Merge ~hloeung/ubuntu-repository-cache:master into ubuntu-repository-cache:master

[Haw Loeung]

Include cloud name in u-r-c cron emails

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

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

[James Simpson (jsimpso)]

LGTM

review: Approve

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

Change successfully merged at revision f0c23229db01e90e52bba9ac3f660117d645229a

diff --git a/lib/ubuntu_repository_cache/service.py b/lib/ubuntu_repository_cache/service.py
index 615c407..c6cec42 100644
--- a/lib/ubuntu_repository_cache/service.py
+++ b/lib/ubuntu_repository_cache/service.py
@@ -291,6 +291,7 @@ def render_configs():
     cron_context['MirrorSeries'] = config['mirror-series'].strip()
     cron_context['ConfigPath'] = urc_config_path
     cron_context['CharmEnvPath'] = os.path.join(hookenv.charm_dir(), 'bin', 'charm-env')
+    cron_context['Cloud'] = util.get_cloud_name()
     # Add Juju model name  and AZ so it's easier to work out which region sent out cron emails.
     cron_context['JujuModelName'] = os.environ.get('JUJU_MODEL_NAME')
     cron_context['JujuAvailabilityZone'] = os.environ.get('JUJU_AVAILABILITY_ZONE')
diff --git a/lib/ubuntu_repository_cache/util.py b/lib/ubuntu_repository_cache/util.py
index 297a297..c90817c 100644
--- a/lib/ubuntu_repository_cache/util.py
+++ b/lib/ubuntu_repository_cache/util.py
@@ -277,3 +277,14 @@ def send_to_influx(metrics, send_to='127.0.0.1:8094'):
     except Exception:
         # We don't care if it fails to send metrics.
         pass
+
+
+def get_cloud_name(cloud_init_path='/run/cloud-init'):
+    cloud_id_path = os.path.join(cloud_init_path, 'cloud-id')
+
+    try:
+        with open(cloud_id_path, 'r') as f:
+            cloud_name = f.readline()
+        return cloud_name.strip()
+    except FileNotFoundError:
+        return ''
diff --git a/templates/cron/ubuntu-repository-cache-cron b/templates/cron/ubuntu-repository-cache-cron
index 186c6cc..9368631 100644
--- a/templates/cron/ubuntu-repository-cache-cron
+++ b/templates/cron/ubuntu-repository-cache-cron
@@ -4,9 +4,9 @@ JUJU_AVAILABILITY_ZONE={{ JujuAvailabilityZone }}
 {%- endif %}
 {%- if Peers != '' %}
 # This cronjob will make the leader sync its view of the metadata with upstream
-{{ Minutes }} * * * * root . {{ ConfigPath }} && run-one {{ CharmEnvPath }} --charm ubuntu-repository-cache python3 -m ubuntu_repository_cache.metadata_sync  # {{ JujuModelName }} {% if JujuAvailabilityZone %}{{ JujuAvailabilityZone }}{% endif %}
+{{ Minutes }} * * * * root . {{ ConfigPath }} && run-one {{ CharmEnvPath }} --charm ubuntu-repository-cache python3 -m ubuntu_repository_cache.metadata_sync  # {{ JujuModelName }} {{ Cloud }}{% if JujuAvailabilityZone %} {{ JujuAvailabilityZone }}{% endif %}
 
 {% else %}
-{{ Minutes }} * * * * root . {{ ConfigPath }} && run-one {{ CharmEnvPath }} --charm ubuntu-repository-cache python3 -m ubuntu_repository_cache.metadata_cleanup  # {{ JujuModelName }} {% if JujuAvailabilityZone %}{{ JujuAvailabilityZone }}{% endif %}
+{{ Minutes }} * * * * root . {{ ConfigPath }} && run-one {{ CharmEnvPath }} --charm ubuntu-repository-cache python3 -m ubuntu_repository_cache.metadata_cleanup  # {{ JujuModelName }} {{ Cloud }}{% if JujuAvailabilityZone %} {{ JujuAvailabilityZone }}{% endif %}
 
 {% endif %}
diff --git a/tests/unit/files/cloud-id-azure b/tests/unit/files/cloud-id-azure
new file mode 100644
index 0000000..9271abf
--- /dev/null
+++ b/tests/unit/files/cloud-id-azure
@@ -0,0 +1 @@
+azure
diff --git a/tests/unit/test_util.py b/tests/unit/test_util.py
new file mode 100644
index 0000000..86ee8db
--- /dev/null
+++ b/tests/unit/test_util.py
@@ -0,0 +1,47 @@
+import os
+import shutil
+import sys
+import tempfile
+import unittest
+
+from unittest import mock
+
+# Add path to where our reactive layer lives and import.
+sys.path.append(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__)))))
+from lib.ubuntu_repository_cache import util  # NOQA: E402
+
+
+class TestCharm(unittest.TestCase):
+    def setUp(self):
+        self.maxDiff = None
+        self.tmpdir = tempfile.mkdtemp(prefix='charm-unittests-')
+        self.addCleanup(shutil.rmtree, self.tmpdir)
+
+        self.charm_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+        patcher = mock.patch('charmhelpers.core.hookenv.log')
+        self.mock_log = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_log.return_value = ''
+
+        patcher = mock.patch('charmhelpers.core.hookenv.charm_dir')
+        self.mock_charm_dir = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_charm_dir.return_value = self.charm_dir
+
+        patcher = mock.patch('charmhelpers.core.hookenv.local_unit')
+        self.mock_local_unit = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_local_unit.return_value = 'mock-ubuntu-repository-cache/0'
+
+        patcher = mock.patch('charmhelpers.core.host.log')
+        self.mock_log = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_log.return_value = ''
+
+    def test_get_cloud_name(self):
+        self.assertEqual(util.get_cloud_name(self.tmpdir), '')
+
+        shutil.copy2('tests/unit/files/cloud-id-azure', self.tmpdir)
+        os.symlink(os.path.join(self.tmpdir, 'cloud-id-azure'), os.path.join(self.tmpdir, 'cloud-id'))
+        self.assertEqual(util.get_cloud_name(self.tmpdir), 'azure')