Merge pull request #29 from fiaas/add-namespace-support-in-watch_list

Add namespace parameter to watch_list

.prospector.yaml

@@ -13,7 +13,7 @@ ignore-paths:
 
 pep8:
   options:
-    max-line-length: 140
+    max-line-length: 120
 
 mccabe:
   max-complexity: 10

k8s/base.py

@@ -35,6 +35,7 @@ def __new__(mcs, cls, bases, attrs):
         meta = {
             "url_template": getattr(attr_meta, "url_template", ""),
             "watch_list_url": getattr(attr_meta, "watch_list_url", ""),
+            "watch_list_url_template": getattr(attr_meta, "watch_list_url_template", ""),
             "fields": [],
             "field_names": []
         }
@@ -78,11 +79,19 @@ def list(cls, namespace="default"):
         return [cls.from_dict(item) for item in resp.json()[u"items"]]
 
     @classmethod
-    def watch_list(cls):
+    def watch_list(cls, namespace=None):
         """Return a generator that yields WatchEvents of cls"""
-        url = cls._meta.watch_list_url
-        if not url:
-            raise NotImplementedError("Cannot watch_list, no watch_list_url defined on class {}".format(cls))
+        if namespace:
+            if cls._meta.watch_list_url_template:
+                url = cls._meta.watch_list_url_template.format(namespace=namespace)
+            else:
+                raise NotImplementedError(
+                    "Cannot watch_list with namespace, no watch_list_url_template defined on class {}".format(cls))
+        else:
+            url = cls._meta.watch_list_url
+            if not url:
+                raise NotImplementedError("Cannot watch_list, no watch_list_url defined on class {}".format(cls))
+
         resp = cls._client.get(url, stream=True, timeout=None)
         for line in resp.iter_lines(chunk_size=None):
             if line:

k8s/watcher.py

@@ -25,13 +25,15 @@ def __init__(self, model, capacity=DEFAULT_CAPACITY):
         self._seen = cachetools.LRUCache(capacity)
         self._model = model
 
-    def watch(self):
+    def watch(self, namespace=None):
         """Watch for events
 
+        :param str namespace: the namespace to watch for events in. The default (None) results in watching for events
+        in all namespaces.
         :return: a generator that yields :py:class:`~.WatchEvent` objects not seen before
         """
         while True:
-            for event in self._model.watch_list():
+            for event in self._model.watch_list(namespace=namespace):
                 o = event.object
                 key = (o.metadata.name, o.metadata.namespace)
                 if self._seen.get(key) == o.metadata.resourceVersion and event.type != WatchEvent.DELETED:

setup.py

@@ -67,7 +67,7 @@ def main():
             "release": ["gitpython", "twine"],
             "docs": ["Sphinx>=1.6.3"]
         },
-
+        tests_require=TESTS_REQ,
         # Metadata
         description="Python client library for the Kubernetes API",
         long_description=_generate_description(),

tests/k8s/test_client.py

@@ -90,12 +90,22 @@ def test_watch_list_should_raise_exception_when_watch_list_url_is_not_set_on_met
         with pytest.raises(NotImplementedError):
             list(WatchListExampleUnsupported.watch_list())
 
+    def test_watch_list_with_namespace_should_raise_exception_when_watch_list_url_template_is_not_set_on_metaclass(self, session):
+        with pytest.raises(NotImplementedError):
+            list(WatchListExampleUnsupported.watch_list(namespace="explicitly-set"))
+
     def test_watch_list(self, session):
         list(WatchListExample.watch_list())
         session.request.assert_called_once_with(
             "GET", _absolute_url("/watch/example"), json=None, timeout=None, stream=True
         )
 
+    def test_watch_list_with_namespace(self, session):
+        list(WatchListExample.watch_list(namespace="explicitly-set"))
+        session.request.assert_called_once_with(
+            "GET", _absolute_url("/watch/explicitly-set/example"), json=None, timeout=None, stream=True
+        )
+
     @pytest.mark.parametrize("key", SENSITIVE_HEADERS)
     def test_redacts_sensitive_headers(self, key):
         message = []
@@ -111,14 +121,15 @@ def _absolute_url(url):
 
 class WatchListExample(Model):
     class Meta:
-        url_template = '/example'
-        watch_list_url = '/watch/example'
+        url_template = "/example"
+        watch_list_url = "/watch/example"
+        watch_list_url_template = "/watch/{namespace}/example"
 
     value = Field(int)
 
 
 class WatchListExampleUnsupported(Model):
     class Meta:
-        url_template = '/example'
+        url_template = "/example"
 
     value = Field(int)

tests/k8s/test_watcher.py

@@ -33,6 +33,8 @@ def test_multiple_events(self, api_watch_list):
         with pytest.raises(StopIteration):
             next(gen)
 
+        api_watch_list.assert_called_with(namespace=None)
+
     def test_handle_reconnect(self, api_watch_list):
         events = [_event(0, ADDED, 1)]
         api_watch_list.side_effect = [events, events]
@@ -81,6 +83,17 @@ def test_complicated(self, api_watch_list):
         with pytest.raises(StopIteration):
             next(gen)
 
+    def test_namespace(self, api_watch_list):
+        namespace = "the-namespace"
+        api_watch_list.side_effect = []
+
+        gen = Watcher(WatchListExample).watch(namespace=namespace)
+
+        with pytest.raises(StopIteration):
+            next(gen)
+
+        api_watch_list.assert_called_with(namespace=namespace)
+
 
 def _event(id, event_type, rv, namespace="default"):
     metadict = {"name": "name{}".format(id), "namespace": namespace, "resourceVersion": rv}
@@ -102,6 +115,7 @@ class WatchListExample(Model):
     class Meta:
         url_template = '/example'
         watch_list_url = '/watch/example'
+        watch_list_url_template = '/watch/{namespace}/example'
 
     apiVersion = Field(six.text_type, "example.com/v1")
     kind = Field(six.text_type, "Example")