Merge pull request #4443 from open-formulieren/feature/4414-remove-zgw-default-config

 [#4414] Remove default ZGW API group

Author: sergei-maertens

bin/check_zgw_groups.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+import django
+
+import click
+from tabulate import tabulate
+
+SRC_DIR = Path(__file__).parent.parent / "src"
+sys.path.insert(0, str(SRC_DIR.resolve()))
+
+
+def check_zgw_groups() -> bool:
+    from openforms.forms.models import FormRegistrationBackend
+    from openforms.registrations.contrib.zgw_apis.models import ZgwConfig
+
+    zgw_config = ZgwConfig.get_solo()
+    default_group = zgw_config.default_zgw_api_group
+
+    problems: list[list[str]] = []
+
+    for backend in FormRegistrationBackend.objects.filter(backend="zgw-create-zaak"):
+        zgw_api_group = backend.options.get("zgw_api_group")
+        if zgw_api_group is None and default_group is None:
+            problems.append(
+                [
+                    backend.form.admin_name,
+                    backend.name,
+                    backend.key,
+                    "No ZGW API group set and no default group available",
+                ]
+            )
+            continue
+
+    if not problems:
+        click.echo(click.style("No problems found.", fg="green"))
+        return True
+
+    click.echo(click.style("Found problems in form registration backends.", fg="red"))
+    click.echo("")
+    click.echo(
+        tabulate(
+            problems,
+            headers=(
+                "Form",
+                "Registration backend name",
+                "Regisration backend key",
+                "Problem",
+            ),
+        )
+    )
+
+    return False
+
+
+def main(skip_setup: bool = False) -> bool:
+    from openforms.setup import setup_env
+
+    if not skip_setup:
+        setup_env()
+        django.setup()
+
+    return check_zgw_groups()
+
+
+@click.command()
+def cli():
+    return main()
+
+
+if __name__ == "__main__":
+    cli()

src/openapi.yaml

@@ -3836,9 +3836,8 @@ paths:
         schema:
           type: integer
           title: ZGW API set
-        description: The primary key of the ZGW API set to use. If provided, the informatieobjecttypen
-          from the Catalogi API in this set will be returned. Otherwise, the Catalogi
-          API in the default ZGW API set will be used to find informatieobjecttypen.
+        description: The primary key of the ZGW API set to use. The informatieobjecttypen
+          from the Catalogi API in this set will be returned.
       tags:
       - registration
       security:

src/openforms/fixtures/admin_index_unlisted.json

@@ -27,6 +27,5 @@
     "stuf_zds.StufZDSConfig",
     "suwinet.SuwinetConfig",
     "upgrades.VersionInfo",
-    "zgw_apis.ZGWApiGroupConfig",
-    "zgw_apis.ZgwConfig"
+    "zgw_apis.ZGWApiGroupConfig"
 ]

src/openforms/fixtures/default_groups.json

@@ -229,26 +229,6 @@
                 "timeline_logger",
                 "timelinelog"
             ],
