Important

Microsoft Playwright Testing will be retired on March 8, 2026. To continue running your Playwright tests,create a newPlaywright Workspace inAzure App Testing, now generally available.Learn how to migrate.

Important

Microsoft Playwright Testing is currently in preview. For legal terms that apply to Azure features that are in beta, in preview, or otherwise not yet released into general availability, see theSupplemental Terms of Use for Microsoft Azure Previews.

• GitHub Actions
• Azure Pipelines

Add service configuration file

If you don't have Playwright tests configured to run with the service, add a service configuration file to your repository. In the next step, you then specify this service configuration file on the Playwright CLI.

1. Create a new fileplaywright.service.config.ts alongside theplaywright.config.ts file.

   Optionally, use theplaywright.service.config.ts file in thesample repository.

2. Add the following content to it:

   import { defineConfig } from '@playwright/test';import { getServiceConfig, ServiceOS } from '@azure/microsoft-playwright-testing';import config from './playwright.config';/* Learn more about service configuration at https://aka.ms/mpt/config */export default defineConfig(  config,  getServiceConfig(config, {    exposeNetwork: '<loopback>',    timeout: 30000,    os: ServiceOS.LINUX,    useCloudHostedBrowsers: true  }),  {    /*     Playwright Testing service reporter is added by default.    This will override any reporter options specified in the base playwright config.    If you are using more reporters, please update your configuration accordingly.    */    reporter: [['list'], ['@azure/microsoft-playwright-testing/reporter']],  });

   By default, the service configuration enables you to:

   • Accelerate build pipelines by running tests in parallel using cloud-hosted browsers.
   • Simplify troubleshooting with easy access to test results and artifacts published to the service.

   However, you can choose to use either of these features or both. SeeHow to use service features and update the service configuration file as per your requirements.

3. Save and commit the file to your source code repository.

Update package.json file

Update thepackage.json file in your repository to add details about Microsoft Playwright Testing service package indevDependencies section.

"devDependencies": {    "@azure/microsoft-playwright-testing": "^1.0.0-beta.6"}

Enable artifacts in Playwright configuration

In theplaywright.config.ts file of your project, make sure you're collecting all the required artifacts.

  use: {    trace: 'on-first-retry',    video:'retain-on-failure',    screenshot:'on'  },

Set up service configuration

1. Create a new filePlaywrightServiceSetup.cs in the root directory of your project. This file facilitates authentication of your client with the service.

2. Add the following content to it:

   using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;using NUnit.Framework;namespace PlaywrightTests; // Remember to change this as per your project namespace[SetUpFixture]public class PlaywrightServiceSetup : PlaywrightServiceNUnit { };

3. Save and commit the file to your source code repository.

Install service package

In your project, install Microsoft Playwright Testing package.

dotnet add package Azure.Developer.MicrosoftPlaywrightTesting.NUnit --prerelease

This command updates your project'scsproj file by adding the service package details to theItemGroup section. Remember to commit these changes.

  <ItemGroup>    <PackageReference Include="Azure.Developer.MicrosoftPlaywrightTesting.NUnit" Version="1.0.0-beta.2" />  </ItemGroup>

Add or update.runsettings file for your project.

If you haven't configured your Playwright tests yet for running them with service, add.runsettings file to your repository. In the next step, you then specify this service configuration file on the Playwright CLI.

1. Create a new.runsettings file.

   Optionally, use the.runsettings file in thesample repository.

