Creator- Refactor plugin templates to rename the scaffolded file and plugin name in the same. (#383)

* Updated add.py

* updated names of jinja templates

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

* updated tests

* generic module scaffold now happens in modules folder

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

* updated tests

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

* reverted changes to launch.json

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

* updated tests

* removed hello_world"

* reverted changes

* changed plugin name

* updated test files

* Updated it for test plugin

* updated test_add.py

* updated doc strings

* print file list

* reverted

* made changes to utils add and init

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

* updated test files

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

* updated test_add.py

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

* updated add.py

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

* fixed add.py

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

* updated test_init to give a diff if dcmp fails

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

* updated utils.py

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

* fixes precommit issues

* fixed comments

* Updated sample_test.py.j2 and sample_test.py

* reverted

* updated to fix license issue

* reverted

* fixed license

* reverted

* updated the templates

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

* changed the plugin_name in types

* reverted

* added diff

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

* imported subprocess

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

* updated add and utils

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

* updated test_init

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

* fixed init test

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

* reverted

* removed hello world

* removed the diff

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

* added @Property

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

* removed path_replacers from Walker

* removed comments

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

* refactored each_obj

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

* added docstring

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

* updated params

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

* updated params

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

* removed params

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

* decluttered walker class

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

* Removed subcommand

* reverted each_obj change

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

* refactored each obj

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

* reverted change

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

* simplified if block

* Updated the comments

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

---------

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

Author: shvenkat-rh

src/ansible_creator/config.py

@@ -68,3 +68,6 @@ def __post_init__(self) -> None:
 
         if isinstance(self.init_path, str):
             object.__setattr__(self, "init_path", expand_path(self.init_path))
+
+        if self.plugin_type == "module":
+            object.__setattr__(self, "plugin_type", "modules")

src/ansible_creator/resources/collection_project/plugins/action/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/action/sample_action.py.j2

@@ -1,5 +1,5 @@
 {# action_plugin_template.j2 #}
-{%- set action_name = plugin_name | default("hello_world") -%}
+{%- set action_name = plugin_name | default("sample_action",true) -%}
 {%- set author = author | default("Your Name") -%}
 {%- set description = description | default("A custom action plugin for Ansible.") -%}
 {%- set license = license | default("GPL-3.0-or-later") -%}

src/ansible_creator/resources/collection_project/plugins/filter/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/filter/sample_filter.py.j2

@@ -1,5 +1,5 @@
 {# filter_plugin_template.j2 #}
-{%- set filter_name = plugin_name | default("hello_world") -%}
+{%- set filter_name = plugin_name | default("sample_filter",true) -%}
 {%- set author = author | default("Your Name") -%}
 {%- set description = description | default("A custom filter plugin for Ansible.") -%}
 {%- set license = license | default("GPL-3.0-or-later") -%}
@@ -41,7 +41,7 @@ EXAMPLES = """
 """
 
 
-def _hello_world(name: str) -> str:
+def _sample_filter(name: str) -> str:
     """Returns Hello message.
 
     Args:
@@ -62,4 +62,4 @@ class FilterModule:
         Returns:
             dict: The filter plugin functions.
         """
-        return {"{{ filter_name }}": _hello_world}
+        return {"{{ filter_name }}": _sample_filter}

src/ansible_creator/resources/collection_project/plugins/lookup/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/lookup/sample_lookup.py.j2

@@ -1,5 +1,5 @@
 {# lookup_plugin_template.j2 #}
-{%- set lookup_name = plugin_name | default("hello_world") -%}
+{%- set lookup_name = plugin_name | default("sample_lookup",true) -%}
 {%- set author = author | default("Your Name (@username)") -%}
 {%- set description = description | default("A custom lookup plugin for Ansible.") -%}
 {%- set license = license | default("GPL-3.0-or-later") -%}

src/ansible_creator/resources/collection_project/plugins/modules/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/modules/sample_action.py.j2

@@ -1,4 +1,4 @@
-{%- set module_name = plugin_name | default("hello_world") -%}
+{%- set module_name = plugin_name | default("sample_action",true) -%}
 {%- set author = author | default("Your Name (@username)") -%}
 # {{ module_name }}.py
 # GNU General Public License v3.0+

src/ansible_creator/resources/collection_project/plugins/sample_module/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/modules/sample_module.py.j2

@@ -1,5 +1,5 @@
 {# module_plugin_template.j2 #}
-{%- set module_name = plugin_name | default("hello_world") -%}
+{%- set module_name = plugin_name | default("sample_module",true) -%}
 {%- set author = author |  default("Your Name (@username)") -%}
 {%- set description = description | default("A custom module plugin for Ansible.") -%}
 {%- set license = license | default("GPL-3.0-or-later") -%}
@@ -41,7 +41,7 @@ EXAMPLES = """
 """
 
 
-def _hello_world(name: str) -> str:
+def _sample_module(name: str) -> str:
     """Returns Hello message.
 
     Args:
@@ -62,4 +62,4 @@ class SampleModule:
         Returns:
             dict: The module plugin functions.
         """
-        return {"{{ module_name }}": _hello_world}
+        return {"{{ module_name }}": _sample_module}

src/ansible_creator/resources/collection_project/plugins/sample_module/__init__.py.j2

@@ -1,5 +1,5 @@
 {# test_plugin_template.j2 #}
-{%- set test_name = plugin_name | default("hello_world") -%}
+{%- set test_name = plugin_name | default("sample_test",true) -%}
 {%- set author = author | default("Your Name") -%}
 {%- set description = description | default("A custom test plugin for Ansible.") -%}
 {%- set license = license | default("GPL-3.0-or-later") -%}

src/ansible_creator/resources/collection_project/plugins/test/hello_world.py.j2 renamed to src/ansible_creator/resources/collection_project/plugins/test/sample_test.py.j2

@@ -48,6 +48,17 @@ def __init__(
         self.output: Output = config.output
         self.templar = Templar()
 
+    @property
+    def _plugin_type_output(self) -> str:
+        """Format the plugin type for output.
+
+        Returns:
+            Formatted plugin type string for display in output messages.
+        """
+        if self._plugin_type == "modules":
+            return "Module"
+        return self._plugin_type.capitalize()
+
     def run(self) -> None:
         """Start scaffolding the resource file."""
         self._check_path_exists()
@@ -209,10 +220,8 @@ def _plugin_scaffold(self, plugin_path: Path) -> None:
             template_data = self._get_plugin_template_data()
             self._perform_lookup_plugin_scaffold(template_data, plugin_path)
 
-        elif self._plugin_type == "module":
+        elif self._plugin_type == "modules":
             template_data = self._get_plugin_template_data()
-            plugin_path = self._add_path / "plugins" / "sample_module"
-            plugin_path.mkdir(parents=True, exist_ok=True)
             self._perform_module_plugin_scaffold(template_data, plugin_path)
 
         elif self._plugin_type == "test":
@@ -258,7 +267,7 @@ def _perform_module_plugin_scaffold(
         template_data: TemplateData,
         plugin_path: Path,
     ) -> None:
-        resources = ("collection_project.plugins.sample_module",)
+        resources = (f"collection_project.plugins.{self._plugin_type}",)
         self._perform_plugin_scaffold(resources, template_data, plugin_path)
 
     def _perform_test_plugin_scaffold(
@@ -311,7 +320,7 @@ def _perform_plugin_scaffold(
 
         if not paths.has_conflicts() or self._force or self._overwrite:
             copier.copy_containers(paths)
-            self.output.note(f"{self._plugin_type.capitalize()} plugin added to {plugin_path}")
+            self.output.note(f"{self._plugin_type_output} plugin added to {plugin_path}")
             return
 
         if not self._overwrite:
@@ -327,7 +336,7 @@ def _perform_plugin_scaffold(
                 )
                 raise CreatorError(msg)
 
-        self.output.note(f"{self._plugin_type.capitalize()} plugin added to {plugin_path}")
+        self.output.note(f"{self._plugin_type_output} plugin added to {plugin_path}")
 
     def _get_devfile_template_data(self) -> TemplateData:
         """Get the template data for devfile resources.

src/ansible_creator/subcommands/add.py

@@ -34,7 +34,7 @@ class TemplateData:
 
     resource_type: str = ""
     plugin_type: str = ""
-    plugin_name: str = "hello_world"
+    plugin_name: str = ""
     additions: dict[str, dict[str, dict[str, str | bool]]] = field(default_factory=dict)
     collection_name: str = ""
     creator_version: str = ""

src/ansible_creator/types.py

@@ -28,7 +28,11 @@
 PATH_REPLACERS = {
     "project_org": "namespace",
     "project_repo": "collection_name",
-    "hello_world": "plugin_name",
+    "sample_module": "plugin_name",
+    "sample_action": "plugin_name",
+    "sample_filter": "plugin_name",
+    "sample_lookup": "plugin_name",
+    "sample_test": "plugin_name",
 }
 
 
@@ -210,6 +214,8 @@ def _recursive_walk(
         self.output.debug(msg=f"current root set to {root}")
 
         file_list = FileList()
+
+        # Process all objects in the directory
         for obj in root.iterdir():
             file_list.extend(
                 self.each_obj(
@@ -244,10 +250,11 @@ def each_obj(
             resource.replace(".", "/") + "/",
             maxsplit=1,
         )[-1]
+
         # replace placeholders in destination path with real values
         for key, val in PATH_REPLACERS.items():
-            if key in dest_name:
-                repl_val = getattr(template_data, val)
+            repl_val = getattr(template_data, val)
+            if key in dest_name and repl_val:
                 dest_name = dest_name.replace(key, repl_val)
         dest_name = dest_name.removesuffix(".j2")
 
@@ -259,18 +266,13 @@ def each_obj(
             )
         else:
             # If self.dest is a single Path
-            dest_path = DestinationFile(
-                dest=self.dest / dest_name,
-                source=obj,
-            )
+            dest_path = DestinationFile(dest=self.dest / dest_name, source=obj)
 
         self.output.debug(f"Looking at {dest_path}")
-
         if obj.is_file():
             dest_path.set_content(template_data, self.templar)
 
         if dest_path.needs_write:
-            # Warn on conflict
             conflict_msg = dest_path.conflict
             if conflict_msg:
                 self.output.warning(conflict_msg)
@@ -289,15 +291,13 @@ def each_obj(
                 )
             if obj.is_file():
                 return FileList([dest_path])
-
         if obj.is_dir() and obj.name not in SKIP_DIRS:
             return self._recursive_walk(
                 root=obj,
                 resource=resource,
                 current_index=current_index,
                 template_data=template_data,
             )
-
         return FileList()
 
     def _per_container(self, resource: str, current_index: int) -> FileList:
@@ -337,6 +337,7 @@ def _per_container(self, resource: str, current_index: int) -> FileList:
                     data=template_data,
                 )
                 deserialized = yaml.safe_load(templated)
+                # Use the deserialized templated value
                 setattr(template_data, key, deserialized)
             else:
                 setattr(template_data, key, value["value"])

src/ansible_creator/utils.py

@@ -1,4 +1,4 @@
-# hello_world.py - A custom action plugin for Ansible.
+# sample_action.py - A custom action plugin for Ansible.
 # Author: Your Name
 # License: GPL-3.0-or-later
 # pylint: disable=E0401
@@ -21,7 +21,7 @@
 
 class ActionModule(ActionBase):  # type: ignore[misc]
     """
-    Custom Ansible action plugin: hello_world
+    Custom Ansible action plugin: sample_action
     A custom action plugin for Ansible.
     """
 

tests/fixtures/collection/testorg/testcol/plugins/action/hello_world.py renamed to tests/fixtures/collection/testorg/testcol/plugins/action/sample_action.py

@@ -1,4 +1,4 @@
-# hello_world.py - A custom filter plugin for Ansible.
+# sample_filter.py - A custom filter plugin for Ansible.
 # Author: Your Name
 # License: GPL-3.0-or-later
 
@@ -15,7 +15,7 @@
 
 
 DOCUMENTATION = """
-    name: hello_world
+    name: sample_filter
     author: Your Name
     version_added: "1.0.0"
     short_description: A custom filter plugin for Ansible.
@@ -28,15 +28,15 @@
 """
 
 EXAMPLES = """
-# hello_world filter example
+# sample_filter filter example
 
 - name: Display a hello message
   ansible.builtin.debug:
-    msg: "{{ 'ansible-creator' | hello_world }}"
+    msg: "{{ 'ansible-creator' | sample_filter }}"
 """
 
 
-def _hello_world(name: str) -> str:
+def _sample_filter(name: str) -> str:
     """Returns Hello message.
 
     Args:
@@ -57,4 +57,4 @@ def filters(self) -> dict[str, Callable[[str], str]]:
         Returns:
             dict: The filter plugin functions.
         """
-        return {"hello_world": _hello_world}
+        return {"sample_filter": _sample_filter}

tests/fixtures/collection/testorg/testcol/plugins/filter/hello_world.py renamed to tests/fixtures/collection/testorg/testcol/plugins/filter/sample_filter.py

@@ -1,14 +1,14 @@
-# hello_world.py - A custom lookup plugin for Ansible.
+# sample_lookup.py - A custom lookup plugin for Ansible.
 
 # pylint: disable=E0401
-# hello_world.py - A custom lookup plugin for Ansible.
+# sample_lookup.py - A custom lookup plugin for Ansible.
 # Author: Your Name (@username)
 # Copyright 2020 Red Hat
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 DOCUMENTATION = """
-    name: hello_world
+    name: sample_lookup
     author: Your Name (@username)
     version_added: "1.0.0"
     short_description: A custom lookup plugin for Ansible.
@@ -23,9 +23,9 @@
 """
 
 EXAMPLES = """
-- name: Example usage of hello_world
+- name: Example usage of sample_lookup
   ansible.builtin.debug:
-    msg: "{{ lookup('hello_world', 'example_term') }}"
+    msg: "{{ lookup('sample_lookup', 'example_term') }}"
 """
 
 RETURN = """
@@ -45,7 +45,7 @@
 
 class LookupModule(LookupBase):  # type: ignore[misc]
     """
-    Custom Ansible lookup plugin: hello_world
+    Custom Ansible lookup plugin: sample_lookup
     A custom lookup plugin for Ansible.
     """
 
@@ -72,14 +72,14 @@ def run(
         if not isinstance(terms, list):
             raise AnsibleError("The 'terms' parameter must be a list.")
 
-        display.vvv(f"Running hello_world lookup plugin with terms: {terms}")
+        display.vvv(f"Running sample_lookup lookup plugin with terms: {terms}")
 
         try:
             # Example processing logic - Replace this with actual lookup code
             result = [term.upper() for term in terms]
 
-            display.vvv(f"Result from hello_world lookup: {result}")
+            display.vvv(f"Result from sample_lookup lookup: {result}")
             return result
 
         except Exception as e:
-            raise AnsibleError(f"Error in hello_world plugin: {e}") from e
+            raise AnsibleError(f"Error in sample_lookup plugin: {e}") from e

tests/fixtures/collection/testorg/testcol/plugins/lookup/hello_world.py renamed to tests/fixtures/collection/testorg/testcol/plugins/lookup/sample_lookup.py

@@ -1,8 +1,8 @@
-# hello_world.py
+# sample_action.py
 # GNU General Public License v3.0+
 
 DOCUMENTATION = """
-    module: hello_world
+    module: sample_action
     author: Your Name (@username)
     version_added: "1.0.0"
     short_description: A custom action plugin for Ansible.
@@ -28,7 +28,7 @@
 - name: Example Action Plugin
   hosts: localhost
   tasks:
-    - name: Example hello_world plugin
+    - name: Example sample_action plugin
       with_prefix:
         prefix: "Hello, World"
         msg: "Ansible!"

tests/fixtures/collection/testorg/testcol/plugins/modules/hello_world.py renamed to tests/fixtures/collection/testorg/testcol/plugins/modules/sample_action.py

@@ -1,4 +1,4 @@
-# hello_world.py - A custom module plugin for Ansible.
+# sample_module.py - A custom module plugin for Ansible.
 # Author: Your Name (@username)
 # License: GPL-3.0-or-later
 
@@ -15,7 +15,7 @@
 
 
 DOCUMENTATION = """
-    name: hello_world
+    name: sample_module
     author: Your Name (@username)
     version_added: "1.0.0"
     short_description: A custom module plugin for Ansible.
@@ -28,15 +28,15 @@
 """
 
 EXAMPLES = """
-# hello_world module example
+# sample_module module example
 
 - name: Display a hello message
   ansible.builtin.debug:
-    msg: "{{ 'ansible-creator' | hello_world }}"
+    msg: "{{ 'ansible-creator' | sample_module }}"
 """
 
 
-def _hello_world(name: str) -> str:
+def _sample_module(name: str) -> str:
     """Returns Hello message.
 
     Args:
@@ -57,4 +57,4 @@ def modules(self) -> dict[str, Callable[[str], str]]:
         Returns:
             dict: The module plugin functions.
         """
-        return {"hello_world": _hello_world}
+        return {"sample_module": _sample_module}