Merge branch 'develop' into ssl-config-dotnet

ozkanpakdil · web-flow · commit 63733f682efa · 2025-09-15T12:22:28.000+01:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <PackageId>$(AssemblyName)</PackageId>
-    <Version>4.7.0</Version>
+    <Version>4.8.0</Version>
     <AssemblyVersion>$(Version)</AssemblyVersion>
     <FileVersion>$(Version)</FileVersion>
     <Product>Testcontainers</Product>
diff --git a/docs/api/create_docker_container.md b/docs/api/create_docker_container.md
@@ -76,7 +76,8 @@ Starting a container or creating a resource (such as a network or a volume) can
 
 ```csharp title="Canceling container start after one minute"
 using var timeoutCts = new CancellationTokenSource(TimeSpan.FromMinutes(1));
-await _container.StartAsync(timeoutCts.Token);
+await _container.StartAsync(timeoutCts.Token)
+  .ConfigureAwait(false);
 ```
 
 ## Getting log messages
@@ -86,7 +87,8 @@ Testcontainers for .NET provides two approaches for retrieving log messages from
 The `GetLogsAsync` method is available through the `IContainer` interface. It allows you to fetch logs from a container for a specific time range or from the beginning until the present. This approach is useful for retrieving logs after a test has run, especially when troubleshooting issues or failures.
 
 ```csharp title="Getting all log messages"
-var (stdout, stderr) = await _container.GetLogsAsync();
+var (stdout, stderr) = await _container.GetLogsAsync()
+  .ConfigureAwait(false);
 ```
 
 The `WithOutputConsumer` method is part of the `ContainerBuilder` class and is used to continuously forward container log messages to a specified output consumer. This approach provides real-time access to logs as the container runs.
