zgw-consumers refactor

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         python: ['3.10', '3.11']
-        django: ['3.2', '4.2']
+        django: ['4.2']
     services:
       postgres:
         image: postgres:14
@@ -62,7 +62,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.10'
 
       - name: Build sdist and wheel
         run: |

.github/workflows/code_quality.yml

@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - name: Install dependencies
         run: pip install tox tox-gh-actions
       - run: tox

CHANGELOG.rst

@@ -2,6 +2,22 @@
 Change history
 ==============
 
+2.0.0 (2024-11-??)
+------------------
+
+* upgrade to zgw-consumers 0.35.1
+* remove zds-client dependency
+
+.. warning::
+
+    The ``APICredential`` class has been removed in favor of the ``Service`` model from zgw-consumers
+
+.. warning::
+
+    Several notifications related models (``NotificationsConfig`` and ``Subscription``) as well as
+    the constants ``SCOPE_NOTIFICATIES_CONSUMEREN_LABEL`` and ``SCOPE_NOTIFICATIES_PUBLICEREN_LABEL`` have
+    been removed, since they are defined in ``notifications-api-common`` and were a not deleted yet in ``commonground-api-common``
+
 1.13.4 (2024-10-25)
 -------------------
 

README.rst

@@ -35,9 +35,6 @@ Features
     * ``UniekeIdentificatieValidator`` (in combinatie met organisatie)
     * ``InformatieObjectUniqueValidator`` om te valideren dat M2M entries
       slechts eenmalig voorkomen
-    * ``ObjectInformatieObjectValidator`` om te valideren dat de synchronisatie
-      van een object-informatieobject relatie pas kan nadat deze relatie in het
-      DRC gemaakt is
     * ``IsImmutableValidator`` - valideer dat bepaalde velden niet gewijzigd
       worden bij een (partial) update, maar wel mogen gezet worden bij een create
     * ``ResourceValidator`` - valideer dat een URL een bepaalde resource ontsluit

docs/ref/client.rst

@@ -2,27 +2,12 @@
 Obtaining a client
 ==================
 
-Internally, `zds-client`_ is used to resolve remote API objects where the API is
-documented using OpenAPI 3 specifications.
+Internally, the `APIClient`_ client is used to resolve remote API objects. To
+allow the `APIClient`_ to correctly, e.g use correct credentials for authentication
+, an `Service`_ instance is required with a matching `api_root`. This replaces
+the previous mechanism to use `APICredentials` for this purpose. A transition from  `APICredentials` to
+the `Service`_ model is performed automatically with the data migration.
 
-Subclasses of the base ``Client`` class can also be used, in a pluggable fashion. By
-default, the base class is used in combination with
-:class:`vng_api_common.models.APICredential`.
 
-
-Public API
-==========
-
-Settings
---------
-
-The setting ``CUSTOM_CLIENT_FETCHER`` is a string with the dotted path to a callable
-taking a single ``url`` string argument. The callable should return a ready-to-use
-client instance for that particular URL, or ``None`` if no suitable client can be
-determined.
-
-.. automodule:: vng_api_common.client
-    :members:
-
-
-.. _zds-client: https://pypi.org/project/gemma-zds-client/
+.. _APIClient: https://ape-pie.readthedocs.io/en/stable/reference.html#apiclient-class
+.. _Service: https://zgw-consumers.readthedocs.io/en/latest/models.html#zgw_consumers.models.Service

docs/ref/oas.rst

@@ -2,10 +2,8 @@
 OpenAPI Specification handling
 ==============================
 
-The processing of external OAS is limited to OAS 3.x. Most of the heavy lifting
-to interact with remote APIs is done through the `zds-client`_.
+The processing of external OAS is limited to OAS 3.x. This module provides utilities to
+perform operations on OAS.
 
 .. automodule:: vng_api_common.oas
     :members:
-
-.. _zds-client: https://pypi.org/project/gemma-zds-client/

setup.cfg

@@ -13,7 +13,6 @@ keywords = openapi, swagger, django
 classifiers =
     Development Status :: 5 - Production/Stable
     Framework :: Django
-    Framework :: Django :: 3.2
     Framework :: Django :: 4.2
     Intended Audience :: Developers
     Operating System :: Unix
@@ -34,22 +33,25 @@ scripts =
   bin/patch_content_types
   bin/use_external_components
 install_requires =
