Add support for docker-compose pull policy (#530)

Author: cristianrgreco

docs/features/compose.md

@@ -41,6 +41,16 @@ const environment = await new DockerComposeEnvironment(composeFilePath, composeF
   .up();
 ```
 
+### With a pull policy
+
+```javascript
+const { DockerComposeEnvironment, AlwaysPullPolicy } = require("testcontainers");
+
+const environment = await new DockerComposeEnvironment(composeFilePath, composeFile)
+  .withPullPolicy(new AlwaysPullPolicy())
+  .up();
+```
+
 ### With rebuild
 
 ```javascript

src/docker-compose-environment/docker-compose-environment.test.ts

@@ -7,7 +7,9 @@ import {
   composeContainerName,
   getRunningContainerNames,
   getVolumeNames,
+  waitForDockerEvent,
 } from "../test-helper";
+import { AlwaysPullPolicy } from "../pull-policy";
 
 describe("DockerComposeEnvironment", () => {
   jest.setTimeout(180_000);
@@ -38,6 +40,30 @@ describe("DockerComposeEnvironment", () => {
     await startedEnvironment.down();
   });
 
+  it("should use pull policy", async () => {
+    const env = new DockerComposeEnvironment(fixtures, "docker-compose-with-many-services.yml");
+
+    const startedEnv1 = await env.up();
+    const dockerPullEventPromise = waitForDockerEvent("pull", 2);
+    const startedEnv2 = await env.withPullPolicy(new AlwaysPullPolicy()).up();
+    await dockerPullEventPromise;
+
+    await startedEnv1.stop();
+    await startedEnv2.stop();
+  });
+
+  it("should use pull policy for specific service", async () => {
+    const env = new DockerComposeEnvironment(fixtures, "docker-compose-with-many-services.yml");
+
+    const startedEnv1 = await env.up(["service_2"]);
+    const dockerPullEventPromise = waitForDockerEvent("pull");
+    const startedEnv2 = await env.withPullPolicy(new AlwaysPullPolicy()).up(["service_2"]);
+    await dockerPullEventPromise;
+
+    await startedEnv1.stop();
+    await startedEnv2.stop();
+  });
+
   it("should start environment with multiple compose files", async () => {
     const overrideFixtures = path.resolve(fixtures, "docker-compose-with-override");
 

src/docker-compose-environment/docker-compose-environment.ts

@@ -17,6 +17,8 @@ import { dockerComposeDown } from "../docker-compose/functions/docker-compose-do
 import { dockerComposeUp } from "../docker-compose/functions/docker-compose-up";
 import { waitForContainer } from "../wait-for-container";
 import { defaultWaitStrategy } from "../wait-strategy/default-wait-strategy";
+import { DefaultPullPolicy, PullPolicy } from "../pull-policy";
+import { dockerComposePull } from "../docker-compose/functions/docker-compose-pull";
 
 export class DockerComposeEnvironment {
   private readonly composeFilePath: string;
@@ -28,6 +30,7 @@ export class DockerComposeEnvironment {
   private environmentFile = "";
   private profiles: string[] = [];
   private environment: Environment = {};
+  private pullPolicy: PullPolicy = new DefaultPullPolicy();
   private waitStrategy: { [containerName: string]: WaitStrategy } = {};
   private startupTimeout = 60_000;
 
@@ -63,6 +66,11 @@ export class DockerComposeEnvironment {
     return this;
   }
 
+  public withPullPolicy(pullPolicy: PullPolicy): this {
+    this.pullPolicy = pullPolicy;
+    return this;
+  }
+
   public withWaitStrategy(containerName: string, waitStrategy: WaitStrategy): this {
     this.waitStrategy[containerName] = waitStrategy;
     return this;
@@ -98,6 +106,9 @@ export class DockerComposeEnvironment {
     }
     this.profiles.forEach((profile) => composeOptions.push("--profile", profile));
 
+    if (this.pullPolicy.shouldPull()) {
+      await dockerComposePull(options, services);
+    }
     await dockerComposeUp({ ...options, commandOptions, composeOptions, environment: this.environment }, services);
 
     const startedContainers = (await listContainers()).filter(

src/docker-compose/functions/docker-compose-pull.ts

@@ -0,0 +1,22 @@
+import { log } from "../../logger";
+import { pullAll, pullMany } from "docker-compose";
+import { defaultDockerComposeOptions } from "../default-docker-compose-options";
+import { DockerComposeOptions } from "../docker-compose-options";
+
+export const dockerComposePull = async (options: DockerComposeOptions, services?: Array<string>): Promise<void> => {
+  try {
+    if (services) {
+      log.info(`Pulling DockerCompose environment images for ${services.join(", ")}`);
+      await pullMany(services, await defaultDockerComposeOptions(options));
+    } else {
+      log.info(`Pulling DockerCompose environment images`);
+      await pullAll(await defaultDockerComposeOptions(options));
+    }
+    log.info(`Pulled DockerCompose environment`);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (err: any) {
+    const errorMessage = err.err || err.message || err || "";
+    log.error(`Failed to pull DockerCompose environment images: ${errorMessage.trim()}`);
+    throw new Error(errorMessage);
+  }
+};

src/generic-container/generic-container-dockerfile.test.ts

@@ -2,7 +2,7 @@ import path from "path";
 import { GenericContainer } from "./generic-container";
 import { AlwaysPullPolicy } from "../pull-policy";
 import { Wait } from "../wait-strategy/wait";
-import { checkContainerIsHealthy, getEvents } from "../test-helper";
+import { checkContainerIsHealthy, waitForDockerEvent } from "../test-helper";
 
 describe("GenericContainer Dockerfile", () => {
   jest.setTimeout(180_000);
@@ -22,29 +22,13 @@ describe("GenericContainer Dockerfile", () => {
   // https://github.com/containers/podman/issues/17779
   if (!process.env["CI_PODMAN"]) {
     it("should use pull policy", async () => {
-      const containerSpec = GenericContainer.fromDockerfile(path.resolve(fixtures, "docker")).withPullPolicy(
-        new AlwaysPullPolicy()
-      );
-      await containerSpec.build();
+      const dockerfile = path.resolve(fixtures, "docker");
+      const containerSpec = GenericContainer.fromDockerfile(dockerfile).withPullPolicy(new AlwaysPullPolicy());
 
-      const events = await getEvents();
-      const pullPromise = new Promise<void>((resolve) => {
-        events.on("data", (data) => {
-          try {
-            const { status } = JSON.parse(data);
-            if (status === "pull") {
-              resolve();
-            }
-          } catch {
-            // ignored
-          }
-        });
-      });
       await containerSpec.build();
-
-      await pullPromise;
-
-      events.destroy();
+      const dockerPullEventPromise = waitForDockerEvent("pull");
+      await containerSpec.build();
+      await dockerPullEventPromise;
     });
   }
 

src/generic-container/generic-container.test.ts

@@ -3,7 +3,7 @@ import path from "path";
 import getPort from "get-port";
 import { GenericContainer } from "./generic-container";
 import { AlwaysPullPolicy } from "../pull-policy";
-import { checkContainerIsHealthy, getEvents } from "../test-helper";
+import { checkContainerIsHealthy, waitForDockerEvent } from "../test-helper";
 import { getContainerById } from "../docker/functions/container/get-container";
 
 describe("GenericContainer", () => {
@@ -220,30 +220,15 @@ describe("GenericContainer", () => {
   });
 
   it("should use pull policy", async () => {
-    const container1 = await new GenericContainer("cristianrgreco/testcontainer:1.1.14").withExposedPorts(8080).start();
-    const events = await getEvents();
-    const pullPromise = new Promise<void>((resolve, reject) => {
-      events.on("data", (data) => {
-        try {
-          if (JSON.parse(data).status === "pull") {
-            resolve();
-          }
-        } catch (err) {
-          reject(`Unexpected err: ${err}`);
-        }
-      });
-    });
-
-    const container2 = await new GenericContainer("cristianrgreco/testcontainer:1.1.14")
-      .withPullPolicy(new AlwaysPullPolicy())
-      .withExposedPorts(8080)
-      .start();
+    const container = new GenericContainer("cristianrgreco/testcontainer:1.1.14").withExposedPorts(8080);
 
-    await pullPromise;
+    const startedContainer1 = await container.start();
+    const dockerPullEventPromise = waitForDockerEvent("pull");
+    const startedContainer2 = await container.withPullPolicy(new AlwaysPullPolicy()).start();
+    await dockerPullEventPromise;
 
-    events.destroy();
-    await container1.stop();
-    await container2.stop();
+    await startedContainer1.stop();
+    await startedContainer2.stop();
   });
 
   it("should set the IPC mode", async () => {

src/test-helper.ts

@@ -76,3 +76,24 @@ export const composeContainerName = async (serviceName: string, index = 1): Prom
   const { dockerComposeInfo } = await getSystemInfo(dockerode);
   return dockerComposeInfo?.version.startsWith("1.") ? `${serviceName}_${index}` : `${serviceName}-${index}`;
 };
+
+export const waitForDockerEvent = async (event: string, times = 1) => {
+  const events = await getEvents();
+
+  let currentTimes = 0;
+  return new Promise<void>((resolve, reject) => {
+    events.on("data", (data) => {
+      try {
+        if (JSON.parse(data).status === event) {
+          if (++currentTimes === times) {
+            resolve();
+            events.destroy();
+          }
+        }
+      } catch (err) {
+        reject(`Unexpected err: ${err}`);
+        events.destroy();
+      }
+    });
+  });
+};