Merge branch 'master' into stable/1.0.x

Author: stevenbal

requirements/base.in

@@ -1,4 +1,3 @@
-Pillow
 pip-tools
 psycopg2-binary
 python-dotenv
@@ -17,4 +16,4 @@ django-markup==1.3
 django_redis
 
 djangorestframework
-vng-api-common<1.1.0
+vng-api-common

requirements/base.txt

@@ -19,6 +19,7 @@ django-filter==2.1.0      # via vng-api-common
 django-ipware==2.1.0      # via django-axes
 django-markup==1.3
 django-redis==4.10.0
+django-rest-framework-condition==0.1.1  # via vng-api-common
 django-solo==1.1.3        # via vng-api-common
 django==2.2.8
 djangorestframework-camel-case==0.2.0  # via vng-api-common
@@ -38,7 +39,6 @@ markdown==3.1
 markupsafe==1.1.1         # via jinja2
 oyaml==0.7                # via vng-api-common
 packaging==19.0           # via sphinx
-pillow==5.2.0
 pip-tools==4.2.0
 psycopg2-binary==2.7.5
 pygments==2.3.1           # via sphinx
@@ -61,4 +61,7 @@ sqlparse==0.3.0           # via django
 unidecode==1.0.22         # via vng-api-common
 uritemplate==3.0.0        # via coreapi, drf-yasg
 urllib3==1.24.3           # via requests
-vng-api-common==1.0.34
+vng-api-common==1.4.4
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools==42.0.2        # via markdown, sphinx

requirements/jenkins.txt

@@ -22,6 +22,7 @@ django-ipware==2.1.0
 django-jenkins==0.110.0
 django-markup==1.3
 django-redis==4.10.0
+django-rest-framework-condition==0.1.1
 django-solo==1.1.3
 django==2.2.8
 djangorestframework-camel-case==0.2.0
@@ -48,7 +49,6 @@ mccabe==0.6.1             # via pylint
 oyaml==0.7
 packaging==19.0
 pep8==1.7.1
-pillow==5.2.0
 pip-tools==4.2.0
 psycopg2-binary==2.7.5
 pygments==2.3.1
@@ -75,5 +75,5 @@ text-unidecode==1.2       # via faker
 unidecode==1.0.22
 uritemplate==3.0.0
 urllib3==1.24.3
-vng-api-common==1.0.34
+vng-api-common==1.4.4
 wrapt==1.10.11            # via astroid

src/brc/api/tests/test_besluit.py

@@ -2,8 +2,7 @@
 from rest_framework.test import APITestCase
 from vng_api_common.tests import JWTAuthMixin, get_operation_url, get_validation_errors
 
-from brc.datamodel.models import BesluitInformatieObject
-from brc.datamodel.tests.factories import BesluitFactory, BesluitInformatieObjectFactory
+from brc.datamodel.tests.factories import BesluitFactory
 
 from .mixins import MockSyncMixin
 

src/brc/api/tests/test_caching.py

@@ -0,0 +1,113 @@
+"""
+Test that the caching mechanisms are in place.
+"""
+from rest_framework import status
+from rest_framework.test import APITestCase, APITransactionTestCase
+from vng_api_common.tests import CacheMixin, JWTAuthMixin, generate_jwt_auth, reverse
+from vng_api_common.tests.schema import get_spec
+
+from brc.datamodel.tests.factories import BesluitFactory, BesluitInformatieObjectFactory
+
+from .mixins import MockSyncMixin
+
+
+class BesluitCacheTests(CacheMixin, JWTAuthMixin, APITestCase):
+    heeft_alle_autorisaties = True
+
+    def test_besluit_get_cache_header(self):
+        besluit = BesluitFactory.create()
+
+        response = self.client.get(reverse(besluit))
+
+        self.assertHasETag(response)
+
+    def test_besluit_head_cache_header(self):
+        besluit = BesluitFactory.create()
+
+        self.assertHeadHasETag(reverse(besluit))
+
+    def test_head_in_apischema(self):
+        spec = get_spec()
+
+        endpoint = spec["paths"]["/besluiten/{uuid}"]
+
+        self.assertIn("head", endpoint)
+
+    def test_conditional_get_304(self):
+        besluit = BesluitFactory.create(with_etag=True)
+        response = self.client.get(
+            reverse(besluit), HTTP_IF_NONE_MATCH=f'"{besluit._etag}"'
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_304_NOT_MODIFIED)
+
+    def test_conditional_get_stale(self):
+        besluit = BesluitFactory.create(with_etag=True)
+
+        response = self.client.get(reverse(besluit), HTTP_IF_NONE_MATCH=f'"not-an-md5"')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class BesluitInformatieObjectCacheTests(
+    MockSyncMixin, CacheMixin, JWTAuthMixin, APITestCase
+):
+    heeft_alle_autorisaties = True
+
+    def test_besluit_get_cache_header(self):
+        bio = BesluitInformatieObjectFactory.create()
+
+        response = self.client.get(reverse(bio))
+
+        self.assertHasETag(response)
+
+    def test_besluit_head_cache_header(self):
+        bio = BesluitInformatieObjectFactory.create()
+
+        self.assertHeadHasETag(reverse(bio))
+
+    def test_head_in_apischema(self):
+        spec = get_spec()
+
+        endpoint = spec["paths"]["/besluitinformatieobjecten/{uuid}"]
+
+        self.assertIn("head", endpoint)
+
+    def test_conditional_get_304(self):
+        bio = BesluitInformatieObjectFactory.create(with_etag=True)
+        response = self.client.get(reverse(bio), HTTP_IF_NONE_MATCH=f'"{bio._etag}"')
+
+        self.assertEqual(response.status_code, status.HTTP_304_NOT_MODIFIED)
+
+    def test_conditional_get_stale(self):
+        bio = BesluitInformatieObjectFactory.create(with_etag=True)
+
+        response = self.client.get(reverse(bio), HTTP_IF_NONE_MATCH=f'"not-an-md5"')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+
+class BesluitCacheTransactionTests(JWTAuthMixin, APITransactionTestCase):
+    heeft_alle_autorisaties = True
+
+    def setUp(self):
+        super().setUp()
+        self._create_credentials(
+            self.client_id,
+            self.secret,
+            self.heeft_alle_autorisaties,
+            self.max_vertrouwelijkheidaanduiding,
+        )
+
+    def test_invalidate_etag_after_change(self):
+        """
+        Because changes are made to the besluit, a code 200 should be returned
+        """
+        besluit = BesluitFactory.create(toelichting="", with_etag=True)
+        etag = besluit._etag
+
+        besluit.toelichting = "bla"
+        besluit.save()
+
+        response = self.client.get(reverse(besluit), HTTP_IF_NONE_MATCH=f"{etag}")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)

