1
diff --git a/lib/charms/redis_k8s/v0/redis.py b/lib/charms/redis_k8s/v0/redis.py
2
index 70787b6..5360ce0 100644
3
--- a/lib/charms/redis_k8s/v0/redis.py
4
+++ b/lib/charms/redis_k8s/v0/redis.py
5
@@ -6,15 +6,29 @@ redis interface.
6
6
Import `RedisRequires` in your charm by adding the following to `src/charm.py`:
6
Import `RedisRequires` in your charm by adding the following to `src/charm.py`:
7
7
```
7
```
8
8
from charms.redis_k8s.v0.redis import RedisRequires
8
from charms.redis_k8s.v0.redis import RedisRequires
11
9
9
```
12
10
# In your charm's `__init__` method.
10
And then in your charm's `__init__` method:
13
11
```
14
12
# Make sure you set redis_relation in StoredState. Assuming you refer to this
15
13
# as `self._stored`:
16
14
self._stored.set_default(redis_relation={})
17
11
self.redis = RedisRequires(self, self._stored)
15
self.redis = RedisRequires(self, self._stored)
18
12
```
16
```
20
13
And then wherever you need to reference the relation data:
17
And then wherever you need to reference the relation data it will be available
21
18
via StoredState:
22
14
```
19
```
23
20
redis_hosts = []
24
15
for redis_unit in self._stored.redis_relation:
21
for redis_unit in self._stored.redis_relation:
27
16
    redis_host = self._stored.redis_relation[redis_unit]["hostname"]
22
    redis_hosts.append({
28
17
    redis_port = self._stored.redis_relation[redis_unit]["port"]
23
        "redis-host": self._stored.redis_relation[redis_unit]["hostname"],
29
24
        "redis-port": self._stored.redis_relation[redis_unit]["port"],
30
25
    })
31
26
```
32
27
You will also need to add the following to `metadata.yaml`:
33
28
```
34
29
requires:
35
30
  redis:
36
31
    interface: redis
37
18
```
32
```
38
19
"""
33
"""
39
20
import logging
34
import logging
40
@@ -22,30 +36,31 @@ import logging
41
22
from ops.charm import CharmEvents
36
from ops.charm import CharmEvents
42
23
from ops.framework import EventBase, EventSource, Object
37
from ops.framework import EventBase, EventSource, Object
43
24
38
45
25
# The unique Charmhub library identifier, never change it
39
# The unique Charmhub library identifier, never change it.
46
26
LIBID = "fe18a608cec5465fa5153e419abcad7b"
40
LIBID = "fe18a608cec5465fa5153e419abcad7b"
47
27
41
49
28
# Increment this major API version when introducing breaking changes
42
# Increment this major API version when introducing breaking changes.
50
29
LIBAPI = 0
43
LIBAPI = 0
51
30
44
52
31
# Increment this PATCH version before using `charmcraft publish-lib` or reset
45
# Increment this PATCH version before using `charmcraft publish-lib` or reset
55
32
# to 0 if you are raising the major API version
46
# to 0 if you are raising the major API version.
56
33
LIBPATCH = 1
47
LIBPATCH = 2
57
34
48
58
35
logger = logging.getLogger(__name__)
49
logger = logging.getLogger(__name__)
59
36
50
60
37
51
61
38
class RedisRelationUpdatedEvent(EventBase):
52
class RedisRelationUpdatedEvent(EventBase):
63
39
    pass
53
    """An event for the redis relation having been updated."""
64
40
54
65
41
55
66
42
class RedisRelationCharmEvents(CharmEvents):
56
class RedisRelationCharmEvents(CharmEvents):
67
57
    """A class to carry custom charm events so requires can react to relation changes."""
68
43
    redis_relation_updated = EventSource(RedisRelationUpdatedEvent)
58
    redis_relation_updated = EventSource(RedisRelationUpdatedEvent)
69
44
59
70
45
60
71
46
class RedisRequires(Object):
61
class RedisRequires(Object):
72
47
    def __init__(self, charm, _stored):
62
    def __init__(self, charm, _stored):
74
48
        # Define a constructor that takes the charm and it's StoredState
