Merge ~xavpaice/charm-hw-health:bug/1924863 into charm-hw-health:master

[Xav Paice]

Add two actions which will list the cron.d hwhealth tasks, and allow the juju user to run them.

[Xav Paice (xavpaice)]

rebased and resubmitted; change looks good but CI was failing because it needed some unrelated fixes.

[🤖 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)]

FAILED: Continuous integration, rev:2c550eeb5a074c0f10a11f4c7a0c665bcf06510d
https://jenkins.canonical.com/bootstack/job/lp-charm-hw-health-ci/19/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-unit/106/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/259/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-hw-health-ci/19//rebuild

review: Needs Fixing (continuous-integration)

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

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

[Tom Haddon (mthaddon)]

Abstaining, just claimed the review to take it off the canonical-is-reviewers dashboard, mergebot has been switched to add bootstack-reviewers for future MPs.

review: Abstain

[James Troup (elmo)]

See comments inline

review: Needs Fixing

Unmerged commits

2c550ee... by Adam Dyess on 2021-04-27

Fix linting issues around testing cron.d updated

339ae39... by Adam Dyess on 2021-04-23

Read the /etc/cron.d/hwhealth_* tools and allow them to be listed or run from a juju action

diff --git a/src/actions.yaml b/src/actions.yaml
index 888711d..1dea722 100644
--- a/src/actions.yaml
+++ b/src/actions.yaml
@@ -26,3 +26,13 @@ ack-sel:
 unack-sel:
   description: |
     Unset the date filter set by ack-sel action.
+list-cron-actions:
+  description: |
+    List all hwhealth installed cron actions
+run-cron-action:
+  description: |
+    Run the hwhealth cron actions
+  params:
+    entries:
+      type: string
+      description: Comma sepearated list of cron actions to run (or "all")
\ No newline at end of file
diff --git a/src/actions/actions.py b/src/actions/actions.py
index 4424545..d9cb734 100755
--- a/src/actions/actions.py
+++ b/src/actions/actions.py
@@ -16,6 +16,8 @@
 """Define hw-health charm actions."""
 
 import os
+import pathlib
+import re
 import subprocess
 import sys
 from datetime import datetime
@@ -27,6 +29,8 @@ from hwhealth import tools
 
 
 IPMI_SEL = "/usr/sbin/ipmi-sel"
+CRON_DIR = pathlib.Path("/etc") / "cron.d"
+CRON_RE = re.compile(r"\S+ \S+ \S+ \S+ \S+ (\S+) (.*)")
 
 
 def clear_sel():
@@ -126,6 +130,48 @@ def unack_sel():
         action_fail("Action failed with {}".format(e))
 
 
+def list_cron_actions():
+    cron_files = CRON_DIR.glob("hwhealth_*")
+    actions = [path.stem.split("_", 1)[-1] for path in cron_files]
+    message = "Cron Actions: {}".format(",".join(actions))
+    log("Action list-cron-actions completed\n" + message)
+    action_set({"message": message})
+    return actions
+
+
+def _run_job_file(fname):
+    with open(fname) as f:
+        job_lines = f.readlines()
+        jobs = [
+            CRON_RE.match(line).groups()
+            for line in job_lines
+            if not any(line.startswith(ch) for ch in "# \t")
+        ]
+        outs = []
+        for who, shell in jobs:
+            cmd = ["sudo", "-u", who, shell]
+            try:
+                out = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
+            except subprocess.CalledProcessError as e:
+                action_fail("{}: {}\n\t{}".format(who, shell, str(e)))
+                out = e.output + e.stderr
+            outs.append((cmd, out))
+        return outs
+
+
+def run_cron_action():
+    cron_entries = [entry for entry in action_get("entries").split(",") if entry]
+    cron_actions = list_cron_actions()
+    to_run = cron_entries or cron_actions  # if nothing specified, run all
+    results = [
+        "{}\n\t{}".format(" ".join(cmd), result)
+        for each in to_run
+        if each in cron_actions
+        for cmd, result in _run_job_file(CRON_DIR / "hwhealth-{}".format(each))
+    ]
+    action_set({"message": "\n".join(results)})
+
+
 # A dictionary of all the defined actions to callables (which take
 # parsed arguments).
 ACTIONS = {
@@ -133,6 +179,8 @@ ACTIONS = {
     "show-sel": show_sel,
     "ack-sel": ack_sel,
     "unack-sel": unack_sel,
+    "list-cron-actions": list_cron_actions,
+    "run-cron-action": run_cron_action,
 }
 
 
diff --git a/src/actions/list-cron-actions b/src/actions/list-cron-actions
new file mode 120000
index 0000000..405a394
--- /dev/null
+++ b/src/actions/list-cron-actions
@@ -0,0 +1 @@
+actions.py
\ No newline at end of file
diff --git a/src/actions/run-cron-action b/src/actions/run-cron-action
new file mode 120000
index 0000000..405a394
--- /dev/null
+++ b/src/actions/run-cron-action
@@ -0,0 +1 @@
+actions.py
\ No newline at end of file
diff --git a/src/tests/unit/test_actions.py b/src/tests/unit/test_actions.py
index 3a3f4f2..575bbe0 100644
--- a/src/tests/unit/test_actions.py
+++ b/src/tests/unit/test_actions.py
@@ -12,13 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pathlib
 import subprocess
 import sys
+import tempfile
 import unittest
 import unittest.mock as mock
 
 sys.path.append(".")
-from actions.actions import clear_sel, show_sel  # noqa:E402
+from actions.actions import (  # noqa:E402
+    clear_sel,
+    list_cron_actions,
+    _run_job_file,
+    run_cron_action,
+    show_sel,
+)
 
 
 class ClearSelTestCase(unittest.TestCase):
@@ -170,3 +178,113 @@ class ShowSelTestCase(unittest.TestCase):
             "Action failed with Command '['bogus-cmd']' "
             "returned non-zero exit status 1.",
         )
