Cleanup of init functionality (#290)

* Unsplit collection internally

* Use playbook internally instead of ansible-project

Author: Qalthos

src/ansible_creator/arg_parser.py

@@ -103,16 +103,6 @@ def parse_args(self: Parser) -> tuple[argparse.Namespace, list[Msg]]:
             self.pending_logs.append(Msg(prefix=Level.CRITICAL, message="Goodbye."))
             return self.args, self.pending_logs
 
-        # The internal still reference the old project name
-        if self.args.project == "playbook":
-            self.args.project = "ansible-project"
-            with contextlib.suppress(ValueError):
-                self.args.scm_org, self.args.scm_project = self.args.collection.split(
-                    ".",
-                    maxsplit=1,
-                )
-            self.args.collection = None
-
         return self.args, self.pending_logs
 
     def _add(self: Parser, subparser: SubParser[ArgumentParser]) -> None:

src/ansible_creator/config.py

@@ -26,8 +26,6 @@ class Config:
         force: Whether to overwrite existing files.
         init_path: The path to initialize the project.
         project: The type of project to scaffold.
-        scm_org: The SCM organization for the project.
-        scm_project: The SCM project for the project.
         collection_name: The name of the collection.
         namespace: The namespace for the collection.
     """
@@ -40,8 +38,6 @@ class Config:
     force: bool = False
     init_path: str | Path = "./"
     project: str = ""
-    scm_org: str | None = None
-    scm_project: str | None = None
     collection_name: str | None = None
     namespace: str = ""
 

src/ansible_creator/resources/common/gitignore/__meta__.yml

@@ -14,6 +14,6 @@ playbook_project:
       !collections/ansible_collections
       !collections/requirements.yml
       collections/ansible_collections/*
-      !collections/ansible_collections/{{ scm_org}}
-      collections/ansible_collections/{{ scm_org }}/*
-      !collections/ansible_collections/{{ scm_org }}/{{ scm_project }}
+      !collections/ansible_collections/{{ namespace }}
+      collections/ansible_collections/{{ namespace }}/*
+      !collections/ansible_collections/{{ namespace }}/{{ collection_name }}

src/ansible_creator/resources/playbook_project/README.md.j2

@@ -1,4 +1,4 @@
-# {{ scm_org|capitalize }} {{ scm_project|capitalize }} Ansible Project
+# {{ namespace|capitalize }} {{ collection_name|capitalize }} Ansible Project
 
 ## Included content/ Directory Structure
 

src/ansible_creator/resources/playbook_project/collections/ansible_collections/project_org/project_repo/README.md.j2

@@ -1,6 +1,6 @@
-# {{ scm_org|capitalize }} {{ scm_project|capitalize }} Collection
+# {{ namespace|capitalize }} {{ collection_name|capitalize }} Collection
 
-This repository contains the `{{ scm_org }}.{{ scm_project }}` Ansible Collection.
+This repository contains the `{{ namespace }}.{{ collection_name }}` Ansible Collection.
 
 ## Tested with Ansible
 
@@ -12,31 +12,31 @@ Some modules and plugins require external libraries. Please check the requiremen
 
 ## Included content
 
-Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/{{ scm_org }}/{{ scm_project }}).
+Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/{{ namespace }}/{{ collection_name }}).
 
 ## Using this collection
 
 ```
-    ansible-galaxy collection install {{ scm_org }}.{{ scm_project }}
+    ansible-galaxy collection install {{ namespace }}.{{ collection_name }}
 ```
 
 You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
 
 ```yaml
 collections:
-  - name: {{ scm_org }}.{{ scm_project }}
+  - name: {{ namespace }}.{{ collection_name }}
 ```
 
 To upgrade the collection to the latest available version, run the following command:
 
 ```bash
-ansible-galaxy collection install {{ scm_org }}.{{ scm_project }} --upgrade
+ansible-galaxy collection install {{ namespace }}.{{ collection_name }} --upgrade
 ```
 
-You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/{{ scm_org }}/{{ scm_project }}):
+You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where `X.Y.Z` can be any [available version](https://galaxy.ansible.com/{{ namespace }}/{{ collection_name }}):
 
 ```bash
-ansible-galaxy collection install {{ scm_org }}.{{ scm_project }}:==X.Y.Z
+ansible-galaxy collection install {{ namespace }}.{{ collection_name }}:==X.Y.Z
 ```
 
 See [Ansible Using Collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.

src/ansible_creator/resources/playbook_project/collections/ansible_collections/project_org/project_repo/roles/run/README.md.j2

@@ -1,4 +1,4 @@
-{{ scm_org|capitalize }}.{{ scm_project|capitalize }} Run Role
+{{ namespace|capitalize }}.{{ collection_name|capitalize }} Run Role
 ========================
 
 A brief description of the role is here.
@@ -27,20 +27,20 @@ Including an example of how to use your role (for instance, with variables passe
 - name: Execute tasks on servers
   hosts: servers
   roles:
-    - role: {{ scm_org }}.{{ scm_project }}.run
+    - role: {{ namespace }}.{{ collection_name }}.run
       run_x: 42
 ```
 
 Another way to consume this role would be:
 
 ```yaml
-- name: Initialize the run role from {{ scm_org }}.{{ scm_project }}
+- name: Initialize the run role from {{ namespace }}.{{ collection_name }}
   hosts: servers
   gather_facts: false
   tasks:
     - name: Trigger invocation of run role
       ansible.builtin.include_role:
-        name: {{ scm_org }}.{{ scm_project }}.run
+        name: {{ namespace }}.{{ collection_name }}.run
       vars:
         run_x: 42
 ```

src/ansible_creator/resources/playbook_project/site.yml.j2

@@ -2,4 +2,4 @@
 - name: Example playbook
   hosts: localhost
   roles:
-    - role: {{ scm_org }}.{{ scm_project }}.run
+    - role: {{ namespace }}.{{ collection_name }}.run

src/ansible_creator/subcommands/init.py

@@ -49,8 +49,6 @@ def __init__(
         self._force = config.force
         self._creator_version = config.creator_version
         self._project = config.project
-        self._scm_org = config.scm_org or ""
-        self._scm_project = config.scm_project or ""
         self._templar = Templar()
         self.output: Output = config.output
 
@@ -65,12 +63,12 @@ def run(self: Init) -> None:
 
         if self._project == "collection":
             self._scaffold_collection()
-        elif self._project == "ansible-project":
+        elif self._project == "playbook":
             self._scaffold_playbook()
 
     def _construct_init_path(self: Init) -> None:
         """Construct the init path based on project type."""
-        if self._project == "ansible-project":
+        if self._project == "playbook":
             return
 
         if (
@@ -117,11 +115,7 @@ def unique_name_in_devfile(self) -> str:
         Returns:
             Unique name entry.
         """
-        final_name: str
-        if self._project == "collection":
-            final_name = f"{self._namespace}.{self._collection_name}"
-        if self._project == "ansible-project":
-            final_name = f"{self._scm_org}.{self._scm_project}"
+        final_name = f"{self._namespace}.{self._collection_name}"
         final_uuid = str(uuid.uuid4())[:8]
         return f"{final_name}-{final_uuid}"
 
@@ -151,12 +145,12 @@ def _scaffold_collection(self) -> None:
 
     def _scaffold_playbook(self: Init) -> None:
         """Scaffold a playbook project."""
-        self.output.debug(msg="started copying ansible-project skeleton to destination")
+        self.output.debug(msg="started copying playbook skeleton to destination")
 
         template_data = TemplateData(
             creator_version=self._creator_version,
-            scm_org=self._scm_org,
-            scm_project=self._scm_project,
+            namespace=self._namespace,
+            collection_name=self._collection_name,
             dev_file_name=self.unique_name_in_devfile(),
         )
 

src/ansible_creator/types.py

@@ -25,8 +25,6 @@ class TemplateData:
         dev_file_name: The unique name entry in devfile.
         namespace: The namespace of the collection.
         recommended_extensions: A list of recommended VsCode extensions.
-        scm_org: The organization of the source control management.
-        scm_project: The project of the source control management.
     """
 
     additions: dict[str, dict[str, dict[str, str | bool]]] = field(default_factory=dict)
@@ -39,5 +37,3 @@ class TemplateData:
     recommended_extensions: Sequence[str] = field(
         default_factory=lambda: GLOBAL_TEMPLATE_VARS["RECOMMENDED_EXTENSIONS"],
     )
-    scm_org: str = ""
-    scm_project: str = ""

src/ansible_creator/utils.py

@@ -24,8 +24,8 @@
 
 
 PATH_REPLACERS = {
-    "project_org": "scm_org",
-    "project_repo": "scm_project",
+    "project_org": "namespace",
+    "project_repo": "collection_name",
 }
 
 

tests/units/test_basic.py

@@ -73,12 +73,10 @@ def test_configuration_class(output: Output) -> None:
                 "log_append": "true",
                 "json": False,
                 "verbose": 0,
-                "collection": None,
+                "collection": "weather.demo",
                 "init_path": f"{Path.home()}/my-ansible-project",
                 "force": False,
-                "project": "ansible-project",
-                "scm_org": "weather",
-                "scm_project": "demo",
+                "project": "playbook",
             },
         ],
         [
@@ -133,12 +131,10 @@ def test_configuration_class(output: Output) -> None:
                 "log_append": "false",
                 "json": True,
                 "verbose": 3,
-                "collection": None,
+                "collection": "weather.demo",
                 "init_path": f"{Path.home()}/my-ansible-project",
                 "force": True,
-                "project": "ansible-project",
-                "scm_org": "weather",
-                "scm_project": "demo",
+                "project": "playbook",
             },
         ],
         [
@@ -175,10 +171,8 @@ def test_configuration_class(output: Output) -> None:
             ],
             {
                 "subcommand": "init",
-                "project": "ansible-project",
-                "scm_org": "foo",
-                "scm_project": "bar",
-                "collection": None,
+                "project": "playbook",
+                "collection": "foo.bar",
                 "init_path": "/test/test",
                 "force": False,
                 "json": False,

tests/units/test_init.py

@@ -31,8 +31,6 @@ class ConfigDict(TypedDict):
         init_path: Path to initialize the project.
         project: The type of project to scaffold.
         force: Force overwrite of existing directory.
-        scm_org: The SCM organization for the project.
-        scm_project: The SCM project for the project.
     """
 
     creator_version: str
@@ -42,8 +40,6 @@ class ConfigDict(TypedDict):
     init_path: str
     project: str
     force: bool
-    scm_org: str | None
-    scm_project: str | None
 
 
 @pytest.fixture(name="cli_args")
@@ -65,8 +61,6 @@ def fixture_cli_args(tmp_path: Path, output: Output) -> ConfigDict:
         "init_path": str(tmp_path / "testorg" / "testcol"),
         "project": "",
         "force": False,
-        "scm_org": "",
-        "scm_project": "",
     }
 
 
