-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathtest_charm.py
453 lines (373 loc) · 16.7 KB
/
test_charm.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
# Copyright 2020 Canonical Ltd.
# See LICENSE file for licensing details.
import hashlib
import json
import re
import unittest
from unittest.mock import MagicMock, PropertyMock, patch
import ops
import yaml
from ops.testing import Harness
import grafana_client
from charm import CONFIG_PATH, DATASOURCES_PATH, PROVISIONING_PATH, GrafanaCharm
ops.testing.SIMULATE_CAN_CONNECT = True
MINIMAL_CONFIG = {"grafana-image-path": "grafana/grafana", "port": 3000}
MINIMAL_DATASOURCES_CONFIG = {
"apiVersion": 1,
"datasources": [],
"deleteDatasources": [],
}
BASIC_DATASOURCES = [
{
"access": "proxy",
"isDefault": "false",
"name": "juju_test-model_abcdef_prometheus_0",
"orgId": "1",
"type": "prometheus",
"url": "http://1.2.3.4:1234",
"jsonData": {"timeout": 300},
}
]
SOURCE_DATA = {
"model": "test-model",
"model_uuid": "abcdef",
"application": "prometheus",
"type": "prometheus",
}
DASHBOARD_CONFIG = {
"apiVersion": 1,
"providers": [
{
"name": "Default",
"updateIntervalSeconds": "5",
"type": "file",
"options": {"path": "/etc/grafana/provisioning/dashboards"},
}
],
}
DB_CONFIG = {
"type": "mysql",
"host": "1.1.1.1:3306",
"name": "mysqldb",
"user": "grafana",
"password": "grafana",
}
DATABASE_CONFIG_INI = """[database]
type = mysql
host = 1.1.1.1:3306
name = mysqldb
user = grafana
password = grafana
url = mysql://grafana:grafana@1.1.1.1:3306/mysqldb
"""
AUTH_PROVIDER_APPLICATION = "auth_provider"
def datasource_config(config):
config_dict = yaml.safe_load(config)
return config_dict
def dashboard_config(config):
config_dict = yaml.safe_load(config)
return config_dict
def global_config(config):
config_dict = yaml.safe_load(config)
return config_dict["global"]
def cli_arg(plan, cli_opt):
plan_dict = plan.to_dict()
args = plan_dict["services"]["grafana"]["command"].split()
for arg in args:
opt_list = arg.split("=")
if len(opt_list) == 2 and opt_list[0] == cli_opt:
return opt_list[1]
if len(opt_list) == 1 and opt_list[0] == cli_opt:
return opt_list[0]
return None
k8s_resource_multipatch = patch.multiple(
"charm.KubernetesComputeResourcesPatch",
_namespace="test-namespace",
_patch=lambda *a, **kw: True,
is_ready=lambda *a, **kw: True,
)
class BaseTestCharm(unittest.TestCase):
def setUp(self, *unused):
self.harness = Harness(GrafanaCharm)
self.addCleanup(self.harness.cleanup)
for p in [
patch("lightkube.core.client.GenericSyncClient"),
patch("socket.getfqdn", new=lambda *args: "grafana-k8s-0.testmodel.svc.cluster.local"),
patch("socket.gethostbyname", new=lambda *args: "1.2.3.4"),
k8s_resource_multipatch,
patch.object(GrafanaCharm, "grafana_version", "0.1.0"),
patch("ops.testing._TestingModelBackend.network_get"),
patch("ops.testing._TestingPebbleClient.exec", MagicMock()),
]:
p.start()
self.addCleanup(p.stop)
self.harness.set_model_name("testmodel")
self.harness.add_relation("grafana", "grafana-k8s")
self.grafana_auth_rel_id = self.harness.add_relation(
"grafana-auth", AUTH_PROVIDER_APPLICATION
)
self.harness.begin_with_initial_hooks()
self.harness.container_pebble_ready("grafana")
self.minimal_datasource_hash = hashlib.sha256(
str(yaml.dump(MINIMAL_DATASOURCES_CONFIG)).encode("utf-8")
).hexdigest()
class TestCharm(BaseTestCharm):
def test_datasource_config_is_updated_by_raw_grafana_source_relation(self):
self.harness.set_leader(True)
# check datasource config is updated when a grafana-source joins
rel_id = self.harness.add_relation("grafana-source", "prometheus")
self.harness.update_relation_data(
rel_id, "prometheus", {"grafana_source_data": json.dumps(SOURCE_DATA)}
)
self.harness.add_relation_unit(rel_id, "prometheus/0")
self.harness.update_relation_data(
rel_id, "prometheus/0", {"grafana_source_host": "1.2.3.4:1234"}
)
config = self.harness.charm.containers["workload"].pull(DATASOURCES_PATH)
self.assertEqual(yaml.safe_load(config).get("datasources"), BASIC_DATASOURCES)
def test_datasource_config_is_updated_by_grafana_source_removal(self):
self.harness.set_leader(True)
rel_id = self.harness.add_relation("grafana-source", "prometheus")
self.harness.update_relation_data(
rel_id, "prometheus", {"grafana_source_data": json.dumps(SOURCE_DATA)}
)
self.harness.add_relation_unit(rel_id, "prometheus/0")
self.harness.update_relation_data(
rel_id, "prometheus/0", {"grafana_source_host": "1.2.3.4:1234"}
)
config = self.harness.charm.containers["workload"].pull(DATASOURCES_PATH)
self.assertEqual(yaml.safe_load(config).get("datasources"), BASIC_DATASOURCES)
rel = self.harness.charm.framework.model.get_relation("grafana-source", rel_id) # type: ignore
self.harness.charm.on["grafana-source"].relation_departed.emit(rel)
config = yaml.safe_load(self.harness.charm.containers["workload"].pull(DATASOURCES_PATH))
self.assertEqual(config.get("datasources"), [])
self.assertEqual(
config.get("deleteDatasources"),
[{"name": "juju_test-model_abcdef_prometheus_0", "orgId": 1}],
)
def test_config_is_updated_with_database_relation(self):
self.harness.set_leader(True)
rel_id = self.harness.add_relation("database", "mysql")
self.harness.add_relation_unit(rel_id, "mysql/0")
self.harness.update_relation_data(
rel_id,
"mysql",
DB_CONFIG,
)
config = self.harness.charm.containers["workload"].pull(CONFIG_PATH)
self.assertEqual(config.read(), DATABASE_CONFIG_INI)
def test_dashboard_path_is_initialized(self):
self.harness.set_leader(True)
self.harness.charm.init_dashboard_provisioning(PROVISIONING_PATH + "/dashboards")
dashboards_dir_path = PROVISIONING_PATH + "/dashboards/default.yaml"
config = self.harness.charm.containers["workload"].pull(dashboards_dir_path)
self.assertEqual(yaml.safe_load(config), DASHBOARD_CONFIG)
def test_can_get_password(self):
self.harness.set_leader(True)
# Harness doesn't quite support actions yet...
self.assertTrue(re.match(r"[A-Za-z0-9]{12}", self.harness.charm._get_admin_password()))
@patch("grafana_client.Grafana.is_ready", new_callable=PropertyMock)
def test_sane_message_for_password_when_grafana_down(self, mock_ready):
mock_ready.return_value = False
event = MagicMock()
self.harness.charm._on_get_admin_password(event)
event.fail.assert_called_with(
"Grafana is not reachable yet. Please try again in a few minutes"
)
@patch("grafana_client.Grafana.password_has_been_changed")
@patch("grafana_client.Grafana.is_ready", new_callable=PropertyMock)
def test_returns_password_changed_message(self, mock_ready, mock_pw_changed):
mock_ready.return_value = True
mock_pw_changed.return_value = True
event = MagicMock()
self.harness.charm._on_get_admin_password(event)
event.set_results.assert_called_with(
{
"url": "http://grafana-k8s-0.testmodel.svc.cluster.local:3000",
"admin-password": "Admin password has been changed by an administrator",
}
)
def test_datasource_timeout_value_overrides_config_if_larger(self):
self.harness.set_leader(True)
# set relation data with timeout value larger than default
rel_id = self.harness.add_relation("grafana-source", "prometheus")
source_data = SOURCE_DATA.copy()
source_data["extra_fields"] = {"timeout": 600}
self.harness.update_relation_data(
rel_id, "prometheus", {"grafana_source_data": json.dumps(source_data)}
)
self.harness.add_relation_unit(rel_id, "prometheus/0")
self.harness.update_relation_data(
rel_id, "prometheus/0", {"grafana_source_host": "1.2.3.4:1234"}
)
config = self.harness.charm.containers["workload"].pull(DATASOURCES_PATH)
expected_source_data = BASIC_DATASOURCES.copy()
expected_source_data[0]["jsonData"]["timeout"] = 600
self.assertEqual(yaml.safe_load(config).get("datasources"), expected_source_data)
def test_datasource_timeout_value_is_overridden_by_config_if_smaller(self):
self.harness.set_leader(True)
# set relation data with timeout value smaller than default
rel_id = self.harness.add_relation("grafana-source", "prometheus")
source_data = SOURCE_DATA.copy()
source_data["extra_fields"] = {"timeout": 200}
self.harness.update_relation_data(
rel_id, "prometheus", {"grafana_source_data": json.dumps(source_data)}
)
self.harness.add_relation_unit(rel_id, "prometheus/0")
self.harness.update_relation_data(
rel_id, "prometheus/0", {"grafana_source_host": "1.2.3.4:1234"}
)
config = self.harness.charm.containers["workload"].pull(DATASOURCES_PATH)
expected_source_data = BASIC_DATASOURCES.copy()
expected_source_data[0]["jsonData"]["timeout"] = 300
self.assertEqual(yaml.safe_load(config).get("datasources"), expected_source_data)
def test_workload_version_is_set(self):
self.harness.container_pebble_ready("grafana")
self.assertEqual(self.harness.get_workload_version(), "0.1.0")
@patch.object(grafana_client.Grafana, "build_info", new={"version": "1.0.0"})
def test_bare_charm_has_no_subpath_set_in_layer(self):
self.harness.set_leader(True)
layer = self.harness.charm._build_layer()
self.assertEqual(
layer.to_dict()["services"]["grafana"]["environment"]["GF_SERVER_ROOT_URL"],
"http://grafana-k8s-0.testmodel.svc.cluster.local:3000",
)
@patch.object(grafana_client.Grafana, "build_info", new={"version": "1.0.0"})
@patch.multiple("charm.TraefikRouteRequirer", external_host="1.2.3.4", scheme="http")
def test_ingress_relation_sets_options_and_rel_data(self):
self.harness.set_leader(True)
self.harness.container_pebble_ready("grafana")
rel_id = self.harness.add_relation("ingress", "traefik")
self.harness.add_relation_unit(rel_id, "traefik/0")
services = (
self.harness.charm.containers["workload"].get_plan().services["grafana"].to_dict()
)
self.assertIn("GF_SERVER_SERVE_FROM_SUB_PATH", services["environment"].keys())
self.assertIn("GF_SERVER_ROOT_URL", services["environment"].keys())
expected_rel_data = {
"http": {
"middlewares": {
"juju-sidecar-noprefix-testmodel-grafana-k8s": {
"stripPrefix": {
"forceSlash": False,
"prefixes": ["/testmodel-grafana-k8s"],
}
}
},
"routers": {
"juju-testmodel-grafana-k8s-router": {
"entryPoints": ["web"],
"middlewares": ["juju-sidecar-noprefix-testmodel-grafana-k8s"],
"rule": "PathPrefix(`/testmodel-grafana-k8s`)",
"service": "juju-testmodel-grafana-k8s-service",
},
"juju-testmodel-grafana-k8s-router-tls": {
"entryPoints": ["websecure"],
"middlewares": ["juju-sidecar-noprefix-testmodel-grafana-k8s"],
"rule": "PathPrefix(`/testmodel-grafana-k8s`)",
"service": "juju-testmodel-grafana-k8s-service",
"tls": {"domains": [{"main": "1.2.3.4", "sans": ["*.1.2.3.4"]}]},
},
},
"services": {
"juju-testmodel-grafana-k8s-service": {
"loadBalancer": {
"servers": [
{"url": "http://grafana-k8s-0.testmodel.svc.cluster.local:3000"}
]
}
}
},
}
}
rel_data = self.harness.get_relation_data(rel_id, self.harness.charm.app.name)
# The insanity of YAML here. It works for the lib, but a single load just strips off
# the extra quoting and leaves regular YAML. Double parse it for the tests
self.maxDiff = None
self.assertEqual(yaml.safe_load(rel_data["config"]), expected_rel_data)
self.assertEqual(self.harness.charm.external_url, "http://1.2.3.4/testmodel-grafana-k8s")
def test_config_is_updated_with_authentication_config(self):
self.harness.set_leader(True)
self.harness.container_pebble_ready("grafana")
example_auth_conf = {
"proxy": {
"enabled": True,
"header_name": "X-WEBAUTH-USER",
"header_property": "email",
"auto_sign_up": False,
"sync_ttl": 10,
}
}
self.harness.update_relation_data(
self.grafana_auth_rel_id,
AUTH_PROVIDER_APPLICATION,
{"auth": json.dumps(example_auth_conf)},
)
services = (
self.harness.charm.containers["workload"].get_plan().services["grafana"].to_dict()
)
self.assertIn("GF_AUTH_PROXY_ENABLED", services["environment"].keys())
self.assertEqual(services["environment"]["GF_AUTH_PROXY_ENABLED"], "True")
class TestCharmReplication(unittest.TestCase):
def setUp(self, *unused):
self.harness = Harness(GrafanaCharm)
self.addCleanup(self.harness.cleanup)
for p in [
patch("lightkube.core.client.GenericSyncClient"),
k8s_resource_multipatch,
patch.object(GrafanaCharm, "grafana_version", "0.1.0"),
patch("ops.testing._TestingPebbleClient.exec", MagicMock()),
]:
p.start()
self.addCleanup(p.stop)
self.harness.add_relation("grafana-auth", AUTH_PROVIDER_APPLICATION)
self.harness.add_relation("grafana", "grafana-k8s")
self.harness.set_leader(True)
self.minimal_datasource_hash = hashlib.sha256(
str(yaml.dump(MINIMAL_DATASOURCES_CONFIG)).encode("utf-8")
).hexdigest()
@patch("socket.getfqdn", lambda: "1.2.3.4")
@patch("ops.testing._TestingModelBackend.network_get")
def test_primary_sets_correct_peer_data(self, mock_unit_ip):
fake_network = {
"bind-addresses": [
{
"interface-name": "eth0",
"addresses": [{"hostname": "grafana-0", "value": "1.2.3.4"}],
}
]
}
mock_unit_ip.return_value = fake_network
self.harness.begin_with_initial_hooks()
self.harness.container_pebble_ready("grafana")
self.harness.container_pebble_ready("litestream")
self.harness.charm.on.config_changed.emit()
rel = self.harness.model.get_relation("grafana")
self.harness.add_relation_unit(rel.id, "grafana-k8s/1")
unit_ip = str(self.harness.charm.model.get_binding("grafana").network.bind_address)
replica_address = self.harness.charm.get_peer_data("replica_primary")
self.assertEqual(unit_ip, replica_address)
@patch("socket.getfqdn", lambda: "2.3.4.5")
@patch("ops.testing._TestingModelBackend.network_get")
def test_replicas_get_correct_environment_variables(self, mock_unit_ip):
fake_network = {
"bind-addresses": [
{
"interface-name": "eth0",
"addresses": [{"hostname": "grafana-0", "value": "2.3.4.5"}],
}
]
}
mock_unit_ip.return_value = fake_network
self.harness.begin_with_initial_hooks()
self.harness.container_pebble_ready("grafana")
self.harness.container_pebble_ready("litestream")
rel = self.harness.model.get_relation("grafana")
self.harness.add_relation_unit(rel.id, "grafana-k8s/1")
self.harness.update_relation_data(
rel.id, "grafana-k8s", {"replica_primary": json.dumps("1.2.3.4")}
)
primary = self.harness.charm._build_replication(False).to_dict()["services"]["litestream"][
"environment"
]["LITESTREAM_UPSTREAM_URL"]
self.assertEqual(primary, "1.2.3.4:9876")