-    django>=3.2.0
-    django-filter>=2.0
+    django>=4.2.0
+    django-filter>=23.1,<=25.1
     django-solo
-    djangorestframework>=3.11.0
+    djangorestframework>=3.15.0
     djangorestframework_camel_case>=1.2.0
     django-rest-framework-condition
-    drf-yasg>=1.20.0
-    drf-nested-routers>=0.93.3
-    gemma-zds-client>=0.14.0
+    drf-yasg>=1.20.0 # TODO: remove usage?
+    drf-nested-routers>=0.94.1
     iso-639
     isodate
-    notifications-api-common>=0.2.2
+    notifications-api-common>=0.3.0
+    zgw-consumers>=0.35.1
+    zgw-consumers-oas
     oyaml
     PyJWT>=2.0.0
     requests
+    requests-mock
     coreapi
+    ape-pie
 tests_require =
     pytest
     pytest-django

tests/test_jwtsecrets.py

@@ -2,9 +2,9 @@
 from rest_framework import status
 from rest_framework.reverse import reverse
 from rest_framework.test import APIClient
-from zds_client.auth import ClientAuth
 
 from vng_api_common.authorizations.models import Applicatie, Autorisatie
+from vng_api_common.authorizations.utils import generate_jwt
 from vng_api_common.constants import ComponentTypes
 from vng_api_common.models import JWTSecret
 
@@ -31,10 +31,8 @@ def test_authorized_jwtsecret_create_ok():
         component=ComponentTypes.ac,
         scopes=["autorisaties.credentials-registreren"],
     )
-    auth = ClientAuth(client_id="pytest", secret="sekrit").credentials()[
-        "Authorization"
-    ]
-    client.credentials(HTTP_AUTHORIZATION=auth)
+    token = generate_jwt("pytest", "sekrit", "pytest", "pytest")
+    client.credentials(HTTP_AUTHORIZATION=token)
 
     response = client.post(url, {"identifier": "foo", "secret": "bar"})
 

tests/test_migrations.py