diff --git a/docs/modules/index.md b/docs/modules/index.md
@@ -73,6 +73,7 @@ await moduleNameContainer.StartAsync();
 | Typesense         | `typesense/typesense:28.0`                                          | [NuGet](https://www.nuget.org/packages/Testcontainers.Typesense)     | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Typesense)     |
 | Weaviate          | `semitechnologies/weaviate:1.26.14`                                 | [NuGet](https://www.nuget.org/packages/Testcontainers.Weaviate)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Weaviate)      |
 | WebDriver         | `selenium/standalone-chrome:110.0`                                  | [NuGet](https://www.nuget.org/packages/Testcontainers.WebDriver)     | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.WebDriver)     |
+| WireMock          | -                                                                   | [NuGet](https://www.nuget.org/packages/WireMock.Net.Testcontainers)  | [Source](https://github.com/wiremock/WireMock.Net)                                                              |
 
 ## Implement a module
 
diff --git a/examples/Flyway/Directory.Packages.props b/examples/Flyway/Directory.Packages.props
@@ -6,7 +6,7 @@
     <ItemGroup>
         <!-- Unit and integration test dependencies: -->
         <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1"/>
-        <PackageVersion Include="Testcontainers.PostgreSql" Version="4.2.0"/>
+        <PackageVersion Include="Testcontainers.PostgreSql" Version="4.7.0"/>
         <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2"/>
         <PackageVersion Include="xunit" Version="2.9.2"/>
         <!-- Third-party client dependencies to connect and interact with the containers: -->
diff --git a/examples/Respawn/Directory.Packages.props b/examples/Respawn/Directory.Packages.props
@@ -6,7 +6,7 @@
     <ItemGroup>
         <!-- Unit and integration test dependencies: -->
         <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1"/>
-        <PackageVersion Include="Testcontainers.PostgreSql" Version="4.2.0"/>
+        <PackageVersion Include="Testcontainers.PostgreSql" Version="4.7.0"/>
         <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2"/>
         <PackageVersion Include="xunit" Version="2.9.2"/>
         <!-- Third-party client dependencies to connect and interact with the containers: -->
diff --git a/examples/WeatherForecast/Directory.Packages.props b/examples/WeatherForecast/Directory.Packages.props
@@ -10,7 +10,7 @@
     <!-- Unit and integration test dependencies: -->
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1"/>
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="8.0.13"/>
-    <PackageVersion Include="Testcontainers.PostgreSql" Version="4.2.0"/>
+    <PackageVersion Include="Testcontainers.PostgreSql" Version="4.7.0"/>
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2"/>
     <PackageVersion Include="xunit" Version="2.9.2"/>
     <!-- Third-party client dependencies to connect and interact with the containers: -->
diff --git a/examples/WeatherForecast/tests/WeatherForecast.Tests/WeatherForecastContainer.cs b/examples/WeatherForecast/tests/WeatherForecast.Tests/WeatherForecastContainer.cs
@@ -40,7 +40,7 @@ public WeatherForecastContainer()
       .WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Path", WeatherForecastImage.CertificateFilePath)
       .WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Password", WeatherForecastImage.CertificatePassword)
       .WithEnvironment("ConnectionStrings__PostgreSQL", postgreSqlConnectionString)
-      .WithWaitStrategy(Wait.ForUnixContainer().UntilPortIsAvailable(WeatherForecastImage.HttpsPort))
+      .WithWaitStrategy(Wait.ForUnixContainer().UntilInternalTcpPortIsAvailable(WeatherForecastImage.HttpsPort))
       .Build();
   }
 
diff --git a/src/Testcontainers.Keycloak/KeycloakBuilder.cs b/src/Testcontainers.Keycloak/KeycloakBuilder.cs
@@ -60,6 +60,22 @@ public KeycloakBuilder WithPassword(string password)
             .WithEnvironment("KEYCLOAK_ADMIN_PASSWORD", password);
     }
 
+    /// <summary>
+    /// Configures Keycloak to import a realm configuration file during startup.
+    /// </summary>
+    /// <remarks>
+    /// The file will be copied to the <c>/opt/keycloak/data/import/</c> directory
+    /// inside the container:
+    /// https://www.keycloak.org/server/importExport#_importing_a_realm_during_startup.
+    /// </remarks>
+    /// <param name="realmConfigurationFilePath">The local path to the realm configuration file (JSON).</param>
+    /// <returns>A configured instance of <see cref="KeycloakBuilder" />.</returns>
+    public KeycloakBuilder WithRealm(string realmConfigurationFilePath)
+    {
+        return WithCommand("--import-realm")
+            .WithResourceMapping(realmConfigurationFilePath, "/opt/keycloak/data/import/");
+    }
+
     /// <inheritdoc />
     public override KeycloakContainer Build()
     {
diff --git a/src/Testcontainers.Weaviate/WeaviateBuilder.cs b/src/Testcontainers.Weaviate/WeaviateBuilder.cs
@@ -42,8 +42,8 @@ protected override WeaviateBuilder Init()
             .WithEnvironment("AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED", "true")
             .WithEnvironment("PERSISTENCE_DATA_PATH", "/var/lib/weaviate")
             .WithWaitStrategy(Wait.ForUnixContainer()
-                .UntilPortIsAvailable(WeaviateHttpPort)
-                .UntilPortIsAvailable(WeaviateGrpcPort)
+                .UntilInternalTcpPortIsAvailable(WeaviateHttpPort)
+                .UntilInternalTcpPortIsAvailable(WeaviateGrpcPort)
                 .UntilHttpRequestIsSucceeded(request =>
                     request.ForPath("/v1/.well-known/ready").ForPort(WeaviateHttpPort)));
 
diff --git a/src/Testcontainers/Configurations/WaitStrategies/IWaitForContainerOS.cs b/src/Testcontainers/Configurations/WaitStrategies/IWaitForContainerOS.cs
@@ -58,16 +58,6 @@ public interface IWaitForContainerOS
     [PublicAPI]
     IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string> command, Action<IWaitStrategy> waitStrategyModifier = null);
 
-    /// <summary>
-    /// Waits until the port is available.
-    /// </summary>
-    /// <param name="port">The port to be checked.</param>
-    /// <param name="waitStrategyModifier">The wait strategy modifier to cancel the readiness check.</param>
-    /// <returns>A configured instance of <see cref="IWaitForContainerOS" />.</returns>
-    [PublicAPI]
-    [Obsolete("Use UntilInternalTcpPortIsAvailable or UntilExternalTcpPortIsAvailable instead. This method corresponds to the internal variant.")]
-    IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
-
     /// <summary>
     /// Waits until a TCP port is available from within the container itself.
     /// This verifies that a service inside the container is listening on the specified port.
diff --git a/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerOS.cs b/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerOS.cs
@@ -27,9 +27,6 @@ protected WaitForContainerOS()
     /// <inheritdoc />
     public abstract IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string> command, Action<IWaitStrategy> waitStrategyModifier = null);
 
-    /// <inheritdoc />
-    public abstract IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
-
     /// <inheritdoc />
     public abstract IWaitForContainerOS UntilInternalTcpPortIsAvailable(int containerPort, Action<IWaitStrategy> waitStrategyModifier = null);
 
diff --git a/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerUnix.cs b/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerUnix.cs
@@ -25,12 +25,6 @@ public override IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string>
       return AddCustomWaitStrategy(new UntilUnixCommandIsCompleted(command.ToArray()), waitStrategyModifier);
     }
 
