Merge pull request #847 from nofusscomputing/model-inheritance-tests

jon-nfc · web-flow · commit dea1daed98f0 · 2025-06-21T16:14:23.000+09:30
diff --git a/app/access/models/entity.py b/app/access/models/entity.py
@@ -70,7 +70,7 @@ def __str__(self) -> str:
 
 
 
-    def clean(self):
+    def clean_fields(self, exclude = None ):
 
         related_model = self.get_related_model()
 
@@ -82,6 +82,8 @@ def clean(self):
 
             self.entity_type = str(related_model._meta.verbose_name).lower().replace(' ', '_')
 
+        super().clean_fields( exclude = exclude )
+
 
 
     def get_related_field_name(self) -> str:
@@ -139,24 +141,3 @@ def get_related_model(self):
 
 
         return related_model
-
-
-    def get_url_kwargs(self, many = False) -> dict:
-
-        model = self.get_related_model()
-
-        if (len(self._meta.parents) == 0 and model is None) or not many:
-
-            return {
-                'pk': self.id
-            }
-
-        if model is None:
-
-            model = self
-
-        kwargs = {
-            'entity_model': str(model._meta.verbose_name).lower().replace(' ', '_'),
-        }
-
-        return kwargs
diff --git a/app/access/tests/functional/company/test_functional_company_metadata.py b/app/access/tests/functional/company/test_functional_company_metadata.py
@@ -53,11 +53,11 @@ def setUpTestData(self):
         }
 
         # self.url_kwargs = {
-        #     'entity_model': self.model._meta.sub_model_type
+        #     'model_name': self.model._meta.sub_model_type
         # }
 
         # self.url_view_kwargs = {
-        #     'entity_model': self.model._meta.sub_model_type
+        #     'model_name': self.model._meta.sub_model_type
         # }
 
         super().setUpTestData()
diff --git a/app/access/tests/functional/contact/test_functional_contact_permission.py b/app/access/tests/functional/contact/test_functional_contact_permission.py
@@ -41,11 +41,11 @@ class ContactPermissionsAPIInheritedCases(
     # def inherited_var_setup(self, request):
 
     #     request.cls.url_kwargs.update({
-    #         'entity_model': self.model._meta.sub_model_type
+    #         'model_name': self.model._meta.sub_model_type
     #     })
 
     #     request.cls.url_view_kwargs.update({
-    #         'entity_model': self.model._meta.sub_model_type
+    #         'model_name': self.model._meta.sub_model_type
     #     })
 
 
diff --git a/app/access/tests/functional/entity/test_functional_entity_metadata.py b/app/access/tests/functional/entity/test_functional_entity_metadata.py
@@ -240,11 +240,11 @@ def setUpTestData(self):
         }
 
         self.url_kwargs = {
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         }
 
         self.url_view_kwargs = {
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         }
 
         super().setUpTestData()
diff --git a/app/access/tests/functional/entity/test_functional_entity_permission.py b/app/access/tests/functional/entity/test_functional_entity_permission.py
@@ -60,11 +60,11 @@ class EntityPermissionsAPIInheritedCases(
     def inherited_var_setup(self, request):
 
         request.cls.url_kwargs.update({
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         })
 
         request.cls.url_view_kwargs.update({
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         })
 
 
diff --git a/app/access/tests/functional/entity/test_functional_entity_viewset.py b/app/access/tests/functional/entity/test_functional_entity_viewset.py
@@ -247,11 +247,11 @@ def setUpTestData(self):
         }
 
         self.url_kwargs = {
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         }
 
         self.url_view_kwargs = {
-            'entity_model': self.model._meta.sub_model_type
+            'model_name': self.model._meta.sub_model_type
         }
 
         super().setUpTestData()
diff --git a/app/access/tests/functional/person/test_functional_person_metadata.py b/app/access/tests/functional/person/test_functional_person_metadata.py
@@ -64,11 +64,11 @@ def setUpTestData(self):
         }
 
         # self.url_kwargs = {
-        #     'entity_model': self.model._meta.sub_model_type
+        #     'model_name': self.model._meta.sub_model_type
         # }
 
         # self.url_view_kwargs = {
-        #     'entity_model': self.model._meta.sub_model_type
+        #     'model_name': self.model._meta.sub_model_type
         # }
 
         super().setUpTestData()
