Merge pull request #365 from maykinmedia/feature/349-selectielijst-api

[#349] Specify which Selectielijst service to use

Author: SilviaAmAm

Diff for: backend/bin/docker_start.sh

@@ -26,6 +26,10 @@ done
 >&2 echo "Apply database migrations"
 python src/manage.py migrate
 
+# Load fixtures
+>&2 echo "Loading fixtures"
+python src/manage.py loaddata default_admin_index
+
 # Populate the environment variables for the frontend
 >&2 echo "Replace frontend env vars"
 /replace-envvars.sh

Diff for: backend/docs/configure/index.rst

@@ -0,0 +1,10 @@
+.. _configuration_index:
+
+=================================================
+Configuring Open Archiefbeheer for administrators
+=================================================
+
+.. toctree::
+    :maxdepth: 2
+
+    services

Diff for: backend/docs/configure/services.rst

@@ -0,0 +1,28 @@
+.. _configuration_services:
+
+===========================
+External APIs configuration
+===========================
+
+Checklist
+=========
+
+#. Services need to be configured for: 
+
+   * Zaken API
+   * Catalogi API
+   * Documenten API
+   * Besluiten API
+   * Selectielijst API
+
+#. In the **API configuration**, specify which service should be used for the Selectielijst API.
+
+Services
+========
+
+The services can be configured under **External APIs** > **Services**.
+
+API configuration
+=================
+
+Under **External APIs** > **API configuration** you can select which service should be used to query the Selectielijst API.

Diff for: backend/docs/index.rst

@@ -13,6 +13,7 @@ Documentation
 .. toctree::
     :maxdepth: 3
 
+    configure/index
     general/index
     install/index
     developers/index

Diff for: backend/src/openarchiefbeheer/config/admin.py

@@ -2,9 +2,14 @@
 
 from solo.admin import SingletonModelAdmin
 
-from .models import ArchiveConfig
+from .models import APIConfig, ArchiveConfig
 
 
 @admin.register(ArchiveConfig)
 class ArchiveConfigAdmin(SingletonModelAdmin):
     pass
+
+
+@admin.register(APIConfig)
+class APIConfigAdmin(SingletonModelAdmin):
+    pass

Diff for: backend/src/openarchiefbeheer/config/migrations/0003_apiconfig.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.2.15 on 2024-09-19 10:23
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("zgw_consumers", "0020_service_timeout"),
+        ("config", "0002_alter_archiveconfig_zaaktypes_short_process"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="APIConfig",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "selectielijst_api_service",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="Which service to use to query the Selectielijst API.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="zgw_consumers.service",
+                        verbose_name="selectielijst API service",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "API configuration",
+                "verbose_name_plural": "API configurations",
+            },
+        ),
+    ]

Diff for: backend/src/openarchiefbeheer/config/models.py

@@ -24,3 +24,21 @@ class Meta:
 
     def __str__(self):
         return "Archive configuration"
+
+
+class APIConfig(SingletonModel):
+    selectielijst_api_service = models.ForeignKey(
+        to="zgw_consumers.Service",
+        verbose_name=_("selectielijst API service"),
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        help_text=_("Which service to use to query the Selectielijst API."),
+    )
+
+    class Meta:
+        verbose_name = _("API configuration")
+        verbose_name_plural = _("API configurations")
+
+    def __str__(self):
+        return "API configuration"

Diff for: backend/src/openarchiefbeheer/fixtures/default_admin_index.json

@@ -0,0 +1,75 @@
+[
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 0,
+            "name": "External APIs",
+            "slug": "externalapis",
+            "models": [
+                ["zgw_consumers", "service"],
+                ["config", "apiconfig"]
+            ]
+        }
+    }, 
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 1,
+            "name": "Users",
+            "slug": "users",
+            "models": [
+                ["accounts", "user"],
+                ["accounts", "role"]
+            ]
+        }
+    },
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 2,
+            "name": "Logs",
+            "slug": "logs",
+            "models": [
+                ["timeline_logger", "timelinelog"]
+            ]
+        }
+    },
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 3,
+            "name": "Destruction Lists",
+            "slug": "destructionlists",
+            "models": [
+                ["destruction", "destructionlist"],
+                ["destruction", "destructionlistitem"],
+                ["destruction", "destructionlistassignee"]
+            ]
+        }
+    },
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 4,
+            "name": "Reviews",
+            "slug": "reviews",
+            "models": [
+                ["destruction", "destructionlistreview"],
+                ["destruction", "destructionlistitemreview"],
+                ["destruction", "reviewresponse"],
+                ["destruction", "reviewitemresponse"]
+            ]
+        }
+    },
+    {
+        "model": "admin_index.appgroup",
+        "fields": {
+            "order": 5,
+            "name": "Cases",
+            "slug": "cases",
+            "models": [
+                ["zaken", "zaak"]
+            ]
+        }
+    }
+]

