testcontainers 8.10.2-beta.0 → 8.12.0

package/README.md

@@ -162,6 +162,16 @@ const container2 = await new GenericContainer("alpine")
 assert(container1.getId() === container2.getId());
 ```
 
+Restarting a container:
+
+```javascript
+const { GenericContainer } = require("testcontainers");
+
+const container = await new GenericContainer("alpine")
+  .start();
+const restartedContainer = await container.restart();
+```
+
 Creating a container with a specified name:
 
 ```javascript

package/dist/docker/functions/container/restart-container.d.ts

@@ -0,0 +1,5 @@
+import Dockerode from "dockerode";
+export declare type RestartContainerOptions = {
+    timeout: number;
+};
+export declare const restartContainer: (container: Dockerode.Container, options: RestartContainerOptions) => Promise<void>;

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

@@ -0,0 +1,23 @@
+"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.restartContainer = void 0;
+const logger_1 = require("../../../logger");
+const restartContainer = (container, options) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield container.restart({ t: options.timeout / 1000 });
+    }
+    catch (err) {
+        logger_1.log.error(`Failed to restart container ${container.id}: ${err}`);
+        throw err;
+    }
+});
+exports.restartContainer = restartContainer;

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 (0, 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, this.getWaitStrategy((yield (0, docker_client_1.dockerClient)()).host, container, containerName).withStartupTimeout(this.startupTimeout));
             })))).reduce((map, startedGenericContainer) => {
                 const containerName = startedGenericContainer.getName();
                 return Object.assign(Object.assign({}, map), { [containerName]: startedGenericContainer });

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 (0, 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, this.getWaitStrategy((yield (0, docker_client_1.dockerClient)()).host, startedContainer).withStartupTimeout(this.startupTimeout));
         });
     }
     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 (0, 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, this.getWaitStrategy((yield (0, docker_client_1.dockerClient)()).host, container).withStartupTimeout(this.startupTimeout));
             if (this.postStart) {
                 yield this.postStart(startedContainer, inspectResult, boundPorts);
             }

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

@@ -1,20 +1,24 @@
 /// <reference types="node" />
-import { StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
+import { RestartOptions, StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import Dockerode from "dockerode";
 import { Command, ContainerName, ExecResult, Host, Id as ContainerId, Labels } from "../docker/types";
 import { InspectResult } from "../docker/functions/container/inspect-container";
 import { BoundPorts } from "../bound-ports";
 import { Port } from "../port";
 import { Readable } from "stream";
+import { WaitStrategy } from "../wait-strategy";
 export declare class StartedGenericContainer implements StartedTestContainer {
     private readonly container;
     private readonly host;
-    private readonly inspectResult;
-    private readonly boundPorts;
+    private inspectResult;
+    private boundPorts;
     private readonly name;
-    constructor(container: Dockerode.Container, host: Host, inspectResult: InspectResult, boundPorts: BoundPorts, name: ContainerName);
+    private readonly waitStrategy;
+    constructor(container: Dockerode.Container, host: Host, inspectResult: InspectResult, boundPorts: BoundPorts, name: ContainerName, waitStrategy: WaitStrategy);
     stop(options?: Partial<StopOptions>): Promise<StoppedTestContainer>;
+    restart(options?: Partial<RestartOptions>): Promise<void>;
     private stopContainer;
+    private waitForContainer;
     getHost(): Host;
     getMappedPort(port: Port): Port;
     getId(): ContainerId;

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

@@ -10,25 +10,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StartedGenericContainer = void 0;
+const inspect_container_1 = require("../docker/functions/container/inspect-container");
+const bound_ports_1 = require("../bound-ports");
 const logger_1 = require("../logger");
 const remove_container_1 = require("../docker/functions/container/remove-container");
 const exec_container_1 = require("../docker/functions/container/exec-container");
 const container_logs_1 = require("../docker/functions/container/container-logs");
 const stopped_generic_container_1 = require("./stopped-generic-container");
 const stop_container_1 = require("../docker/functions/container/stop-container");
+const restart_container_1 = require("../docker/functions/container/restart-container");
 class StartedGenericContainer {
-    constructor(container, host, inspectResult, boundPorts, name) {
+    constructor(container, host, inspectResult, boundPorts, name, waitStrategy) {
         this.container = container;
         this.host = host;
         this.inspectResult = inspectResult;
         this.boundPorts = boundPorts;
         this.name = name;
+        this.waitStrategy = waitStrategy;
     }
     stop(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.stopContainer(options);
         });
     }
+    restart(options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolvedOptions = Object.assign({ timeout: 0 }, options);
+            yield (0, restart_container_1.restartContainer)(this.container, resolvedOptions);
+            // Inspect the restarted container and update the bound ports
+            this.inspectResult = yield (0, inspect_container_1.inspectContainer)(this.container);
+            this.boundPorts = yield bound_ports_1.BoundPorts.fromInspectResult(this.inspectResult).filter(Array.from(this.boundPorts.iterator()).map((port) => port[0]));
+            yield this.waitForContainer(this.container, this.boundPorts);
+        });
+    }
     stopContainer(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             logger_1.log.info(`Stopping container with ID: ${this.container.id}`);
@@ -38,6 +52,26 @@ class StartedGenericContainer {
             return new stopped_generic_container_1.StoppedGenericContainer();
         });
     }
