testcontainers 8.6.1-beta.0 → 8.7.0

package/README.md

@@ -243,6 +243,19 @@ const container = await new GenericContainer("alpine")
   .start();
 ```
 
+Creating a container with labels:
+
+```javascript
+const { GenericContainer } = require("testcontainers");
+
+const container = await new GenericContainer("alpine")
+  .withLabels({
+    label1: "value1",
+    label2: "value2",
+  })
+  .start();
+```
+
 Creating a container with a custom health check command. Note that `interval`, `timeout`, `retries` and `startPeriod` are optional; the values will be inherited from the image or parent image if omitted. Also note that the wait strategy should be set to `Wait.forHealthCheck()` for this option to take effect:
 
 ```javascript

package/dist/docker/docker-client.js

@@ -148,6 +148,6 @@ const findGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* (
     const inspectResult = yield dockerode.getNetwork("bridge").inspect();
     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 findDefaultGateway = (dockerode) => __awaiter(void 0, void 0, void 0, function* () { return run_in_container_1.runInContainer(dockerode, "alpine:3.14", ["sh", "-c", "ip route|awk '/default/ { print $3 }'"]); });
 const isInContainer = () => fs_1.existsSync("/.dockerenv");
 exports.dockerClient = getDockerClient();

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

@@ -1,8 +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";
+import { BindMount, Command, ContainerName, Env, ExtraHost, HealthCheck, Labels, NetworkMode, TmpFs } from "../../types";
 export declare type CreateContainerOptions = {
     imageName: DockerImageName;
     env: Env;

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

@@ -1,4 +1,4 @@
-import { ContainerName, HealthCheckStatus, NetworkSettings, Ports } from "../../types";
+import { ContainerName, HealthCheckStatus, Labels, NetworkSettings, Ports } from "../../types";
 import Dockerode from "dockerode";
 export declare type InspectResult = {
     name: ContainerName;
@@ -12,5 +12,6 @@ export declare type InspectResult = {
         status: string;
         running: boolean;
     };
+    labels: Labels;
 };
 export declare const inspectContainer: (container: Dockerode.Container) => Promise<InspectResult>;

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

@@ -21,6 +21,7 @@ const inspectContainer = (container) => __awaiter(void 0, void 0, void 0, functi
             healthCheckStatus: getHealthCheckStatus(inspectResult),
             networkSettings: getNetworkSettings(inspectResult),
             state: { status: inspectResult.State.Status, running: inspectResult.State.Running },
+            labels: inspectResult.Config.Labels,
         };
     }
     catch (err) {

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

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

package/dist/docker/types.d.ts

@@ -28,6 +28,9 @@ export declare type ExtraHost = {
 };
 export declare type NetworkMode = string;
 export declare type ContainerName = string;
+export declare type Labels = {
+    [key: string]: string;
+};
 export declare type Ports = {
     [internalPort: number]: number;
 };

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, ExtraHost, HealthCheck, NetworkMode, TmpFs } from "../docker/types";
+import { BindMode, BindMount, BuildContext, Command, ContainerName, Dir, Env, EnvKey, EnvValue, ExtraHost, HealthCheck, NetworkMode, TmpFs, Labels } from "../docker/types";
 import { InspectResult } from "../docker/functions/container/inspect-container";
 import { GenericContainerBuilder } from "./generic-container-builder";
 export declare class GenericContainer implements TestContainer {
@@ -20,6 +20,7 @@ export declare class GenericContainer implements TestContainer {
     protected cmd: Command[];
     protected bindMounts: BindMount[];
     protected name?: ContainerName;
+    protected labels: Labels;
     protected tmpFs: TmpFs;
     protected healthCheck?: HealthCheck;
     protected waitStrategy?: WaitStrategy;
@@ -40,6 +41,7 @@ export declare class GenericContainer implements TestContainer {
     protected postStart?(container: StartedTestContainer, inspectResult: InspectResult, boundPorts: BoundPorts): Promise<void>;
     withCmd(cmd: Command[]): this;
     withName(name: ContainerName): this;
+    withLabels(labels: Labels): this;
     withEnv(key: EnvKey, value: EnvValue): this;
     withTmpFs(tmpFs: TmpFs): this;
     withNetworkMode(networkMode: NetworkMode): this;

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

@@ -46,6 +46,7 @@ class GenericContainer {
         this.ports = [];
         this.cmd = [];
         this.bindMounts = [];
+        this.labels = {};
         this.tmpFs = {};
         this.startupTimeout = 60000;
         this.useDefaultLogDriver = false;
@@ -83,6 +84,7 @@ class GenericContainer {
                 tmpFs: this.tmpFs,
                 exposedPorts: this.ports,
                 name: this.name,
+                labels: this.labels,
                 reusable: this.reuse,
                 networkMode: this.networkAliases.length > 0 ? undefined : this.networkMode,
                 healthCheck: this.healthCheck,
@@ -169,6 +171,10 @@ class GenericContainer {
         this.name = name;
         return this;
     }
+    withLabels(labels) {
+        this.labels = Object.assign({}, labels);
+        return this;
+    }
     withEnv(key, value) {
         this.env[key] = value;
         return this;

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import Dockerode from "dockerode";
-import { Command, ContainerName, ExecResult, Host, Id as ContainerId } from "../docker/types";
+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";
@@ -19,6 +19,7 @@ export declare class StartedGenericContainer implements StartedTestContainer {
     getMappedPort(port: Port): Port;
     getId(): ContainerId;
     getName(): ContainerName;
+    getLabels(): Labels;
     getNetworkNames(): string[];
     getNetworkId(networkName: string): string;
     getIpAddress(networkName: string): string;

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

@@ -50,6 +50,9 @@ class StartedGenericContainer {
     getName() {
         return this.name;
     }
+    getLabels() {
+        return this.inspectResult.labels;
+    }
     getNetworkNames() {
         return Object.keys(this.inspectResult.networkSettings);
     }

package/dist/modules/abstract-started-container.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import { Port } from "../port";
-import { ContainerName, Host, Id, Command, ExecResult } from "../docker/types";
+import { ContainerName, Host, Id, Command, ExecResult, Labels } from "../docker/types";
 import { Readable } from "stream";
 export declare class AbstractStartedContainer {
     protected readonly startedTestContainer: StartedTestContainer;
@@ -10,6 +10,7 @@ export declare class AbstractStartedContainer {
     getHost(): Host;
     getMappedPort(port: Port): Port;
     getName(): ContainerName;
+    getLabels(): Labels;
     getId(): Id;
     getNetworkNames(): string[];
     getNetworkId(networkName: string): string;

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

@@ -17,6 +17,9 @@ class AbstractStartedContainer {
     getName() {
         return this.startedTestContainer.getName();
     }
+    getLabels() {
+        return this.startedTestContainer.getLabels();
+    }
     getId() {
         return this.startedTestContainer.getId();
     }

package/dist/reaper.js

@@ -14,10 +14,10 @@ const net_1 = require("net");
 const logger_1 = require("./logger");
 const generic_container_1 = require("./generic-container/generic-container");
 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");
+const wait_1 = require("./wait");
 class RealReaper {
     constructor(container, socket) {
         this.container = container;
@@ -85,13 +85,14 @@ class ReaperInstance {
             const container = new generic_container_1.GenericContainer(images_1.REAPER_IMAGE)
                 .withName(`testcontainers-ryuk-${session_id_1.sessionId}`)
                 .withExposedPorts(8080)
-                .withBindMount(dockerSocket, "/var/run/docker.sock");
+                .withBindMount(dockerSocket, "/var/run/docker.sock")
+                .withWaitStrategy(wait_1.Wait.forLogMessage(/.+ Started!/));
             if (this.isPrivileged()) {
                 container.withPrivilegedMode();
             }
             const startedContainer = yield container.start();
             const containerId = startedContainer.getId();
-            const host = (yield docker_client_1.dockerClient).host;
+            const host = startedContainer.getHost();
             const port = startedContainer.getMappedPort(8080);
             logger_1.log.debug(`Connecting to Reaper ${containerId} on ${host}:${port}`);
             const socket = new net_1.Socket();

package/dist/test-container.d.ts

@@ -3,7 +3,7 @@ import { Port, PortWithOptionalBinding } from "./port";
 import { PullPolicy } from "./pull-policy";
 import { WaitStrategy } from "./wait-strategy";
 import { Readable } from "stream";
-import { BindMode, Command, ContainerName, Dir, EnvKey, EnvValue, ExecResult, ExtraHost, Host, Id, NetworkMode, TmpFs } from "./docker/types";
+import { BindMode, Command, ContainerName, Dir, EnvKey, EnvValue, ExecResult, ExtraHost, Host, Id, NetworkMode, TmpFs, Labels } from "./docker/types";
 export interface TestContainer {
     start(): Promise<StartedTestContainer>;
     withEnv(key: EnvKey, value: EnvValue): this;
@@ -32,6 +32,7 @@ export interface StartedTestContainer {
     getHost(): Host;
     getMappedPort(port: Port): Port;
     getName(): ContainerName;
+    getLabels(): Labels;
     getId(): Id;
     getNetworkNames(): string[];
     getNetworkId(networkName: string): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.6.1-beta.0",
+  "version": "8.7.0",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [