Interface IKafkaTestingHelper

Exposes some helper methods and shortcuts to simplify testing.

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

Namespace: Silverback.Testing

Assembly: Silverback.Integration.Kafka.Testing.dll

Syntax

public interface IKafkaTestingHelper : ITestingHelper

Properties

ConsumerGroups

Gets a collection of IMockedConsumerGroup representing all known consumer groups.

Declaration

IReadOnlyCollection<IMockedConsumerGroup> ConsumerGroups { get; }

Property Value

Type	Description
IReadOnlyCollection<IMockedConsumerGroup>	The collection of IMockedConsumerGroup.

Methods

GetConsumerGroup(string)

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

Declaration

IMockedConsumerGroup GetConsumerGroup(string groupId)

Parameters

Type	Name	Description
string	groupId	The consumer group id.

Returns

Type	Description
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.

Declaration

IMockedConsumerGroup GetConsumerGroup(string groupId, string bootstrapServers)

Parameters

Type	Name	Description
string	groupId	The consumer group id.
string	bootstrapServers	The bootstrap servers string used to identify the target broker.

Returns

Type	Description
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.

Declaration

IProducer GetProducer(Action<KafkaProducerConfigurationBuilder> configurationBuilderAction)

Parameters

Type	Name	Description
Action<KafkaProducerConfigurationBuilder>	configurationBuilderAction	An Action<T> that takes the KafkaProducerConfigurationBuilder and configures it.

Returns

Type	Description
IProducer	The IProducer.

GetTopic(string, string?)

Returns the IInMemoryTopic with the specified name.

Declaration

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

Parameters

Type	Name	Description
string	name	The name of the topic.
string	bootstrapServers	The bootstrap servers string used to identify the target broker. This must be specified when testing with multiple brokers.

Returns

Type	Description
IInMemoryTopic	The IInMemoryTopic.

Remarks

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