org.apache.flink.statefun.e2e.common.kafka

Class KafkaIOVerifier<PK,PV,CK,CV>

java.lang.Object

org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier<PK,PV,CK,CV>

Type Parameters:

PK - key type of input records written to Kafka

PV - value type of input records written to Kafka

CK - key type of output records read from Kafka

CV - value type of output records read from Kafka

public final class KafkaIOVerifier<PK,PV,CK,CV>
extends java.lang.Object

A utility to make test assertions by means of writing inputs to Kafka, and then matching on outputs read from Kafka.

Example usage:

 KafkaProducer<String, Integer> producer = ...
 KafkaConsumer<String, Boolean> consumer = ...

 KafkaIOVerifier<String, Integer, String, Boolean> verifier =
     new KafkaIOVerifier(producer, consumer);

 assertThat(
     verifier.sending(
         new ProducerRecord<>("topic", "key-1", 1991),
         new ProducerRecord<>("topic", "key-2", 1108)
     ), verifier.resultsInOrder(
         true, false, true, true
     )
 );
 

Constructor Summary

Constructors

Constructor and Description
KafkaIOVerifier(org.apache.kafka.clients.producer.Producer<PK,PV> producer, org.apache.kafka.clients.consumer.Consumer<CK,CV> consumer) Creates a verifier.

Method Summary

Modifier and Type	Method and Description
org.hamcrest.Matcher<org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV>>	resultsInAnyOrder(org.hamcrest.Matcher<CV>... expectedResults) Matcher for verifying the outputs, happening in any order, as a result of calling sending(ProducerRecord[]).
org.hamcrest.Matcher<org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV>>	resultsInOrder(org.hamcrest.Matcher<CV>... expectedResults) Matcher for verifying the outputs as a result of calling sending(ProducerRecord[]).
org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV>	sending(org.apache.kafka.clients.producer.ProducerRecord<PK,PV>... assertionInputs) Writes to Kafka multiple assertion input producer records, in the given order.

Methods inherited from class java.lang.Object

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

Constructor Detail

KafkaIOVerifier

public KafkaIOVerifier(org.apache.kafka.clients.producer.Producer<PK,PV> producer,
                       org.apache.kafka.clients.consumer.Consumer<CK,CV> consumer)

Creates a verifier.

Parameters:

producer - producer to use to write input records to Kafka.

consumer - consumer to use for reading output records from Kafka.

Method Detail

sending

@SafeVarargs
public final org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV> sending(org.apache.kafka.clients.producer.ProducerRecord<PK,PV>... assertionInputs)

Writes to Kafka multiple assertion input producer records, in the given order.

The results of calling this method should be asserted using resultsInOrder(Matcher[]). In the background, the provided Kafka consumer will be used to continuously poll output records. For each assertion input provided via this method, you must consequently use resultsInOrder(Matcher[]) to complete the assertion, which then stops the consumer from polling Kafka.

Parameters:

assertionInputs - assertion input producer records to send to Kafka.

Returns:

resulting outputs consumed from Kafka that can be asserted using resultsInOrder(Matcher[]).

resultsInOrder

@SafeVarargs
public final org.hamcrest.Matcher<org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV>> resultsInOrder(org.hamcrest.Matcher<CV>... expectedResults)

Matcher for verifying the outputs as a result of calling sending(ProducerRecord[]).

Parameters:

expectedResults - matchers for the expected results.

Returns:

a matcher for verifying the output of calling sending(ProducerRecord[]).

resultsInAnyOrder

@SafeVarargs
public final org.hamcrest.Matcher<org.apache.flink.statefun.e2e.common.kafka.KafkaIOVerifier.OutputsHandoff<CV>> resultsInAnyOrder(org.hamcrest.Matcher<CV>... expectedResults)

Matcher for verifying the outputs, happening in any order, as a result of calling sending(ProducerRecord[]).

Parameters:

expectedResults - matchers for the expected results.

Returns:

a matcher for verifying the output of calling sending(ProducerRecord[]).