Package org.apache.kafka.clients.producer

Class MockProducer<K,V>

java.lang.Object

org.apache.kafka.clients.producer.MockProducer<K,V>

All Implemented Interfaces:

Closeable, AutoCloseable, Producer<K,V>

public class MockProducer<K,V>
extends Object
implements Producer<K,V>

A mock of the producer interface you can use for testing code that uses Kafka.

By default this mock will synchronously complete each send call successfully. However it can be configured to allow the user to control the completion of the call and supply an optional error for the producer to throw.

Field Summary

Fields

Modifier and Type	Field	Description
RuntimeException	abortTransactionException	Exception to throw when abortTransaction() is called
RuntimeException	beginTransactionException	Exception to throw when beginTransaction() is called
RuntimeException	closeException	Exception to throw when close() or close(Duration) is called
RuntimeException	commitTransactionException	Exception to throw when commitTransaction() is called
RuntimeException	flushException	Exception to throw when flush() is called
RuntimeException	initTransactionException	Exception to throw when initTransactions() is called
RuntimeException	partitionsForException	Exception to throw when partitionsFor(String) is called
RuntimeException	sendException	Exception to throw when send(ProducerRecord) or send(ProducerRecord, Callback) is called
RuntimeException	sendOffsetsToTransactionException	Exception to throw when sendOffsetsToTransaction(Map, ConsumerGroupMetadata) is called

Constructor Summary

Constructors

Constructor	Description
MockProducer()	Create a new mock producer with invented metadata.
MockProducer(boolean autoComplete, Partitioner partitioner, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a new mock producer with invented metadata the given autoComplete setting, partitioner and key\value serializers.
MockProducer(Cluster cluster, boolean autoComplete, Partitioner partitioner, Serializer<K> keySerializer, Serializer<V> valueSerializer)	Create a mock producer

Method Summary

Modifier and Type	Method	Description
void	abortTransaction()	See KafkaProducer.abortTransaction()
List<KafkaMetric>	addedMetrics()	Gets the list of metrics that have been registered for subscription.
void	beginTransaction()	See KafkaProducer.beginTransaction()
void	clear()	Clear the stored history of sent records, consumer group offsets
Uuid	clientInstanceId(Duration timeout)	See KafkaProducer.clientInstanceId(Duration)}
void	close()	See KafkaProducer.close()
void	close(Duration timeout)	See KafkaProducer.close(Duration)
boolean	closed()	Checks whether this mock producer has been closed.
long	commitCount()	Gets the total number of transactions committed by this mock producer.
void	commitTransaction()	See KafkaProducer.commitTransaction()
boolean	completeNext()	Complete the earliest uncompleted call successfully.
List<Map<String,Map<TopicPartition,OffsetAndMetadata>>>	consumerGroupOffsetsHistory()	Get the list of committed consumer group offsets since the last call to clear()
void	disableTelemetry()	Disables telemetry for this mock producer for testing purposes.
boolean	errorNext(RuntimeException e)	Complete the earliest uncompleted call with the given error.
void	fenceProducer()	Fences this mock producer, causing it to throw ProducerFencedException on subsequent transactional operations.
void	flush()	See KafkaProducer.flush()
boolean	flushed()	Checks whether all sent records have been completed (no pending completions).
List<ProducerRecord<K,V>>	history()	Get the list of sent records since the last call to clear()
void	initTransactions()	See KafkaProducer.initTransactions()
void	injectTimeoutException(int injectTimeoutExceptionCounter)	Injects timeout exceptions into clientInstanceId(Duration) calls for testing purposes.
Map<MetricName,Metric>	metrics()	See KafkaProducer.metrics()
List<PartitionInfo>	partitionsFor(String topic)	See KafkaProducer.partitionsFor(String)
void	registerMetricForSubscription(KafkaMetric metric)	See KafkaProducer.registerMetricForSubscription(KafkaMetric)
Future<RecordMetadata>	send(ProducerRecord<K,V> record)	Adds the record to the list of sent records.
Future<RecordMetadata>	send(ProducerRecord<K,V> record, Callback callback)	Adds the record to the list of sent records.
void	sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets, ConsumerGroupMetadata groupMetadata)	See KafkaProducer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata)
boolean	sentOffsets()	Checks whether offsets have been sent to the current transaction.
void	setClientInstanceId(Uuid instanceId)	Sets the client instance ID for this mock producer.
void	setMockMetrics(MetricName name, Metric metric)	Set a mock metric for testing purpose
boolean	transactionAborted()	Checks whether the current transaction has been aborted.
boolean	transactionCommitted()	Checks whether the current transaction has been committed.
boolean	transactionInFlight()	Checks whether a transaction is currently in progress.
boolean	transactionInitialized()	Checks whether transactions have been initialized for this mock producer.
Map<String,Map<TopicPartition,OffsetAndMetadata>>	uncommittedOffsets()	Gets the consumer group offsets sent in the current transaction that have not yet been committed.
List<ProducerRecord<K,V>>	uncommittedRecords()	Gets the list of records sent in the current transaction that have not yet been committed.
void	unregisterMetricFromSubscription(KafkaMetric metric)	See KafkaProducer.unregisterMetricFromSubscription(KafkaMetric)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

