feat(radiation_protection): automatically creates radiation certification when starting app

- Removed direct usage of environment variable for radiation protection certification name in settings and other modules.
- Introduced a new constants file to define the radiation protection certification name.
- Updated related code and tests to reference the new constant, ensuring consistency and maintainability.
- Cleaned up README and workflow files by removing obsolete environment variable references.

Author: wiwski

.github/workflows/test.yaml

@@ -16,7 +16,6 @@ env:
   PYTHON_VERSION: 3.12.8
   EUPHROSYNE_TOOLS_API_URL: http://localhost:8001
   EROS_HTTP_TOKEN: token
-  RADIATION_PROTECTION_CERTIFICATION_NAME: quiz
   RADIATION_PROTECTION_TALLY_SECRET_KEY: secret
   RADIATION_PROTECTION_RISK_ADVISOR_EMAIL: test@test.com
 

README.md

@@ -58,7 +58,6 @@ You can copy this file to a new `.env` file to easily set up your environment.
 | CGU_ACCEPTANCE_DATE                     | Optional. Deadline from which users must accept the new Terms of Use. If a user has not accepted by this date, they will be redirected to the acceptance page                                                                 |
 | MATOMO_SITE_ID                          | Matomo site ID for analytics                                                                                                                                                                                                  |
 | ORCID_USE_SANDBOX                       | ORCID authentication environment selection. If set to 'true', sandbox environment is used. Defaults to false                                                                                                                  |
-| RADIATION_PROTECTION_CERTIFICATION_NAME | Nom de la certification New AGLAE de radioprotection dans la base de données (modèle `certification.certifications.models.Certification`)                                                                                     |
 | RADIATION_PROTECTION_TALLY_SECRET_KEY   | Clé secrète utilisé pour sécuriser le webhook où Tally poste les résultats du quiz de radioprotection. Elle se trouve sur la page de configuration des integrations dans le formulaire Tally (via https://tally.so/dashboard) |
 | SITE_URL                                | The URL of this Euphrosyne instance                                                                                                                                                                                           |
 | SENTRY_DSN                              | Optional. Sentry DSN. If omitted, Sentry will not be used                                                                                                                                                                     |

certification/notifications/tests/test_send_notifications_command.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from unittest import mock
+
 import pytest
 from django.core import mail
 from django.core.management import call_command

euphrosyne/settings.py

@@ -392,9 +392,6 @@ def _get_nav_items(request: HttpRequest) -> list:
 METHOD_MODEL_CLASS = "euphrosyne.methods.models.EuphrosyneMethodModel"
 
 # CERTIFICATIONS
-RADIATION_PROTECTION_CERTIFICATION_NAME = os.environ[
-    "RADIATION_PROTECTION_CERTIFICATION_NAME"
-]
 RADIATION_PROTECTION_TALLY_SECRET_KEY = os.environ[
     "RADIATION_PROTECTION_TALLY_SECRET_KEY"
 ]

radiation_protection/certification.py

@@ -2,14 +2,14 @@
 import typing
 from functools import lru_cache
 
-from django.conf import settings
-
 from certification.certifications.models import Certification
 from certification.notifications.models import (
     CertificationNotification,
     NotificationType,
 )
 
+from .constants import RADIATION_PROTECTION_CERTIFICATION_NAME
+
 if typing.TYPE_CHECKING:
     from euphro_auth.models import User
 
@@ -18,9 +18,7 @@
 
 @lru_cache
 def _get_radioprotection_certification() -> Certification:
-    return Certification.objects.get(
-        name=settings.RADIATION_PROTECTION_CERTIFICATION_NAME
-    )
+    return Certification.objects.get(name=RADIATION_PROTECTION_CERTIFICATION_NAME)
 
 
 def check_radio_protection_certification(user: "User"):
@@ -35,7 +33,7 @@ def user_has_active_certification(user: "User") -> bool:
     except Certification.DoesNotExist:
         logger.error(
             "Radiation protection certification %s does not exist.",
-            settings.RADIATION_PROTECTION_CERTIFICATION_NAME,
+            RADIATION_PROTECTION_CERTIFICATION_NAME,
         )
         return False
     return certification.user_has_valid_participation(user)

radiation_protection/constants.py

@@ -0,0 +1 @@
+RADIATION_PROTECTION_CERTIFICATION_NAME = "Radiation protection"

radiation_protection/migrations/0001_initial.py

@@ -0,0 +1,41 @@
+from django.db import migrations
+
+
+def create_radiation_protection_certification(apps, schema_editor):
+    """Create the radiation protection certification."""
+    from ..constants import RADIATION_PROTECTION_CERTIFICATION_NAME
+    from certification.certifications.models import CertificationType
+
+    Certification = apps.get_model("certification", "Certification")
+
+    Certification.objects.get_or_create(
+        name=RADIATION_PROTECTION_CERTIFICATION_NAME,
+        defaults={
+            "type_of": CertificationType.QUIZ,
+            "description": "Radiation protection certification for AGLAE beamline users",
+            "num_days_valid": 365,
+            "invitation_to_complete_email_template_path": "radiation_protection/email/radioprotection_invitation.html",
+            "success_email_template_path": "radiation_protection/email/radioprotection_success.html",
+        },
+    )
+
+
+def remove_radiation_protection_certification(apps, schema_editor):
+    """Remove the radiation protection certification."""
+    from ..constants import RADIATION_PROTECTION_CERTIFICATION_NAME
+
+    Certification = apps.get_model("certification", "Certification")
+    Certification.objects.filter(name=RADIATION_PROTECTION_CERTIFICATION_NAME).delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("certification", "0002_alter_certificationnotification_type_of"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            create_radiation_protection_certification,
+            remove_radiation_protection_certification,
+        ),
+    ]

radiation_protection/migrations/__init__.py

@@ -1,7 +1,6 @@
 import logging
 from typing import Type, cast
 
-from django.conf import settings
 from django.db.models.signals import post_save
 from django.dispatch import receiver
 from django.utils import timezone
@@ -10,6 +9,7 @@
 from lab.participations.models import Participation
 from lab.runs.models import Run
 
+from .constants import RADIATION_PROTECTION_CERTIFICATION_NAME
 from .document import (
     fill_radiation_protection_documents,
     send_document_to_risk_advisor,
@@ -35,10 +35,7 @@ def handle_radiation_protection_certification(
 
     try:
         # Check if this is for the radiation protection certification
-        if (
-            instance.quiz.certification.name
-            != settings.RADIATION_PROTECTION_CERTIFICATION_NAME
-        ):
+        if instance.quiz.certification.name != RADIATION_PROTECTION_CERTIFICATION_NAME:
             return
 
         # Only proceed if the user passed the quiz

radiation_protection/signals.py

@@ -19,16 +19,14 @@
     create_invitation_notification,
     user_has_active_certification,
 )
-
-
-@pytest.fixture(autouse=True)
-def set_certification_name_settings(settings):
-    settings.RADIATION_PROTECTION_CERTIFICATION_NAME = "radiation"
+from radiation_protection.constants import RADIATION_PROTECTION_CERTIFICATION_NAME
 
 
 @pytest.fixture(name="certification")
 def certification_fixture():
-    return Certification.objects.create(name="radiation", num_days_valid=5)
+    return Certification.objects.create(
+        name=RADIATION_PROTECTION_CERTIFICATION_NAME, num_days_valid=5
+    )
 
 
 @pytest.fixture(name="quiz")