Add support for add subcommand to scaffold devfile resources

src/ansible_creator/arg_parser.py

@@ -36,7 +36,7 @@
 
 COMING_SOON = (
     "add resource devcontainer",
-    "add resource devfile",
+    # "add resource devfile",
     "add resource role",
     "add plugin action",
     "add plugin filter",
@@ -290,6 +290,22 @@ def _add_resource_devfile(self: Parser, subparser: SubParser[ArgumentParser]) ->
             help="The destination directory for the devfile file. The default is the "
             "current working directory.",
         )
+        parser.add_argument(
+            "-o",
+            "--overwrite",
+            default=False,
+            dest="overwrite",
+            action="store_true",
+            help="Overwrite existing files or directories.",
+        )
+        parser.add_argument(
+            "-no",
+            "--no-overwrite",
+            default=False,
+            dest="no_overwrite",
+            action="store_true",
+            help="Flag that restricts overwriting operation.",
+        )
         self._add_args_common(parser)
 
     def _add_resource_role(self: Parser, subparser: SubParser[ArgumentParser]) -> None:

src/ansible_creator/config.py

@@ -30,12 +30,14 @@ class Config:
         project: The type of project to scaffold.
         collection_name: The name of the collection.
         namespace: The namespace for the collection.
+        resource_type: The type of resource to be scaffolded.
+        type: The type of the project for which the resource is being scaffolded.
+        path: The file path where the resource should be added.
     """
 
     creator_version: str
     output: Output
     subcommand: str
-
     collection: str = ""
     force: bool = False
     overwrite: bool = False
@@ -44,6 +46,9 @@ class Config:
     project: str = ""
     collection_name: str | None = None
     namespace: str = ""
+    resource_type: str = ""
+    type: str = ""
+    path: str = ""
 
     def __post_init__(self: Config) -> None:
         """Post process config values."""

src/ansible_creator/subcommands/add.py

@@ -0,0 +1,118 @@
+"""Definitions for ansible-creator add action."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from ansible_creator.exceptions import CreatorError
+from ansible_creator.templar import Templar
+from ansible_creator.types import TemplateData
+from ansible_creator.utils import Copier, Walker, ask_yes_no
+
+
+if TYPE_CHECKING:
+    from ansible_creator.config import Config
+    from ansible_creator.output import Output
+
+
+class Add:
+    """Class to handle the add subcommand.
+
+    Attributes:
+        common_resources: List of common resources to copy.
+    """
+
+    common_resources = ("common.devfile",)
+
+    def __init__(
+        self: Add,
+        config: Config,
+    ) -> None:
+        """Initialize the add action.
+
+        Args:
+            config: App configuration object.
+        """
+        self._resource_type: str = config.resource_type
+        self._add_path: Path = Path(config.path)
+        self._force = config.force
+        self._overwrite = config.overwrite
+        self._no_overwrite = config.no_overwrite
+        self._creator_version = config.creator_version
+        self._project = config.project
+        self.output: Output = config.output
+        self.templar = Templar()
+
+    def run(self) -> None:
+        """Start scaffolding the resource file."""
+        self._check_add_path()
+        self.output.debug(msg=f"final collection path set to {self._add_path}")
+
+        self._scaffold()
+
+    def _check_add_path(self) -> None:
+        """Validate the provided add path.
+
+        Raises:
+            CreatorError: If the add path does not exist.
+        """
+        if not self._add_path.exists():
+            msg = f"The path {self._add_path} does not exist. Please provide an existing directory."
+            raise CreatorError(msg)
+
+    def _scaffold(self) -> None:
+        """Scaffold the specified resource file.
+
+        Raises:
+            CreatorError: If there are conflicts and overwriting is not allowed.
+        """
+        self.output.debug(f"Started copying {self._project} resource to destination")
+
+        # Set up template data
+        template_data = TemplateData(
+            resource_type=self._resource_type,
+            creator_version=self._creator_version,
+        )
+
+        # Initialize Walker and Copier for file operations
+
+        walker = Walker(
+            resources=self.common_resources,
+            resource_id="common.devfile",
+            dest=self._add_path,
+            output=self.output,
+            template_data=template_data,
+            templar=self.templar,
+        )
+        paths = walker.collect_paths()
+        copier = Copier(output=self.output)
+
+        if self._no_overwrite:
+            msg = "The flag `--no-overwrite` restricts overwriting."
+            if paths.has_conflicts():
+                msg += (
+                    "\nThe destination directory contains files that can be overwritten."
+                    "\nPlease re-run ansible-creator with --overwrite to continue."
+                )
+            raise CreatorError(msg)
+
+        if not paths.has_conflicts() or self._force or self._overwrite:
+            copier.copy_containers(paths)
+            self.output.note(f"Resource added to {self._add_path}")
+            return
+
+        if not self._overwrite:
+            question = (
+                "Files in the destination directory will be overwritten. Do you want to proceed?"
+            )
+            if ask_yes_no(question):
+                copier.copy_containers(paths)
+            else:
+                msg = (
+                    "The destination directory contains files that will be overwritten."
+                    " Please re-run ansible-creator with --overwrite to continue."
+                )
+                raise CreatorError(msg)
+
+        self.output.note(f"Resource added to {self._add_path}")

