update docs and wrap pebble.ExecError with custom error

docs/explanation/moderation-and-spam-control.md

@@ -59,5 +59,4 @@ For details and implementation, visit the module’s repository: [Synapse Invite
 ---
 
 ## Mjolnir
-
-With the arrival of MAS mjolnir has been temporary disabled.
+With the arrival of MAS, mjolnir has been temporary disabled.

src/auth/mas.py

@@ -16,7 +16,6 @@
 logger = logging.getLogger()
 
 MAS_TEMPLATE_FILE_NAME = "mas_config.yaml.j2"
-
 MAS_SERVICE_NAME = "synapse-mas"
 MAS_EXECUTABLE_PATH = "/usr/bin/mas-cli"
 MAS_WORKING_DIR = "/mas"
@@ -46,6 +45,10 @@ class MASConfigInvalidError(Exception):
     """Exception raised when validation of the MAS config failed."""
 
 
+class MASConfigSyncError(Exception):
+    """Exception raised when synchronisation of the MAS config failed."""
+
+
 class MASRegisterUserFailedError(Exception):
     """Exception raised when validation of the MAS config failed."""
 
@@ -54,6 +57,10 @@ class MASVerifyUserEmailFailedError(Exception):
     """Exception raised when validation of the MAS config failed."""
 
 
+class MASDeactivateUserFailedError(Exception):
+    """Exception raised when deactivation of a MAS user failed."""
+
+
 class MASGenerateAdminAccessTokenError(Exception):
     """Exception raised when generation of admin token failed."""
 
@@ -63,21 +70,37 @@ def validate_mas_config(container: ops.model.Container) -> None:
 
     Args:
         container: Synapse container.
+
+    Raises:
+        MASConfigInvalidError: when validation of the MAS config failed.
     """
     command = [MAS_EXECUTABLE_PATH, "config", "check", "-c", MAS_CONFIGURATION_PATH]
-    process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
-    process.wait_output()
+
+    try:
+        process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
+        process.wait_output()
+    except ops.pebble.ExecError as exc:
+        logger.exception("Validation of the MAS config failed.")
+        raise MASConfigInvalidError("Validation of the MAS config failed.") from exc
 
 
 def sync_mas_config(container: ops.model.Container) -> None:
     """Sync the MAS configuration with the database.
 
     Args:
         container: Synapse container.
+
+    Raises:
+        MASConfigSyncError: when synchronisation of the MAS config failed.
     """
     command = [MAS_EXECUTABLE_PATH, "config", "sync", "--prune", "-c", MAS_CONFIGURATION_PATH]
-    process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
-    process.wait()
+
+    try:
+        process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
+        process.wait()
+    except ops.pebble.ExecError as exc:
+        logger.exception("Error syncing MAS config with the database.")
+        raise MASConfigSyncError("Error validating MAS configuration.") from exc
 
 
 def register_user(
@@ -116,7 +139,7 @@ def register_user(
         process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
         process.wait_output()
     except ops.pebble.ExecError as exc:
-        logger.error("Error registering new user: %s", exc.stderr)
+        logger.exception("Error registering new user.")
         raise MASRegisterUserFailedError("Error validating MAS configuration.") from exc
 
     return password
@@ -151,7 +174,7 @@ def verify_user_email(
         process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
         process.wait_output()
     except ops.pebble.ExecError as exc:
-        logger.error("Error verifying the user email: %s", exc.stderr)
+        logger.exception("Error verifying the user email.")
         raise MASVerifyUserEmailFailedError("Error verifying the user email.") from exc
 
 
@@ -161,6 +184,9 @@ def deactivate_user(container: ops.model.Container, username: str) -> None:
     Args:
         container: Synapse container.
         username: Username to create the access token.
+
+    Raises:
+        MASDeactivateUserFailedError: when deactivation of the user fails
     """
     command = [
         MAS_EXECUTABLE_PATH,
@@ -172,8 +198,12 @@ def deactivate_user(container: ops.model.Container, username: str) -> None:
         username,
     ]
 
-    process = container.exec(command=command, working_dir=MAS_WORKING_DIR, combine_stderr=True)
-    process.wait_output()
+    try:
+        process = container.exec(command=command, working_dir=MAS_WORKING_DIR)
+        process.wait_output()
+    except ops.pebble.ExecError as exc:
+        logger.error("Error registering new user: %s", exc.stderr)
+        raise MASDeactivateUserFailedError("Error deactivating user.") from exc
 
 
 def generate_mas_config(

src/charm.py

@@ -20,6 +20,7 @@
 import pebble
 import synapse
 from auth.mas import (
+    MASDeactivateUserFailedError,
     MASRegisterUserFailedError,
     MASVerifyUserEmailFailedError,
     deactivate_user,
@@ -537,7 +538,6 @@ def _on_verify_user_email_action(self, event: ActionEvent) -> None:
         results = {"verify-user-email": True}
         event.set_results(results)
 
-    @validate_charm_state
     def _on_anonymize_user_action(self, event: ActionEvent) -> None:
         """Anonymize user and report action result.
 
@@ -551,7 +551,7 @@ def _on_anonymize_user_action(self, event: ActionEvent) -> None:
 
         try:
             deactivate_user(container=container, username=event.params["username"])
-        except ops.pebble.ExecError as exc:
+        except MASDeactivateUserFailedError as exc:
             logger.exception("Error deactivating user.")
             event.fail(str(exc))