Skip to content

MINOR: Migrate verificationAllTransactionComplete from EOS system test to smoke test #20718

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
mjsax merged 7 commits into from
Nov 24, 2025
Merged

MINOR: Migrate verificationAllTransactionComplete from EOS system test to smoke test #20718

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cce7e1f
add verifyAllTransactionFinished for smoke test driver
RaidenE1 Oct 16, 2025
b90e340
migrate verificationresult to smoke test utils
RaidenE1 Oct 16, 2025
a03c2d0
use try-with
RaidenE1 Oct 16, 2025
3db1e67
fix
RaidenE1 Oct 16, 2025
3086d33
refactor to reuse the props
RaidenE1 Nov 7, 2025
7709f35
refactor to lower complexity
RaidenE1 Nov 21, 2025
f1126ef
update result checking logic
RaidenE1 Nov 21, 2025
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
185 changes: 142 additions & 43 deletions streams/src/test/java/org/apache/kafka/streams/tests/SmokeTestDriver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;
import org.apache.kafka.common.IsolationLevel;
import org.apache.kafka.common.PartitionInfo;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.errors.TimeoutException;
import org.apache.kafka.common.serialization.ByteArrayDeserializer;
import org.apache.kafka.common.serialization.ByteArraySerializer;
import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.Serde;
Expand Down Expand Up @@ -92,6 +94,7 @@ public class SmokeTestDriver extends SmokeTestUtil {
}

private static final int MAX_RECORD_EMPTY_RETRIES = 30;
private static final long MAX_IDLE_TIME_MS = 600000L;

private static class ValueList {
public final String key;
Expand Down Expand Up @@ -372,33 +375,53 @@ public Number deserialize(final String topic, final byte[] data) {
}
}

public static VerificationResult verify(final String kafka,
final Map<String, Set<Integer>> inputs,
final int maxRecordsPerKey,
final boolean eosEnabled) {
final Properties props = new Properties();
props.put(ConsumerConfig.CLIENT_ID_CONFIG, "verifier");
props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, kafka);
props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, NumberDeserializer.class);
props.put(ConsumerConfig.ISOLATION_LEVEL_CONFIG, "read_committed");
private static class PollResult {
final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events;
final int recordsProcessed;
final VerificationResult verificationResult;

PollResult(final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events,
final int recordsProcessed,
final VerificationResult verificationResult) {
this.events = events;
this.recordsProcessed = recordsProcessed;
this.verificationResult = verificationResult;
}
}

final KafkaConsumer<String, Number> consumer = new KafkaConsumer<>(props);
final List<TopicPartition> partitions = getAllPartitions(consumer, NUMERIC_VALUE_TOPICS);
consumer.assign(partitions);
consumer.seekToBeginning(partitions);
private static VerificationResult preVerifyTransactions(final String kafka, final boolean eosEnabled) {
if (!eosEnabled) {
return null;

@mjsax mjsax Nov 21, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why do we return null? Might be easier to return a VerificationResult with passed == true?

}

final VerificationResult txnResult = verifyAllTransactionFinished(kafka);
if (!txnResult.passed()) {
System.err.println("Transaction verification failed: " + txnResult.result());
System.out.println("FAILED");
return txnResult;
}
return null;

@mjsax mjsax Nov 21, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As above -- why do we convert a "passed" into null ? Kinda confusing.

}