-    /// <inheritdoc />
-    public override IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
-    {
-      return UntilInternalTcpPortIsAvailable(port, waitStrategyModifier);
-    }
-
     /// <inheritdoc />
     public override IWaitForContainerOS UntilInternalTcpPortIsAvailable(int containerPort, Action<IWaitStrategy> waitStrategyModifier = null)
     {
diff --git a/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerWindows.cs b/src/Testcontainers/Configurations/WaitStrategies/WaitForContainerWindows.cs
@@ -25,12 +25,6 @@ public override IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string>
       return AddCustomWaitStrategy(new UntilWindowsCommandIsCompleted(command.ToArray()), waitStrategyModifier);
     }
 
-    /// <inheritdoc />
-    public override IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
-    {
-      return UntilInternalTcpPortIsAvailable(port, waitStrategyModifier);
-    }
-
     /// <inheritdoc />
     public override IWaitForContainerOS UntilInternalTcpPortIsAvailable(int containerPort, Action<IWaitStrategy> waitStrategyModifier = null)
     {
diff --git a/src/Testcontainers/Containers/PortForwarding.cs b/src/Testcontainers/Containers/PortForwarding.cs
@@ -107,7 +107,9 @@ protected override PortForwardingBuilder Init()
           .WithPortBinding(SshdPort, true)
           .WithUsername("root")
           .WithPassword("root")
-          .WithWaitStrategy(Wait.ForUnixContainer().UntilPortIsAvailable(SshdPort));
+          .WithWaitStrategy(Wait.ForUnixContainer()
+            .UntilInternalTcpPortIsAvailable(SshdPort)
+            .UntilExternalTcpPortIsAvailable(SshdPort));
       }
 
       /// <inheritdoc />
diff --git a/src/Testcontainers/Containers/SocatBuilder.cs b/src/Testcontainers/Containers/SocatBuilder.cs
@@ -72,7 +72,9 @@ public override SocatContainer Build()
         .Select(item => string.Format(argument, item.Key, item.Value)));
 
       var waitStrategy = DockerResourceConfiguration.Targets
-        .Aggregate(Wait.ForUnixContainer(), (waitStrategy, item) => waitStrategy.UntilPortIsAvailable(item.Key));
+        .Aggregate(Wait.ForUnixContainer(), (waitStrategy, item) => waitStrategy
+          .UntilInternalTcpPortIsAvailable(item.Key)
+          .UntilExternalTcpPortIsAvailable(item.Key));
 
       var socatBuilder = WithCommand(command).WithWaitStrategy(waitStrategy);
       return new SocatContainer(socatBuilder.DockerResourceConfiguration);
diff --git a/tests/Testcontainers.Keycloak.Tests/KeycloakContainerTest.cs b/tests/Testcontainers.Keycloak.Tests/KeycloakContainerTest.cs
@@ -85,4 +85,28 @@ public KeycloakV26Configuration()
         {
         }
     }
+
+    [UsedImplicitly]
+    public sealed class KeycloakRealmConfiguration : KeycloakContainerTest
+    {
+        public KeycloakRealmConfiguration()
+            : base(new KeycloakBuilder().WithRealm("realm-export.json").Build())
+        {
+        }
+
+        [Fact]
+        [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
+        public async Task AllRealmsAreEnabled()
+        {
+            // Given
+            var keycloakClient = new KeycloakClient(_keycloakContainer.GetBaseAddress(), KeycloakBuilder.DefaultUsername, KeycloakBuilder.DefaultPassword);
+
+            // When
+            var realms = await keycloakClient.GetRealmsAsync("master", TestContext.Current.CancellationToken)
+                .ConfigureAwait(true);
+
+            // Then
+            Assert.Collection(realms, realm => Assert.True(realm.Enabled), realm => Assert.True(realm.Enabled));
+        }
+    }
 }
