testcontainers 9.0.1 → 9.1.0

package/README.md

@@ -832,6 +832,85 @@ const container = await new GenericContainer("redis")
   .start();
 ```
 
+### HTTP
+
+Default behaviour of waiting for a 200 response:
+
+```javascript
+const { GenericContainer, Wait } = require("testcontainers");
+
+const container = await new GenericContainer("redis")
+  .withExposedPorts(6379)
+  .withWaitStrategy(Wait.forHttp("/health", 8080))
+  .start();
+```
+
+Specify status code:
+
+```javascript
+.withWaitStrategy(Wait.forHttp("/health", 8080)
+  .forStatusCode(201))
+
+.withWaitStrategy(Wait.forHttp("/health", 8080)
+  .forStatusCodeMatching(statusCode => statusCode === 201))
+```
+
+Specify response body:
+
+```javascript
+.withWaitStrategy(Wait.forHttp("/health", 8080)
+  .forResponsePredicate(response => response === "OK"))
+```
+
+Customise the request:
+
+```javascript
+.withWaitStrategy(Wait.forHttp("/health", 8080)
+  .withMethod("POST")
+  .withHeaders({ X_CUSTOM_VALUE: "custom" })
+  .withBasicCredentials("username", "password")
+  .withReadTimeout(10000))
+```
+
+Use TLS:
+
+```javascript
+.withWaitStrategy(Wait.forHttp("/health", 8443)
+  .useTls())
+```
+
+Allow insecure TLS:
+
+```javascript
+.withWaitStrategy(Wait.forHttp("/health", 8443)
+  .useTls()
+  .insecureTls())
+```
+
+### Other Startup Strategies
+
+If none of these options meet your requirements, you can create your own subclass of `StartupCheckStrategy`:
+
+```javascript
+const Dockerode = require("dockerode");
+const { 
+  GenericContainer, 
+  StartupCheckStrategy,
+  StartupStatus
+} = require("testcontainers");
+
+class ReadyAfterDelayWaitStrategy extends StartupCheckStrategy {
+  public checkStartupState(dockerClient: Dockerode, containerId: string): Promise<StartupStatus> {
+    return new Promise((resolve) => setTimeout(() => resolve("SUCCESS"), 3000));
+  }
+}
+
+const container = await new GenericContainer("redis")
+  .withExposedPorts(6379)
+  .withWaitStrategy(new ReadyAfterDelayWaitStrategy())
+  .start();
+```
+
 ## Authentication
 
 Testcontainers will automatically pick up and use credentials from `$HOME/.docker/config.json`, using

package/dist/docker-compose-environment/docker-compose-environment.js

@@ -108,7 +108,7 @@ class DockerComposeEnvironment {
                 const waitStrategy = (this.waitStrategy[containerName] ? this.waitStrategy[containerName] : (0, wait_strategy_1.defaultWaitStrategy)(host, container)).withStartupTimeout(this.startupTimeout);
                 try {
                     logger_1.log.info(`Waiting for container ${containerName} to be ready`);
-                    yield (0, wait_for_container_1.waitForContainer)(container, waitStrategy, boundPorts);
+                    yield (0, wait_for_container_1.waitForContainer)(container, waitStrategy, host, boundPorts);
                     logger_1.log.info(`Container ${containerName} is ready`);
                 }
                 catch (err) {

package/dist/generic-container/generic-container.js

@@ -123,7 +123,7 @@ class GenericContainer {
             const boundPorts = bound_ports_1.BoundPorts.fromInspectResult(inspectResult).filter(this.ports);
             const host = (yield (0, docker_client_1.dockerClient)()).host;
             const waitStrategy = ((_a = this.waitStrategy) !== null && _a !== void 0 ? _a : (0, wait_strategy_1.defaultWaitStrategy)(host, startedContainer)).withStartupTimeout(this.startupTimeout);
-            yield (0, wait_for_container_1.waitForContainer)(startedContainer, waitStrategy, boundPorts);
+            yield (0, wait_for_container_1.waitForContainer)(startedContainer, waitStrategy, host, boundPorts);
             return new started_generic_container_1.StartedGenericContainer(startedContainer, host, inspectResult, boundPorts, inspectResult.name, waitStrategy);
         });
     }
@@ -163,7 +163,7 @@ class GenericContainer {
             const boundPorts = bound_ports_1.BoundPorts.fromInspectResult(inspectResult).filter(this.ports);
             const host = (yield (0, docker_client_1.dockerClient)()).host;
             const waitStrategy = ((_a = this.waitStrategy) !== null && _a !== void 0 ? _a : (0, wait_strategy_1.defaultWaitStrategy)(host, container)).withStartupTimeout(this.startupTimeout);
-            yield (0, wait_for_container_1.waitForContainer)(container, waitStrategy, boundPorts);
+            yield (0, wait_for_container_1.waitForContainer)(container, waitStrategy, host, boundPorts);
             const startedContainer = new started_generic_container_1.StartedGenericContainer(container, host, inspectResult, boundPorts, inspectResult.name, waitStrategy);
             if (this.postStart) {
                 yield this.postStart(startedContainer, inspectResult, boundPorts);

package/dist/generic-container/started-generic-container.js

@@ -40,7 +40,7 @@ class StartedGenericContainer {
             yield (0, restart_container_1.restartContainer)(this.container, resolvedOptions);
             this.inspectResult = yield (0, inspect_container_1.inspectContainer)(this.container);
             this.boundPorts = bound_ports_1.BoundPorts.fromInspectResult(this.inspectResult).filter(Array.from(this.boundPorts.iterator()).map((port) => port[0]));
-            yield (0, wait_for_container_1.waitForContainer)(this.container, this.waitStrategy, this.boundPorts);
+            yield (0, wait_for_container_1.waitForContainer)(this.container, this.waitStrategy, this.host, this.boundPorts);
         });
     }
     stopContainer(options = {}) {

package/dist/http-wait-strategy.d.ts

@@ -0,0 +1,27 @@
+import Dockerode from "dockerode";
+import { BoundPorts } from "./bound-ports";
+import { AbstractWaitStrategy } from "./wait-strategy";
+export declare class HttpWaitStrategy extends AbstractWaitStrategy {
+    private readonly path;
+    private readonly port;
+    private protocol;
+    private method;
+    private headers;
+    private predicates;
+    private _allowInsecure;
+    private readTimeout;
+    constructor(path: string, port: number);
+    forStatusCode(statusCode: number): HttpWaitStrategy;
+    forStatusCodeMatching(predicate: (statusCode: number) => boolean): HttpWaitStrategy;
+    forResponsePredicate(predicate: (response: string) => boolean): HttpWaitStrategy;
+    withMethod(method: string): HttpWaitStrategy;
+    withHeaders(headers: {
+        [key: string]: string;
+    }): HttpWaitStrategy;
+    withBasicCredentials(username: string, password: string): HttpWaitStrategy;
+    withReadTimeout(readTimeout: number): HttpWaitStrategy;
+    usingTls(): HttpWaitStrategy;
+    allowInsecure(): HttpWaitStrategy;
+    waitUntilReady(container: Dockerode.Container, host: string, boundPorts: BoundPorts): Promise<void>;
+    private getAgent;
+}

package/dist/http-wait-strategy.js

@@ -0,0 +1,107 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpWaitStrategy = void 0;
+const wait_strategy_1 = require("./wait-strategy");
+const retry_strategy_1 = require("./retry-strategy");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const https_1 = __importDefault(require("https"));
+class HttpWaitStrategy extends wait_strategy_1.AbstractWaitStrategy {
+    constructor(path, port) {
+        super();
+        this.protocol = "http";
+        this.method = "GET";
+        this.headers = {};
+        this.predicates = [];
+        this._allowInsecure = false;
+        this.readTimeout = 1000;
+        this.path = path;
+        this.port = port;
+    }
+    forStatusCode(statusCode) {
+        this.predicates.push((response) => __awaiter(this, void 0, void 0, function* () { return response.status === statusCode; }));
+        return this;
+    }
+    forStatusCodeMatching(predicate) {
+        this.predicates.push((response) => __awaiter(this, void 0, void 0, function* () { return predicate(response.status); }));
+        return this;
+    }
+    forResponsePredicate(predicate) {
+        this.predicates.push((response) => __awaiter(this, void 0, void 0, function* () { return predicate(yield response.text()); }));
+        return this;
+    }
+    withMethod(method) {
+        this.method = method;
+        return this;
+    }
+    withHeaders(headers) {
+        this.headers = Object.assign(Object.assign({}, this.headers), headers);
+        return this;
+    }
+    withBasicCredentials(username, password) {
+        const base64Encoded = Buffer.from(`${username}:${password}`).toString("base64");
+        this.headers = Object.assign(Object.assign({}, this.headers), { Authorization: `Bearer ${base64Encoded}` });
+        return this;
+    }
+    withReadTimeout(readTimeout) {
+        this.readTimeout = readTimeout;
+        return this;
+    }
+    usingTls() {
+        this.protocol = "https";
+        return this;
+    }
+    allowInsecure() {
+        this._allowInsecure = true;
+        return this;
+    }
+    waitUntilReady(container, host, boundPorts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield new retry_strategy_1.IntervalRetryStrategy(this.readTimeout).retryUntil(() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const url = `${this.protocol}://${host}:${boundPorts.getBinding(this.port)}${this.path}`;
+                    return yield (0, node_fetch_1.default)(url, {
+                        method: this.method,
+                        timeout: this.readTimeout,
+                        headers: this.headers,
+                        agent: this.getAgent(),
+                    });
+                }
+                catch (_a) {
+                    return undefined;
+                }
+            }), (response) => {
+                if (response === undefined) {
+                    return false;
+                }
+                else if (!this.predicates.length) {
+                    return response.ok;
+                }
+                else {
+                    return this.predicates.every((predicate) => predicate(response));
+                }
+            }, () => {
+                throw new Error(`URL ${this.path} not accessible after ${this.startupTimeout}ms for ${container.id}`);
+            }, this.startupTimeout);
+        });
+    }
+    getAgent() {
+        if (this._allowInsecure) {
+            return new https_1.default.Agent({
+                rejectUnauthorized: false,
+            });
+        }
+    }
+}
+exports.HttpWaitStrategy = HttpWaitStrategy;

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export { StoppedDockerComposeEnvironment } from "./docker-compose-environment/st
 export { DownedDockerComposeEnvironment } from "./docker-compose-environment/downed-docker-compose-environment";
 export { Network, StartedNetwork, StoppedNetwork } from "./network";
 export { Wait } from "./wait";
