feat: Add delete API for Artifact client (#142)

Author: ShriramS-Emerson

docs/api_reference.rst

@@ -19,6 +19,7 @@ API Reference
    api_reference/assetmanagement
    api_reference/systems
    api_reference/test_plan
+   api_reference/artifact
 
 Indices and tables
 ------------------

docs/api_reference/artifact.rst

@@ -0,0 +1,16 @@
+.. _api_tag_page:
+
+nisystemlink.clients.artifact
+======================
+
+.. autoclass:: nisystemlink.clients.artifact.ArtifactClient
+   :exclude-members: __init__
+
+   .. automethod:: __init__
+   .. automethod:: upload_artifact
+   .. automethod:: download_artifact
+   .. automethod:: delete_artifact
+
+.. automodule:: nisystemlink.clients.artifact.models
+   :members:
+   :imported-members:

…rtifact/upload_and_download_artifacts.py examples/artifact/artifacts.pyexamples/artifact/upload_and_download_artifacts.py renamed to examples/artifact/artifacts.py examples/artifact/upload_and_download_artifacts.py renamed to examples/artifact/artifacts.py

@@ -1,28 +1,31 @@
-import io
-
-from nisystemlink.clients.artifact import ArtifactClient
-from nisystemlink.clients.core import HttpConfiguration
-
-
-# Setup the server configuration to point to your instance of SystemLink Enterprise
-server_configuration = HttpConfiguration(
-    server_uri="https://yourserver.yourcompany.com",
-    api_key="YourAPIKeyGeneratedFromSystemLink",
-)
-client = ArtifactClient(configuration=server_configuration)
-
-# Define the workspace and artifact content
-workspace = "your workspace ID"
-artifact_stream = io.BytesIO(b"test content")
-
-# Upload the artifact
-upload_response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
-if upload_response and upload_response.id:
-    print(f"Uploaded artifact ID: {upload_response.id}")
-
-# Download the artifact using the ID from the upload response
-artifact_id = upload_response.id
-download_response = client.download_artifact(artifact_id)
-if download_response:
-    downloaded_content = download_response.read()
-    print(f"Downloaded artifact content: {downloaded_content.decode('utf-8')}")
+import io
+
+from nisystemlink.clients.artifact import ArtifactClient
+from nisystemlink.clients.core import HttpConfiguration
+
+
+# Setup the server configuration to point to your instance of SystemLink Enterprise
+server_configuration = HttpConfiguration(
+    server_uri="https://yourserver.yourcompany.com",
+    api_key="YourAPIKeyGeneratedFromSystemLink",
+)
+client = ArtifactClient(configuration=server_configuration)
+
+# Define the workspace and artifact content
+workspace = "your workspace ID"
+artifact_stream = io.BytesIO(b"test content")
+
+# Upload the artifact
+upload_response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
+if upload_response and upload_response.id:
+    print(f"Uploaded artifact ID: {upload_response.id}")
+
+# Download the artifact using the ID from the upload response
+artifact_id = upload_response.id
+download_response = client.download_artifact(artifact_id)
+if download_response:
+    downloaded_content = download_response.read()
+    print(f"Downloaded artifact content: {downloaded_content.decode('utf-8')}")
+
+# Delete the artifact
+client.delete_artifact(artifact_id)

nisystemlink/clients/artifact/_artifact_client.py

@@ -4,7 +4,12 @@
 
 from nisystemlink.clients import core
 from nisystemlink.clients.core._uplink._base_client import BaseClient
-from nisystemlink.clients.core._uplink._methods import get, post, response_handler
+from nisystemlink.clients.core._uplink._methods import (
+    delete,
+    get,
+    post,
+    response_handler,
+)
 from nisystemlink.clients.core.helpers._iterator_file_like import IteratorFileLike
 from requests.models import Response
 from uplink import Part, Path
@@ -81,3 +86,13 @@ def download_artifact(self, id: Path) -> IteratorFileLike:
 
         """
         ...
+
+    @delete("artifacts/{id}", args=[Path("id")])
+    def delete_artifact(self, id: str) -> None:
+        """Deletes an artifact.
+
+        Args:
+            id: The ID of the artifact to delete.
+
+        """
+        ...

tests/integration/artifact/test_artifact.py

@@ -1,8 +1,11 @@
 import io
-import os
+from typing import List
 
 import pytest
 from nisystemlink.clients.artifact import ArtifactClient
+from nisystemlink.clients.artifact.models._upload_artifact_response import (
+    UploadArtifactResponse,
+)
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
 
 
@@ -12,35 +15,62 @@ def client(enterprise_config: HttpConfiguration) -> ArtifactClient:
     return ArtifactClient(enterprise_config)
 
 
+@pytest.fixture
+def create_artifact(client: ArtifactClient):
+    """Fixture to return a factory that creates artifact."""
+    created_artifact_ids: List[str] = []
+
+    def _create_artifact(
+        content: bytes = b"test content",
+        cleanup: bool = True,
+        workspace: str = "2300760d-38c4-48a1-9acb-800260812337",
+    ):
+        # Used the main-test default workspace since the client for creating a workspace has not been added yet
+        artifact_stream = io.BytesIO(content)
+        response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
+        if cleanup:
+            created_artifact_ids.append(response.id)
+
+        return response
+
+    yield _create_artifact
+
+    for artifact_id in created_artifact_ids:
+        client.delete_artifact(artifact_id)
+
+
 @pytest.mark.integration
 @pytest.mark.enterprise
 class TestArtifact:
 
-    def test__upload_artifact__artifact_uploaded(self, client: ArtifactClient):
-        workspace = os.getenv("SYSTEMLINK_WORKSPACE_ID")
+    def test__upload_artifact__artifact_uploaded(
+        self, client: ArtifactClient, create_artifact
+    ):
+        upload_response: UploadArtifactResponse = create_artifact()
 
-        if workspace is not None:
-            artifact_stream = io.BytesIO(b"test content")
+        assert upload_response is not None
+        assert upload_response.id is not None
 
-            response = client.upload_artifact(
-                workspace=workspace, artifact=artifact_stream
-            )
+    def test__download_artifact__artifact_downloaded(
+        self, client: ArtifactClient, create_artifact
+    ):
+        artifact_content = b"test content"
 
-            assert response is not None
-            assert response.id is not None
+        upload_response: UploadArtifactResponse = create_artifact(
+            content=artifact_content
+        )
+        artifact_id = upload_response.id
+        download_response = client.download_artifact(artifact_id)
 
-    def test__download_artifact__artifact_downloaded(self, client: ArtifactClient):
-        workspace = os.getenv("SYSTEMLINK_WORKSPACE_ID")
+        assert download_response is not None
+        assert download_response.read() == artifact_content
 
-        if workspace is not None:
-            artifact_content = b"test content"
-            artifact_stream = io.BytesIO(artifact_content)
+    def test__delete_artifact__artifact_deleted(
+        self, client: ArtifactClient, create_artifact
+    ):
+        upload_response: UploadArtifactResponse = create_artifact(cleanup=False)
+        artifact_id = upload_response.id
 
-            upload_response = client.upload_artifact(
-                workspace=workspace, artifact=artifact_stream
-            )
-            artifact_id = upload_response.id
-            download_response = client.download_artifact(artifact_id)
+        delete_response = client.delete_artifact(artifact_id)
 
-            assert download_response is not None
-            assert download_response.read() == artifact_content
+        assert delete_response is None