+    waitForContainer(container, boundPorts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger_1.log.debug(`Waiting for container to be ready: ${container.id}`);
+            try {
+                yield this.waitStrategy.waitUntilReady(container, boundPorts);
+                logger_1.log.info("Container is ready");
+            }
+            catch (err) {
+                logger_1.log.error(`Container failed to be ready: ${err}`);
+                try {
+                    yield (0, stop_container_1.stopContainer)(container, { timeout: 0 });
+                    yield (0, remove_container_1.removeContainer)(container, { removeVolumes: true });
+                }
+                catch (stopErr) {
+                    logger_1.log.error(`Failed to stop container after it failed to be ready: ${stopErr}`);
+                }
+                throw err;
+            }
+        });
+    }
     getHost() {
         return this.host;
     }

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/abstract-started-container.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
+import { RestartOptions, StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import { Port } from "../port";
 import { ContainerName, Host, Id, Command, ExecResult, Labels } from "../docker/types";
 import { Readable } from "stream";
@@ -7,6 +7,7 @@ export declare class AbstractStartedContainer {
     protected readonly startedTestContainer: StartedTestContainer;
     constructor(startedTestContainer: StartedTestContainer);
     stop(options?: Partial<StopOptions>): Promise<StoppedTestContainer>;
+    restart(options?: Partial<RestartOptions>): Promise<void>;
     getHost(): Host;
     getMappedPort(port: Port): Port;
     getName(): ContainerName;

package/dist/modules/abstract-started-container.js

@@ -1,4 +1,13 @@
 "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.AbstractStartedContainer = void 0;
 class AbstractStartedContainer {
@@ -8,6 +17,11 @@ class AbstractStartedContainer {
     stop(options) {
         return this.startedTestContainer.stop(options);
     }
+    restart(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.startedTestContainer.restart(options);
+        });
+    }
     getHost() {
         return this.startedTestContainer.getHost();
     }

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/test-container.d.ts

@@ -23,12 +23,16 @@ export interface TestContainer {
     withCopyFileToContainer(sourcePath: string, containerPath: string): this;
     withCopyContentToContainer(content: string | Buffer | Readable, containerPath: string): this;
 }
+export interface RestartOptions {
+    timeout: number;
+}
 export interface StopOptions {
     timeout: number;
     removeVolumes: boolean;
 }
 export interface StartedTestContainer {
     stop(options?: Partial<StopOptions>): Promise<StoppedTestContainer>;
+    restart(options?: Partial<RestartOptions>): Promise<void>;
     getHost(): Host;
     getMappedPort(port: Port): Port;
     getName(): ContainerName;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.10.2-beta.0",
+  "version": "8.12.0",
   "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": [