testcontainers 9.3.0 → 9.4.0

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "testcontainers",
     "author": "Cristian Greco",
-    "version": "9.3.0",
+    "version": "9.4.0",
     "main": "dist/src/index",
     "types": "dist/src/index",
     "keywords": [
@@ -38,7 +38,7 @@
     "dependencies": {
         "@balena/dockerignore": "^1.0.2",
         "@types/archiver": "^5.3.2",
-        "@types/dockerode": "^3.3.15",
+        "@types/dockerode": "^3.3.16",
         "archiver": "^5.3.1",
         "async-lock": "^1.4.0",
         "byline": "^5.0.0",
@@ -56,33 +56,33 @@
         "@types/async-lock": "^1.4.0",
         "@types/byline": "^4.2.33",
         "@types/debug": "4.1.7",
-        "@types/jest": "^29.2.6",
-        "@types/node": "^18.11.19",
-        "@types/node-fetch": "^2.6.2",
+        "@types/jest": "^29.5.0",
+        "@types/node": "^18.15.11",
+        "@types/node-fetch": "^2.6.3",
         "@types/pg": "^8.6.6",
         "@types/properties-reader": "^2.1.1",
         "@types/tar-fs": "^2.0.1",
-        "@typescript-eslint/eslint-plugin": "^5.41.0",
-        "@typescript-eslint/parser": "^5.41.0",
-        "arangojs": "^8.0.0",
+        "@typescript-eslint/eslint-plugin": "^5.57.0",
+        "@typescript-eslint/parser": "^5.57.0",
+        "arangojs": "^8.2.0",
         "cross-env": "^7.0.3",
-        "eslint": "^8.26.0",
-        "eslint-config-prettier": "^8.5.0",
+        "eslint": "^8.37.0",
+        "eslint-config-prettier": "^8.8.0",
         "eslint-plugin-prettier": "^4.2.1",
         "husky": "^8.0.3",
         "jest": "^29.5.0",
         "kafkajs": "^2.2.4",
-        "lint-staged": "^13.0.4",
-        "mongoose": "^6.7.5",
+        "lint-staged": "^13.2.0",
+        "mongoose": "^6.10.4",
         "mysql2": "^2.3.3",
-        "nats": "^2.8.0",
-        "neo4j-driver": "^5.2.0",
-        "pg": "^8.8.0",
-        "prettier": "^2.7.1",
+        "nats": "^2.13.1",
+        "neo4j-driver": "^5.6.0",
+        "pg": "^8.10.0",
+        "prettier": "^2.8.7",
         "rimraf": "^3.0.2",
         "ts-jest": "^29.0.5",
         "ts-node": "^10.9.1",
-        "typescript": "^4.8.4",
+        "typescript": "^4.9.5",
         "wait-for-expect": "^3.0.2"
     },
     "lint-staged": {

package/dist/src/docker/docker-client.js

@@ -18,7 +18,6 @@ const path_1 = __importDefault(require("path"));
 const logger_1 = require("../logger");
 const url_1 = require("url");
 const fs_1 = require("fs");
-const run_in_container_1 = require("./functions/run-in-container");
 const session_id_1 = require("./session-id");
 const lookup_host_ips_1 = require("./lookup-host-ips");
 const system_info_1 = require("../system-info");
@@ -26,6 +25,7 @@ const rootless_unix_socket_strategy_1 = require("./rootless-unix-socket-strategy
 const stream_utils_1 = require("../stream-utils");
 const stream_1 = require("stream");
 const docker_client_config_1 = require("./docker-client-config");
+const resolve_host_1 = require("./resolve-host");
 const getDockerClient = () => __awaiter(void 0, void 0, void 0, function* () {
     const strategies = [
         new ConfigurationStrategy(),
@@ -43,7 +43,7 @@ const getDockerClient = () => __awaiter(void 0, void 0, void 0, function* () {
             logger_1.log.debug(`Testing Docker client strategy URI: ${uri}`);
             if (yield isDockerDaemonReachable(dockerode)) {
                 const indexServerAddress = (yield (0, system_info_1.getSystemInfo)(dockerode)).dockerInfo.indexServerAddress;
-                const host = yield resolveHost(dockerode, indexServerAddress, uri);
+                const host = yield (0, resolve_host_1.resolveHost)(dockerode, indexServerAddress, uri);
                 const hostIps = yield (0, lookup_host_ips_1.lookupHostIps)(host);
                 logger_1.log.info(`Using Docker client strategy: ${strategy.getName()}, Docker host: ${host} (${hostIps
                     .map((hostIp) => hostIp.address)
@@ -145,49 +145,6 @@ class NpipeSocketStrategy {
         return "NpipeSocketStrategy";
     }
 }
-const resolveHost = (dockerode, indexServerAddress, uri) => __awaiter(void 0, void 0, void 0, function* () {
-    if (process.env.TESTCONTAINERS_HOST_OVERRIDE !== undefined) {
-        return process.env.TESTCONTAINERS_HOST_OVERRIDE;
-    }
-    const { protocol, hostname } = new url_1.URL(uri);
-    switch (protocol) {
-        case "http:":
-        case "https:":
-        case "tcp:":
-            return hostname;
-        case "unix:":
-        case "npipe:": {
-            if (isInContainer()) {
-                const gateway = yield findGateway(dockerode);
-                if (gateway !== undefined) {
-                    return gateway;
-                }
-                const defaultGateway = yield findDefaultGateway(dockerode, indexServerAddress);
-                if (defaultGateway !== undefined) {
-                    return defaultGateway;
-                }
-            }
-            return "localhost";
-        }
-        default:
-            throw new Error(`Unsupported protocol: ${protocol}`);
-    }
-});
-const findGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c;
-    logger_1.log.debug(`Checking gateway for Docker host`);
-    const inspectResult = yield dockerode.getNetwork("bridge").inspect();
-    return (_c = (_b = (_a = inspectResult === null || inspectResult === void 0 ? void 0 : inspectResult.IPAM) === null || _a === void 0 ? void 0 : _a.Config) === null || _b === void 0 ? void 0 : _b.find((config) => config.Gateway !== undefined)) === null || _c === void 0 ? void 0 : _c.Gateway;
-});
-const findDefaultGateway = (dockerode, indexServerAddress) => __awaiter(void 0, void 0, void 0, function* () {
-    logger_1.log.debug(`Checking default gateway for Docker host`);
-    return (0, run_in_container_1.runInContainer)(dockerode, indexServerAddress, "alpine:3.14", [
-        "sh",
-        "-c",
-        "ip route|awk '/default/ { print $3 }'",
-    ]);
-});
-const isInContainer = () => (0, fs_1.existsSync)("/.dockerenv");
 let _dockerClient;
 const dockerClient = () => {
     if (!_dockerClient) {

package/dist/src/docker/functions/container/exec-container.d.ts

@@ -1,9 +1,3 @@
 import { ExecResult } from "../../types";
 import Dockerode from "dockerode";
-type ExecContainerOptions = {
-    tty: boolean;
-    stdin: boolean;
-    detach: boolean;
-};
-export declare const execContainer: (container: Dockerode.Container, command: string[], options: ExecContainerOptions, shouldLog?: boolean) => Promise<ExecResult>;
-export {};
+export declare const execContainer: (container: Dockerode.Container, command: string[], shouldLog?: boolean) => Promise<ExecResult>;

package/dist/src/docker/functions/container/exec-container.js

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.execContainer = void 0;
 const logger_1 = require("../../../logger");
 const byline_1 = __importDefault(require("byline"));
-const execContainer = (container, command, options, shouldLog = true) => __awaiter(void 0, void 0, void 0, function* () {
+const execContainer = (container, command, shouldLog = true) => __awaiter(void 0, void 0, void 0, function* () {
     const chunks = [];
     try {
         const exec = yield container.exec({
@@ -23,7 +23,7 @@ const execContainer = (container, command, options, shouldLog = true) => __await
             AttachStdout: true,
             AttachStderr: true,
         });
-        const stream = yield startExec(exec, options);
+        const stream = yield startExec(exec);
         stream.on("data", (chunk) => chunks.push(chunk));
         if (shouldLog && logger_1.execLog.enabled()) {
             (0, byline_1.default)(stream).on("data", (line) => logger_1.execLog.trace(`${container.id}: ${line}`));
@@ -38,9 +38,9 @@ const execContainer = (container, command, options, shouldLog = true) => __await
     }
 });
 exports.execContainer = execContainer;
-const startExec = (exec, options) => __awaiter(void 0, void 0, void 0, function* () {
+const startExec = (exec) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const stream = yield exec.start(options);
+        const stream = yield exec.start({ stdin: true, Detach: false, Tty: true });
         stream.setEncoding("utf-8");
         return stream;
     }

package/dist/src/docker/resolve-host.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import Dockerode from "dockerode";
+export declare const resolveHost: (dockerode: Dockerode, indexServerAddress: string, uri: string, env?: NodeJS.ProcessEnv) => Promise<string>;

package/dist/src/docker/resolve-host.js

@@ -0,0 +1,60 @@
+"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.resolveHost = void 0;
+const url_1 = require("url");
+const logger_1 = require("../logger");
+const run_in_container_1 = require("./functions/run-in-container");
+const fs_1 = require("fs");
+const resolveHost = (dockerode, indexServerAddress, uri, env = process.env) => __awaiter(void 0, void 0, void 0, function* () {
+    if (env.TESTCONTAINERS_HOST_OVERRIDE !== undefined) {
+        return env.TESTCONTAINERS_HOST_OVERRIDE;
+    }
+    const { protocol, hostname } = new url_1.URL(uri);
+    switch (protocol) {
+        case "http:":
+        case "https:":
+        case "tcp:":
+            return hostname;
+        case "unix:":
+        case "npipe:": {
+            if (isInContainer()) {
+                const gateway = yield findGateway(dockerode);
+                if (gateway !== undefined) {
+                    return gateway;
+                }
+                const defaultGateway = yield findDefaultGateway(dockerode, indexServerAddress);
+                if (defaultGateway !== undefined) {
+                    return defaultGateway;
+                }
+            }
+            return "localhost";
+        }
+        default:
+            throw new Error(`Unsupported protocol: ${protocol}`);
+    }
+});
+exports.resolveHost = resolveHost;
+const findGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    logger_1.log.debug(`Checking gateway for Docker host`);
+    const inspectResult = yield dockerode.getNetwork("bridge").inspect();
+    return (_c = (_b = (_a = inspectResult === null || inspectResult === void 0 ? void 0 : inspectResult.IPAM) === null || _a === void 0 ? void 0 : _a.Config) === null || _b === void 0 ? void 0 : _b.find((config) => config.Gateway !== undefined)) === null || _c === void 0 ? void 0 : _c.Gateway;
+});
+const findDefaultGateway = (dockerode, indexServerAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    logger_1.log.debug(`Checking default gateway for Docker host`);
+    return (0, run_in_container_1.runInContainer)(dockerode, indexServerAddress, "alpine:3.14", [
+        "sh",
+        "-c",
+        "ip route|awk '/default/ { print $3 }'",
+    ]);
+});
+const isInContainer = () => (0, fs_1.existsSync)("/.dockerenv");

package/dist/src/docker-compose/default-docker-compose-options.js

@@ -22,11 +22,23 @@ var __rest = (this && this.__rest) || function (s, e) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultDockerComposeOptions = void 0;
 const docker_client_1 = require("../docker/docker-client");
+const logger_1 = require("../logger");
+const os_1 = require("os");
+const type_guards_1 = require("../type-guards");
 const defaultDockerComposeOptions = (_a) => __awaiter(void 0, void 0, void 0, function* () {
     var { environment = {} } = _a, options = __rest(_a, ["environment"]);
     const { composeEnvironment } = yield (0, docker_client_1.dockerClient)();
     return {
         log: false,
+        callback: logger_1.log.enabled()
+            ? (chunk) => {
+                chunk
+                    .toString()
+                    .split(os_1.EOL)
+                    .filter(type_guards_1.isNotEmptyString)
+                    .forEach((line) => logger_1.log.trace(line.trim()));
+            }
+            : undefined,
         cwd: options.filePath,
         config: options.files,
         composeOptions: options.composeOptions,

package/dist/src/docker-compose/functions/docker-compose-up.js

@@ -27,8 +27,8 @@ const dockerComposeUp = (options, services) => __awaiter(void 0, void 0, void 0,
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
     }
     catch (err) {
-        const errorMessage = err.err || err.message || err;
-        logger_1.log.error(`Failed to up DockerCompose environment: ${errorMessage}`);
+        const errorMessage = err.err || err.message || err || "";
+        logger_1.log.error(`Failed to up DockerCompose environment: ${errorMessage.trim()}`);
         try {
             yield (0, docker_compose_down_1.dockerComposeDown)(options, { removeVolumes: true, timeout: 0 });
         }

package/dist/src/docker-compose-environment/docker-compose-environment.d.ts

@@ -1,4 +1,4 @@
-import { WaitStrategy } from "../wait-strategy";
+import { WaitStrategy } from "../wait-strategy/wait-strategy";
 import { Uuid } from "../uuid";
 import { Environment } from "../docker/types";
 import { StartedDockerComposeEnvironment } from "./started-docker-compose-environment";

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

@@ -14,7 +14,6 @@ const bound_ports_1 = require("../bound-ports");
 const container_name_resolver_1 = require("../docker-compose/functions/container-name-resolver");
 const started_generic_container_1 = require("../generic-container/started-generic-container");
 const logger_1 = require("../logger");
-const wait_strategy_1 = require("../wait-strategy");
 const reaper_1 = require("../reaper");
 const uuid_1 = require("../uuid");
 const list_containers_1 = require("../docker/functions/container/list-containers");
@@ -26,6 +25,7 @@ const started_docker_compose_environment_1 = require("./started-docker-compose-e
 const docker_compose_down_1 = require("../docker-compose/functions/docker-compose-down");
 const docker_compose_up_1 = require("../docker-compose/functions/docker-compose-up");
 const wait_for_container_1 = require("../wait-for-container");
+const default_wait_strategy_1 = require("../wait-strategy/default-wait-strategy");
 class DockerComposeEnvironment {
     constructor(composeFilePath, composeFiles, uuid = new uuid_1.RandomUuid()) {
         this.build = false;
@@ -102,10 +102,12 @@ class DockerComposeEnvironment {
                 const { host, hostIps } = yield (0, docker_client_1.dockerClient)();
                 const inspectResult = yield (0, inspect_container_1.inspectContainer)(container);
                 const boundPorts = bound_ports_1.BoundPorts.fromInspectResult(hostIps, inspectResult);
-                const waitStrategy = (this.waitStrategy[containerName] ? this.waitStrategy[containerName] : (0, wait_strategy_1.defaultWaitStrategy)(host, container)).withStartupTimeout(this.startupTimeout);
-                (yield (0, container_logs_1.containerLogs)(container))
-                    .on("data", (data) => logger_1.containerLog.trace(`${containerName}: ${data}`))
-                    .on("err", (data) => logger_1.containerLog.error(`${containerName}: ${data}`));
+                const waitStrategy = (this.waitStrategy[containerName] ? this.waitStrategy[containerName] : (0, default_wait_strategy_1.defaultWaitStrategy)(host, container)).withStartupTimeout(this.startupTimeout);
+                if (logger_1.containerLog.enabled()) {
+                    (yield (0, container_logs_1.containerLogs)(container))
+                        .on("data", (data) => logger_1.containerLog.trace(`${containerName}: ${data.trim()}`))
+                        .on("err", (data) => logger_1.containerLog.error(`${containerName}: ${data.trim()}`));
+                }
                 try {
                     logger_1.log.info(`Waiting for container ${containerName} to be ready`);
                     yield (0, wait_for_container_1.waitForContainer)(container, waitStrategy, host, boundPorts);

package/dist/src/dockerfile-parser.js

@@ -14,6 +14,7 @@ const os_1 = require("os");
 const fs_1 = require("fs");
 const logger_1 = require("./logger");
 const docker_image_name_1 = require("./docker-image-name");
+const type_guards_1 = require("./type-guards");
 const buildArgRegex = /\${([^{]+)}/g;
 const getDockerfileImages = (dockerfile, buildArgs) => __awaiter(void 0, void 0, void 0, function* () {
     try {
@@ -32,7 +33,7 @@ function parseImages(dockerfile) {
         return Array.from((yield fs_1.promises.readFile(dockerfile, "utf8"))
             .split(os_1.EOL)
             .filter((line) => line.toUpperCase().startsWith("FROM"))
-            .map((line) => line.split(" ").filter((part) => part !== "")[1])
+            .map((line) => line.split(" ").filter(type_guards_1.isNotEmptyString)[1])
             .reduce((prev, next) => prev.add(next), new Set())
             .values());
     });

package/dist/src/generic-container/create-container-options.d.ts

@@ -0,0 +1,3 @@
+import { CreateContainerOptions } from "../docker/functions/container/create-container";
+import { DockerImageName } from "../docker-image-name";
+export declare const initCreateContainerOptions: (imageName: DockerImageName, autoRemove: boolean) => CreateContainerOptions;

package/dist/src/generic-container/create-container-options.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCreateContainerOptions = void 0;
+const initCreateContainerOptions = (imageName, autoRemove) => ({
+    imageName,
+    autoRemove,
+    environment: {},
+    exposedPorts: [],
+    command: [],
+    bindMounts: [],
+    labels: {},
+    tmpFs: {},
+    useDefaultLogDriver: false,
+    privilegedMode: false,
+    reusable: false,
+    extraHosts: [],
+});
+exports.initCreateContainerOptions = initCreateContainerOptions;

package/dist/src/generic-container/generic-container.d.ts

@@ -3,47 +3,38 @@ import { BoundPorts } from "../bound-ports";
 import { PortWithOptionalBinding } from "../port";
 import { PullPolicy } from "../pull-policy";
 import { StartedTestContainer, TestContainer } from "../test-container";
-import { WaitStrategy } from "../wait-strategy";
-import { BindMount, ContentToCopy, Environment, ExtraHost, FileToCopy, HealthCheck, Labels, TmpFs, Ulimits, ResourcesQuota } from "../docker/types";
+import { WaitStrategy } from "../wait-strategy/wait-strategy";
+import { BindMount, ContentToCopy, Environment, ExtraHost, FileToCopy, HealthCheck, Labels, ResourcesQuota, TmpFs, Ulimits } from "../docker/types";
+import { CreateContainerOptions } from "../docker/functions/container/create-container";
 import { InspectResult } from "../docker/functions/container/inspect-container";
 import { GenericContainerBuilder } from "./generic-container-builder";
 import { StartedNetwork } from "../network";
 export declare class GenericContainer implements TestContainer {
     readonly image: string;
     static fromDockerfile(context: string, dockerfileName?: string): GenericContainerBuilder;
-    private readonly imageName;
-    protected environment: Environment;
+    protected opts: CreateContainerOptions;
+    protected startupTimeout: number;
+    protected waitStrategy?: WaitStrategy;
+    protected tarToCopy?: archiver.Archiver;
     protected networkMode?: string;
     protected networkAliases: string[];
-    protected ports: PortWithOptionalBinding[];
-    protected command: string[];
-    protected entrypoint?: string[];
-    protected bindMounts: BindMount[];
-    protected name?: string;
-    protected labels: Labels;
-    protected tmpFs: TmpFs;
-    protected healthCheck?: HealthCheck;
-    protected waitStrategy?: WaitStrategy;
-    protected startupTimeout: number;
-    protected useDefaultLogDriver: boolean;
-    protected privilegedMode: boolean;
-    protected workingDir?: string;
-    protected ipcMode?: string;
-    protected ulimits?: Ulimits;
-    protected addedCapabilities?: string[];
-    protected droppedCapabilities?: string[];
-    protected user?: string;
     protected pullPolicy: PullPolicy;
-    protected reuse: boolean;
-    protected tarToCopy?: archiver.Archiver;
-    protected resourcesQuota?: ResourcesQuota;
-    private extraHosts;
     constructor(image: string);
+    /**
+     * @deprecated Since version 9.4.0. Will be removed in version 10.0.0. Use `beforeContainerStarted` instead.
+     */
     protected preStart?(): Promise<void>;
+    protected beforeContainerStarted?(): Promise<void>;
+    protected containerCreated?(containerId: string): Promise<void>;
+    protected containerStarting?(inspectResult: InspectResult, reused: boolean): Promise<void>;
     start(): Promise<StartedTestContainer>;
     private reuseContainer;
     private startContainer;
+    /**
+     * @deprecated Since version 9.4.0. Will be removed in version 10.0.0. Use `containerStarted` instead.
+     */
     protected postStart?(container: StartedTestContainer, inspectResult: InspectResult, boundPorts: BoundPorts): Promise<void>;
+    protected containerStarted?(container: StartedTestContainer, inspectResult: InspectResult, reused: boolean): Promise<void>;
     protected get hasExposedPorts(): boolean;
     withCommand(command: string[]): this;
     withEntrypoint(entrypoint: string[]): this;