src/ansible_creator/types.py

@@ -17,6 +17,7 @@ class TemplateData:
     """Dataclass representing the template data.
 
     Attributes:
+        resource_type: The type of resource to be scaffolded.
         additions: A dictionary containing additional data to add to the gitignore.
         collection_name: The name of the collection.
         creator_version: The version of the creator.
@@ -27,6 +28,7 @@ class TemplateData:
         recommended_extensions: A list of recommended VsCode extensions.
     """
 
+    resource_type: str = ""
     additions: dict[str, dict[str, dict[str, str | bool]]] = field(default_factory=dict)
     collection_name: str = ""
     creator_version: str = ""

tests/fixtures/common/devfile/devfile.yaml

@@ -0,0 +1,15 @@
+schemaVersion: 2.2.2
+metadata:
+  name:
+components:
+  - name: tooling-container
+    container:
+      image: ghcr.io/ansible/ansible-workspace-env-reference:latest
+      memoryRequest: 256M
+      memoryLimit: 6Gi
+      cpuRequest: 250m
+      cpuLimit: 2000m
+      args: ["tail", "-f", "/dev/null"]
+      env:
+        - name: KUBEDOCK_ENABLED
+          value: "true"

tests/units/test_add.py

@@ -0,0 +1,138 @@
+# cspell: ignore dcmp, subdcmp
+"""Unit tests for ansible-creator add."""
+
+from __future__ import annotations
+
+import re
+
+from filecmp import dircmp
+from typing import TYPE_CHECKING, TypedDict
+
+import pytest
+
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from ansible_creator.output import Output
+
+from ansible_creator.config import Config
+from ansible_creator.subcommands.add import Add
+from tests.defaults import FIXTURES_DIR
+
+
+class ConfigDict(TypedDict):
+    """Type hint for Config dictionary.
+
+    Attributes:
+        creator_version: The version of the creator.
+        output: The output object to use for logging.
+        subcommand: The subcommand to execute.
+        resource_type: The type of resource to be scaffolded.
+        type: The type of the project for which the resource is being scaffolded.
+        path: The file path where the resource should be added.
+        force: Force overwrite of existing directory.
+        overwrite: To overwrite files in an existing directory.
+        no_overwrite: To not overwrite files in an existing directory.
+    """
+
+    creator_version: str
+    output: Output
+    subcommand: str
+    resource_type: str
+    type: str
+    path: str
+    force: bool
+    overwrite: bool
+    no_overwrite: bool
+
+
+@pytest.fixture(name="cli_args")
+def fixture_cli_args(tmp_path: Path, output: Output) -> ConfigDict:
+    """Create a dict to use for a Add class object as fixture.
+
+    Args:
+        tmp_path: Temporary directory path.
+        output: Output class object.
+
+    Returns:
+        dict: Dictionary, partial Add class object.
+    """
+    return {
+        "creator_version": "0.0.1",
+        "output": output,
+        "subcommand": "add",
+        "type": "resource",
+        "resource_type": "devfile",
+        "path": str(tmp_path),
+        "force": False,
+        "overwrite": False,
+        "no_overwrite": False,
+    }
+
+
+def has_differences(dcmp: dircmp[str], errors: list[str]) -> list[str]:
+    """Recursively check for differences in dircmp object.
+
+    Args:
+        dcmp: dircmp object.
+        errors: List of errors.
+
+    Returns:
+        list: List of errors.
+    """
+    errors.extend([f"Only in {dcmp.left}: {f}" for f in dcmp.left_only])
+    errors.extend([f"Only in {dcmp.right}: {f}" for f in dcmp.right_only])
+    errors.extend(
+        [f"Differing files: {dcmp.left}/{f} {dcmp.right}/{f}" for f in dcmp.diff_files],
+    )
+    for subdcmp in dcmp.subdirs.values():
+        errors = has_differences(subdcmp, errors)
+    return errors
+
+
+def test_run_success_add_devfile(
+    capsys: pytest.CaptureFixture[str],
+    tmp_path: Path,
+    cli_args: ConfigDict,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    """Test Add.run().
+
+    Successfully add devfile to path
+
+    Args:
+        capsys: Pytest fixture to capture stdout and stderr.
+        tmp_path: Temporary directory path.
+        cli_args: Dictionary, partial Add class object.
+        monkeypatch: Pytest monkeypatch fixture.
+    """
+    add = Add(
+        Config(**cli_args),
+    )
+
+    add.run()
+    result = capsys.readouterr().out
+    # check stdout
+    print(result)
+    assert re.search("Note: Resource added to", result) is not None
+
+    # recursively assert files created
+    cmp = dircmp(str(tmp_path), str(FIXTURES_DIR / "common" / "devfile"))
+    diff = has_differences(dcmp=cmp, errors=[])
+    assert diff == [], diff
+
+    conflict_file = tmp_path / "devfile.yaml"
+    conflict_file.write_text("schemaVersion: 2.2.2")
+
+    monkeypatch.setattr("builtins.input", lambda _: "y")
+    add.run()
+    result = capsys.readouterr().out
+    assert (
+        re.search(
+            "already exists",
+            result,
+        )
+        is not None
+    ), result
+    assert re.search("Note: Resource added to", result) is not None