@@ -160,27 +154,25 @@ def test_run_success_ansible_project(
 ) -> None:
     """Test Init.run().
 
-    Successfully create new ansible-project
+    Successfully create new playbook project
 
     Args:
         capsys: Pytest fixture to capture stdout and stderr.
         tmp_path: Temporary directory path.
         cli_args: Dictionary, partial Init class object.
         monkeypatch: Pytest monkeypatch fixture.
     """
-    cli_args["collection"] = ""
-    cli_args["project"] = "ansible-project"
+    cli_args["collection"] = "weather.demo"
+    cli_args["project"] = "playbook"
     cli_args["init_path"] = str(tmp_path / "new_project")
-    cli_args["scm_org"] = "weather"
-    cli_args["scm_project"] = "demo"
     init = Init(
         Config(**cli_args),
     )
 
     # Mock the "unique_name_in_devfile" method
     def mock_unique_name_in_devfile(self: Init) -> str:
-        coll_namespace = self._scm_org
-        coll_name = self._scm_project
+        coll_namespace = self._namespace
+        coll_name = self._collection_name
         return f"{coll_namespace}.{coll_name}"
 
     # Apply the mock
@@ -204,7 +196,7 @@ def mock_unique_name_in_devfile(self: Init) -> str:
     diff = has_differences(dcmp=cmp, errors=[])
     assert diff == [], diff
 