private static PollResult pollAndCollect(
final KafkaConsumer<String, Number> consumer,
final Map<String, Set<Integer>> inputs,
final int maxRecordsPerKey,
final boolean eosEnabled) {
final int recordsGenerated = inputs.size() * maxRecordsPerKey;
final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events = new HashMap<>();
VerificationResult verificationResult = new VerificationResult(false, "no results yet");
final long start = System.currentTimeMillis();
int recordsProcessed = 0;

final List<TopicPartition> partitions = getAllPartitions(consumer, NUMERIC_VALUE_TOPICS);
consumer.assign(partitions);
consumer.seekToBeginning(partitions);
final Map<String, AtomicInteger> processed =
Stream.of(NUMERIC_VALUE_TOPICS)
.collect(Collectors.toMap(t -> t, t -> new AtomicInteger(0)));

final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events = new HashMap<>();

VerificationResult verificationResult = new VerificationResult(false, "no results yet");
int retry = 0;
final long start = System.currentTimeMillis();
while (System.currentTimeMillis() - start < TimeUnit.MINUTES.toMillis(6)) {
final ConsumerRecords<String, Number> records = consumer.poll(Duration.ofSeconds(5));
if (records.isEmpty() && recordsProcessed >= recordsGenerated) {
Expand Down Expand Up @@ -436,23 +459,32 @@ public static VerificationResult verify(final String kafka,
System.out.println(processed);
}
}
consumer.close();

final long finished = System.currentTimeMillis() - start;
return new PollResult(events, recordsProcessed, verificationResult);
}

private static VerificationResult reportAndFinalize(
final Map<String, Set<Integer>> inputs,
final int maxRecordsPerKey,
final long startTime,
final boolean eosEnabled,
final PollResult pollResult) {
final int recordsGenerated = inputs.size() * maxRecordsPerKey;
final long finished = System.currentTimeMillis() - startTime;
System.out.println("Verification time=" + finished);
System.out.println("-------------------");
System.out.println("Result Verification");
System.out.println("-------------------");
System.out.println("recordGenerated=" + recordsGenerated);
System.out.println("recordProcessed=" + recordsProcessed);
System.out.println("recordProcessed=" + pollResult.recordsProcessed);

if (recordsProcessed > recordsGenerated) {
if (pollResult.recordsProcessed > recordsGenerated) {
System.out.println("PROCESSED-MORE-THAN-GENERATED");
} else if (recordsProcessed < recordsGenerated) {
} else if (pollResult.recordsProcessed < recordsGenerated) {
System.out.println("PROCESSED-LESS-THAN-GENERATED");
}

final Map<String, Set<Number>> received = parseRecordsForEchoTopic(events);
final Map<String, Set<Number>> received = parseRecordsForEchoTopic(pollResult.events);

boolean success = inputs.equals(received);

Expand All @@ -466,9 +498,10 @@ public static VerificationResult verify(final String kafka,
System.out.println("missedRecords=" + missedCount);
}

VerificationResult verificationResult = pollResult.verificationResult;
// give it one more try if it's not already passing.
if (!verificationResult.passed()) {
verificationResult = verifyAll(inputs, events, true, eosEnabled);
verificationResult = verifyAll(inputs, pollResult.events, true, eosEnabled);
}
success &= verificationResult.passed();

Expand All @@ -478,6 +511,29 @@ public static VerificationResult verify(final String kafka,
return verificationResult;
}

public static VerificationResult verify(final String kafka,
final Map<String, Set<Integer>> inputs,
final int maxRecordsPerKey,
final boolean eosEnabled) {
final VerificationResult txnResult = preVerifyTransactions(kafka, eosEnabled);
if (txnResult != null) {

@mjsax mjsax Nov 21, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This does not seem to be easy to reason about? If txnResult is not null and passed, we only know that all transactions completed, but we cannot stop the verification yet -- we could only exit early if we get a "false" VerifcationResult.

This code does only make sense if one knows how preVerifyTransactions works, and it would return null for "passed == true" case, but it make the code hard to ready.

@RaidenE1 RaidenE1 Nov 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Make sense, updated

return txnResult;
}

final Properties props = new Properties();
props.put(ConsumerConfig.CLIENT_ID_CONFIG, "verifier");
props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, kafka);
props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, NumberDeserializer.class);
props.put(ConsumerConfig.ISOLATION_LEVEL_CONFIG, "read_committed");

final long start = System.currentTimeMillis();
try (final KafkaConsumer<String, Number> consumer = new KafkaConsumer<>(props)) {
final PollResult pollResult = pollAndCollect(consumer, inputs, maxRecordsPerKey, eosEnabled);
return reportAndFinalize(inputs, maxRecordsPerKey, start, eosEnabled, pollResult);
}
}

private static Map<String, Set<Number>> parseRecordsForEchoTopic(
final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events) {
return events.containsKey("echo") ?
Expand All @@ -491,24 +547,6 @@ private static Map<String, Set<Number>> parseRecordsForEchoTopic(
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)) : Collections.emptyMap();
}

