refactor the settings

Signed-off-by: tdruez <tdruez@aboutcode.org>

Author: tdruez

dejacode/settings.py

@@ -662,16 +662,10 @@ def get_fake_redis_connection(config, use_strict_redis):
 # django-altcha
 ALTCHA_HMAC_KEY = env.str("DEJACODE_ALTCHA_HMAC_KEY", default="")
 
-WEBHOOK_EVENTS = [
-    "request.added",
-    "request.updated",
-    "request_comment.added",
-    "user.added_or_updated",
-    "user.locked_out",
-    "vulnerability.data_update",
-]
 # Provide context variables to WebhookSubscription extra_headers template values.
-HOOK_ENV = env.dict("HOOK_ENV", default={})
+# HOOK_ENV is the legacy name, kept for backward compatibility.
+_legacy_hook_env = env.dict("HOOK_ENV", default={})
+DEJACODE_WEBHOOK_ENV = env.dict("DEJACODE_WEBHOOK_ENV", default=_legacy_hook_env)
 
 # Django-axes
 # Enable or disable Axes plugin functionality

notification/admin.py

@@ -7,18 +7,18 @@
 #
 
 from django import forms
-from django.conf import settings
 from django.contrib import admin
 
 from dje.admin import DataspacedAdmin
 from dje.admin import ProhibitDataspaceLookupMixin
 from dje.admin import dejacode_site
 from dje.forms import DataspacedAdminForm
+from notification.models import WEBHOOK_EVENTS
 from notification.models import WebhookSubscription
 
 
 class WebhookSubscriptionForm(DataspacedAdminForm):
-    EVENTS = [(event, event) for event in settings.WEBHOOK_EVENTS]
+    EVENTS = [(event, event) for event in WEBHOOK_EVENTS]
 
     class Meta:
         model = WebhookSubscription

notification/models.py

@@ -21,6 +21,15 @@
 
 logger = logging.getLogger("dje")
 
+WEBHOOK_EVENTS = [
+    "request.added",
+    "request.updated",
+    "request_comment.added",
+    "user.added_or_updated",
+    "user.locked_out",
+    "vulnerability.data_update",
+]
+
 
 class WebhookSubscriptionQuerySet(WebhookSubscriptionQuerySetMixin, DataspacedQuerySet):
     pass
@@ -59,7 +68,7 @@ def dict(self):
 
     def get_extra_headers(self):
         """Inject `hook_env` context in headers template values."""
-        if hook_env := settings.HOOK_ENV:
+        if hook_env := settings.DEJACODE_WEBHOOK_ENV:
             hook_env_context = template.Context(hook_env)
             return {
                 key: self.render_template(value, hook_env_context)

notification/tests/test_models.py

@@ -44,5 +44,5 @@ def test_webhook_subscription_get_extra_headers(self):
         self.assertEqual(expected, self.webhook.get_extra_headers())
 
         expected = {"Header": "some_value"}
-        with override_settings(HOOK_ENV={"ENV_VALUE": "some_value"}):
+        with override_settings(DEJACODE_WEBHOOK_ENV={"ENV_VALUE": "some_value"}):
             self.assertEqual(expected, self.webhook.get_extra_headers())