feat: add withPlatform-function to TestContainer

Adds the ability to the pass `--platform`-argument for the docker container refs testcontainers#773
weyert · Jul 28, 2024 · 061f15d · 061f15d
1 parent 789a723
commit 061f15d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/packages/testcontainers/src/generic-container/generic-container-builder.ts b/packages/testcontainers/src/generic-container/generic-container-builder.ts
@@ -18,6 +18,7 @@ export class GenericContainerBuilder {
   private pullPolicy: ImagePullPolicy = PullPolicy.defaultPolicy();
   private cache = true;
   private target?: string;
+  private platform?: string;
 
   constructor(
     private readonly context: string,
@@ -40,6 +41,11 @@ export class GenericContainerBuilder {
     return this;
   }
 
+  public withPlatform(platform: string): this {
+    this.platform = platform;
+    return this;
+  }
+
   public withTarget(target: string): this {
     this.target = target;
     return this;
@@ -72,6 +78,7 @@ export class GenericContainerBuilder {
       registryconfig: registryConfig,
       labels,
       target: this.target,
+      platform: this.platform,
     };
 
     if (this.pullPolicy.shouldPull()) {

diff --git a/packages/testcontainers/src/generic-container/generic-container.test.ts b/packages/testcontainers/src/generic-container/generic-container.test.ts
@@ -123,6 +123,15 @@ describe("GenericContainer", () => {
     expect(output).toEqual(expect.stringContaining("/tmp"));
   });
 
+  it("should set platform", async () => {
+    const container = await new GenericContainer("amd64/alpine")
+      .withPlatform("linux/amd64")
+      .withExposedPorts(8080)
+      .start();
+
+    await checkContainerIsHealthy(container);
+  });
+
   it("should set entrypoint", async () => {
     const container = await new GenericContainer("cristianrgreco/testcontainer:1.1.14")
       .withEntrypoint(["node"])

diff --git a/packages/testcontainers/src/generic-container/generic-container.ts b/packages/testcontainers/src/generic-container/generic-container.ts
@@ -278,6 +278,11 @@ export class GenericContainer implements TestContainer {
     return this;
   }
 
+  public withPlatform(platform: string): this {
+    this.createOpts.platform = platform;
+    return this;
+  }
+
   public withTmpFs(tmpFs: TmpFs): this {
     this.hostConfig.Tmpfs = { ...this.hostConfig.Tmpfs, ...tmpFs };
     return this;

diff --git a/packages/testcontainers/src/test-container.ts b/packages/testcontainers/src/test-container.ts
@@ -36,6 +36,7 @@ export interface TestContainer {
   withExtraHosts(extraHosts: ExtraHost[]): this;
   withDefaultLogDriver(): this;
   withPrivilegedMode(): this;
+  withPlatform(platform: string): this;
   withUser(user: string): this;
   withPullPolicy(pullPolicy: ImagePullPolicy): this;
   withReuse(): this;