testcontainers 6.1.1 → 6.4.1

package/README.md

@@ -23,6 +23,8 @@ The following environment variables are supported:
 | `DEBUG` | `testcontainers*` | See all output |
 | `DOCKER_HOST` | `tcp://docker:2375` | Override the Docker host |
 | `TESTCONTAINERS_RYUK_DISABLED` | `true` | Disable [ryuk](#ryuk) |
+| `RYUK_CONTAINER_IMAGE` | `registry.mycompany.com/mirror/ryuk:0.3.0` | Custom image for [ryuk](#ryuk) |
+| `SSHD_CONTAINER_IMAGE` | `registry.mycompany.com/mirror/sshd:1.0.0` | Custom image for [SSHd](#SSHd) |
 
 ## Modules
 
@@ -508,13 +510,37 @@ const container = await new GenericContainer("redis")
   .start();
 ```
 
-## ryuk
+## Sidecars
 
-Testcontainers will start a sidecar container called ryuk whenever a container, docker-compose environment or network is started. This container keeps track of containers/images/networks/volumes created by testcontainers and will automatically clean up these resources 10s after connectivity with testcontainers is lost. 
+Testcontainers may need to create sidecar containers to provide its functionality. 
 
-This is useful for example if a test starts a container and then terminates unexpectedly, as these dangling resources will be automatically removed.
+To avoid Docker pull limits, you can host your own images and use them by setting the appropriate environment variables:
 
-ryuk must be run with privileged mode; in CI environments such as Bit Bucket where this isn't supported, ryuk can be disabled by setting the environment variable `TESTCONTAINERS_RYUK_DISABLED` to `true`.
+| Sidecar | Environment Variable | Default
+| --- | --- | --- |
+| ryuk | `RYUK_CONTAINER_IMAGE` | `testcontainers/ryuk:0.3.0` |
+| SSHd | `SSHD_CONTAINER_IMAGE` | `testcontainers/sshd:1.0.0` |
+
+### ryuk
+
+Testcontainers will start ryuk whenever a container, docker-compose environment or network is started. 
+
+Once started, this container keeps track of containers/images/networks/volumes created by testcontainers and will 
+automatically clean them up 10s after connectivity with testcontainers is lost. This is useful for example if a test 
+starts a container and then terminates unexpectedly, as it will be automatically removed.
+
+ryuk must be run with privileged mode; in CI environments such as Bit Bucket where this isn't supported, ryuk can be 
+disabled by setting the environment variable `TESTCONTAINERS_RYUK_DISABLED` to `true`.
+
+### SSHd
+
+Testcontainers will start SSHd when using the expose host port functionality. 
+
+Once started, any container that is created will have a host mapping of `host.testcontainers.internal` that points to 
+the SSHd container, as well as being connected to its network.
+
+When we then expose a host port, we remote port forward our local port to the SSHd container, which the other
+containers will then be able to access at `host.testcontainers.internal:<exposed-port>`.
 
 ## Common Issues
 
@@ -533,4 +559,4 @@ It can take a few seconds up to a few minutes to pull and run certain Docker ima
 depending on file sizes and network constraints. It's unlikely that the default
 timeouts set by test frameworks are sufficient.
 
-- Increase the test timeout via the methods provided by the testing framework.
+- Increase the test timeout via the methods provided by the testing framework.

package/dist/container.js

@@ -115,6 +115,9 @@ class DockerodeExec {
                 if (err) {
                     return reject(err);
                 }
+                else if (!stream) {
+                    return reject(new Error("Unexpected error occurred, stream is undefined"));
+                }
                 return resolve(stream);
             });
         });

package/dist/docker-compose-container-name-resolver.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveDockerComposeContainerName = void 0;
-exports.resolveDockerComposeContainerName = (projectName, containerName) => {
+const resolveDockerComposeContainerName = (projectName, containerName) => {
     if (containerName.includes(projectName)) {
         return containerName.substring(`/${projectName}_`.length);
     }
@@ -12,3 +12,4 @@ exports.resolveDockerComposeContainerName = (projectName, containerName) => {
         throw new Error(`Unable to resolve container name for container name: "${containerName}", project name: "${projectName}"`);
     }
 };
+exports.resolveDockerComposeContainerName = resolveDockerComposeContainerName;

package/dist/docker-ignore.js

@@ -17,7 +17,7 @@ const fs_1 = require("fs");
 const os_1 = __importDefault(require("os"));
 const glob_1 = __importDefault(require("glob"));
 const path_1 = __importDefault(require("path"));
-exports.findDockerIgnoreFiles = (context) => __awaiter(void 0, void 0, void 0, function* () {
+const findDockerIgnoreFiles = (context) => __awaiter(void 0, void 0, void 0, function* () {
     const dockerIgnoreFiles = new Set();
     const dockerIgnoreFilePath = path_1.default.join(context, ".dockerignore");
     if (!fs_1.existsSync(dockerIgnoreFilePath)) {
@@ -42,3 +42,4 @@ exports.findDockerIgnoreFiles = (context) => __awaiter(void 0, void 0, void 0, f
     });
     return dockerIgnoreFiles;
 });
+exports.findDockerIgnoreFiles = findDockerIgnoreFiles;

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

@@ -12,6 +12,8 @@ export declare class KafkaContainer extends GenericContainer {
     readonly image: Image;
     readonly tag: Tag;
     readonly host?: string | undefined;
+    readonly zooKeeperImage: Image;
+    readonly zooKeeperTag: Tag;
     private readonly uuid;
     private readonly portClient;
     private isZooKeeperProvided;
@@ -19,7 +21,7 @@ export declare class KafkaContainer extends GenericContainer {
     private zooKeeperPort?;
     private network?;
     private zooKeeperContainer?;
-    constructor(image?: Image, tag?: Tag, host?: string | undefined);
+    constructor(image?: Image, tag?: Tag, host?: string | undefined, zooKeeperImage?: Image, zooKeeperTag?: Tag);
     withZooKeeper(host: Host, port: Port): this;
     protected preCreate(dockerClient: DockerClient, boundPorts: BoundPorts): Promise<void>;
     start(): Promise<StartedKafkaContainer>;

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

@@ -17,11 +17,13 @@ const uuid_1 = require("../../uuid");
 const logger_1 = require("../../logger");
 const abstract_started_container_1 = require("../abstract-started-container");
 class KafkaContainer extends generic_container_1.GenericContainer {
-    constructor(image = "confluentinc/cp-kafka", tag = "latest", host) {
+    constructor(image = "confluentinc/cp-kafka", tag = "latest", host, zooKeeperImage = "confluentinc/cp-zookeeper", zooKeeperTag = "latest") {
         super(image, tag);
         this.image = image;
         this.tag = tag;
         this.host = host;
+        this.zooKeeperImage = zooKeeperImage;
+        this.zooKeeperTag = zooKeeperTag;
         this.uuid = new uuid_1.RandomUuid();
         this.portClient = new port_client_1.RandomPortClient();
         this.isZooKeeperProvided = false;
@@ -53,7 +55,7 @@ class KafkaContainer extends generic_container_1.GenericContainer {
                 const zooKeeperHost = this.uuid.nextUuid();
                 const zooKeeperPort = yield this.portClient.getPort();
                 this.withEnv("KAFKA_ZOOKEEPER_CONNECT", `${zooKeeperHost}:${zooKeeperPort}`);
-                const zookeeperContainer = yield new generic_container_1.GenericContainer("confluentinc/cp-zookeeper", "latest")
+                const zookeeperContainer = yield new generic_container_1.GenericContainer(this.zooKeeperImage, this.zooKeeperTag)
                     .withName(zooKeeperHost)
                     .withEnv("ZOOKEEPER_CLIENT_PORT", zooKeeperPort.toString());
                 if (this.networkMode !== undefined) {

package/dist/port-forwarder.d.ts

@@ -16,6 +16,8 @@ export declare class PortForwarderInstance {
     static IMAGE_VERSION: string;
     private static instance;
     static isRunning(): boolean;
+    private static getImageName;
+    private static getImageVersion;
     static getInstance(dockerClient: DockerClient): Promise<PortForwarder>;
     private static createInstance;
 }

package/dist/port-forwarder.js

@@ -40,6 +40,18 @@ class PortForwarderInstance {
     static isRunning() {
         return this.instance !== undefined;
     }
+    static getImageName() {
+        if (process.env.SSHD_CONTAINER_IMAGE !== undefined) {
+            this.IMAGE_NAME = process.env.SSHD_CONTAINER_IMAGE.split(/:/)[0];
+        }
+        return this.IMAGE_NAME;
+    }
+    static getImageVersion() {
+        if (process.env.SSHD_CONTAINER_IMAGE !== undefined) {
+            this.IMAGE_VERSION = process.env.SSHD_CONTAINER_IMAGE.split(/:/)[1];
+        }
+        return this.IMAGE_VERSION;
+    }
     static getInstance(dockerClient) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.instance) {
@@ -53,7 +65,7 @@ class PortForwarderInstance {
             logger_1.log.debug(`Creating new Port Forwarder`);
             const username = "root";
             const password = new uuid_1.RandomUuid().nextUuid();
-            const container = yield new generic_container_1.GenericContainer(this.IMAGE_NAME, this.IMAGE_VERSION)
+            const container = yield new generic_container_1.GenericContainer(this.getImageName(), this.getImageVersion())
                 .withName(`testcontainers-port-forwarder-${dockerClient.getSessionId()}`)
                 .withDaemonMode()
                 .withExposedPorts(22)

package/dist/reaper.d.ts

@@ -8,6 +8,8 @@ export declare class ReaperInstance {
     private static instance;
     static getInstance(dockerClient: DockerClient): Promise<Reaper>;
     private static isEnabled;
+    private static getImageName;
+    private static getImageVersion;
     private static createDisabledInstance;
     private static createRealInstance;
 }

package/dist/reaper.js

@@ -46,6 +46,18 @@ class ReaperInstance {
     static isEnabled() {
         return process.env.TESTCONTAINERS_RYUK_DISABLED !== "true";
     }
+    static getImageName() {
+        if (process.env.RYUK_CONTAINER_IMAGE !== undefined) {
+            this.IMAGE_NAME = process.env.RYUK_CONTAINER_IMAGE.split(/:/)[0];
+        }
+        return this.IMAGE_NAME;
+    }
+    static getImageVersion() {
+        if (process.env.RYUK_CONTAINER_IMAGE !== undefined) {
+            this.IMAGE_VERSION = process.env.RYUK_CONTAINER_IMAGE.split(/:/)[1];
+        }
+        return this.IMAGE_VERSION;
+    }
     static createDisabledInstance(dockerClient) {
         const sessionId = dockerClient.getSessionId();
         logger_1.log.debug(`Not creating new Reaper for session: ${sessionId}`);
@@ -55,7 +67,7 @@ class ReaperInstance {
         return __awaiter(this, void 0, void 0, function* () {
             const sessionId = dockerClient.getSessionId();
             logger_1.log.debug(`Creating new Reaper for session: ${sessionId}`);
-            const container = yield new generic_container_1.GenericContainer(this.IMAGE_NAME, this.IMAGE_VERSION)
+            const container = yield new generic_container_1.GenericContainer(this.getImageName(), this.getImageVersion())
                 .withName(`testcontainers-ryuk-${sessionId}`)
                 .withExposedPorts(8080)
                 .withWaitStrategy(wait_1.Wait.forLogMessage("Started!"))

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "6.1.1",
+  "version": "6.4.1",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [
@@ -31,9 +31,9 @@
     "updateDeps": "npx npm-check-updates -u"
   },
   "dependencies": {
-    "@types/dockerode": "^2.5.34",
+    "@types/dockerode": "^3.2.1",
     "byline": "^5.0.0",
-    "debug": "^4.1.1",
+    "debug": "^4.3.1",
     "docker-compose": "^0.23.5",
     "dockerode": "^3.2.1",
     "get-port": "^5.1.1",
@@ -41,35 +41,35 @@
     "slash": "^3.0.0",
     "ssh-remote-port-forward": "^1.0.3",
     "stream-to-array": "^2.3.0",
-    "tar-fs": "^2.1.0"
+    "tar-fs": "^2.1.1"
   },
   "devDependencies": {
-    "@elastic/elasticsearch": "^7.9.1",
+    "@elastic/elasticsearch": "^7.10.0",
     "@types/byline": "^4.2.32",
     "@types/debug": "4.1.5",
     "@types/glob": "^7.1.3",
-    "@types/jest": "^26.0.13",
-    "@types/node": "^14.10.1",
+    "@types/jest": "^26.0.19",
+    "@types/node": "^14.14.14",
     "@types/node-fetch": "^2.5.7",
     "@types/stream-to-array": "^2.3.0",
     "@types/tar-fs": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.1.1",
-    "@typescript-eslint/parser": "^4.1.1",
-    "arangojs": "^6.14.1",
-    "cross-env": "^7.0.2",
-    "eslint": "^7.9.0",
-    "eslint-config-prettier": "^6.11.0",
-    "husky": "^4.3.0",
-    "jest": "^26.4.2",
-    "kafkajs": "^1.13.0",
-    "lint-staged": "^10.3.0",
-    "neo4j-driver": "^4.1.2",
+    "@typescript-eslint/eslint-plugin": "^4.11.0",
+    "@typescript-eslint/parser": "^4.11.0",
+    "arangojs": "^7.2.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^7.16.0",
+    "eslint-config-prettier": "^7.1.0",
+    "husky": "^4.3.6",
+    "jest": "^26.6.3",
+    "kafkajs": "^1.15.0",
+    "lint-staged": "^10.5.3",
+    "neo4j-driver": "^4.2.1",
     "node-fetch": "^2.6.1",
-    "prettier": "^2.1.1",
+    "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.3.0",
-    "ts-node": "^9.0.0",
-    "typescript": "^4.0.2"
+    "ts-jest": "^26.4.4",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3"
   },
   "husky": {
     "hooks": {