63
        """A class implementing the redis requires relation."""
75
49
        super().__init__(charm, "redis")
64
        super().__init__(charm, "redis")
76
50
        self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
65
        self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
77
51
        self.framework.observe(charm.on.redis_relation_broken, self._on_relation_broken)
66
        self.framework.observe(charm.on.redis_relation_broken, self._on_relation_broken)
78
@@ -53,19 +68,20 @@ class RedisRequires(Object):
79
53
        self.charm = charm
68
        self.charm = charm
80
54
69
81
55
    def _on_relation_changed(self, event):
70
    def _on_relation_changed(self, event):
82
71
        """Handle the relation changed event."""
83
56
        if not event.unit:
72
        if not event.unit:
84
57
            return
73
            return
85
58
74
86
59
        hostname = event.relation.data[event.unit].get("hostname")
75
        hostname = event.relation.data[event.unit].get("hostname")
87
60
        port = event.relation.data[event.unit].get("port")
76
        port = event.relation.data[event.unit].get("port")
88
61
        # Store some data from the relation in local state
89
62
        self._stored.redis_relation[event.relation.id] = {"hostname": hostname, "port": port}
77
        self._stored.redis_relation[event.relation.id] = {"hostname": hostname, "port": port}
90
63
78
91
64
        # Trigger an event that our charm can react to.
79
        # Trigger an event that our charm can react to.
92
65
        self.charm.on.redis_relation_updated.emit()
80
        self.charm.on.redis_relation_updated.emit()
93
66
81
94
67
    def _on_relation_broken(self, event):
82
    def _on_relation_broken(self, event):
96
68
        # Remove the unit data from local state
83
        """Handle the relation broken event."""
97
84
        # Remove the unit data from local state.
98
69
        self._stored.redis_relation.pop(event.relation.id, None)
85
        self._stored.redis_relation.pop(event.relation.id, None)
99
70
86
100
71
        # Trigger an event that our charm can react to.
87
        # Trigger an event that our charm can react to.
101
@@ -74,23 +90,26 @@ class RedisRequires(Object):
102
74
90
103
75
class RedisProvides(Object):
91
class RedisProvides(Object):
104
76
    def __init__(self, charm, port):
92
    def __init__(self, charm, port):
105
93
        """A class implementing the redis provides relation."""
106
77
        super().__init__(charm, "redis")
94
        super().__init__(charm, "redis")
107
78
        self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
95
        self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
108
79
        self._port = port
96
        self._port = port
109
80
97
110
81
    def _on_relation_changed(self, event):
98
    def _on_relation_changed(self, event):
111
99
        """Handle the relation changed event."""
112
82
        if not self.model.unit.is_leader():
100
        if not self.model.unit.is_leader():
113
83
            logger.debug("Relation changes ignored by non-leader")
101
            logger.debug("Relation changes ignored by non-leader")
114
84
            return
102
            return
115
85
103
116
86
        event.relation.data[self.model.unit]['hostname'] = str(self._bind_address(event))
104
        event.relation.data[self.model.unit]['hostname'] = str(self._bind_address(event))
117
87
        event.relation.data[self.model.unit]['port'] = str(self._port)
105
        event.relation.data[self.model.unit]['port'] = str(self._port)
119
88
        # The reactive Redis charm exposes also 'password'. When tackling
106
        # The reactive Redis charm also exposes 'password'. When tackling
120
89
        # https://github.com/canonical/redis-operator/issues/7 add 'password'
107
        # https://github.com/canonical/redis-operator/issues/7 add 'password'
121
90
        # field so that it matches the exposed interface information from it.
108
        # field so that it matches the exposed interface information from it.
122
91
        # event.relation.data[self.unit]['password'] = ''
109
        # event.relation.data[self.unit]['password'] = ''
123
92
110
124
93
    def _bind_address(self, event):
111
    def _bind_address(self, event):
125
112
        """Convenience function for getting the unit address."""
126
94
        relation = self.model.get_relation(event.relation.name, event.relation.id)
113
        relation = self.model.get_relation(event.relation.name, event.relation.id)