+
+
+class ListCronTestCase(unittest.TestCase):
+    @mock.patch("actions.actions.action_set")
+    @mock.patch("actions.actions.log")
+    @mock.patch("actions.actions.CRON_DIR")
+    def test_list_cron_jobs(self, mock_cron_dir, mock_log, mock_action_set):
+        mock_cron_dir.glob.return_value = [
+            pathlib.Path("/path/to/hwhealth_ipmi"),
+            pathlib.Path("/path/to/hwhealth_test"),
+        ]
+
+        actions = list_cron_actions()
+        assert actions == ["ipmi", "test"]
+        mock_cron_dir.glob.assert_called_once_with("hwhealth_*")
+        ui_response = "Cron Actions: ipmi,test"
+        mock_log.assert_called_once_with(
+            "Action list-cron-actions completed\n{}".format(ui_response)
+        )
+        mock_action_set.assert_called_once_with({"message": ui_response})
+
+    @mock.patch("subprocess.check_output")
+    def test_run_good_job_file(self, mock_check_output):
+        with tempfile.TemporaryDirectory() as tempdirname:
+            test_file = pathlib.Path(tempdirname) / "test"
+            with open(test_file, "w") as fp:
+                fp.write(
+                    """
+# Cron Comments
+ lines starting with spaces are comments
+    so are lines starting with tab
+* * * * * nagios /run/my/command with some --arguments
+* * * * * root /run/my/command with some --other-arguments
+""".strip()
+                )
+
+            mock_check_output.side_effect = [
+                "result #1",
+                "result #2",
+            ]
+            job_output = _run_job_file(test_file)
+            assert job_output == [
+                (
+                    ["sudo", "-u", "nagios", "/run/my/command with some --arguments"],
+                    "result #1",
+                ),
+                (
+                    [
+                        "sudo",
+                        "-u",
+                        "root",
+                        "/run/my/command with some --other-arguments",
+                    ],
+                    "result #2",
+                ),
+            ]
+
+    @mock.patch("actions.actions.action_fail")
+    @mock.patch("subprocess.check_output")
+    def test_run_job_file_failure(self, mock_check_output, mock_action_fail):
+        with tempfile.TemporaryDirectory() as tempdirname:
+            test_file = pathlib.Path(tempdirname) / "test"
+            with open(test_file, "w") as fp:
+                fp.write("* * * * * root /run/my/command with some --other-arguments")
+
+            mock_check_output.side_effect = [
+                subprocess.CalledProcessError(
+                    cmd="sudo",
+                    returncode=-1,
+                    output="No ",
+                    stderr="Way",
+                ),
+            ]
+            job_output = _run_job_file(test_file)
+            assert job_output == [
+                (
+                    [
+                        "sudo",
+                        "-u",
+                        "root",
+                        "/run/my/command with some --other-arguments",
+                    ],
+                    "No Way",
+                )
+            ]
+            mock_action_fail.assert_called_with(
+                "root: /run/my/command with some --other-arguments\n\t"
+                "Command 'sudo' died with <Signals.SIGHUP: 1>."
+            )
+
+    @mock.patch("actions.actions._run_job_file")
+    @mock.patch("actions.actions.list_cron_actions")
+    @mock.patch("actions.actions.action_get")
+    @mock.patch("actions.actions.action_set")
+    def test_run_cron_action(
+        self,
+        mock_action_set,
+        mock_action_get,
+        mock_list_cron_actions,
+        mock_run_job_file,
+    ):
+        mock_action_get.return_value = ""
+        mock_list_cron_actions.return_value = ["test"]
+        mock_run_job_file.return_value = [
+            (["sudo", "-u", "root", "/run/my/cmd"], "works!")
+        ]
+        run_cron_action()
+        mock_action_set.assert_called_once_with(
+            {"message": "sudo -u root /run/my/cmd\n\tworks!"}
+        )