@testcontainers/kafka 10.0.0-beta.4

package/build/index.d.ts

@@ -0,0 +1 @@
+export { KafkaContainer, StartedKafkaContainer } from "./kafka-container";

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedKafkaContainer = exports.KafkaContainer = void 0;
+var kafka_container_1 = require("./kafka-container");
+Object.defineProperty(exports, "KafkaContainer", { enumerable: true, get: function () { return kafka_container_1.KafkaContainer; } });
+Object.defineProperty(exports, "StartedKafkaContainer", { enumerable: true, get: function () { return kafka_container_1.StartedKafkaContainer; } });
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAA0E;AAAjE,iHAAA,cAAc,OAAA;AAAE,wHAAA,qBAAqB,OAAA"}

package/build/kafka-container.d.ts

@@ -0,0 +1,41 @@
+import { AbstractStartedContainer, Content, GenericContainer, InspectResult, StartedTestContainer } from "@testcontainers/testcontainers";
+export declare const KAFKA_IMAGE = "confluentinc/cp-kafka:7.2.2";
+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: Content;
+    passphrase: string;
+}
+export declare class KafkaContainer extends GenericContainer {
+    private readonly uuid;
+    private isZooKeeperProvided;
+    private zooKeeperHost?;
+    private zooKeeperPort?;
+    private saslSslConfig?;
+    constructor(image?: string);
+    withZooKeeper(host: string, port: number): this;
+    withSaslSslListener(options: SaslSslListenerOptions): this;
+    protected beforeContainerCreated(): Promise<void>;
+    start(): Promise<StartedKafkaContainer>;
+    protected containerStarted(container: StartedTestContainer, inspectResult: InspectResult): Promise<void>;
+    private addPlaintextAndSecureListener;
+    private addPlaintextListener;
+    private updateAdvertisedListeners;
+    private createUser;
+}
+export declare class StartedKafkaContainer extends AbstractStartedContainer {
+    constructor(startedTestContainer: StartedTestContainer);
+}
+export {};

