testcontainers 8.5.0 → 8.6.1-beta.0

package/README.md

@@ -24,9 +24,9 @@ The following environment variables are supported:
 - `DOCKER_HOST=tcp://docker:2375` Sets the URL of the docker daemon
 - `DOCKER_TLS_VERIFY=1` When set to `1`, enables TLS communication with the docker
   daemon
-- `DOCKER_CONFIG=/some/path` Configures the path to the `config.json`. Defaults to `~/.docker`
 - `DOCKER_CERT_PATH=/some/path` Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS
   verification. Defaults to `~/.docker`
+- `DOCKER_CONFIG=/some/path` Configures the path to the `config.json`. Defaults to `~/.docker`
 - `TESTCONTAINERS_HOST_OVERRIDE=docker.svc.local` Docker's host on which ports are exposed
 - `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock` Path to Docker's socket. Used by [ryuk](#ryuk) and
   other [auxiliary containers](#auxiliary-containers) that need to perform Docker actions
@@ -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,7 +134,7 @@ 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:
+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");

package/dist/docker/docker-client.js

@@ -17,7 +17,7 @@ const dockerode_1 = __importDefault(require("dockerode"));
 const path_1 = __importDefault(require("path"));
 const logger_1 = require("../logger");
 const url_1 = require("url");
-const fs_1 = __importDefault(require("fs"));
+const fs_1 = require("fs");
 const run_in_container_1 = require("./functions/run-in-container");
 const log_system_diagnostics_1 = require("../log-system-diagnostics");
 require("../testcontainers-properties-file");
@@ -30,11 +30,10 @@ const getDockerClient = () => __awaiter(void 0, void 0, void 0, function* () {
     for (const strategy of strategies) {
         if (strategy.isApplicable()) {
             logger_1.log.debug(`Found applicable Docker client strategy: ${strategy.getName()}`);
-            const dockerConfig = strategy.getDockerConfig();
-            const dockerode = new dockerode_1.default(createDockerodeOptions(dockerConfig));
-            logger_1.log.debug(`Testing Docker client strategy URI: ${dockerConfig.uri}`);
+            const { uri, dockerode } = yield strategy.initialise();
+            logger_1.log.debug(`Testing Docker client strategy URI: ${uri}`);
             if (yield isDockerDaemonReachable(dockerode)) {
-                const host = yield resolveHost(dockerode, dockerConfig.uri);
+                const host = yield resolveHost(dockerode, uri);
                 logger_1.log.info(`Using Docker client strategy: ${strategy.getName()}, Docker host: ${host}`);
                 log_system_diagnostics_1.logSystemDiagnostics();
                 return { host, dockerode };
@@ -46,23 +45,6 @@ const getDockerClient = () => __awaiter(void 0, void 0, void 0, function* () {
     }
     throw new Error("No Docker client strategy found");
 });
-const createDockerodeOptions = (dockerConfig) => {
-    const dockerOptions = {};
-    if (dockerConfig.socketPath) {
-        dockerOptions.socketPath = dockerConfig.socketPath;
-    }
-    else {
-        const { hostname, port } = new url_1.URL(dockerConfig.uri);
-        dockerOptions.host = hostname;
-        dockerOptions.port = port;
-    }
-    if (dockerConfig.ssl) {
-        dockerOptions.ca = dockerConfig.ssl.ca;
-        dockerOptions.cert = dockerConfig.ssl.cert;
-        dockerOptions.key = dockerConfig.ssl.key;
-    }
-    return dockerOptions;
-};
 const isDockerDaemonReachable = (dockerode) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         const response = yield dockerode.ping();
@@ -74,18 +56,25 @@ const isDockerDaemonReachable = (dockerode) => __awaiter(void 0, void 0, void 0,
     }
 });
 class ConfigurationStrategy {
-    getDockerConfig() {
-        const { DOCKER_HOST, DOCKER_TLS_VERIFY, DOCKER_CERT_PATH } = process.env;
-        return {
-            uri: DOCKER_HOST,
-            ssl: DOCKER_TLS_VERIFY === "1" && DOCKER_CERT_PATH !== undefined
-                ? {
-                    ca: path_1.default.resolve(DOCKER_CERT_PATH, "ca.pem"),
-                    cert: path_1.default.resolve(DOCKER_CERT_PATH, "cert.pem"),
-                    key: path_1.default.resolve(DOCKER_CERT_PATH, "key.pem"),
-                }
-                : undefined,
-        };
+    initialise() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { DOCKER_HOST, DOCKER_TLS_VERIFY, DOCKER_CERT_PATH } = process.env;
+            const dockerOptions = {};
+            const url = new url_1.URL(DOCKER_HOST);
+            const dockerHost = url.host === "" ? `tcp://${DOCKER_HOST}` : DOCKER_HOST;
+            const { hostname, port } = new url_1.URL(dockerHost);
+            dockerOptions.host = hostname;
+            dockerOptions.port = port;
+            if (DOCKER_TLS_VERIFY === "1" && DOCKER_CERT_PATH !== undefined) {
+                dockerOptions.ca = yield fs_1.promises.readFile(path_1.default.resolve(DOCKER_CERT_PATH, "ca.pem"));
+                dockerOptions.cert = yield fs_1.promises.readFile(path_1.default.resolve(DOCKER_CERT_PATH, "cert.pem"));
+                dockerOptions.key = yield fs_1.promises.readFile(path_1.default.resolve(DOCKER_CERT_PATH, "key.pem"));
+            }
+            return {
+                uri: dockerHost,
+                dockerode: new dockerode_1.default(dockerOptions),
+            };
+        });
     }
     isApplicable() {
         return process.env.DOCKER_HOST !== undefined;
@@ -95,11 +84,13 @@ class ConfigurationStrategy {
     }
 }
 class UnixSocketStrategy {
-    getDockerConfig() {
-        return {
-            uri: "unix:///var/run/docker.sock",
-            socketPath: "/var/run/docker.sock",
-        };
+    initialise() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                uri: "unix:///var/run/docker.sock",
+                dockerode: new dockerode_1.default({ socketPath: "/var/run/docker.sock" }),
+            };
+        });
     }
     isApplicable() {
         return process.platform === "linux" || process.platform === "darwin";
@@ -109,11 +100,13 @@ class UnixSocketStrategy {
     }
 }
 class NpipeSocketStrategy {
-    getDockerConfig() {
-        return {
-            uri: "npipe:////./pipe/docker_engine",
-            socketPath: "//./pipe/docker_engine",
-        };
+    initialise() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                uri: "npipe:////./pipe/docker_engine",
+                dockerode: new dockerode_1.default({ socketPath: "//./pipe/docker_engine" }),
+            };
+        });
     }
     isApplicable() {
         return process.platform === "win32";
@@ -156,5 +149,5 @@ const findGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* (
     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) => __awaiter(void 0, void 0, void 0, function* () { return run_in_container_1.runInContainer(dockerode, "alpine:3.5", ["sh", "-c", "ip route|awk '/default/ { print $3 }'"]); });
-const isInContainer = () => fs_1.default.existsSync("/.dockerenv");
+const isInContainer = () => fs_1.existsSync("/.dockerenv");
 exports.dockerClient = getDockerClient();

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

@@ -14,17 +14,28 @@ 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, {
@@ -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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.5.0",
+  "version": "8.6.1-beta.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);
-    }
-}));