メインコンテンツにスキップ

テストランナー

はじめに​

Playwright for .NETは特定のテストランナーやテストフレームワークに縛られませんが、私たちの経験では、MSTest、NUnit、xUnit、またはxUnit v3用に提供されている基本クラスを使用するのが最も簡単に始める方法です。これらのクラスは、複数のブラウザエンジンでのテスト実行、起動/コンテキストオプションの調整、そしてPage/BrowserContextインスタンスをテストごとにすぐに取得することをサポートしています。

PlaywrightとBrowserインスタンスは、パフォーマンス向上のためテスト間で再利用されます。各テストケースを新しいBrowserContextで実行することをお勧めします。これにより、テスト間でブラウザの状態が隔離されます。

Playwrightは、Microsoft.Playwright.MSTestパッケージを介してMSTestでテストを記述するための基本クラスを提供します。

インストールガイドを確認して始めてください。

並行してテストを実行する​

デフォルトでは、MSTestはすべてのクラスを並行して実行し、各クラス内のテストは順番に実行します（ExecutionScope.ClassLevel）。ホストシステム上のコアの数だけプロセスを作成します。この動作は、以下のCLIパラメーターを使用するか、.runsettingsファイルを使用して調整できます。詳細については以下を参照してください。メソッドレベルでのテストの並行実行（ExecutionScope.MethodLevel）はサポートされていません。

dotnet test --settings:.runsettings -- MSTest.Parallelize.Workers=4

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

コンテキストオプションをカスタマイズするには、Microsoft.Playwright.MSTest.PageTestまたはMicrosoft.Playwright.MSTest.ContextTestから派生したテストクラスのContextOptionsメソッドをオーバーライドできます。以下の例を参照してください。

using System.Threading.Tasks;
using Microsoft.Playwright;
using Microsoft.Playwright.MSTest;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace PlaywrightTests;

[TestClass]
public class ExampleTest : PageTest
{
    [TestMethod]
    public async Task TestWithCustomContextOptions()
    {
        // The following Page (and BrowserContext) instance has the custom colorScheme, viewport and baseURL set:
        await Page.GotoAsync("/login");
    }

    public override BrowserNewContextOptions ContextOptions()
    {
        return new BrowserNewContextOptions()
        {
            ColorScheme = ColorScheme.Light,
            ViewportSize = new()
            {
                Width = 1920,
                Height = 1080
            },
            BaseURL = "https://github.com",
        };
    }
}

Browser/起動オプションのカスタマイズ​

Browser/起動オプションは、実行設定ファイルを使用するか、CLIを介して実行設定オプションを直接設定することでオーバーライドできます。以下の例を参照してください。

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
  <Playwright>
    <BrowserName>chromium</BrowserName>
    <LaunchOptions>
      <Headless>false</Headless>
      <Channel>msedge</Channel>
    </LaunchOptions>
  </Playwright>
</RunSettings>
dotnet test -- Playwright.BrowserName=chromium Playwright.LaunchOptions.Headless=false Playwright.LaunchOptions.Channel=msedge

詳細APIログの使用​

DEBUG環境変数を通じて詳細APIログを有効にすると、標準エラー出力ストリームにメッセージが表示されます。Visual Studio内では、これはOutputウィンドウのTestsペインになります。また、各テストのTest Logにも表示されます。

.runsettingsファイルの使用​

Visual Studioからテストを実行する場合、.runsettingsファイルを活用できます。以下にサポートされている値のリファレンスを示します。

例えば、ワーカー数を指定するにはMSTest.Parallelize.Workersを使用できます。また、RunConfiguration.EnvironmentVariablesを使用してDEBUGログを有効にすることもできます。

<RunSettings>
  <!-- MSTest adapter -->  
  <MSTest>
    <Parallelize>
      <Workers>4</Workers>
      <Scope>ClassLevel</Scope>
    </Parallelize>
  </MSTest>
  <!-- General run configuration -->
  <RunConfiguration>
    <EnvironmentVariables>
      <!-- For debugging selectors, it's recommend to set the following environment variable -->
      <DEBUG>pw:api</DEBUG>
    </EnvironmentVariables>
  </RunConfiguration>
  <!-- Playwright -->  
  <Playwright>
    <BrowserName>chromium</BrowserName>
    <ExpectTimeout>5000</ExpectTimeout>
    <LaunchOptions>
      <Headless>false</Headless>
      <Channel>msedge</Channel>
    </LaunchOptions>
  </Playwright>
</RunSettings>

Playwrightの基本クラス​

Microsoft.Playwright.MSTest名前空間で利用可能な基本クラスがいくつかあります。

テスト説明
PageTest各テストは、独自のBrowserContext内で作成されたWebPageの新しいコピーを取得します。このクラスを拡張することは、完全に機能するPlaywrightテストを記述する最も簡単な方法です。

注：各テストファイルでContextOptionsメソッドをオーバーライドしてコンテキストオプションを制御できます。これは通常、Browser.NewContextAsync()メソッドに渡されるものです。これにより、テストファイルごとにあらゆる種類のエミュレーションオプションを個別に指定できます。
ContextTest各テストはBrowserContextの新しいコピーを取得します。このコンテキスト内で好きなだけページを作成できます。このテストを使用することは、複数のタブが必要な複数ページシナリオをテストする最も簡単な方法です。

注：各テストファイルでContextOptionsメソッドをオーバーライドしてコンテキストオプションを制御できます。これは通常、Browser.NewContextAsync()メソッドに渡されるものです。これにより、テストファイルごとにあらゆる種類のエミュレーションオプションを個別に指定できます。
BrowserTest各テストはブラウザを取得し、好きなだけコンテキストを作成できます。各テストは、作成したすべてのコンテキストをクリーンアップする責任があります。
PlaywrightTestこれにより、各テストにPlaywrightオブジェクトが与えられ、テストは好きなだけブラウザを起動および停止できます。