Diff for: backend/src/openarchiefbeheer/zaken/tests/test_tasks.py

@@ -1,4 +1,5 @@
 from datetime import date
+from unittest.mock import patch
 
 from django.test import TestCase, TransactionTestCase, tag
 from django.utils.translation import gettext_lazy as _
@@ -10,6 +11,7 @@
 from zgw_consumers.constants import APITypes
 from zgw_consumers.test.factories import ServiceFactory
 
+from openarchiefbeheer.config.models import APIConfig
 from openarchiefbeheer.destruction.tests.factories import DestructionListItemFactory
 
 from ..models import Zaak
@@ -355,7 +357,7 @@ def test_expanded_correctly(self, m):
             api_type=APITypes.zrc,
             api_root="http://zaken-api.nl/zaken/api/v1",
         )
-        ServiceFactory.create(
+        selectielist_service = ServiceFactory.create(
             api_type=APITypes.orc,
             api_root="https://selectielijst.openzaak.nl/api/v1/",
         )
@@ -369,7 +371,11 @@ def test_expanded_correctly(self, m):
             },
         )
 
-        retrieve_and_cache_zaken_from_openzaak()
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            retrieve_and_cache_zaken_from_openzaak()
 
         zaak_with_resultaat = Zaak.objects.get(identificatie="ZAAK-01")
 

Diff for: backend/src/openarchiefbeheer/zaken/tests/test_views.py

@@ -13,6 +13,7 @@
 from zgw_consumers.test.factories import ServiceFactory
 
 from openarchiefbeheer.accounts.tests.factories import UserFactory
+from openarchiefbeheer.config.models import APIConfig
 from openarchiefbeheer.destruction.constants import ListItemStatus
 from openarchiefbeheer.destruction.tests.factories import (
     DestructionListFactory,
@@ -418,7 +419,7 @@ def test_not_authenticated(self):
 
     @Mocker()
     def test_retrieve_choices(self, m):
-        ServiceFactory.create(
+        selectielist_service = ServiceFactory.create(
             api_type=APITypes.orc,
             api_root="http://selectielijst.nl/api/v1",
         )
@@ -461,7 +462,11 @@ def test_retrieve_choices(self, m):
         endpoint = furl(reverse("api:retrieve-selectielijstklasse-choices"))
         endpoint.args["zaak"] = zaak.url
 
-        response = self.client.get(endpoint.url)
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            response = self.client.get(endpoint.url)
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(
@@ -494,7 +499,7 @@ def test_retrieve_choices(self, m):
     @Mocker()
     def test_retrieve_choices_without_zaak(self, m):
         # Create a mock service
-        ServiceFactory.create(
+        selectielist_service = ServiceFactory.create(
             api_type=APITypes.orc,
             api_root="http://selectielijst.nl/api/v1",
         )
@@ -541,7 +546,11 @@ def test_retrieve_choices_without_zaak(self, m):
         endpoint = furl(reverse("api:retrieve-selectielijstklasse-choices"))
 
         # Send the GET request
-        response = self.client.get(endpoint.url)
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            response = self.client.get(endpoint.url)
 
         # Validate the response
         self.assertEqual(response.status_code, status.HTTP_200_OK)
@@ -574,7 +583,7 @@ def test_retrieve_choices_without_zaak(self, m):
 
     @Mocker()
     def test_response_cached(self, m):
-        ServiceFactory.create(
+        selectielist_service = ServiceFactory.create(
             api_type=APITypes.orc,
             api_root="http://selectielijst.nl/api/v1",
         )
@@ -617,7 +626,11 @@ def test_response_cached(self, m):
         endpoint = furl(reverse("api:retrieve-selectielijstklasse-choices"))
         endpoint.args["zaak"] = zaak.url
 
-        self.client.get(endpoint.url)
-        self.client.get(endpoint.url)
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            self.client.get(endpoint.url)
+            self.client.get(endpoint.url)
 
         self.assertEqual(len(m.request_history), 1)

Diff for: backend/src/openarchiefbeheer/zaken/utils.py

@@ -20,6 +20,7 @@
 from zgw_consumers.models import Service
 from zgw_consumers.utils import PaginatedResponseData
 
+from openarchiefbeheer.config.models import APIConfig
 from openarchiefbeheer.utils.datastructure import HashableDict
 from openarchiefbeheer.utils.results_store import ResultStore
 
@@ -127,7 +128,8 @@ def format_selectielijstklasse_choice(resultaat: Resultaat) -> DropDownChoice:
 
 @lru_cache
 def retrieve_selectielijstklasse_choices(query_params: HashableDict | None) -> list:
-    selectielijst_service = Service.objects.filter(api_type=APITypes.orc).first()
+    config = APIConfig.get_solo()
+    selectielijst_service = config.selectielijst_api_service
     if not selectielijst_service:
         return []