AAP-36964 - API endpoint to scaffold devfile using ansible-creator add subcommand (#553)

* adding initital changes

* chore: auto fixes from pre-commit.com hooks

* fixed path var

* fixes

* docstring changes

* removed the collection param

* chore: auto fixes from pre-commit.com hooks

* comment fix

* added pytest

* chore: auto fixes from pre-commit.com hooks

* added test case

* chore: auto fixes from pre-commit.com hooks

* fixes 2

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: kaushiki069

src/ansible_dev_tools/resources/server/creator_v2.py

@@ -10,6 +10,7 @@
 from ansible_creator._version import version as creator_version
 from ansible_creator.config import Config
 from ansible_creator.output import Output
+from ansible_creator.subcommands.add import Add
 from ansible_creator.subcommands.init import Init
 from ansible_creator.utils import TermFeatures
 from django.core.files.storage import FileSystemStorage
@@ -104,6 +105,30 @@ def collection(
             response=response,
         )
 
+    def devfile(
+        self,
+        request: HttpRequest,
+    ) -> FileResponse | HttpResponse:
+        """Add a devfile.
+
+        Args:
+            request: HttpRequest object.
+
+        Returns:
+            File or error response.
+        """
+        result = validate_request(request)
+        if isinstance(result, HttpResponse):
+            return result
+        with tempfile.TemporaryDirectory() as tmp_dir:
+            tar_file = CreatorBackend(Path(tmp_dir)).devfile()
+            response = self._response_from_tar(tar_file)
+
+        return validate_response(
+            request=request,
+            response=response,
+        )
+
 
 class CreatorOutput(Output):
     """The creator output."""
@@ -190,3 +215,26 @@ def playbook(
         tar_file = self.tmp_dir / f"{namespace}-{collection_name}.tar"
         create_tar_file(init_path, tar_file)
         return tar_file
+
+    def devfile(self) -> Path:
+        """Scaffold a devfile.
+
+        Returns:
+            The tar file path.
+        """
+        # Path where the devfile is going to be added
+        add_path = self.tmp_dir / "devfile"
+        add_path.mkdir(parents=True, exist_ok=True)
+
+        config = Config(
+            resource_type="devfile",
+            creator_version=creator_version,
+            path=str(add_path),
+            output=CreatorOutput(log_file=str(self.tmp_dir / "creator.log")),
+            subcommand="add",
+            overwrite=True,
+        )
+        Add(config).run()
+        tar_file = self.tmp_dir / "devfile.tar"
+        create_tar_file(add_path, tar_file)
+        return tar_file

src/ansible_dev_tools/resources/server/data/openapi.yaml

@@ -102,6 +102,22 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+  /v2/creator/devfile:
+    post:
+      summary: Create a new devfile project
+      responses:
+        "201":
+          description: Created
+          content:
+            application/tar:
+              schema:
+                AnyValue: {}
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
 
 components:
   schemas:

src/ansible_dev_tools/subcommands/server.py

@@ -27,6 +27,7 @@
     path(route="v1/creator/collection", view=CreatorFrontendV1().collection),
     path(route="v2/creator/playbook", view=CreatorFrontendV2().playbook),
     path(route="v2/creator/collection", view=CreatorFrontendV2().collection),
+    path(route="v2/creator/devfile", view=CreatorFrontendV2().devfile),
 )
 
 

tests/integration/test_server_creator_v2.py

@@ -27,6 +27,23 @@ def test_error_v2(server_url: str, resource: str) -> None:
     assert response.text == "Missing required request body"
 
 
+def test_error_devfile_v2(server_url: str) -> None:
+    """Test the error response when a request body is sent unexpectedly.
+
+    Args:
+        server_url: The server URL.
+
+    Raises:
+        AssertionError: If the test assertions fail (e.g., response status code or tar content).
+    """
+    # To simulate an error, we are sending the request with the get method as the api works with empty request body as well.
+    response = requests.get(f"{server_url}/v2/creator/devfile", timeout=10)
+    assert response.status_code == requests.codes.get("bad_request"), (
+        f"Expected 400 but got {response.status_code}"
+    )
+    assert response.text == "Operation get not found for " + f"{server_url}/v2/creator/devfile"
+
+
 def test_playbook_v2(server_url: str, tmp_path: Path) -> None:
     """Test the playbook creation.
 
@@ -79,3 +96,28 @@ def test_collection_v2(server_url: str, tmp_path: Path) -> None:
         tar_file.write(response.content)
     with tarfile.open(dest_file) as file:
         assert "./roles/run/tasks/main.yml" in file.getnames()
+
+
+def test_devfile_v2(server_url: str, tmp_path: Path) -> None:
+    """Test the devfile creation.
+
+    Args:
+        server_url: The server URL.
+        tmp_path: Pytest tmp_path fixture.
+
+    Raises:
+        AssertionError: If the test assertions fail (e.g., response status code or tar content).
+    """
+    response = requests.post(
+        f"{server_url}/v2/creator/devfile",
+        json={},
+        timeout=10,
+    )
+    assert response.status_code == requests.codes.get("created")
+    assert response.headers["Content-Disposition"] == 'attachment; filename="devfile.tar"'
+    assert response.headers["Content-Type"] == "application/tar"
+    dest_file = tmp_path / "devfile.tar"
+    with dest_file.open(mode="wb") as tar_file:
+        tar_file.write(response.content)
+    with tarfile.open(dest_file) as file:
+        assert "./devfile.yaml" in file.getnames()