feat: Add Playwright module

Directory.Packages.props

@@ -68,6 +68,7 @@
         <PackageVersion Include="Microsoft.Azure.Cosmos" Version="3.32.1"/>
         <PackageVersion Include="Microsoft.Azure.Kusto.Data" Version="12.2.8"/>
         <PackageVersion Include="Microsoft.Data.SqlClient" Version="5.2.2"/>
+        <PackageVersion Include="Microsoft.Playwright" Version="1.55.0"/>
         <PackageVersion Include="Milvus.Client" Version="2.2.2-preview.6"/>
         <PackageVersion Include="MongoDB.Driver" Version="3.2.0"/>
         <PackageVersion Include="MyCouch" Version="7.6.0"/>

Testcontainers.sln

@@ -264,6 +264,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Xunit.Tests"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.XunitV3.Tests", "tests\Testcontainers.XunitV3.Tests\Testcontainers.XunitV3.Tests.csproj", "{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Playwright", "src\Testcontainers.Playwright\Testcontainers.Playwright.csproj", "{7F91A202-4F07-470D-881C-9A46A700DCA5}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Playwright.Tests", "tests\Testcontainers.Playwright.Tests\Testcontainers.Playwright.Tests.csproj", "{DE065875-1B7B-4E20-9332-C88C8437333D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -758,6 +762,14 @@ Global
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7F91A202-4F07-470D-881C-9A46A700DCA5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7F91A202-4F07-470D-881C-9A46A700DCA5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7F91A202-4F07-470D-881C-9A46A700DCA5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7F91A202-4F07-470D-881C-9A46A700DCA5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{DE065875-1B7B-4E20-9332-C88C8437333D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DE065875-1B7B-4E20-9332-C88C8437333D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DE065875-1B7B-4E20-9332-C88C8437333D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DE065875-1B7B-4E20-9332-C88C8437333D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -886,5 +898,7 @@ Global
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{E901DF14-6F05-4FC2-825A-3055FAD33561} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{7F91A202-4F07-470D-881C-9A46A700DCA5} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{DE065875-1B7B-4E20-9332-C88C8437333D} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 	EndGlobalSection
 EndGlobal

src/Testcontainers.Playwright/.editorconfig

@@ -0,0 +1 @@
+root = true

src/Testcontainers.Playwright/PlaywrightBrowser.cs

@@ -0,0 +1,52 @@
+namespace Testcontainers.Playwright;
+
+/// <summary>
+/// Playwright browser configuration.
+/// </summary>
+[PublicAPI]
+public readonly struct PlaywrightBrowser
+{
+  /// <summary>
+  /// Gets the Playwright standalone Chrome configuration.
+  /// </summary>
+  public static readonly PlaywrightBrowser Chrome = new PlaywrightBrowser("jacoblincool/playwright:chrome-server");
+
+  /// <summary>
+  /// Gets the Playwright standalone Chromium configuration.
+  /// </summary>
+  public static readonly PlaywrightBrowser Chromium = new PlaywrightBrowser("jacoblincool/playwright:chromium-server");
+
+  /// <summary>
+  /// Gets the Playwright standalone Firefox configuration.
+  /// </summary>
+  public static readonly PlaywrightBrowser Firefox = new PlaywrightBrowser("jacoblincool/playwright:firefox-server");
+
+  /// <summary>
+  /// Gets the Playwright standalone Edge configuration.
+  /// </summary>
+  public static readonly PlaywrightBrowser Edge = new PlaywrightBrowser("jacoblincool/playwright:msedge-server");
+
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightBrowser" /> struct.
+  /// </summary>
+  /// <param name="image">The Playwright standalone Docker image.</param>
+  public PlaywrightBrowser(string image)
+    : this(new DockerImage(image))
+  {
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightBrowser" /> struct.
+  /// </summary>
+  /// <param name="image">The Playwright standalone Docker image.</param>
+  public PlaywrightBrowser(IImage image)
+  {
+    Image = image;
+  }
+  /// <summary>
+  /// Gets the Playwright standalone Docker image.
+  /// </summary>
+  [NotNull]
+  public IImage Image { get; }
+}

src/Testcontainers.Playwright/PlaywrightBuilder.cs

@@ -0,0 +1,98 @@
+namespace Testcontainers.Playwright;
+
+/// <inheritdoc cref="PlaywrightBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
+/// <remarks>
+/// Find further information about the Playwright image, here: https://playwright.dev/dotnet/docs/docker.
+/// </remarks>
+[PublicAPI]
+public class PlaywrightBuilder : ContainerBuilder<PlaywrightBuilder, PlaywrightContainer, PlaywrightConfiguration>
+{
+  private const ushort PlaywrightPort = 53333;
+  private const string PlaywrightEndpointPath = "/playwright";
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightBuilder" /> class.
+  /// </summary>
+  public PlaywrightBuilder() : this(new PlaywrightConfiguration())
+  {
+    DockerResourceConfiguration = Init().DockerResourceConfiguration;
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightBuilder" /> class.
+  /// </summary>
+  /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+  private PlaywrightBuilder(PlaywrightConfiguration resourceConfiguration)
+    : base(resourceConfiguration)
+  {
+    DockerResourceConfiguration = resourceConfiguration;
+  }
+
+  /// <inheritdoc />
+  protected override PlaywrightConfiguration DockerResourceConfiguration { get; }
+
+  public override PlaywrightContainer Build()
+  {
+    Validate();
+    return new PlaywrightContainer(DockerResourceConfiguration);
+  }
+
+  /// <inheritdoc />
+  protected override PlaywrightBuilder Init()
+  {
+    return base.Init()
+      .WithBrowser(PlaywrightBrowser.Chrome)
+      .WithEndpointPath(PlaywrightEndpointPath)
+      .WithBrowserPort(PlaywrightPort)
+      .WithWaitStrategy(Wait.ForUnixContainer()
+        .UntilMessageIsLogged($"ws://.*:{PlaywrightPort}{PlaywrightEndpointPath}"));
+  }
+
+  public PlaywrightBuilder WithBrowser(PlaywrightBrowser playwrightBrowser)
+  {
+    return WithImage(playwrightBrowser.Image);
+  }
+
+  /// <summary>
+  /// Sets the BROWSER WS ENDPOINT.
+  /// </summary>
+  /// <param name="endpointPath">The BROWSER WS ENDPOINT.</param>
+  /// <returns>A configured instance of <see cref="PlaywrightBuilder" />.</returns>
+  public PlaywrightBuilder WithEndpointPath(string endpointPath)
+  {
+    return Merge(DockerResourceConfiguration, new PlaywrightConfiguration(endpoint: endpointPath))
+      .WithEnvironment("BROWSER_WS_ENDPOINT", endpointPath);
+  }
+
+  /// <summary>
+  /// Sets the BROWSER WS PORT.
+  /// </summary>
+  /// <param name="port">The BROWSER WS PORT.</param>
+  /// <returns>A configured instance of <see cref="PlaywrightBuilder" />.</returns>
+  public PlaywrightBuilder WithBrowserPort(int port, bool assignRandomHostPort=false)
+  {
+    return Merge(DockerResourceConfiguration, new PlaywrightConfiguration(port: port))
+      .WithEnvironment("BROWSER_PORT", port.ToString())
+      .WithPortBinding(port, assignRandomHostPort);
+  }
+
+
+
+  /// <inheritdoc />
+  protected override PlaywrightBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+  {
+    return Merge(DockerResourceConfiguration, new PlaywrightConfiguration(resourceConfiguration));
+  }
+
+  /// <inheritdoc />
+  protected override PlaywrightBuilder Clone(IContainerConfiguration resourceConfiguration)
+  {
+    return Merge(DockerResourceConfiguration, new PlaywrightConfiguration(resourceConfiguration));
+  }
+
+  /// <inheritdoc />
+  protected override PlaywrightBuilder Merge(PlaywrightConfiguration oldValue, PlaywrightConfiguration newValue)
+  {
+    return new PlaywrightBuilder(new PlaywrightConfiguration(oldValue, newValue));
+  }
+}

src/Testcontainers.Playwright/PlaywrightConfiguration.cs

@@ -0,0 +1,70 @@
+namespace Testcontainers.Playwright;
+
+/// <inheritdoc cref="PlaywrightConfiguration" />
+[PublicAPI]
+public class PlaywrightConfiguration : ContainerConfiguration
+{
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightConfiguration" /> class.
+  /// </summary>
+  /// <param name="endpoint">The Playwright endpoint.</param>
+  public PlaywrightConfiguration(string endpoint = null,
+    int? port = null)
+  {
+    Endpoint = endpoint;
+    Port = port;
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightConfiguration" /> class.
+  /// </summary>
+  /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+  public PlaywrightConfiguration(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+    : base(resourceConfiguration)
+  {
+    // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightConfiguration" /> class.
+  /// </summary>
+  /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+  public PlaywrightConfiguration(IContainerConfiguration resourceConfiguration)
+    : base(resourceConfiguration)
+  {
+    // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightConfiguration" /> class.
+  /// </summary>
+  /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+  public PlaywrightConfiguration(PlaywrightConfiguration resourceConfiguration)
+    : this(new PlaywrightConfiguration(), resourceConfiguration)
+  {
+    // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+  }
+
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightConfiguration" /> class.
+  /// </summary>
+  /// <param name="oldValue">The old Docker resource configuration.</param>
+  /// <param name="newValue">The new Docker resource configuration.</param>
+  public PlaywrightConfiguration(PlaywrightConfiguration oldValue, PlaywrightConfiguration newValue)
+    : base(oldValue, newValue)
+  {
+    Endpoint = BuildConfiguration.Combine(oldValue.Endpoint, newValue.Endpoint);
+  }
+
+
+  /// <summary>
+  /// Gets the Playwright endpoint.
+  /// </summary>
+  public string Endpoint { get; }
+
+
+  /// <summary>
+  /// Gets the Playwright port.
+  /// </summary>
+  public int? Port { get; }
+}

src/Testcontainers.Playwright/PlaywrightContainer.cs

@@ -0,0 +1,14 @@
+namespace Testcontainers.Playwright;
+
+/// <inheritdoc cref="DockerContainer" />
+[PublicAPI]
+public class PlaywrightContainer : DockerContainer
+{
+  /// <summary>
+  /// Initializes a new instance of the <see cref="PlaywrightContainer" /> class.
+  /// </summary>
+  /// <param name="configuration">The container configuration.</param>
+  public PlaywrightContainer(PlaywrightConfiguration configuration) : base(configuration)
+  {
+  }
+}

src/Testcontainers.Playwright/Testcontainers.Playwright.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>net8.0;net9.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="JetBrains.Annotations" VersionOverride="2023.3.0" PrivateAssets="All"/>
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="../Testcontainers/Testcontainers.csproj"/>
+    </ItemGroup>
+</Project>

src/Testcontainers.Playwright/Usings.cs

@@ -0,0 +1,16 @@
+global using System;
+global using System.IO;
+global using System.Linq;
+global using System.Net.Http;
+global using System.Text.Json;
+global using System.Threading;
+global using System.Threading.Tasks;
+global using Docker.DotNet.Models;
+global using DotNet.Testcontainers;
+global using DotNet.Testcontainers.Builders;
+global using DotNet.Testcontainers.Configurations;
+global using DotNet.Testcontainers.Containers;
+global using DotNet.Testcontainers.Images;
+global using DotNet.Testcontainers.Networks;
+global using JetBrains.Annotations;
+global using Microsoft.Extensions.Logging.Abstractions;

tests/Testcontainers.Playwright.Tests/.editorconfig

@@ -0,0 +1 @@
+root = true

tests/Testcontainers.Playwright.Tests/.runs-on

@@ -0,0 +1 @@
+ubuntu-24.04

tests/Testcontainers.Playwright.Tests/GlobalUsings.cs

@@ -0,0 +1,3 @@
+global using Xunit;
+global using System;
+global using System.Threading.Tasks;

tests/Testcontainers.Playwright.Tests/PlaywrightContainerTest.cs

@@ -0,0 +1,28 @@
+namespace Testcontainers.Playwright.Tests;
+
+public class PlaywrightContainerTest : IClassFixture<TestInitializer>
+{
+  private readonly Uri _helloWorldBaseAddress;
+
+  public PlaywrightContainerTest(TestInitializer testInitializer)
+  {
+    _helloWorldBaseAddress = testInitializer._helloWorldBaseAddress;
+  }
+
+  [Fact]
+  public async Task HeadingElementReturnsHelloWorld()
+  {
+    // Given
+    var playwright = await Microsoft.Playwright.Playwright.CreateAsync();
+    var browser = await playwright.Chromium.ConnectAsync($"ws://localhost:63333/playwright");
+    var page = await browser.NewPageAsync();
+
+    // When
+    await page.GotoAsync(_helloWorldBaseAddress.ToString());
+    var headingElement = await page.QuerySelectorAsync("h1");
+    var headingElementText = await headingElement.InnerTextAsync();
+
+    // Then
+    Assert.Equal("Hello world", headingElementText);
+  }
+}