chore: update job_token docs and object names

TimKnight-DWP · JohnVillalovos · commit b6e4d0121953 · 2024-05-13T14:25:14.000-07:00
Signed-off-by: Tim Knight &lt;tim.knight1@engineering.digital.dwp.gov.uk&gt;
diff --git a/docs/gl_objects/job_token_scope.rst b/docs/gl_objects/job_token_scope.rst
@@ -67,9 +67,18 @@ Remove a project from the project's inbound allowlist::
 .. warning::
 
    Similar to above, the ID attributes you receive from the create and list
-   APIs are not consistent. To safely retrieve the ID of the allowlisted project
+   APIs are not consistent (in create() the id is returned as ``source_project_id`` whereas list() returns as ``id``). To safely retrieve the ID of the allowlisted project
    regardless of how the object was created, always use its ``.get_id()`` method.
 
+Using ``.get_id()``::
+
+    resp = allowlist.create({"target_project_id": 2})
+    allowlist_id = resp.get_id()
+
+    allowlists = project.allowlist.list()
+    for allowlist in allowlists:
+      allowlist_id == allowlist.get_id()
+
 Get a project's CI/CD job token inbound groups allowlist::
 
     allowlist = scope.groups_allowlist.list()
diff --git a/gitlab/v4/objects/job_token_scope.py b/gitlab/v4/objects/job_token_scope.py
@@ -23,8 +23,8 @@
 class ProjectJobTokenScope(RefreshMixin, SaveMixin, RESTObject):
     _id_attr = None
 
-    allowlist: "AllowlistedProjectManager"
-    groups_allowlist: "AllowlistedGroupManager"
+    allowlist: "AllowlistProjectManager"
+    groups_allowlist: "AllowlistGroupManager"
 
 
 class ProjectJobTokenScopeManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
@@ -37,7 +37,7 @@ def get(self, **kwargs: Any) -> ProjectJobTokenScope:
         return cast(ProjectJobTokenScope, super().get(**kwargs))
 
 
-class AllowlistedProject(ObjectDeleteMixin, RESTObject):
+class AllowlistProject(ObjectDeleteMixin, RESTObject):
     _id_attr = "target_project_id"  # note: only true for create endpoint
 
     def get_id(self) -> int:
@@ -47,17 +47,17 @@ def get_id(self) -> int:
         try:
             return cast(int, getattr(self, self._id_attr))
         except AttributeError:
-            return cast(int, getattr(self, "id"))
+            return cast(int, self.id)
 
 
-class AllowlistedProjectManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
+class AllowlistProjectManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
     _path = "/projects/{project_id}/job_token_scope/allowlist"
-    _obj_cls = AllowlistedProject
+    _obj_cls = AllowlistProject
     _from_parent_attrs = {"project_id": "project_id"}
     _create_attrs = RequiredOptional(required=("target_project_id",))
 
 
-class AllowlistedGroup(ObjectDeleteMixin, RESTObject):
+class AllowlistGroup(ObjectDeleteMixin, RESTObject):
     _id_attr = "target_group_id"  # note: only true for create endpoint
 
     def get_id(self) -> int:
@@ -67,11 +67,11 @@ def get_id(self) -> int:
         try:
             return cast(int, getattr(self, self._id_attr))
         except AttributeError:
-            return cast(int, getattr(self, "id"))
+            return cast(int, self.id)
 
 
-class AllowlistedGroupManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
+class AllowlistGroupManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
     _path = "/projects/{project_id}/job_token_scope/groups_allowlist"
-    _obj_cls = AllowlistedGroup
+    _obj_cls = AllowlistGroup
     _from_parent_attrs = {"project_id": "project_id"}
     _create_attrs = RequiredOptional(required=("target_group_id",))
diff --git a/tests/unit/objects/test_job_token_scope.py b/tests/unit/objects/test_job_token_scope.py
@@ -7,8 +7,8 @@
 
 from gitlab.v4.objects import ProjectJobTokenScope
 from gitlab.v4.objects.job_token_scope import (
-    AllowlistedGroupManager,
-    AllowlistedProjectManager,
+    AllowlistGroupManager,
+    AllowlistProjectManager,
 )
 
 job_token_scope_content = {
@@ -170,31 +170,31 @@ def test_update_job_token_scope(project, resp_patch_job_token_scope):
 
 def test_get_projects_allowlist(job_token_scope, resp_get_allowlist):
     allowlist = job_token_scope.allowlist
-    assert isinstance(allowlist, AllowlistedProjectManager)
+    assert isinstance(allowlist, AllowlistProjectManager)
 
     allowlist_content = allowlist.list()
     assert isinstance(allowlist_content, list)
 
 
 def test_add_project_to_allowlist(job_token_scope, resp_add_to_allowlist):
     allowlist = job_token_scope.allowlist
-    assert isinstance(allowlist, AllowlistedProjectManager)
+    assert isinstance(allowlist, AllowlistProjectManager)
 
     resp = allowlist.create({"target_project_id": 2})
     assert resp.get_id() == 2
 
 
 def test_get_groups_allowlist(job_token_scope, resp_get_groups_allowlist):
     allowlist = job_token_scope.groups_allowlist
-    assert isinstance(allowlist, AllowlistedGroupManager)
+    assert isinstance(allowlist, AllowlistGroupManager)
 
     allowlist_content = allowlist.list()
     assert isinstance(allowlist_content, list)
 
 
 def test_add_group_to_allowlist(job_token_scope, resp_add_to_groups_allowlist):
     allowlist = job_token_scope.groups_allowlist
-    assert isinstance(allowlist, AllowlistedGroupManager)
+    assert isinstance(allowlist, AllowlistGroupManager)
 
     resp = allowlist.create({"target_group_id": 4})
     assert resp.get_id() == 4
