feat(access): Support updating role permissions in format <app>.<permission>_<model>

ref: #1190 #1160 nofusscomputing/ansible_collection_centurion#47

Author: jon-nfc

app/access/serializers/role.py

@@ -1,4 +1,11 @@
+from functools import reduce
+
+from operator import or_
+
+from django.db import models
+
 from rest_framework import serializers
+from rest_framework.exceptions import ParseError
 
 from drf_spectacular.utils import extend_schema_serializer
 
@@ -98,6 +105,47 @@ class Meta:
 
 
 
+    def to_internal_value(self, data):
+        """Convert Permission Names
+
+        Permission may be added in format `<app>.<permission>_<model>` this
+        function converts to the permission pk.
+        """
+
+        if(
+            'permissions' in data
+            and isinstance(data['permissions'][0], str)
+        ):
+
+            filters = [
+                models.Q(
+                    content_type__app_label=app, codename=codename
+                ) for app, codename in (
+                    perm.split(".", 1) for perm in data['permissions']
+                )
+            ]
+
+            PermissionModel = self.Meta.model.permissions.field.related_model
+
+            permissions_id = [
+                permission.id for permission in PermissionModel.objects.filter(
+                    reduce(or_, filters)
+                )
+            ]
+
+
+            if len(permissions_id) != len(data['permissions']):
+                raise ParseError(
+                    detail = 'A Permission was supplied that could not be found',
+                    code = 'supplied_permission_does_not_exist'
+                )
+
+            data['permissions'] = permissions_id
+
+        return super().to_internal_value(data)
+
+
+
 @extend_schema_serializer(component_name = 'RoleViewSerializer')
 class ViewSerializer(ModelSerializer):
     """Role Base View Model"""

app/access/tests/unit/role/test_unit_role_serializer.py

@@ -47,6 +47,39 @@ def test_serializer_validation_no_name(self,
 
 
 
+    @pytest.mark.skip( reason = 'Test to be written' )
+    def test_serializer_function_to_internal_value_permissions_as_int(self):
+        """Serializer Function Check
+
+        Ensure that function `to_internal_value` accepts permissions as a list
+        of int
+        """
+        pass
+
+
+
+    @pytest.mark.skip( reason = 'Test to be written' )
+    def test_serializer_function_to_internal_value_permissions_to_int(self):
+        """Serializer Function Check
+
+        Ensure that function `to_internal_value` converts the permission
+        strings list to a list of int.
+        """
+        pass
+
+
+
+    @pytest.mark.skip( reason = 'Test to be written' )
+    def test_serializer_function_to_internal_value_permissions_not_exist(self):
+        """Serializer Function Check
+
+        Ensure that function `to_internal_value` raises an exception when a
+        permission supplied does not exist.
+        """
+        pass
+
+
+
 class RoleSerializerInheritedCases(
     RoleSerializerTestCases
 ):

app/api/tests/unit/test_unit_serializer.py

@@ -138,3 +138,16 @@ def test_only_base_defines__urls_object(self,
         """
 
         assert model_serializer['model']._declared_fields['_urls'].method_name == 'get_url_fields'
+
+
+
+    @pytest.mark.skip( reason = 'Test to be written' )
+    def test_role_serializer_accepts_permissions_as_str(self,
+        serializer_role, model
+    ):
+        """RoleSerializer Function Check
+
+        Ensure that role function `to_internal_value` accepts models
+        permissions as a list of str. format `<app>.<permission>_<model>`.
+        """
+        pass

docs/projects/centurion_erp/user/access/role.md

@@ -28,3 +28,8 @@ Unlike filesystem based permssions, Centurion ERP permissions are not inclusive,
 - To `view` an item you must have its corresponding `view` permission
 
 The exclusitvity is that each of the permissions listed above, dont include an assumed permission. For instance if you have the `add` permission for an item, you will not be able to view it. That would require the `view` permission.
+
+
+## Updating Role Permissions
+
+Roles like all objects can be updated via the API. However role permissions additionally support supplying the permission(s) as a string. The format for the permission is `<app>.<permission>_<model>`. This has been added as a feature so it's easier to see what permission is being used as normally an API list would only contain numbers.