Catalog API should support tokens

Konstantin Nazarov · Konstantin Nazarov · commit 4a54b184e94d · 2016-09-09T20:38:42.000+03:00
In a case where the acl_token is set to "anonymous" in consul server config, by default services in catalog are invisible, and trying to list them shows only "consul" service. In context of #116
diff --git a/consul/base.py b/consul/base.py
@@ -932,7 +932,13 @@ class Catalog(object):
         def __init__(self, agent):
             self.agent = agent
 
-        def register(self, node, address, service=None, check=None, dc=None):
+        def register(self,
+                     node,
+                     address,
+                     service=None,
+                     check=None,
+                     dc=None,
+                     token=None):
             """
             A low level mechanism for directly registering or updating entries
             in the catalog. It is usually recommended to use
@@ -980,6 +986,8 @@ def register(self, node, address, service=None, check=None, dc=None):
             *dc* is the datacenter of the node and defaults to this agents
             datacenter.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             This manipulates the health check entry, but does not setup a
             script or TTL to actually update the status. The full documentation
             is `here <https://consul.io/docs/agent/http.html#catalog>`_.
@@ -994,10 +1002,18 @@ def register(self, node, address, service=None, check=None, dc=None):
                 data['service'] = service
             if check:
                 data['check'] = check
+            token = token or self.agent.token
+            if token:
+                data['token'] = token
             return self.agent.http.put(
                 CB.bool(), '/v1/catalog/register', data=json.dumps(data))
 
-        def deregister(self, node, service_id=None, check_id=None, dc=None):
+        def deregister(self,
+                       node,
+                       service_id=None,
+                       check_id=None,
+                       dc=None,
+                       token=None):
             """
             A low level mechanism for directly removing entries in the catalog.
             It is usually recommended to use the agent APIs, as they are
@@ -1009,6 +1025,8 @@ def deregister(self, node, service_id=None, check_id=None, dc=None):
             and *check_id* should be provided and only that service or check
             will be removed.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             Returns *True* on success.
             """
             assert not (service_id and check_id)
@@ -1020,6 +1038,9 @@ def deregister(self, node, service_id=None, check_id=None, dc=None):
                 data['serviceid'] = service_id
             if check_id:
                 data['checkid'] = check_id
+            token = token or self.agent.token
+            if token:
+                data['token'] = token
             return self.agent.http.put(
                 CB.bool(), '/v1/catalog/deregister', data=json.dumps(data))
 
@@ -1036,7 +1057,8 @@ def nodes(
                 wait=None,
                 consistency=None,
                 dc=None,
-                near=None):
+                near=None,
+                token=None):
             """
             Returns a tuple of (*index*, *nodes*) of all nodes known
             about in the *dc* datacenter. *dc* defaults to the current
@@ -1056,6 +1078,8 @@ def nodes(
             not specified *consistency* will the consistency level this client
             was configured with.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             The response looks like this::
 
                 (index, [
@@ -1079,13 +1103,21 @@ def nodes(
                     params['wait'] = wait
             if near:
                 params['near'] = near
+            token = token or self.agent.token
+            if token:
+                params['token'] = token
             consistency = consistency or self.agent.consistency
             if consistency in ('consistent', 'stale'):
                 params[consistency] = '1'
             return self.agent.http.get(
                 CB.json(index=True), '/v1/catalog/nodes', params=params)
 
-        def services(self, index=None, wait=None, consistency=None, dc=None):
+        def services(self,
+                     index=None,
+                     wait=None,
+                     consistency=None,
+                     dc=None,
+                     token=None):
             """
             Returns a tuple of (*index*, *services*) of all services known
             about in the *dc* datacenter. *dc* defaults to the current
@@ -1102,6 +1134,8 @@ def services(self, index=None, wait=None, consistency=None, dc=None):
             not specified *consistency* will the consistency level this client
             was configured with.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             The response looks like this::
 
                 (index, {
@@ -1124,13 +1158,22 @@ def services(self, index=None, wait=None, consistency=None, dc=None):
                 params['index'] = index
                 if wait:
                     params['wait'] = wait
+            token = token or self.agent.token
+            if token:
+                params['token'] = token
             consistency = consistency or self.agent.consistency
             if consistency in ('consistent', 'stale'):
                 params[consistency] = '1'
             return self.agent.http.get(
                 CB.json(index=True), '/v1/catalog/services', params=params)
 
-        def node(self, node, index=None, wait=None, consistency=None, dc=None):
+        def node(self,
+                 node,
+                 index=None,
+                 wait=None,
+                 consistency=None,
+                 dc=None,
+                 token=None):
             """
             Returns a tuple of (*index*, *services*) of all services provided
             by *node*.
@@ -1149,6 +1192,8 @@ def node(self, node, index=None, wait=None, consistency=None, dc=None):
             *dc* is the datacenter of the node and defaults to this agents
             datacenter.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             The response looks like this::
 
                 (index, {
@@ -1182,6 +1227,9 @@ def node(self, node, index=None, wait=None, consistency=None, dc=None):
                 params['index'] = index
                 if wait:
                     params['wait'] = wait
+            token = token or self.agent.token
+            if token:
+                params['token'] = token
             consistency = consistency or self.agent.consistency
             if consistency in ('consistent', 'stale'):
                 params[consistency] = '1'
@@ -1198,7 +1246,8 @@ def service(
                 tag=None,
                 consistency=None,
                 dc=None,
-                near=None):
+                near=None,
+                token=None):
             """
             Returns a tuple of (*index*, *nodes*) of the nodes providing
             *service* in the *dc* datacenter. *dc* defaults to the current
@@ -1221,6 +1270,8 @@ def service(
             not specified *consistency* will the consistency level this client
             was configured with.
 
+            *token* is an optional `ACL token`_ to apply to this request.
+
             The response looks like this::
 
                 (index, [
@@ -1246,6 +1297,9 @@ def service(
                     params['wait'] = wait
             if near:
                 params['near'] = near
+            token = token or self.agent.token
+            if token:
+                params['token'] = token
             consistency = consistency or self.agent.consistency
             if consistency in ('consistent', 'stale'):
                 params[consistency] = '1'
