Skip to content
This repository was archived by the owner on Apr 15, 2024. It is now read-only.

Add node_meta to catalog/register endpoint #222

Merged
matusvalo merged 7 commits into from
Jul 25, 2018
Merged

Add node_meta to catalog/register endpoint #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f682eb5
Add node_meta to catalog/register endpoint
ibrahimmenem Jul 14, 2018
d150e83
Add unittest to node_meta parameter
ibrahimmenem Jul 20, 2018
b5b6100
Ensure order doesn't affect node_meta unittest
ibrahimmenem Jul 20, 2018
23df603
Make code compatible with python 2.6
ibrahimmenem Jul 20, 2018
2a43a6a
Reorder unittests
ibrahimmenem Jul 21, 2018
8753931
Add node_meta to 'list nodes per service'
ibrahimmenem Jul 24, 2018
77cfdfd
Add 'list nodes per service' to node_meta unittests
ibrahimmenem Jul 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions consul/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1066,7 +1066,8 @@ def register(self,
service=None,
check=None,
dc=None,
token=None):
token=None,
node_meta=None):
"""
A low level mechanism for directly registering or updating entries
in the catalog. It is usually recommended to use
Expand Down Expand Up @@ -1116,6 +1117,9 @@ def register(self,

*token* is an optional `ACL token`_ to apply to this request.

*node_meta* is an optional meta data used for filtering, a
dictionary formatted as {k1:v1, k2:v2}.

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>`_.
Expand All @@ -1135,6 +1139,10 @@ def register(self,
if token:
data['WriteRequest'] = {'Token': token}
params.append(('token', token))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))
return self.agent.http.put(
CB.bool(),
'/v1/catalog/register',
Expand Down Expand Up @@ -1248,9 +1256,8 @@ def nodes(
params.append((consistency, '1'))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{}:{}'.
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))

return self.agent.http.get(
CB.json(index=True), '/v1/catalog/nodes', params=params)

Expand Down Expand Up @@ -1312,9 +1319,8 @@ def services(self,
params.append((consistency, '1'))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{}:{}'.
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))

return self.agent.http.get(
CB.json(index=True), '/v1/catalog/services', params=params)

Expand Down Expand Up @@ -1398,7 +1404,8 @@ def service(
consistency=None,
dc=None,
near=None,
token=None):
token=None,
node_meta=None):
"""
Returns a tuple of (*index*, *nodes*) of the nodes providing
*service* in the *dc* datacenter. *dc* defaults to the current
Expand All @@ -1423,6 +1430,9 @@ def service(

*token* is an optional `ACL token`_ to apply to this request.

*node_meta* is an optional meta data used for filtering, a
dictionary formatted as {k1:v1, k2:v2}.

The response looks like this::

(index, [
Expand Down Expand Up @@ -1454,6 +1464,10 @@ def service(
consistency = consistency or self.agent.consistency
if consistency in ('consistent', 'stale'):
params.append((consistency, '1'))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))
return self.agent.http.get(
CB.json(index=True),
'/v1/catalog/service/%s' % service,
Expand Down Expand Up @@ -1521,9 +1535,8 @@ def service(self,
params.append(('token', token))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{}:{}'.
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))

return self.agent.http.get(
CB.json(index=True),
'/v1/health/service/%s' % service,
Expand Down Expand Up @@ -1577,9 +1590,8 @@ def checks(
params.append(('token', token))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{}:{}'.
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))

return self.agent.http.get(
CB.json(index=True),
'/v1/health/checks/%s' % service,
Expand Down Expand Up @@ -1638,7 +1650,7 @@ def state(self,
params.append(('token', token))
if node_meta:
for nodemeta_name, nodemeta_value in node_meta.items():
params.append(('node-meta', '{}:{}'.
params.append(('node-meta', '{0}:{1}'.
format(nodemeta_name, nodemeta_value)))
return self.agent.http.get(
CB.json(index=True),
Expand Down
27 changes: 27 additions & 0 deletions tests/test_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,20 @@ def _should_support(c):
)


def _should_support_node_meta(c):
return (
# catalog
c.catalog.nodes,
c.catalog.services,
lambda **kw: c.catalog.service('foo', **kw),
lambda **kw: c.catalog.register('foo', 'bar', **kw),
# health
lambda **kw: c.health.service('foo', **kw),
lambda **kw: c.health.checks('foo', **kw),
lambda **kw: c.health.state('unknown', **kw),
)


class TestIndex(object):
"""
Tests read requests that should support blocking on an index
Expand Down Expand Up @@ -80,6 +94,19 @@ def test_implicit(self):
assert r(consistency='stale').params == [('stale', '1')]


class TestNodemeta(object):
"""
Tests read requests that should support node_meta
"""

def test_node_meta(self):
c = Consul()
for r in _should_support_node_meta(c):
assert r().params == []
assert sorted(r(node_meta={'env': 'prod', 'net': 1}).params) == \
sorted([('node-meta', 'net:1'), ('node-meta', 'env:prod')])


class TestCB(object):

def test_status_200_passes(self):
Expand Down