initTransactionException

public RuntimeException initTransactionException

Exception to throw when initTransactions() is called

beginTransactionException

public RuntimeException beginTransactionException

Exception to throw when beginTransaction() is called

sendOffsetsToTransactionException

public RuntimeException sendOffsetsToTransactionException

Exception to throw when sendOffsetsToTransaction(Map, ConsumerGroupMetadata) is called

commitTransactionException

public RuntimeException commitTransactionException

Exception to throw when commitTransaction() is called

abortTransactionException

public RuntimeException abortTransactionException

Exception to throw when abortTransaction() is called

sendException

public RuntimeException sendException

Exception to throw when send(ProducerRecord) or send(ProducerRecord, Callback) is called

flushException

public RuntimeException flushException

Exception to throw when flush() is called

partitionsForException

public RuntimeException partitionsForException

Exception to throw when partitionsFor(String) is called

closeException

public RuntimeException closeException

Exception to throw when close() or close(Duration) is called

Constructor Details

MockProducer

public MockProducer(Cluster cluster,
 boolean autoComplete,
 Partitioner partitioner,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a mock producer

Parameters:

cluster - The cluster holding metadata for this producer

autoComplete - If true automatically complete all requests successfully and execute the callback. Otherwise the user must call completeNext() or errorNext(RuntimeException) after send() to complete the call and unblock the Future<RecordMetadata> that is returned.

partitioner - The partition strategy

keySerializer - The serializer for key that implements Serializer.

valueSerializer - The serializer for value that implements Serializer.

MockProducer

public MockProducer(boolean autoComplete,
 Partitioner partitioner,
 Serializer<K> keySerializer,
 Serializer<V> valueSerializer)

Create a new mock producer with invented metadata the given autoComplete setting, partitioner and key\value serializers. Equivalent to new MockProducer(Cluster.empty(), autoComplete, partitioner, keySerializer, valueSerializer)

MockProducer

public MockProducer()

Create a new mock producer with invented metadata. Equivalent to new MockProducer(Cluster.empty(), false, null, null, null)

Method Details

initTransactions

public void initTransactions()

Description copied from interface: Producer

See KafkaProducer.initTransactions()

Specified by:

initTransactions in interface Producer<K,V>

beginTransaction

public void beginTransaction()
                      throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.beginTransaction()

Specified by:

beginTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

sendOffsetsToTransaction

public void sendOffsetsToTransaction(Map<TopicPartition,OffsetAndMetadata> offsets,
 ConsumerGroupMetadata groupMetadata)
                              throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.sendOffsetsToTransaction(Map, ConsumerGroupMetadata)

Specified by:

sendOffsetsToTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

commitTransaction

public void commitTransaction()
                       throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.commitTransaction()

Specified by:

commitTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

abortTransaction

public void abortTransaction()
                      throws ProducerFencedException

Description copied from interface: Producer

See KafkaProducer.abortTransaction()

Specified by:

abortTransaction in interface Producer<K,V>

Throws:

ProducerFencedException

send

public Future<RecordMetadata> send(ProducerRecord<K,V> record)

Adds the record to the list of sent records. The RecordMetadata returned will be immediately satisfied.

Specified by:

send in interface Producer<K,V>

See Also:

• history()

send

public Future<RecordMetadata> send(ProducerRecord<K,V> record,
 Callback callback)

Adds the record to the list of sent records.

Specified by:

send in interface Producer<K,V>

See Also:

• history()

flush

public void flush()

Description copied from interface: Producer

See KafkaProducer.flush()

Specified by:

flush in interface Producer<K,V>

partitionsFor

public List<PartitionInfo> partitionsFor(String topic)

Description copied from interface: Producer

See KafkaProducer.partitionsFor(String)

Specified by:

partitionsFor in interface Producer<K,V>

disableTelemetry

public void disableTelemetry()

Disables telemetry for this mock producer for testing purposes.

injectTimeoutException

public void injectTimeoutException(int injectTimeoutExceptionCounter)

Injects timeout exceptions into clientInstanceId(Duration) calls for testing purposes.

Parameters:

injectTimeoutExceptionCounter - Number of times to inject timeout exceptions, or -1 for infinite

setClientInstanceId

public void setClientInstanceId(Uuid instanceId)

Sets the client instance ID for this mock producer.

Parameters:

instanceId - The client instance ID to set

clientInstanceId

public Uuid clientInstanceId(Duration timeout)

Description copied from interface: Producer

See KafkaProducer.clientInstanceId(Duration)}