-            [
-                "add_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "change_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "delete_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "view_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
             [
                 "add_service",
                 "zgw_consumers",
@@ -1508,26 +1488,6 @@
                 "timeline_logger",
                 "timelinelog"
             ],
-            [
-                "add_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "change_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "delete_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
-            [
-                "view_zgwconfig",
-                "zgw_apis",
-                "zgwconfig"
-            ],
             [
                 "add_nlxconfig",
                 "zgw_consumers",

src/openforms/fixtures/demo_zgw_apis.json

@@ -54,14 +54,13 @@
         }
     },
     {
-        "model": "zgw_apis.zgwconfig",
+        "model": "zgw_apis.zgwapigroupconfig",
         "pk": 1,
         "fields": {
+            "name": "test ZGW API group",
             "zrc_service": 1,
             "drc_service": 2,
             "ztc_service": 3,
-            "zaaktype": "https://test.openzaak.nl/catalogi/api/v1/zaaktypen/53340e34-7581-4b04-884f-8ff7e6a73c2c",
-            "informatieobjecttype": "https://test.openzaak.nl/catalogi/api/v1/informatieobjecttypen/1db73aba-cef4-42ec-bdf0-cd4c7c4f2514",
             "organisatie_rsin": "000000000"
         }
     }

src/openforms/forms/tests/files/vcr_cassettes/ImportZGWAPITests/ImportZGWAPITests.test_import_form_with_zgw_registration_backend_available_group.yaml

@@ -0,0 +1,44 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate, br
+      Authorization:
+      - Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0X2NsaWVudF9pZCIsImlhdCI6MTcxOTkyMTgwMSwiY2xpZW50X2lkIjoidGVzdF9jbGllbnRfaWQiLCJ1c2VyX2lkIjoiIiwidXNlcl9yZXByZXNlbnRhdGlvbiI6IiJ9.fn0AHRxUSOammPxgql-z-nznW95J0poa2bPwjoY7qBk
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-requests/2.32.3
+    method: GET
+    uri: http://localhost:8003/catalogi/api/v1/catalogussen
+  response:
+    body:
+      string: '{"count":1,"next":null,"previous":null,"results":[{"url":"http://localhost:8003/catalogi/api/v1/catalogussen/bd58635c-793e-446d-a7e0-460d7b04829d","domein":"TEST","rsin":"000000000","contactpersoonBeheerNaam":"Test
+        name","contactpersoonBeheerTelefoonnummer":"","contactpersoonBeheerEmailadres":"","zaaktypen":["http://localhost:8003/catalogi/api/v1/zaaktypen/1f41885e-23fc-4462-bbc8-80be4ae484dc"],"besluittypen":[],"informatieobjecttypen":["http://localhost:8003/catalogi/api/v1/informatieobjecttypen/7a474713-0833-402a-8441-e467c08ac55b","http://localhost:8003/catalogi/api/v1/informatieobjecttypen/b2d83b94-9b9b-4e80-a82f-73ff993c62f3","http://localhost:8003/catalogi/api/v1/informatieobjecttypen/531f6c1a-97f7-478c-85f0-67d2f23661c7"],"naam":"Test
+        catalog","versie":"","begindatumVersie":null}]}'
+    headers:
+      API-version:
+      - 1.3.1
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Content-Length:
+      - '799'
+      Content-Type:
+      - application/json
+      Referrer-Policy:
+      - same-origin
+      Vary:
+      - Accept, Origin
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-XSS-Protection:
+      - 1; mode=block
+    status:
+      code: 200
+      message: OK
+version: 1

src/openforms/forms/tests/test_import_export.py

@@ -6,7 +6,7 @@
 from textwrap import dedent
 from unittest.mock import patch
 
-from django.core.management import call_command
+from django.core.management import CommandError, call_command
 from django.test import TestCase, override_settings, tag
 from django.utils import translation
 
@@ -22,6 +22,9 @@
 from openforms.payments.contrib.ogone.tests.factories import OgoneMerchantFactory
 from openforms.products.tests.factories import ProductFactory
 from openforms.registrations.contrib.objects_api.models import ObjectsAPIGroupConfig
+from openforms.registrations.contrib.zgw_apis.tests.factories import (
+    ZGWApiGroupConfigFactory,
+)
 from openforms.translations.tests.utils import make_translated
 from openforms.utils.tests.vcr import OFVCRMixin
 from openforms.variables.constants import FormVariableSources
@@ -1521,3 +1524,106 @@ def test_import_form_with_objecttype_uuid_objects_api_registration_backend(self)
             registration_backend.options["objecttype"],
             "8e46e0a5-b1b4-449b-b9e9-fa3cea655f48",
         )