src/brc/api/viewsets.py

@@ -8,6 +8,7 @@
     AuditTrailViewSet,
     AuditTrailViewsetMixin,
 )
+from vng_api_common.caching import conditional_retrieve
 from vng_api_common.notifications.viewsets import (
     NotificationCreateMixin,
     NotificationDestroyMixin,
@@ -31,6 +32,7 @@
 from .serializers import BesluitInformatieObjectSerializer, BesluitSerializer
 
 
+@conditional_retrieve()
 class BesluitViewSet(
     NotificationViewSetMixin,
     CheckQueryParamsMixin,
@@ -119,6 +121,7 @@ class BesluitViewSet(
     audit = AUDIT_BRC
 
 
+@conditional_retrieve()
 class BesluitInformatieObjectViewSet(
     NotificationCreateMixin,
     NotificationDestroyMixin,

src/brc/datamodel/migrations/0011_auto_20190910_1037.py

@@ -0,0 +1,36 @@
+# Generated by Django 2.2.4 on 2019-09-10 10:37
+
+from django.db import migrations, models
+import vng_api_common.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [("datamodel", "0010_migrate_to_flattened_urls")]
+
+    operations = [
+        migrations.AddField(
+            model_name="besluit",
+            name="_etag",
+            field=models.CharField(
+                default="",
+                editable=False,
+                help_text="MD5 hash of the resource representation in its current version.",
+                max_length=32,
+                verbose_name="etag value",
+            ),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="besluitinformatieobject",
+            name="_etag",
+            field=models.CharField(
+                default="",
+                editable=False,
+                help_text="MD5 hash of the resource representation in its current version.",
+                max_length=32,
+                verbose_name="etag value",
+            ),
+            preserve_default=False,
+        ),
+    ]

src/brc/datamodel/models.py

@@ -4,6 +4,7 @@
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 
+from vng_api_common.caching import ETagMixin
 from vng_api_common.fields import RSINField
 from vng_api_common.models import APIMixin
 from vng_api_common.utils import (
@@ -21,7 +22,7 @@
 logger = logging.getLogger(__name__)
 
 
-class Besluit(APIMixin, models.Model):
+class Besluit(ETagMixin, APIMixin, models.Model):
     uuid = models.UUIDField(default=_uuid.uuid4)
 
     identificatie = models.CharField(
@@ -142,7 +143,7 @@ def unique_representation(self):
         return f"{self.identificatie}"
 
 
-class BesluitInformatieObject(models.Model):
+class BesluitInformatieObject(ETagMixin, models.Model):
     """
     Aanduiding van het (de) INFORMATIEOBJECT(en) waarin
     het BESLUIT beschreven is.

src/brc/datamodel/tests/factories.py

@@ -21,7 +21,12 @@ def ingangsdatum(self):
             end_date=self.datum + timedelta(days=180),
             tzinfo=timezone.utc,
         )
-        return _ingangsdatum.evaluate(self, None, None)
+        return _ingangsdatum.evaluate(self, None, None).date()
+
+    class Params:
+        with_etag = factory.Trait(
+            _etag=factory.PostGenerationMethodCall("calculate_etag_value")
+        )
 
 
 class BesluitInformatieObjectFactory(factory.django.DjangoModelFactory):
@@ -30,3 +35,8 @@ class BesluitInformatieObjectFactory(factory.django.DjangoModelFactory):
 
     class Meta:
         model = "datamodel.BesluitInformatieObject"
+
+    class Params:
+        with_etag = factory.Trait(
+            _etag=factory.PostGenerationMethodCall("calculate_etag_value")
+        )