fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! ✨ [#500] Implement Referentielijsten integration for Klantcontact

Author: OlhaZahoruiko

src/openklant/config/tests/test_models.py

@@ -57,41 +57,3 @@ def test_validation_fails_for_invalid_kanaal(self):
         self.assertIn("'fax' is not a valid kanaal", str(cm.exception))
         self.assertIn("email", str(cm.exception))
         self.assertIn("phone", str(cm.exception))
-
-    # @patch(PATCH_TARGET, autospec=True)
-    # def test_validation_succeeds_when_config_is_disabled(self, mock_get_items):
-    #     ReferentielijstenConfig.objects.all().update(enabled=False)
-    #
-    #     validator = KanaalValidator()
-    #
-    #     validator("not-a-real-channel")
-    #     mock_get_items.assert_not_called()
-    #
-    # @patch(PATCH_TARGET, autospec=True)
-    # def test_validation_fails_on_api_400(self, mock_get_items):
-    #     from requests.exceptions import HTTPError
-    #     from requests.models import Response
-    #
-    #     response = Response()
-    #     response.status_code = 400
-    #     mock_get_items.side_effect = HTTPError(response=response)
-    #
-    #     validator = KanaalValidator()
-    #     with self.assertRaises(ValidationError) as cm:
-    #         validator("email")
-    #
-    #     self.assertIn(
-    #         "Failed to retrieve valid channels from the API", str(cm.exception)
-    #     )
-    #
-    # @patch(PATCH_TARGET, autospec=True)
-    # def test_validation_fails_on_api_request_exception(self, mock_get_items):
-    #     mock_get_items.side_effect = RequestException("Timeout occurred")
-    #
-    #     validator = KanaalValidator()
-    #     with self.assertRaises(ValidationError) as cm:
-    #         validator("email")
-    #
-    #     self.assertIn(
-    #         "Failed to retrieve valid channels from the API", str(cm.exception)
-    #     )

src/referentielijsten_client/setup_configuration/steps.py

@@ -29,11 +29,11 @@ def execute(self, model: ReferentielijstenConfigurationModel) -> None:
         logger.info(
             "configuring_referentielijsten",
             enabled=model.enabled,
-            service_identifier=model.service_identifier,
+            service_identifier=model.referentielijsten_api_service_identifier,
         )
 
         service = None
-        if identifier := model.service_identifier:
+        if identifier := model.referentielijsten_api_service_identifier:
             try:
                 service = get_service(identifier)
             except Service.DoesNotExist as exc:
@@ -46,7 +46,7 @@ def execute(self, model: ReferentielijstenConfigurationModel) -> None:
         config_instance.enabled = model.enabled
         config_instance.service = service
 
-        config_instance.kanalen_tabel_code = model.tabel_code
+        config_instance.kanalen_tabel_code = model.kanalen_tabel_code
 
         config_instance.save()
 

src/referentielijsten_client/setup_configuration/test/files/referentielijsten_happy_flow.yaml

@@ -0,0 +1,4 @@
+referentielijsten_config:
+       enabled: true
+       referentielijsten_api_service_identifier: referentielijsten-api-test
+       kanalen_tabel_code: KANAAL

src/referentielijsten_client/setup_configuration/test/files/referentielijsten_idempotent.yaml

@@ -0,0 +1,4 @@
+referentielijsten_config:
+       enabled: true
+       referentielijsten_api_service_identifier: idempotent-service
+       kanalen_tabel_code: TABEL_IDEMPOTENT

src/referentielijsten_client/setup_configuration/test/files/referentielijsten_missing_service.yaml

@@ -0,0 +1,4 @@
+referentielijsten_config:
+   enabled: true
+   referentielijsten_api_service_identifier: non-existent-api
+   kanalen_tabel_code: KANAAL

src/referentielijsten_client/setup_configuration/test/test_client_config_step.py

@@ -0,0 +1,73 @@
+from pathlib import Path
+
+from django.test import TestCase
+
+from django_setup_configuration.exceptions import ConfigurationRunFailed
+from django_setup_configuration.test_utils import execute_single_step
+from zgw_consumers.test.factories import ServiceFactory
+
+from openklant.config.models import ReferentielijstenConfig
+from referentielijsten_client.setup_configuration.steps import (
+    ReferentielijstenConfigurationStep,
+)
+
+TEST_FILES = (Path(__file__).parent / "files").resolve()
+
+
+class ReferentielijstenConfigurationStepTests(TestCase):
+    def setUp(self):
+        ReferentielijstenConfig.objects.all().delete()
+
+    def test_happy_flow(self):
+        service = ServiceFactory(
+            slug="referentielijsten-api-test", api_root="http://test.nl/api/v1"
+        )
+
+        test_file_path = str(TEST_FILES / "referentielijsten_happy_flow.yaml")
+
+        execute_single_step(
+            ReferentielijstenConfigurationStep, yaml_source=test_file_path
+        )
+
+        config = ReferentielijstenConfig.get_solo()
+
+        self.assertTrue(config.enabled)
+        self.assertEqual(config.service, service)
+        self.assertEqual(config.kanalen_tabel_code, "KANAAL")
+
+    def test_error_flow_missing_service(self):
+        test_file_path = str(TEST_FILES / "referentielijsten_missing_service.yaml")
+
+        with self.assertRaises(ConfigurationRunFailed) as cm:
+            execute_single_step(
+                ReferentielijstenConfigurationStep, yaml_source=test_file_path
+            )
+
+        self.assertIn(
+            "Could not find Service with identifier 'non-existent-api'",
+            str(cm.exception),
+        )
+
+        config = ReferentielijstenConfig.get_solo()
+        self.assertFalse(config.enabled)
+        self.assertIsNone(config.service)
+
+    def test_idempotency(self):
+        service = ServiceFactory(
+            slug="idempotent-service", api_root="http://idempotent.nl/api/v1"
+        )
+
+        test_file_path = str(TEST_FILES / "referentielijsten_idempotent.yaml")
+
+        execute_single_step(
+            ReferentielijstenConfigurationStep, yaml_source=test_file_path
+        )
+
+        execute_single_step(
+            ReferentielijstenConfigurationStep, yaml_source=test_file_path
+        )
+
+        config = ReferentielijstenConfig.get_solo()
+        self.assertTrue(config.enabled)
+        self.assertEqual(config.service, service)
+        self.assertEqual(config.kanalen_tabel_code, "TABEL_IDEMPOTENT")