refactor(settings): Serializer Unit Test Suite re-written to Pytest for model ExternalLink

ref: #942 #940

app/settings/tests/functional/external_links/test_external_links_serializer.py

@@ -1,117 +0,0 @@
-import pytest
-
-from django.test import TestCase
-
-from rest_framework.exceptions import ValidationError
-
-from access.models.tenant import Tenant as Organization
-
-from centurion.tests.abstract.mock_view import MockView, User
-
-from settings.serializers.external_links import (
-    ExternalLink,
-    ExternalLinkModelSerializer
-)
-
-
-
-class ExternalLinkValidationAPI(
-    TestCase,
-):
-
-    model = ExternalLink
-
-    @classmethod
-    def setUpTestData(self):
-        """Setup Test
-
-        1. Create an org
-        2. Create an item
-        """
-
-        organization = Organization.objects.create(name='test_org')
-
-        self.user = User.objects.create_user(username="test_user_view", password="password")
-
-        self.organization = organization
-
-        self.valid_data: dict = {
-            'organization': self.organization.id,
-            'name': 'a name',
-            'template': 'http://example.com/{{ val }}'
-        }
-
-        self.mock_view = MockView( user = self.user )
-
-
-
-
-    def test_serializer_valid_data(self):
-        """Serializer Validation Check
-
-        Ensure that if creating an item with valid data that
-        no errors occur
-        """
-
-        serializer = ExternalLinkModelSerializer(
-                context = {
-                    'request': self.mock_view.request,
-                    'view': self.mock_view,
-                },
-            data = self.valid_data
-        )
-
-        assert serializer.is_valid(raise_exception = True)
-
-
-
-    def test_serializer_validation_no_name(self):
-        """Serializer Validation Check
-
-        Ensure that if creating and no name is provided a validation error occurs
-        """
-
-        data = self.valid_data.copy()
-
-        del data['name']
-
-        with pytest.raises(ValidationError) as err:
-
-            serializer = ExternalLinkModelSerializer(
-                context = {
-                    'request': self.mock_view.request,
-                    'view': self.mock_view,
-                },
-                data = data
-            )
-
-            serializer.is_valid(raise_exception = True)
-
-        assert err.value.get_codes()['name'][0] == 'required'
-
-
-
-
-    def test_serializer_validation_no_template(self):
-        """Serializer Validation Check
-
-        Ensure that if creating and no template is provided a validation error occurs
-        """
-
-        data = self.valid_data.copy()
-
-        del data['template']
-
-        with pytest.raises(ValidationError) as err:
-
-            serializer = ExternalLinkModelSerializer(
-                context = {
-                    'request': self.mock_view.request,
-                    'view': self.mock_view,
-                },
-                data = data
-            )
-
-            serializer.is_valid(raise_exception = True)
-
-        assert err.value.get_codes()['template'][0] == 'required'

app/settings/tests/unit/external_links/conftest.py

@@ -17,3 +17,9 @@ def model_kwargs(request, kwargs_externallink):
 
     if hasattr(request.cls, 'kwargs_create_item'):
         del request.cls.kwargs_create_item
+
+
+@pytest.fixture( scope = 'class')
+def model_serializer(serializer_externallink):
+
+    yield serializer_externallink

app/settings/tests/unit/external_links/test_unit_external_links_serializer.py

@@ -0,0 +1,140 @@
+import pytest
+
+from django.db import models
+
+from rest_framework.exceptions import ValidationError
+
+from api.tests.unit.test_unit_serializer import (
+    SerializerTestCases
+)
+
+from centurion.tests.abstract.mock_view import MockView
+
+
+
+@pytest.mark.model_externallink
+class ExternalLinkSerializerTestCases(
+    SerializerTestCases
+):
+
+
+    @pytest.fixture( scope = 'function' )
+    def created_model(self, django_db_blocker, model, model_kwargs):
+
+        with django_db_blocker.unblock():
+
+            kwargs_many_to_many = {}
+
+            kwargs = {}
+
+            for key, value in model_kwargs.items():
+
+                field = model._meta.get_field(key)
+
+                if isinstance(field, models.ManyToManyField):
+
+                    kwargs_many_to_many.update({
+                        key: value
+                    })
+
+                else:
+
+                    kwargs.update({
+                        key: value
+                    })
+
+
+            item = model.objects.create( **kwargs )
+
+            for key, value in kwargs_many_to_many.items():
+
+                field = getattr(item, key)
+
+                for entry in value:
+
+                    field.add(entry)
+
+            yield item
+
+            item.delete()
+
+
+
+    def test_serializer_validation_no_name(self,
+        kwargs_api_create, model, model_serializer, request_user
+    ):
+        """Serializer Validation Check
+
+        Ensure that if creating and no name is provided a validation error occurs
+        """
+
+        mock_view = MockView(
+            user = request_user,
+            model = model,
+            action = 'create',
+        )
+
+        kwargs = kwargs_api_create.copy()
+        del kwargs['name']
+
+        with pytest.raises(ValidationError) as err:
+
+            serializer = model_serializer['model'](
+                context = {
+                    'request': mock_view.request,
+                    'view': mock_view,
+                },
+                data = kwargs,
+            )
+
+            serializer.is_valid(raise_exception = True)
+
+        assert err.value.get_codes()['name'][0] == 'required'
+
+
+
+    def test_serializer_validation_no_template(self,
+        kwargs_api_create, model, model_serializer, request_user
+    ):
+        """Serializer Validation Check
+
+        Ensure that if creating and no template is provided a validation error occurs
+        """
+
+        mock_view = MockView(
+            user = request_user,
+            model = model,
+            action = 'create',
+        )
+
+        kwargs = kwargs_api_create.copy()
+        del kwargs['template']
+
+        with pytest.raises(ValidationError) as err:
+
+            serializer = model_serializer['model'](
+                context = {
+                    'request': mock_view.request,
+                    'view': mock_view,
+                },
+                data = kwargs
+            )
+
+            serializer.is_valid(raise_exception = True)
+
+        assert err.value.get_codes()['template'][0] == 'required'
+
+
+
+class ExternalLinkSerializerInheritedCases(
+    ExternalLinkSerializerTestCases
+):
+    pass
+
+
+
+@pytest.mark.module_settings
+class ExternalLinkSerializerPyTest(
+    ExternalLinkSerializerTestCases
+):
+    pass

app/tests/fixtures/__init__.py

@@ -145,6 +145,7 @@ from .model_entity import (
 from .model_externallink import (
     kwargs_externallink,
     model_externallink,
+    serializer_externallink,
 )
 
 from .model_featureflag import (

app/tests/fixtures/model_externallink.py

@@ -2,6 +2,13 @@ import datetime
 import pytest
 
 from settings.models.external_link import ExternalLink
+from settings.serializers.external_links import (
+    ExternalLinkBaseSerializer,
+    ExternalLinkModelSerializer,
+    ExternalLinkViewSerializer,
+)
+
+
 
 @pytest.fixture( scope = 'class')
 def model_externallink():
@@ -20,7 +27,18 @@ def kwargs_externallink( kwargs_centurionmodel ):
         **kwargs_centurionmodel.copy(),
         'name': 'el' + random_str,
         'button_text': 'bt' + random_str,
-        'template': 'boo'
+        'template': 'boo',
+        'colour': '#00FF00',
     }
 
     yield kwargs.copy()
+
+
+@pytest.fixture( scope = 'class')
+def serializer_externallink():
+
+    yield {
+        'base': ExternalLinkBaseSerializer,
+        'model': ExternalLinkModelSerializer,
+        'view': ExternalLinkViewSerializer
+    }