testcontainers 8.10.1 → 8.11.1

package/dist/docker/docker-client.d.ts

@@ -5,5 +5,5 @@ declare type DockerClient = {
     host: Host;
     dockerode: Dockerode;
 };
-export declare const dockerClient: Promise<DockerClient>;
+export declare const dockerClient: () => Promise<DockerClient>;
 export {};

package/dist/docker/docker-client.js

@@ -153,4 +153,11 @@ const findGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* (
 });
 const findDefaultGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* () { return (0, run_in_container_1.runInContainer)(dockerode, "alpine:3.14", ["sh", "-c", "ip route|awk '/default/ { print $3 }'"]); });
 const isInContainer = () => (0, fs_1.existsSync)("/.dockerenv");
-exports.dockerClient = getDockerClient();
+let _dockerClient;
+const dockerClient = () => {
+    if (!_dockerClient) {
+        _dockerClient = getDockerClient();
+    }
+    return _dockerClient;
+};
+exports.dockerClient = dockerClient;

package/dist/docker/functions/container/create-container.js

@@ -17,7 +17,7 @@ const create_labels_1 = require("../create-labels");
 const createContainer = (options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Creating container for image: ${options.imageName}`);
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         return yield dockerode.createContainer({
             name: options.name,
             User: options.user,

package/dist/docker/functions/container/get-container.js

@@ -15,7 +15,7 @@ const logger_1 = require("../../../logger");
 const labels_1 = require("../../../labels");
 const getContainerById = (id) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         return dockerode.getContainer(id);
     }
     catch (err) {
@@ -26,7 +26,7 @@ const getContainerById = (id) => __awaiter(void 0, void 0, void 0, function* ()
 exports.getContainerById = getContainerById;
 const getContainerByHash = (hash) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const containers = yield dockerode.listContainers({
             limit: 1,
             filters: {

package/dist/docker/functions/container/list-containers.js

@@ -14,7 +14,7 @@ const docker_client_1 = require("../../docker-client");
 const logger_1 = require("../../../logger");
 const listContainers = () => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         return yield dockerode.listContainers();
     }
     catch (err) {

package/dist/docker/functions/demux-stream.js

@@ -16,7 +16,7 @@ const docker_client_1 = require("../docker-client");
 const demuxStream = (stream) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const demuxedStream = new stream_1.PassThrough({ autoDestroy: true, encoding: "utf-8" });
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         dockerode.modem.demuxStream(stream, demuxedStream, demuxedStream);
         stream.on("end", () => demuxedStream.end());
         demuxedStream.on("close", () => {

package/dist/docker/functions/get-info.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDockerInfo = void 0;
 const docker_client_1 = require("../docker-client");
 const getDockerInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-    const { dockerode } = yield docker_client_1.dockerClient;
+    const { dockerode } = yield (0, docker_client_1.dockerClient)();
     const info = yield dockerode.info();
     return {
         serverVersion: info.ServerVersion,

package/dist/docker/functions/image/build-image.js

@@ -36,7 +36,7 @@ const buildImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
                 }
             },
         });
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         return new Promise((resolve) => dockerode
             .buildImage(tarStream, {
             dockerfile: options.dockerfileName,

package/dist/docker/functions/image/list-images.js

@@ -15,7 +15,7 @@ const docker_client_1 = require("../../docker-client");
 const logger_1 = require("../../../logger");
 const listImages = () => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const images = yield dockerode.listImages();
         return images.reduce((dockerImageNames, image) => {
             var _a;

package/dist/docker/functions/image/pull-image.js

@@ -21,7 +21,7 @@ const pullImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
             return;
         }
         logger_1.log.info(`Pulling image: ${options.imageName}`);
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const stream = yield dockerode.pull(options.imageName.toString(), { authconfig: options.authConfig });
         yield new pull_stream_parser_1.PullStreamParser(options.imageName, logger_1.log).consume(stream);
     }

package/dist/docker/functions/network/connect-network.js

@@ -15,7 +15,7 @@ const docker_client_1 = require("../../docker-client");
 const connectNetwork = (options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Connecting container ${options.containerId} to network ${options.networkId}`);
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const network = dockerode.getNetwork(options.networkId);
         yield network.connect({ Container: options.containerId, EndpointConfig: { Aliases: options.networkAliases } });
     }

