juplo.de Git - demos/kafka/training/blob - src/test/java/de/juplo/kafka/GenericApplicationTests.java

   1 package de.juplo.kafka;
   2
   3 import com.mongodb.client.MongoClient;
   4 import lombok.extern.slf4j.Slf4j;
   5 import org.apache.kafka.clients.consumer.ConsumerRecord;
   6 import org.apache.kafka.clients.consumer.KafkaConsumer;
   7 import org.apache.kafka.clients.producer.KafkaProducer;
   8 import org.apache.kafka.clients.producer.ProducerRecord;
   9 import org.apache.kafka.common.TopicPartition;
  10 import org.apache.kafka.common.errors.RecordDeserializationException;
  11 import org.apache.kafka.common.serialization.*;
  12 import org.apache.kafka.common.utils.Bytes;
  13 import org.junit.jupiter.api.*;
  14 import org.springframework.beans.factory.annotation.Autowired;
  15 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
  16 import org.springframework.boot.autoconfigure.mongo.MongoProperties;
  17 import org.springframework.boot.test.autoconfigure.data.mongo.AutoConfigureDataMongo;
  18 import org.springframework.boot.test.context.ConfigDataApplicationContextInitializer;
  19 import org.springframework.boot.test.context.TestConfiguration;
  20 import org.springframework.context.annotation.Import;
  21 import org.springframework.kafka.test.context.EmbeddedKafka;
  22 import org.springframework.test.context.TestPropertySource;
  23 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
  24
  25 import java.time.Duration;
  26 import java.util.*;
  27 import java.util.concurrent.ExecutorService;
  28 import java.util.function.BiConsumer;
  29 import java.util.function.Consumer;
  30 import java.util.stream.Collectors;
  31 import java.util.stream.IntStream;
  32
  33 import static de.juplo.kafka.GenericApplicationTests.PARTITIONS;
  34 import static de.juplo.kafka.GenericApplicationTests.TOPIC;
  35 import static org.assertj.core.api.Assertions.*;
  36 import static org.awaitility.Awaitility.*;
  37
  38
  39 @SpringJUnitConfig(initializers = ConfigDataApplicationContextInitializer.class)
  40 @TestPropertySource(
  41                 properties = {
  42                                 "sumup.adder.bootstrap-server=${spring.embedded.kafka.brokers}",
  43                                 "sumup.adder.topic=" + TOPIC,
  44                                 "sumup.adder.commit-interval=500ms",
  45                                 "spring.mongodb.embedded.version=4.4.13" })
  46 @EmbeddedKafka(topics = TOPIC, partitions = PARTITIONS)
  47 @EnableAutoConfiguration
  48 @AutoConfigureDataMongo
  49 @Slf4j
  50 abstract class GenericApplicationTests<K, V>
  51 {
  52         public static final String TOPIC = "FOO";
  53         public static final int PARTITIONS = 10;
  54
  55
  56         @Autowired
  57         KafkaConsumer<K, V> kafkaConsumer;
  58         @Autowired
  59         Consumer<ConsumerRecord<K, V>> consumer;
  60         @Autowired
  61         ApplicationProperties properties;
  62         @Autowired
  63         ExecutorService executor;
  64         @Autowired
  65         StateRepository stateRepository;
  66         @Autowired
  67         MongoClient mongoClient;
  68         @Autowired
  69         MongoProperties mongoProperties;
  70         @Autowired
  71         PollIntervalAwareConsumerRebalanceListener rebalanceListener;
  72         @Autowired
  73         RecordHandler<K, V> recordHandler;
  74
  75         KafkaProducer<Bytes, Bytes> testRecordProducer;
  76         KafkaConsumer<Bytes, Bytes> offsetConsumer;
  77         EndlessConsumer<K, V> endlessConsumer;
  78         Map<TopicPartition, Long> oldOffsets;
  79         Map<TopicPartition, Long> seenOffsets;
  80         Set<ConsumerRecord<K, V>> receivedRecords;
  81
  82
  83         final RecordGenerator recordGenerator;
  84         final Consumer<ProducerRecord<Bytes, Bytes>> messageSender;
  85
  86         public GenericApplicationTests(RecordGenerator recordGenerator)
  87         {
  88                 this.recordGenerator = recordGenerator;
  89                 this.messageSender = (record) -> sendMessage(record);
  90         }
  91
  92
  93         /** Tests methods */
  94
  95         @Test
  96         void commitsCurrentOffsetsOnSuccess()
  97         {
  98                 int numberOfGeneratedMessages =
  99                                 recordGenerator.generate(false, false, messageSender);
 100
 101                 await(numberOfGeneratedMessages + " records received")
 102                                 .atMost(Duration.ofSeconds(30))
 103                                 .pollInterval(Duration.ofSeconds(1))
 104                                 .until(() -> receivedRecords.size() >= numberOfGeneratedMessages);
 105
 106                 await("Offsets committed")
 107                                 .atMost(Duration.ofSeconds(10))
 108                                 .pollInterval(Duration.ofSeconds(1))
 109                                 .untilAsserted(() ->
 110                                 {
 111                                         checkSeenOffsetsForProgress();
 112                                         assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
 113                                 });
 114
 115                 assertThatExceptionOfType(IllegalStateException.class)
 116                                 .isThrownBy(() -> endlessConsumer.exitStatus())
 117                                 .describedAs("Consumer should still be running");
 118
 119                 recordGenerator.assertBusinessLogic();
 120         }
 121
 122         @Test
 123         @SkipWhenErrorCannotBeGenerated(poisonPill = true)
 124         void commitsOffsetOfErrorForReprocessingOnDeserializationError()
 125         {
 126                 int numberOfGeneratedMessages =
 127                                 recordGenerator.generate(true, false, messageSender);
 128
 129                 await("Consumer failed")
 130                                 .atMost(Duration.ofSeconds(30))
 131                                 .pollInterval(Duration.ofSeconds(1))
 132                                 .until(() -> !endlessConsumer.running());
 133
 134                 checkSeenOffsetsForProgress();
 135                 assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
 136
 137                 endlessConsumer.start();
 138                 await("Consumer failed")
 139                                 .atMost(Duration.ofSeconds(30))
 140                                 .pollInterval(Duration.ofSeconds(1))
 141                                 .until(() -> !endlessConsumer.running());
 142
 143                 checkSeenOffsetsForProgress();
 144                 assertSeenOffsetsEqualCommittedOffsets(seenOffsets);
 145                 assertThat(receivedRecords.size())
 146                                 .describedAs("Received not all sent events")
 147                                 .isLessThan(numberOfGeneratedMessages);
 148
 149                 assertThatNoException()
 150                                 .describedAs("Consumer should not be running")
 151                                 .isThrownBy(() -> endlessConsumer.exitStatus());
 152                 assertThat(endlessConsumer.exitStatus())
 153                                 .describedAs("Consumer should have exited abnormally")
 154                                 .containsInstanceOf(RecordDeserializationException.class);
 155
 156                 recordGenerator.assertBusinessLogic();
 157         }
 158
 159         @Test
 160         @SkipWhenErrorCannotBeGenerated(logicError = true)
 161         void doesNotCommitOffsetsOnLogicError()
 162         {
 163                 int numberOfGeneratedMessages =
 164                                 recordGenerator.generate(false, true, messageSender);
 165
 166                 await("Consumer failed")
 167                                 .atMost(Duration.ofSeconds(30))
 168                                 .pollInterval(Duration.ofSeconds(1))
 169                                 .until(() -> !endlessConsumer.running());
 170
 171                 checkSeenOffsetsForProgress();
 172                 assertSeenOffsetsAreBehindCommittedOffsets(seenOffsets);
 173
 174                 endlessConsumer.start();
 175                 await("Consumer failed")
 176                                 .atMost(Duration.ofSeconds(30))
 177                                 .pollInterval(Duration.ofSeconds(1))
 178                                 .until(() -> !endlessConsumer.running());
 179
 180                 assertSeenOffsetsAreBehindCommittedOffsets(seenOffsets);
 181
 182                 assertThatNoException()
 183                                 .describedAs("Consumer should not be running")
 184                                 .isThrownBy(() -> endlessConsumer.exitStatus());
 185                 assertThat(endlessConsumer.exitStatus())
 186                                 .describedAs("Consumer should have exited abnormally")
 187                                 .containsInstanceOf(RuntimeException.class);
 188
 189                 recordGenerator.assertBusinessLogic();
 190         }
 191
 192
 193         /** Helper methods for the verification of expectations */
 194
 195         void assertSeenOffsetsEqualCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
 196         {
 197                 doForCurrentOffsets((tp, offset) ->
 198                 {
 199                         Long expected = offsetsToCheck.get(tp) + 1;
 200                         log.debug("Checking, if the offset {} for {} is exactly {}", offset, tp, expected);
 201                         assertThat(offset)
 202                                         .describedAs("Committed offset corresponds to the offset of the consumer")
 203                                         .isEqualTo(expected);
 204                 });
 205         }
 206
 207         void assertSeenOffsetsAreBehindCommittedOffsets(Map<TopicPartition, Long> offsetsToCheck)
 208         {
 209                 List<Boolean> isOffsetBehindSeen = new LinkedList<>();
 210
 211                 doForCurrentOffsets((tp, offset) ->
 212                 {
 213                         Long expected = offsetsToCheck.get(tp) + 1;
 214                         log.debug("Checking, if the offset {} for {} is at most {}", offset, tp, expected);
 215                         assertThat(offset)
 216                                         .describedAs("Committed offset corresponds to the offset of the consumer")
 217                                         .isLessThanOrEqualTo(expected);
 218                         isOffsetBehindSeen.add(offset < expected);
 219                 });
 220
 221                 assertThat(isOffsetBehindSeen.stream().reduce(false, (result, next) -> result | next))
 222                                 .describedAs("Committed offsets are behind seen offsets")
 223                                 .isTrue();
 224         }
 225
 226         void checkSeenOffsetsForProgress()
 227         {
 228                 // Be sure, that some messages were consumed...!
 229                 Set<TopicPartition> withProgress = new HashSet<>();
 230                 partitions().forEach(tp ->
 231                 {
 232                         Long oldOffset = oldOffsets.get(tp) + 1;
 233                         Long newOffset = seenOffsets.get(tp) + 1;
 234                         if (!oldOffset.equals(newOffset))
 235                         {
 236                                 log.debug("Progress for {}: {} -> {}", tp, oldOffset, newOffset);
 237                                 withProgress.add(tp);
 238                         }
 239                 });
 240                 assertThat(withProgress)
 241                                 .describedAs("Some offsets must have changed, compared to the old offset-positions")
 242                                 .isNotEmpty();
 243         }
 244
 245
 246         /** Helper methods for setting up and running the tests */
 247
 248         void seekToEnd()
 249         {
 250                 offsetConsumer.assign(partitions());
 251                 partitions().forEach(tp ->
 252                 {
 253                         Long offset = offsetConsumer.position(tp);
 254                         log.info("New position for {}: {}", tp, offset);
 255                         Integer partition = tp.partition();
 256                         StateDocument document =
 257                                         stateRepository
 258                                                         .findById(partition.toString())
 259                                                         .orElse(new StateDocument(partition));
 260                         document.offset = offset;
 261                         stateRepository.save(document);
 262                 });
 263                 offsetConsumer.unsubscribe();
 264         }
 265
 266         void doForCurrentOffsets(BiConsumer<TopicPartition, Long> consumer)
 267         {
 268                 partitions().forEach(tp ->
 269                 {
 270                         String partition = Integer.toString(tp.partition());
 271                         Optional<Long> offset = stateRepository.findById(partition).map(document -> document.offset);
 272                         consumer.accept(tp, offset.orElse(0l));
 273                 });
 274         }
 275
 276         List<TopicPartition> partitions()
 277         {
 278                 return
 279                                 IntStream
 280                                                 .range(0, PARTITIONS)
 281                                                 .mapToObj(partition -> new TopicPartition(TOPIC, partition))
 282                                                 .collect(Collectors.toList());
 283         }
 284
 285
 286         public interface RecordGenerator
 287         {
 288                 int generate(
 289                                 boolean poisonPills,
 290                                 boolean logicErrors,
 291                                 Consumer<ProducerRecord<Bytes, Bytes>> messageSender);
 292
 293                 default boolean canGeneratePoisonPill()
 294                 {
 295                         return true;
 296                 }
 297
 298                 default boolean canGenerateLogicError()
 299                 {
 300                         return true;
 301                 }
 302
 303                 default void assertBusinessLogic()
 304                 {
 305                         log.debug("No business-logic to assert");
 306                 }
 307         }
 308
 309         void sendMessage(ProducerRecord<Bytes, Bytes> record)
 310         {
 311                 testRecordProducer.send(record, (metadata, e) ->
 312                 {
 313                         if (metadata != null)
 314                         {
 315                                 log.debug(
 316                                                 "{}|{} - {}={}",
 317                                                 metadata.partition(),
 318                                                 metadata.offset(),
 319                                                 record.key(),
 320                                                 record.value());
 321                         }
 322                         else
 323                         {
 324                                 log.warn(
 325                                                 "Exception for {}={}: {}",
 326                                                 record.key(),
 327                                                 record.value(),
 328                                                 e.toString());
 329                         }
 330                 });
 331         }
 332
 333
 334         @BeforeEach
 335         public void init()
 336         {
 337                 Properties props;
 338                 props = new Properties();
 339                 props.put("bootstrap.servers", properties.getBootstrapServer());
 340                 props.put("linger.ms", 100);
 341                 props.put("key.serializer", BytesSerializer.class.getName());
 342                 props.put("value.serializer", BytesSerializer.class.getName());
 343                 testRecordProducer = new KafkaProducer<>(props);
 344
 345                 props = new Properties();
 346                 props.put("bootstrap.servers", properties.getBootstrapServer());
 347                 props.put("client.id", "OFFSET-CONSUMER");
 348                 props.put("group.id", properties.getGroupId());
 349                 props.put("key.deserializer", BytesDeserializer.class.getName());
 350                 props.put("value.deserializer", BytesDeserializer.class.getName());
 351                 offsetConsumer = new KafkaConsumer<>(props);
 352
 353                 mongoClient.getDatabase(mongoProperties.getDatabase()).drop();
 354                 seekToEnd();
 355
 356                 oldOffsets = new HashMap<>();
 357                 seenOffsets = new HashMap<>();
 358                 receivedRecords = new HashSet<>();
 359
 360                 doForCurrentOffsets((tp, offset) ->
 361                 {
 362                         oldOffsets.put(tp, offset - 1);
 363                         seenOffsets.put(tp, offset - 1);
 364                 });
 365
 366                 TestRecordHandler<K, V> captureOffsetAndExecuteTestHandler =
 367                                 new TestRecordHandler<K, V>(recordHandler)
 368                                 {
 369                                         @Override
 370                                         public void onNewRecord(ConsumerRecord<K, V> record)
 371                                         {
 372                                                 seenOffsets.put(
 373                                                                 new TopicPartition(record.topic(), record.partition()),
 374                                                                 record.offset());
 375                                                 receivedRecords.add(record);
 376                                         }
 377                                 };
 378
 379                 endlessConsumer =
 380                                 new EndlessConsumer<>(
 381                                                 executor,
 382                                                 properties.getClientId(),
 383                                                 properties.getTopic(),
 384                                                 kafkaConsumer,
 385                                                 rebalanceListener,
 386                                                 captureOffsetAndExecuteTestHandler);
 387
 388                 endlessConsumer.start();
 389         }
 390
 391         @AfterEach
 392         public void deinit()
 393         {
 394                 try
 395                 {
 396                         endlessConsumer.stop();
 397                         testRecordProducer.close();
 398                         offsetConsumer.close();
 399                 }
 400                 catch (Exception e)
 401                 {
 402                         log.info("Exception while stopping the consumer: {}", e.toString());
 403                 }
 404         }
 405
 406
 407         @TestConfiguration
 408         @Import(ApplicationConfiguration.class)
 409         public static class Configuration
 410         {
 411         }
 412 }