Kazoo has several test harnesses used internally for its own tests that are exposed as public API’s for use in your own tests for common Zookeeper cluster management and session testing. They can be mixed in with your own unittest or nose tests along with a mock object that allows you to force specific KazooClient commands to fail in various ways.

The test harness needs to be able to find the Zookeeper Java libraries. You need to specify an environment variable called ZOOKEEPER_PATH and point it to their location, for example /usr/share/java. The directory should contain a zookeeper-*.jar and a lib directory containing at least a log4j-*.jar.

If your Java setup is complex, you may also override our classpath mechanism completely by specifying an environment variable called ZOOKEEPER_CLASSPATH. If provided, it will be used unmodified as the Java classpath for Zookeeper.

You can specify an optional ZOOKEEPER_PORT_OFFSET environment variable to influence the ports the cluster is using. By default the offset is 20000 and a cluster with three members will use ports 20000, 20010 and 20020.

Kazoo Test Harness

The KazooTestHarness can be used directly or mixed in with your test code.


from kazoo.testing import KazooTestHarness

class MyTest(KazooTestHarness):
    def setUp(self):

    def tearDown(self):

    def testmycode(self):
        result = self.client.get('/test/path')

Kazoo Test Case

The KazooTestCase is complete test case that is equivalent to the mixin setup of KazooTestHarness. An equivalent test to the one above:

from kazoo.testing import KazooTestCase

class MyTest(KazooTestCase):
    def testmycode(self):
        result = self.client.get('/test/path')


For those that do not need (or desire) to setup a Zookeeper cluster to test integration with kazoo there is also a library called zake. Contributions to Zake’s github repository are welcome.

Zake can be used to provide a mock client to layers of your application that interact with kazoo (using the same client interface) during testing to allow for introspection of what was stored, which watchers are active (and more) after your test of your application code has finished.