diff --git a/tests/Testcontainers.Keycloak.Tests/Testcontainers.Keycloak.Tests.csproj b/tests/Testcontainers.Keycloak.Tests/Testcontainers.Keycloak.Tests.csproj
@@ -16,4 +16,9 @@
         <ProjectReference Include="../../src/Testcontainers.Keycloak/Testcontainers.Keycloak.csproj"/>
         <ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
     </ItemGroup>
+    <ItemGroup>
+        <None Update="realm-export.json">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </None>
+    </ItemGroup>
 </Project>
diff --git a/tests/Testcontainers.Keycloak.Tests/realm-export.json b/tests/Testcontainers.Keycloak.Tests/realm-export.json
@@ -0,0 +1,47 @@
+{
+  "realm": "test-realm",
+  "enabled": true,
+  "clients": [
+    {
+      "clientId": "test-client",
+      "secret": "secret",
+      "enabled": true,
+      "protocol": "openid-connect",
+      "publicClient": false,
+      "directAccessGrantsEnabled": true,
+      "serviceAccountsEnabled": true,
+      "name": "Test Client",
+      "attributes": {
+        "jwt.client.claims": "true"
+      },
+      "protocolMappers": [
+        {
+          "name": "audience",
+          "protocol": "openid-connect",
+          "protocolMapper": "oidc-audience-mapper",
+          "consentRequired": false,
+          "config": {
+            "included.client.audience": "test-client",
+            "id.token.claim": "true",
+            "access.token.claim": "true"
+          }
+        }
+      ]
+    }
+  ],
+  "users": [
+    {
+      "username": "admin",
+      "enabled": true,
+      "emailVerified": true,
+      "credentials": [
+        {
+          "type": "password",
+          "value": "admin",
+          "temporary": false
+        }
+      ],
+      "email": "admin@example.com"
+    }
+  ]
+}
diff --git a/tests/Testcontainers.Platform.Windows.Tests/WindowsContainerTest.cs b/tests/Testcontainers.Platform.Windows.Tests/WindowsContainerTest.cs
@@ -57,7 +57,7 @@ public UntilInternalTcpPortIsAvailable()
                 .WithImage(CommonImages.ServerCore)
                 .WithEntrypoint("PowerShell", "-NoLogo", "-Command")
                 .WithCommand("$tcpListener = [System.Net.Sockets.TcpListener]::new([System.Net.IPAddress]::Any, 8080); $tcpListener.Start(); Start-Sleep -Seconds 120")
-                .WithWaitStrategy(Wait.ForWindowsContainer().UntilPortIsAvailable(8080))
+                .WithWaitStrategy(Wait.ForWindowsContainer().UntilInternalTcpPortIsAvailable(8080))
                 .Build())
         {
         }
diff --git a/tests/Testcontainers.Tests/Unit/Containers/Unix/GetContainerLogsTest.cs b/tests/Testcontainers.Tests/Unit/Containers/Unix/GetContainerLogsTest.cs
@@ -10,8 +10,7 @@ public sealed class GetContainerLogsTest : IAsyncLifetime
   {
     private readonly IContainer _container = new ContainerBuilder()
       .WithImage("amazon/dynamodb-local:1.20.0")
-      .WithWaitStrategy(Wait.ForUnixContainer()
-        .UntilPortIsAvailable(8000))
+      .WithWaitStrategy(Wait.ForUnixContainer().UntilInternalTcpPortIsAvailable(8000))
       .Build();
 
     [Fact]

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public WeatherForecastContainer()`
`40`	`40`	`.WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Path", WeatherForecastImage.CertificateFilePath)`
`41`	`41`	`.WithEnvironment("ASPNETCORE_Kestrel__Certificates__Default__Password", WeatherForecastImage.CertificatePassword)`
`42`	`42`	`.WithEnvironment("ConnectionStrings__PostgreSQL", postgreSqlConnectionString)`
`43`		`- .WithWaitStrategy(Wait.ForUnixContainer().UntilPortIsAvailable(WeatherForecastImage.HttpsPort))`
	`43`	`+ .WithWaitStrategy(Wait.ForUnixContainer().UntilInternalTcpPortIsAvailable(WeatherForecastImage.HttpsPort))`
`44`	`44`	`.Build();`
`45`	`45`	`}`
`46`	`46`