fixed tests and linting

src-docs/charm.py.md

@@ -0,0 +1,98 @@
+<!-- markdownlint-disable -->
+
+<a href="../src/charm.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `charm.py`
+Charm for Discourse on kubernetes. 
+
+**Global Variables**
+---------------
+- **DEFAULT_RELATION_NAME**
+- **DATABASE_NAME**
+- **DISCOURSE_PATH**
+- **THROTTLE_LEVELS**
+- **LOG_PATHS**
+- **PROMETHEUS_PORT**
+- **REQUIRED_S3_SETTINGS**
+- **SCRIPT_PATH**
+- **SERVICE_NAME**
+- **CONTAINER_NAME**
+- **CONTAINER_APP_USERNAME**
+- **SERVICE_PORT**
+- **SETUP_COMPLETED_FLAG_FILE**
+- **DATABASE_RELATION_NAME**
+
+
+---
+
+## <kbd>class</kbd> `DiscourseCharm`
+Charm for Discourse on kubernetes. 
+
+<a href="../src/charm.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `__init__`
+
+```python
+__init__(*args)
+```
+
+Initialize defaults and event handlers. 
+
+
+---
+
+#### <kbd>property</kbd> app
+
+Application that this unit is part of. 
+
+---
+
+#### <kbd>property</kbd> charm_dir
+
+Root directory of the charm as it is running. 
+
+---
+
+#### <kbd>property</kbd> config
+
+A mapping containing the charm's config and current values. 
+
+---
+
+#### <kbd>property</kbd> meta
+
+Metadata of this charm. 
+
+---
+
+#### <kbd>property</kbd> model
+
+Shortcut for more simple access the model. 
+
+---
+
+#### <kbd>property</kbd> unit
+
+Unit that this execution is responsible for. 
+
+
+
+
+---
+
+## <kbd>class</kbd> `MissingRedisRelationDataError`
+Custom exception to be raised in case of malformed/missing redis relation data. 
+
+
+
+
+
+---
+
+## <kbd>class</kbd> `S3Info`
+S3Info(enabled, region, bucket, endpoint) 
+
+
+
+
+

src-docs/database.py.md

@@ -0,0 +1,79 @@
+<!-- markdownlint-disable -->
+
+<a href="../src/database.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `database.py`
+Provide the DatabaseObserver class to handle database relation and state. 
+
+**Global Variables**
+---------------
+- **DATABASE_NAME**
+
+
+---
+
+## <kbd>class</kbd> `DatabaseHandler`
+The Database relation observer. 
+
+<a href="../src/database.py#L18"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `__init__`
+
+```python
+__init__(charm: CharmBase, relation_name)
+```
+
+Initialize the observer and register event handlers. 
+
+
+
+**Args:**
+
+ - <b>`charm`</b>:  The parent charm to attach the observer to. 
+
+
+---
+
+#### <kbd>property</kbd> model
+
+Shortcut for more simple access the model. 
+
+
+
+---
+
+<a href="../src/database.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `get_relation_data`
+
+```python
+get_relation_data() → Dict[str, str]
+```
+
+Get database data from relation. 
+
+
+
+**Returns:**
+
+ - <b>`Dict`</b>:  Information needed for setting environment variables. Returns default if the relation data is not correctly initialized. 
+
+---
+
+<a href="../src/database.py#L79"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+### <kbd>function</kbd> `is_relation_ready`
+
+```python
+is_relation_ready() → bool
+```
+
+Check if the relation is ready. 
+
+
+
+**Returns:**
+
+ - <b>`bool`</b>:  returns True if the relation is ready. 
+
+

src/charm.py

@@ -703,30 +703,31 @@ def _on_add_admin_user_action(self, event: ActionEvent) -> None:
         """
         container = self.unit.get_container(CONTAINER_NAME)
 
+        email = event.params["email"]
+
         if not container.can_connect():
             event.fail("Unable to connect to container, container is not ready")
             return
-
-        self._create_user(event) 
+        self._create_user(event)
 
         process = container.exec(
             [
                 os.path.join(DISCOURSE_PATH, "bin/bundle"),
                 "exec",
                 "rake",
                 "admin:promote",
-                event.params["email"],
+                email,
             ],
             working_dir=DISCOURSE_PATH,
             user=CONTAINER_APP_USERNAME,
             environment=self._create_discourse_environment_settings(),
         )
         try:
             process.wait_output()
-            event.set_results({"user": f"{event.params["email"]}"})
+            event.set_results(email)
         except ExecError as ex:
             event.fail(
-                f"Failed to make user with email {event.params["email"]} an admin: {ex.stdout}"  # type: ignore
+                f"Failed to make user with email {email} an admin: {ex.stdout}"  # type: ignore
             )
 
     def _create_user(self, event: ActionEvent):
@@ -735,16 +736,19 @@ def _create_user(self, event: ActionEvent):
         Args:
             event: Event triggering the create user action.
         """
-
         container = self.unit.get_container(CONTAINER_NAME)
+
+        email = event.params["email"]
+        password = event.params["password"]
+
         process = container.exec(
             [
                 os.path.join(DISCOURSE_PATH, "bin/bundle"),
                 "exec",
                 "rake",
                 "users:create",
             ],
-            stdin=f"{event.params["email"]}\n{event.params["password"]}\n",
+            stdin=f"{email}\n{password}\n",
             working_dir=DISCOURSE_PATH,
             user=CONTAINER_APP_USERNAME,
             environment=self._create_discourse_environment_settings(),
@@ -753,9 +757,7 @@ def _create_user(self, event: ActionEvent):
         try:
             process.wait_output()
         except ExecError as ex:
-            event.fail(
-                f"Failed to create user with email {email}: {ex.stdout}" # type: ignore
-            )
+            event.fail(f"Failed to create user with email {email}: {ex.stdout}")  # type: ignore
 
     def _config_force_https(self) -> None:
         """Config Discourse to force_https option based on charm configuration."""

tests/unit/test_charm.py

@@ -373,7 +373,7 @@ def bundle_handler(args: ops.testing.ExecArgs) -> None:
             args.environment != harness.charm._create_discourse_environment_settings()
             or args.working_dir != DISCOURSE_PATH
             or args.user != "_daemon_"
-            or args.stdin != f"{email}\n{password}\n{password}\n"
+            or args.stdin != f"{email}\n{password}\n"
             or args.timeout != 60
         ):
             raise ValueError(f"{args.command} wasn't made with the correct args.")