Add KafkaTimeoutError (used by client.ensure_topic_exists) and add a test

Author: Dana Powers

kafka/client.py

@@ -8,8 +8,8 @@
 
 from kafka.common import (TopicAndPartition,
                           ConnectionError, FailedPayloadsError,
-                          PartitionUnavailableError,
-                          LeaderUnavailableError, KafkaUnavailableError,
+                          PartitionUnavailableError, LeaderUnavailableError, KafkaUnavailableError,
+                          KafkaTimeoutError,
                           UnknownTopicOrPartitionError, NotLeaderForPartitionError)
 
 from kafka.conn import collect_hosts, KafkaConnection, DEFAULT_SOCKET_TIMEOUT_SECONDS
@@ -219,7 +219,7 @@ def ensure_topic_exists(self, topic, timeout = 30):
         self.load_metadata_for_topics(topic)
         while not self.has_metadata_for_topic(topic):
             if time.time() > start_time + timeout:
-                raise KafkaTimeoutError("Unable to create topic {}".format(topic))
+                raise KafkaTimeoutError("Unable to create topic {0}".format(topic))
             self.load_metadata_for_topics(topic)
             time.sleep(.5)
 

kafka/common.py

@@ -135,6 +135,10 @@ class KafkaUnavailableError(KafkaError):
     pass
 
 
+class KafkaTimeoutError(KafkaError):
+    pass
+
+
 class LeaderUnavailableError(KafkaError):
     pass
 

test/test_client_integration.py

@@ -49,6 +49,17 @@ def test_consume_none(self):
         messages = list(fetch_resp.messages)
         self.assertEquals(len(messages), 0)
 
+    @kafka_versions("all")
+    def test_ensure_topic_exists(self):
+
+        # assume that self.topic was created by setUp
+        # if so, this should succeed
+        self.client.ensure_topic_exists(self.topic, timeout=1)
+
+        # ensure_topic_exists should fail with KafkaTimeoutError
+        with self.assertRaises(KafkaTimeoutError):
+            self.client.ensure_topic_exists("this_topic_doesnt_exist", timeout=0)
+
     ####################
     #   Offset Tests   #
     ####################