diff --git a/app/access/tests/functional/person/test_functional_person_permission.py b/app/access/tests/functional/person/test_functional_person_permission.py
@@ -62,11 +62,11 @@ class PersonPermissionsAPIInheritedCases(
     # def inherited_var_setup(self, request):
 
     #     request.cls.url_kwargs.update({
-    #         'entity_model': self.model._meta.sub_model_type
+    #         'model_name': self.model._meta.sub_model_type
     #     })
 
     #     request.cls.url_view_kwargs.update({
-    #         'entity_model': self.model._meta.sub_model_type
+    #         'model_name': self.model._meta.sub_model_type
     #     })
 
 
diff --git a/app/access/tests/unit/entity/test_unit_entity_api_fields.py b/app/access/tests/unit/entity/test_unit_entity_api_fields.py
@@ -24,7 +24,7 @@ def setup_model(self, request,
         if model != self.base_model:
         
             request.cls.url_view_kwargs.update({
-                'entity_model': model._meta.sub_model_type,
+                'model_name': model._meta.sub_model_type,
             })
 
 
diff --git a/app/access/tests/unit/entity/test_unit_entity_model.py b/app/access/tests/unit/entity/test_unit_entity_model.py
@@ -93,6 +93,22 @@ def test_attribute_value_kb_model_name(self, model):
         assert model.kb_model_name == 'entity'
 
 
+    def test_method_get_url_kwargs(self, mocker, model_instance, settings):
+        """Test Class Method
+        
+        Ensure method `get_url_kwargs` returns the correct value.
+        """
+
+
+        url = model_instance.get_url_kwargs()
+
+        assert model_instance.get_url_kwargs() == {
+            'model_name': model_instance._meta.model_name,
+            'pk': model_instance.id
+        }
+
+
+
 
 class EntityModelInheritedCases(
     EntityModelTestCases,
@@ -113,3 +129,16 @@ def test_function_value_get_related_model(self, model_instance):
         """
 
         assert model_instance.get_related_model() is None
+
+    def test_method_get_url_kwargs(self, mocker, model_instance, settings):
+        """Test Class Method
+        
+        Ensure method `get_url_kwargs` returns the correct value.
+        """
+
+
+        url = model_instance.get_url_kwargs()
+
+        assert model_instance.get_url_kwargs() == {
+            'pk': model_instance.id
+        }
diff --git a/app/access/tests/unit/entity/test_unit_entity_viewset.py b/app/access/tests/unit/entity/test_unit_entity_viewset.py
@@ -4,7 +4,7 @@
 
 from rest_framework.reverse import reverse
 
-
+from access.models.entity import Entity
 from access.viewsets.entity import (
     NoDocsViewSet,
     ViewSet,
@@ -21,6 +21,8 @@ class ViewsetTestCases(
 
     kwargs = None
 
+    model = Entity
+
     viewset = None
 
     route_name = None
@@ -66,7 +68,7 @@ class EntityViewsetInheritedCases(
     def setUpTestData(self):
 
         self.kwargs = {
-            'entity_model': self.model._meta.model_name
+            'model_name': self.model._meta.model_name
         }
 
         super().setUpTestData()
diff --git a/app/access/tests/unit/role/test_unit_role_api_v2.py b/app/access/tests/unit/role/test_unit_role_api_v2.py
@@ -56,7 +56,7 @@ def setUpTestData(self):
         # if self.model._meta.model_name != 'entity':
 
         #     self.url_view_kwargs.update({
-        #         'entity_model': self.item.entity_type,
+        #         'model_name': self.item.entity_type,
         #     })
 
 
diff --git a/app/access/urls_api.py b/app/access/urls_api.py
@@ -34,12 +34,12 @@
 router.register('', access_v2.Index, basename = '_api_v2_access_home')
 
 router.register(
-    prefix = '(?P<entity_model>[company]+)', viewset = entity.ViewSet,
+    prefix = '(?P<model_name>[company]+)', viewset = entity.ViewSet,
     feature_flag = '2025-00008',basename = '_api_v2_company'
 )
 
 router.register(
-    prefix=f'entity/(?P<entity_model>[{entity_type_names}]+)?', viewset = entity.ViewSet,
+    prefix=f'entity/(?P<model_name>[{entity_type_names}]+)?', viewset = entity.ViewSet,
     feature_flag = '2025-00002', basename = '_api_entity_sub'
 )
 
diff --git a/app/access/viewsets/entity.py b/app/access/viewsets/entity.py
@@ -24,7 +24,9 @@
     Entity,
 )
 
-from api.viewsets.common import SubModelViewSet
+from api.viewsets.common import (
+    SubModelViewSet_ReWrite,
+)
 
 
 
@@ -63,7 +65,7 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         description='.',
         parameters = [
             OpenApiParameter(
-                name = 'entity_model',
+                name = 'model_name',
                 description = 'Enter the entity type. This is the name of the Entity sub-model.',
                 location = OpenApiParameter.PATH,
                 type = str,
@@ -104,7 +106,7 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         description = '.',
         parameters =[
             OpenApiParameter(
-                name = 'entity_model',
+                name = 'model_name',
                 description = 'Enter the entity type. This is the name of the Entity sub-model.',
                 location = OpenApiParameter.PATH,
                 type = str,
@@ -128,7 +130,7 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         description='.',
         parameters = [
             OpenApiParameter(
-                name = 'entity_model',
+                name = 'model_name',
                 description = 'Enter the entity type. This is the name of the Entity sub-model.',
                 location = OpenApiParameter.PATH,
                 type = str,
@@ -160,7 +162,7 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         description='.',
         parameters = [
             OpenApiParameter(
-                name = 'entity_model',
+                name = 'model_name',
                 description = 'Enter the entity type. This is the name of the Entity sub-model.',
                 location = OpenApiParameter.PATH,
                 type = str,
@@ -193,7 +195,7 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         description = '.',
         parameters = [
             OpenApiParameter(
-                name = 'entity_model',
+                name = 'model_name',
                 description = 'Enter the entity type. This is the name of the Entity sub-model.',
                 location = OpenApiParameter.PATH,
                 type = str,
@@ -221,15 +223,17 @@ def spectacular_request_serializers( serializer_type = 'Model'):
         }
     ),
 )
-class ViewSet( SubModelViewSet ):
+class ViewSet(
+    SubModelViewSet_ReWrite
+):
 
     base_model = Entity
 
     filterset_fields = [
         'organization',
     ]
 
-    model_kwarg = 'entity_model'
+    model_kwarg = 'model_name'
 
     search_fields = [
         'model_notes',
@@ -250,7 +254,7 @@ def get_back_url(self) -> str:
                 viewname = '_api_entity_sub-list',
                 request = self.request,
                 kwargs = {
-                    'entity_model': self.kwargs[self.model_kwarg],
+                    'model_name': self.kwargs[self.model_kwarg],
                 }
             )
 
diff --git a/app/access/viewsets/index.py b/app/access/viewsets/index.py
@@ -30,7 +30,7 @@ def list(self, request, pk=None):
         if self.request.feature_flag['2025-00002']:
             
             response.update({
-                "directory": reverse( 'v2:_api_entity_sub-list', request=request, kwargs = { 'entity_model': 'contact' } ),
+                "directory": reverse( 'v2:_api_entity_sub-list', request=request, kwargs = { 'model_name': 'contact' } ),
                 "entities": reverse( 'v2:_api_entity-list', request=request ),
             })
 
diff --git a/app/api/tests/functional/test_functional_api_fields.py b/app/api/tests/functional/test_functional_api_fields.py
@@ -106,6 +106,7 @@ def setup_pre(self,
     ):
 
         request.cls.url_view_kwargs = {}
+        request.cls.model = model
 
         with django_db_blocker.unblock():
 
@@ -140,11 +141,15 @@ def setup_pre(self,
                 })
 
 
-            if 'model_notes' in self.model().fields:
+            if hasattr(request.cls.model(), 'model_notes'):
 
-                request.cls.kwargs_create_item.update({
-                    'model_notes': 'notes',
-                })
+                for field in request.cls.model()._meta.fields:
+
+                    if field.attname == 'model_notes':
+
+                        request.cls.kwargs_create_item.update({
+                            'model_notes': 'notes',
+                        })
 
 
             view_permissions = Permission.objects.get(
diff --git a/app/api/tests/unit/test_unit_common_viewset.py b/app/api/tests/unit/test_unit_common_viewset.py
diff --git a/app/human_resources/viewsets/index.py b/app/human_resources/viewsets/index.py
diff --git a/app/tests/fixtures/model_employee.py b/app/tests/fixtures/model_employee.py

Original file line number	Diff line number	Diff line change
`@@ -240,11 +240,11 @@ def setUpTestData(self):`
`240`	`240`	`}`
`241`	`241`
`242`	`242`	`self.url_kwargs = {`
`243`		`- 'entity_model': self.model._meta.sub_model_type`
	`243`	`+ 'model_name': self.model._meta.sub_model_type`
`244`	`244`	`}`
`245`	`245`
`246`	`246`	`self.url_view_kwargs = {`
`247`		`- 'entity_model': self.model._meta.sub_model_type`
	`247`	`+ 'model_name': self.model._meta.sub_model_type`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`super().setUpTestData()`
Original file line number	Diff line number	Diff line change
`@@ -247,11 +247,11 @@ def setUpTestData(self):`
`247`	`247`	`}`
`248`	`248`
`249`	`249`	`self.url_kwargs = {`
`250`		`- 'entity_model': self.model._meta.sub_model_type`
	`250`	`+ 'model_name': self.model._meta.sub_model_type`
`251`	`251`	`}`
`252`	`252`
`253`	`253`	`self.url_view_kwargs = {`
`254`		`- 'entity_model': self.model._meta.sub_model_type`
	`254`	`+ 'model_name': self.model._meta.sub_model_type`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`super().setUpTestData()`