package/dist/docker/functions/network/create-network.js

@@ -16,7 +16,7 @@ const create_labels_1 = require("../create-labels");
 const createNetwork = (options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Creating network ${options.name}`);
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const network = yield dockerode.createNetwork({
             Name: options.name,
             CheckDuplicate: options.checkDuplicate,

package/dist/docker/functions/network/remove-network.js

@@ -15,7 +15,7 @@ const docker_client_1 = require("../../docker-client");
 const removeNetwork = (id) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Removing network ${id}`);
-        const { dockerode } = yield docker_client_1.dockerClient;
+        const { dockerode } = yield (0, docker_client_1.dockerClient)();
         const network = dockerode.getNetwork(id);
         const { message } = yield network.remove();
         if (message) {

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

@@ -119,7 +119,7 @@ class DockerComposeEnvironment {
                     }
                     throw err;
                 }
-                return new started_generic_container_1.StartedGenericContainer(container, (yield docker_client_1.dockerClient).host, inspectResult, boundPorts, containerName);
+                return new started_generic_container_1.StartedGenericContainer(container, (yield (0, docker_client_1.dockerClient)()).host, inspectResult, boundPorts, containerName);
             })))).reduce((map, startedGenericContainer) => {
                 const containerName = startedGenericContainer.getName();
                 return Object.assign(Object.assign({}, map), { [containerName]: startedGenericContainer });
@@ -130,7 +130,7 @@ class DockerComposeEnvironment {
     }
     waitForContainer(container, containerName, boundPorts) {
         return __awaiter(this, void 0, void 0, function* () {
-            const waitStrategy = this.getWaitStrategy((yield docker_client_1.dockerClient).host, container, containerName);
+            const waitStrategy = this.getWaitStrategy((yield (0, docker_client_1.dockerClient)()).host, container, containerName);
             yield waitStrategy.withStartupTimeout(this.startupTimeout).waitUntilReady(container, boundPorts);
         });
     }

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

@@ -119,7 +119,7 @@ class GenericContainer {
             const inspectResult = yield (0, inspect_container_1.inspectContainer)(startedContainer);
             const boundPorts = bound_ports_1.BoundPorts.fromInspectResult(inspectResult).filter(this.ports);
             yield this.waitForContainer(startedContainer, boundPorts);
-            return new started_generic_container_1.StartedGenericContainer(startedContainer, (yield docker_client_1.dockerClient).host, inspectResult, boundPorts, inspectResult.name);
+            return new started_generic_container_1.StartedGenericContainer(startedContainer, (yield (0, docker_client_1.dockerClient)()).host, inspectResult, boundPorts, inspectResult.name);
         });
     }
     startContainer(createContainerOptions) {
@@ -156,7 +156,7 @@ class GenericContainer {
             const inspectResult = yield (0, inspect_container_1.inspectContainer)(container);
             const boundPorts = bound_ports_1.BoundPorts.fromInspectResult(inspectResult).filter(this.ports);
             yield this.waitForContainer(container, boundPorts);
-            const startedContainer = new started_generic_container_1.StartedGenericContainer(container, (yield docker_client_1.dockerClient).host, inspectResult, boundPorts, inspectResult.name);
+            const startedContainer = new started_generic_container_1.StartedGenericContainer(container, (yield (0, docker_client_1.dockerClient)()).host, inspectResult, boundPorts, inspectResult.name);
             if (this.postStart) {
                 yield this.postStart(startedContainer, inspectResult, boundPorts);
             }
@@ -263,7 +263,7 @@ class GenericContainer {
     waitForContainer(container, boundPorts) {
         return __awaiter(this, void 0, void 0, function* () {
             logger_1.log.debug(`Waiting for container to be ready: ${container.id}`);
-            const waitStrategy = this.getWaitStrategy((yield docker_client_1.dockerClient).host, container);
+            const waitStrategy = this.getWaitStrategy((yield (0, docker_client_1.dockerClient)()).host, container);
             try {
                 yield waitStrategy.withStartupTimeout(this.startupTimeout).waitUntilReady(container, boundPorts);
                 logger_1.log.info("Container is ready");

package/dist/index.d.ts

@@ -15,3 +15,4 @@ export { Neo4jContainer, StartedNeo4jContainer } from "./modules/neo4j/neo4j-con
 export { ArangoDBContainer, StartedArangoContainer } from "./modules/arangodb/arangodb-container";
 export { ElasticsearchContainer, StartedElasticsearchContainer } from "./modules/elasticsearch/elasticsearch-container";
 export { MySqlContainer, StartedMySqlContainer } from "./modules/mysql/mysql-container";
+export { NatsContainer, StartedNatsContainer, NatsConnectionOptions, NatsTlsOptions, } from "./modules/nats/nats-container";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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;
 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");
@@ -42,3 +42,6 @@ Object.defineProperty(exports, "StartedElasticsearchContainer", { enumerable: tr
 var mysql_container_1 = require("./modules/mysql/mysql-container");
 Object.defineProperty(exports, "MySqlContainer", { enumerable: true, get: function () { return mysql_container_1.MySqlContainer; } });
 Object.defineProperty(exports, "StartedMySqlContainer", { enumerable: true, get: function () { return mysql_container_1.StartedMySqlContainer; } });
+var nats_container_1 = require("./modules/nats/nats-container");
+Object.defineProperty(exports, "NatsContainer", { enumerable: true, get: function () { return nats_container_1.NatsContainer; } });
+Object.defineProperty(exports, "StartedNatsContainer", { enumerable: true, get: function () { return nats_container_1.StartedNatsContainer; } });

package/dist/modules/nats/nats-container.d.ts

@@ -0,0 +1,55 @@
+import { GenericContainer } from "../../generic-container/generic-container";
+import { StartedTestContainer } from "../../test-container";
+import { AbstractStartedContainer } from "../abstract-started-container";
+export declare class NatsContainer extends GenericContainer {
+    private args;
+    constructor(image?: string);
+    withUser(user: string): this;
+    withPass(pass: string): this;
+    withArg(name: string, value: string): this;
+    private static ensureDashInFrontOfArgumentName;
+    start(): Promise<StartedNatsContainer>;
+    private getUser;
+    private getPass;
+}
+export declare class StartedNatsContainer extends AbstractStartedContainer {
+    readonly username: string;
+    readonly password: string;
+    private readonly connectionOptions;
+    constructor(startedTestContainer: StartedTestContainer, username: string, password: string);
+    getConnectionOptions(): NatsConnectionOptions;
+}
+export interface NatsConnectionOptions {
+    debug?: boolean;
+    maxPingOut?: number;
+    maxReconnectAttempts?: number;
+    name?: string;
+    noEcho?: boolean;
+    noRandomize?: boolean;
+    pass?: string;
+    pedantic?: boolean;
+    pingInterval?: number;
+    port?: number;
+    reconnect?: boolean;
+    reconnectDelayHandler?: () => number;
+    reconnectJitter?: number;
+    reconnectJitterTLS?: number;
+    reconnectTimeWait?: number;
+    servers?: Array<string> | string;
+    timeout?: number;
+    tls?: NatsTlsOptions;
+    token?: string;
+    user?: string;
+    verbose?: boolean;
+    waitOnFirstConnect?: boolean;
+    ignoreClusterUpdates?: boolean;
+    inboxPrefix?: string;
+}
+export interface NatsTlsOptions {
+    certFile?: string;
+    cert?: string;
+    caFile?: string;
+    ca?: string;
+    keyFile?: string;
+    key?: string;
+}

package/dist/modules/nats/nats-container.js

@@ -0,0 +1,98 @@
+"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.StartedNatsContainer = exports.NatsContainer = void 0;
+const generic_container_1 = require("../../generic-container/generic-container");
+const uuid_1 = require("../../uuid");
+const abstract_started_container_1 = require("../abstract-started-container");
+const wait_1 = require("../../wait");
+const CLIENT_PORT = 4222;
+const ROUTING_PORT_FOR_CLUSTERING = 6222;
+const HTTP_MANAGEMENT_PORT = 8222;
+const USER_ARGUMENT_KEY = "--user";
+const PASS_ARGUMENT_KEY = "--pass";
+class NatsContainer extends generic_container_1.GenericContainer {
+    constructor(image = "nats:2.8-alpine") {
+        super(image);
+        this.args = {};
+        this.args[USER_ARGUMENT_KEY] = new uuid_1.RandomUuid().nextUuid();
+        this.args[PASS_ARGUMENT_KEY] = new uuid_1.RandomUuid().nextUuid();
+    }
+    withUser(user) {
+        this.args[USER_ARGUMENT_KEY] = user;
+        return this;
+    }
+    withPass(pass) {
+        this.args[PASS_ARGUMENT_KEY] = pass;
+        return this;
+    }
+    withArg(name, value) {
+        name = NatsContainer.ensureDashInFrontOfArgumentName(name);
+        this.args[name] = value;
+        return this;
+    }
+    static ensureDashInFrontOfArgumentName(name) {
+        if (name.startsWith("--") || name.startsWith("-")) {
+            return name;
+        }
+        if (name.length == 1) {
+            return "-" + name;
+        }
+        else {
+            return "--" + name;
+        }
+    }
+    start() {
+        const _super = Object.create(null, {
+            start: { get: () => super.start }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            function buildCmdsFromArgs(args) {
+                const result = [];
+                result.push("nats-server");
+                for (const argsKey in args) {
+                    result.push(argsKey);
+                    result.push(args[argsKey]);
+                }
+                return result;
+            }
+            this.withCmd(buildCmdsFromArgs(this.args))
+                .withExposedPorts(...(this.hasExposedPorts ? this.ports : [CLIENT_PORT, ROUTING_PORT_FOR_CLUSTERING, HTTP_MANAGEMENT_PORT]))
+                .withWaitStrategy(wait_1.Wait.forLogMessage(new RegExp(".*Server is ready.*")))
+                .withStartupTimeout(120000);
+            return new StartedNatsContainer(yield _super.start.call(this), this.getUser(), this.getPass());
+        });
+    }
+    getUser() {
+        return this.args[USER_ARGUMENT_KEY];
+    }
+    getPass() {
+        return this.args[PASS_ARGUMENT_KEY];
+    }
+}
+exports.NatsContainer = NatsContainer;
+class StartedNatsContainer extends abstract_started_container_1.AbstractStartedContainer {
+    constructor(startedTestContainer, username, password) {
+        super(startedTestContainer);
+        this.username = username;
+        this.password = password;
+        const port = startedTestContainer.getMappedPort(CLIENT_PORT);
+        this.connectionOptions = {
+            servers: `${this.startedTestContainer.getHost()}:${port}`,
+            user: this.username,
+            pass: this.password,
+        };
+    }
+    getConnectionOptions() {
+        return this.connectionOptions;
+    }
+}
+exports.StartedNatsContainer = StartedNatsContainer;

package/dist/port-forwarder.js

@@ -69,7 +69,7 @@ class PortForwarderInstance {
                 `echo "${username}:$PASSWORD" | chpasswd && /usr/sbin/sshd -D -o PermitRootLogin=yes -o AddressFamily=inet -o GatewayPorts=yes`,
             ])
                 .start();
-            const host = (yield docker_client_1.dockerClient).host;
+            const host = (yield (0, docker_client_1.dockerClient)()).host;
             const port = container.getMappedPort(22);
             logger_1.log.debug(`Connecting to Port Forwarder on ${host}:${port}`);
             const connection = yield (0, ssh_remote_port_forward_1.createSshConnection)({ host, port, username, password });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.10.1",
+  "version": "8.11.1",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [
@@ -74,7 +74,8 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3",
-    "wait-for-expect": "^3.0.2"
+    "wait-for-expect": "^3.0.2",
+    "nats": "^2.7.1"
   },
   "lint-staged": {
     "src/**/*.ts": [