+export { StartupCheckStrategy, StartupStatus } from "./startup-check-strategy";
 export { PullPolicy, DefaultPullPolicy, AlwaysPullPolicy } from "./pull-policy";
 export { PostgreSqlContainer, StartedPostgreSqlContainer } from "./modules/postgresql/postgresql-container";
 export { KafkaContainer, StartedKafkaContainer } from "./modules/kafka/kafka-container";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StartedMongoDBContainer = exports.MongoDBContainer = exports.StartedNatsContainer = exports.NatsContainer = exports.StartedMySqlContainer = exports.MySqlContainer = exports.StartedElasticsearchContainer = exports.ElasticsearchContainer = exports.StartedArangoContainer = exports.ArangoDBContainer = exports.StartedNeo4jContainer = exports.Neo4jContainer = exports.StartedKafkaContainer = exports.KafkaContainer = exports.StartedPostgreSqlContainer = exports.PostgreSqlContainer = exports.AlwaysPullPolicy = exports.DefaultPullPolicy = exports.Wait = exports.StoppedNetwork = exports.StartedNetwork = exports.Network = exports.DownedDockerComposeEnvironment = exports.StoppedDockerComposeEnvironment = exports.StartedDockerComposeEnvironment = exports.DockerComposeEnvironment = exports.TestContainers = exports.GenericContainerBuilder = exports.GenericContainer = void 0;
