README
¶
sarama/mocks
The mocks subpackage includes mock implementations that implement the interfaces of the major sarama types.
You can use them to test your sarama applications using dependency injection.
The following mock objects are available:
- Consumer, which will create PartitionConsumer mocks.
- AsyncProducer
- SyncProducer
The mocks allow you to set expectations on them. When you close the mocks, the expectations will be verified,
and the results will be reported to the *testing.T object you provided when creating the mock.
Documentation
¶
Overview ¶
Package mocks provides mocks that can be used for testing applications that use Sarama. The mock types provided by this package implement the interfaces Sarama exports, so you can use them for dependency injection in your tests.
All mock instances require you to set expectations on them before you can use them. It will determine how the mock will behave. If an expectation is not met, it will make your test fail.
NOTE: this package currently does not fall under the API stability guarantee of Sarama as it is still considered experimental.
Index ¶
- Constants
- type AsyncProducer
- func (mp *AsyncProducer) AsyncClose()
- func (mp *AsyncProducer) Close() error
- func (mp *AsyncProducer) Errors() <-chan *sarama.ProducerError
- func (mp *AsyncProducer) ExpectInputAndFail(err error)
- func (mp *AsyncProducer) ExpectInputAndSucceed()
- func (mp *AsyncProducer) Input() chan<- *sarama.ProducerMessage
- func (mp *AsyncProducer) Successes() <-chan *sarama.ProducerMessage
- type Consumer
- func (c *Consumer) Close() error
- func (c *Consumer) ConsumePartition(topic string, partition int32, offset int64) (sarama.PartitionConsumer, error)
- func (c *Consumer) ExpectConsumePartition(topic string, partition int32, offset int64) *PartitionConsumer
- func (c *Consumer) Partitions(topic string) ([]int32, error)
- func (c *Consumer) SetTopicMetadata(metadata map[string][]int32)
- func (c *Consumer) Topics() ([]string, error)
- type ErrorReporter
- type PartitionConsumer
- func (pc *PartitionConsumer) AsyncClose()
- func (pc *PartitionConsumer) Close() error
- func (pc *PartitionConsumer) Errors() <-chan *sarama.ConsumerError
- func (pc *PartitionConsumer) ExpectErrorsDrainedOnClose()
- func (pc *PartitionConsumer) ExpectMessagesDrainedOnClose()
- func (pc *PartitionConsumer) HighWaterMarkOffset() int64
- func (pc *PartitionConsumer) Messages() <-chan *sarama.ConsumerMessage
- func (pc *PartitionConsumer) YieldError(err error)
- func (pc *PartitionConsumer) YieldMessage(msg *sarama.ConsumerMessage)
- type SyncProducer
Constants ¶
const AnyOffset int64 = -1000
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AsyncProducer ¶
type AsyncProducer struct {
// contains filtered or unexported fields
}
AsyncProducer implements sarama's Producer interface for testing purposes. Before you can send messages to it's Input channel, you have to set expectations so it knows how to handle the input. This way you can easily test success and failure scenarios.
func NewAsyncProducer ¶
func NewAsyncProducer(t ErrorReporter, config *sarama.Config) *AsyncProducer
NewAsyncProducer instantiates a new Producer mock. The t argument should be the *testing.T instance of your test method. An error will be written to it if an expectation is violated. The config argument is used to determine whether it should ack successes on the Successes channel.
func (*AsyncProducer) AsyncClose ¶
func (mp *AsyncProducer) AsyncClose()
AsyncClose corresponds with the AsyncClose method of sarama's Producer implementation. By closing a mock producer, you also tell it that no more input will be provided, so it will write an error to the test state if there's any remaining expectations.
func (*AsyncProducer) Close ¶
func (mp *AsyncProducer) Close() error
Close corresponds with the Close method of sarama's Producer implementation. By closing a mock producer, you also tell it that no more input will be provided, so it will write an error to the test state if there's any remaining expectations.
func (*AsyncProducer) Errors ¶
func (mp *AsyncProducer) Errors() <-chan *sarama.ProducerError
Errors corresponds with the Errors method of sarama's Producer implementation.
func (*AsyncProducer) ExpectInputAndFail ¶
func (mp *AsyncProducer) ExpectInputAndFail(err error)
ExpectInputAndFail sets an expectation on the mock producer that a message will be provided on the input channel. The mock producer will handle the message as if it failed to produce successfully. This means it will make a ProducerError available on the Errors channel.
func (*AsyncProducer) ExpectInputAndSucceed ¶
func (mp *AsyncProducer) ExpectInputAndSucceed()
ExpectInputAndSucceed sets an expectation on the mock producer that a message will be provided on the input channel. The mock producer will handle the message as if it is produced successfully, i.e. it will make it available on the Successes channel if the Producer.Return.Successes setting is set to true.
func (*AsyncProducer) Input ¶
func (mp *AsyncProducer) Input() chan<- *sarama.ProducerMessage
Input corresponds with the Input method of sarama's Producer implementation. You have to set expectations on the mock producer before writing messages to the Input channel, so it knows how to handle them. If there is no more remaining expectations and a messages is written to the Input channel, the mock producer will write an error to the test state object.
func (*AsyncProducer) Successes ¶
func (mp *AsyncProducer) Successes() <-chan *sarama.ProducerMessage
Successes corresponds with the Successes method of sarama's Producer implementation.
type Consumer ¶
type Consumer struct {
// contains filtered or unexported fields
}
Consumer implements sarama's Consumer interface for testing purposes. Before you can start consuming from this consumer, you have to register topic/partitions using ExpectConsumePartition, and set expectations on them.
func NewConsumer ¶
func NewConsumer(t ErrorReporter, config *sarama.Config) *Consumer
NewConsumer returns a new mock Consumer instance. The t argument should be the *testing.T instance of your test method. An error will be written to it if an expectation is violated. The config argument is currently unused and can be set to nil.
func (*Consumer) Close ¶
Close implements the Close method from the sarama.Consumer interface. It will close all registered PartitionConsumer instances.
func (*Consumer) ConsumePartition ¶
func (c *Consumer) ConsumePartition(topic string, partition int32, offset int64) (sarama.PartitionConsumer, error)
ConsumePartition implements the ConsumePartition method from the sarama.Consumer interface. Before you can start consuming a partition, you have to set expectations on it using ExpectConsumePartition. You can only consume a partition once per consumer.
func (*Consumer) ExpectConsumePartition ¶
func (c *Consumer) ExpectConsumePartition(topic string, partition int32, offset int64) *PartitionConsumer
ExpectConsumePartition will register a topic/partition, so you can set expectations on it. The registered PartitionConsumer will be returned, so you can set expectations on it using method chanining. Once a topic/partition is registered, you are expected to start consuming it using ConsumePartition. If that doesn't happen, an error will be written to the error reporter once the mock consumer is closed. It will also expect that the
func (*Consumer) Partitions ¶ added in v1.4.0
Partitions returns the list of parititons for the given topic, as registered with SetMetadata
func (*Consumer) SetTopicMetadata ¶ added in v1.4.0
SetMetadata sets the clusters topic/partition metadata, which will be returned by Topics() and Partitions().
type ErrorReporter ¶
type ErrorReporter interface {
Errorf(string, ...interface{})
}
A simple interface that includes the testing.T methods we use to report expectation violations when using the mock objects.
type PartitionConsumer ¶
type PartitionConsumer struct {
// contains filtered or unexported fields
}
PartitionConsumer implements sarama's PartitionConsumer interface for testing purposes. It is returned by the mock Consumers ConsumePartitionMethod, but only if it is registered first using the Consumer's ExpectConsumePartition method. Before consuming the Errors and Messages channel, you should specify what values will be provided on these channels using YieldMessage and YieldError.
func (*PartitionConsumer) AsyncClose ¶
func (pc *PartitionConsumer) AsyncClose()
AsyncClose implements the AsyncClose method from the sarama.PartitionConsumer interface.
func (*PartitionConsumer) Close ¶
func (pc *PartitionConsumer) Close() error
Close implements the Close method from the sarama.PartitionConsumer interface. It will verify whether the partition consumer was actually started.
func (*PartitionConsumer) Errors ¶
func (pc *PartitionConsumer) Errors() <-chan *sarama.ConsumerError
Errors implements the Errors method from the sarama.PartitionConsumer interface.
func (*PartitionConsumer) ExpectErrorsDrainedOnClose ¶
func (pc *PartitionConsumer) ExpectErrorsDrainedOnClose()
ExpectErrorsDrainedOnClose sets an expectation on the partition consumer that the errors channel will be fully drained when Close is called. If this expectation is not met, an error is reported to the error reporter.
func (*PartitionConsumer) ExpectMessagesDrainedOnClose ¶
func (pc *PartitionConsumer) ExpectMessagesDrainedOnClose()
ExpectMessagesDrainedOnClose sets an expectation on the partition consumer that the messages channel will be fully drained when Close is called. If this expectation is not met, an error is reported to the error reporter.
func (*PartitionConsumer) HighWaterMarkOffset ¶ added in v1.4.0
func (pc *PartitionConsumer) HighWaterMarkOffset() int64
func (*PartitionConsumer) Messages ¶
func (pc *PartitionConsumer) Messages() <-chan *sarama.ConsumerMessage
Messages implements the Messages method from the sarama.PartitionConsumer interface.
func (*PartitionConsumer) YieldError ¶
func (pc *PartitionConsumer) YieldError(err error)
YieldError will yield an error on the Errors channel of this partition consumer when it is consumed. By default, the mock consumer will not verify whether this error was consumed from the Errors channel, because there are legitimate reasons for this not to happen. You can call ExpectErrorsDrainedOnClose so it will verify that the channel is empty on close.
func (*PartitionConsumer) YieldMessage ¶
func (pc *PartitionConsumer) YieldMessage(msg *sarama.ConsumerMessage)
YieldMessage will yield a messages Messages channel of this partition consumer when it is consumed. By default, the mock consumer will not verify whether this message was consumed from the Messages channel, because there are legitimate reasons forthis not to happen. ou can call ExpectMessagesDrainedOnClose so it will verify that the channel is empty on close.
type SyncProducer ¶
type SyncProducer struct {
// contains filtered or unexported fields
}
SyncProducer implements sarama's SyncProducer interface for testing purposes. Before you can use it, you have to set expectations on the mock SyncProducer to tell it how to handle calls to SendMessage, so you can easily test success and failure scenarios.
func NewSyncProducer ¶
func NewSyncProducer(t ErrorReporter, config *sarama.Config) *SyncProducer
NewSyncProducer instantiates a new SyncProducer mock. The t argument should be the *testing.T instance of your test method. An error will be written to it if an expectation is violated. The config argument is currently unused, but is maintained to be compatible with the async Producer.
func (*SyncProducer) Close ¶
func (sp *SyncProducer) Close() error
Close corresponds with the Close method of sarama's SyncProducer implementation. By closing a mock syncproducer, you also tell it that no more SendMessage calls will follow, so it will write an error to the test state if there's any remaining expectations.
func (*SyncProducer) ExpectSendMessageAndFail ¶
func (sp *SyncProducer) ExpectSendMessageAndFail(err error)
ExpectSendMessageAndFail sets an expectation on the mock producer that SendMessage will be called. The mock producer will handle the message as if it failed to produce successfully, i.e. by returning the provided error.
func (*SyncProducer) ExpectSendMessageAndSucceed ¶
func (sp *SyncProducer) ExpectSendMessageAndSucceed()
ExpectSendMessageAndSucceed sets an expectation on the mock producer that SendMessage will be called. The mock producer will handle the message as if it produced successfully, i.e. by returning a valid partition, and offset, and a nil error.
func (*SyncProducer) SendMessage ¶
func (sp *SyncProducer) SendMessage(msg *sarama.ProducerMessage) (partition int32, offset int64, err error)
SendMessage corresponds with the SendMessage method of sarama's SyncProducer implementation. You have to set expectations on the mock producer before calling SendMessage, so it knows how to handle them. If there is no more remaining expectations when SendMessage is called, the mock producer will write an error to the test state object.
Source Files