Merge lp:~silverdrake11/landscape-charm/bootstrap_account_charm_lndeng-150 into lp:~mitchburton/landscape-charm/op-framework

[Kevin Nasto]

Added bootstrap account feature to server charm

[Mitch Burton (mitchburton)]

Works great, good job!

review: Approve

=== modified file 'config.yaml'
--- config.yaml	2022-10-18 18:27:37 +0000
+++ config.yaml	2023-01-27 22:11:21 +0000
@@ -60,7 +60,32 @@
     type: string
     default:
     description: |
-      The email address that Landscape emails will appear to come from.
+      The initial email address that Landscape emails will appear to come from.
+      Note this value cannot be set more than once.
+  admin_email:
+    type: string
+    default:
+    description: |
+      The email address of the initial account administrator. Note this value
+      cannot be set more than once.
+  admin_name:
+    type: string
+    default:
+    description: |
+      The full name of the initial account administrator. Note this value
+      cannot be set more than once.
+  admin_password:
+    type: string
+    default:
+    description: |
+      The initial password of the account administrator. Note this value cannot
+      be set more than once.
+  registration_key:
+    type: string
+    default:
+    description: |
+      The initial account registration key. Note this value cannot be set more
+      than once.
   smtp_relay_host:
     type: string
     default: ""

=== modified file 'src/charm.py'
--- src/charm.py	2023-01-25 19:57:43 +0000
+++ src/charm.py	2023-01-27 22:11:21 +0000
@@ -49,6 +49,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"
 
 LANDSCAPE_PACKAGES = (
     "landscape-server",
@@ -135,6 +136,8 @@
         })
         self._stored.set_default(leader_ip="")
         self._stored.set_default(running=False)
+        self._stored.set_default(default_root_url="")
+        self._stored.set_default(account_bootstrapped=False)
 
         self.landscape_uid = user_exists("landscape").pw_uid
         self.root_gid = group_exists("root").gr_gid
@@ -185,6 +188,8 @@
                 "package-upload": {"root-url": root_url},
             })
 
+        self._bootstrap_account()
+
         if isinstance(prev_status, BlockedStatus):
             self.unit.status = prev_status
 
@@ -387,6 +392,7 @@
         # Update root_url, if not provided.
         if not self.model.config.get("root_url"):
             url = f'https://{event.relation.data[event.unit]["public-address"]}/'
+            self._stored.default_root_url = url
             update_service_conf({
                 "global": {"root-url": url},
                 "api": {"root-url": url},
@@ -725,6 +731,61 @@
                 "OpenID configuration requires both 'openid_provider_url' and "
                 "'openid_logout_url'")
 
+    def _bootstrap_account(self):
+        """If admin account details are provided, create admin"""
+        if not self.unit.is_leader():
+            return
+        if self._stored.account_bootstrapped:  # Admin already created
+            return
+        karg = {}  # Keyword args for command line
+        karg["admin_email"] = self.model.config.get("admin_email")
+        karg["admin_name"] = self.model.config.get("admin_name")
+        karg["admin_password"] = self.model.config.get("admin_password")
+        required_args = karg.values()
+        if not any(required_args):  # Return since no args are specified
+            return
+        if not all(required_args):  # Some required args are missing
+            logger.error(
+                "Admin email, name, and password required for bootstrap account"
+            )
+            return
+        karg["root_url"] = self.model.config.get("root_url")
+        if not karg["root_url"]:
+            default_root_url = self._stored.default_root_url
+            if default_root_url:
+                karg["root_url"] = default_root_url
+            else:
+                logger.error("Bootstrap account waiting on default root url..")
+                return
+        karg["registration_key"] = self.model.config.get("registration_key")
+        karg["system_email"] = self.model.config.get("system_email")
+
+        # Collect command line arguments
+        args = [BOOTSTRAP_ACCOUNT_SCRIPT]
+        for key, value in karg.items():
+            if not value:
+                continue
+            args.append("--" + key)
+            args.append(value)
+
+        try:
+            logger.info(args)
+            result = subprocess.run(args, capture_output=True, text=True)
+        except FileNotFoundError:
+            logger.error("Bootstrap script not found!")
+            logger.error(BOOTSTRAP_ACCOUNT_SCRIPT)
+            return
+        logger.info(result.stdout)
+        if result.returncode:
+            if "DuplicateAccountError" in result.stderr:
+                logger.error("Cannot bootstrap b/c account is already there!")
+                self._stored.account_bootstrapped = True
+            else:
+                logger.error(result.stderr)
+        else:
+            logger.info("Admin account successfully bootstrapped!")
+            self._stored.account_bootstrapped = True
+
     def _pause(self, event: ActionEvent) -> None:
         self.unit.status = MaintenanceStatus("Stopping services")
         event.log("Stopping services")

=== modified file 'tests/test_charm.py'
--- tests/test_charm.py	2023-01-25 19:57:43 +0000
+++ tests/test_charm.py	2023-01-27 22:11:21 +0000
@@ -941,3 +941,146 @@
                 "host": "test",
             },
         })