@@ -0,0 +1,176 @@
+from django.apps import apps as global_apps
+from django.db import connection
+from django.db.migrations.executor import MigrationExecutor
+from django.test import override_settings
+
+import pytest
+from zgw_consumers.constants import APITypes, AuthTypes
+
+
+class BaseMigrationTest:
+    app = None
+    migrate_from = None  # The migration before the one we want to test
+    migrate_to = None  # The migration we want to test
+    setting_overrides = {}
+
+    @pytest.fixture(autouse=True)
+    def setup_migration(self, db):
+        """
+        Setup the migration test by reversing to `migrate_from` state,
+        then applying the `migrate_to` state.
+        """
+        assert self.app is not None, "You must define the `app` attribute"
+        assert self.migrate_from is not None, "You must define `migrate_from`"
+        assert self.migrate_to is not None, "You must define `migrate_to`"
+
+        # Step 1: Set up the MigrationExecutor
+        executor = MigrationExecutor(connection)
+
+        # Step 2: Reverse to the starting migration state
+        migrate_from = [(self.app, self.migrate_from)]
+        migrate_to = [(self.app, self.migrate_to)]
+        old_migrate_state = executor.migrate(migrate_from)
+        old_apps = old_migrate_state.apps
+
+        # Step 3: Run the `setup_before_migration` hook with old state models
+        self.setup_before_migration(old_apps)
+
+        # Step 4: Apply the migration we want to test with any settings overrides
+        with override_settings(**self.setting_overrides):
+            executor = MigrationExecutor(connection)
+            executor.loader.build_graph()  # reload the graph in case of dependency changes
+            executor.migrate(migrate_to)
+
+        # Set `self.apps` to the post-migration state
+        self.apps = executor.loader.project_state(migrate_to).apps
+
+    def setup_before_migration(self, apps):
+        """
+        Hook to set up the state before the migration. Subclasses can
+        override this to create data or perform other setup actions.
+        """
+        pass
+
+
+class TestMigrateAPICredentialToService(BaseMigrationTest):
+    app = "vng_api_common"
+    migrate_from = "0005_auto_20190614_1346"
+    migrate_to = "0006_delete_apicredential"
+
+    def setup_before_migration(self, apps):
+        Service = apps.get_model("zgw_consumers", "Service")
+        APICredential = apps.get_model("vng_api_common", "APICredential")
+
+        APICredential.objects.create(
+            api_root="https://example.com/zaken/api/v1/",
+            label="Zaken API",
+            client_id="user",
+            secret="secret",
+            user_id="user",
+            user_representation="User",
+        )
+
+        APICredential.objects.create(
+            api_root="https://example.com/api/v1/",
+            label="Selectielijst API",
+            client_id="user2",
+            secret="secret2",
+            user_id="user2",
+            user_representation="User2",
+        )
+
+        APICredential.objects.create(
+            api_root="https://example.com/documenten/api/v1/",
+            label="Documenten API",
+            client_id="user3",
+            secret="secret3",
+            user_id="user3",
+            user_representation="User3",
+        )
+        Service.objects.create(
+            api_root="https://example.com/documenten/api/v1/",
+            label="Documenten",
+            slug="already-exists",
+            api_type=APITypes.drc,
+            auth_type=AuthTypes.zgw,
+            client_id="user4",
+            secret="secret4",
+            user_id="user4",
+            user_representation="User4",
+        )
+
+    def test_migrate_api_credentials_to_services(self):
+        Service = global_apps.get_model("zgw_consumers", "Service")
+
+        zaken_service = Service.objects.get(slug="zaken-api")
+
+        assert zaken_service.api_root == "https://example.com/zaken/api/v1/"
+        assert zaken_service.label == "Zaken API"
+        assert zaken_service.api_type == APITypes.zrc
+        assert zaken_service.auth_type == AuthTypes.zgw
+        assert zaken_service.client_id == "user"
+        assert zaken_service.secret == "secret"
+        assert zaken_service.user_id == "user"
+        assert zaken_service.user_representation == "User"
+
+        selectielijst_service = Service.objects.get(slug="selectielijst-api")
+
+        assert selectielijst_service.api_root == "https://example.com/api/v1/"
+        assert selectielijst_service.label == "Selectielijst API"
+        assert selectielijst_service.api_type == APITypes.orc
+        assert selectielijst_service.auth_type == AuthTypes.zgw
+        assert selectielijst_service.client_id == "user2"
+        assert selectielijst_service.secret == "secret2"
+        assert selectielijst_service.user_id == "user2"
+        assert selectielijst_service.user_representation == "User2"
+
+        documenten_service = Service.objects.get(slug="already-exists")
+
+        # Because there already was a service for this API root, that data is used instead
+        assert documenten_service.api_root == "https://example.com/documenten/api/v1/"
+        assert documenten_service.label == "Documenten"
+        assert documenten_service.api_type == APITypes.drc
+        assert documenten_service.auth_type == AuthTypes.zgw
+        assert documenten_service.client_id == "user4"
+        assert documenten_service.secret == "secret4"
+        assert documenten_service.user_id == "user4"
+        assert documenten_service.user_representation == "User4"
+
+
+class TestMigrateAuthorizationsConfigAPIRootToService(BaseMigrationTest):
+    app = "authorizations"
+    migrate_from = "0015_auto_20220318_1608"
+    migrate_to = "0016_remove_authorizationsconfig_api_root_and_more"
+
+    def setup_before_migration(self, apps):
+        Service = apps.get_model("zgw_consumers", "Service")
+        AuthorizationsConfig = apps.get_model("authorizations", "AuthorizationsConfig")
+
+        config, _ = AuthorizationsConfig.objects.get_or_create()
+        config.api_root = "https://example.com/autorisaties/api/v1/"
+        config.save()
+
+        self.service = Service.objects.create(
+            api_root="https://example.com/autorisaties/api/v1/",
+            label="Autorisaties",
+            slug="autorisaties",
+            api_type=APITypes.ac,
+            auth_type=AuthTypes.zgw,
+            client_id="user",
+            secret="secret",
+            user_id="user",
+            user_representation="User",
+        )
+
+    def test_migrate_api_root_to_service(self):
+        AuthorizationsConfig = global_apps.get_model(
+            "authorizations", "AuthorizationsConfig"
+        )
+
+        config, _ = AuthorizationsConfig.objects.get_or_create()
+
+        assert config.authorizations_api_service.pk == self.service.pk
+        assert (
+            config.authorizations_api_service.api_root
+            == "https://example.com/autorisaties/api/v1/"
+        )