2. Add the following content to it:

   <?xml version="1.0" encoding="utf-8"?><RunSettings>    <TestRunParameters>        <!-- The below parameters are optional -->        <Parameter name="Os" value="linux" />        <!--<Parameter name="RunId" value="sample-run-id1" />-->        <Parameter name="ServiceAuthType" value="EntraId" />        <Parameter name="UseCloudHostedBrowsers" value="true" />        <Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />        <!--<Parameter name="ManagedIdentityClientId" value="{clientId-value}" />-->        <Parameter name="EnableGitHubSummary" value="false" />        <!--<Parameter name="ExposeNetwork" value="*" />-->    </TestRunParameters>  <!-- NUnit adapter -->    <NUnit>    <!-- Adjust parallel workers, parallel worker would also be bound by number of unit test files -->    <NumberOfTestWorkers>10</NumberOfTestWorkers>  </NUnit>  <!-- 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>    <LoggerRunSettings>        <Loggers>            <!--microsoft playwright testing service logger for reporting -->            <Logger friendlyName="microsoft-playwright-testing" enabled="True" />            <!--could enable any logger additionally -->            <Logger friendlyName="trx" enabled="false" />        </Loggers>    </LoggerRunSettings></RunSettings>

   The settings in this file enable you to:

   • Accelerate build pipelines by running tests in parallel using cloud-hosted browsers.
   • Publish test results and artifacts to the service for faster troubleshooting.

   However, you can choose to use either of these features or both. SeeHow to use service features and update the service configuration file as per your requirements.

3. Save and commit the file to your source code repository.

Enable artifacts in your Playwright setup

Set up Playwright to capture artifacts such as screenshot, videos and traces.

• For screenshots, seecapture screenshots
• For videos, seerecord videos for your tests
• For traces, seerecording a trace

Once you collect these artifacts, attach them to theTestContext to ensure they're available in your test reports. For more information, see oursample project for NUnit.

• GitHub Actions
• Azure Pipelines

Caution

We strongly recommend using Microsoft Entra ID for authentication to the service. If you're using access tokens, seeHow to manage access tokens

Update the CI workflow definition to run your Playwright tests with the Playwright CLI. Pass theservice configuration file as an input parameter for the Playwright CLI. You configure your environment by specifying environment variables.

1. Open the CI workflow definition

2. Add the following steps to run your Playwright tests in Microsoft Playwright Testing.

   The following steps describe the workflow changes for GitHub Actions or Azure Pipelines. Similarly, you can run your Playwright tests by using the Playwright CLI in other CI platforms.

   • GitHub Actions
   • Azure Pipelines

     # This step is to sign-in to Azure to run tests from GitHub Action workflow.   # Choose how to set up authentication to Azure from GitHub Actions. This is one example.   name: Playwright Tests (Microsoft Playwright Testing)  on:    push:      branches: [main, master]    pull_request:      branches: [main, master]  permissions: # Required when using Microsoft Entra ID to authenticate    id-token: write    contents: read  jobs:    test:      timeout-minutes: 60      runs-on: ubuntu-latest      steps:        - uses: actions/checkout@v4        - name: Login to Azure with AzPowershell (enableAzPSSession true)          uses: azure/login@v2          with:            client-id: ${{ secrets.AZURE_CLIENT_ID }} # GitHub Open ID connect values copied in previous steps            tenant-id: ${{ secrets.AZURE_TENANT_ID }}            subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}            enable-AzPSSession: true        - name: Install dependencies          working-directory: path/to/playwright/folder # update accordingly          run: npm ci        - name: Run Playwright tests          working-directory: path/to/playwright/folder # update accordingly          env:            # Regional endpoint for Microsoft Playwright Testing            PLAYWRIGHT_SERVICE_URL: ${{ secrets.PLAYWRIGHT_SERVICE_URL }}            # PLAYWRIGHT_SERVICE_ACCESS_TOKEN: ${{ secrets.PLAYWRIGHT_SERVICE_ACCESS_TOKEN }} # Not recommended, use Microsoft Entra ID authentication.           run: npx playwright test -c playwright.service.config.ts --workers=20        - name: Upload Playwright report          uses: actions/upload-artifact@v3          if: always()          with:            name: playwright-report            path: path/to/playwright/folder/playwright-report/ # update accordingly            retention-days: 10

Update the CI workflow definition to run your Playwright tests with the Playwright NUnit CLI. Pass the.runsettings file as an input parameter for the Playwright CLI. You configure your environment by specifying environment variables.

1. Open the CI workflow definition.

