Scaffold action plugin through add subcommand

Author: shatakshiiii

src/ansible_creator/arg_parser.py

@@ -34,10 +34,7 @@
 
 MIN_COLLECTION_NAME_LEN = 2
 
-COMING_SOON = (
-    "add resource role",
-    "add plugin action",
-)
+COMING_SOON = ("add resource role",)
 
 
 class Parser:
@@ -369,6 +366,7 @@ def _add_plugin_action(self, subparser: SubParser[ArgumentParser]) -> None:
             formatter_class=CustomHelpFormatter,
         )
         self._add_args_common(parser)
+        self._add_overwrite(parser)
         self._add_args_plugin_common(parser)
 
     def _add_plugin_filter(self, subparser: SubParser[ArgumentParser]) -> None:

src/ansible_creator/resources/collection_project/plugins/action/hello_world.py.j2

@@ -0,0 +1,89 @@
+{# action_plugin_template.j2 #}
+{%- set action_name = plugin_name | default("hello_world") -%}
+{%- 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") -%}
+# {{ action_name }}.py - {{ description }}
+# Author: {{ author }}
+# License: {{ license }}
+# pylint: disable=E0401
+
+from __future__ import absolute_import, annotations, division, print_function
+
+__metaclass__ = type  # pylint: disable=C0103
+
+from typing import TYPE_CHECKING
+from ansible.plugins.action import ActionBase  # type: ignore
+
+
+if TYPE_CHECKING:
+    from typing import Optional, Dict, Any
+
+
+DOCUMENTATION = """
+    name: {{ action_name }}
+    author: {{ author }}
+    version_added: "1.0.0"
+    short_description: {{ description }}
+    description:
+      - This is a custom action plugin to provide action functionality.
+    notes:
+      - This is a scaffold template. Customize the plugin to fit your needs.
+"""
+
+EXAMPLES = """
+- name: Example Action Plugin
+  hosts: localhost
+  tasks:
+    - name: Example {{ action_name }} plugin
+      with_prefix:
+        prefix: "Hello, World"
+        msg: "Ansible!"
+"""
+
+
+class ActionModule(ActionBase):  # type: ignore[misc]
+    """
+    Custom Ansible action plugin: {{ action_name }}
+    A custom action plugin for Ansible.
+    """
+
+    def run(
+        self,
+        tmp: Optional[str] = None,
+        task_vars: Optional[Dict[str, Any]] = None,
+    ) -> Dict[str, Any]:
+        """
+        Executes the action plugin.
+
+        Args:
+            tmp: Temporary path provided by Ansible for the module execution. Defaults to None.
+            task_vars: Dictionary of task variables available to the plugin. Defaults to None.
+
+        Returns:
+            dict: Result of the action plugin execution.
+        """
+        # Get the task arguments
+        if task_vars is None:
+            task_vars = {}
+        result = {}
+        warnings: list[str] = []
+
+        # Example processing logic - Replace this with actual action code
+        result = super(ActionModule, self).run(tmp, task_vars)
+        module_args = self._task.args.copy()
+        result.update(
+            self._execute_module(
+                module_name="debug",
+                module_args=module_args,
+                task_vars=task_vars,
+                tmp=tmp,
+            ),
+        )
+
+        if warnings:
+            if "warnings" in result:
+                result["warnings"].extend(warnings)
+            else:
+                result["warnings"] = warnings
+        return result

src/ansible_creator/subcommands/add.py

@@ -174,7 +174,7 @@ def _plugin_scaffold(self, plugin_path: Path) -> None:
         self.output.debug(f"Started copying {self._project} plugin to destination")
 
         # Call the appropriate scaffolding function based on the plugin type
-        if self._plugin_type in ("lookup", "filter"):
+        if self._plugin_type in ("action", "filter", "lookup"):
             template_data = self._get_plugin_template_data()
 
         else:

tests/fixtures/collection/testorg/testcol/plugins/action/hello_world.py

@@ -0,0 +1,84 @@
+# hello_world.py - A custom action plugin for Ansible.
+# Author: Your Name
+# License: GPL-3.0-or-later
+# pylint: disable=E0401
+
+from __future__ import absolute_import, annotations, division, print_function
+
+__metaclass__ = type  # pylint: disable=C0103
+
+from typing import TYPE_CHECKING
+from ansible.plugins.action import ActionBase  # type: ignore
+
+
+if TYPE_CHECKING:
+    from typing import Optional, Dict, Any
+
+
+DOCUMENTATION = """
+    name: hello_world
+    author: Your Name
+    version_added: "1.0.0"
+    short_description: A custom action plugin for Ansible.
+    description:
+      - This is a custom action plugin to provide action functionality.
+    notes:
+      - This is a scaffold template. Customize the plugin to fit your needs.
+"""
+
+EXAMPLES = """
+- name: Example Action Plugin
+  hosts: localhost
+  tasks:
+    - name: Example hello_world plugin
+      with_prefix:
+        prefix: "Hello, World"
+        msg: "Ansible!"
+"""
+
+
+class ActionModule(ActionBase):  # type: ignore[misc]
+    """
+    Custom Ansible action plugin: hello_world
+    A custom action plugin for Ansible.
+    """
+
+    def run(
+        self,
+        tmp: Optional[str] = None,
+        task_vars: Optional[Dict[str, Any]] = None,
+    ) -> Dict[str, Any]:
+        """
+        Executes the action plugin.
+
+        Args:
+            tmp: Temporary path provided by Ansible for the module execution. Defaults to None.
+            task_vars: Dictionary of task variables available to the plugin. Defaults to None.
+
+        Returns:
+            dict: Result of the action plugin execution.
+        """
+        # Get the task arguments
+        if task_vars is None:
+            task_vars = {}
+        result = {}
+        warnings: list[str] = []
+
+        # Example processing logic - Replace this with actual action code
+        result = super(ActionModule, self).run(tmp, task_vars)
+        module_args = self._task.args.copy()
+        result.update(
+            self._execute_module(
+                module_name="debug",
+                module_args=module_args,
+                task_vars=task_vars,
+                tmp=tmp,
+            ),
+        )
+
+        if warnings:
+            if "warnings" in result:
+                result["warnings"].extend(warnings)
+            else:
+                result["warnings"] = warnings
+        return result