Add archive and unarchive pipeline endpoints (#84)

* Add archive and unarchive endpoints * Use double quotes to match style * Add tests for archive and unarchive * Fix test path formatting * Fix test URL formatting
pyasi · Jan 13, 2023 · 173b09d · 173b09d
1 parent 68359f6
commit 173b09d
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 2 deletions.
diff --git a/pybuildkite/pipelines.py b/pybuildkite/pipelines.py
@@ -132,7 +132,7 @@ def delete_pipeline(self, organization, pipeline):
         """
         url = self.path.format(organization) + pipeline
         return self.client.delete(url)
-
+    
     def update_pipeline(
         self,
         organization,
@@ -184,7 +184,27 @@ def update_pipeline(
         }
         url = self.path.format(organization) + pipeline
         return self.client.patch(url, body=body)
-
+
+    def archive_pipeline(self, organization, pipeline):
+        """
+        Archive a pipeline
+        :param organization: Organization slug
+        :param pipeline: Pipeline slug
+        :return:
+        """
+        url = self.path.format(organization) + pipeline + "/archive"
+        return self.client.post(url)
+
+    def unarchive_pipeline(self, organization, pipeline):
+        """
+        Unarchive a pipeline
+        :param organization: Organization slug
+        :param pipeline: Pipeline slug
+        :return:
+        """
+        url = self.path.format(organization) + pipeline + "/unarchive"
+        return self.client.post(url)
+
 
 class PipelineException(Exception):
     pass
diff --git a/tests/test_pipelines.py b/tests/test_pipelines.py
@@ -317,3 +317,21 @@ def test_update_pipeline_configuration_and_steps(fake_client):
             configuration="",
             steps={},
         )
+
+def test_archive_pipeline(fake_client):
+    pipeline = Pipelines(fake_client, "https://api.buildkite.com/v2/")
+    pipeline.archive_pipeline(
+        "test_org", "test_pipeline"
+    )
+    fake_client.post.assert_called_with(
+        pipeline.path.format("test_org") + "test_pipeline" + "/archive"  
+    )
+
+def test_unarchive_pipeline(fake_client):
+    pipeline = Pipelines(fake_client, "https://api.buildkite.com/v2/")
+    pipeline.unarchive_pipeline(
+        "test_org", "test_pipeline"
+    )
+    fake_client.post.assert_called_with(
+        pipeline.path.format("test_org") + "test_pipeline" + "/unarchive"
+    )