Merge lp:~hloeung/ubuntu-repository-cache/add-maintenance-mode-action into lp:ubuntu-repository-cache

[Haw Loeung]

Added ability to put units in maintenance mode - LP:1916080

[🤖 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/add-maintenance-mode-action]

360. By Haw Loeung on 2022-07-27

Added unit tests

[James Simpson (jsimpso)]

LGTM

review: Approve

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

Change successfully merged at revision 359

=== added directory 'actions'
=== added file 'actions.yaml'
--- actions.yaml	1970-01-01 00:00:00 +0000
+++ actions.yaml	2022-07-27 01:59:40 +0000
@@ -0,0 +1,9 @@
+maintenance-mode:
+  description: Start/stop maintenance mode.
+  params:
+    do:
+      type: string
+      enum: [start, stop, status]
+      description: start, stop, or show status of whether unit is in maintenance mode
+  required: [do]
+  additionalProperties: false

=== added symlink 'actions/maintenance-mode'
=== target is 'maintenance_mode.py'
=== added file 'actions/maintenance_mode.py'
--- actions/maintenance_mode.py	1970-01-01 00:00:00 +0000
+++ actions/maintenance_mode.py	2022-07-27 01:59:40 +0000
@@ -0,0 +1,48 @@
+#!/usr/local/sbin/charm-env python3
+
+import os
+
+from charmhelpers.core import hookenv, unitdata
+
+
+def start(healthcheck_disabled):
+    if os.path.exists(healthcheck_disabled):
+        print('Unit is already in maintenance mode')
+    else:
+        with open(healthcheck_disabled, 'a'):
+            os.utime(healthcheck_disabled, None)
+        print('Unit is _now_ in maintenance mode')
+
+
+def stop(healthcheck_disabled):
+    if os.path.exists(healthcheck_disabled):
+        os.unlink(healthcheck_disabled)
+        print('Unit is no longer in maintenance mode')
+    else:
+        print('Unit was not in maintenance mode')
+
+
+def status(healthcheck_disabled):
+    if os.path.exists(healthcheck_disabled):
+        print('Unit is currrently in maintenance mode')
+    else:
+        print('Unit is _not_ currently in maintenance mode')
+
+
+def main():
+    action = hookenv.action_get('do')
+
+    apache_path = unitdata.kv().get('apache-root')
+    healthcheck_path = os.path.join(apache_path, 'health-check')
+    healthcheck_disabled = os.path.join(healthcheck_path, 'health-check-disabled.flag')
+
+    if action == 'start':
+        start(healthcheck_disabled)
+    elif action == 'stop':
+        stop(healthcheck_disabled)
+    elif action == 'status':
+        status(healthcheck_disabled)
+
+
+if __name__ == '__main__':  # pragma: no cover
+    main()

=== added file 'tests/unit/test_actions.py'
--- tests/unit/test_actions.py	1970-01-01 00:00:00 +0000
+++ tests/unit/test_actions.py	2022-07-27 01:59:40 +0000
@@ -0,0 +1,64 @@
+import os
+import shutil
+import sys
+import tempfile
+import unittest
+from unittest import mock
+
+from charmhelpers.core import unitdata
+
+# 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 actions import maintenance_mode  # 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__))))
+
+    @mock.patch('builtins.print')
+    def test_maintenance_mode_start(self, mock_print):
+        healthcheck_disabled = os.path.join(self.tmpdir, 'health-check-disabled.flag')
+
+        maintenance_mode.start(healthcheck_disabled)
+        mock_print.assert_called_with('Unit is _now_ in maintenance mode')
+        self.assertTrue(os.path.exists(healthcheck_disabled))
+
+        # Already in maintenance mode.
+        maintenance_mode.start(healthcheck_disabled)
+        mock_print.assert_called_with('Unit is already in maintenance mode')
+
+    @mock.patch('builtins.print')
+    def test_maintenance_mode_stop(self, mock_print):
+        healthcheck_disabled = os.path.join(self.tmpdir, 'health-check-disabled.flag')
+
+        with open(healthcheck_disabled, 'a'):
+            os.utime(healthcheck_disabled, None)
+        maintenance_mode.stop(healthcheck_disabled)
+        mock_print.assert_called_with('Unit is no longer in maintenance mode')
+        self.assertFalse(os.path.exists(healthcheck_disabled))
+
+        # Not in maintenance mode.
+        maintenance_mode.stop(healthcheck_disabled)
+        mock_print.assert_called_with('Unit was not in maintenance mode')
+
+    @mock.patch('builtins.print')
+    def test_maintenance_mode_status(self, mock_print):
+        healthcheck_disabled = os.path.join(self.tmpdir, 'health-check-disabled.flag')
+
+        # Not in maintenance mode.
+        maintenance_mode.status(healthcheck_disabled)
+        mock_print.assert_called_with('Unit is _not_ currently in maintenance mode')
+
+        # In maintenance mode.
+        with open(healthcheck_disabled, 'a'):
+            os.utime(healthcheck_disabled, None)
+        maintenance_mode.status(healthcheck_disabled)
+        mock_print.assert_called_with('Unit is currrently in maintenance mode')

=== modified file 'tox.ini'
--- tox.ini	2022-07-22 03:55:30 +0000
+++ tox.ini	2022-07-27 01:59:40 +0000
@@ -10,7 +10,7 @@
 [testenv:unit]
 commands =
     pytest --ignore {toxinidir}/tests/functional \
-      {posargs:-v --cov=files --cov=lib --cov=reactive --cov-branch --cov-report=term-missing --cov-report=html}
+      {posargs:-v --cov=actions --cov=files --cov=lib --cov=reactive --cov-branch --cov-report=term-missing --cov-report=html}
 deps = -r{toxinidir}/tests/unit/requirements.txt
        -r{toxinidir}/requirements.txt
 setenv =