+
+
+class TestBootstrapAccount(unittest.TestCase):
+    def setUp(self):
+        self.harness = Harness(LandscapeServerCharm)
+        self.addCleanup(self.harness.cleanup)
+
+        self.harness.model.get_binding = Mock(
+            return_value=Mock(bind_address="123.123.123.123")
+        )
+        self.harness.add_relation("replicas", "landscape-server")
+        self.harness.set_leader()
+
+        self.process_mock = patch("subprocess.run").start()
+        self.log_mock = patch("charm.logger.error").start()
+
+        self.addCleanup(patch.stopall)
+
+        self.harness.begin()
+
+    def test_bootstrap_account_doesnt_run_with_missing_configs(self):
+        self.harness.update_config(
+            {"admin_email": "[e-mail]", "admin_name": "Hello Ubuntu"}
+        )
+        self.assertIn("password required", self.log_mock.call_args.args[0])
+        self.process_mock.assert_not_called()
+
+    def test_bootstrap_account_doesnt_run_with_missing_rooturl(self):
+        self.harness.update_config(
+            {
+                "admin_email": "[e-mail]",
+                "admin_name": "Hello Ubuntu",
+                "admin_password": "password",
+            }
+        )
+        self.assertIn("root url", self.log_mock.call_args.args[0])
+        self.process_mock.assert_not_called()
+
+    def test_bootstrap_account_default_root_url_is_used(self):
+        self.harness.charm._stored.default_root_url = "https://hello.lxd"
+        self.harness.update_config(
+            {
+                "admin_email": "[e-mail]",
+                "admin_name": "Hello Ubuntu",
+                "admin_password": "password",
+            }
+        )
+        self.assertIn(
+            self.harness.charm._stored.default_root_url,
+            self.process_mock.call_args.args[0],
+        )
+
+    def test_bootstrap_account_config_url_over_default(self):
+        """If config root url and default root url exists, use config url"""
+        self.harness.charm._stored.default_root_url = "https://hello.lxd"
+        config_root_url = "https://www.landscape.com"
+        self.harness.update_config(
+            {
+                "admin_email": "[e-mail]",
+                "admin_name": "Hello Ubuntu",
+                "admin_password": "password",
+                "root_url": config_root_url,
+            }
+        )
+        self.assertIn(config_root_url, self.process_mock.call_args.args[0])
+
+    def test_bootstrap_account_runs_once_with_correct_args(self):
+        """
+        Test that bootstrap account runs with correct args and that it can't
+        run again after a successful run
+        """
+        self.process_mock.return_value.returncode = 0  # Success
+        admin_email = "[e-mail]"
+        admin_name = "Hello Ubuntu"
+        admin_password = "password"
+        root_url = "https://www.landscape.com"
+        config = {
+            "admin_email": admin_email,
+            "admin_name": admin_name,
+            "admin_password": admin_password,
+            "root_url": root_url,
+        }
+        self.harness.update_config(config)
+        self.assertEqual(
+            [
+                "/opt/canonical/landscape/bootstrap-account",
+                "--admin_email",
+                admin_email,
+                "--admin_name",
+                admin_name,
+                "--admin_password",
+                admin_password,
+                "--root_url",
+                root_url,
+            ],
+            self.process_mock.call_args.args[0],
+        )
+        self.harness.update_config(config)
+        self.process_mock.assert_called_once()
+
+    def test_bootstrap_account_runs_twice_if_error(self):
+        """
+        If there's an error ensure that bootstrap account runs again and not
+        a third time if successful
+        """
+        self.process_mock.return_value.returncode = 1  # Error here
+        admin_email = "[e-mail]"
+        admin_name = "Hello Ubuntu"
+        admin_password = "password"
+        root_url = "https://www.landscape.com"
+        config = {
+            "admin_email": admin_email,
+            "admin_name": admin_name,
+            "admin_password": admin_password,
+            "root_url": root_url,
+        }
+        self.harness.update_config(config)
+        self.process_mock.return_value.returncode = 0
+        self.harness.update_config(config)
+        self.harness.update_config(config)  # Third time
+        self.assertEqual(self.process_mock.call_count, 2)
+
+    def test_bootstrap_account_cannot_run_if_already_bootstrapped(self):
+        """
+        If user already has created an account outside of the charm,
+        then the bootstrap account cannot run again
+        """
+        self.process_mock.return_value.returncode = 1  # Error here
+        self.process_mock.return_value.stderr = "DuplicateAccountError"
+        admin_email = "[e-mail]"
+        admin_name = "Hello Ubuntu"
+        admin_password = "password"
+        root_url = "https://www.landscape.com"
+        config = {
+            "admin_email": admin_email,
+            "admin_name": admin_name,
+            "admin_password": admin_password,
+            "root_url": root_url,
+        }
+        self.harness.update_config(config)
+        self.harness.update_config(config)
+        self.harness.update_config(config)  # Third time
+        self.process_mock.assert_called_once()