Skip to content

Playwright

Playwright is a framework for web testing and automation. It allows testing across all modern rendering engines including Chromium, WebKit, and Firefox with a single API. This module provides pre-configured browser containers for automated testing.

Add the following dependency to your project file:

NuGet
1
dotnet add package Testcontainers.Playwright

You can start a Playwright container instance from any .NET application. To create and start a container instance with the default configuration, use the module-specific builder as shown below:

1
2
var playwrightContainer = new PlaywrightBuilder().Build();
await playwrightContainer.StartAsync();

This example uses xUnit.net's IAsyncLifetime interface to manage the lifecycle of the container. The container is started in the InitializeAsync method before the test method runs, ensuring that the environment is ready for testing. After the test completes, the container is removed in the DisposeAsync method.

This example demonstrates the Playwright container accessing a web site running inside another container (using the testcontainers/helloworld image). Both containers are assigned to a shared network (see the Network configuration section) to enable communication between them.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
[Fact]
[Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
public async Task HeadingElementReturnsHelloWorld()
{
    // Given
    var playwright = await Microsoft.Playwright.Playwright.CreateAsync()
        .ConfigureAwait(true);

    var browser = await playwright.Chromium.ConnectAsync(_playwrightContainer.GetConnectionString())
        .ConfigureAwait(true);

    var page = await browser.NewPageAsync()
        .ConfigureAwait(true);

    // When
    await page.GotoAsync(_helloWorldBaseAddress.ToString())
        .ConfigureAwait(true);

    var headingElement = await page.QuerySelectorAsync("h1")
        .ConfigureAwait(true);

    var headingElementText = await headingElement!.InnerTextAsync()
        .ConfigureAwait(true);

    // Then
    Assert.Equal("Hello world", headingElementText);
}

The test example uses the following NuGet dependencies:

1
2
3
4
5
<PackageReference Include="Microsoft.NET.Test.Sdk"/>
<PackageReference Include="coverlet.collector"/>
<PackageReference Include="xunit.runner.visualstudio"/>
<PackageReference Include="xunit.v3"/>
<PackageReference Include="Microsoft.Playwright"/>

To execute the tests, use the command dotnet test from a terminal.

Tip

For the complete source code of this example and additional information, please refer to our test projects.

Network configuration

The Playwright container is configured with a network that can be shared with other containers. This is useful when testing applications that need to communicate with other services. Use the GetNetwork() method to access the container's network:

1
2
3
var helloWorldContainer = new ContainerBuilder()
    .WithNetwork(playwrightContainer.GetNetwork())
    .Build();