Interface IKafkaTestingHelper

Namespace

Silverback.Testing

Assembly

Silverback.Integration.Kafka.Testing.dll

Exposes some helper methods and shortcuts to simplify testing.

public interface IKafkaTestingHelper : ITestingHelper

Inherited Members

ITestingHelper.GetConsumer(string)

ITestingHelper.GetConsumerForEndpoint(string)

ITestingHelper.GetProducerForEndpoint(string)

ITestingHelper.WaitUntilConnectedAsync(TimeSpan?)

ITestingHelper.WaitUntilConnectedAsync(bool, TimeSpan?)

ITestingHelper.WaitUntilConnectedAsync(CancellationToken)

ITestingHelper.WaitUntilConnectedAsync(bool, CancellationToken)

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(TimeSpan?, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, TimeSpan?)

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, TimeSpan?, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(CancellationToken, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, CancellationToken, params string[])

ITestingHelper.WaitUntilOutboxIsEmptyAsync(TimeSpan?)

ITestingHelper.WaitUntilOutboxIsEmptyAsync(CancellationToken)

ITestingHelper.IsOutboxEmptyAsync()

ITestingHelper.Spy

Properties

ConsumerGroups

Gets a collection of IMockedConsumerGroup representing all known consumer groups.

IReadOnlyCollection<IMockedConsumerGroup> ConsumerGroups { get; }

Property Value

IReadOnlyCollection<IMockedConsumerGroup>

The collection of IMockedConsumerGroup.

Methods

GetConsumerGroup(string)

Returns the IMockedConsumerGroup representing the consumer group with the specified id.

IMockedConsumerGroup GetConsumerGroup(string groupId)

Parameters

groupId string

The consumer group id.

Returns

IMockedConsumerGroup

The IMockedConsumerGroup.

Remarks

This method works with the mocked Kafka broker only. See UseMockedKafka(SilverbackBuilder, Action<IMockedKafkaOptionsBuilder>?) or AddMockedKafka(BrokerOptionsBuilder, Action<IMockedKafkaOptionsBuilder>?).

GetConsumerGroup(string, string)

Returns the IMockedConsumerGroup representing the consumer group with the specified id.

IMockedConsumerGroup GetConsumerGroup(string groupId, string bootstrapServers)

Parameters

groupId string

The consumer group id.

bootstrapServers string

The bootstrap servers string used to identify the target broker.

Returns

IMockedConsumerGroup

The IMockedConsumerGroup.

Remarks

This method works with the mocked Kafka broker only. See UseMockedKafka(SilverbackBuilder, Action<IMockedKafkaOptionsBuilder>?) or AddMockedKafka(BrokerOptionsBuilder, Action<IMockedKafkaOptionsBuilder>?).

GetProducer(Action<KafkaProducerConfigurationBuilder>)

Gets a new producer with the specified configuration.

IProducer GetProducer(Action<KafkaProducerConfigurationBuilder> configurationBuilderAction)

Parameters

configurationBuilderAction Action<KafkaProducerConfigurationBuilder>

An Action<T> that takes the KafkaProducerConfigurationBuilder and configures it.

Returns

IProducer

The IProducer.

GetTopic(string, string?)

Returns the IInMemoryTopic with the specified name.

IInMemoryTopic GetTopic(string name, string? bootstrapServers = null)

Parameters

name string

The name of the topic.

bootstrapServers string

The bootstrap servers string used to identify the target broker. This must be specified when testing with multiple brokers.

Returns

IInMemoryTopic

The IInMemoryTopic.

Remarks

This method works with the mocked Kafka broker only. See UseMockedKafka(SilverbackBuilder, Action<IMockedKafkaOptionsBuilder>?) or AddMockedKafka(BrokerOptionsBuilder, Action<IMockedKafkaOptionsBuilder>?).