Added aliases to the entity entries API

hinashi · hinashi · commit 40331aaf92c1 · 2024-12-18T11:25:18.000+09:00
diff --git a/entry/api_v2/serializers.py b/entry/api_v2/serializers.py
@@ -23,7 +23,7 @@
 from airone.lib.types import AttrDefaultValue, AttrType
 from entity.api_v2.serializers import EntitySerializer
 from entity.models import Entity, EntityAttr
-from entry.models import Attribute, AttributeValue, Entry, AliasEntry
+from entry.models import AliasEntry, Attribute, AttributeValue, Entry
 from entry.settings import CONFIG as CONFIG_ENTRY
 from group.models import Group
 from job.models import Job, JobStatus
@@ -214,6 +214,16 @@ class AttrTypeField(serializers.IntegerField):
     schema = EntityAttributeTypeSerializer()
 
 
+class EntryAliasSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AliasEntry
+        fields = [
+            "id",
+            "name",
+            "entry",
+        ]
+
+
 class EntryBaseSerializer(serializers.ModelSerializer):
     # This attribute toggle privileged mode that allow user to CRUD Entry without
     # considering permission. This must not change from program, but declare in a
@@ -222,6 +232,7 @@ class EntryBaseSerializer(serializers.ModelSerializer):
 
     schema = EntitySerializer(read_only=True)
     deleted_user = UserBaseSerializer(read_only=True, allow_null=True)
+    aliases = EntryAliasSerializer(many=True, read_only=True)
 
     class Meta:
         model = Entry
@@ -233,6 +244,7 @@ class Meta:
             "deleted_user",
             "deleted_time",
             "updated_time",
+            "aliases",
         ]
         extra_kwargs = {
             "id": {"read_only": True},
@@ -296,6 +308,9 @@ def _validate(self, schema: Entity, name: str, attrs: list[dict[str, Any]]):
                 "validate_entry", schema.name, user, schema.name, name, attrs, self.instance
             )
 
+    def get_aliases(self, obj: Entry):
+        return obj.aliases.all()
+
 
 @extend_schema_field({})
 class AttributeValueField(serializers.Field):
@@ -1318,24 +1333,3 @@ def save(self, **kwargs) -> None:
             params=self.validated_data,
         )
         job.run()
-
-
-class EntryAliasRetrieveSerializer(serializers.ModelSerializer):
-    entry = EntryRetrieveSerializer()
-
-    class Meta:
-        model = Entry
-        fields = [
-            "id",
-            "name",
-            "entry",
-        ]
-
-class EntryAliasUpdateSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = AliasEntry
-        fields = [
-            "id",
-            "name",
-            "entry",
-        ]
diff --git a/entry/api_v2/urls.py b/entry/api_v2/urls.py
@@ -41,7 +41,7 @@
         "<int:pk>/histories/",
         views.EntryAPI.as_view(
             {
-                "get": "list",
+                "get": "list_histories",
             }
         ),
     ),
