testcontainers 7.22.1 → 7.24.0

package/README.md

@@ -5,6 +5,8 @@
 [![Node.js CI](https://github.com/testcontainers/testcontainers-node/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/testcontainers/testcontainers-node/actions/workflows/node.js.yml)
 [![npm version](https://badge.fury.io/js/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
 [![npm version](https://img.shields.io/npm/dm/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
+[![Thundra Foresight](https://thundra-assets-prod.s3.us-west-2.amazonaws.com/images/badges/thundra-foresight-badge-enabled.svg)](https://foresight.thundra.live/testRuns/57175ecb-d5ac-4129-957a-9dd617fd27d0)
+[![Foresight Test Summary](https://foresight.service.thundra.us/public/api/v1/badge/test/57175ecb-d5ac-4129-957a-9dd617fd27d0)](https://foresight.thundra.live/testruns/57175ecb-d5ac-4129-957a-9dd617fd27d0)
 
 ## Install
 
@@ -276,6 +278,22 @@ const fooContainer = await new GenericContainer("alpine")
 expect((await container.exec(["nslookup", "foo"])).exitCode).toBe(0);
 ```
 
+Add hostname mappings:
+
+```javascript
+const { GenericContainer } = require("testcontainers");
+
+const container = await new GenericContainer("alpine")
+  .withExtraHosts([
+    { host: "foo", ipAddress: "10.11.12.13" },
+    { host: "bar", ipAddress: "11.12.13.14" }
+  ])
+  .start();
+
+expect((await container.exec(["nslookup", "foo"])).exitCode).toBe(0);
+expect((await container.exec(["nslookup", "bar"])).exitCode).toBe(0);
+```
+
 Specifying a pull policy. Note that if omitted will use the `DefaultPullPolicy` which will use a locally cached image 
 if one already exists, this is usually the preferred option. In cases where there is a local image for a given tag 
 but the remote image with the same tag may have changed (for example when using the `latest` tag), you can tell 
@@ -523,6 +541,16 @@ const environment = await new DockerComposeEnvironment(composeFilePath, composeF
   .up();
 ```
 
+Specify [profiles](https://docs.docker.com/compose/profiles/):
+
+```javascript
+const { DockerComposeEnvironment } = require("testcontainers");
+
+const environment = await new DockerComposeEnvironment(composeFilePath, composeFile)
+    .withProfiles("profile1", "profile2")
+    .up();
+```
+
 Specify not to re-create containers that are already running: 
 
 ```javascript

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

@@ -19,18 +19,11 @@ const execContainer = (container, command) => __awaiter(void 0, void 0, void 0,
             AttachStderr: true,
         });
         const stream = yield startExec(exec);
-        return yield new Promise((resolve) => {
-            const chunks = [];
-            stream.on("data", (chunk) => chunks.push(chunk));
-            const interval = setInterval(() => __awaiter(void 0, void 0, void 0, function* () {
-                const { running, exitCode } = yield inspectExec(exec);
-                if (!running) {
-                    clearInterval(interval);
-                    stream.destroy();
-                    resolve({ output: chunks.join(""), exitCode });
-                }
-            }), 100);
-        });
+        const chunks = [];
+        stream.on("data", (chunk) => chunks.push(chunk));
+        const exitCode = yield waitForExec(exec);
+        stream.destroy();
+        return { output: chunks.join(""), exitCode };
     }
     catch (err) {
         logger_1.log.error(`Failed to exec container ${container.id} with command "${command.join(" ")}": ${err}`);
@@ -72,3 +65,14 @@ const inspectExec = (exec) => __awaiter(void 0, void 0, void 0, function* () {
         throw err;
     }
 });
+const waitForExec = (exec) => __awaiter(void 0, void 0, void 0, function* () {
+    return new Promise((resolve) => {
+        const interval = setInterval(() => __awaiter(void 0, void 0, void 0, function* () {
+            const { running, exitCode } = yield inspectExec(exec);
+            if (!running) {
+                clearInterval(interval);
+                resolve(exitCode);
+            }
+        }), 100);
+    });
+});

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

@@ -23,7 +23,7 @@ const create_labels_1 = require("../create-labels");
 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);
+        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)) });
         return new Promise((resolve) => dockerode_1.dockerode
             .buildImage(tarStream, {

package/dist/docker-compose/default-docker-compose-options.js

@@ -18,6 +18,7 @@ const defaultDockerComposeOptions = (_a) => {
         log: false,
         cwd: options.filePath,
         config: options.files,
+        composeOptions: options.composeOptions,
         commandOptions: options.commandOptions,
         env: Object.assign(Object.assign(Object.assign({}, process.env), { COMPOSE_PROJECT_NAME: options.projectName }), env),
     };

package/dist/docker-compose/docker-compose-options.d.ts

@@ -4,5 +4,6 @@ export declare type DockerComposeOptions = {
     files: string | string[];
     projectName: string;
     commandOptions?: string[];
+    composeOptions?: string[];
     env?: Env;
 };

package/dist/docker-compose-environment/docker-compose-environment.d.ts

@@ -8,12 +8,14 @@ export declare class DockerComposeEnvironment {
     private projectName;
     private build;
     private recreate;
+    private profiles;
     private env;
     private waitStrategy;
     private startupTimeout;
     constructor(composeFilePath: string, composeFiles: string | string[], uuid?: Uuid);
     withBuild(): this;
     withEnv(key: EnvKey, value: EnvValue): this;
+    withProfiles(...profiles: string[]): this;
     withNoRecreate(): this;
     withWaitStrategy(containerName: string, waitStrategy: WaitStrategy): this;
     withStartupTimeout(startupTimeout: number): this;

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

@@ -30,6 +30,7 @@ class DockerComposeEnvironment {
     constructor(composeFilePath, composeFiles, uuid = new uuid_1.RandomUuid()) {
         this.build = false;
         this.recreate = true;
+        this.profiles = [];
         this.env = {};
         this.waitStrategy = {};
         this.startupTimeout = 60000;
@@ -45,6 +46,10 @@ class DockerComposeEnvironment {
         this.env[key] = value;
         return this;
     }
+    withProfiles(...profiles) {
+        this.profiles = profiles;
+        return this;
+    }
     withNoRecreate() {
         this.recreate = false;
         this.projectName = "testcontainers-node";
@@ -74,7 +79,12 @@ class DockerComposeEnvironment {
             if (!this.recreate) {
                 commandOptions.push("--no-recreate");
             }
-            yield docker_compose_up_1.dockerComposeUp(Object.assign(Object.assign({}, options), { commandOptions, env: this.env }), services);
+            const composeOptions = [];
+            this.profiles.forEach((profile) => {
+                composeOptions.push("--profile");
+                composeOptions.push(profile);
+            });
+            yield docker_compose_up_1.dockerComposeUp(Object.assign(Object.assign({}, options), { commandOptions, composeOptions, env: this.env }), services);
             const startedContainers = (yield list_containers_1.listContainers()).filter((container) => container.Labels["com.docker.compose.project"] === this.projectName);
             const startedContainerNames = startedContainers.reduce((containerNames, startedContainer) => [
                 ...containerNames,
@@ -110,7 +120,7 @@ class DockerComposeEnvironment {
                 return Object.assign(Object.assign({}, map), { [containerName]: startedGenericContainer });
             }, {});
             logger_1.log.info(`DockerCompose environment started: ${Object.keys(startedGenericContainers).join(", ")}`);
-            return new started_docker_compose_environment_1.StartedDockerComposeEnvironment(startedGenericContainers, options);
+            return new started_docker_compose_environment_1.StartedDockerComposeEnvironment(startedGenericContainers, Object.assign(Object.assign({}, options), { composeOptions, env: this.env }));
         });
     }
     getBoundPorts(containerInfo) {

package/dist/docker-ignore.d.ts

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

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"));
-const findDockerIgnoreFiles = (context) => __awaiter(void 0, void 0, void 0, function* () {
+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();
@@ -25,6 +25,7 @@ const findDockerIgnoreFiles = (context) => __awaiter(void 0, void 0, void 0, fun
     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);

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

@@ -6,7 +6,7 @@ import { PullPolicy } from "../pull-policy";
 import { StartedTestContainer, TestContainer } from "../test-container";
 import { WaitStrategy } from "../wait-strategy";
 import { Readable } from "stream";
-import { BindMode, BindMount, BuildContext, Command, ContainerName, Dir, Env, EnvKey, EnvValue, HealthCheck, NetworkMode, TmpFs } from "../docker/types";
+import { BindMode, BindMount, BuildContext, Command, ContainerName, Dir, Env, EnvKey, EnvValue, ExtraHost, HealthCheck, NetworkMode, TmpFs } from "../docker/types";
 import { GenericContainerBuilder } from "./generic-container-builder";
 export declare class GenericContainer implements TestContainer {
     readonly image: string;
@@ -38,6 +38,7 @@ export declare class GenericContainer implements TestContainer {
     withTmpFs(tmpFs: TmpFs): this;
     withNetworkMode(networkMode: NetworkMode): this;
     withNetworkAliases(...networkAliases: string[]): this;
+    withExtraHosts(...extraHosts: ExtraHost[]): this;
     withExposedPorts(...ports: Port[]): this;
     withBindMount(source: Dir, target: Dir, bindMode?: BindMode): this;
     withHealthCheck(healthCheck: HealthCheck): this;

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

@@ -94,7 +94,11 @@ class GenericContainer {
                 const portForwarderNetworkId = portForwarder.getNetworkId();
                 const excludedNetworks = [portForwarderNetworkId, "none", "host"];
                 if (!this.networkMode || !excludedNetworks.includes(this.networkMode)) {
-                    yield connect_network_1.connectNetwork({ containerId: container.id, networkId: portForwarderNetworkId, networkAliases: [] });
+                    yield connect_network_1.connectNetwork({
+                        containerId: container.id,
+                        networkId: portForwarderNetworkId,
+                        networkAliases: [],
+                    });
                 }
             }
             if (this.networkMode && this.networkAliases.length > 0) {
@@ -142,6 +146,10 @@ class GenericContainer {
         this.networkAliases = networkAliases;
         return this;
     }
+    withExtraHosts(...extraHosts) {
+        this.extraHosts.push(...extraHosts);
+        return this;
+    }
     withExposedPorts(...ports) {
         this.ports = ports;
         return this;

package/dist/test-container.d.ts

@@ -3,7 +3,7 @@ import { Port } from "./port";
 import { PullPolicy } from "./pull-policy";
 import { WaitStrategy } from "./wait-strategy";
 import { Readable } from "stream";
-import { BindMode, Command, ContainerName, Dir, EnvKey, EnvValue, ExecResult, Host, Id, NetworkMode, TmpFs } from "./docker/types";
+import { BindMode, Command, ContainerName, Dir, EnvKey, EnvValue, ExecResult, ExtraHost, Host, Id, NetworkMode, TmpFs } from "./docker/types";
 export interface TestContainer {
     start(): Promise<StartedTestContainer>;
     withEnv(key: EnvKey, value: EnvValue): this;
@@ -14,6 +14,7 @@ export interface TestContainer {
     withWaitStrategy(waitStrategy: WaitStrategy): this;
     withStartupTimeout(startupTimeout: number): this;
     withNetworkMode(networkMode: NetworkMode): this;
+    withExtraHosts(...extraHosts: ExtraHost[]): this;
     withDefaultLogDriver(): this;
     withPrivilegedMode(): this;
     withUser(user: string): this;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "7.22.1",
+  "version": "7.24.0",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [
@@ -26,7 +26,7 @@
     "pre-commit": "lint-staged",
     "build": "npm run clean && tsc",
     "clean": "rimraf dist",
-    "test": "cross-env DEBUG=testcontainers jest --maxWorkers=2",
+    "test": "cross-env DEBUG=testcontainers jest --runInBand",
     "format": "prettier --write package.json \"src/**/*.ts\"",
     "lint": "eslint --fix package.json \"src/**/*.ts\"",
     "updateDeps": "npx npm-check-updates -u"