feat/ISD-3609: Add multi-level category setting to charm config (#341)

* feat/ISD-3609: Add multi-level category setting to charm config

* feat/ISD-3609: Adding a config check to make sure the setting is either 2 or 3.

Author: DeeKay3

config.yaml

@@ -35,6 +35,10 @@ options:
     type: boolean
     description: "Force SAML login (full screen, no local database logins)."
     default: false
+  max_category_nesting:
+    type: int
+    description: "Maximum category nesting allowed. Minimum is 2, maximum is 3."
+    default: 2
   saml_sync_groups:
     type: string
     description: "Comma-separated list of groups to sync from SAML provider."

src/charm.py

@@ -69,6 +69,7 @@
     f"{DISCOURSE_PATH}/log/unicorn.stderr.log",
     f"{DISCOURSE_PATH}/log/unicorn.stdout.log",
 ]
+MAX_CATEGORY_NESTING_LEVELS = [2, 3]
 PROMETHEUS_PORT = 3000
 REQUIRED_S3_SETTINGS = ["s3_access_key_id", "s3_bucket", "s3_region", "s3_secret_access_key"]
 SCRIPT_PATH = "/srv/scripts"
@@ -311,7 +312,11 @@ def _is_config_valid(self) -> bool:
             and self.model.get_relation(DEFAULT_RELATION_NAME) is None
         ):
             errors.append("force_saml_login cannot be true without a saml relation")
-
+        if self.config["max_category_nesting"] not in MAX_CATEGORY_NESTING_LEVELS:
+            errors.append(
+                "max_category_nesting must be one of: "
+                f"{', '.join(map(str, MAX_CATEGORY_NESTING_LEVELS))}"
+            )
         if (
             self.config["saml_sync_groups"]
             and self.model.get_relation(DEFAULT_RELATION_NAME) is None
@@ -465,6 +470,7 @@ def _create_discourse_environment_settings(self) -> typing.Dict[str, str]:
             "DISCOURSE_DEVELOPER_EMAILS": self.config["developer_emails"],
             "DISCOURSE_ENABLE_CORS": str(self.config["enable_cors"]).lower(),
             "DISCOURSE_HOSTNAME": self._get_external_hostname(),
+            "DISCOURSE_MAX_CATEGORY_NESTING": str(self.config["max_category_nesting"]),
             "DISCOURSE_REDIS_HOST": redis_relation_data[0],
             "DISCOURSE_REDIS_PORT": str(redis_relation_data[1]),
             "DISCOURSE_REFRESH_MAXMIND_DB_DURING_PRECOMPILE_DAYS": "0",

tests/unit_harness/test_charm.py

@@ -201,6 +201,7 @@ def bundle_handler(args: ops.testing.ExecArgs) -> None:
     assert "someuser" == updated_plan_env["DISCOURSE_DB_USERNAME"]
     assert updated_plan_env["DISCOURSE_ENABLE_CORS"]
     assert "discourse-k8s" == updated_plan_env["DISCOURSE_HOSTNAME"]
+    assert "2" == updated_plan_env["DISCOURSE_MAX_CATEGORY_NESTING"]
     assert "redis-host" == updated_plan_env["DISCOURSE_REDIS_HOST"]
     assert "1010" == updated_plan_env["DISCOURSE_REDIS_PORT"]
     assert updated_plan_env["DISCOURSE_SERVE_STATIC_ASSETS"]
@@ -258,6 +259,7 @@ def test_on_config_changed_when_valid():
     assert "[email protected]" == updated_plan_env["DISCOURSE_DEVELOPER_EMAILS"]
     assert updated_plan_env["DISCOURSE_ENABLE_CORS"]
     assert "discourse.local" == updated_plan_env["DISCOURSE_HOSTNAME"]
+    assert "2" == updated_plan_env["DISCOURSE_MAX_CATEGORY_NESTING"]
     assert "redis-host" == updated_plan_env["DISCOURSE_REDIS_HOST"]
     assert "1010" == updated_plan_env["DISCOURSE_REDIS_PORT"]
     assert updated_plan_env["DISCOURSE_SAML_CERT_FINGERPRINT"] is not None