127
95
        if address := self.model.get_binding(relation).network.bind_address:
114
        if address := self.model.get_binding(relation).network.bind_address:
128
96
            return address
115
            return address
129
diff --git a/tox.ini b/tox.ini
130
index d48b030..857a545 100644
131
--- a/tox.ini
132
+++ b/tox.ini
133
@@ -5,8 +5,6 @@ skip_missing_interpreters = True
134
5
5
135
6
[testenv]
6
[testenv]
136
7
basepython = python3
7
basepython = python3
137
8
setenv =
138
9
  PYTHONPATH = {toxinidir}/build/lib:{toxinidir}/build/venv
139
10
8
140
11
[testenv:unit]
9
[testenv:unit]
141
12
commands =
10
commands =
142
@@ -15,7 +13,7 @@ commands =
143
15
deps = -r{toxinidir}/tests/unit/requirements.txt
13
deps = -r{toxinidir}/tests/unit/requirements.txt
144
16
       -r{toxinidir}/requirements.txt
14
       -r{toxinidir}/requirements.txt
145
17
setenv =
15
setenv =
147
18
  PYTHONPATH={toxinidir}/src:{toxinidir}/build/lib:{toxinidir}/build/venv
16
  PYTHONPATH={toxinidir}/src:{toxinidir}/lib
148
19
  TZ=UTC
17
  TZ=UTC
