Merge ~mitchburton/landscape-charm:main into landscape-charm:main

[Mitch Burton]

add hash-id-databases action

This patch adds the hash-id-databases action, which simply runs the hash-id-databases script on-demand.

To test:
  1. charmcraft pack
  2. juju deploy ./bundle.yaml
  3. wait until everything is ready, go look at /var/lib/landscape/hash-id-databases on the landscape-server unit when things are done installing to see their file stats
  4. juju run-action landscape-server/0 hash-id-databases --wait

Confirm that the files in /var/lib/landscape/hash-id-databases are now newly created.

[Kevin Nasto (silverdrake11)]

Not sure if this will be in issue but I noticed that cron job is /opt/canonical/landscape/scripts/hash_id_databases.sh but this one is in /landscape/. Seems like it's just checking if it already is running

[Kevin Nasto (silverdrake11)]

Also should the action wait until units are ready?

[Kevin Nasto (silverdrake11)]

When I did the manual test I noticed that the original files are owned by landscape but the new files are owned by root. So this should be running as landscape user

[Mitch Burton (mitchburton)]

> When I did the manual test I noticed that the original files are owned by
> landscape but the new files are owned by root. So this should be running as
> landscape user

Right. Will fix.

[Mitch Burton (mitchburton)]

> Also should the action wait until units are ready?

I don't think this is necessary. The only relation that is needed is the postgres one, and since this is a read-only action for the db, there shouldn't be any impact if other things aren't ready.

[Mitch Burton (mitchburton)]

> Not sure if this will be in issue but I noticed that cron job is
> /opt/canonical/landscape/scripts/hash_id_databases.sh but this one is in
> /landscape/. Seems like it's just checking if it already is running

The .sh just have some wrapping checks for if things are already running (like all the cron jobs do). I think it's fine to "jump the queue" and run this directly. It should be rare to run this one, anyways.

[Kevin Nasto (silverdrake11)]

LGTM +1

review: Approve

diff --git a/.gitignore b/.gitignore
index c5cb1af..ecb8c2f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,4 @@
-.coverage
\ No newline at end of file
+.coverage
+venv
+__pycache__
+*.charm
diff --git a/actions.yaml b/actions.yaml
index 9289f0d..1b891ab 100644
--- a/actions.yaml
+++ b/actions.yaml
@@ -6,9 +6,15 @@ pause:
 resume:
   description: Resume the Landscape services.
 upgrade:
-  description: Upgrade software on the Landscape Server unit. This will update
+  description: |
+    Upgrade software on the Landscape Server unit. This will update
     APT package indices and upgrade the landscape-server package. Unit must
     already be paused using the 'pause' action.
 migrate-schema:
-  description: Upgrade the Landscape database schemas on the related databases.
-    Unit must already be paused using the 'pause' action.
\ No newline at end of file
+  description: |
+    Upgrade the Landscape database schemas on the related databases.
+    Unit must already be paused using the 'pause' action.
+hash-id-databases:
+  description: |
+    Regenerate the package hash to id mapping files that are used to
+    speed up client package reporting.
diff --git a/src/charm.py b/src/charm.py
index 8af68d2..6c15478 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -51,6 +51,7 @@ NRPE_D_DIR = "/etc/nagios/nrpe.d"
 POSTFIX_CF = "/etc/postfix/main.cf"
 SCHEMA_SCRIPT = "/usr/bin/landscape-schema"
 BOOTSTRAP_ACCOUNT_SCRIPT = "/opt/canonical/landscape/bootstrap-account"
+HASH_ID_DATABASES = "/opt/canonical/landscape/hash-id-databases"
 
 LANDSCAPE_PACKAGES = (
     "landscape-server",
@@ -129,6 +130,8 @@ class LandscapeServerCharm(CharmBase):
         self.framework.observe(self.on.upgrade_action, self._upgrade)
         self.framework.observe(self.on.migrate_schema_action,
                                self._migrate_schema)
+        self.framework.observe(self.on.hash_id_databases_action,
+                               self._hash_id_databases)
 
         # State
         self._stored.set_default(ready={
@@ -945,6 +948,19 @@ command[check_{service}]=/usr/local/lib/nagios/plugins/check_systemd.py {service
         else:
             self.unit.status = prev_status
 
+    def _hash_id_databases(self, event: ActionEvent) -> None:
+        prev_status = self.unit.status
+        self.unit.status = MaintenanceStatus("Hashing ID databases...")
+        event.log("Running hash_id_databases")
+
+        try:
+            subprocess.run(["sudo", "-u", "landscape", HASH_ID_DATABASES], check=True, text=True)
+        except CalledProcessError as e:
+            logger.error("Hashing ID databases failed with error code %s", e.returncode)
+            event.fail("Hashing ID databases failed with error code %s", e.returncode)
+        finally:
+            self.unit.status = prev_status
+
 
 if __name__ == "__main__":  # pragma: no cover
     main(LandscapeServerCharm)
diff --git a/tests/test_charm.py b/tests/test_charm.py
index 516bc3f..08a4119 100644
--- a/tests/test_charm.py
+++ b/tests/test_charm.py
@@ -24,7 +24,7 @@ from charms.operator_libs_linux.v0.apt import (
 
 from charm import (
     DEFAULT_SERVICES, HAPROXY_CONFIG_FILE, LANDSCAPE_PACKAGES, LEADER_SERVICES, LSCTL,
-    NRPE_D_DIR, SCHEMA_SCRIPT, LandscapeServerCharm)
+    NRPE_D_DIR, SCHEMA_SCRIPT, HASH_ID_DATABASES, LandscapeServerCharm)
 
 
 class TestCharm(unittest.TestCase):
@@ -1287,3 +1287,29 @@ class TestBootstrapAccount(unittest.TestCase):
         self.harness.update_config(config)
         self.harness.update_config(config)  # Third time
         self.process_mock.assert_called_once()
+
+    @patch("subprocess.run")
+    def test_hash_id_databases(self, run_mock):
+        event = Mock(spec_set=ActionEvent)
+
+        self.harness.charm._hash_id_databases(event)
+
+        run_mock.assert_called_once_with(
+            ["sudo", "-u", "landscape", HASH_ID_DATABASES],
+            check=True,
+            text=True
+        )
+
+    @patch("subprocess.run")
+    def test_hash_id_databases_error(self, run_mock):
+        event = Mock(spec_set=ActionEvent)
+        run_mock.side_effect = CalledProcessError(127, "ouchie")
+
+        self.harness.charm._hash_id_databases(event)
+
+        run_mock.assert_called_once_with(
+            ["sudo", "-u", "landscape", HASH_ID_DATABASES],
+            check=True,
+            text=True
+        )
+        event.fail.assert_called_once()