+exports.StartedMongoDBContainer = exports.MongoDBContainer = exports.StartedNatsContainer = exports.NatsContainer = exports.StartedMySqlContainer = exports.MySqlContainer = exports.StartedElasticsearchContainer = exports.ElasticsearchContainer = exports.StartedArangoContainer = exports.ArangoDBContainer = exports.StartedNeo4jContainer = exports.Neo4jContainer = exports.StartedKafkaContainer = exports.KafkaContainer = exports.StartedPostgreSqlContainer = exports.PostgreSqlContainer = exports.AlwaysPullPolicy = exports.DefaultPullPolicy = exports.StartupCheckStrategy = exports.Wait = exports.StoppedNetwork = exports.StartedNetwork = exports.Network = exports.DownedDockerComposeEnvironment = exports.StoppedDockerComposeEnvironment = exports.StartedDockerComposeEnvironment = exports.DockerComposeEnvironment = exports.TestContainers = exports.GenericContainerBuilder = exports.GenericContainer = void 0;
 var generic_container_1 = require("./generic-container/generic-container");
 Object.defineProperty(exports, "GenericContainer", { enumerable: true, get: function () { return generic_container_1.GenericContainer; } });
 var generic_container_builder_1 = require("./generic-container/generic-container-builder");
@@ -21,6 +21,8 @@ Object.defineProperty(exports, "StartedNetwork", { enumerable: true, get: functi
 Object.defineProperty(exports, "StoppedNetwork", { enumerable: true, get: function () { return network_1.StoppedNetwork; } });
 var wait_1 = require("./wait");
 Object.defineProperty(exports, "Wait", { enumerable: true, get: function () { return wait_1.Wait; } });
+var startup_check_strategy_1 = require("./startup-check-strategy");
+Object.defineProperty(exports, "StartupCheckStrategy", { enumerable: true, get: function () { return startup_check_strategy_1.StartupCheckStrategy; } });
 var pull_policy_1 = require("./pull-policy");
 Object.defineProperty(exports, "DefaultPullPolicy", { enumerable: true, get: function () { return pull_policy_1.DefaultPullPolicy; } });
 Object.defineProperty(exports, "AlwaysPullPolicy", { enumerable: true, get: function () { return pull_policy_1.AlwaysPullPolicy; } });

package/dist/startup-check-strategy.d.ts

@@ -0,0 +1,8 @@
+import { AbstractWaitStrategy } from "./wait-strategy";
+import Dockerode from "dockerode";
+import { BoundPorts } from "./bound-ports";
+export declare type StartupStatus = "PENDING" | "SUCCESS" | "FAIL";
+export declare abstract class StartupCheckStrategy extends AbstractWaitStrategy {
+    abstract checkStartupState(dockerClient: Dockerode, containerId: string): Promise<StartupStatus>;
+    waitUntilReady(container: Dockerode.Container, host: string, ports: BoundPorts): Promise<void>;
+}

package/dist/startup-check-strategy.js

@@ -0,0 +1,30 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartupCheckStrategy = void 0;
+const wait_strategy_1 = require("./wait-strategy");
+const retry_strategy_1 = require("./retry-strategy");
+const docker_client_1 = require("./docker/docker-client");
+class StartupCheckStrategy extends wait_strategy_1.AbstractWaitStrategy {
+    waitUntilReady(container, host, ports) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { dockerode } = yield (0, docker_client_1.dockerClient)();
+            const startupStatus = yield new retry_strategy_1.IntervalRetryStrategy(1000).retryUntil(() => __awaiter(this, void 0, void 0, function* () { return yield this.checkStartupState(dockerode, container.id); }), (startupStatus) => startupStatus === "SUCCESS" || startupStatus === "FAIL", () => new Error(`Container not accessible after ${this.startupTimeout}ms for ${container.id}`), this.startupTimeout);
+            if (startupStatus instanceof Error) {
+                throw startupStatus;
+            }
+            else if (startupStatus === "FAIL") {
+                throw new Error(`Container failed to start for ${container.id}`);
+            }
+        });
+    }
+}
+exports.StartupCheckStrategy = StartupCheckStrategy;

