Allow user healthcheck override

Author: cristianrgreco

packages/modules/postgresql/src/postgresql-container.test.ts

@@ -1,5 +1,6 @@
 import { Client } from "pg";
 import { PostgreSqlContainer } from "./postgresql-container";
+import { Wait } from "testcontainers";
 
 describe("PostgreSqlContainer", () => {
   jest.setTimeout(180_000);
@@ -103,4 +104,15 @@ describe("PostgreSqlContainer", () => {
     await client.end();
     await container.stop();
   });
+
+  it("should allow custom healthcheck", async () => {
+    const container = new PostgreSqlContainer().withHealthCheck({
+      test: ["CMD-SHELL", "exit 1"],
+      interval: 100,
+      retries: 0,
+      timeout: 0,
+    });
+
+    await expect(() => container.start()).rejects.toThrow();
+  });
 });

packages/modules/postgresql/src/postgresql-container.ts

@@ -9,7 +9,9 @@ export class PostgreSqlContainer extends GenericContainer {
 
   constructor(image = "postgres:13.3-alpine") {
     super(image);
-    this.withExposedPorts(POSTGRES_PORT).withStartupTimeout(120_000);
+    this.withExposedPorts(POSTGRES_PORT);
+    this.withWaitStrategy(Wait.forHealthCheck());
+    this.withStartupTimeout(120_000);
   }
 
   public withDatabase(database: string): this {
@@ -33,13 +35,14 @@ export class PostgreSqlContainer extends GenericContainer {
       POSTGRES_USER: this.username,
       POSTGRES_PASSWORD: this.password,
     });
-    this.withHealthCheck({
-      test: ["CMD-SHELL", `PGPASSWORD=${this.password} psql -U ${this.username} -d ${this.database} -c 'SELECT 1;'`],
-      interval: 250,
-      timeout: 1000,
-      retries: 1000,
-    });
-    this.withWaitStrategy(Wait.forHealthCheck());
+    if (!this.healthCheck) {
+      this.withHealthCheck({
+        test: ["CMD-SHELL", `PGPASSWORD=${this.password} psql -U ${this.username} -d ${this.database} -c 'SELECT 1;'`],
+        interval: 250,
+        timeout: 1000,
+        retries: 1000,
+      });
+    }
     return new StartedPostgreSqlContainer(await super.start(), this.database, this.username, this.password);
   }
 }

packages/testcontainers/src/generic-container/generic-container.ts

@@ -57,6 +57,7 @@ export class GenericContainer implements TestContainer {
   protected filesToCopy: FileToCopy[] = [];
   protected directoriesToCopy: DirectoryToCopy[] = [];
   protected contentsToCopy: ContentToCopy[] = [];
+  protected healthCheck?: HealthCheck;
 
   constructor(image: string) {
     this.imageName = ImageName.fromString(image);
@@ -387,13 +388,15 @@ export class GenericContainer implements TestContainer {
   public withHealthCheck(healthCheck: HealthCheck): this {
     const toNanos = (duration: number): number => duration * 1e6;
 
+    this.healthCheck = healthCheck;
     this.createOpts.Healthcheck = {
       Test: healthCheck.test,
       Interval: healthCheck.interval ? toNanos(healthCheck.interval) : 0,
       Timeout: healthCheck.timeout ? toNanos(healthCheck.timeout) : 0,
       Retries: healthCheck.retries || 0,
       StartPeriod: healthCheck.startPeriod ? toNanos(healthCheck.startPeriod) : 0,
     };
+
     return this;
   }