2. Add the following steps to run your Playwright tests in Microsoft Playwright Testing.

   The following steps describe the workflow changes for GitHub Actions or Azure Pipelines. Similarly, you can run your Playwright tests by using the Playwright CLI in other CI platforms.

   • GitHub Actions
   • Azure Pipelines

   on:  push:    branches: [ main, master ]  pull_request:    branches: [ main, master ]permissions: # Required when using AuthType as EntraId  id-token: write  contents: readjobs:  test:    timeout-minutes: 60    runs-on: ubuntu-latest      steps:      - uses: actions/checkout@v4    # This step is to sign-in to Azure to run tests from GitHub Action workflow.     # Choose how to set up authentication to Azure from GitHub Actions. This is one example.       - name: Login to Azure with AzPowershell (enableAzPSSession true)         uses: azure/login@v2         with:           client-id: ${{ secrets.AZURE_CLIENT_ID }} # GitHub Open ID connect values copied in previous steps          tenant-id: ${{ secrets.AZURE_TENANT_ID }}            subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}            enable-AzPSSession: true       - name: Setup .NET        uses: actions/setup-dotnet@v4        with:          dotnet-version: 8.0.x      - name: Restore dependencies        run: dotnet restore        working-directory: path/to/playwright/folder # update accordingly      - name: Build        run: dotnet build --no-restore        working-directory: path/to/playwright/folder # update accordingly      - name: Run Playwright tests          working-directory: path/to/playwright/folder # update accordingly        env:          # Regional endpoint for Microsoft Playwright Testing          PLAYWRIGHT_SERVICE_URL: ${{ secrets.PLAYWRIGHT_SERVICE_URL }}          # PLAYWRIGHT_SERVICE_ACCESS_TOKEN: ${{ secrets.PLAYWRIGHT_SERVICE_ACCESS_TOKEN }} # Not recommended, use Microsoft Entra ID authentication.         run: dotnet test --settings:.runsettings --logger "microsoft-playwright-testing" -- NUnit.NumberOfTestWorkers=20      - name: Upload Playwright report        uses: actions/upload-artifact@v3        if: always()        with:          name: playwright-report          path: path/to/playwright/folder/playwright-report/ # update accordingly          retention-days: 10

Note

Reporting feature is enabled by default for existing workspaces. This is being rolled out in stages and will take a few days. To avoid failures, confirm thatRich diagnostics using reporting setting is ON for your workspace before proceeding. For more information, see,Enable reporting for workspace.

Caution

With Microsoft Playwright Testing, you get charged based on the number of total test minutes consumed and test results published. If you're a first-time user orgetting started with a free trial, you might start with running a single test at scale instead of your full test suite to avoid exhausting your free test minutes and test results.

You can run a single test with the service by using the following command-line:

npx playwright test {name-of-file.spec.ts} --config=playwright.service.config.ts

1. After your test run completes, a link to the Playwright Portal is generated. Open this link to view detailed test results and associated artifacts. The portal displays essential information, including:

   • CI build details
   • Overall test run status
   • The commit ID linked to the test run

   

2. The Playwright portal provides all the necessary information for troubleshooting. You can:

   • Switch between retries.
   • View detailed error logs, test steps, and attached artifacts such as screenshots or videos.
   • Navigate directly to theTrace Viewer for deeper analysis.

   

3. The Trace Viewer allows you to step through your test execution visually. You can:

   • Use the timeline to hover over individual steps, revealing the page state before and after each action.
   • Inspect detailed logs, DOM snapshots, network activity, errors, and console output for each step.

   

1. After your test run completes, you get a link to the Playwright portal in your terminal. Open this link to view detailed test results and associated artifacts. The portal displays essential information, including:

   • CI build details
   • Overall test run status
   • The commit ID linked to the test run

   

2. The Playwright portal provides all the necessary information for troubleshooting. You can:

   • View detailed error logs, and attached artifacts such as screenshots or videos.
   • Navigate directly to theTrace Viewer for deeper analysis.

   

4. The Trace Viewer allows you to step through your test execution visually. You can:

   • Use the timeline to hover over individual steps, revealing the page state before and after each action.
   • Inspect detailed logs, DOM snapshots, network activity, errors, and console output for each step.

   

Tip

You can use Microsoft Playwright Testing service features independently. You can publish test results to the portal without using the cloud-hosted browsers feature and you can also use only cloud-hosted browsers to expedite your test suite without publishing test results. For details, seeHow to use service features.

Note

The test results and artifacts that you publish are retained on the service for 90 days. After that, they are automatically deleted.