embedded zookeeper for unit/integration test

Question

Is there an embedded zookeeper so that we could use it in unit testing? It can be shipped with the test and run out of the box. Maybe we could mock some service and register to the embedded zookeeper

Answer 1

The Curator framework has TestingServer and TestingCluster classes (see https://github.com/Netflix/curator/wiki/Utilities) that are in a separate maven artifact (curator-test - see the Maven/Artifacts section of https://github.com/Netflix/curator/wiki).

They're pretty self explanatory, or you can download the curator code base and see how they're used internally in their own test cases.

We've used both successfully within unit tests at $DAY_JOB.

Answer 2

You could use Apache Curator Utilities provided in-process ZooKeeper server TestingServer that can be used for testing. With maven you can dependency as follows

    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-test</artifactId>
        <version>3.2.1</version>
    </dependency>

And you can create in process zookeeper server as folows

 TestingServer zkServer;

  @Before
  public void setUp() throws Exception
  {
    zkServer = new TestingServer(2181, true);
  }

  @After
  public void tearDown() throws Exception
  {
    zkServer.stop();
  }

For testing Cluster use can use TestingCluster, which creates an internally running ensemble of ZooKeeper servers

Answer 3

You could use the zookeeper-maven-plugin, which is documented here.

Answer 4

The zookeeper project produces a "fat-jar" that it uses itself for system test.

There is a written up README, showing how easy it is to launch, but unfortunately it is not being made as an artifact, so cannot be linked to maven.