Specified by:

clientInstanceId in interface Producer<K,V>

metrics

public Map<MetricName,Metric> metrics()

Description copied from interface: Producer

See KafkaProducer.metrics()

Specified by:

metrics in interface Producer<K,V>

setMockMetrics

public void setMockMetrics(MetricName name,
 Metric metric)

Set a mock metric for testing purpose

close

public void close()

Description copied from interface: Producer

See KafkaProducer.close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Producer<K,V>

close

public void close(Duration timeout)

Description copied from interface: Producer

See KafkaProducer.close(Duration)

Specified by:

close in interface Producer<K,V>

closed

public boolean closed()

Checks whether this mock producer has been closed.

Returns:

true if the producer has been closed, false otherwise

fenceProducer

public void fenceProducer()

Fences this mock producer, causing it to throw ProducerFencedException on subsequent transactional operations.

transactionInitialized

public boolean transactionInitialized()

Checks whether transactions have been initialized for this mock producer.

Returns:

true if transactions have been initialized, false otherwise

transactionInFlight

public boolean transactionInFlight()

Checks whether a transaction is currently in progress.

Returns:

true if a transaction is in progress, false otherwise

transactionCommitted

public boolean transactionCommitted()

Checks whether the current transaction has been committed.

Returns:

true if the transaction was committed, false otherwise

transactionAborted

public boolean transactionAborted()

Checks whether the current transaction has been aborted.

Returns:

true if the transaction was aborted, false otherwise

flushed

public boolean flushed()

Checks whether all sent records have been completed (no pending completions).

Returns:

true if there are no pending completions, false otherwise

sentOffsets

public boolean sentOffsets()

Checks whether offsets have been sent to the current transaction.

Returns:

true if offsets were sent in the current transaction, false otherwise

commitCount

public long commitCount()

Gets the total number of transactions committed by this mock producer.

Returns:

The commit count

history

public List<ProducerRecord<K,V>> history()

Get the list of sent records since the last call to clear()

uncommittedRecords

public List<ProducerRecord<K,V>> uncommittedRecords()

Gets the list of records sent in the current transaction that have not yet been committed.

Returns:

A list of uncommitted producer records

consumerGroupOffsetsHistory

public List<Map<String,Map<TopicPartition,OffsetAndMetadata>>> consumerGroupOffsetsHistory()

Get the list of committed consumer group offsets since the last call to clear()

uncommittedOffsets

public Map<String,Map<TopicPartition,OffsetAndMetadata>> uncommittedOffsets()

Gets the consumer group offsets sent in the current transaction that have not yet been committed.

Returns:

A map of consumer group IDs to their uncommitted offsets

clear

public void clear()

Clear the stored history of sent records, consumer group offsets

completeNext

public boolean completeNext()

Complete the earliest uncompleted call successfully.

Returns:

true if there was an uncompleted call to complete

errorNext

public boolean errorNext(RuntimeException e)

Complete the earliest uncompleted call with the given error.

Returns:

true if there was an uncompleted call to complete

addedMetrics

public List<KafkaMetric> addedMetrics()

Gets the list of metrics that have been registered for subscription.

Returns:

An unmodifiable list of added metrics

registerMetricForSubscription

public void registerMetricForSubscription(KafkaMetric metric)

Description copied from interface: Producer

See KafkaProducer.registerMetricForSubscription(KafkaMetric)

Specified by:

registerMetricForSubscription in interface Producer<K,V>

unregisterMetricFromSubscription

public void unregisterMetricFromSubscription(KafkaMetric metric)

Description copied from interface: Producer

See KafkaProducer.unregisterMetricFromSubscription(KafkaMetric)

Specified by:

unregisterMetricFromSubscription in interface Producer<K,V>