content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.camel.component.kafka.integration;
  
  import java.util.Collections;
  import java.util.Map;
  import java.util.Properties;
  import java.util.concurrent.TimeUnit;
  import java.util.stream.StreamSupport;
  
  import org.apache.camel.BindToRegistry;
  import org.apache.camel.CamelContext;
  import org.apache.camel.builder.RouteBuilder;
  import org.apache.camel.component.kafka.KafkaConstants;
  import org.apache.camel.component.kafka.KafkaConsumer;
  import org.apache.camel.component.kafka.KafkaEndpoint;
  import org.apache.camel.component.kafka.MockConsumerInterceptor;
  import org.apache.camel.component.kafka.SeekPolicy;
  import org.apache.camel.component.kafka.integration.common.KafkaTestUtil;
  import org.apache.camel.component.kafka.serde.DefaultKafkaHeaderDeserializer;
  import org.apache.camel.component.mock.MockEndpoint;
  import org.apache.camel.test.infra.core.annotations.RouteFixture;
  import org.apache.kafka.clients.admin.DeleteTopicsResult;
  import org.apache.kafka.clients.producer.ProducerRecord;
  import org.apache.kafka.common.Uuid;
  import org.apache.kafka.common.header.internals.RecordHeader;
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.MethodOrderer;
  import org.junit.jupiter.api.Order;
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.api.TestInstance;
  import org.junit.jupiter.api.TestMethodOrder;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  import org.testcontainers.shaded.org.awaitility.Awaitility;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertInstanceOf;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
  @TestInstance(TestInstance.Lifecycle.PER_CLASS)
  public class KafkaConsumerFullIT extends BaseKafkaTestSupport {
      public static final String TOPIC = "test-full-" + Uuid.randomUuid(); //CAMEL-20722: a more unique name to avoid clash
      public static final String ROUTE = "full-it-" + Uuid.randomUuid();   //CAMEL-20722: a more unique name to avoid clash
  
      private static final Logger LOG = LoggerFactory.getLogger(KafkaConsumerFullIT.class);
  
      private static final String FROM_URI = "kafka:" + TOPIC
                                             + "?groupId=KafkaConsumerFullIT&autoOffsetReset=earliest&keyDeserializer=org.apache.kafka.common.serialization.StringDeserializer&"
                                             + "valueDeserializer=org.apache.kafka.common.serialization.StringDeserializer"
                                             + "&autoCommitIntervalMs=1000&pollTimeoutMs=1000&autoCommitEnable=true&interceptorClasses=org.apache.camel.component.kafka.MockConsumerInterceptor";
  
      private org.apache.kafka.clients.producer.KafkaProducer<String, String> producer;
      @BindToRegistry("myHeaderDeserializer")
      private final MyKafkaHeaderDeserializer bean = new MyKafkaHeaderDeserializer();
  
      @BeforeEach
      public void before() {
          Properties props = getDefaultProperties();
          producer = new org.apache.kafka.clients.producer.KafkaProducer<>(props);
          MockConsumerInterceptor.recordsCaptured.clear();
      }
  
      @AfterEach
      public void after() {
          if (producer != null) {
              producer.close();
          }
          // clean all test topics
          DeleteTopicsResult r = kafkaAdminClient.deleteTopics(Collections.singletonList(TOPIC));
  
          // wait necessary to ensure the topic is actually deleted, and avoid chance of clash in unrelate tests
          Awaitility.await()
                  .timeout(60, TimeUnit.SECONDS)
                  .pollDelay(3, TimeUnit.SECONDS)
                  .untilAsserted(() -> assertTrue(r.all().isDone()));
  
      }
  
      @RouteFixture
      public void createRouteBuilder(CamelContext context) throws Exception {
          context.addRoutes(createRouteBuilder());
      }
  
      protected RouteBuilder createRouteBuilder() {
          return new RouteBuilder() {
              @Override
              public void configure() {
                  from(FROM_URI)
                          .process(exchange -> LOG.trace("Captured on the processor: {}", exchange.getMessage().getBody()))
                          .routeId(ROUTE).to(KafkaTestUtil.MOCK_RESULT);
              }
          };
      }
  
      @Order(3)
      @Test
      public void kafkaMessageIsConsumedByCamel() throws InterruptedException {
          String propagatedHeaderKey = "PropagatedCustomHeader";
          byte[] propagatedHeaderValue = "propagated header value".getBytes();
          String skippedHeaderKey = "CamelSkippedHeader";
  
          MockEndpoint to = contextExtension.getMockEndpoint(KafkaTestUtil.MOCK_RESULT);
  
          to.expectedMessageCount(5);
          to.expectedBodiesReceivedInAnyOrder("message-0", "message-1", "message-2", "message-3", "message-4");
          // The LAST_RECORD_BEFORE_COMMIT header should not be configured on any
          // exchange because autoCommitEnable=true
          to.expectedHeaderValuesReceivedInAnyOrder(KafkaConstants.LAST_RECORD_BEFORE_COMMIT, null, null, null, null, null);
          to.expectedHeaderReceived(propagatedHeaderKey, propagatedHeaderValue);
  
          for (int k = 0; k < 5; k++) {
              String msg = "message-" + k;
              ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", msg);
              data.headers().add(new RecordHeader("CamelSkippedHeader", "skipped header value".getBytes()));
              data.headers().add(new RecordHeader(propagatedHeaderKey, propagatedHeaderValue));
              producer.send(data);
          }
  
          to.assertIsSatisfied(3000);
  
          assertEquals(5, MockConsumerInterceptor.recordsCaptured.stream()
                  .flatMap(i -> StreamSupport.stream(i.records(TOPIC).spliterator(), false)).count());
  
          Map<String, Object> headers = to.getExchanges().get(0).getIn().getHeaders();
          assertFalse(headers.containsKey(skippedHeaderKey), "Should not receive skipped header");
          assertTrue(headers.containsKey(propagatedHeaderKey), "Should receive propagated header");
      }
  
      @Order(2)
      @Test
      public void kafkaRecordSpecificHeadersAreNotOverwritten() throws InterruptedException {
          String propagatedHeaderKey = KafkaConstants.TOPIC;
          byte[] propagatedHeaderValue = "propagated incorrect topic".getBytes();
  
          MockEndpoint to = contextExtension.getMockEndpoint(KafkaTestUtil.MOCK_RESULT);
          to.expectedHeaderReceived(KafkaConstants.TOPIC, TOPIC);
  
          ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", "message");
          data.headers().add(new RecordHeader(propagatedHeaderKey, propagatedHeaderValue));
          producer.send(data);
  
          to.assertIsSatisfied(3000);
  
          Map<String, Object> headers = to.getExchanges().get(0).getIn().getHeaders();
          assertTrue(headers.containsKey(KafkaConstants.TOPIC), "Should receive KafkaEndpoint populated kafka.TOPIC header");
          assertEquals(TOPIC, headers.get(KafkaConstants.TOPIC), "Topic name received");
      }
  
      @Test
      @Order(1)
      public void kafkaMessageIsConsumedByCamelSeekedToBeginning() throws Exception {
          MockEndpoint to = contextExtension.getMockEndpoint(KafkaTestUtil.MOCK_RESULT);
          to.expectedMessageCount(5);
          to.expectedBodiesReceivedInAnyOrder("message-0", "message-1", "message-2", "message-3", "message-4");
          for (int k = 0; k < 5; k++) {
              String msg = "message-" + k;
              ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", msg);
              producer.send(data);
          }
          to.assertIsSatisfied(3000);
  
          to.reset();
  
          to.expectedMessageCount(5);
  
          to.expectedBodiesReceivedInAnyOrder("message-0", "message-1", "message-2", "message-3", "message-4");
  
          // Restart endpoint
          CamelContext context = contextExtension.getContext();
          context.getRouteController().stopRoute(ROUTE);
  
          KafkaEndpoint kafkaEndpoint = (KafkaEndpoint) context.getEndpoint(FROM_URI);
          kafkaEndpoint.getConfiguration().setSeekTo(SeekPolicy.BEGINNING);
  
          context.getRouteController().startRoute(ROUTE);
  
          // As wee set seek to beginning we should re-consume all messages
          to.assertIsSatisfied(3000);
      }
  
      @Order(4)
      @Test
      public void kafkaMessageIsConsumedByCamelSeekedToEnd() throws Exception {
          MockEndpoint to = contextExtension.getMockEndpoint(KafkaTestUtil.MOCK_RESULT);
  
          to.expectedMessageCount(5);
          to.expectedBodiesReceivedInAnyOrder("message-0", "message-1", "message-2", "message-3", "message-4");
          for (int k = 0; k < 5; k++) {
              String msg = "message-" + k;
              ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", msg);
              producer.send(data);
          }
          to.assertIsSatisfied(3000);
  
          to.reset();
  
          to.expectedMessageCount(0);
  
          // Restart endpoint
          CamelContext context = contextExtension.getContext();
          context.getRouteController().stopRoute(ROUTE);
  
          KafkaEndpoint kafkaEndpoint = (KafkaEndpoint) context.getEndpoint(FROM_URI);
          kafkaEndpoint.getConfiguration().setSeekTo(SeekPolicy.END);
  
          context.getRouteController().startRoute(ROUTE);
  
          to.assertIsSatisfied(3000);
      }
  
      @Order(5)
      @Test
      public void headerDeserializerCouldBeOverridden() {
          CamelContext context = contextExtension.getContext();
  
          KafkaEndpoint kafkaEndpoint
                  = context.getEndpoint("kafka:random_topic?headerDeserializer=#myHeaderDeserializer", KafkaEndpoint.class);
          assertInstanceOf(MyKafkaHeaderDeserializer.class, kafkaEndpoint.getConfiguration().getHeaderDeserializer());
      }
  
      @Order(6)
      @Test
      public void kafkaMessageIsConsumedByCamelAfterSuspendResume() throws Exception {
          MockEndpoint to = contextExtension.getMockEndpoint(KafkaTestUtil.MOCK_RESULT);
  
          to.expectedMessageCount(5);
          to.expectedBodiesReceivedInAnyOrder("message-0", "message-1", "message-2", "message-3", "message-4");
  
          for (int k = 0; k < 5; k++) {
              String msg = "message-" + k;
              ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", msg);
              producer.send(data);
          }
  
          to.assertIsSatisfied(3000);
  
          assertEquals(5, MockConsumerInterceptor.recordsCaptured.stream()
                  .flatMap(i -> StreamSupport.stream(i.records(TOPIC).spliterator(), false)).count());
  
          // suspend route
          CamelContext context = contextExtension.getContext();
          context.getRouteController().suspendRoute(ROUTE);
  
          // wait until the kafka client is really paused
          KafkaConsumer kc = (KafkaConsumer) context.getRoute(ROUTE).getConsumer();
          Awaitility.await().until(() -> {
              boolean paused = kc.isKafkaPaused();
              LOG.info("Waiting for kafka client to be paused: {}", paused);
              return paused;
          });
  
          context.getRouteController().resumeRoute(ROUTE);
  
          to.reset();
  
          to.expectedMessageCount(3);
          to.expectedBodiesReceivedInAnyOrder("message-5", "message-6", "message-7");
  
          for (int k = 5; k < 8; k++) {
              String msg = "message-" + k;
              ProducerRecord<String, String> data = new ProducerRecord<>(TOPIC, "1", msg);
              producer.send(data);
          }
  
          to.assertIsSatisfied(3000);
  
          assertEquals(5 + 3, MockConsumerInterceptor.recordsCaptured.stream()
                  .flatMap(i -> StreamSupport.stream(i.records(TOPIC).spliterator(), false)).count());
      }
  
      private static class MyKafkaHeaderDeserializer extends DefaultKafkaHeaderDeserializer {
      }
  }
  