package/dist/wait-for-container.d.ts

@@ -1,4 +1,4 @@
 import Dockerode from "dockerode";
 import { BoundPorts } from "./bound-ports";
 import { WaitStrategy } from "./wait-strategy";
-export declare const waitForContainer: (container: Dockerode.Container, waitStrategy: WaitStrategy, boundPorts: BoundPorts) => Promise<void>;
+export declare const waitForContainer: (container: Dockerode.Container, waitStrategy: WaitStrategy, host: string, boundPorts: BoundPorts) => Promise<void>;

package/dist/wait-for-container.js

@@ -13,10 +13,10 @@ exports.waitForContainer = void 0;
 const logger_1 = require("./logger");
 const stop_container_1 = require("./docker/functions/container/stop-container");
 const remove_container_1 = require("./docker/functions/container/remove-container");
-const waitForContainer = (container, waitStrategy, boundPorts) => __awaiter(void 0, void 0, void 0, function* () {
+const waitForContainer = (container, waitStrategy, host, boundPorts) => __awaiter(void 0, void 0, void 0, function* () {
     logger_1.log.debug(`Waiting for container to be ready: ${container.id}`);
     try {
-        yield waitStrategy.waitUntilReady(container, boundPorts);
+        yield waitStrategy.waitUntilReady(container, host, boundPorts);
         logger_1.log.info("Container is ready");
     }
     catch (err) {

package/dist/wait-strategy.d.ts

@@ -2,19 +2,19 @@ import { BoundPorts } from "./bound-ports";
 import { PortCheck } from "./port-check";
 import Dockerode from "dockerode";
 export interface WaitStrategy {
-    waitUntilReady(container: Dockerode.Container, boundPorts: BoundPorts): Promise<void>;
+    waitUntilReady(container: Dockerode.Container, host: string, boundPorts: BoundPorts): Promise<void>;
     withStartupTimeout(startupTimeout: number): WaitStrategy;
 }
-declare abstract class AbstractWaitStrategy implements WaitStrategy {
+export declare abstract class AbstractWaitStrategy implements WaitStrategy {
     protected startupTimeout: number;
-    abstract waitUntilReady(container: Dockerode.Container, boundPorts: BoundPorts): Promise<void>;
+    abstract waitUntilReady(container: Dockerode.Container, host: string, boundPorts: BoundPorts): Promise<void>;
     withStartupTimeout(startupTimeout: number): WaitStrategy;
 }
 export declare class HostPortWaitStrategy extends AbstractWaitStrategy {
     private readonly hostPortCheck;
     private readonly internalPortCheck;
     constructor(hostPortCheck: PortCheck, internalPortCheck: PortCheck);
-    waitUntilReady(container: Dockerode.Container, boundPorts: BoundPorts): Promise<void>;
+    waitUntilReady(container: Dockerode.Container, host: string, boundPorts: BoundPorts): Promise<void>;
     private waitForHostPorts;
     private waitForInternalPorts;
     private waitForPort;
@@ -29,4 +29,3 @@ export declare class HealthCheckWaitStrategy extends AbstractWaitStrategy {
     waitUntilReady(container: Dockerode.Container): Promise<void>;
 }
 export declare const defaultWaitStrategy: (host: string, container: Dockerode.Container) => HostPortWaitStrategy;
-export {};

package/dist/wait-strategy.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultWaitStrategy = exports.HealthCheckWaitStrategy = exports.LogWaitStrategy = exports.HostPortWaitStrategy = void 0;
+exports.defaultWaitStrategy = exports.HealthCheckWaitStrategy = exports.LogWaitStrategy = exports.HostPortWaitStrategy = exports.AbstractWaitStrategy = void 0;
 const byline_1 = __importDefault(require("byline"));
 const logger_1 = require("./logger");
 const port_check_1 = require("./port-check");
@@ -28,13 +28,14 @@ class AbstractWaitStrategy {
         return this;
     }
 }
+exports.AbstractWaitStrategy = AbstractWaitStrategy;
 class HostPortWaitStrategy extends AbstractWaitStrategy {
     constructor(hostPortCheck, internalPortCheck) {
         super();
         this.hostPortCheck = hostPortCheck;
         this.internalPortCheck = internalPortCheck;
     }
-    waitUntilReady(container, boundPorts) {
+    waitUntilReady(container, host, boundPorts) {
         return __awaiter(this, void 0, void 0, function* () {
             yield Promise.all([this.waitForHostPorts(container, boundPorts), this.waitForInternalPorts(container, boundPorts)]);
         });

package/dist/wait.d.ts

@@ -1,5 +1,7 @@
 import { Log, WaitStrategy } from "./wait-strategy";
+import { HttpWaitStrategy } from "./http-wait-strategy";
 export declare class Wait {
     static forLogMessage(message: Log | RegExp): WaitStrategy;
     static forHealthCheck(): WaitStrategy;
+    static forHttp(path: string, port: number): HttpWaitStrategy;
 }

package/dist/wait.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Wait = void 0;
 const wait_strategy_1 = require("./wait-strategy");
+const http_wait_strategy_1 = require("./http-wait-strategy");
 class Wait {
     static forLogMessage(message) {
         return new wait_strategy_1.LogWaitStrategy(message);
@@ -9,5 +10,8 @@ class Wait {
     static forHealthCheck() {
         return new wait_strategy_1.HealthCheckWaitStrategy();
     }
+    static forHttp(path, port) {
+        return new http_wait_strategy_1.HttpWaitStrategy(path, port);
+    }
 }
 exports.Wait = Wait;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "9.0.1",
+  "version": "9.1.0",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [