refactor(devops): Serializer Unit Test Suite re-written to Pytest for model FeatureFlag

ref: #946 #944
This commit is contained in:
2025-08-07 12:49:06 +09:30
parent d340fb3375
commit 20f5c3b5d7
5 changed files with 280 additions and 213 deletions

View File

@ -1,213 +0,0 @@
import pytest
from django.test import TestCase
from rest_framework.exceptions import ValidationError
from access.models.tenant import Tenant as Organization
from devops.models.software_enable_feature_flag import SoftwareEnableFeatureFlag
from devops.serializers.feature_flag import FeatureFlag, ModelSerializer
from itam.models.software import Software
class ValidationAPI(
TestCase,
):
model = FeatureFlag
@classmethod
def setUpTestData(self):
"""Setup Test
1. Create an org
2. Create an item
"""
organization = Organization.objects.create(name='test_org')
self.organization = organization
self.diff_organization = Organization.objects.create(name='test_org_diff_org')
software = Software.objects.create(
organization = self.organization,
name = 'soft',
)
SoftwareEnableFeatureFlag.objects.create(
organization = self.organization,
software = software,
enabled = True
)
self.item = self.model.objects.create(
organization = self.organization,
name = 'one',
software = software,
description = 'desc',
model_notes = 'text',
enabled = True
)
self.valid_data = {
'organization': self.organization.id,
'name': 'two',
'software': software.id,
'description': 'a description',
'model_notes': 'dfsdfsd',
'enabled': True
}
self.software_no_feature_flag_enabled = Software.objects.create(
organization = self.organization,
name = 'soft no flagging',
)
def test_serializer_validation_valid_data(self):
"""Serializer Validation Check
Ensure that if creating and no name is provided a validation error occurs
"""
serializer = ModelSerializer(
data = self.valid_data
)
assert serializer.is_valid( raise_exception = True )
def test_serializer_validation_no_name_exception(self):
"""Serializer Validation Check
Ensure that when creating and field name is not provided a
validation error occurs
"""
valid_data = self.valid_data.copy()
del valid_data['name']
with pytest.raises(ValidationError) as err:
serializer = ModelSerializer(
data = valid_data
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['name'][0] == 'required'
def test_serializer_validation_no_software_exception(self):
"""Serializer Validation Check
Ensure that when creating and field software is not provided, no
validation error occurs
"""
valid_data = self.valid_data.copy()
del valid_data['software']
with pytest.raises(ValidationError) as err:
serializer = ModelSerializer(
data = valid_data
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['software'][0] == 'required'
def test_serializer_validation_feature_flagging_not_enabled(self):
"""Serializer Validation Check
Ensure that when creating and the software doesn't, have feature
flagging enabled an exception is thrown.
"""
valid_data = self.valid_data.copy()
valid_data['software'] = self.software_no_feature_flag_enabled.id
with pytest.raises(ValidationError) as err:
serializer = ModelSerializer(
data = valid_data
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['software'] == 'feature_flagging_disabled'
def test_serializer_validation_feature_flagging_not_enabled_for_organization(self):
"""Serializer Validation Check
Ensure that when creating and the software doesn't, have feature
flagging enabled an exception is thrown.
"""
valid_data = self.valid_data.copy()
valid_data['organization'] = self.diff_organization.id
with pytest.raises(ValidationError) as err:
serializer = ModelSerializer(
data = valid_data
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['organization'] == 'feature_flagging_wrong_organizaiton'
def test_serializer_validation_no_description_ok(self):
"""Serializer Validation Check
Ensure that when creating and field description is not provided, no
validation error occurs
"""
valid_data = self.valid_data.copy()
del valid_data['description']
serializer = ModelSerializer(
data = valid_data
)
assert serializer.is_valid(raise_exception = True)
def test_serializer_validation_no_enabled_ok_default_false(self):
"""Serializer Validation Check
Ensure that when creating and field enabled is not provided, no
validation error occurs and enabled is set to `false`
"""
valid_data = self.valid_data.copy()
del valid_data['enabled']
serializer = ModelSerializer(
data = valid_data
)
assert serializer.is_valid(raise_exception = True)
serializer.save()
assert serializer.instance.enabled is False

View File

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

View File

@ -0,0 +1,257 @@
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_featureflag
class FeatureFlagSerializerTestCases(
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_exception(self,
kwargs_api_create, model, model_serializer, request_user
):
"""Serializer Validation Check
Ensure that when creating and field name is not 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_software_exception(self,
kwargs_api_create, model, model_serializer, request_user
):
"""Serializer Validation Check
Ensure that when creating and field software is not provided, no
validation error occurs
"""
mock_view = MockView(
user = request_user,
model = model,
action = 'create',
)
kwargs = kwargs_api_create.copy()
del kwargs['software']
with pytest.raises(ValidationError) as err:
serializer = model_serializer['model'](
data = kwargs
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['software'][0] == 'required'
def test_serializer_validation_feature_flagging_not_enabled(self,
kwargs_api_create, model, model_serializer, request_user,
model_software, kwargs_software,
):
"""Serializer Validation Check
Ensure that when creating and the software doesn't, have feature
flagging enabled an exception is thrown.
"""
mock_view = MockView(
user = request_user,
model = model,
action = 'create',
)
kwargs = kwargs_software.copy()
kwargs['name'] = 'ff_soft'
software = model_software.objects.create( **kwargs )
kwargs = kwargs_api_create.copy()
kwargs['software'] = software.id
with pytest.raises(ValidationError) as err:
serializer = model_serializer['model'](
data = kwargs
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['software'] == 'feature_flagging_disabled'
software.delete()
def test_serializer_validation_feature_flagging_not_enabled_for_organization(self,
kwargs_api_create, model, model_serializer, request_user, api_request_permissions
):
"""Serializer Validation Check
Ensure that when creating and the software doesn't, have feature
flagging enabled an exception is thrown.
"""
mock_view = MockView(
user = request_user,
model = model,
action = 'create',
)
kwargs = kwargs_api_create.copy()
kwargs['organization'] = api_request_permissions['tenancy']['different']
with pytest.raises(ValidationError) as err:
serializer = model_serializer['model'](
data = kwargs
)
serializer.is_valid(raise_exception = True)
assert err.value.get_codes()['organization'] == 'feature_flagging_wrong_organizaiton'
def test_serializer_validation_no_description_ok(self,
kwargs_api_create, model, model_serializer, request_user
):
"""Serializer Validation Check
Ensure that when creating and field description is not provided, no
validation error occurs
"""
mock_view = MockView(
user = request_user,
model = model,
action = 'create',
)
kwargs = kwargs_api_create.copy()
del kwargs['description']
serializer = model_serializer['model'](
data = kwargs
)
assert serializer.is_valid(raise_exception = True)
def test_serializer_validation_no_enabled_ok_default_false(self,
kwargs_api_create, model, model_serializer, request_user
):
"""Serializer Validation Check
Ensure that when creating and field enabled is not provided, no
validation error occurs and enabled is set to `false`
"""
mock_view = MockView(
user = request_user,
model = model,
action = 'create',
)
kwargs = kwargs_api_create.copy()
del kwargs['enabled']
serializer = model_serializer['model'](
data = kwargs
)
assert serializer.is_valid(raise_exception = True)
serializer.save()
assert serializer.instance.enabled is False
class FeatureFlagSerializerInheritedCases(
FeatureFlagSerializerTestCases
):
pass
@pytest.mark.module_assistance
class FeatureFlagSerializerPyTest(
FeatureFlagSerializerTestCases
):
pass

View File

@ -152,6 +152,7 @@ from .model_externallink import (
from .model_featureflag import (
kwargs_featureflag,
model_featureflag,
serializer_featureflag,
)
from .model_gitgroup import (

View File

@ -1,6 +1,11 @@
import pytest
from devops.models.feature_flag import FeatureFlag
from devops.serializers.feature_flag import (
BaseSerializer,
ModelSerializer,
ViewSerializer
)
@ -45,3 +50,14 @@ def kwargs_featureflag(django_db_blocker, kwargs_centurionmodel, model_software,
software.delete()
except:
pass
@pytest.fixture( scope = 'class')
def serializer_featureflag():
yield {
'base': BaseSerializer,
'model': ModelSerializer,
'view': ViewSerializer
}