-    # fail to override existing ansible-project directory with force=false (default)
+    # fail to override existing playbook directory with force=false (default)
     fail_msg = (
         f"The directory {tmp_path}/new_project is not empty."
         "\nYou can use --force to re-initialize this directory."
@@ -213,7 +205,7 @@ def mock_unique_name_in_devfile(self: Init) -> str:
     with pytest.raises(CreatorError, match=fail_msg):
         init.run()
 
-    # override existing ansible-project directory with force=true
+    # override existing playbook directory with force=true
     cli_args["force"] = True
     init = Init(
         Config(**cli_args),
@@ -345,15 +337,13 @@ def fixture_collection_project(tmp_path: Path, output: Output) -> Config:
         force=False,
         creator_version="1.0.0",
         project="collection",
-        scm_org="",
-        scm_project="",
         output=output,
     )
 
 
 @pytest.fixture(name="cli_args_playbook")
 def fixture_playbook_project(tmp_path: Path, output: Output) -> Config:
-    """Fixture for Config object with ansible-project.
+    """Fixture for Config object with playbook.
 
     Args:
         tmp_path: Temporary directory path.
@@ -364,14 +354,12 @@ def fixture_playbook_project(tmp_path: Path, output: Output) -> Config:
     """
     return Config(
         subcommand="init",
-        namespace="",
-        collection_name="",
+        namespace="foo",
+        collection_name="bar",
         init_path=str(tmp_path / "test_path"),
         force=False,
         creator_version="1.0.0",
-        project="ansible-project",
-        scm_org="foo",
-        scm_project="bar",
+        project="playbook",
         output=output,
     )