testcontainers 8.4.0 → 8.6.0

package/README.md

@@ -77,7 +77,12 @@ describe("GenericContainer", () => {
 Using TypeScript:
 
 ```typescript
-import { TestContainer, StartedTestContainer, StoppedTestContainer, GenericContainer } from "testcontainers";
+import { 
+  TestContainer, 
+  StartedTestContainer, 
+  StoppedTestContainer, 
+  GenericContainer
+} from "testcontainers";
 
 const container: TestContainer = new GenericContainer("alpine");
 const startedContainer: StartedTestContainer = await container.start();
@@ -129,6 +134,24 @@ const container = await new GenericContainer("alpine")
   .start();
 ```
 
+Enabling container reuse, note that two containers are considered equal if their options (exposed ports, commands, mounts, etc) match. This also works across multiple processes:
+
+```javascript
+const { GenericContainer } = require("testcontainers");
+
+const container1 = await new GenericContainer("alpine")
+  .withCmd(["sleep", "infinity"])
+  .withReuse()
+  .start();
+
+const container2 = await new GenericContainer("alpine")
+  .withCmd(["sleep", "infinity"])
+  .withReuse()
+  .start();
+
+assert(container1.getId() === container2.getId());
+```
+
 Creating a container with a specified name:
 
 ```javascript

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

@@ -1,6 +1,7 @@
 import { DockerImageName } from "../../../docker-image-name";
 import Dockerode from "dockerode";
 import { PortWithOptionalBinding } from "../../../port";
+import { Labels } from "../create-labels";
 import { BindMount, Command, ContainerName, Env, ExtraHost, HealthCheck, NetworkMode, TmpFs } from "../../types";
 export declare type CreateContainerOptions = {
     imageName: DockerImageName;
@@ -10,6 +11,8 @@ export declare type CreateContainerOptions = {
     tmpFs: TmpFs;
     exposedPorts: PortWithOptionalBinding[];
     name?: ContainerName;
+    reusable: boolean;
+    labels?: Labels;
     networkMode?: NetworkMode;
     healthCheck?: HealthCheck;
     useDefaultLogDriver: boolean;

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

@@ -25,7 +25,7 @@ const createContainer = (options) => __awaiter(void 0, void 0, void 0, function*
             Env: getEnv(options.env),
             ExposedPorts: getExposedPorts(options.exposedPorts),
             Cmd: options.cmd,
-            Labels: create_labels_1.createLabels(options.imageName),
+            Labels: create_labels_1.createLabels(options.reusable, options.imageName, options.labels),
             // @ts-ignore
             Healthcheck: getHealthCheck(options.healthCheck),
             HostConfig: {

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

@@ -1,3 +1,4 @@
 import Dockerode from "dockerode";
 import { Id } from "../../types";
 export declare const getContainerById: (id: Id) => Promise<Dockerode.Container>;
+export declare const getContainerByHash: (hash: string) => Promise<Dockerode.Container | undefined>;

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

@@ -9,10 +9,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContainerById = void 0;
+exports.getContainerByHash = exports.getContainerById = void 0;
 const docker_client_1 = require("../../docker-client");
+const logger_1 = require("../../../logger");
+const labels_1 = require("../../../labels");
 const getContainerById = (id) => __awaiter(void 0, void 0, void 0, function* () {
-    const { dockerode } = yield docker_client_1.dockerClient;
-    return dockerode.getContainer(id);
+    try {
+        const { dockerode } = yield docker_client_1.dockerClient;
+        return dockerode.getContainer(id);
+    }
+    catch (err) {
+        logger_1.log.error(`Failed to get container by ID: ${err}`);
+        throw err;
+    }
 });
 exports.getContainerById = getContainerById;
+const getContainerByHash = (hash) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const { dockerode } = yield docker_client_1.dockerClient;
+        const containers = yield dockerode.listContainers({
+            limit: 1,
+            filters: {
+                status: ["running"],
+                label: [`${labels_1.LABEL_CONTAINER_HASH}=${hash}`],
+            },
+        });
+        if (containers.length === 0) {
+            return undefined;
+        }
+        else {
+            return yield exports.getContainerById(containers[0].Id);
+        }
+    }
+    catch (err) {
+        logger_1.log.error(`Failed to get container by hash (${hash}): ${err}`);
+        throw err;
+    }
+});
+exports.getContainerByHash = getContainerByHash;

package/dist/docker/functions/create-labels.d.ts

@@ -1,4 +1,5 @@
 import { DockerImageName } from "../../docker-image-name";
-export declare const createLabels: (dockerImageName?: DockerImageName | undefined) => {
-    [label: string]: string;
+export declare type Labels = {
+    [key: string]: string;
 };
+export declare const createLabels: (reusable: boolean, dockerImageName?: DockerImageName | undefined, extraLabels?: Labels) => Labels;

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

@@ -2,10 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLabels = void 0;
 const session_id_1 = require("../session-id");
-const createLabels = (dockerImageName) => {
+const labels_1 = require("../../labels");
+const createLabels = (reusable, dockerImageName, extraLabels = {}) => {
+    const labels = Object.assign({}, extraLabels);
     if (dockerImageName && dockerImageName.isReaper()) {
-        return {};
+        return labels;
     }
-    return { "org.testcontainers.session-id": session_id_1.sessionId };
+    if (!reusable) {
+        labels[labels_1.LABEL_SESSION_ID] = session_id_1.sessionId;
+    }
+    return labels;
 };
 exports.createLabels = createLabels;

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

@@ -14,24 +14,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildImage = void 0;
 const logger_1 = require("../../../logger");
-const docker_ignore_1 = require("../../../docker-ignore");
 const tar_fs_1 = __importDefault(require("tar-fs"));
-const slash_1 = __importDefault(require("slash"));
 const byline_1 = __importDefault(require("byline"));
 const docker_client_1 = require("../../docker-client");
 const create_labels_1 = require("../create-labels");
+const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
+const dockerignore_1 = __importDefault(require("@balena/dockerignore"));
 const buildImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Building image '${options.imageName.toString()}' with context '${options.context}'`);
-        const dockerIgnoreFiles = yield docker_ignore_1.findDockerIgnoreFiles(options.context, options.dockerfileName);
-        const tarStream = tar_fs_1.default.pack(options.context, { ignore: (name) => dockerIgnoreFiles.has(slash_1.default(name)) });
+        const isDockerIgnored = yield createIsDockerIgnoredFunction(options.context);
+        const tarStream = tar_fs_1.default.pack(options.context, {
+            ignore: (aPath) => {
+                const relativePath = path_1.default.relative(options.context, aPath);
+                if (relativePath === options.dockerfileName) {
+                    return false;
+                }
+                else {
+                    return isDockerIgnored(relativePath);
+                }
+            },
+        });
         const { dockerode } = yield docker_client_1.dockerClient;
         return new Promise((resolve) => dockerode
             .buildImage(tarStream, {
             dockerfile: options.dockerfileName,
             buildargs: options.buildArgs,
             t: options.imageName.toString(),
-            labels: create_labels_1.createLabels(options.imageName),
+            labels: create_labels_1.createLabels(false, options.imageName),
             registryconfig: options.registryConfig,
             pull: options.pullPolicy.shouldPull() ? "any" : undefined,
         })
@@ -48,3 +59,14 @@ const buildImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 exports.buildImage = buildImage;
+const createIsDockerIgnoredFunction = (context) => __awaiter(void 0, void 0, void 0, function* () {
+    const dockerIgnoreFilePath = path_1.default.join(context, ".dockerignore");
+    if (!fs_1.existsSync(dockerIgnoreFilePath)) {
+        return () => false;
+    }
+    const instance = dockerignore_1.default({ ignorecase: false });
+    const dockerIgnorePatterns = yield fs_1.promises.readFile(dockerIgnoreFilePath, { encoding: "utf-8" });
+    instance.add(dockerIgnorePatterns);
+    const filter = instance.createFilter();
+    return (aPath) => !filter(aPath);
+});

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

@@ -26,7 +26,7 @@ const createNetwork = (options) => __awaiter(void 0, void 0, void 0, function* (
             Ingress: options.ingress,
             EnableIPv6: options.enableIPv6,
             Options: options.options,
-            Labels: Object.assign(Object.assign({}, options.labels), create_labels_1.createLabels()),
+            Labels: Object.assign(Object.assign({}, options.labels), create_labels_1.createLabels(false)),
         });
         return network.id;
     }

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

@@ -29,11 +29,14 @@ export declare class GenericContainer implements TestContainer {
     protected ipcMode?: string;
     protected user?: string;
     protected pullPolicy: PullPolicy;
+    protected reuse: boolean;
     protected tarToCopy?: archiver.Archiver;
     private extraHosts;
     constructor(image: string);
     protected preStart?(): Promise<void>;
     start(): Promise<StartedTestContainer>;
+    private reuseContainer;
+    private startContainer;
     protected postStart?(container: StartedTestContainer, inspectResult: InspectResult, boundPorts: BoundPorts): Promise<void>;
     withCmd(cmd: Command[]): this;
     withName(name: ContainerName): this;
@@ -51,6 +54,7 @@ export declare class GenericContainer implements TestContainer {
     withDefaultLogDriver(): this;
     withPrivilegedMode(): this;
     withUser(user: string): this;
+    withReuse(): this;
     withPullPolicy(pullPolicy: PullPolicy): this;
     withIpcMode(ipcMode: string): this;
     withCopyFileToContainer(sourcePath: string, containerPath: string): this;

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

@@ -35,6 +35,9 @@ const remove_container_1 = require("../docker/functions/container/remove-contain
 const put_container_archive_1 = require("../docker/functions/container/put-container-archive");
 const generic_container_builder_1 = require("./generic-container-builder");
 const started_generic_container_1 = require("./started-generic-container");
+const hash_1 = require("../hash");
+const get_container_1 = require("../docker/functions/container/get-container");
+const labels_1 = require("../labels");
 class GenericContainer {
     constructor(image) {
         this.image = image;
@@ -48,6 +51,7 @@ class GenericContainer {
         this.useDefaultLogDriver = false;
         this.privilegedMode = false;
         this.pullPolicy = new pull_policy_1.DefaultPullPolicy();
+        this.reuse = false;
         this.extraHosts = [];
         this.imageName = docker_image_name_1.DockerImageName.fromString(image);
     }
@@ -71,7 +75,7 @@ class GenericContainer {
                 const portForwarder = yield port_forwarder_1.PortForwarderInstance.getInstance();
                 this.extraHosts.push({ host: "host.testcontainers.internal", ipAddress: portForwarder.getIpAddress() });
             }
-            const container = yield create_container_1.createContainer({
+            const createContainerOptions = {
                 imageName: this.imageName,
                 env: this.env,
                 cmd: this.cmd,
@@ -79,6 +83,7 @@ class GenericContainer {
                 tmpFs: this.tmpFs,
                 exposedPorts: this.ports,
                 name: this.name,
+                reusable: this.reuse,
                 networkMode: this.networkAliases.length > 0 ? undefined : this.networkMode,
                 healthCheck: this.healthCheck,
                 useDefaultLogDriver: this.useDefaultLogDriver,
@@ -87,7 +92,37 @@ class GenericContainer {
                 extraHosts: this.extraHosts,
                 ipcMode: this.ipcMode,
                 user: this.user,
-            });
+            };
+            if (this.reuse) {
+                const containerHash = hash_1.hash(JSON.stringify(createContainerOptions));
+                createContainerOptions.labels = { [labels_1.LABEL_CONTAINER_HASH]: containerHash };
+                logger_1.log.debug(`Container reuse has been enabled, hash: ${containerHash}`);
+                const container = yield get_container_1.getContainerByHash(containerHash);
+                if (container !== undefined) {
+                    logger_1.log.debug(`Found container to reuse with hash: ${containerHash}`);
+                    return this.reuseContainer(container);
+                }
+                else {
+                    logger_1.log.debug("No container found to reuse");
+                    return this.startContainer(createContainerOptions);
+                }
+            }
+            else {
+                return this.startContainer(createContainerOptions);
+            }
+        });
+    }
+    reuseContainer(startedContainer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const inspectResult = yield 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);
+        });
+    }
+    startContainer(createContainerOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const container = yield create_container_1.createContainer(createContainerOptions);
             if (!this.imageName.isHelperContainer() && port_forwarder_1.PortForwarderInstance.isRunning()) {
                 const portForwarder = yield port_forwarder_1.PortForwarderInstance.getInstance();
                 const portForwarderNetworkId = portForwarder.getNetworkId();
@@ -190,6 +225,10 @@ class GenericContainer {
         this.user = user;
         return this;
     }
+    withReuse() {
+        this.reuse = true;
+        return this;
+    }
     withPullPolicy(pullPolicy) {
         this.pullPolicy = pullPolicy;
         return this;

package/dist/hash.d.ts

@@ -0,0 +1 @@
+export declare const hash: (str: string) => string;

package/dist/hash.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hash = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const hash = (str) => {
+    return crypto_1.default.createHash("md5").update(str).digest("hex");
+};
+exports.hash = hash;

package/dist/labels.d.ts

@@ -0,0 +1,2 @@
+export declare const LABEL_SESSION_ID = "org.testcontainers.session-id";
+export declare const LABEL_CONTAINER_HASH = "org.testcontainers.container-hash";

package/dist/labels.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LABEL_CONTAINER_HASH = exports.LABEL_SESSION_ID = void 0;
+exports.LABEL_SESSION_ID = "org.testcontainers.session-id";
+exports.LABEL_CONTAINER_HASH = "org.testcontainers.container-hash";

package/dist/reaper.js

@@ -17,6 +17,7 @@ const session_id_1 = require("./docker/session-id");
 const docker_client_1 = require("./docker/docker-client");
 const images_1 = require("./images");
 const port_1 = require("./port");
+const labels_1 = require("./labels");
 class RealReaper {
     constructor(container, socket) {
         this.container = container;
@@ -109,7 +110,7 @@ class ReaperInstance {
             return new Promise((resolve) => {
                 socket.connect(port_1.getContainerPort(port), host, () => {
                     logger_1.log.debug(`Connected to Reaper ${containerId}`);
-                    socket.write(`label=org.testcontainers.session-id=${session_id_1.sessionId}\r\n`);
+                    socket.write(`label=${labels_1.LABEL_SESSION_ID}=${session_id_1.sessionId}\r\n`);
                     const reaper = new RealReaper(startedContainer, socket);
                     resolve(reaper);
                 });

package/dist/test-container.d.ts

@@ -19,6 +19,7 @@ export interface TestContainer {
     withPrivilegedMode(): this;
     withUser(user: string): this;
     withPullPolicy(pullPolicy: PullPolicy): this;
+    withReuse(): this;
     withCopyFileToContainer(sourcePath: string, containerPath: string): this;
     withCopyContentToContainer(content: string | Buffer | Readable, containerPath: string): this;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.4.0",
+  "version": "8.6.0",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [
@@ -32,17 +32,16 @@
     "updateDeps": "npx npm-check-updates -u"
   },
   "dependencies": {
+    "@balena/dockerignore": "^1.0.2",
     "@types/archiver": "^5.1.1",
     "@types/dockerode": "^3.2.7",
     "archiver": "^5.3.0",
     "byline": "^5.0.0",
-    "debug": "^4.3.3",
+    "debug": "^4.3.4",
     "docker-compose": "^0.23.17",
     "dockerode": "^3.3.1",
     "get-port": "^5.1.1",
-    "glob": "^7.2.0",
     "properties-reader": "^2.2.0",
-    "slash": "^3.0.0",
     "ssh-remote-port-forward": "^1.0.4",
     "tar-fs": "^2.1.1"
   },
@@ -50,11 +49,10 @@
     "@elastic/elasticsearch": "^7.14.1",
     "@types/byline": "^4.2.33",
     "@types/debug": "4.1.7",
-    "@types/glob": "^7.1.4",
     "@types/jest": "^27.0.3",
     "@types/node": "^16.9.6",
     "@types/node-fetch": "^2.5.12",
-    "@types/pg": "^8.6.4",
+    "@types/pg": "^8.6.5",
     "@types/properties-reader": "^2.1.1",
     "@types/tar-fs": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^4.31.2",

package/dist/docker-ignore.d.ts

@@ -1 +0,0 @@
-export declare const findDockerIgnoreFiles: (context: string, dockerfileName: string) => Promise<Set<string>>;

package/dist/docker-ignore.js

@@ -1,41 +0,0 @@
-"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.findDockerIgnoreFiles = void 0;
-const fs_1 = require("fs");
-const os_1 = __importDefault(require("os"));
-const glob_1 = __importDefault(require("glob"));
-const path_1 = __importDefault(require("path"));
-const findDockerIgnoreFiles = (context, dockerfileName) => __awaiter(void 0, void 0, void 0, function* () {
-    const dockerIgnoreFilePath = path_1.default.join(context, ".dockerignore");
-    if (!fs_1.existsSync(dockerIgnoreFilePath)) {
-        return new Set();
-    }
-    const dockerIgnorePatterns = (yield fs_1.promises.readFile(dockerIgnoreFilePath, { encoding: "utf-8" }))
-        .toString()
-        .split(os_1.default.EOL)
-        .filter((dockerIgnorePattern) => dockerIgnorePattern !== dockerfileName)
-        .map((dockerIgnorePattern) => path_1.default.resolve(context, dockerIgnorePattern));
-    const dockerIgnoreMatches = (yield Promise.all(dockerIgnorePatterns.map(findIgnoredFilesForPattern))).reduce((prev, next) => [...prev, ...next]);
-    return new Set(dockerIgnoreMatches);
-});
-exports.findDockerIgnoreFiles = findDockerIgnoreFiles;
-const findIgnoredFilesForPattern = (dockerIgnorePattern) => new Promise((resolve, reject) => glob_1.default(dockerIgnorePattern, (err, matches) => {
-    if (err) {
-        return reject(err);
-    }
-    else {
-        resolve(matches);
-    }
-}));