Merge pull request #696 from maykinmedia/fix/691-multiple-services-configured

[#691] Multiple services configured

Author: SilviaAmAm

backend/src/openarchiefbeheer/destruction/models.py

@@ -19,11 +19,11 @@
 from timeline_logger.models import TimelineLog
 from zgw_consumers.client import build_client
 from zgw_consumers.constants import APITypes
-from zgw_consumers.models import Service
 
 from openarchiefbeheer.accounts.models import User
 from openarchiefbeheer.config.models import ArchiveConfig
 from openarchiefbeheer.utils.results_store import ResultStore
+from openarchiefbeheer.utils.services import get_service
 from openarchiefbeheer.zaken.utils import (
     delete_zaak_and_related_objects,
     get_zaak_metadata,
@@ -286,7 +286,7 @@ def get_destruction_report_url(self) -> str | None:
         if not self.zaak_destruction_report_url:
             return
 
-        zrc_service = Service.objects.get(api_type=APITypes.zrc)
+        zrc_service = get_service(APITypes.zrc)
         zrc_client = build_client(zrc_service)
 
         with zrc_client:

backend/src/openarchiefbeheer/destruction/utils.py

@@ -10,7 +10,6 @@
 
 from zgw_consumers.client import build_client
 from zgw_consumers.constants import APITypes
-from zgw_consumers.models import Service
 
 from openarchiefbeheer.accounts.models import User
 from openarchiefbeheer.config.models import ArchiveConfig
@@ -19,6 +18,7 @@
 from openarchiefbeheer.logging import logevent
 from openarchiefbeheer.selection.models import SelectionItem
 from openarchiefbeheer.utils.results_store import ResultStore
+from openarchiefbeheer.utils.services import get_service
 from openarchiefbeheer.zaken.models import Zaak
 
 from .constants import (
@@ -177,7 +177,7 @@ def create_zaak_for_report(
 ) -> None:
     config = ArchiveConfig.get_solo()
 
-    zrc_service = Service.objects.get(api_type=APITypes.zrc)
+    zrc_service = get_service(APITypes.zrc)
     zrc_client = build_client(zrc_service)
 
     with zrc_client:
@@ -240,7 +240,7 @@ def create_eio_destruction_report(
 
     config = ArchiveConfig.get_solo()
 
-    drc_service = Service.objects.get(api_type=APITypes.drc)
+    drc_service = get_service(APITypes.drc)
     drc_client = build_client(drc_service)
 
     with drc_client, destruction_list.destruction_report.open("rb") as f_report:
@@ -271,7 +271,7 @@ def attach_report_to_zaak(
     if store.has_created_resource("zaakinformatieobjecten"):
         return
 
-    zrc_service = Service.objects.get(api_type=APITypes.zrc)
+    zrc_service = get_service(APITypes.zrc)
     zrc_client = build_client(zrc_service)
 
     with zrc_client:

backend/src/openarchiefbeheer/utils/exceptions.py

@@ -0,0 +1,2 @@
+class NoServiceConfigured(Exception):
+    pass

backend/src/openarchiefbeheer/utils/services.py

@@ -0,0 +1,11 @@
+from zgw_consumers.constants import APITypes
+from zgw_consumers.models import Service
+
+from .exceptions import NoServiceConfigured
+
+
+def get_service(service_type: APITypes) -> Service:
+    service = Service.objects.filter(api_type=service_type).first()
+    if not service:
+        raise NoServiceConfigured(f"No service configured of type {service_type}.")
+    return service

backend/src/openarchiefbeheer/utils/tests/test_utils.py

@@ -0,0 +1,15 @@
+from django.test import TestCase
+
+from zgw_consumers.constants import APITypes
+from zgw_consumers.models import Service
+
+from ..exceptions import NoServiceConfigured
+from ..services import get_service
+
+
+class UtilsTests(TestCase):
+    def test_no_zaak_services_configured(self):
+        Service.objects.filter(api_type=APITypes.zrc).delete()
+
+        with self.assertRaises(NoServiceConfigured):
+            get_service(APITypes.zrc)

backend/src/openarchiefbeheer/zaken/models.py

@@ -5,7 +5,8 @@
 
 from zgw_consumers.client import build_client
 from zgw_consumers.constants import APITypes
-from zgw_consumers.models import Service
+
+from openarchiefbeheer.utils.services import get_service
 
 
 class Zaak(models.Model):
@@ -112,7 +113,7 @@ def __str__(self):
     def update_data(self, data: dict) -> None:
         from .api.serializers import ZaakSerializer
 
-        zrc_service = Service.objects.get(api_type=APITypes.zrc)
+        zrc_service = get_service(APITypes.zrc)
         zrc_client = build_client(zrc_service)
 
         with zrc_client:

backend/src/openarchiefbeheer/zaken/tasks.py

@@ -9,12 +9,12 @@
 from requests.adapters import HTTPAdapter, Retry
 from zgw_consumers.client import build_client
 from zgw_consumers.constants import APITypes
-from zgw_consumers.models import Service
 
 from openarchiefbeheer.celery import app
 from openarchiefbeheer.config.models import APIConfig
 from openarchiefbeheer.destruction.utils import resync_items_and_zaken
 from openarchiefbeheer.logging import logevent
+from openarchiefbeheer.utils.services import get_service
 
 from .api.serializers import ZaakSerializer
 from .decorators import log_errors
@@ -36,7 +36,7 @@ def configure_retry(client: APIClient) -> APIClient:
 
 
 def retrieve_and_cache_zaken(is_full_resync=False):
-    zrc_service = Service.objects.get(api_type=APITypes.zrc)
+    zrc_service = get_service(APITypes.zrc)
     zrc_client = build_client(zrc_service)
     zrc_client = configure_retry(zrc_client)
 

backend/src/openarchiefbeheer/zaken/tests/vcr/test_utils.py

@@ -4,11 +4,11 @@
 from vcr.unittest import VCRMixin
 from zgw_consumers.client import build_client
 from zgw_consumers.constants import APITypes
-from zgw_consumers.models import Service
 from zgw_consumers.test.factories import ServiceFactory
 
 from openarchiefbeheer.destruction.tests.factories import DestructionListItemFactory
 from openarchiefbeheer.utils.results_store import ResultStore
+from openarchiefbeheer.utils.services import get_service
 from openarchiefbeheer.utils.utils_decorators import reload_openzaak_fixtures
 
 from ...models import Zaak
@@ -54,7 +54,7 @@ def test_delete_zaak_related_to_besluit_related_to_document(self):
 
         delete_zaak_and_related_objects(destruction_list_item.zaak, result_store)
 
-        zrc_service = Service.objects.get(api_type=APITypes.zrc)
+        zrc_service = get_service(APITypes.zrc)
         zrc_client = build_client(zrc_service)
 
         with zrc_client:
@@ -65,7 +65,7 @@ def test_delete_zaak_related_to_besluit_related_to_document(self):
 
             self.assertEqual(data["count"], 102)
 
-        drc_service = Service.objects.get(api_type=APITypes.drc)
+        drc_service = get_service(APITypes.drc)
         drc_client = build_client(drc_service)
         with drc_client:
             response = drc_client.get("enkelvoudiginformatieobjecten")
@@ -80,7 +80,7 @@ def test_delete_zaak_related_to_besluit_related_to_document(self):
             self.assertIn("DOCUMENT-01", identificaties)
             self.assertIn("DOCUMENT-03", identificaties)
 
-        brc_service = Service.objects.get(api_type=APITypes.brc)
+        brc_service = get_service(APITypes.brc)
         brc_client = build_client(brc_service)
         with brc_client:
             response = brc_client.get("besluiten")

backend/src/openarchiefbeheer/zaken/utils.py

@@ -25,6 +25,7 @@
 from openarchiefbeheer.config.models import APIConfig
 from openarchiefbeheer.utils.datastructure import HashableDict
 from openarchiefbeheer.utils.results_store import ResultStore
+from openarchiefbeheer.utils.services import get_service
 
 from .models import Zaak
 from .types import DropDownChoice
@@ -267,7 +268,7 @@ def delete_decisions_and_relation_objects(
 
     This automatically deletes ZaakBesluiten in the Zaken API.
     """
-    brc_service = Service.objects.get(api_type=APITypes.brc)
+    brc_service = get_service(APITypes.brc)
     brc_client = build_client(brc_service)
 
     with brc_client:
@@ -338,7 +339,7 @@ def delete_relation_object(
 
 
 def delete_documents(result_store: ResultStore) -> None:
-    drc_service = Service.objects.get(api_type=APITypes.drc)
+    drc_service = get_service(APITypes.drc)
     drc_client = build_client(drc_service)
 
     with drc_client:
@@ -393,7 +394,7 @@ def delete_zaak_and_related_objects(zaak: "Zaak", result_store: ResultStore) ->
     If an error occurs after deleting the ZIOs, we wouldn't know which documents
     should be deleted.
     """
-    zrc_service = Service.objects.get(api_type=APITypes.zrc)
+    zrc_service = get_service(APITypes.zrc)
     zrc_client = build_client(zrc_service)
 
     delete_decisions_and_relation_objects(zaak, result_store)
@@ -409,7 +410,7 @@ def retrieve_paginated_type(
     def format_choice(item: dict) -> DropDownChoice:
         return {"label": item["omschrijving"] or item["url"], "value": item["url"]}
 
-    ztc_service = Service.objects.get(api_type=APITypes.ztc)
+    ztc_service = get_service(APITypes.ztc)
     ztc_client = build_client(ztc_service)
 
     with ztc_client:
@@ -433,7 +434,7 @@ def get_zaak_metadata(zaak: Zaak) -> dict:
 
 @lru_cache
 def retrieve_zaaktypen(query_params: HashableDict | None = None) -> list[dict]:
-    ztc_service = Service.objects.get(api_type=APITypes.ztc)
+    ztc_service = get_service(APITypes.ztc)
     ztc_client = build_client(ztc_service)
 
     with ztc_client: