Merge pull request jplana#135 from projectcalico/smc-fix-read-timeout-err

lavagetto · lavagetto · commit 9fccae1dffeb · 2015-10-14T11:34:21.000-04:00
Introduce EtcdWatchTimedOut exception.
diff --git a/buildout.cfg b/buildout.cfg
@@ -4,7 +4,7 @@ parts = python
       test
 develop = .
 eggs = 
-     urllib3==1.7
+     urllib3==1.7.1
      pyOpenSSL==0.13.1
 
 [python]
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 version = '0.4.2'
 
 install_requires = [
-    'urllib3>=1.7'
+    'urllib3>=1.7.1'
 ]
 
 test_requires = [
diff --git a/src/etcd/__init__.py b/src/etcd/__init__.py
@@ -200,6 +200,13 @@ def __init__(self, message=None, payload=None, cause=None):
         self.cause = cause
 
 
+class EtcdWatchTimedOut(EtcdConnectionFailed):
+    """
+    A watch timed out without returning a result.
+    """
+    pass
+
+
 class EtcdWatcherCleared(EtcdException):
     """
     Watcher is cleared due to etcd recovery.
diff --git a/src/etcd/client.py b/src/etcd/client.py
@@ -772,6 +772,14 @@ def api_execute(self, path, method, params=None, timeout=None):
             except (urllib3.exceptions.HTTPError,
                     HTTPException,
                     socket.error) as e:
+                if (params.get("wait") == "true" and
+                        isinstance(e, urllib3.exceptions.ReadTimeoutError)):
+                    _log.debug("Watch timed out.")
+                    raise etcd.EtcdWatchTimedOut(
+                        "Watch timed out: %r" % e,
+                        cause=e
+                    )
+
                 _log.error("Request to server %s failed: %r",
                            self._base_uri, e)
                 if self._allow_reconnect:
diff --git a/src/etcd/tests/unit/test_request.py b/src/etcd/tests/unit/test_request.py
@@ -1,3 +1,5 @@
+import urllib3
+
 import etcd
 from etcd.tests.unit import TestClientApiBase
 
@@ -428,6 +430,20 @@ def test_compare_and_swap_failure(self):
             prevValue='oldbog'
         )
 
+    def test_watch_timeout(self):
+        """ Exception will be raised if prevValue != value in test_set """
+        self.client.http.request = mock.create_autospec(
+            self.client.http.request,
+            side_effect=urllib3.exceptions.ReadTimeoutError(self.client.http,
+                                                            "foo",
+                                                            "Read timed out")
+        )
+        self.assertRaises(
+            etcd.EtcdWatchTimedOut,
+            self.client.watch,
+            '/testKey',
+        )
+
     def test_path_without_trailing_slash(self):
         """ Exception will be raised if a path without a trailing slash is used """
         self.assertRaises(ValueError, self.client.api_execute,

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`version = '0.4.2'`
`10`	`10`
`11`	`11`	`install_requires = [`
`12`		`- 'urllib3>=1.7'`
	`12`	`+ 'urllib3>=1.7.1'`
`13`	`13`	`]`
`14`	`14`
`15`	`15`	`test_requires = [`