Add an add-admin action

.gitignore

@@ -8,3 +8,4 @@ __pycache__/
 .idea
 .vscode
 .mypy_cache
+*.egg-info/

indico.Dockerfile

@@ -35,7 +35,6 @@ RUN apt-get update \
 # Add our plugins
 COPY --chown=indico:indico plugins /srv/indico/plugins
 
-USER indico
 RUN python3 -m pip install --no-cache-dir --no-warn-script-location --prefer-binary \
     indico==3.2.0 \
     indico-plugin-piwik \

plugins/autocreate/autocreate/__init__.py

@@ -1,3 +1,5 @@
-from indico.util.i18n import make_bound_gettext
+#!/usr/bin/env python3
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
 
-_ = make_bound_gettext("autocreate")
+"""Create users non-interactively."""

plugins/autocreate/autocreate/cli.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python3
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
+"""Create users non-interactively."""
+
 import click
 from indico.cli.core import cli_group
 from indico.core.db import db
@@ -45,8 +51,10 @@ def create_admin(ctx, email, password):
     )
     user.is_admin = True
 
-    db.session.add(user)
-    db.session.commit()
+    # db.session has add()
+    db.session.add(user)  # pylint: disable=no-member
+    # db.session has commit()
+    db.session.commit()  # pylint: disable=no-member
 
     # search the created user
     res = search_users(
@@ -63,4 +71,10 @@ def create_admin(ctx, email, password):
         click.secho("Admin was not correctly created", fg="red")
         ctx.exit(1)
 
-    click.secho(f'Admin with email "{res.pop().email}" correctly created', fg="green")
+    user = res.pop()
+
+    if not user.is_admin:
+        click.secho("Created user is not admin", fg="red")
+        ctx.exit(1)
+
+    click.secho(f'Admin with email "{user.email}" correctly created', fg="green")

plugins/autocreate/autocreate/plugin.py

@@ -1,3 +1,7 @@
+#!/usr/bin/env python3
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 """Connect our CLI plugin to the existing Indico's CLI."""
 
 from autocreate.cli import cli
@@ -15,5 +19,7 @@ def init(self):
         super().init()
         self.connect(signals.plugin.cli, self._extend_indico_cli)
 
-    def _extend_indico_cli(self, sender, **kwargs):
+    # We need those arguments when extending indico's CLI
+    # pylint: disable=unused-argument
+    def _extend_indico_cli(self, *args, **kwargs):
         return cli

src/charm.py

@@ -690,7 +690,7 @@ def _get_indico_env_config(self, container: Container) -> Dict:
 
     def _get_indico_env_config_str(self, container: Container) -> Dict[str, str]:
         indico_env_config = self._get_indico_env_config(container)
-        return {k: str(v) for k, v in indico_env_config.items()}
+        return {env_name: str(value) for env_name, value in indico_env_config.items()}
 
     def _get_http_proxy_configuration(self) -> Dict[str, str]:
         """Generate http proxy config.
@@ -924,11 +924,11 @@ def _add_admin_action(self, event: ActionEvent) -> None:
                 output = process.wait_output()
                 event.set_results({"user": f"{event.params['email']}", "output": output})
             except ExecError as ex:
-                logger.exception("Action add-admin failed")
+                logger.exception("Action add-admin failed: %s", ex.stdout)
 
                 event.fail(
                     # Parameter validation errors are printed to stdout
-                    f"Failed to create admin {event.params['email']}: {ex.stdout}"  # type: ignore
+                    f"Failed to create admin {event.params['email']}: {ex.stdout!r}"
                 )
 
 

tests/integration/test_charm.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright 2022 Canonical Ltd.
+# Copyright 2023 Canonical Ltd.
 # See LICENSE file for licensing details.
 
 """Indico charm integration tests."""
@@ -100,16 +100,20 @@ async def test_health_checks(app: Application):
 @pytest.mark.asyncio
 @pytest.mark.abort_on_fail
 async def test_add_admin(app: Application):
-    """Test the add-admin action.
-
-    Assume that the charm has already been built and is running.
+    """
+    arrange: given charm in its initial state
+    act: run the add-admin action
+    assert: check the output in the action result
     """
 
+    # Application actually does have units
     assert app.units[0]  # type: ignore
 
     email = "[email protected]"
+    # This is a test password
     password = "somepassword"  # nosec
 
+    # Application actually does have units
     action: juju.action.Action = await app.units[0].run_action(  # type: ignore
         "add-admin", email=email, password=password
     )

tests/unit/test_actions.py

@@ -133,10 +133,12 @@ def test_add_admin_fail(self, mock_exec):
             return_value=("", None),
         )
 
+        stdout_mock = "CRASH"
+
         # I'm disabling unused-argument here because some could be passed to the mock
         def mock_wo_side_effect(*args, **kwargs):  # pylint: disable=unused-argument
             if isinstance(mock_wo.cmd, list) and "autocreate" in mock_wo.cmd:
-                raise ExecError(command=mock_wo.cmd, exit_code=42, stdout="CRASH", stderr="")
+                raise ExecError(command=mock_wo.cmd, exit_code=42, stdout=stdout_mock, stderr="")
             return DEFAULT
 
         mock_wo.side_effect = mock_wo_side_effect
@@ -193,7 +195,7 @@ def event_store_failure(arg):
         ]
 
         charm._add_admin_action(event)
-        assert event.fail_message == "Failed to create admin sample@email.com: CRASH"
+        assert event.fail_message == f"Failed to create admin {email}: '{stdout_mock}'"
 
         mock_exec.assert_any_call(
             expected_cmd,

tox.ini

@@ -9,8 +9,9 @@ envlist = lint, unit, static, coverage-report
 [vars]
 src_path = {toxinidir}/src/
 tst_path = {toxinidir}/tests/
+plugins_path = {toxinidir}/plugins/
 ;lib_path = {toxinidir}/lib/charms/operator_name_with_underscores
-all_path = {[vars]src_path} {[vars]tst_path}
+all_path = {[vars]src_path} {[vars]tst_path} {[vars]plugins_path}
 
 [testenv]
 setenv =
@@ -42,9 +43,11 @@ deps =
     flake8-docstrings>=1.6.0
     flake8-docstrings-complete>=1.0.3
     flake8-test-docs>=1.0
+    indico==3.2.0
     isort
     mypy
     pep8-naming
+    plugins/autocreate
     pydocstyle>=2.10
     pylint
     pyproject-flake8<6.0.0