JUnit（実験的）

はじめに

数行のコードで、Playwright をお好みの Java テストランナーに接続できます。

JUnit では、Playwright フィクスチャ を使用して、Playwright、Browser、BrowserContext、または Page を自動的に初期化できます。以下の例では、3 つのテストメソッドすべてが同じ Browser を使用しています。各テストは、独自の BrowserContext と Page を使用します。

package org.example;

import com.microsoft.playwright.Page;
import com.microsoft.playwright.junit.UsePlaywright;
import org.junit.jupiter.api.Test;

import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;

@UsePlaywright
public class TestExample {
  @Test
  void shouldClickButton(Page page) {
    page.navigate("data:text/html,<script>var result;</script><button onclick='result=\"Clicked\"'>Go</button>");
    page.locator("button").click();
    assertEquals("Clicked", page.evaluate("result"));
  }

  @Test
  void shouldCheckTheBox(Page page) {
    page.setContent("<input id='checkbox' type='checkbox'></input>");
    page.locator("input").check();
    assertEquals(true, page.evaluate("window['checkbox'].checked"));
  }

  @Test
  void shouldSearchWiki(Page page) {
    page.navigate("https://www.wikipedia.org/");
    page.locator("input[name=\"search\"]").click();
    page.locator("input[name=\"search\"]").fill("playwright");
    page.locator("input[name=\"search\"]").press("Enter");
    assertThat(page).hasURL("https://en.wikipedia.org/wiki/Playwright");
  }
}

フィクスチャ

Playwright フィクスチャを有効にするには、JUnit アノテーション @UsePlaywright をテストクラスに追加するだけです。テストフィクスチャは、各テストの環境を確立するために使用され、テストに必要なものすべてを提供し、それ以外のものは提供しません。

@UsePlaywright
public class TestExample {

  @Test
  void basicTest(Page page) {
    page.navigate("https://playwright.dokyumento.jp/");

    assertThat(page).hasTitle(Pattern.compile("Playwright"));
  }
}

Page page 引数は、page フィクスチャをセットアップし、テストメソッドに提供するように JUnit に指示します。

事前定義されたフィクスチャのリストを以下に示します

フィクスチャ	タイプ	説明
ページ	Page	このテスト実行のために分離されたページ。
browserContext	BrowserContext	このテスト実行のために分離されたコンテキスト。page フィクスチャもこのコンテキストに属します。
ブラウザ	Browser	ブラウザは、リソースを最適化するためにテスト間で共有されます。
playwright	Playwright	Playwright インスタンスは、同じスレッドで実行されているテスト間で共有されます。
request	APIRequestContext	このテスト実行のために分離された APIRequestContext。 API テスト の方法をご覧ください。

オプションのカスタマイズ

フィクスチャオプションをカスタマイズするには、OptionsFactory を実装し、@UsePlaywright() アノテーションでクラスを指定する必要があります。

BrowserType.launch() の起動オプション、または Browser.newContext() および APIRequest.newContext() のコンテキストオプションを簡単にオーバーライドできます。次の例をご覧ください

import com.microsoft.playwright.junit.Options;
import com.microsoft.playwright.junit.OptionsFactory;
import com.microsoft.playwright.junit.UsePlaywright;

@UsePlaywright(MyTest.CustomOptions.class)
public class MyTest {

  public static class CustomOptions implements OptionsFactory {
    @Override
    public Options getOptions() {
      return new Options()
          .setHeadless(false)
          .setContextOption(new Browser.NewContextOptions()
              .setBaseURL("https://github.com"))
          .setApiRequestOptions(new APIRequest.NewContextOptions()
              .setBaseURL("https://playwright.dokyumento.jp"));
    }
  }

  @Test
  public void testWithCustomOptions(Page page, APIRequestContext request) {
    page.navigate("/");
    assertThat(page).hasURL(Pattern.compile("github"));

    APIResponse response = request.get("/");
    assertTrue(response.text().contains("Playwright"));
  }
}

テストの並列実行

デフォルトでは、JUnit はすべてのテストを単一のスレッドで順番に実行します。JUnit 5.3 以降では、この動作を変更してテストを並列実行し、実行速度を向上させることができます（このページを参照）。複数のスレッドから同じ Playwright オブジェクトを余分な同期なしで使用するのは安全ではないため、スレッドごとに Playwright インスタンスを作成し、そのスレッドでのみ排他的に使用することをお勧めします。複数のテストクラスを並列実行する方法の例を次に示します。

@UsePlaywright
class Test1 {
  @Test
  void shouldClickButton(Page page) {
    page.navigate("data:text/html,<script>var result;</script><button onclick='result=\"Clicked\"'>Go</button>");
    page.locator("button").click();
    assertEquals("Clicked", page.evaluate("result"));
  }

  @Test
  void shouldCheckTheBox(Page page) {
    page.setContent("<input id='checkbox' type='checkbox'></input>");
    page.locator("input").check();
    assertEquals(true, page.evaluate("window['checkbox'].checked"));
  }

  @Test
  void shouldSearchWiki(Page page) {
    page.navigate("https://www.wikipedia.org/");
    page.locator("input[name=\"search\"]").click();
    page.locator("input[name=\"search\"]").fill("playwright");
    page.locator("input[name=\"search\"]").press("Enter");
    assertThat(page).hasURL("https://en.wikipedia.org/wiki/Playwright");
  }
}

@UsePlaywright
class Test2 {
  @Test
  void shouldReturnInnerHTML(Page page) {
    page.setContent("<div>hello</div>");
    assertEquals("hello", page.innerHTML("css=div"));
  }

  @Test
  void shouldClickButton(Page page) {
    Page popup = page.waitForPopup(() -> {
      page.evaluate("window.open('about:blank');");
    });
    assertEquals("about:blank", popup.url());
  }
}

各クラスでテストを順番に実行し、複数のクラスを並列スレッドで実行するように JUnit を構成します（スレッドの最大数は CPU コア数の 1/2 に相当）。

junit.jupiter.execution.parallel.enabled = true
junit.jupiter.execution.parallel.mode.default = same_thread
junit.jupiter.execution.parallel.mode.classes.default = concurrent
junit.jupiter.execution.parallel.config.strategy=dynamic
junit.jupiter.execution.parallel.config.dynamic.factor=0.5