@@ -55,15 +55,15 @@
     ),
     path(
         "alias/",
-        views.AliasUpdateAPI.as_view(
+        views.EntryAliasAPI.as_view(
             {
                 "post": "create",
             }
         ),
     ),
     path(
         "alias/<int:pk>",
-        views.AliasUpdateAPI.as_view(
+        views.EntryAliasAPI.as_view(
             {
                 "delete": "destroy",
             }
diff --git a/entry/api_v2/views.py b/entry/api_v2/views.py
@@ -4,7 +4,6 @@
 
 from django.conf import settings
 from django.db.models import Prefetch, Q
-from django.http.response import JsonResponse
 from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import OpenApiParameter, extend_schema
 from rest_framework import generics, serializers, status, viewsets
@@ -34,9 +33,8 @@
     AdvancedSearchResultExportSerializer,
     AdvancedSearchResultSerializer,
     AdvancedSearchSerializer,
+    EntryAliasSerializer,
     EntryAttributeValueRestoreSerializer,
-    EntryAliasRetrieveSerializer,
-    EntryAliasUpdateSerializer,
     EntryBaseSerializer,
     EntryCopySerializer,
     EntryExportSerializer,
@@ -46,7 +44,7 @@
     EntryUpdateSerializer,
     GetEntryAttrReferralSerializer,
 )
-from entry.models import Attribute, AttributeValue, Entry, AliasEntry
+from entry.models import AliasEntry, Attribute, AttributeValue, Entry
 from entry.services import AdvancedSearchService
 from entry.settings import CONFIG
 from entry.settings import CONFIG as ENTRY_CONFIG
@@ -66,7 +64,8 @@ def has_object_permission(self, request: Request, view, obj) -> bool:
             "destroy": ACLType.Writable,
             "restore": ACLType.Writable,
             "copy": ACLType.Writable,
-            "list": ACLType.Readable,  # histories
+            "list_histories": ACLType.Readable,  # histories
+            "list_alias": ACLType.Readable,
         }
 
         if not user.has_permission(obj, permisson.get(view.action)):
@@ -86,7 +85,7 @@ def get_serializer_class(self):
             "update": serializers.Serializer,
             "copy": EntryCopySerializer,
             "list": EntryHistoryAttributeValueSerializer,
-            "list_alias": AliasListAPI,
+            "list_alias": EntryAliasSerializer,
         }
         return serializer.get(self.action, EntryBaseSerializer)
 
@@ -177,16 +176,13 @@ def copy(self, request: Request, *args, **kwargs) -> Response:
         return Response({}, status=status.HTTP_200_OK)
 
     def list_alias(self, request: Request, *args, **kwargs) -> Response:
-        print("[onix/view.list_alias(00)]")
-        user: User = self.request.user
         entry: Entry = self.get_object()
 
         self.queryset = AliasEntry.objects.filter(entry=entry, entry__is_active=True)
 
         return super(EntryAPI, self).list(request, *args, **kwargs)
 
-    # histories view
-    def list(self, request: Request, *args, **kwargs) -> Response:
+    def list_histories(self, request: Request, *args, **kwargs) -> Response:
         user: User = self.request.user
         entry: Entry = self.get_object()
 
@@ -840,25 +836,8 @@ def delete(self, request: Request, *args, **kwargs) -> Response:
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 
-class AliasListAPI(viewsets.ModelViewSet):
-    permission_classes = [IsAuthenticated & EntryPermission]
-    pagination_class = LimitOffsetPagination
-    serializer_class = EntryAliasRetrieveSerializer
-
-    def get_queryset(self, *args, **kwargs):
-        # get all aliasentry items that are associated with specified entryid
-        return aliasentry.objects.filter(entry__id=self.kwargs["pk"])
-
-class AliasUpdateAPI(viewsets.ModelViewSet):
-    # permission_classes = [IsAuthenticated & EntryPermission]
+class EntryAliasAPI(viewsets.ModelViewSet):
     permission_classes = [IsAuthenticated]
     pagination_class = LimitOffsetPagination
+    serializer_class = EntryAliasSerializer
     queryset = AliasEntry.objects.filter(entry__is_active=True)
-
-    def get_serializer_class(self):
-        print("[onix/view/get_serializer_class(00)] action: %s" % str(self.action))
-        serializer = {
-            "create": EntryAliasUpdateSerializer,
-            "destroy": EntryAliasUpdateSerializer,
-        }
-        return serializer.get(self.action, EntryAliasRetrieveSerializer)
diff --git a/entry/tests/test_api_v2_alias.py b/entry/tests/test_api_v2_alias.py
@@ -1,8 +1,7 @@
 import json
 
 from airone.lib.test import AironeViewTest
-from entity.models import Entity, EntityAttr
-from entry.models import Attribute, AttributeValue, Entry, AliasEntry
+from entry.models import AliasEntry
 from user.models import User
 
 
@@ -15,6 +14,30 @@ def setUp(self):
         self.model = self.create_entity(self.user, "TestModel")
         self.item = self.add_entry(self.user, "Item", self.model)
 
+    def test_entry_alias_list(self):
+        # initialize Aliases to be listed
+        [self.item.add_alias(x) for x in ["foo", "bar", "baz"]]
+
+        item2 = self.add_entry(self.user, "Item2", self.model)
+        item2.add_alias("hoge")
+
+        # create another Model, Item and Aliases to test to get only Aliases
+        # that are associated with specified Item in the URL parameter.
+        another_model = self.create_entity(self.user, "AnotherModel")
+        another_item = self.add_entry(self.user, "Item", another_model)
+        another_item.add_alias("hoge")
+
+        # send request to list aliases
+        resp = self.client.get("/entity/api/v2/%d/entries/?is_active=true" % self.model.id)
+        self.assertEqual(resp.status_code, 200)
+
+        # check this returned only Aliases that are associated with self.item
+        self.assertEqual(resp.json()["count"], 2)
+        self.assertEqual(
+            [x["name"] for x in resp.json()["results"][0]["aliases"]], ["foo", "bar", "baz"]
+        )
+        self.assertEqual([x["name"] for x in resp.json()["results"][1]["aliases"]], ["hoge"])
+
     def test_list(self):
         # initialize Aliases to be listed
         [self.item.add_alias(x) for x in ["foo", "bar", "baz"]]
@@ -32,13 +55,19 @@ def test_list(self):
         # check this returned only Aliases that are associated with self.item
         self.assertEqual(resp.json()["count"], 3)
         self.assertEqual([x["name"] for x in resp.json()["results"]], ["foo", "bar", "baz"])
-        self.assertTrue(all([x["entry"]["id"] == self.item.id for x in resp.json()["results"]]))
+        self.assertTrue(all([x["entry"] == self.item.id for x in resp.json()["results"]]))
 
     def test_create(self):
-        resp = self.client.post("/entry/api/v2/alias/", json.dumps({
-            "name": "NewAlias",
-            "entry": self.item.id,
-        }), "application/json")
+        resp = self.client.post(
+            "/entry/api/v2/alias/",
+            json.dumps(
+                {
+                    "name": "NewAlias",
+                    "entry": self.item.id,
+                }
+            ),
+            "application/json",
+        )
         self.assertEqual(resp.status_code, 201)
         self.assertEqual(resp.json()["name"], "NewAlias")
         self.assertEqual(resp.json()["entry"], self.item.id)
@@ -51,11 +80,7 @@ def test_delete(self):
         alias = self.item.add_alias("Deleting Alias")
 
         # send request to list aliases
-        resp = self.client.delete(
-            "/entry/api/v2/alias/%s" % alias.id,
-            None,
-            "application/json"
-        )
+        resp = self.client.delete("/entry/api/v2/alias/%s" % alias.id, None, "application/json")
         self.assertEqual(resp.status_code, 204)
 
         # check specified Alias was deleted actually
diff --git a/entry/tests/test_model.py b/entry/tests/test_model.py
@@ -11,7 +11,7 @@
 from airone.lib.test import AironeTestCase
 from airone.lib.types import AttrType
 from entity.models import Entity, EntityAttr
-from entry.models import Attribute, AttributeValue, Entry, AliasEntry
+from entry.models import Attribute, AttributeValue, Entry
 from entry.services import AdvancedSearchService
 from entry.settings import CONFIG
 from group.models import Group
@@ -5018,4 +5018,4 @@ def test_max_entries(self):
         settings.MAX_ENTRIES = None
         Entry.objects.create(
             name=f"entry-{max_entries}", created_user=self._user, schema=self._entity
-        )
+        )
diff --git a/entry/tests/test_model_alias.py b/entry/tests/test_model_alias.py
@@ -1,6 +1,5 @@
 from airone.lib.test import AironeTestCase
 from entry.models import AliasEntry
-from user.models import User
 
 
 class ModelTest(AironeTestCase):

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`"<int:pk>/histories/",`
`42`	`42`	`views.EntryAPI.as_view(`
`43`	`43`	`{`
`44`		`- "get": "list",`
	`44`	`+ "get": "list_histories",`
`45`	`45`	`}`
`46`	`46`	`),`
`47`	`47`	`),`
`@@ -55,15 +55,15 @@`
`55`	`55`	`),`
`56`	`56`	`path(`
`57`	`57`	`"alias/",`
`58`		`- views.AliasUpdateAPI.as_view(`
	`58`	`+ views.EntryAliasAPI.as_view(`
`59`	`59`	`{`
`60`	`60`	`"post": "create",`
`61`	`61`	`}`
`62`	`62`	`),`
`63`	`63`	`),`
`64`	`64`	`path(`
`65`	`65`	`"alias/<int:pk>",`
`66`		`- views.AliasUpdateAPI.as_view(`
	`66`	`+ views.EntryAliasAPI.as_view(`
`67`	`67`	`{`
`68`	`68`	`"delete": "destroy",`
`69`	`69`	`}`