Merge charm-grafana:dashboard-json into charm-grafana:master

[Joe Guo]

Fix LP1897843: support non-wrapped JSON data and keep backward compatibility

Currently this charm requires dashboard JSON data be wrapped like this:

    {
        "dashbaord": {<real dashboard JSON data>},
        "overwrite": true,
        "folderId": 1
    }

Actually this is a misuse of the grafana rest api structure.
Dashboard JSON data should include the real data directly.
Refer to LP1897843 for details.

This patch make the code support both formats.
Since most of our dashboard JSON file followed the wrong pattern, we
have to keep backward compatibility until grafana charm upgraded in all clouds.

LP: #1897843

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

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

[James Hebden (ec0)]

See comments inline

review: Needs Fixing

[Joe Guo (guoqiao)]

log removed and re-pushed.

[James Hebden (ec0)]

LGTM

review: Approve

[Adam Dyess (addyess)]

LGTM2

review: Approve

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

Change successfully merged at revision 239f891810ed9f7afee1c28de74967aa1b4c6bd8

diff --git a/src/lib/charms/layer/grafana.py b/src/lib/charms/layer/grafana.py
index ecd8c69..009c812 100644
--- a/src/lib/charms/layer/grafana.py
+++ b/src/lib/charms/layer/grafana.py
@@ -132,7 +132,7 @@ def post_dashboard(name, dashboard):
         )
 
 
-def import_dashboard(dashboard, remote_app=None, name=None):
+def import_dashboard(dashboard, remote_app=None, name=None, overwrite=True):
     """Process and import a dashboard.
 
     Will update dashboard title if the dashboard is provided over a remote
@@ -146,16 +146,34 @@ def import_dashboard(dashboard, remote_app=None, name=None):
     :param remote_app: name of remote app for dashes provided over relation
     :param remote_model: if dash is provided over CMR, name of remote model
     :param name: dash internal name
+    :param overwrite: if True, overwrite existing dashboard with same id
     :return: None
     """
-    dashboard["dashboard"]["title"] = compute_dash_title(
-        dashboard["dashboard"].get("title"), remote_app
-    )
+    if "dashboard" in dashboard:
+        # bug LP1897843: dashboard json data is wrapped in {"dashboard": {<data>}}
+        dashboard["dashboard"]["title"] = compute_dash_title(
+            dashboard["dashboard"].get("title"), remote_app
+        )
 
-    dashboard["folderId"] = ensure_and_get_dash_folder(dashboard.get("source_model"))
-    if name is None:
-        name = dashboard["dashboard"].get("title") or "Untitled"
-    return post_dashboard(name, dashboard)
+        dashboard["folderId"] = ensure_and_get_dash_folder(
+            dashboard.get("source_model")
+        )
+        if name is None:
+            name = dashboard["dashboard"].get("title") or "Untitled"
+        return post_dashboard(name, dashboard)
+    else:
+        # correct data
+        dashboard["title"] = compute_dash_title(dashboard.get("title"), remote_app)
+
+        folder_id = ensure_and_get_dash_folder(dashboard.get("source_model"))
+        data = {
+            "dashboard": dashboard,
+            "folderId": folder_id,
+            "overwrite": overwrite,
+        }
+        if name is None:
+            name = dashboard.get("title") or "Untitled"
+        return post_dashboard(name, data)
 
 
 def get_cmd_output(cmd, shell=False):
diff --git a/src/wheelhouse.txt b/src/wheelhouse.txt
index ffdadef..ebe0ec6 100644
--- a/src/wheelhouse.txt
+++ b/src/wheelhouse.txt
@@ -1,2 +1,3 @@
+setuptools
 requests
 jsondiff