feat(api): add ProjectPackagePipeline

JacobHenner · nejch · commit 5b4addda5959 · 2023-10-12T20:20:31.000+02:00
Add ProjectPackagePipeline, which is scheduled to be included in GitLab
16.0
diff --git a/docs/gl_objects/packages.rst b/docs/gl_objects/packages.rst
@@ -95,6 +95,31 @@ Delete a package file in a project::
     file = package.package_files.list()[0]
     file.delete()
 
+Project Package Pipelines
+=========================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectPackagePipeline`
+  + :class:`gitlab.v4.objects.ProjectPackagePipelineManager`
+  + :attr:`gitlab.v4.objects.ProjectPackage.pipelines`
+
+..
+  TODO: Not yet published (see https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117539).
+  Add anchor/fragment once available.
+
+* GitLab API: https://docs.gitlab.com/ee/api/packages.html
+
+Examples
+--------
+
+List package pipelines for package in project::
+
+    package = project.packages.get(1)
+    package_pipelines = package.pipelines.list()
 
 Generic Packages
 ================
diff --git a/gitlab/v4/objects/packages.py b/gitlab/v4/objects/packages.py
@@ -33,6 +33,8 @@
     "ProjectPackageManager",
     "ProjectPackageFile",
     "ProjectPackageFileManager",
+    "ProjectPackagePipeline",
+    "ProjectPackagePipelineManager",
 ]
 
 
@@ -188,6 +190,7 @@ class GroupPackageManager(ListMixin, RESTManager):
 
 class ProjectPackage(ObjectDeleteMixin, RESTObject):
     package_files: "ProjectPackageFileManager"
+    pipelines: "ProjectPackagePipelineManager"
 
 
 class ProjectPackageManager(ListMixin, GetMixin, DeleteMixin, RESTManager):
@@ -215,3 +218,13 @@ class ProjectPackageFileManager(DeleteMixin, ListMixin, RESTManager):
     _path = "/projects/{project_id}/packages/{package_id}/package_files"
     _obj_cls = ProjectPackageFile
     _from_parent_attrs = {"project_id": "project_id", "package_id": "id"}
+
+
+class ProjectPackagePipeline(RESTObject):
+    pass
+
+
+class ProjectPackagePipelineManager(ListMixin, RESTManager):
+    _path = "/projects/{project_id}/packages/{package_id}/pipelines"
+    _obj_cls = ProjectPackagePipeline
+    _from_parent_attrs = {"project_id": "project_id", "package_id": "id"}
diff --git a/tests/unit/objects/test_packages.py b/tests/unit/objects/test_packages.py
@@ -12,6 +12,7 @@
     GroupPackage,
     ProjectPackage,
     ProjectPackageFile,
+    ProjectPackagePipeline,
 )
 
 package_content = {
@@ -104,6 +105,50 @@
     },
 ]
 
+package_pipeline_content = [
+    {
+        "id": 123,
+        "iid": 1,
+        "project_id": 1,
+        "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
+        "ref": "new-pipeline",
+        "status": "failed",
+        "source": "push",
+        "created_at": "2016-08-11T11:28:34.085Z",
+        "updated_at": "2016-08-11T11:32:35.169Z",
+        "web_url": "https://example.com/foo/bar/pipelines/47",
+        "user": {
+            "id": 1,
+            "username": "root",
+            "name": "Administrator",
+            "state": "active",
+            "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
+            "web_url": "http://gdk.test:3001/root",
+        },
+    },
+    {
+        "id": 234,
+        "iid": 2,
+        "project_id": 1,
+        "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
+        "ref": "new-pipeline",
+        "status": "failed",
+        "source": "push",
+        "created_at": "2016-08-11T11:28:34.085Z",
+        "updated_at": "2016-08-11T11:32:35.169Z",
+        "web_url": "https://example.com/foo/bar/pipelines/58",
+        "user": {
+            "id": 1,
+            "username": "root",
+            "name": "Administrator",
+            "state": "active",
+            "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon",
+            "web_url": "http://gdk.test:3001/root",
+        },
+    },
+]
+
+
 package_name = "hello-world"
 package_version = "v1.0.0"
 file_name = "hello.tar.gz"
@@ -195,6 +240,19 @@ def resp_list_package_files():
         yield rsps
 
 
+@pytest.fixture
+def resp_list_package_pipelines():
+    with responses.RequestsMock() as rsps:
+        rsps.add(
+            method=responses.GET,
+            url=re.compile(r"http://localhost/api/v4/projects/1/packages/1/pipelines"),
+            json=package_pipeline_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
 @pytest.fixture
 def resp_upload_generic_package(created_content):
     with responses.RequestsMock() as rsps:
@@ -269,6 +327,14 @@ def test_delete_project_package_file_from_package_file_object(
         package_file.delete()
 
 
+def test_list_project_package_pipelines(project, resp_list_package_pipelines):
+    package = project.packages.get(1, lazy=True)
+    pipelines = package.pipelines.list()
+    assert isinstance(pipelines, list)
+    assert isinstance(pipelines[0], ProjectPackagePipeline)
+    assert pipelines[0].id == 123
+
+
 def test_upload_generic_package(tmp_path, project, resp_upload_generic_package):
     path = tmp_path / file_name
     path.write_text(file_content, encoding="utf-8")
