Merge ~lihuiguo/charm-nagios:bug/1945723 into charm-nagios:master

[Linda Guo]

add registration relation to register nagios to Homer dashboard[1]

[1] https://launchpad.net/charm-homer-dashboard

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

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

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:0bc176675b599f38941710a50887771f86282e65
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/35/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/143/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/537/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/35//rebuild

review: Approve (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:13f56a864cbf14ba5711e05afd9aff38beb42075
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/36/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/145/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/542/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/36//rebuild

review: Approve (continuous-integration)

[James Troup (elmo)]

As discussed, let's please come up with clearer relation/interface names (e.g. 'application-dashboard' and 'register-application').

Other comments inline.

review: Needs Fixing

[Linda Guo (lihuiguo)]

updated the code according to the review comments

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:ab45216a4d0e74603ad9f3eb2932cc63568ecc61
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/37/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/147/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/555/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/37//rebuild

review: Approve (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:d31671415a99a6d923190d00f83f3a3347d4866f
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/38/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/150/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/557/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-nagios-ci/38//rebuild

review: Approve (continuous-integration)

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

Change successfully merged at revision 9ad5dc8672b4d2fec83d92e6fdbd2c97eb5b0d9d

diff --git a/config.yaml b/config.yaml
index 765d70b..0739d64 100644
--- a/config.yaml
+++ b/config.yaml
@@ -355,3 +355,7 @@ options:
             - name: snmp_collector
               host: /path/to/snmp/helper ....
               service: /path/to/snmp/helper ....
+    site_name:
+        type: string
+        default: ''
+        description: An unique site name for Nagios deployment
\ No newline at end of file
diff --git a/hooks/application-dashboard-relation-changed b/hooks/application-dashboard-relation-changed
new file mode 120000
index 0000000..a13f386
--- /dev/null
+++ b/hooks/application-dashboard-relation-changed
@@ -0,0 +1 @@
+application_dashboard_relation.py
\ No newline at end of file
diff --git a/hooks/application-dashboard-relation-joined b/hooks/application-dashboard-relation-joined
new file mode 120000
index 0000000..a13f386
--- /dev/null
+++ b/hooks/application-dashboard-relation-joined
@@ -0,0 +1 @@
+application_dashboard_relation.py
\ No newline at end of file
diff --git a/hooks/application_dashboard_relation.py b/hooks/application_dashboard_relation.py
new file mode 100755
index 0000000..54a9596
--- /dev/null
+++ b/hooks/application_dashboard_relation.py
@@ -0,0 +1,75 @@
+#!/usr/bin/python
+# Copyright Canonical 2021 Canonical Ltd. All Rights Reserved
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+import os
+import sys
+
+from charmhelpers.core.hookenv import (
+    Hooks,
+    UnregisteredHookError,
+    config,
+    is_leader,
+    log,
+    relation_ids,
+    relation_set,
+    unit_public_ip,
+)
+
+hooks = Hooks()
+
+
[e-mail]("config-changed")
[e-mail]("application-dashboard-relation-joined")
[e-mail]("application-dashboard-relation-changed")
+def application_dashboard_relation_changed(relation_id=None, remote_unit=None):
+    """Register Nagios URL in dashboard charm such as Homer."""
+    if not is_leader():
+        return
+    relations = relation_ids("application-dashboard")
+    if not relations:
+        return
+    tls_configured = config("ssl_key")
+    scheme = "https://" if tls_configured else "http://"
+    url = scheme + unit_public_ip()
+    if config("site_name"):
+        subtitle = "[{}] Monitoring and alerting".format(config("site_name"))
+        group = "[{}] LMA".format(config("site_name"))
+    else:
+        subtitle = "Monitoring and alerting"
+        group = "LMA"
+    icon_file = os.environ.get("JUJU_CHARM_DIR", None) + "/icon.svg"
+    icon_data = None
+    if os.path.exists(icon_file):
+        with open(icon_file) as f:
+            icon_data = f.read()
+    for rid in relations:
+        relation_set(
+            rid,
+            app=True,
+            relation_settings={
+                "name": "Nagios",
+                "url": url,
+                "subtitle": subtitle,
+                "icon": icon_data,
+                "group": group,
+            },
+        )
+
+
+if __name__ == "__main__":
+    try:
+        hooks.execute(sys.argv)
+    except UnregisteredHookError as e:
+        log("Unknown hook {} - skipping.".format(e))
diff --git a/hooks/upgrade_charm.py b/hooks/upgrade_charm.py
index 32f6613..816d41d 100755
--- a/hooks/upgrade_charm.py
+++ b/hooks/upgrade_charm.py
@@ -20,6 +20,8 @@ except ImportError:
         "DEBIAN_FRONTEND=noninteractive apt-get -qy install python-enum34", shell=True
     )
 
+from application_dashboard_relation import application_dashboard_relation_changed
+
 from charmhelpers import fetch
 from charmhelpers.contrib import ssl
 from charmhelpers.core import hookenv, host
@@ -678,6 +680,7 @@ update_cgi_config()
 update_contacts()
 update_password("nagiosro", ro_password)
 configure_livestatus_xinetd()
+application_dashboard_relation_changed()
 
 if password:
     update_password(nagiosadmin, password)
diff --git a/metadata.yaml b/metadata.yaml
index 21ceda1..e89c497 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -16,5 +16,7 @@ requires:
     interface: juju-info
   monitors:
     interface: monitors
+  application-dashboard:
+    interface: register-application
 extra-bindings:
   public:
diff --git a/tests/unit/test_registration_relation_joined.py b/tests/unit/test_registration_relation_joined.py
new file mode 100644
index 0000000..0161f47
--- /dev/null
+++ b/tests/unit/test_registration_relation_joined.py
@@ -0,0 +1,39 @@
+import application_dashboard_relation
+
+import mock
+
+
[e-mail]("application_dashboard_relation.relation_set")
[e-mail]("application_dashboard_relation.unit_public_ip")
[e-mail]("application_dashboard_relation.is_leader")
[e-mail]("application_dashboard_relation.relation_ids")
[e-mail]("application_dashboard_relation.config")
[e-mail]("os.environ.get")
+def test_main(
+    environ_get, config, relation_ids, is_leader, unit_public_ip, relation_set
+):
+    hostname = "nagios.com"
+    unit_public_ip.return_value = hostname
+    relation_id = "application-dashboard:0"
+    environ_get.return_value = ""
+    relation_ids.return_value = relation_id
+    site_name = "test"
+    config.return_value = site_name
+    application_dashboard_relation.application_dashboard_relation_changed()
+    subtitle = "[{}] Monitoring and alerting".format(site_name)
+    group = "[{}] LMA".format(site_name)
+    name = "Nagios"
+    tls_configured = config("ssl_key")
+    scheme = "https" if tls_configured else "http"
+
+    relation_set.assert_called_with(
+        "0",
+        app=True,
+        relation_settings={
+            "name": name,
+            "url": "{}://{}".format(scheme, hostname),
+            "subtitle": subtitle,
+            "icon": None,
+            "group": group,
+        },
+    )