package/build/kafka-container.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedKafkaContainer = exports.KafkaContainer = exports.KAFKA_IMAGE = void 0;
+const testcontainers_1 = require("@testcontainers/testcontainers");
+const KAFKA_PORT = 9093;
+const KAFKA_BROKER_PORT = 9092;
+const DEFAULT_ZOOKEEPER_PORT = 2181;
+exports.KAFKA_IMAGE = "confluentinc/cp-kafka:7.2.2";
+class KafkaContainer extends testcontainers_1.GenericContainer {
+    uuid = new testcontainers_1.RandomUuid();
+    isZooKeeperProvided = false;
+    zooKeeperHost;
+    zooKeeperPort;
+    saslSslConfig;
+    constructor(image = exports.KAFKA_IMAGE) {
+        super(image);
+        this.withExposedPorts(KAFKA_PORT).withStartupTimeout(180000).withEnvironment({
+            KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: "BROKER:PLAINTEXT,PLAINTEXT:PLAINTEXT",
+            KAFKA_INTER_BROKER_LISTENER_NAME: "BROKER",
+            KAFKA_BROKER_ID: "1",
+            KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: "1",
+            KAFKA_OFFSETS_TOPIC_NUM_PARTITIONS: "1",
+            KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: "1",
+            KAFKA_LOG_FLUSH_INTERVAL_MESSAGES: "9223372036854775807",
+            KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS: "0",
+            KAFKA_CONFLUENT_SUPPORT_METRICS_ENABLE: "false",
+        });
+    }
+    withZooKeeper(host, port) {
+        this.isZooKeeperProvided = true;
+        this.zooKeeperHost = host;
+        this.zooKeeperPort = port;
+        return this;
+    }
+    withSaslSslListener(options) {
+        this.saslSslConfig = options;
+        return this;
+    }
+    async beforeContainerCreated() {
+        const network = this.networkMode && this.networkAliases.length > 0 ? this.networkAliases[0] : "localhost";
+        this.withEnvironment({ 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.withEnvironment({ KAFKA_ZOOKEEPER_CONNECT: `${this.zooKeeperHost}:${this.zooKeeperPort}` });
+        }
+        else {
+            this.zooKeeperHost = this.uuid.nextUuid();
+            this.zooKeeperPort = DEFAULT_ZOOKEEPER_PORT;
+            this.withExposedPorts(this.zooKeeperPort);
+            this.withEnvironment({ KAFKA_ZOOKEEPER_CONNECT: `localhost:${this.zooKeeperPort}` });
+            command += "echo 'clientPort=" + this.zooKeeperPort + "' > zookeeper.properties\n";
+            command += "echo 'dataDir=/var/lib/zookeeper/data' >> zookeeper.properties\n";
+            command += "echo 'dataLogDir=/var/lib/zookeeper/log' >> zookeeper.properties\n";
+            command += "zookeeper-server-start zookeeper.properties &\n";
+        }
+        command += "echo '' > /etc/confluent/docker/ensure \n";
+        command += "/etc/confluent/docker/run \n";
+        this.withCommand(["sh", "-c", command]);
+    }
+    async start() {
+        return new StartedKafkaContainer(await super.start());
+    }
+    async containerStarted(container, inspectResult) {
+        await this.updateAdvertisedListeners(container, inspectResult);
+        if (this.saslSslConfig) {
+            await this.createUser(container, this.saslSslConfig.sasl);
+        }
+    }
+    addPlaintextAndSecureListener({ port, sasl, keystore, truststore }) {
+        this.withEnvironment({
+            KAFKA_LISTENERS: `SECURE://0.0.0.0:${port},PLAINTEXT://0.0.0.0:${KAFKA_PORT},BROKER://0.0.0.0:${KAFKA_BROKER_PORT}`,
+            KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: "BROKER:PLAINTEXT,PLAINTEXT:PLAINTEXT,SECURE:SASL_SSL",
+            KAFKA_SSL_PROTOCOL: "TLSv1.2",
+            KAFKA_SSL_KEYSTORE_LOCATION: "/etc/kafka/secrets/server.keystore.pfx",
+            KAFKA_SSL_KEYSTORE_PASSWORD: keystore.passphrase,
+            KAFKA_SSL_KEYSTORE_TYPE: "PKCS12",
+            KAFKA_SASL_ENABLED_MECHANISMS: sasl.mechanism,
+            [`KAFKA_LISTENER_NAME_SECURE_${sasl.mechanism}_SASL_JAAS_CONFIG`]: "org.apache.kafka.common.security.scram.ScramLoginModule required;",
+        })
+            .withCopyContentToContainer([{ content: keystore.content, target: "/etc/kafka/secrets/server.keystore.pfx" }])
+            .withExposedPorts(KAFKA_PORT, port);
+        if (truststore) {
+            this.withCopyContentToContainer([
+                { content: truststore.content, target: "/etc/kafka/secrets/server.truststore.pfx" },
+            ]).withEnvironment({
+                KAFKA_SSL_TRUSTSTORE_LOCATION: "/etc/kafka/secrets/server.truststore.pfx",
+                KAFKA_SSL_TRUSTSTORE_PASSWORD: truststore.passphrase,
+                KAFKA_SSL_TRUSTSTORE_TYPE: "PKCS12",
+            });
+        }
+    }
+    addPlaintextListener() {
+        this.withEnvironment({
+            KAFKA_LISTENERS: `PLAINTEXT://0.0.0.0:${KAFKA_PORT},BROKER://0.0.0.0:${KAFKA_BROKER_PORT}`,
+        }).withExposedPorts(KAFKA_PORT);
+    }
+    async updateAdvertisedListeners(container, inspectResult) {
+        const brokerAdvertisedListener = `BROKER://${inspectResult.hostname}:${KAFKA_BROKER_PORT}`;
+        let bootstrapServers = `PLAINTEXT://${container.getHost()}:${container.getMappedPort(KAFKA_PORT)}`;
+        if (this.saslSslConfig) {
+            if (this.networkMode) {
+                bootstrapServers = `${bootstrapServers},SECURE://${inspectResult.hostname}:${this.saslSslConfig.port}`;
+            }
+            else {
+                bootstrapServers = `${bootstrapServers},SECURE://${container.getHost()}:${container.getMappedPort(this.saslSslConfig.port)}`;
+            }
+        }
+        const { output, exitCode } = await container.exec([
+            "kafka-configs",
+            "--alter",
+            "--bootstrap-server",
+            brokerAdvertisedListener,
+            "--entity-type",
+            "brokers",
+            "--entity-name",
+            this.environment["KAFKA_BROKER_ID"],
+            "--add-config",
+            `advertised.listeners=[${bootstrapServers},${brokerAdvertisedListener}]`,
+        ]);
+        if (exitCode !== 0) {
+            throw new Error(`Kafka container configuration failed with exit code ${exitCode}: ${output}`);
+        }
+    }
+    async createUser(container, { user: { name, password }, mechanism }) {
+        const { output, exitCode } = await 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.environment["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 testcontainers_1.AbstractStartedContainer {
+    constructor(startedTestContainer) {
+        super(startedTestContainer);
+    }
+}
+exports.StartedKafkaContainer = StartedKafkaContainer;
+//# sourceMappingURL=kafka-container.js.map

package/build/kafka-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kafka-container.js","sourceRoot":"","sources":["../src/kafka-container.ts"],"names":[],"mappings":";;;AAAA,mEAQwC;AAExC,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAC/B,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAEvB,QAAA,WAAW,GAAG,6BAA6B,CAAC;AAwBzD,MAAa,cAAe,SAAQ,iCAAgB;IACjC,IAAI,GAAS,IAAI,2BAAU,EAAE,CAAC;IAEvC,mBAAmB,GAAG,KAAK,CAAC;IAC5B,aAAa,CAAU;IACvB,aAAa,CAAU;IACvB,aAAa,CAA0B;IAE/C,YAAY,KAAK,GAAG,mBAAW;QAC7B,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,MAAO,CAAC,CAAC,eAAe,CAAC;YAC5E,oCAAoC,EAAE,sCAAsC;YAC5E,gCAAgC,EAAE,QAAQ;YAC1C,eAAe,EAAE,GAAG;YACpB,sCAAsC,EAAE,GAAG;YAC3C,kCAAkC,EAAE,GAAG;YACvC,mCAAmC,EAAE,GAAG;YACxC,iCAAiC,EAAE,qBAAqB;YACxD,sCAAsC,EAAE,GAAG;YAC3C,sCAAsC,EAAE,OAAO;SAChD,CAAC,CAAC;IACL,CAAC;IAEM,aAAa,CAAC,IAAY,EAAE,IAAY;QAC7C,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mBAAmB,CAAC,OAA+B;QACjD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAEkB,KAAK,CAAC,sBAAsB;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;QAC1G,IAAI,CAAC,eAAe,CAAC,EAAE,0BAA0B,EAAE,YAAY,OAAO,IAAI,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAEjG,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC7B;QAED,IAAI,OAAO,GAAG,eAAe,CAAC;QAC9B,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC5B,IAAI,CAAC,eAAe,CAAC,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;SAClG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,GAAG,sBAAsB,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC1C,IAAI,CAAC,eAAe,CAAC,EAAE,uBAAuB,EAAE,aAAa,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YACrF,OAAO,IAAI,mBAAmB,GAAG,IAAI,CAAC,aAAa,GAAG,4BAA4B,CAAC;YACnF,OAAO,IAAI,kEAAkE,CAAC;YAC9E,OAAO,IAAI,oEAAoE,CAAC;YAChF,OAAO,IAAI,iDAAiD,CAAC;SAC9D;QAED,OAAO,IAAI,2CAA2C,CAAC;QACvD,OAAO,IAAI,8BAA8B,CAAC;QAC1C,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;IAEe,KAAK,CAAC,KAAK;QACzB,OAAO,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAEkB,KAAK,CAAC,gBAAgB,CACvC,SAA+B,EAC/B,aAA4B;QAE5B,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAC3D;IACH,CAAC;IAEO,6BAA6B,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAA0B;QAChG,IAAI,CAAC,eAAe,CAAC;YACnB,eAAe,EAAE,oBAAoB,IAAI,wBAAwB,UAAU,qBAAqB,iBAAiB,EAAE;YACnH,oCAAoC,EAAE,sDAAsD;YAC5F,kBAAkB,EAAE,SAAS;YAC7B,2BAA2B,EAAE,wCAAwC;YACrE,2BAA2B,EAAE,QAAQ,CAAC,UAAU;YAChD,uBAAuB,EAAE,QAAQ;YACjC,6BAA6B,EAAE,IAAI,CAAC,SAAS;YAC7C,CAAC,8BAA8B,IAAI,CAAC,SAAS,mBAAmB,CAAC,EAC/D,mEAAmE;SACtE,CAAC;aACC,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,wCAAwC,EAAE,CAAC,CAAC;aAC7G,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAEtC,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,0BAA0B,CAAC;gBAC9B,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,0CAA0C,EAAE;aACpF,CAAC,CAAC,eAAe,CAAC;gBACjB,6BAA6B,EAAE,0CAA0C;gBACzE,6BAA6B,EAAE,UAAU,CAAC,UAAU;gBACpD,yBAAyB,EAAE,QAAQ;aACpC,CAAC,CAAC;SACJ;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,eAAe,CAAC;YACnB,eAAe,EAAE,uBAAuB,UAAU,qBAAqB,iBAAiB,EAAE;SAC3F,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,SAA+B,EAAE,aAA4B;QACnG,MAAM,wBAAwB,GAAG,YAAY,aAAa,CAAC,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QAE3F,IAAI,gBAAgB,GAAG,eAAe,SAAS,CAAC,OAAO,EAAE,IAAI,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACnG,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,gBAAgB,GAAG,GAAG,gBAAgB,aAAa,aAAa,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;aACxG;iBAAM;gBACL,gBAAgB,GAAG,GAAG,gBAAgB,aAAa,SAAS,CAAC,OAAO,EAAE,IAAI,SAAS,CAAC,aAAa,CAC/F,IAAI,CAAC,aAAa,CAAC,IAAI,CACxB,EAAE,CAAC;aACL;SACF;QAED,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YAChD,eAAe;YACf,SAAS;YACT,oBAAoB;YACpB,wBAAwB;YACxB,eAAe;YACf,SAAS;YACT,eAAe;YACf,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC;YACnC,cAAc;YACd,yBAAyB,gBAAgB,IAAI,wBAAwB,GAAG;SACzE,CAAC,CAAC;QAEH,IAAI,QAAQ,KAAK,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,uDAAuD,QAAQ,KAAK,MAAM,EAAE,CAAC,CAAC;SAC/F;IACH,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,SAA+B,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAe;QAC5G,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YAChD,eAAe;YACf,SAAS;YACT,0IAA0I;YAC1I,6FAA6F;YAC7F,aAAa;YACb,IAAI,CAAC,WAAW,CAAC,yBAAyB,CAAC;YAC3C,eAAe;YACf,OAAO;YACP,eAAe;YACf,GAAG,IAAI,EAAE;YACT,cAAc;YACd,GAAG,SAAS,cAAc,QAAQ,GAAG;SACtC,CAAC,CAAC;QAEH,IAAI,QAAQ,KAAK,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,uDAAuD,QAAQ,KAAK,MAAM,EAAE,CAAC,CAAC;SAC/F;IACH,CAAC;CACF;AApKD,wCAoKC;AAED,MAAa,qBAAsB,SAAQ,yCAAwB;IACjE,YAAY,oBAA0C;QACpD,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC9B,CAAC;CACF;AAJD,sDAIC"}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@testcontainers/kafka",
+  "version": "10.0.0-beta.4",
+  "license": "MIT",
+  "main": "build/index.js",
+  "files": [
+    "build"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json"
+  },
+  "devDependencies": {
+    "kafkajs": "^2.2.4"
+  },
+  "dependencies": {
+    "@testcontainers/testcontainers": "*"
+  }
+}