Merge lp:~hloeung/ubuntu-repository-cache/status-show-charm-revno into lp:ubuntu-repository-cache

[Haw Loeung]

Add showing charm revno in juju status output

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

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

[lp:~hloeung/ubuntu-repository-cache/status-show-charm-revno]

300. By Haw Loeung on 2021-01-31

Support when revision-id: doesn't exist, e.g. charm pushed

301. By Haw Loeung on 2021-02-01

Capitolise

302. By Haw Loeung on 2021-02-01

status.maintenance() in favor of LOG() for when we want to update and show what's currently in progress

[Thomas Cuthbert (tcuthbert)]

LGTM +1

review: Approve

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

Change successfully merged at revision 299

=== renamed file 'reactive/ubuntu-repository-cache.py' => 'reactive/ubuntu_repository_cache.py'
--- reactive/ubuntu-repository-cache.py	2021-01-08 02:57:34 +0000
+++ reactive/ubuntu_repository_cache.py	2021-02-01 00:23:42 +0000
@@ -8,6 +8,7 @@
 import pwd
 
 from charms import reactive
+from charms.layer import status
 from charmhelpers.core import hookenv, host, unitdata
 from charmhelpers.contrib import unison
 
@@ -26,7 +27,8 @@
 def install():
     '''Perform service installation'''
 
-    LOG('Installing %s' % SERVICE)
+    status.maintenance('Installing %s' % SERVICE)
+    reactive.clear_flag('ubuntu-repository-cache.active')
     service.install()
     reactive.set_flag('ubuntu-repository-cache.installed')
     # Needed to make sure any initial MPM tuning and mode will be made live.
@@ -37,7 +39,8 @@
 def config_changed():
     '''Handle charm configuration changes'''
 
-    LOG('Config changed for %s' % SERVICE)
+    status.maintenance('Config changed for %s' % SERVICE)
+    reactive.clear_flag('ubuntu-repository-cache.active')
     reactive.clear_flag('ubuntu-repository-cache.configured')
     reactive.clear_flag('nagios-nrpe.configured')
 
@@ -68,6 +71,20 @@
     reactive.set_flag('ubuntu-repository-cache.configured')
 
 
[e-mail]('ubuntu-repository-cache.configured')
[e-mail]_not('ubuntu-repository-cache.active', 'ubuntu-repository-cache.apache2-restart-required')
+def set_active(version_file='version'):
+    revno = ''
+    if os.path.exists(version_file):
+        with open(version_file) as f:
+            revno = f.readline().strip().split('-')[-1]
+        # We only want the first 8 characters, that's enough to tell
+        # which version of the charm we're using.
+        revno = ' ({})'.format(revno[:8])
+    status.active('Ready{}'.format(revno))
+    reactive.set_flag('ubuntu-repository-cache.active')
+
+
 def update_website_relation_data():
     relation_id = None
     for relid in hookenv.relation_ids('website'):
@@ -85,7 +102,7 @@
 @reactive.when('ubuntu-repository-cache.configured')
 @reactive.when('ubuntu-repository-cache.apache2-restart-required')
 def apache2_restart():
-    LOG('Restarting apache2 as MPM settings have changed')
+    status.maintenance('Restarting apache2 as MPM settings have changed')
     host.service_restart('apache2')
     reactive.clear_flag('ubuntu-repository-cache.apache2-restart-required')
 
@@ -94,7 +111,8 @@
 def upgrade_charm():
     '''Handle charm updates'''
 
-    LOG('Upgrading %s' % SERVICE)
+    status.maintenance('Upgrading %s' % SERVICE)
+    reactive.clear_flag('ubuntu-repository-cache.active')
     reactive.clear_flag('ubuntu-repository-cache.configured')
     reactive.clear_flag('nagios-nrpe.configured')
 
@@ -103,14 +121,14 @@
 def start():
     '''Start the charm's services'''
 
-    LOG('Starting %s' % SERVICE)
+    status.maintenance('Starting %s' % SERVICE)
     service.render_configs()
 
     sync_host = hookenv.config()['sync-host']
     mirror_series = hookenv.config()['mirror-series'].strip()
     config = hookenv.config()
     if config['sync-on-start']:
-        LOG('Performing initial sync from %s' % sync_host)
+        status.maintenance('Performing initial sync from %s' % sync_host)
         # This creates a semaphore to prevent cronjobs form eventually running
         # while this is still syncing.
         try:
