rasjones/scalatest-embedded-kafka

A library that provides an in-memory Kafka instance to run your ScalaTest specs against.

scalatest-embedded-kafka

A library that provides an in-memory Kafka broker to run your ScalaTest specs against. It uses Kafka 0.10.0.1 and ZooKeeper 3.4.9.

The version supporting Kafka 0.8.x can be found here - this is no longer actively supported, although I'll be happy to accept PRs and produce releases.

Inspired by https://github.com/chbatey/kafka-unit

How to use

scalatest-embedded-kafka is available on Bintray and Maven Central, compiled for both Scala 2.10 and 2.11

• In your build.sbt file add the following dependency: "net.manub" %% "scalatest-embedded-kafka" % "0.9.0" % "test"

• Have your Spec extend the EmbeddedKafka trait.

• Enclose the code that needs a running instance of Kafka within the withRunningKafka closure.

    class MySpec extends WordSpec with EmbeddedKafka {
  
    "runs with embedded kafka" should {
  
        withRunningKafka {
            // ... code goes here
        }
    
    }
  

• In-memory Zookeeper and Kafka will be instantiated respectively on port 6000 and 6001 and automatically shutdown at the end of the test.

Use without the withRunningKafka method

A EmbeddedKafka companion object is provided for usage without the EmbeddedKafka trait. Zookeeper and Kafka can be started an stopped in a programmatic way.

    class MySpec extends WordSpec {

    "runs with embedded kafka" should {
    
        EmbeddedKafka.start()
        
        // ... code goes here
        
        EmbeddedKafka.stop() 
    
    }

Please note that in order to avoid Kafka instances not shutting down properly, it's recommended to call EmbeddedKafka.stop() in a after block or in a similar teardown logic.

Configuration

It's possible to change the ports on which Zookeeper and Kafka are started by providing an implicit EmbeddedKafkaConfig

    class MySpec extends WordSpec with EmbeddedKafka {

    "runs with embedded kafka on a specific port" should {

        implicit val config = EmbeddedKafkaConfig(kafkaPort = 12345)

        withRunningKafka {
            // now a kafka broker is listening on port 12345
        }
    
    }

This works for both withRunningKafka and EmbeddedKafka.start()

Also, it is now possible to provide custom properties to the broker while starting Kafka. EmbeddedKafkaConfig has a customBrokerProperties field which can be used to provide extra properties contained in a Map[String, String]. Those properties will be added to the broker configuration, however some properties are set by the library itself and in case of conflict the library values will take precedence. Please look at the source code to see what this properties are.

Utility methods

The EmbeddedKafka trait provides also some utility methods to interact with the embedded kafka, in order to set preconditions or verifications in your specs:

    def publishToKafka(topic: String, message: String): Unit
    
    def consumeFirstMessageFrom(topic: String): String

    def createCustomTopic(topic: String, topicConfig: Map[String,String], partitions: Int, replicationFactor: Int): Unit

Custom producers

It is possible to create producers for custom types in two ways:

• Using the syntax aKafkaProducer thatSerializesValuesWith classOf[Serializer[V]]. This will return a KafkaProducer[String, V]
• Using the syntax aKafkaProducer[V]. This will return a KafkaProducer[String, V], using an implicit Serializer[V].

For more information about how to use the utility methods, you can either look at the Scaladocs or at the tests of this project.

Custom consumers

Use the Consumer trait that easily creates consumers of arbitrary key-value types and manages their lifecycle (via a loaner pattern).

• For basic String consumption use Consumer.withStringConsumer { your code here }.
• For arbitrary key and value types, expose implicit Deserializers for each type and use Consumer.withConsumer { your code here }.
• If you just want to create a consumer and manage its lifecycle yourself then try Consumer.newConsumer().

Easy message consumption

With ConsumerExtensions you can turn a consumer to a Scala lazy Stream of key-value pairs and treat it as a collection for easy assertion.

• Just import the extensions.
• On any KafkaConsumer instance you can now do:

import net.manub.embeddedkafka.ConsumerExtensions._
...
consumer.consumeLazily("from-this-topic").take(3).toList should be (Seq(
  "1" -> "one", 
  "2" -> "two", 
  "3" -> "three"
)

scalatest-embedded-kafka-streams

A library that builds on top of scalatest-embedded-kafka to offer easy testing of Kafka Streams with ScalaTest. It uses Kafka Streams 0.10.0.1. It takes care of instantiating and starting your streams as well as closing them after running your test-case code.

How to use

• In your build.sbt file add the following dependency: "net.manub" %% "scalatest-embedded-kafka-streams" % "0.9.0" % "test"
• Have a look at the example test
• For most of the cases have your Spec extend the EmbeddedKafkaStreamsAllInOne trait. This offers both streams management and easy creation of consumers for asserting resulting messages in output/sink topics.
• If you only want to use the streams management without the test consumers just have the Spec extend the EmbeddedKafkaStreams trait.
• Use the runStreamsWithStringConsumer to:
  • Create any topics that need to exist for the strems to operate (usually sources and sinks).
  • Pass the Stream or Topology builder that will then be used to instantiate and start the Kafka Streams. This will be done while using the withRunningKafka closure internally so that your stream runs with an embedded Kafka and Zookeeper.
  • Pass the {code block} that needs a running instance of your streams. This is where your actual test code will sit. You can publish messages to your source topics and consume messages from your sink topics that the Kafka Streams should have generated. This method also offers a pre-instantiated consumer that can read String keys and values.
• For more flexibility, use runStreams and withConsumer. This allows you to create your own consumers of custom types as seen in the example test.

import net.manub.embeddedkafka.ConsumerExtensions._
import org.apache.kafka.streams.kstream.KStreamBuilder
import org.scalatest.{Matchers, WordSpec}

class MySpec extends WordSpec with Matchers with EmbeddedKafkaStreamsAllInOne {
  "my kafka stream" should {
    "be easy to test" in {
      val inputTopic = "input-topic"
      val outputTopic = "output-topic"
      // your code for building the stream goes here e.g.
      val streamBuilder = new KStreamBuilder
      streamBuilder.stream(inputTopic).to(outputTopic)
      // tell the stream test
      // 1. what topics need to be created before the stream starts
      // 2. the builder to be used for initializing and starting the stream
      runStreamsWithStringConsumer(
        topicsToCreate = Seq(inputTopic, outputTopic),
        builder = streamBuilder
      ){ consumer =>
        // your test code goes here
        publishToKafka(inputTopic, key = "hello", message = "world")
        consumer.consumeLazily(outputTopic).head should be ("hello" -> "world")
      }
    }
  }
}