Make the image platform configurable

Author: 0xced

src/Testcontainers/Clients/DockerImageOperations.cs

@@ -60,6 +60,7 @@ public async Task CreateAsync(IImage image, IDockerRegistryAuthenticationConfigu
       var createParameters = new ImagesCreateParameters
       {
         FromImage = image.FullName,
+        Platform = image.Platform,
       };
 
       var authConfig = new AuthConfig

src/Testcontainers/Images/DockerImage.cs

@@ -31,12 +31,15 @@ public sealed class DockerImage : IImage
     [CanBeNull]
     private readonly string _digest;
 
+    [CanBeNull]
+    private readonly string _platform;
+
     /// <summary>
     /// Initializes a new instance of the <see cref="DockerImage" /> class.
     /// </summary>
     /// <param name="image">The image.</param>
     public DockerImage(IImage image)
-      : this(image.Repository, image.Registry, image.Tag, image.Digest)
+      : this(image.Repository, image.Registry, image.Tag, image.Digest, image.Platform)
     {
     }
 
@@ -57,19 +60,22 @@ public DockerImage(string image)
     /// <param name="registry">The registry.</param>
     /// <param name="tag">The tag.</param>
     /// <param name="digest">The digest.</param>
+    /// <param name="platform">The platform.</param>
     /// <param name="hubImageNamePrefix">The Docker Hub image name prefix.</param>
     /// <example><c>fedora/httpd:version1.0</c> where <c>fedora/httpd</c> is the repository and <c>version1.0</c> the tag.</example>
     public DockerImage(
       string repository,
       string registry = null,
       string tag = null,
       string digest = null,
+      string platform = null,
       string hubImageNamePrefix = null)
       : this(
         TrimOrDefault(repository),
         TrimOrDefault(registry),
         TrimOrDefault(tag, tag == null && digest == null ? LatestTag : null),
         TrimOrDefault(digest),
+        TrimOrDefault(platform),
         hubImageNamePrefix == null ? [] : hubImageNamePrefix.Trim(TrimChars).Split(SlashChar, 2, StringSplitOptions.RemoveEmptyEntries))
     {
     }
@@ -79,6 +85,7 @@ private DockerImage(
       string registry,
       string tag,
       string digest,
+      string platform,
       string[] substitutions)
     {
       _ = Guard.Argument(repository, nameof(repository))
@@ -109,6 +116,7 @@ private DockerImage(
 
       _tag = tag;
       _digest = digest;
+      _platform = platform;
     }
 
     /// <inheritdoc />
@@ -123,6 +131,9 @@ private DockerImage(
     /// <inheritdoc />
     public string Digest => _digest;
 
+    /// <inheritdoc />
+    public string Platform => _platform;
+
     /// <inheritdoc />
     public string FullName
     {

src/Testcontainers/Images/FutureDockerImage.cs

@@ -68,6 +68,16 @@ public string Digest
       }
     }
 
+    /// <inheritdoc />
+    public string Platform
+    {
+      get
+      {
+        ThrowIfResourceNotFound();
+        return _configuration.Image.Platform;
+      }
+    }
+
     /// <inheritdoc />
     public string FullName
     {

src/Testcontainers/Images/IImage.cs

@@ -33,6 +33,15 @@ public interface IImage
     [CanBeNull]
     string Digest { get; }
 
+    /// <summary>
+    /// Gets the platform. Supported format is <c>&lt;os&gt;|&lt;arch&gt;|&lt;os&gt;/&lt;arch&gt;[/&lt;variant&gt;]</c>. Either the operating system or the architecture or both can be provided.
+    /// </summary>
+    /// <remarks>
+    /// See https://github.com/containerd/platforms for more information.
+    /// </remarks>
+    [CanBeNull]
+    string Platform { get; }
+
     /// <summary>
     /// Gets the full image name.
     /// </summary>

src/Testcontainers/Images/IImageExtensions.cs

@@ -27,7 +27,7 @@ public static IImage ApplyHubImageNamePrefix(this IImage image)
         return image;
       }
 
-      return new DockerImage(image.Repository, image.Registry, image.Tag, image.Digest, TestcontainersSettings.HubImageNamePrefix);
+      return new DockerImage(image.Repository, image.Registry, image.Tag, image.Digest, image.Platform, TestcontainersSettings.HubImageNamePrefix);
     }
   }
 }

