Kafka Testing using YAML
Integration testing can be difficult for distributed systems. I’ve found this to be true when testing Kafka to ensure data is produced correctly. I’ve tried using a consumer in my tests to verify data made it into the topic. Unfortunately, the Observer Effect made this unstable because of Kafka’s design to balance partitions between consumers.
I found using a Producer Interceptor solved my testing problem in a less invasive way. (Note that for unit tests, Kafka provides MockProducer and MockConsumer classes that are quite powerful and should be used when applicable.)
Kafka Producer Interceptor
Producers can have interceptors that are given the opportunity to process records and optionally modify them. We’ll use an interceptor that logs the record to a file. The file format will be YAML. YAML allows us to append elements to the file and the format is always valid. With JSON or XML we’d need closing syntax and that becomes more difficult to record a valid file.
The interceptor is configured using the properties given to the KafkaProducer constructor:
- interceptor.classes = LoggingProducerInterceptor
- interceptor.LoggingProducerInterceptor.file = /tmp/producer.log
The YAML file is an array of JSON objects. The first entry is the configuration for the producer. Each entry after that has the record thread name, key and value. The thread can be used, in addition to the key and/or value, for querying in the test.
Writing the Test
Verification is done by reading the YAML file and finding the record you expect. With Groovy
Iterable extensions and YAML/JSON, this is straightforward and readable.
There are two common patterns I found in my tests. First, limiting to the current test thread, which assumes the producer interceptor is called in the same thread as the test. Second, ignoring existing records.
I wrote a helper class that provides the YAML as a collection with optional filtering by thread and/or ignoring the existing records.
Here’s an example of a test using
The example is simple but your verification doesn’t have to be. The complete value of the record is available for testing.
I had unstable integration tests that would fail about 10% of the time. Using a YAML file to record producer activity removed the instability when checking for correctly produced records. Also, it can be applied to other technology beyond Kafka.