Redpanda

cristianrgreco · cristianrgreco · commit 5bc56c4e53b1 · 2025-07-31T11:50:08.000+01:00
diff --git a/docs/modules/kafka.md b/docs/modules/kafka.md
@@ -22,14 +22,14 @@ Choose an image from the [container registry](https://hub.docker.com/r/confluent
 
 <!--codeinclude-->
 [Code](../../packages/modules/kafka/src/kafka-container-latest.test.ts) inside_block:kafkaLatestConnect
-[Helper function](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
+[`assertMessageProducedAndConsumed`](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
 <!--/codeinclude-->
 
 #### With SSL
 
 <!--codeinclude-->
 [Code](../../packages/modules/kafka/src/kafka-container-latest.test.ts) inside_block:kafkaLatestSsl
-[Helper function](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
+[`assertMessageProducedAndConsumed`](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
 <!--/codeinclude-->
 
 ---
@@ -48,14 +48,14 @@ Choose an image from the [container registry](https://hub.docker.com/r/confluent
 
 <!--codeinclude-->
 [Code](../../packages/modules/kafka/src/kafka-container-7.test.ts) inside_block:connectBuiltInZK
-[Helper function](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
+[`assertMessageProducedAndConsumed`](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
 <!--/codeinclude-->
 
 #### With SSL
 
 <!--codeinclude-->
 [Code](../../packages/modules/kafka/src/kafka-container-7.test.ts) inside_block:kafkaSsl
-[Helper function](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
+[`assertMessageProducedAndConsumed`](../../packages/modules/kafka/src/test-helper.ts) inside_block:kafkaTestHelper
 <!--/codeinclude-->
 
 #### With provided ZooKeeper
diff --git a/docs/modules/redpanda.md b/docs/modules/redpanda.md
@@ -1,32 +1,42 @@
 # Redpanda
 
-Testcontainers can be used to automatically instantiate and manage [Redpanda](https://redpanda.com/) containers.
-More precisely Testcontainers uses the official Docker images for [Redpanda](https://hub.docker.com/r/redpandadata/redpanda)
-
-!!! note
-    This module uses features provided in `docker.redpanda.com/redpandadata/redpanda`.
-
 ## Install
 
-
 ```bash
 npm install @testcontainers/redpanda --save-dev
 ```
 
-## Example
+## Examples
+
+These examples use the following libraries:
+
+- [kafkajs](https://www.npmjs.com/package/kafkajs)
+
+        npm install kafkajs
+
+Choose an image from the [container registry](https://hub.docker.com/r/redpandadata/redpanda) and substitute `IMAGE`.
+
+### Produce/consume a message
 
 <!--codeinclude-->
-[Connect:](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToKafka
+[Code](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToKafka
+[`assertMessageProducedAndConsumed`](../../packages/modules/redpanda/src/test-helper.ts) inside_block:redpandaTestHelper
 <!--/codeinclude-->
 
+### Connect to schema registry
+
 <!--codeinclude-->
-[Schema registry:](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToSchemaRegistry
+[](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToSchemaRegistry
 <!--/codeinclude-->
 
+### Connect to admin
+
 <!--codeinclude-->
-[Admin APIs:](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToAdmin
+[](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToAdmin
 <!--/codeinclude-->
 
+### Connect to REST proxy
+
 <!--codeinclude-->
-[Rest Proxy:](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToRestProxy
+[](../../packages/modules/redpanda/src/redpanda-container.test.ts) inside_block:connectToRestProxy
 <!--/codeinclude-->
diff --git a/packages/modules/arangodb/src/arangodb-container.test.ts b/packages/modules/arangodb/src/arangodb-container.test.ts
@@ -4,7 +4,7 @@ import { ArangoDBContainer } from "./arangodb-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("ArangoDB", { timeout: 180_000 }, () => {
+describe("ArangoDBContainer", { timeout: 180_000 }, () => {
   it("should connect and return a query result", async () => {
     // example {
     await using container = await new ArangoDBContainer(IMAGE).start();
diff --git a/packages/modules/azurite/src/azurite-container.test.ts b/packages/modules/azurite/src/azurite-container.test.ts
@@ -6,7 +6,7 @@ import { AzuriteContainer } from "./azurite-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("Azurite", { timeout: 240_000 }, () => {
+describe("AzuriteContainer", { timeout: 240_000 }, () => {
   it("should upload and download blob with default credentials", async () => {
     // uploadAndDownloadBlob {
     await using container = await new AzuriteContainer(IMAGE).start();
diff --git a/packages/modules/cassandra/src/cassandra-container.test.ts b/packages/modules/cassandra/src/cassandra-container.test.ts
@@ -5,7 +5,7 @@ import { CassandraContainer } from "./cassandra-container";
 
 const IMAGE = getImage(__dirname);
 
-describe.sequential("Cassandra", { timeout: 240_000 }, () => {
+describe.sequential("CassandraContainer", { timeout: 240_000 }, () => {
   it("should connect and execute a query with default credentials", async () => {
     // connectWithDefaultCredentials {
     await using container = await new CassandraContainer(IMAGE).start();
diff --git a/packages/modules/chromadb/src/chromadb-container.test.ts b/packages/modules/chromadb/src/chromadb-container.test.ts
@@ -8,7 +8,7 @@ import { ChromaDBContainer } from "./chromadb-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("ChromaDB", { timeout: 360_000 }, () => {
+describe("ChromaDBContainer", { timeout: 360_000 }, () => {
   it("should connect", async () => {
     await using container = await new ChromaDBContainer(IMAGE).start();
     const client = new ChromaClient({ path: container.getHttpUrl() });
diff --git a/packages/modules/etcd/src/etcd-container.test.ts b/packages/modules/etcd/src/etcd-container.test.ts
@@ -4,7 +4,7 @@ import { EtcdContainer } from "./etcd-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("etcd", { timeout: 180_000 }, () => {
+describe("EtcdContainer", { timeout: 180_000 }, () => {
   it("should connect and perform read/write operations", async () => {
     // readWrite {
     await using container = await new EtcdContainer(IMAGE).start();
diff --git a/packages/modules/k3s/src/k3s-container.test.ts b/packages/modules/k3s/src/k3s-container.test.ts
@@ -5,7 +5,7 @@ import { K3sContainer } from "./k3s-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("K3s", { timeout: 120_000 }, () => {
+describe("K3sContainer", { timeout: 120_000 }, () => {
   // K3sContainer runs as a privileged container
   if (!process.env["CI_ROOTLESS"]) {
     it("should start and have listable node", async () => {
diff --git a/packages/modules/kafka/src/kafka-container-latest.test.ts b/packages/modules/kafka/src/kafka-container-latest.test.ts
@@ -13,6 +13,7 @@ describe("KafkaContainer", { timeout: 240_000 }, () => {
   it("should connect", async () => {
     // kafkaLatestConnect {
     await using container = await new KafkaContainer(IMAGE).start();
+
     await assertMessageProducedAndConsumed(container);
     // }
   });
diff --git a/packages/modules/kafka/src/test-helper.ts b/packages/modules/kafka/src/test-helper.ts
@@ -1,12 +1,12 @@
 import { Kafka, KafkaConfig, logLevel } from "kafkajs";
-import { StartedTestContainer } from "testcontainers";
+import { StartedKafkaContainer } from "./kafka-container";
 
 // kafkaTestHelper {
 export async function assertMessageProducedAndConsumed(
-  kafkaContainer: StartedTestContainer,
+  container: StartedKafkaContainer,
   additionalConfig: Partial<KafkaConfig> = {}
 ) {
-  const brokers = [`${kafkaContainer.getHost()}:${kafkaContainer.getMappedPort(9093)}`];
+  const brokers = [`${container.getHost()}:${container.getMappedPort(9093)}`];
   const kafka = new Kafka({ logLevel: logLevel.NOTHING, brokers: brokers, ...additionalConfig });
 
   const producer = kafka.producer();
diff --git a/packages/modules/minio/src/minio-container.test.ts b/packages/modules/minio/src/minio-container.test.ts
@@ -4,7 +4,7 @@ import { MinioContainer } from "./minio-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("MinIO", { timeout: 240_000 }, () => {
+describe("MinioContainer", { timeout: 240_000 }, () => {
   it("should connect and upload a file", async () => {
     // connectWithDefaultCredentials {
     await using container = await new MinioContainer(IMAGE).start();
diff --git a/packages/modules/mssqlserver/src/mssqlserver-container.test.ts b/packages/modules/mssqlserver/src/mssqlserver-container.test.ts
@@ -4,7 +4,7 @@ import { MSSQLServerContainer } from "./mssqlserver-container";
 
 const IMAGE = getImage(__dirname);
 
-describe("MSSqlServerContainer", { timeout: 180_000 }, () => {
+describe("MSSQLServerContainer", { timeout: 180_000 }, () => {
   it("should connect and return a query result", async () => {
     // mssqlConnect {
     await using container = await new MSSQLServerContainer(IMAGE).acceptLicense().start();
diff --git a/packages/modules/redpanda/src/redpanda-container.test.ts b/packages/modules/redpanda/src/redpanda-container.test.ts
@@ -1,21 +1,22 @@
-import { Kafka, KafkaConfig, logLevel } from "kafkajs";
 import { getImage } from "../../../testcontainers/src/utils/test-helper";
-import { RedpandaContainer, StartedRedpandaContainer } from "./redpanda-container";
+import { RedpandaContainer } from "./redpanda-container";
+import { assertMessageProducedAndConsumed } from "./test-helper";
 
 const IMAGE = getImage(__dirname);
 
 describe("RedpandaContainer", { timeout: 240_000 }, () => {
-  // connectToKafka {
   it("should connect", async () => {
-    await using redpandaContainer = await new RedpandaContainer(IMAGE).start();
-    await testPubSub(redpandaContainer);
+    // connectToKafka {
+    await using container = await new RedpandaContainer(IMAGE).start();
+
+    await assertMessageProducedAndConsumed(container);
+    // }
   });
-  // }
 
-  // connectToSchemaRegistry {
   it("should connect to schema registry", async () => {
-    await using redpandaContainer = await new RedpandaContainer(IMAGE).start();
-    const schemaRegistryUrl = redpandaContainer.getSchemaRegistryAddress();
+    // connectToSchemaRegistry {
+    await using container = await new RedpandaContainer(IMAGE).start();
+    const schemaRegistryUrl = container.getSchemaRegistryAddress();
 
     const response = await fetch(`${schemaRegistryUrl}/subjects`, {
       method: "GET",
@@ -25,63 +26,28 @@ describe("RedpandaContainer", { timeout: 240_000 }, () => {
     });
 
     expect(response.status).toBe(200);
+    // }
   });
-  // }
 
-  // connectToAdmin {
   it("should connect to admin", async () => {
-    await using redpandaContainer = await new RedpandaContainer(IMAGE).start();
-    const adminUrl = `${redpandaContainer.getAdminAddress()}/v1`;
+    // connectToAdmin {
+    await using container = await new RedpandaContainer(IMAGE).start();
+    const adminUrl = `${container.getAdminAddress()}/v1`;
 
     const response = await fetch(adminUrl);
 
     expect(response.status).toBe(200);
+    // }
   });
-  // }
 
-  // connectToRestProxy {
   it("should connect to rest proxy", async () => {
-    await using redpandaContainer = await new RedpandaContainer(IMAGE).start();
-    const restProxyUrl = `${redpandaContainer.getRestProxyAddress()}/topics`;
+    // connectToRestProxy {
+    await using container = await new RedpandaContainer(IMAGE).start();
+    const restProxyUrl = `${container.getRestProxyAddress()}/topics`;
 
     const response = await fetch(restProxyUrl);
 
     expect(response.status).toBe(200);
+    // }
   });
-  // }
-
-  const testPubSub = async (
-    redpandaContainer: StartedRedpandaContainer,
-    additionalConfig: Partial<KafkaConfig> = {}
-  ) => {
-    const kafka = new Kafka({
-      logLevel: logLevel.NOTHING,
-      brokers: [redpandaContainer.getBootstrapServers()],
-      ...additionalConfig,
-    });
-
-    const producer = kafka.producer();
-    await producer.connect();
-
-    const consumer = kafka.consumer({ groupId: "test-group" });
-    await consumer.connect();
-
-    await producer.send({
-      topic: "test-topic",
-      messages: [{ value: "test message" }],
-    });
-
-    await consumer.subscribe({ topic: "test-topic", fromBeginning: true });
-
-    const consumedMessage = await new Promise((resolve) => {
-      consumer.run({
-        eachMessage: async ({ message }) => resolve(message.value?.toString()),
-      });
-    });
-
-    expect(consumedMessage).toBe("test message");
-
-    await consumer.disconnect();
-    await producer.disconnect();
-  };
 });
diff --git a/packages/modules/redpanda/src/test-helper.ts b/packages/modules/redpanda/src/test-helper.ts
@@ -0,0 +1,26 @@
+import { Kafka, logLevel } from "kafkajs";
+import { StartedRedpandaContainer } from "./redpanda-container";
+
+// redpandaTestHelper {
+export async function assertMessageProducedAndConsumed(container: StartedRedpandaContainer) {
+  const kafka = new Kafka({ logLevel: logLevel.NOTHING, brokers: [container.getBootstrapServers()] });
+
+  const producer = kafka.producer();
+  await producer.connect();
+  const consumer = kafka.consumer({ groupId: "test-group" });
+  await consumer.connect();
+
+  await producer.send({ topic: "test-topic", messages: [{ value: "test message" }] });
+  await consumer.subscribe({ topic: "test-topic", fromBeginning: true });
+
+  const consumedMessage = await new Promise((resolve) =>
+    consumer.run({
+      eachMessage: async ({ message }) => resolve(message.value?.toString()),
+    })
+  );
+  expect(consumedMessage).toBe("test message");
+
+  await consumer.disconnect();
+  await producer.disconnect();
+}
+// }
diff --git a/packages/modules/redpanda/tsconfig.build.json b/packages/modules/redpanda/tsconfig.build.json
@@ -2,7 +2,8 @@
   "extends": "./tsconfig.json",
   "exclude": [
     "build",
-    "src/**/*.test.ts"
+    "src/**/*.test.ts",
+    "src/test-helper.ts"
   ],
   "references": [
     {
