Skip to content

Kafka with Testcontainers

Understanding with testcontainers helps you work with Apache Kafka confidently. Here you will learn the core ideas behind with testcontainers, see working code, and pick up best practices used on real teams.

with Testcontainers Overview

At its core, with testcontainers is about doing one thing well inside your Apache Kafka project. Once you understand the pattern, you can apply it consistently across features and teams.

Good with testcontainers pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

import { Kafka } from 'kafkajs';

test('produces and consumes an order event', async () => {
  const messages = [];
  await consumer.run({
    eachMessage: async ({ message }) =>
      messages.push(JSON.parse(message.value.toString())),
  });
  await producer.send({ topic: 'orders', messages: [{ value: '{"id":"1"}' }] });
  // assert messages received
});

Integration tests produce a message and assert the consumer receives it.

with Testcontainers Example

import { Kafka } from 'kafkajs';

const kafka = new Kafka({ clientId: 'app', brokers: ['localhost:9092'] });
const producer = kafka.producer();
const consumer = kafka.consumer({ groupId: 'group' });
  • Start from a minimal with Testcontainers example and grow it only as needed.
  • Keep configuration explicit so with Testcontainers behaves the same in every environment.
  • Name things clearly so teammates understand your with Testcontainers at a glance.
  • Add tests around with Testcontainers early to lock in expected behaviour.

Apache Kafka Cheatsheet

Handy KafkaJS reference related to with testcontainers.

Task Example Purpose
Create client new Kafka({ clientId, brokers }) Connect to the cluster
Produce producer.send({ topic, messages }) Publish events
Consume consumer.run({ eachMessage }) Process events
Subscribe consumer.subscribe({ topic }) Choose topics to read
Group kafka.consumer({ groupId }) Scale consumers
Admin admin.createTopics(...) Manage topics
Commit offset auto-commit or commitOffsets Track progress

How with Testcontainers Works in Apache Kafka

with Testcontainers builds on Kafka's log-based design, where producers append events to partitioned topics and consumer groups read them independently, tracking their own offsets.

Integration tests produce a message and assert the consumer receives it.

  • Topics are split into partitions for parallelism and ordering per key.
  • Producers choose a partition, usually by message key.
  • Consumer groups share partitions so work scales horizontally.
  • Offsets record how far each group has read.

Practical Guidance for with Testcontainers

In production, with testcontainers needs attention to delivery guarantees, retries, and observability. Make handlers idempotent and monitor consumer lag closely.

Concern Recommendation
Ordering Key related events so they land on one partition
Reliability Use acks=all and idempotent producers
Idempotency Handle duplicate deliveries safely
Monitoring Track consumer lag and error rates

Common Mistakes

  • Skipping error handling and edge cases when wiring up with testcontainers.
  • Leaving with testcontainers untested, so regressions slip into production.
  • Over-engineering with testcontainers before you actually need the extra flexibility.
  • Ignoring documentation, which makes with testcontainers hard for the next developer to change.

Key Takeaways

  • with Testcontainers is a core part of working effectively with Apache Kafka.
  • Start small and keep with testcontainers focused on a single responsibility.
  • Apply consistent patterns so with testcontainers scales across your project.
  • Test and document with testcontainers to keep it maintainable over time.

Pro Tip

Bookmark this with testcontainers pattern and reuse it. Consistency across your Apache Kafka codebase is worth more than clever one-off solutions.