testcontainers 8.7.2 → 8.8.1-beta.1

package/README.md

@@ -18,18 +18,26 @@ npm i -D testcontainers
 
 The following environment variables are supported:
 
+### Logs
+
 - `DEBUG=testcontainers` Enable testcontainers logs
 - `DEBUG=testcontainers:containers` Enable container logs
 - `DEBUG=testcontainers*` Enable all logs
+
+### Docker
+
 - `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_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`
+  verification
+- `DOCKER_CONFIG=/some/path` Configures the path to the `config.json`
 - `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
+
+### Testcontainers
+
 - `TESTCONTAINERS_RYUK_PRIVILEGED=true` Run [ryuk](#ryuk) as a privileged container
 - `TESTCONTAINERS_RYUK_DISABLED=true` Disable [ryuk](#ryuk)
 - `RYUK_CONTAINER_IMAGE=registry.mycompany.com/mirror/ryuk:0.3.0` Custom image for [ryuk](#ryuk)

package/dist/docker/docker-client.js

@@ -60,18 +60,21 @@ class ConfigurationStrategy {
         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;
+            const { pathname, hostname, port } = new url_1.URL(DOCKER_HOST);
+            if (hostname !== "") {
+                dockerOptions.host = hostname;
+                dockerOptions.port = port;
+            }
+            else {
+                dockerOptions.socketPath = pathname;
+            }
             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,
+                uri: DOCKER_HOST,
                 dockerode: new dockerode_1.default(dockerOptions),
             };
         });

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

@@ -39,6 +39,7 @@ export declare class GenericContainer implements TestContainer {
     private reuseContainer;
     private startContainer;
     protected postStart?(container: StartedTestContainer, inspectResult: InspectResult, boundPorts: BoundPorts): Promise<void>;
+    protected get hasExposedPorts(): boolean;
     withCmd(cmd: Command[]): this;
     withName(name: ContainerName): this;
     withLabels(labels: Labels): this;

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

@@ -163,6 +163,9 @@ class GenericContainer {
             return startedContainer;
         });
     }
+    get hasExposedPorts() {
+        return this.ports.length !== 0;
+    }
     withCmd(cmd) {
         this.cmd = cmd;
         return this;

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

@@ -13,7 +13,7 @@ exports.StartedArangoContainer = exports.ArangoDBContainer = void 0;
 const __1 = require("../..");
 const uuid_1 = require("../../uuid");
 const abstract_started_container_1 = require("../abstract-started-container");
-const PORT = 8529;
+const ARANGODB_PORT = 8529;
 const USERNAME = "root";
 class ArangoDBContainer extends __1.GenericContainer {
     constructor(image = "arangodb:3.7.13", password = new uuid_1.RandomUuid().nextUuid()) {
@@ -29,7 +29,7 @@ class ArangoDBContainer extends __1.GenericContainer {
             start: { get: () => super.start }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            this.withExposedPorts(PORT)
+            this.withExposedPorts(...(this.hasExposedPorts ? this.ports : [ARANGODB_PORT]))
                 .withWaitStrategy(__1.Wait.forLogMessage("Have fun!"))
                 .withEnv("ARANGO_ROOT_PASSWORD", this.password)
                 .withStartupTimeout(120000);
@@ -43,7 +43,7 @@ class StartedArangoContainer extends abstract_started_container_1.AbstractStarte
         super(startedTestContainer);
         this.password = password;
         this.host = this.startedTestContainer.getHost();
-        this.port = this.startedTestContainer.getMappedPort(PORT);
+        this.port = this.startedTestContainer.getMappedPort(ARANGODB_PORT);
     }
     getTcpUrl() {
         return `tcp://${this.host}:${this.port}/`;

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

