Azure Playwright NUnit client library for .NET - version 1.0.0-beta.2

Azure Playwright is a fully managed service that uses the cloud to enable you to run Playwright tests with much higher parallelization across different operating system-browser combinations simultaneously. This means faster test runs with broader scenario coverage, which helps speed up delivery of features without sacrificing quality. The service also enables you to publish test results and related artifacts to the service and view them in the service portal enabling faster and easier troubleshooting. With Azure Playwright, you can release features faster and more confidently.

Ready to get started? Jump into our quickstart guide!

Useful links

• Quickstart: Run end-to-end tests at scale
• Documentation
• Pricing
• Share feedback

Getting started

Install the package

Install the client library for .NET with NuGet:

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

Prerequisites

• An Azure subscription
• Your Azure account must be assigned the Owner, Contributor, or one of the classic administrator roles.

Authenticate the client

To learn more about options for Microsoft Entra Id authentication, refer to Azure.Identity credentials.

Create a Workspace

1. Sign in to the Azure portal with your Azure account.

2. Create the Workspace.

   • Select the menu button in the upper-left corner of the portal, and then select Create a resource.

     

   • Enter Playwright Workspaces in the search box.

   • Select the Playwright Workspaces card, and then select Create.

     

   • Provide the following information to configure a new Playwright workspace:

     Field	Description
     Subscription	Select the Azure subscription that you want to use for this Playwright workspace.
     Resource group	Select an existing resource group. Or select Create new, and then enter a unique name for the new resource group.
     Name	Enter a unique name to identify your workspace. The name can only consist of alphanumerical characters, and have a length between 3 and 64 characters.
     Location	Select a geographic location to host your workspace. This location also determines where the test execution results are stored.

     Note

     Optionally, you can configure more details on the Tags tab. Tags are name/value pairs that enable you to categorize resources and view consolidated billing by applying the same tag to multiple resources and resource groups.

   • After you're finished configuring the resource, select Review + Create.

   • Review all the configuration settings and select Create to start the deployment of the Playwright workspace.

   • When the process has finished, a deployment success message appears.

   • To view the new workspace, select Go to resource.

     |

```

Set up Azure Playwright

Create a file PlaywrightServiceSetup.cs in the root directory with the below content

using Azure.Developer.Playwright.NUnit;
using Azure.Identity;

namespace PlaywrightService.SampleTests; // Remember to change this as per your project namespace

[SetUpFixture]
public class PlaywrightServiceNUnitSetup : PlaywrightServiceBrowserNUnit
{
    public PlaywrightServiceNUnitSetup() : base(
        credential: new DefaultAzureCredential()
    )
    { }
}

Setup Azure Playwright cloud browser connection

Override builtin PageTest fixture with Azure Playwright cloud browser connection and use ServicePageTest in all test classes.

using Microsoft.Playwright.NUnit;
using Azure.Developer.Playwright;
using Azure.Identity;
using Microsoft.Playwright;

namespace PlaywrightService.SampleTests;

public class ServicePageTest : PageTest
{
    public override async Task<(string, BrowserTypeConnectOptions?)?> ConnectOptionsAsync()
    {
        PlaywrightServiceBrowserClient client = new PlaywrightServiceBrowserClient(credential: new DefaultAzureCredential());
        var connectOptions = await client.GetConnectOptionsAsync<BrowserTypeConnectOptions>();
        return (connectOptions.WsEndpoint, connectOptions.Options);
    }
}

Obtain region endpoint

1. In the Playwright portal, copy the command under Add region endpoint in your set up.

   

   The endpoint URL corresponds to the workspace region. You might see a different endpoint URL in the Playwright portal, depending on the region you selected when creating the workspace.

Set up environment

Ensure that the PLAYWRIGHT_SERVICE_URL that you obtained in previous step is available in your environment.

Run the tests

Run Playwright tests against browsers managed by the service using the configuration you created above.

dotnet test

Key concepts

Key concepts of the Azure Playwright NUnit SDK for .NET can be found here

Examples

Code samples for using this SDK can be found in the following locations

• .NET Azure Playwright NUnit Library Code Samples

Troubleshooting

• File an issue via GitHub Issues.
• Check previous questions or ask new ones on Stack Overflow using Azure and .NET tags.

Next steps

• Run tests in a CI/CD pipeline.

• Learn how to manage access to the created workspace.

• Experiment with different number of workers to determine the optimal configuration of your test suite.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].

This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.