tests/Testcontainers.Tests/Fixtures/Images/DockerImageFixture.cs

@@ -37,8 +37,8 @@ public DockerImageFixture()
       Add(new DockerImageFixtureSerializable(new DockerImage(FedoraHttpd, PortSeparatorRegistry, CustomTag1, null)), $"{PortSeparatorRegistry}/{FedoraHttpd}:{CustomTag1}", $"{PortSeparatorRegistry}/{FedoraHttpd}:{CustomTag1}");
       Add(new DockerImageFixtureSerializable(new DockerImage(FooBarBaz, DotSeparatorRegistry, SemVerTag, Digest)), $"{DotSeparatorRegistry}/{FooBarBaz}:{SemVerTag}@{Digest}", $"{DotSeparatorRegistry}/{FooBarBaz}:{SemVerTag}@{Digest}");
       Add(new DockerImageFixtureSerializable(new DockerImage(FooBarBaz, DotSeparatorRegistry, null, Digest)), $"{DotSeparatorRegistry}/{FooBarBaz}@{Digest}", $"{DotSeparatorRegistry}/{FooBarBaz}@{Digest}");
-      Add(new DockerImageFixtureSerializable(new DockerImage(BarBaz, null, null, null, HubImageNamePrefixImplicitLibrary)), $"{HubImageNamePrefixImplicitLibrary}/{BarBaz}", $"{HubImageNamePrefixImplicitLibrary}/{BarBaz}:{LatestTag}");
-      Add(new DockerImageFixtureSerializable(new DockerImage(BarBaz, null, null, null, HubImageNamePrefixExplicitLibrary)), $"{HubImageNamePrefixExplicitLibrary}/{BarBaz}", $"{HubImageNamePrefixExplicitLibrary}/{BarBaz}:{LatestTag}");
+      Add(new DockerImageFixtureSerializable(new DockerImage(BarBaz, null, null, null, null, HubImageNamePrefixImplicitLibrary)), $"{HubImageNamePrefixImplicitLibrary}/{BarBaz}", $"{HubImageNamePrefixImplicitLibrary}/{BarBaz}:{LatestTag}");
+      Add(new DockerImageFixtureSerializable(new DockerImage(BarBaz, null, null, null, null, HubImageNamePrefixExplicitLibrary)), $"{HubImageNamePrefixExplicitLibrary}/{BarBaz}", $"{HubImageNamePrefixExplicitLibrary}/{BarBaz}:{LatestTag}");
     }
   }
 }

tests/Testcontainers.Tests/Fixtures/Images/DockerImageFixtureSerializable.cs

@@ -22,7 +22,8 @@ public void Deserialize(IXunitSerializationInfo info)
       var registry = info.GetValue<string>("Registry");
       var tag = info.GetValue<string>("Tag");
       var digest = info.GetValue<string>("Digest");
-      Image = new DockerImage(repository, registry, tag, digest);
+      var platform = info.GetValue<string>("Platform");
+      Image = new DockerImage(repository, registry, tag, digest, platform);
     }
 
     public void Serialize(IXunitSerializationInfo info)
@@ -31,6 +32,7 @@ public void Serialize(IXunitSerializationInfo info)
       info.AddValue("Registry", Image.Registry);
       info.AddValue("Tag", Image.Tag);
       info.AddValue("Digest", Image.Digest);
+      info.AddValue("Platform", Image.Platform);
     }
   }
 }

tests/Testcontainers.Tests/Fixtures/Images/HealthCheckFixture.cs

@@ -23,6 +23,8 @@ public sealed class HealthCheckFixture : IImage, IAsyncLifetime
 
     public string Digest => _image.Digest;
 
+    public string Platform => _image.Platform;
+
     public string FullName => _image.FullName;
 
     public string GetHostname()

tests/Testcontainers.Tests/Unit/Images/TestcontainersImageTest.cs

@@ -65,6 +65,7 @@ public void WhenImageNameGetsAssigned(DockerImageFixtureSerializable serializabl
       Assert.Equal(expected.Registry, actual.Registry);
       Assert.Equal(expected.Tag, actual.Tag);
       Assert.Equal(expected.Digest, actual.Digest);
+      Assert.Equal(expected.Platform, actual.Platform);
       Assert.Equal(expected.FullName, actual.FullName);
       Assert.Equal(fullName, actual.FullName);
     }