@@ -22,7 +22,7 @@ class ElasticsearchContainer extends __1.GenericContainer {
             start: { get: () => super.start }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            this.withExposedPorts(ELASTIC_SEARCH_HTTP_PORT)
+            this.withExposedPorts(...(this.hasExposedPorts ? this.ports : [ELASTIC_SEARCH_HTTP_PORT]))
                 .withEnv("discovery.type", "single-node")
                 .withStartupTimeout(120000);
             return new StartedElasticsearchContainer(yield _super.start.call(this));

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

@@ -6,17 +6,42 @@ import { AbstractStartedContainer } from "../abstract-started-container";
 import { Host } from "../../docker/types";
 import { InspectResult } from "../../docker/functions/container/inspect-container";
 export declare const KAFKA_IMAGE = "confluentinc/cp-kafka:5.5.4";
+interface SaslSslListenerOptions {
+    sasl: SaslOptions;
+    port: number;
+    keystore: PKCS12CertificateStore;
+    truststore?: PKCS12CertificateStore;
+}
+interface SaslOptions {
+    mechanism: "SCRAM-SHA-256" | "SCRAM-SHA-512";
+    user: User;
+}
+interface User {
+    name: string;
+    password: string;
+}
+interface PKCS12CertificateStore {
+    content: Parameters<GenericContainer["withCopyContentToContainer"]>[0];
+    passphrase: string;
+}
 export declare class KafkaContainer extends GenericContainer {
     private readonly uuid;
     private isZooKeeperProvided;
     private zooKeeperHost?;
     private zooKeeperPort?;
+    private saslSslConfig?;
     constructor(image?: string);
     withZooKeeper(host: Host, port: Port): this;
+    withSaslSslListener(options: SaslSslListenerOptions): this;
     protected preStart(): Promise<void>;
     start(): Promise<StartedKafkaContainer>;
     protected postStart(container: StartedTestContainer, inspectResult: InspectResult, boundPorts: BoundPorts): Promise<void>;
+    private addPlaintextAndSecureListener;
+    private addPlaintextListener;
+    private updateAdvertisedListeners;
+    private createUser;
 }
 export declare class StartedKafkaContainer extends AbstractStartedContainer {
     constructor(startedTestContainer: StartedTestContainer);
 }
+export {};

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

@@ -13,7 +13,6 @@ exports.StartedKafkaContainer = exports.KafkaContainer = exports.KAFKA_IMAGE = v
 const generic_container_1 = require("../../generic-container/generic-container");
 const uuid_1 = require("../../uuid");
 const abstract_started_container_1 = require("../abstract-started-container");
-const docker_client_1 = require("../../docker/docker-client");
 const KAFKA_PORT = 9093;
 const KAFKA_BROKER_PORT = 9092;
 const DEFAULT_ZOOKEEPER_PORT = 2181;
@@ -25,7 +24,6 @@ class KafkaContainer extends generic_container_1.GenericContainer {
         this.isZooKeeperProvided = false;
         this.withExposedPorts(KAFKA_PORT)
             .withStartupTimeout(180000)
-            .withEnv("KAFKA_LISTENERS", `PLAINTEXT://0.0.0.0:${KAFKA_PORT},BROKER://0.0.0.0:${KAFKA_BROKER_PORT}`)
             .withEnv("KAFKA_LISTENER_SECURITY_PROTOCOL_MAP", "BROKER:PLAINTEXT,PLAINTEXT:PLAINTEXT")
             .withEnv("KAFKA_INTER_BROKER_LISTENER_NAME", "BROKER")
             .withEnv("KAFKA_BROKER_ID", "1")
@@ -42,10 +40,20 @@ class KafkaContainer extends generic_container_1.GenericContainer {
         this.zooKeeperPort = port;
         return this;
     }
+    withSaslSslListener(options) {
+        this.saslSslConfig = options;
+        return this;
+    }
     preStart() {
         return __awaiter(this, void 0, void 0, function* () {
             const network = this.networkMode && this.networkAliases.length > 0 ? this.networkAliases[0] : "localhost";
             this.withEnv("KAFKA_ADVERTISED_LISTENERS", `BROKER://${network}:${KAFKA_BROKER_PORT}`);
+            if (this.saslSslConfig) {
+                this.addPlaintextAndSecureListener(this.saslSslConfig);
+            }
+            else {
+                this.addPlaintextListener();
+            }
             let command = "#!/bin/bash\n";
             if (this.isZooKeeperProvided) {
                 this.withEnv("KAFKA_ZOOKEEPER_CONNECT", `${this.zooKeeperHost}:${this.zooKeeperPort}`);
@@ -74,9 +82,41 @@ class KafkaContainer extends generic_container_1.GenericContainer {
         });
     }
     postStart(container, inspectResult, boundPorts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.updateAdvertisedListeners(container, inspectResult, boundPorts);
+            if (this.saslSslConfig) {
+                yield this.createUser(container, this.saslSslConfig.sasl);
+            }
+        });
+    }
+    addPlaintextAndSecureListener({ port, sasl, keystore, truststore }) {
+        this.withEnv("KAFKA_LISTENERS", `SECURE://0.0.0.0:${port},PLAINTEXT://0.0.0.0:${KAFKA_PORT},BROKER://0.0.0.0:${KAFKA_BROKER_PORT}`)
+            .withEnv("KAFKA_LISTENER_SECURITY_PROTOCOL_MAP", "BROKER:PLAINTEXT,PLAINTEXT:PLAINTEXT,SECURE:SASL_SSL")
+            .withEnv("KAFKA_SSL_PROTOCOL", "TLSv1.2")
+            .withCopyContentToContainer(keystore.content, "/etc/kafka/secrets/server.keystore.pfx")
+            .withEnv("KAFKA_SSL_KEYSTORE_LOCATION", "/etc/kafka/secrets/server.keystore.pfx")
+            .withEnv("KAFKA_SSL_KEYSTORE_PASSWORD", keystore.passphrase)
+            .withEnv("KAFKA_SSL_KEYSTORE_TYPE", "PKCS12")
+            .withEnv("KAFKA_SASL_ENABLED_MECHANISMS", sasl.mechanism)
+            .withEnv(`KAFKA_LISTENER_NAME_SECURE_${sasl.mechanism}_SASL_JAAS_CONFIG`, "org.apache.kafka.common.security.scram.ScramLoginModule required;")
+            .addExposedPorts(KAFKA_PORT, port);
+        if (truststore) {
+            this.withCopyContentToContainer(truststore.content, "/etc/kafka/secrets/server.truststore.pfx")
+                .withEnv("KAFKA_SSL_TRUSTSTORE_LOCATION", "/etc/kafka/secrets/server.truststore.pfx")
+                .withEnv("KAFKA_SSL_TRUSTSTORE_PASSWORD", truststore.passphrase)
+                .withEnv("KAFKA_SSL_TRUSTSTORE_TYPE", "PKCS12");
+        }
+    }
+    addPlaintextListener() {
+        this.withEnv("KAFKA_LISTENERS", `PLAINTEXT://0.0.0.0:${KAFKA_PORT},BROKER://0.0.0.0:${KAFKA_BROKER_PORT}`).addExposedPorts(KAFKA_PORT);
+    }
+    updateAdvertisedListeners(container, inspectResult, boundPorts) {
         return __awaiter(this, void 0, void 0, function* () {
             const brokerAdvertisedListener = `BROKER://${inspectResult.hostname}:${KAFKA_BROKER_PORT}`;
-            const bootstrapServers = `PLAINTEXT://${(yield docker_client_1.dockerClient).host}:${boundPorts.getBinding(KAFKA_PORT)}`;
+            let bootstrapServers = `PLAINTEXT://${container.getHost()}:${boundPorts.getBinding(KAFKA_PORT)}`;
+            if (this.saslSslConfig) {
+                bootstrapServers = `${bootstrapServers},SECURE://${container.getHost()}:${boundPorts.getBinding(this.saslSslConfig.port)}`;
+            }
             const { output, exitCode } = yield container.exec([
                 "kafka-configs",
                 "--alter",
@@ -94,6 +134,27 @@ class KafkaContainer extends generic_container_1.GenericContainer {
             }
         });
     }
+    createUser(container, { user: { name, password }, mechanism }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { output, exitCode } = yield container.exec([
+                "kafka-configs",
+                "--alter",
+                // At the time of writing kafka-configs displays a warning stating that the 'zookeeper' flag is deprecated in favor of 'bootstrap-server'.
+                // Unfortunately, 'bootstrap-server' can only be used to set quotas and not to create a user.
+                "--zookeeper",
+                this.env["KAFKA_ZOOKEEPER_CONNECT"],
+                "--entity-type",
+                "users",
+                "--entity-name",
+                `${name}`,
+                "--add-config",
+                `${mechanism}=[password=${password}]`,
+            ]);
+            if (exitCode !== 0) {
+                throw new Error(`Kafka container configuration failed with exit code ${exitCode}: ${output}`);
+            }
+        });
+    }
 }
 exports.KafkaContainer = KafkaContainer;
 class StartedKafkaContainer extends abstract_started_container_1.AbstractStartedContainer {

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

@@ -13,6 +13,7 @@ exports.StartedMySqlContainer = exports.MySqlContainer = void 0;
 const generic_container_1 = require("../../generic-container/generic-container");
 const uuid_1 = require("../../uuid");
 const abstract_started_container_1 = require("../abstract-started-container");
+const MYSQL_PORT = 3306;
 class MySqlContainer extends generic_container_1.GenericContainer {
     constructor(image = "mysql:8.0.26") {
         super(image);
@@ -42,7 +43,7 @@ class MySqlContainer extends generic_container_1.GenericContainer {
             start: { get: () => super.start }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            this.withExposedPorts(3306)
+            this.withExposedPorts(...(this.hasExposedPorts ? this.ports : [MYSQL_PORT]))
                 .withEnv("MYSQL_DATABASE", this.database)
                 .withEnv("MYSQL_ROOT_PASSWORD", this.rootPassword)
                 .withEnv("MYSQL_USER", this.username)

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

@@ -39,7 +39,7 @@ class Neo4jContainer extends __1.GenericContainer {
             start: { get: () => super.start }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            this.withExposedPorts(BOLT_PORT, HTTP_PORT)
+            this.withExposedPorts(...(this.hasExposedPorts ? this.ports : [BOLT_PORT, HTTP_PORT]))
                 .withWaitStrategy(__1.Wait.forLogMessage("Started."))
                 .withEnv("NEO4J_AUTH", `${USERNAME}/${this.password}`)
                 .withStartupTimeout(120000);

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

@@ -13,6 +13,7 @@ exports.StartedPostgreSqlContainer = exports.PostgreSqlContainer = void 0;
 const generic_container_1 = require("../../generic-container/generic-container");
 const uuid_1 = require("../../uuid");
 const abstract_started_container_1 = require("../abstract-started-container");
+const POSTGRES_PORT = 5432;
 class PostgreSqlContainer extends generic_container_1.GenericContainer {
     constructor(image = "postgres:13.3-alpine") {
         super(image);
@@ -37,7 +38,7 @@ class PostgreSqlContainer extends generic_container_1.GenericContainer {
             start: { get: () => super.start }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            this.withExposedPorts(5432)
+            this.withExposedPorts(...(this.hasExposedPorts ? this.ports : [POSTGRES_PORT]))
                 .withEnv("POSTGRES_DB", this.database)
                 .withEnv("POSTGRES_USER", this.username)
                 .withEnv("POSTGRES_PASSWORD", this.password)

package/package.json

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