✨ [#458] Add services setup configuration steps

Author: SilviaAmAm

backend/src/openarchiefbeheer/conf/base.py

@@ -646,8 +646,17 @@
     "OIDC_RENEW_ID_TOKEN_EXPIRY_SECONDS", default=60 * 15
 )
 
+#
 # Django privates
 #
 PRIVATE_MEDIA_ROOT = os.path.join(BASE_DIR, "private_media")
 
 PRIVATE_MEDIA_URL = "/private-media/"
+
+#
+# Django setup configuration
+#
+SETUP_CONFIGURATION_STEPS = [
+    "zgw_consumers.contrib.setup_configuration.steps.ServiceConfigurationStep",
+    "openarchiefbeheer.config.setup_configuration.steps.APIConfigConfigurationStep",
+]

backend/src/openarchiefbeheer/config/setup_configuration/__init__.py

@@ -0,0 +1,10 @@
+from django_setup_configuration import ConfigurationModel
+from django_setup_configuration.fields import DjangoModelRef
+
+from ..models import APIConfig
+
+
+class APIConfigConfigurationModel(ConfigurationModel):
+    selectielijst_service_identifier: str = DjangoModelRef(
+        APIConfig, "selectielijst_api_service"
+    )

backend/src/openarchiefbeheer/config/setup_configuration/models.py

@@ -0,0 +1,40 @@
+from django_setup_configuration import BaseConfigurationStep
+from zgw_consumers.models import Service
+
+from ..models import APIConfig
+from .models import APIConfigConfigurationModel
+
+
+def get_service(slug: str) -> Service:
+    """
+    Try to find a Service and re-raise DoesNotExist with the identifier to make debugging
+    easier
+    """
+    try:
+        return Service.objects.get(slug=slug)
+    except Service.DoesNotExist as e:
+        raise Service.DoesNotExist(f"{str(e)} (identifier = {slug})")
+
+
+class APIConfigConfigurationStep(BaseConfigurationStep[APIConfigConfigurationModel]):
+    """Configure API settings"""
+
+    config_model = APIConfigConfigurationModel
+    enable_setting = "api_configuration_enabled"
+    namespace = "api_configuration"
+    verbose_name = "API Configuration"
+
+    def execute(self, model: APIConfigConfigurationModel) -> None:
+        service = get_service(model.selectielijst_service_identifier)
+
+        config = APIConfig.get_solo()
+
+        # Idempotent configuration
+        if (
+            config.selectielijst_api_service
+            and service.pk == config.selectielijst_api_service.pk
+        ):
+            return
+
+        config.selectielijst_api_service = service
+        config.save()

backend/src/openarchiefbeheer/config/setup_configuration/steps.py

@@ -0,0 +1,45 @@
+zgw_consumers_config_enable: True
+zgw_consumers:
+  services:
+  - identifier: zaken-test
+    label: Open Zaak - Zaken API
+    oas: http://localhost:8003/zaken/api/v1/schema/openapi.yaml
+    api_root: http://localhost:8003/zaken/api/v1/
+    api_type: zrc
+    auth_type: zgw
+    client_id: test-vcr
+    secret: test-vcr
+  - identifier: documenten-test
+    label: Open Zaak - Documenten API
+    oas: http://localhost:8003/documenten/api/v1/schema/openapi.yaml
+    api_root: http://localhost:8003/documenten/api/v1/
+    api_type: drc
+    auth_type: zgw
+    client_id: test-vcr
+    secret: test-vcr
+  - identifier: catalogi-test
+    label: Open Zaak - Catalogi API
+    oas: http://localhost:8003/catalogi/api/v1/schema/openapi.yaml
+    api_root: http://localhost:8003/catalogi/api/v1/
+    api_type: ztc
+    auth_type: zgw
+    client_id: test-vcr
+    secret: test-vcr
+  - identifier: besluiten-test
+    label: Open Zaak - Besluiten API
+    oas: http://localhost:8003/besluiten/api/v1/schema/openapi.yaml
+    api_root: http://localhost:8003/besluiten/api/v1/
+    api_type: brc
+    auth_type: zgw
+    client_id: test-vcr
+    secret: test-vcr
+  - identifier: selectielijst
+    label: Open Zaak (public) - Selectielijst API
+    oas: https://selectielijst.openzaak.nl/api/v1/schema/openapi.yaml
+    api_root: https://selectielijst.openzaak.nl/api/v1/
+    api_type: orc
+    auth_type: no_auth
+
+api_configuration_enabled: True
+api_configuration:
+  selectielijst_service_identifier: selectielijst