MicroShed Testing

microshed-testing

Kafka Messaging

MicroShed Testing provides integration with applications using Apache Kafka for messaging. Apache Kafka is a messaging engine that is commonly used with Java microservice applications, and also is commonly used with MicroProfile Reactive Messaging.

Sending and receiving messages from tests

If an application purely uses Kafka Messaging for communication, a true-to-production way of testing is to also have the test client driving requests on the application via message passing. To do this, MicroShed Testing offers two annotations: @KafkaConsumerConfig and @KafkaProducerConfig

Example setup

To begin using Kafka with MicroShed Testing, define a KafkaContainer in the test environment:

import org.testcontainers.containers.KafkaContainer;
import org.testcontainers.containers.Network;
// other imports ...

public class AppContainerConfig implements SharedContainerConfiguration {

    private static Network network = Network.newNetwork();

    @Container
    public static KafkaContainer kafka = new KafkaContainer()
                    .withNetwork(network);

    @Container
    public static ApplicationContainer app = new ApplicationContainer()
                    .withNetwork(network)
                    .dependsOn(kafka);
}

Runtimes such as OpenLiberty and Quarkus will be auto-configured together if a KafkaContainer is present in the test environment. For Quarkus, no ApplicationContainer or Network is needed either. For other runtimes, you can link the containers together by using kafka.withNetworkAlias("kafka") and app.withEnv("<runtime-specific kafka bootstrap servers property>", "kafka:9092").

Example usage

import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.common.serialization.StringDeserializer;
import org.apache.kafka.common.serialization.StringSerializer;
import org.microshed.testing.kafka.KafkaConsumerConfig;
import org.microshed.testing.kafka.KafkaProducerConfig;
// other imports ...

@MicroShedTest
@SharedContainerConfig(AppContainerConfig.class)
public class KitchenEndpointIT {

  @KafkaProducerConfig                                   // (1)
  public static KafkaProducer<String, String> producer;

  @KafkaConsumerConfig(groupId = "update-status",
                       topics = "statusTopic")           // (2)
  public static KafkaConsumer<String, String> consumer;
  
  @Test
  public void myTest() {
    // Use the producer to send messages
    producer.send(...);

    // Use the consumer to poll for records
    ConsumerRecords<String, String> records = consumer.poll(Duration.ofSeconds(30));
    // ...
  }
}
  1. Each @KafkaProducerConfig and @KafkaConsumerConfig may optionally define a set of key/value [de]serializers that correspond to the key/value types defined in the KafkaProducer and KafkaConsumer. If none are specified, then an attempt will be made to auto-detect a fitting built-in [de]serializer.
  2. For @KafkaConsumerConfig zero or more topics may be specified to automatically subscribe the injected consumer to the specified topics.

Additional resources