Merge ~canonical-is-bootstack/charm-grafana:bug/1876327 into charm-grafana:master

[Alvaro Uria]

Fix grafana-dashboards deserialization

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Alvaro Uria (aluria)]

Manually tested in the charmlab and works as expected. Functional tests can't be included because the prometheus-libvirt-exporter fix is not merged yet.

[Xav Paice (xavpaice)]

LGTM. Not sure I follow the comment on the prometheus-libvirt-exporter fix, but functional tests on master aren't working for me due to the bundle not being found (environment vars need fixing).

review: Approve

[Alvaro Uria (aluria)]

Sorry, by "Functional tests can't be included because the prometheus-libvirt-exporter fix is not merged yet" I meant that the MP lacks for a test case regarding this fix.

The reason is that the only project that supports the grafana-dashboard interface in the LMA stack (maintained by BootStack) is prometheus-libvirt-exporter. However that project has a MP pending to include a dashboard (the one that would be shared with Grafana when the "grafana-dashboard" interface is used).

[Alvaro Uria (aluria)]

Regarding func tests not working for you, in tests/functional/test_deploy.py, there is a snippet:
"""
CHARM_BUILD_DIR = os.getenv('CHARM_BUILD_DIR')
JUJU_REPOSITORY = os.getenv('JUJU_REPOSITORY')
if CHARM_BUILD_DIR is not None:
    GRAFANA_BUILD_DIR = os.path.join(CHARM_BUILD_DIR.rstrip('/'), "grafana")
elif JUJU_REPOSITORY is not None:
    GRAFANA_BUILD_DIR = os.path.join(JUJU_REPOSITORY.rstrip('/'), "builds", "grafana")
else:
    GRAFANA_BUILD_DIR = "/tmp/charm-builds/grafana"
BUNDLE_PATH = os.path.join(GRAFANA_BUILD_DIR, "..", "bundle.yaml")
OVERLAY_PATH = os.path.join(GRAFANA_BUILD_DIR, "..", "overlay.yaml")
"""

"charm build" from charmtools uses /tmp/charm-builds/grafana when no env var is found. Please paste here the failure or file a bug and I will look into it.

Thank you.

[Xav Paice (xavpaice)]

the tests not working for me was down to env vars- the change from JUJU_REPOSITORY to CHARM_BUILD_DIR - it might be good in a future change to tidy that and remove all references to the JUJU_REPOSITORY, but if there's no errors with those vars (like there was in my env) then it's fine for now.

[Alvaro Uria (aluria)]

Now, both prometheus-libvirt-exporter and telegraf support the grafana-dashboards interface. This fix has been tested together with those charms and dashboards are loaded as expected.

diff --git a/metadata.yaml b/metadata.yaml
index 54efd4f..fac2022 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -5,8 +5,8 @@ description: |
    Grafana is the leading graph and dashboard builder for visualizing
    time series metrics.
 series:
-  - bionic
   - focal
+  - bionic
   - xenial
 tags:
   - misc
diff --git a/reactive/grafana.py b/reactive/grafana.py
index 303b10e..c324b41 100644
--- a/reactive/grafana.py
+++ b/reactive/grafana.py
@@ -888,5 +888,16 @@ def hpwgen(passwd, salt):
       'endpoint.dashboards.requests')
 def import_dashboards(dashboards):
     for request in dashboards.new_requests:
-        success, reason = import_dashboard(request.dashboard, request.name)
+        try:
+            dash = request.dashboard
+            if isinstance(request.dashboard, str):
+                dash = json.loads(request.dashboard)
+            success, reason = import_dashboard(dash, request.name)
+        except json.decoder.JSONDecodeError as error:
+            success, reason = False, str(error)
+
+        hookenv.log(
+            "import_dashboards via grafana-dashboards: {} [{}]".format(success, reason),
+            hookenv.DEBUG,
+        )
         request.respond(success, reason)