Karate has native support for Apache Kafka as an optional dependency (non-open source and commercial). Enterprise users can find more information here: Karate-Kafka.
A license is required for running (for e.g. in CI/CD) and a Karate Labs IDE subscription is required per developer seat.
This sample project shows how to use the Avro and plain-JSON support. Make sure you have a .karate/karate.lic file in place before running the example.
- Docker is required to start the Kafka broker and Zookeeper. There is a
docker-compose.ymlfile in this project. - Run the following commands
docker-compose up -dmvn test
- To stop the Docker containers run
docker-compose down
- kafka-custom - it is possible to test Kafka by writing the Java integration code yourself and generating Java code, but the approach above is recommended
- kafla-mtls - using MTLS (SSL / Auth) with Kafka and also includes an example of hybrid API + Kafka testing
- community-example - a community project that provides a generic approach to testing Kafka with Karate, but requires you to to write / generate Java code.