test: add unit tests for job_token_scope

TimKnight-DWP · TimKnight-DWP · commit 2bbe2ba4f174 · 2024-05-07T10:42:36.000+01:00
Signed-off-by: Tim Knight &lt;tim.knight1@engineering.digital.dwp.gov.uk&gt;
diff --git a/gitlab/v4/objects/job_token_scope.py b/gitlab/v4/objects/job_token_scope.py
@@ -62,7 +62,7 @@ class AllowlistedGroup(ObjectDeleteMixin, RESTObject):
 
     def get_id(self) -> int:
         """Returns the id of the resource. This override deals with
-        the fact that either an `id` or a `target_project_id` attribute
+        the fact that either an `id` or a `target_group_id` attribute
         is returned by the server depending on the endpoint called."""
         try:
             return cast(int, getattr(self, self._id_attr))
diff --git a/tests/unit/objects/test_job_token_scope.py b/tests/unit/objects/test_job_token_scope.py
@@ -47,6 +47,11 @@
     }
 ]
 
+project_allowlist_created_content = {
+    "target_project_id": 2,
+    "project_id": 1,
+}
+
 groups_allowlist_content = [
     {
         "id": 4,
@@ -55,6 +60,11 @@
     }
 ]
 
+group_allowlist_created_content = {
+    "target_group_id": 4,
+    "project_id": 1,
+}
+
 
 @pytest.fixture
 def resp_get_job_token_scope():
@@ -82,6 +92,19 @@ def resp_get_allowlist():
         yield rsps
 
 
+@pytest.fixture
+def resp_add_to_allowlist():
+    with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/projects/1/job_token_scope/allowlist",
+            json=project_allowlist_created_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_get_groups_allowlist():
     with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
@@ -95,6 +118,19 @@ def resp_get_groups_allowlist():
         yield rsps
 
 
+@pytest.fixture
+def resp_add_to_groups_allowlist():
+    with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/projects/1/job_token_scope/groups_allowlist",
+            json=group_allowlist_created_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_patch_job_token_scope():
     with responses.RequestsMock(assert_all_requests_are_fired=False) as rsps:
@@ -140,9 +176,25 @@ def test_get_projects_allowlist(job_token_scope, resp_get_allowlist):
     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)
+
+    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)
 
     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)
+
+    resp = allowlist.create({"target_group_id": 4})
+    assert resp.get_id() == 4
