feat: Add WithPlatform(string) container builder API

Author: HofmeisterAn

src/Testcontainers/Builders/ContainerBuilder`3.cs

@@ -95,6 +95,12 @@ public TBuilderEntity WithImage(IImage image)
       return Clone(new ContainerConfiguration(image: image.ApplyHubImageNamePrefix()));
     }
 
+    /// <inheritdoc />
+    public TBuilderEntity WithPlatform(string platform)
+    {
+      return Clone(new ContainerConfiguration(platform: platform));
+    }
+
     /// <inheritdoc />
     public TBuilderEntity WithImagePullPolicy(Func<ImageInspectResponse, bool> imagePullPolicy)
     {

src/Testcontainers/Builders/IContainerBuilder`2.cs

@@ -87,6 +87,14 @@ public interface IContainerBuilder<out TBuilderEntity, out TContainerEntity, out
     [PublicAPI]
     TBuilderEntity WithImage(IImage image);
 
+    /// <summary>
+    /// Sets the platform.
+    /// </summary>
+    /// <param name="platform">The platform.</param>
+    /// <returns>A configured instance of <typeparamref name="TBuilderEntity" />.</returns>
+    [PublicAPI]
+    TBuilderEntity WithPlatform(string platform);
+
     /// <summary>
     /// Sets the image pull policy.
     /// </summary>

src/Testcontainers/Clients/DockerImageOperations.cs

@@ -55,11 +55,12 @@ public async Task<bool> ExistsWithIdAsync(string id, CancellationToken ct = defa
       }
     }
 
-    public async Task CreateAsync(IImage image, IDockerRegistryAuthenticationConfiguration dockerRegistryAuthConfig, CancellationToken ct = default)
+    public async Task CreateAsync(IImage image, IDockerRegistryAuthenticationConfiguration dockerRegistryAuthConfig, string platform = null, CancellationToken ct = default)
     {
       var createParameters = new ImagesCreateParameters
       {
         FromImage = image.FullName,
+        Platform = platform,
       };
 
       var authConfig = new AuthConfig

src/Testcontainers/Clients/IDockerImageOperations.cs

@@ -8,7 +8,7 @@ namespace DotNet.Testcontainers.Clients
 
   internal interface IDockerImageOperations : IHasListOperations<ImagesListResponse, ImageInspectResponse>
   {
-    Task CreateAsync(IImage image, IDockerRegistryAuthenticationConfiguration dockerRegistryAuthConfig, CancellationToken ct = default);
+    Task CreateAsync(IImage image, IDockerRegistryAuthenticationConfiguration dockerRegistryAuthConfig, string platform = null, CancellationToken ct = default);
 
     Task DeleteAsync(IImage image, CancellationToken ct = default);
 

src/Testcontainers/Clients/TestcontainersClient.cs

@@ -334,7 +334,7 @@ public async Task<string> RunAsync(IContainerConfiguration configuration, Cancel
 
       if (configuration.ImagePullPolicy(cachedImage))
       {
-        await PullImageAsync(configuration.Image, ct)
+        await PullImageAsync(configuration.Image, configuration.Platform, ct)
           .ConfigureAwait(false);
       }
 
@@ -392,7 +392,7 @@ public async Task<string> BuildAsync(IImageFromDockerfileConfiguration configura
 
         var uncachedImages = baseImages.Where(baseImage => !repositoryTags.Contains(baseImage.FullName));
 
-        await Task.WhenAll(uncachedImages.Select(image => PullImageAsync(image, ct)))
+        await Task.WhenAll(uncachedImages.Select(image => PullImageAsync(image, null, ct)))
           .ConfigureAwait(false);
 
         _ = await Image.BuildAsync(configuration, dockerfileArchive, ct)
@@ -406,8 +406,9 @@ await Task.WhenAll(uncachedImages.Select(image => PullImageAsync(image, ct)))
     /// Pulls an image from a registry.
     /// </summary>
     /// <param name="image">The image to pull.</param>
+    /// <param name="platform">The platform.</param>
     /// <param name="ct">Cancellation token.</param>
-    private async Task PullImageAsync(IImage image, CancellationToken ct = default)
+    private async Task PullImageAsync(IImage image, string platform = null, CancellationToken ct = default)
     {
       var dockerRegistryServerAddress = image.GetHostname();
 
@@ -427,7 +428,7 @@ private async Task PullImageAsync(IImage image, CancellationToken ct = default)
 
       var authConfig = _registryAuthenticationProvider.GetAuthConfig(dockerRegistryServerAddress);
 
-      await Image.CreateAsync(image, authConfig, ct)
+      await Image.CreateAsync(image, authConfig, platform, ct)
         .ConfigureAwait(false);
     }
   }

src/Testcontainers/Configurations/Containers/ContainerConfiguration.cs

@@ -20,6 +20,7 @@ public class ContainerConfiguration : ResourceConfiguration<CreateContainerParam
     /// Initializes a new instance of the <see cref="ContainerConfiguration" /> class.
     /// </summary>
     /// <param name="image">The image.</param>
+    /// <param name="platform">The platform.</param>
     /// <param name="imagePullPolicy">The image pull policy.</param>
     /// <param name="name">The name.</param>
     /// <param name="hostname">The hostname.</param>
@@ -43,6 +44,7 @@ public class ContainerConfiguration : ResourceConfiguration<CreateContainerParam
     /// <param name="privileged">A value indicating whether the privileged flag is set or not.</param>
     public ContainerConfiguration(
       IImage image = null,
+      string platform = null,
       Func<ImageInspectResponse, bool> imagePullPolicy = null,
       string name = null,
       string hostname = null,
@@ -69,6 +71,7 @@ public ContainerConfiguration(
       AutoRemove = autoRemove;
       Privileged = privileged;
       Image = image;
+      Platform = platform;
       ImagePullPolicy = imagePullPolicy;
       Name = name;
       Hostname = hostname;
@@ -118,6 +121,7 @@ public ContainerConfiguration(IContainerConfiguration oldValue, IContainerConfig
       : base(oldValue, newValue)
     {
       Image = BuildConfiguration.Combine(oldValue.Image, newValue.Image);
+      Platform = BuildConfiguration.Combine(oldValue.Platform, newValue.Platform);
       ImagePullPolicy = BuildConfiguration.Combine(oldValue.ImagePullPolicy, newValue.ImagePullPolicy);
       Name = BuildConfiguration.Combine(oldValue.Name, newValue.Name);
       Hostname = BuildConfiguration.Combine(oldValue.Hostname, newValue.Hostname);
@@ -153,6 +157,10 @@ public ContainerConfiguration(IContainerConfiguration oldValue, IContainerConfig
     /// <inheritdoc />
     public IImage Image { get; }
 
+    /// <inheritdoc />
+    [JsonIgnore]
+    public string Platform { get; }
+
     /// <inheritdoc />
     [JsonIgnore]
     public Func<ImageInspectResponse, bool> ImagePullPolicy { get; }

src/Testcontainers/Configurations/Containers/IContainerConfiguration.cs

@@ -31,6 +31,11 @@ public interface IContainerConfiguration : IResourceConfiguration<CreateContaine
     /// </summary>
     IImage Image { get; }
 
+    /// <summary>
+    /// Gets the platform.
+    /// </summary>
+    string Platform { get; }
+
     /// <summary>
     /// Gets the image pull policy.
     /// </summary>