public static class VerificationResult {
private final boolean passed;
private final String result;

VerificationResult(final boolean passed, final String result) {
this.passed = passed;
this.result = result;
}

public boolean passed() {
return passed;
}

public String result() {
return result;
}
}

private static VerificationResult verifyAll(final Map<String, Set<Integer>> inputs,
final Map<String, Map<String, LinkedList<ConsumerRecord<String, Number>>>> events,
final boolean printResults,
Expand Down Expand Up @@ -732,4 +770,65 @@ private static List<TopicPartition> getAllPartitions(final KafkaConsumer<?, ?> c
return partitions;
}

private static Properties createConsumerPropsWithByteDeserializer(final String kafka, final String clientId) {
final Properties props = new Properties();
props.put(ConsumerConfig.CLIENT_ID_CONFIG, clientId);
props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, kafka);
props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, ByteArrayDeserializer.class);
props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, ByteArrayDeserializer.class);
return props;
}

private static VerificationResult verifyAllTransactionFinished(final String kafka) {
final Properties txnProps = createConsumerPropsWithByteDeserializer(kafka, "verifier");
txnProps.put(ConsumerConfig.ISOLATION_LEVEL_CONFIG, IsolationLevel.READ_COMMITTED.toString());
try (final KafkaConsumer<byte[], byte[]> consumer = new KafkaConsumer<>(txnProps)) {
// Get all output topics except "data" (which is the input topic)
final String[] outputTopics = Arrays.stream(NUMERIC_VALUE_TOPICS)
.filter(topic -> !topic.equals("data"))
.toArray(String[]::new);

final List<TopicPartition> partitions = getAllPartitions(consumer, outputTopics);
consumer.assign(partitions);
consumer.seekToEnd(partitions);
for (final TopicPartition tp : partitions) {
System.out.println(tp + " at position " + consumer.position(tp));
}
final Properties consumerProps = createConsumerPropsWithByteDeserializer(kafka, "consumer-uncommitted");

final long maxWaitTime = System.currentTimeMillis() + MAX_IDLE_TIME_MS;
try (final KafkaConsumer<byte[], byte[]> consumerUncommitted = new KafkaConsumer<>(consumerProps)) {
while (!partitions.isEmpty() && System.currentTimeMillis() < maxWaitTime) {
consumer.seekToEnd(partitions);
final Map<TopicPartition, Long> topicEndOffsets = consumerUncommitted.endOffsets(partitions);

final java.util.Iterator<TopicPartition> iterator = partitions.iterator();
while (iterator.hasNext()) {
final TopicPartition topicPartition = iterator.next();
final long position = consumer.position(topicPartition);

if (position == topicEndOffsets.get(topicPartition)) {
iterator.remove();
System.out.println("Removing " + topicPartition + " at position " + position);
} else if (position > topicEndOffsets.get(topicPartition)) {
return new VerificationResult(false, "Offset for partition " + topicPartition + " is larger than topic endOffset: " + position + " > " + topicEndOffsets.get(topicPartition));
} else {
System.out.println("Retry " + topicPartition + " at position " + position);
}
}
sleep(1000L);
}
}

if (!partitions.isEmpty()) {
return new VerificationResult(false, "Could not read all verification records. Did not receive any new record within the last " + (MAX_IDLE_TIME_MS / 1000L) + " sec.");
}
return new VerificationResult(true, "All transactions finished successfully");
} catch (final Exception e) {
e.printStackTrace(System.err);
System.out.println("FAILED");
return new VerificationResult(false, "Transaction verification failed: " + e.getMessage());
}
}

}
18 changes: 18 additions & 0 deletions streams/src/test/java/org/apache/kafka/streams/tests/SmokeTestUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,22 @@ public static void sleep(final long duration) {
} catch (final Exception ignore) { }
}

public static class VerificationResult {
private final boolean passed;
private final String result;

public VerificationResult(final boolean passed, final String result) {
this.passed = passed;
this.result = result;
}

public boolean passed() {
return passed;
}

public String result() {
return result;
}
}

}