Add OpenKlantConfig configuration step

Author: swrichards

src/open_inwoner/conf/app/setup_configuration.py

@@ -3,6 +3,7 @@
 SETUP_CONFIGURATION_STEPS = [
     "zgw_consumers.contrib.setup_configuration.steps.ServiceConfigurationStep",
     "open_inwoner.configurations.bootstrap.zgw.ZGWAPIsConfigurationStep",
+    "open_inwoner.configurations.bootstrap.openklant.OpenKlantConfigurationStep",
 ]
 OIP_ORGANIZATION = config("OIP_ORGANIZATION", "")
 

src/open_inwoner/configurations/bootstrap/kic.py

@@ -0,0 +1,90 @@
+from django.core.exceptions import ValidationError
+
+from django_setup_configuration.configuration import BaseConfigurationStep
+from django_setup_configuration.exceptions import ConfigurationRunFailed
+from django_setup_configuration.fields import DjangoModelRef
+from django_setup_configuration.models import ConfigurationModel
+from zgw_consumers.constants import APITypes
+from zgw_consumers.models import Service
+
+from open_inwoner.configurations.bootstrap.utils import get_service
+from open_inwoner.openklant.models import OpenKlantConfig
+
+
+class KlantenApiConfigurationModel(ConfigurationModel):
+    klanten_service_identifier: str
+    contactmomenten_service_identifier: str
+    exclude_contactmoment_kanalen: list[str] | None = DjangoModelRef(
+        OpenKlantConfig,
+        "exclude_contactmoment_kanalen",
+        default=None,
+    )
+
+    class Meta:
+        django_model_refs = {
+            OpenKlantConfig: (
+                "register_email",
+                "register_contact_moment",
+                "register_bronorganisatie_rsin",
+                "register_channel",
+                "register_type",
+                "register_employee_id",
+                "use_rsin_for_innNnpId_query_parameter",
+                "send_email_confirmation",
+            )
+        }
+
+
+class OpenKlantConfigurationStep(BaseConfigurationStep[KlantenApiConfigurationModel]):
+    """
+    Configure the KIC settings and set any feature flags or other options if specified
+    """
+
+    verbose_name = "Klantinteractie APIs configuration"
+    enable_setting = "openklant_config_enable"
+    namespace = "openklant_config"
+    config_model = KlantenApiConfigurationModel
+
+    def execute(self, model: KlantenApiConfigurationModel):
+        config = OpenKlantConfig.get_solo()
+
+        try:
+            kc = get_service(model.klanten_service_identifier)
+            if kc.api_type != APITypes.kc:
+                raise ConfigurationRunFailed(
+                    f"Found klanten service with identifier `{kc.slug}`, but expected"
+                    f" `api_type` to equal `{APITypes.kc}` and got `{kc.api_type}`"
+                )
+            config.klanten_service = kc
+
+            cm = get_service(model.contactmomenten_service_identifier)
+            if cm.api_type != APITypes.cmc:
+                raise ConfigurationRunFailed(
+                    f"Found contactmomenten service with identifier `{cm.slug}`, but"
+                    f" expected `api_type` to equal `{APITypes.cmc}` and got "
+                    f"`{cm.api_type}`"
+                )
+
+            config.contactmomenten_service = cm
+        except Service.DoesNotExist as exc:
+            raise ConfigurationRunFailed(
+                "Unable to retrieve `klanten_service` and/or `contactmomenten_service`"
+                ". Try first configuring the `zgw_consumers` configuration steps, and."
+                " ensure that both the `identifier` and `api_type` fields match."
+            ) from exc
+
+        for key, val in model.model_dump(
+            exclude={
+                "klanten_service_identifier",
+                "contactmomenten_service_identifier",
+            }
+        ).items():
+            setattr(config, key, val)
+
+        try:
+            config.full_clean()
+            config.save()
+        except ValidationError as exc:
+            raise ConfigurationRunFailed(
+                "Unable to validate and save configuration"
+            ) from exc

src/open_inwoner/configurations/bootstrap/openklant.py

@@ -0,0 +1,13 @@
+openklant_config_enable: true
+openklant_config:
+  klanten_service_identifier: klanten-service
+  contactmomenten_service_identifier: contactmomenten-service
+  exclude_contactmoment_kanalen: []
+  register_email: [email protected]
+  register_contact_moment: true
+  register_bronorganisatie_rsin: '837194569'
+  register_channel: email
+  register_type: bericht
+  register_employee_id: '1234'
+  use_rsin_for_innNnpId_query_parameter: true
+  send_email_confirmation: false

src/open_inwoner/configurations/tests/bootstrap/files/openklant_config_step_full.yaml

@@ -21,7 +21,7 @@
     CMSProductsConfigurationStep,
     CMSProfileConfigurationStep,
 )
-from open_inwoner.configurations.bootstrap.kic import (
+from open_inwoner.configurations.bootstrap.openklant import (
     ContactmomentenAPIConfigurationStep,
     KICAPIsConfigurationStep,
     KlantenAPIConfigurationStep,