@@ -126,10 +144,10 @@
             raise
 
         if meta_ver:
-            LOG('Initial sync from {} completed ver={}.'.format(sync_host, meta_ver))
+            status.maintenance('Initial sync from {} completed ver={}.'.format(sync_host, meta_ver))
             service.start()
         else:
-            LOG('Leader could not gather new metadata', hookenv.WARNING)
+            status.maintenance('Leader could not gather new metadata', hookenv.WARNING)
     else:
         LOG('Skipping initial content sync, "sync-on-start" config ' 'option was not set')
 
@@ -138,7 +156,7 @@
 def stop():
     '''Stop the charm's services'''
 
-    LOG('Stopping %s' % SERVICE)
+    status.maintenance('Stopping %s' % SERVICE)
     service.stop()
 
 
 
=== added directory 'tests/unit/files'
=== added file 'tests/unit/files/version'
--- tests/unit/files/version	1970-01-01 00:00:00 +0000
+++ tests/unit/files/version	2021-02-01 00:23:42 +0000
@@ -0,0 +1,5 @@
+revision-id: [e-mail]-20210131223324-uax4glwgttv0wftp
+date: 2021-02-01 09:33:24 +1100
+build-date: 2021-02-01 09:41:04 +1100
+revno: 298
+branch-nick: ubuntu-repository-cache
 \ No newline at end of file
 
=== added file 'tests/unit/files/version2'
--- tests/unit/files/version2	1970-01-01 00:00:00 +0000
+++ tests/unit/files/version2	2021-02-01 00:23:42 +0000
@@ -0,0 +1,1 @@
+uax4glw
 
=== added file 'tests/unit/files/version3'
--- tests/unit/files/version3	1970-01-01 00:00:00 +0000
+++ tests/unit/files/version3	2021-02-01 00:23:42 +0000
@@ -0,0 +1,1 @@
[e-mail]-20210131233021-66dfilb1615jppxt
 \ No newline at end of file
 
=== added file 'tests/unit/test_ubuntu_repository_cache.py'
--- tests/unit/test_ubuntu_repository_cache.py	1970-01-01 00:00:00 +0000
+++ tests/unit/test_ubuntu_repository_cache.py	2021-02-01 00:23:42 +0000
@@ -0,0 +1,76 @@
+import os
+import shutil
+import sys
+import tempfile
+import unittest
+from unittest import mock
+
+# We also need to mock up charms.layer so we can run unit tests without having
+# to build the charm and pull in layers such as layer-status.
+sys.modules['charms.layer'] = mock.MagicMock()
+
+from charms.layer import status  # NOQA: E402
+from charmhelpers.core import unitdata  # NOQA: E402
+
+# 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 reactive import ubuntu_repository_cache  # 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)
+        os.environ['UNIT_STATE_DB'] = os.path.join(self.tmpdir, '.unit-state.db')
+
+        unitdata.kv().set('test', {})
+
+        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.hookenv.config')
+        self.mock_config = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_config.return_value = {'nagios_context': 'juju'}
+
+        patcher = mock.patch('charmhelpers.core.host.log')
+        self.mock_log = patcher.start()
+        self.addCleanup(patcher.stop)
+        self.mock_log.return_value = ''
+
+        status.active.reset_mock()
+        status.blocked.reset_mock()
+        status.maintenance.reset_mock()
+
+    @mock.patch('charms.reactive.set_flag')
+    def test_set_active(self, set_flag):
+        ubuntu_repository_cache.set_active()
+        status.active.assert_called_once_with('Ready')
+        set_flag.assert_called_once_with('ubuntu-repository-cache.active')
+
+        status.active.reset_mock()
+        ubuntu_repository_cache.set_active(os.path.join(self.charm_dir, 'tests/unit/files/version'))
+        status.active.assert_called_once_with('Ready (uax4glwg)')
+
+        status.active.reset_mock()
+        ubuntu_repository_cache.set_active(os.path.join(self.charm_dir, 'tests/unit/files/version2'))
+        status.active.assert_called_once_with('Ready (uax4glw)')
+
+        status.active.reset_mock()
+        ubuntu_repository_cache.set_active(os.path.join(self.charm_dir, 'tests/unit/files/version3'))
+        status.active.assert_called_once_with('Ready (66dfilb1)')