kafkat

package
v1.67.2 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 9 Imported by: 0

README

Package kafkat

Пакет kafkat предназначен для упрощения написания тестов, взаимодействующих с Kafka, с использованием базового клиента-писателя и средств для управления топиками.

Types

Kafka

Структура Kafka предоставляет вспомогательные методы для создания и удаления топиков, публикации и чтения сообщений, а также генерации конфигураций Kafka-публикатора и консьюмера.

Methods:

NewKafka(t *test.Test) *Kafka

Создаёт экземпляр Kafka, инициализирует соединение с Kafka и писатель, а также регистрирует автоматическое удаление созданных топиков и закрытие соединений по завершению теста.

(k *Kafka) WriteMessages(msgs ...*kgo.Record)

Публикует переданные сообщения в соответствующие топики.

(k *Kafka) ReadMessage(topic string, offset int64) kafka.Message

Считывает одно сообщение из указанного топика с заданного смещения.

(k *Kafka) Address() string

Возвращает адрес Kafka-сервера.

(k *Kafka) CreateDefaultTopic(topic string)

Создаёт Kafka-топик с одной партицией и фактором репликации -1.

(k *Kafka) PublisherConfig(topic string) kafkax.PublisherConfig

Возвращает готовую конфигурацию Kafka-публикатора для заданного топика.

(k *Kafka) ConsumerConfig(topic, groupId string) kafkax.ConsumerConfig

Возвращает готовую конфигурацию Kafka-консьюмера для заданного топика и группы.

Usage

Example usage in test
package mypkg_test

import (
	"testing"
	"github.com/segmentio/kafka-go"
	"github.com/txix-open/isp-kit/kafkat"
	"github.com/txix-open/isp-kit/test"
)

func TestKafkaExample(t *testing.T) {
	testCtx := test.New(t)
	kafka := kafkat.NewKafka(testCtx)

	topic := "example-topic"
	kafka.CreateDefaultTopic(topic)

	msg := kafka.Message{Topic: topic, Value: []byte("test-message")}
	kafka.WriteMessages(msg)

	read := kafka.ReadMessage(topic, 0)
	testCtx.Assert().Equal("test-message", string(read.Value))
}

Documentation

Overview

Package kafkat provides test helpers for Kafka operations using the franz-go client. It creates isolated topics for each test and automatically cleans them up after the test completes.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Kafka

type Kafka struct {
	// contains filtered or unexported fields
}

Kafka provides a test helper for Kafka operations. It manages Kafka client connections and automatically cleans up created topics after each test.

func NewKafka

func NewKafka(t *test.Test) *Kafka

NewKafka creates a new Kafka test client. Connection parameters can be overridden using environment variables: KAFKA_ADDRESS, KAFKA_USERNAME, KAFKA_PASSWORD.

func (*Kafka) Address

func (k *Kafka) Address() string

Address returns the Kafka broker address.

func (*Kafka) ConsumerConfig

func (k *Kafka) ConsumerConfig(topic, groupId string) kafkax.ConsumerConfig

ConsumerConfig returns a ConsumerConfig for the specified topic and consumer group, pre-configured with the Kafka connection details.

func (*Kafka) CreateDefaultTopic

func (k *Kafka) CreateDefaultTopic(topic string)

CreateDefaultTopic creates a new topic with a single partition. The topic is automatically deleted when the test completes. Panics if topic creation fails.

func (*Kafka) PublisherConfig

func (k *Kafka) PublisherConfig(topic string) kafkax.PublisherConfig

PublisherConfig returns a PublisherConfig for the specified topic, pre-configured with the Kafka connection details.

func (*Kafka) ReadMessage

func (k *Kafka) ReadMessage(topic string, offset int64) *kgo.Record

ReadMessage retrieves a single message from the specified topic at the given offset. Panics if the message cannot be read.

func (*Kafka) WriteMessages

func (k *Kafka) WriteMessages(msgs ...*kgo.Record)

WriteMessages publishes one or more messages to their respective topics. Panics if any message fails to produce.

Jump to

Keyboard shortcuts

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