test: Unit test case for ensuing that layout.table contains valid fields

ref:

Author: jon-nfc

app/config_management/tests/unit/config_group_hosts/test_unit_config_group_hosts_model.py

@@ -89,3 +89,6 @@ class ConfigGroupHostModelPyTest(
     def test_method_get_url_returns_str(self, mocker, model_instance):
 
         pytest.xfail( reason = 'This model has no endpoint' )
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'This model has no endpoint' )

app/config_management/tests/unit/config_groups_software/test_unit_config_groups_software_model.py

@@ -159,4 +159,6 @@ class ConfigGroupSoftwareModelInheritedCases(
 class ConfigGroupSoftwareModelPyTest(
     ConfigGroupSoftwareModelTestCases,
 ):
-    pass
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'This model has no endpoint' )

app/core/tests/unit/centurion_abstract/test_unit_centurion_abstract_model.py

@@ -242,3 +242,6 @@ def test_manager_tenancy_filter_tenant(self):
 
     def test_manager_tenancy_select_related(self):
         pytest.xfail( reason = 'base model, test is n/a.' )
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'base model, test is n/a.' )

app/core/tests/unit/centurion_audit/test_unit_centurion_audit_model.py

@@ -313,3 +313,7 @@ def test_method_get_model_history_populates_field_before(self, model_instance):
         del model_instance._before
 
         assert model_instance.before == test_value
+
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'base model, test is n/a.' )

app/core/tests/unit/centurion_audit_meta/test_unit_centurion_audit_meta_model.py

@@ -264,3 +264,6 @@ def test_method_clean_fields_calls_super_centurion_mixin(self):
 
     def test_method_clean_fields_calls_super_tenancy_abstract(self):
         pytest.xfail( reason = 'base model, test is n/a.' )
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'base model, test is n/a.' )

app/core/tests/unit/centurion_audit_meta/test_unit_meta_audit_history_model.py

@@ -1,3 +1,5 @@
+import importlib
+
 import pytest
 
 from django.apps import apps
@@ -183,7 +185,24 @@ def model(self, request):
 
         yield request.cls.model_class
 
-    
+
+    @pytest.fixture( scope = 'class')
+    def model_serializer(self, model):
+
+        serializer_name: str =  'centurionaudit_' + str(model._meta.model_name)[0:( len(model._meta.model_name) - len('audithistory') )]
+
+        serializer_module = importlib.import_module(
+                    name = model._meta.app_label + '.serializers.' + str(
+                        serializer_name
+                    )
+                )
+
+
+        yield {
+            'view': getattr( serializer_module, 'ViewSerializer' )
+        }
+
+
     @pytest.mark.skip( reason = 'ToDo: Figure out how to dynomagic add audit_model instance' )
     def test_model_creation(self, model, user):
         pass

app/core/tests/unit/centurion_model_note/test_unit_centurion_model_note_model.py

@@ -164,3 +164,6 @@ def test_method_get_url_returns_str(self, model, model_instance):
         """
 
         pytest.xfail( reason = 'Test not required as model does not have direct endpoint.' )
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'base model, test is n/a.' )

app/core/tests/unit/centurion_model_note_meta/test_unit_centurion_model_note_meta_model.py

@@ -265,3 +265,6 @@ def test_method_clean_fields_calls_super_centurion_mixin(self):
 
     def test_method_clean_fields_calls_super_tenancy_abstract(self):
         pytest.xfail( reason = 'base model, test is n/a.' )
+
+    def test_attribute_page_layout_table_fields(self):
+        pytest.xfail( reason = 'base model, test is n/a.' )

app/core/tests/unit/centurion_model_note_meta/test_unit_meta_model_note_model.py

@@ -1,3 +1,5 @@
+import importlib
+
 import pytest
 
 from django.apps import apps
@@ -188,6 +190,24 @@ def model(self, request):
         return request.cls.model_class
 
 
+    @pytest.fixture( scope = 'class')
+    def model_serializer(self, model):
+
+        serializer_name: str =  'centurionmodelnote_' + str(model._meta.model_name).replace('centurionmodelnote', '')
+
+        serializer_module = importlib.import_module(
+                    name = model._meta.app_label + '.serializers.' + str(
+                        serializer_name
+                    )
+                )
+
+
+        yield {
+            'view': getattr( serializer_module, 'ViewSerializer' )
+        }
+
+
+
     @pytest.mark.skip( reason = 'ToDo: Figure out how to dynomagic add note_model instance' )
     def test_model_creation(self, model, user):
         pass

app/core/tests/unit/mixin_centurion/test_unit_centurion_mixin.py

@@ -440,6 +440,69 @@ def get(*args, **kwargs):
         # Fail-Safe to ensure test writer fills all fields
 
 
+    def test_attribute_page_layout_table_fields(self, model, model_serializer):
+        """Test page_layout key
+        
+        Ensure that all table columns use valid model fields.
+        """
+
+        if 'table' not in model.page_layout:
+            pytest.xfail( reason = 'model does not use any layout.' )
+
+
+
+        allowed_unknown_fields = [
+            '-action_delete-',    # Adds delete button to UI
+            'nbsp',    # blank cell
+        ]
+
+        def check(field) -> list:
+
+            return_val = []
+
+            if model_serializer['view'].Meta.fields == '__all__':
+
+                if not hasattr(model, field):
+
+                    return_val += [ field ]
+
+
+            elif(
+                not field in model_serializer['view'].Meta.fields
+                and field not in allowed_unknown_fields
+            ):
+
+                return_val += [ field ]
+
+            return return_val
+
+
+
+        unknown_fields = []
+
+        for field in model.page_layout['table']:
+
+            if isinstance(field, list):
+
+                for sub_field in field:
+
+                    unknown_fields += check(sub_field)
+
+            elif isinstance(field, dict):
+
+                field = field['field']
+
+                unknown_fields += check(field)
+
+            else:
+
+                unknown_fields += check(field)
+
+
+        assert len(unknown_fields) == 0, f"The following field(s) are not a model field {unknown_fields}"
+
+
+
 
 @pytest.mark.module_core
 class CenturionMixnPyTest(