kafka

package module
v0.43.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2026 License: MIT Imports: 9 Imported by: 32

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithClusterID

func WithClusterID(clusterID string) testcontainers.CustomizeRequestOption

Types

type KafkaContainer

type KafkaContainer struct {
	testcontainers.Container
	ClusterID string
}

KafkaContainer represents the Kafka container type used in the module

func Run added in v0.32.0

Run creates an instance of the Kafka container type

Example
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/testcontainers/testcontainers-go"
	"github.com/testcontainers/testcontainers-go/modules/kafka"
)

func main() {
	// runKafkaContainer {
	ctx := context.Background()

	kafkaContainer, err := kafka.Run(ctx,
		"confluentinc/confluent-local:7.5.0",
		kafka.WithClusterID("test-cluster"),
	)
	defer func() {
		if err := testcontainers.TerminateContainer(kafkaContainer); err != nil {
			log.Printf("failed to terminate container: %s", err)
		}
	}()
	if err != nil {
		log.Printf("failed to start container: %s", err)
		return
	}
	// }

	state, err := kafkaContainer.State(ctx)
	if err != nil {
		log.Printf("failed to get container state: %s", err)
		return
	}

	fmt.Println(kafkaContainer.ClusterID)
	fmt.Println(state.Running)

}
Output:
test-cluster
true

func RunContainer deprecated

Deprecated: use Run instead RunContainer creates an instance of the Kafka container type

func (*KafkaContainer) Brokers

func (kc *KafkaContainer) Brokers(ctx context.Context) ([]string, error)

Brokers retrieves the broker connection strings from Kafka with only one entry, defined by the exposed public port.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL