Skip to content

Add getEndOffsets() to KafkaTestUtils #1666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 4, 2021
Merged

Add getEndOffsets() to KafkaTestUtils #1666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f41338
Add getEndOffsets() to KafkaTestUtils
garyrussell Jan 4, 2021
4b297a6
Docs and minor polishing.
garyrussell Jan 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions spring-kafka-test/src/main/java/org/springframework/kafka/test/utils/KafkaTestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
Expand All @@ -36,6 +38,7 @@
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.consumer.OffsetAndMetadata;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.common.PartitionInfo;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.serialization.IntegerDeserializer;
import org.apache.kafka.common.serialization.IntegerSerializer;
Expand Down Expand Up @@ -239,6 +242,39 @@ public static OffsetAndMetadata getCurrentOffset(String brokerAddresses, String
}
}

/**
* Return the end offsets of the requested topic/partitions
* @param <K> the key type.
* @param <V> the value type.
* @param consumer the consumer.
* @param topic the topic.
* @param partitions the partitions, or null for all partitions.
* @return the map of end offsets.
* @since 2.6.5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need to add a @see for JavaDocs of that consumer.endOffsets() because that is exactly an info we get back.

* @see Consumer#endOffsets(Collection, Duration)
*/
public static Map<TopicPartition, Long> getEndOffsets(Consumer<?, ?> consumer, String topic,
Integer... partitions) {

Collection<TopicPartition> tps;
if (partitions == null || partitions.length == 0) {
Map<String, List<PartitionInfo>> parts = consumer.listTopics(Duration.ofSeconds(10));
tps = parts.entrySet()
.stream()
.filter(entry -> entry.getKey().equals(topic))
.flatMap(entry -> entry.getValue().stream())
.map(pi -> new TopicPartition(topic, pi.partition()))
.collect(Collectors.toList());
}
else {
Assert.noNullElements(partitions, "'partitions' cannot have null elements");
tps = Arrays.stream(partitions)
.map(part -> new TopicPartition(topic, part))
.collect(Collectors.toList());
}
return consumer.endOffsets(tps, Duration.ofSeconds(10));
}

/**
* Poll the consumer for records.
* @param consumer the consumer.
Expand Down
15 changes: 12 additions & 3 deletions ...ng-kafka-test/src/test/java/org/springframework/kafka/test/utils/KafkaTestUtilsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.TopicPartition;
import org.junit.jupiter.api.Test;

import org.springframework.kafka.test.EmbeddedKafkaBroker;
Expand All @@ -44,22 +45,26 @@ public class KafkaTestUtilsTests {
void testGetSingleWithMoreThatOneTopic(EmbeddedKafkaBroker broker) {
Map<String, Object> producerProps = KafkaTestUtils.producerProps(broker);
KafkaProducer<Integer, String> producer = new KafkaProducer<>(producerProps);
producer.send(new ProducerRecord<>("singleTopic1", 1, "foo"));
producer.send(new ProducerRecord<>("singleTopic2", 1, "foo"));
producer.send(new ProducerRecord<>("singleTopic1", 0, 1, "foo"));
producer.send(new ProducerRecord<>("singleTopic2", 0, 1, "foo"));
producer.close();
Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("ktuTests1", "false", broker);
KafkaConsumer<Integer, String> consumer = new KafkaConsumer<>(consumerProps);
broker.consumeFromAllEmbeddedTopics(consumer);
KafkaTestUtils.getSingleRecord(consumer, "singleTopic1");
KafkaTestUtils.getSingleRecord(consumer, "singleTopic2");
Map<TopicPartition, Long> endOffsets = KafkaTestUtils.getEndOffsets(consumer, "singleTopic1");
assertThat(endOffsets).hasSize(2);
assertThat(endOffsets.get(new TopicPartition("singleTopic1", 0))).isEqualTo(1L);
assertThat(endOffsets.get(new TopicPartition("singleTopic1", 1))).isEqualTo(0L);
consumer.close();
}

@Test
void testGetSingleWithMoreThatOneTopicRecordNotThereYet(EmbeddedKafkaBroker broker) {
Map<String, Object> producerProps = KafkaTestUtils.producerProps(broker);
KafkaProducer<Integer, String> producer = new KafkaProducer<>(producerProps);
producer.send(new ProducerRecord<>("singleTopic4", 1, "foo"));
producer.send(new ProducerRecord<>("singleTopic4", 0, 1, "foo"));
Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("ktuTests2", "false", broker);
KafkaConsumer<Integer, String> consumer = new KafkaConsumer<>(consumerProps);
broker.consumeFromEmbeddedTopics(consumer, "singleTopic4", "singleTopic5");
Expand All @@ -71,6 +76,10 @@ void testGetSingleWithMoreThatOneTopicRecordNotThereYet(EmbeddedKafkaBroker brok
producer.close();
KafkaTestUtils.getSingleRecord(consumer, "singleTopic4");
KafkaTestUtils.getSingleRecord(consumer, "singleTopic5");
Map<TopicPartition, Long> endOffsets = KafkaTestUtils.getEndOffsets(consumer, "singleTopic4", 0, 1);
assertThat(endOffsets).hasSize(2);
assertThat(endOffsets.get(new TopicPartition("singleTopic4", 0))).isEqualTo(1L);
assertThat(endOffsets.get(new TopicPartition("singleTopic4", 1))).isEqualTo(0L);
consumer.close();
}

Expand Down
8 changes: 7 additions & 1 deletion src/reference/asciidoc/testing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@

The `spring-kafka-test` jar contains some useful utilities to assist with testing your applications.

[[ktu]]
==== KafkaTestUtils

`o.s.kafka.test.utils.KafkaTestUtils` provides a number of static helper methods to consume records, retrieve various record offsets, and others.
Refer to its https://docs.spring.io/spring-kafka/docs/current/api/org/springframework/kafka/test/utils/KafkaTestUtils.html[Javadocs] for complete details.

[[junit]]
==== JUnit

`o.s.kafka.test.utils.KafkaTestUtils` provides some static methods to set up producer and consumer properties.
`o.s.kafka.test.utils.KafkaTestUtils` also provides some static methods to set up producer and consumer properties.
The following listing shows those method signatures:

====
Expand Down