+
+
+class ImportZGWAPITests(TempdirMixin, OFVCRMixin, TestCase):
+    """This test case requires the Open Zaak Docker Compose to be running.
+
+    See the relevant Docker compose in the ``docker/`` folder.
+    """
+
+    VCR_TEST_FILES = PATH / "files"
+
+    def test_import_form_with_zgw_registration_backend_no_available_group(self):
+
+        resources = {
+            "forms": [
+                {
+                    "active": True,
+                    "name": "Test Form 1",
+                    "internal_name": "Test Form Internal 1",
+                    "slug": "zgw-no-group",
+                    "uuid": "324cadce-a627-4e3f-b117-37ca232f16b2",
+                    "registration_backends": [
+                        {
+                            "key": "test-backend",
+                            "name": "Test backend",
+                            "backend": "zgw-create-zaak",
+                            "options": {
+                                "zaaktype": "https://catalogi.nl/api/v1/zaaktypen/1",
+                                "informatieobjecttype": "https://catalogi.nl/api/v1/informatieobjecttypen/1",
+                            },
+                        }
+                    ],
+                }
+            ]
+        }
+
+        with zipfile.ZipFile(self.filepath, "w") as zip_file:
+            for name, data in resources.items():
+                zip_file.writestr(f"{name}.json", json.dumps(data))
+
+        with self.assertRaises(CommandError):
+            call_command("import", import_file=self.filepath)
+
+    def test_import_form_with_zgw_registration_backend_available_group(self):
+        resources = {
+            "forms": [
+                {
+                    "active": True,
+                    "name": "Test Form 1",
+                    "internal_name": "Test Form Internal 1",
+                    "slug": "zgw-no-group",
+                    "uuid": "324cadce-a627-4e3f-b117-37ca232f16b2",
+                    "registration_backends": [
+                        {
+                            "key": "test-backend",
+                            "name": "Test backend",
+                            "backend": "zgw-create-zaak",
+                            "options": {
+                                "zaaktype": "http://localhost:8003/catalogi/api/v1/zaaktypen/1f41885e-23fc-4462-bbc8-80be4ae484dc",
+                                "informatieobjecttype": "http://localhost:8003/catalogi/api/v1/informatieobjecttypen/531f6c1a-97f7-478c-85f0-67d2f23661c7",
+                            },
+                        }
+                    ],
+                }
+            ]
+        }
+
+        _credentials = {
+            "auth_type": AuthTypes.zgw,
+            "client_id": "test_client_id",
+            "secret": "test_secret_key",
+        }
+        zaken_service = ServiceFactory.create(
+            api_root="http://localhost:8003/zaken/api/v1/",
+            api_type=APITypes.zrc,
+            **_credentials,
+        )
+        documenten_service = ServiceFactory.create(
+            api_root="http://localhost:8003/documenten/api/v1/",
+            api_type=APITypes.drc,
+            **_credentials,
+        )
+        catalogi_service = ServiceFactory.create(
+            api_root="http://localhost:8003/catalogi/api/v1/",
+            api_type=APITypes.ztc,
+            **_credentials,
+        )
+        zgw_group = ZGWApiGroupConfigFactory.create(
+            zrc_service=zaken_service,
+            drc_service=documenten_service,
+            ztc_service=catalogi_service,
+        )
+
+        with zipfile.ZipFile(self.filepath, "w") as zip_file:
+            for name, data in resources.items():
+                zip_file.writestr(f"{name}.json", json.dumps(data))
+
+        call_command("import", import_file=self.filepath)
+
+        registration_backend = FormRegistrationBackend.objects.get(key="test-backend")
+        self.assertEqual(
+            registration_backend.options["zgw_api_group"],
+            zgw_group.pk,
+        )

src/openforms/registrations/api/filters.py

@@ -9,7 +9,7 @@
 from openforms.contrib.zgw.clients.catalogi import CatalogiClient
 from openforms.registrations.contrib.objects_api.models import ObjectsAPIGroupConfig
 from openforms.registrations.contrib.zgw_apis.client import get_catalogi_client
-from openforms.registrations.contrib.zgw_apis.models import ZGWApiGroupConfig, ZgwConfig
+from openforms.registrations.contrib.zgw_apis.models import ZGWApiGroupConfig
 
 from ..registry import register
 
@@ -18,9 +18,8 @@ class ListInformatieObjectTypenQueryParamsSerializer(serializers.Serializer):
     zgw_api_group = PrimaryKeyRelatedAsChoicesField(
         queryset=ZGWApiGroupConfig.objects.all(),
         help_text=_(
-            "The primary key of the ZGW API set to use. If provided, the informatieobjecttypen from the Catalogi API "
-            "in this set will be returned. Otherwise, the Catalogi API in the default ZGW API set will be used to find "
-            "informatieobjecttypen."
+            "The primary key of the ZGW API set to use. The informatieobjecttypen from the Catalogi API "
+            "in this set will be returned."
         ),
         label=_("ZGW API set"),
         required=False,
@@ -51,6 +50,13 @@ def validate(self, attrs: dict[str, Any]) -> dict[str, Any]:
                 )
             )
 
+        if registration_backend == "zgw-create-zaak" and "zgw_api_group" not in attrs:
+            raise serializers.ValidationError(
+                _(
+                    "'zgw_api_group' is required when 'registration_backend' is set to 'zgw-create-zaak'."
+                )
+            )
+
         return attrs
 
     def get_fields(self):
@@ -63,15 +69,8 @@ def get_ztc_client(self) -> CatalogiClient | None:
         registration_backend: str = self.validated_data.get("registration_backend")
 
         if registration_backend == "zgw-create-zaak":
-            zgw_api_group: ZGWApiGroupConfig | None = self.validated_data.get(
-                "zgw_api_group"
-            )
-            if zgw_api_group is not None:
-                return get_catalogi_client(zgw_api_group)
-            config = ZgwConfig.get_solo()
-            assert isinstance(config, ZgwConfig)
-            if group := config.default_zgw_api_group:
-                return get_catalogi_client(group)
+            zgw_api_group: ZGWApiGroupConfig = self.validated_data["zgw_api_group"]
+            return get_catalogi_client(zgw_api_group)
         elif registration_backend == "objects_api":
             objects_api_group: ObjectsAPIGroupConfig = self.validated_data[
                 "objects_api_group"