149
20
18
150
21
[testenv:black]
19
[testenv:black]
151
@@ -32,4 +30,3 @@ exclude = .git, __pycache__, .tox,
152
32
ignore = E231
30
ignore = E231
153
33
max-line-length = 120
31
max-line-length = 120
154
34
max-complexity = 10
32
max-complexity = 10
155
35
Status:	Merged
Approved by:	Barry Price on 2021-11-23
Approved revision:	902dfd48f34c356618ef9da905fb2ca9ec4a119f
Merge reported by:	Barry Price
Merged at revision:	902dfd48f34c356618ef9da905fb2ca9ec4a119f
Proposed branch:	~barryprice/charm-k8s-discourse/+git/charm-k8s-discourse:v2.8.0.beta7-20.04
Merge into:	charm-k8s-discourse:v2.8.0.beta7-20.04
Diff against target:	155 lines (+34/-18) 2 files modified lib/charms/redis_k8s/v0/redis.py (+33/-14) tox.ini (+1/-4)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Tom Haddon		2021-10-29	Approve on 2021-11-02
🤖 prod-jenkaas-is (community)	continuous-integration		Needs Fixing on 2021-11-02
Canonical IS Reviewers		2021-10-29	Pending
Review via email: mp+411007@code.launchpad.net
1	diff --git a/lib/charms/redis_k8s/v0/redis.py b/lib/charms/redis_k8s/v0/redis.py
2	index 70787b6..5360ce0 100644
3	--- a/lib/charms/redis_k8s/v0/redis.py
4	+++ b/lib/charms/redis_k8s/v0/redis.py
5	@@ -6,15 +6,29 @@ redis interface.
6	6	Import `RedisRequires` in your charm by adding the following to `src/charm.py`:	6	Import `RedisRequires` in your charm by adding the following to `src/charm.py`:
7	7	```	7	```
8	8	from charms.redis_k8s.v0.redis import RedisRequires	8	from charms.redis_k8s.v0.redis import RedisRequires
11	9		9	```
12	10	# In your charm's `__init__` method.	10	And then in your charm's `__init__` method:
13			11	```
14			12	# Make sure you set redis_relation in StoredState. Assuming you refer to this
15			13	# as `self._stored`:
16			14	self._stored.set_default(redis_relation={})
17	11	self.redis = RedisRequires(self, self._stored)	15	self.redis = RedisRequires(self, self._stored)
18	12	```	16	```
20	13	And then wherever you need to reference the relation data:	17	And then wherever you need to reference the relation data it will be available
21			18	via StoredState:
22	14	```	19	```
23			20	redis_hosts = []
24	15	for redis_unit in self._stored.redis_relation:	21	for redis_unit in self._stored.redis_relation:
27	16	redis_host = self._stored.redis_relation[redis_unit]["hostname"]	22	redis_hosts.append({
28	17	redis_port = self._stored.redis_relation[redis_unit]["port"]	23	"redis-host": self._stored.redis_relation[redis_unit]["hostname"],
29			24	"redis-port": self._stored.redis_relation[redis_unit]["port"],
30			25	})
31			26	```
32			27	You will also need to add the following to `metadata.yaml`:
33			28	```
34			29	requires:
35			30	redis:
36			31	interface: redis
37	18	```	32	```
38	19	"""	33	"""
39	20	import logging	34	import logging
40	@@ -22,30 +36,31 @@ import logging
41	22	from ops.charm import CharmEvents	36	from ops.charm import CharmEvents
42	23	from ops.framework import EventBase, EventSource, Object	37	from ops.framework import EventBase, EventSource, Object
43	24		38
45	25	# The unique Charmhub library identifier, never change it	39	# The unique Charmhub library identifier, never change it.
46	26	LIBID = "fe18a608cec5465fa5153e419abcad7b"	40	LIBID = "fe18a608cec5465fa5153e419abcad7b"
47	27		41
49	28	# Increment this major API version when introducing breaking changes	42	# Increment this major API version when introducing breaking changes.
50	29	LIBAPI = 0	43	LIBAPI = 0
51	30		44
52	31	# Increment this PATCH version before using `charmcraft publish-lib` or reset	45	# Increment this PATCH version before using `charmcraft publish-lib` or reset
55	32	# to 0 if you are raising the major API version	46	# to 0 if you are raising the major API version.
56	33	LIBPATCH = 1	47	LIBPATCH = 2
57	34		48
58	35	logger = logging.getLogger(__name__)	49	logger = logging.getLogger(__name__)
59	36		50
60	37		51
61	38	class RedisRelationUpdatedEvent(EventBase):	52	class RedisRelationUpdatedEvent(EventBase):
63	39	pass	53	"""An event for the redis relation having been updated."""
64	40		54
65	41		55
66	42	class RedisRelationCharmEvents(CharmEvents):	56	class RedisRelationCharmEvents(CharmEvents):
67			57	"""A class to carry custom charm events so requires can react to relation changes."""
68	43	redis_relation_updated = EventSource(RedisRelationUpdatedEvent)	58	redis_relation_updated = EventSource(RedisRelationUpdatedEvent)
69	44		59
70	45		60
71	46	class RedisRequires(Object):	61	class RedisRequires(Object):
72	47	def __init__(self, charm, _stored):	62	def __init__(self, charm, _stored):
74	48	# Define a constructor that takes the charm and it's StoredState	63	"""A class implementing the redis requires relation."""
75	49	super().__init__(charm, "redis")	64	super().__init__(charm, "redis")
76	50	self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)	65	self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
77	51	self.framework.observe(charm.on.redis_relation_broken, self._on_relation_broken)	66	self.framework.observe(charm.on.redis_relation_broken, self._on_relation_broken)
78	@@ -53,19 +68,20 @@ class RedisRequires(Object):
79	53	self.charm = charm	68	self.charm = charm
80	54		69
81	55	def _on_relation_changed(self, event):	70	def _on_relation_changed(self, event):
82			71	"""Handle the relation changed event."""
83	56	if not event.unit:	72	if not event.unit:
84	57	return	73	return
85	58		74
86	59	hostname = event.relation.data[event.unit].get("hostname")	75	hostname = event.relation.data[event.unit].get("hostname")
87	60	port = event.relation.data[event.unit].get("port")	76	port = event.relation.data[event.unit].get("port")
88	61	# Store some data from the relation in local state
89	62	self._stored.redis_relation[event.relation.id] = {"hostname": hostname, "port": port}	77	self._stored.redis_relation[event.relation.id] = {"hostname": hostname, "port": port}
90	63		78
91	64	# Trigger an event that our charm can react to.	79	# Trigger an event that our charm can react to.
92	65	self.charm.on.redis_relation_updated.emit()	80	self.charm.on.redis_relation_updated.emit()
93	66		81
94	67	def _on_relation_broken(self, event):	82	def _on_relation_broken(self, event):
96	68	# Remove the unit data from local state	83	"""Handle the relation broken event."""
97			84	# Remove the unit data from local state.
98	69	self._stored.redis_relation.pop(event.relation.id, None)	85	self._stored.redis_relation.pop(event.relation.id, None)
99	70		86
100	71	# Trigger an event that our charm can react to.	87	# Trigger an event that our charm can react to.
101	@@ -74,23 +90,26 @@ class RedisRequires(Object):
102	74		90
103	75	class RedisProvides(Object):	91	class RedisProvides(Object):
104	76	def __init__(self, charm, port):	92	def __init__(self, charm, port):
105			93	"""A class implementing the redis provides relation."""
106	77	super().__init__(charm, "redis")	94	super().__init__(charm, "redis")
107	78	self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)	95	self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
108	79	self._port = port	96	self._port = port
109	80		97
110	81	def _on_relation_changed(self, event):	98	def _on_relation_changed(self, event):
111			99	"""Handle the relation changed event."""
112	82	if not self.model.unit.is_leader():	100	if not self.model.unit.is_leader():
113	83	logger.debug("Relation changes ignored by non-leader")	101	logger.debug("Relation changes ignored by non-leader")
114	84	return	102	return
115	85		103
116	86	event.relation.data[self.model.unit]['hostname'] = str(self._bind_address(event))	104	event.relation.data[self.model.unit]['hostname'] = str(self._bind_address(event))
117	87	event.relation.data[self.model.unit]['port'] = str(self._port)	105	event.relation.data[self.model.unit]['port'] = str(self._port)
119	88	# The reactive Redis charm exposes also 'password'. When tackling	106	# The reactive Redis charm also exposes 'password'. When tackling
120	89	# https://github.com/canonical/redis-operator/issues/7 add 'password'	107	# https://github.com/canonical/redis-operator/issues/7 add 'password'
121	90	# field so that it matches the exposed interface information from it.	108	# field so that it matches the exposed interface information from it.
122	91	# event.relation.data[self.unit]['password'] = ''	109	# event.relation.data[self.unit]['password'] = ''
123	92		110
124	93	def _bind_address(self, event):	111	def _bind_address(self, event):
125			112	"""Convenience function for getting the unit address."""
126	94	relation = self.model.get_relation(event.relation.name, event.relation.id)	113	relation = self.model.get_relation(event.relation.name, event.relation.id)
127	95	if address := self.model.get_binding(relation).network.bind_address:	114	if address := self.model.get_binding(relation).network.bind_address:
128	96	return address	115	return address
129	diff --git a/tox.ini b/tox.ini
130	index d48b030..857a545 100644
131	--- a/tox.ini
132	+++ b/tox.ini
133	@@ -5,8 +5,6 @@ skip_missing_interpreters = True
134	5		5
135	6	[testenv]	6	[testenv]
136	7	basepython = python3	7	basepython = python3
137	8	setenv =
138	9	PYTHONPATH = {toxinidir}/build/lib:{toxinidir}/build/venv
139	10		8
140	11	[testenv:unit]	9	[testenv:unit]
141	12	commands =	10	commands =
142	@@ -15,7 +13,7 @@ commands =
143	15	deps = -r{toxinidir}/tests/unit/requirements.txt	13	deps = -r{toxinidir}/tests/unit/requirements.txt
144	16	-r{toxinidir}/requirements.txt	14	-r{toxinidir}/requirements.txt
145	17	setenv =	15	setenv =
147	18	PYTHONPATH={toxinidir}/src:{toxinidir}/build/lib:{toxinidir}/build/venv	16	PYTHONPATH={toxinidir}/src:{toxinidir}/lib
148	19	TZ=UTC	17	TZ=UTC
149	20		18
150	21	[testenv:black]	19	[testenv:black]
151	@@ -32,4 +30,3 @@ exclude = .git, __pycache__, .tox,
152	32	ignore = E231	30	ignore = E231
153	33	max-line-length = 120	31	max-line-length = 120
154	34	max-complexity = 10	32	max-complexity = 10
155	35