Merge branch 'main' into feat/find-module

Author: nervo

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add a "file" parameter to "path" module
 - Add a "find" module
 
 ## [1.1.0] - 2024-09-13

plugins/action/path.py

@@ -20,6 +20,7 @@ def run(self, tmp=None, task_vars=None):
                 'path': {'type': 'path', 'required': True},
                 'state': {'type': 'str', 'choices': ['present', 'absent', 'file'], 'default': 'present'},
                 'content': {'type': 'str'},
+                'file': {'type': 'path'},
                 'template': {'type': 'path'},
                 'vars': {'type': 'dict', 'default': {}},
                 'user': {'type': 'str'},
@@ -28,7 +29,7 @@ def run(self, tmp=None, task_vars=None):
                 'validate': {'type': 'str'},
             },
             mutually_exclusive=(
-                ['content', 'template'],
+                ['content', 'file', 'template'],
             ),
         )
 
@@ -66,6 +67,28 @@ def run(self, tmp=None, task_vars=None):
                     shared_loader_obj=self._shared_loader_obj,
                 ).run(task_vars=combine_vars(task_vars, args['vars']))
             )
+        elif (args['state'] in ['present', 'file']) and args['file']:
+            display.v('Use "ansible.builtin.copy" to ensure "%s" file.' % args['path'])
+            task = self._task.copy()
+            task.args = {
+                'dest': args['path'],
+                'src': args['file'],
+                'owner': args['user'],
+                'group': args['group'],
+                'mode': args['mode'],
+                'validate': args['validate'],
+            }
+            result.update(
+                self._shared_loader_obj.action_loader.get(
+                    'ansible.builtin.copy',
+                    task=task,
+                    connection=self._connection,
+                    play_context=self._play_context,
+                    loader=self._loader,
+                    templar=self._templar,
+                    shared_loader_obj=self._shared_loader_obj,
+                ).run(task_vars=task_vars)
+            )
         elif (args['state'] in ['present', 'file']) and args['template']:
             display.v('Use "ansible.builtin.template" to ensure "%s" template.' % args['path'])
             task = self._task.copy()
@@ -89,7 +112,7 @@ def run(self, tmp=None, task_vars=None):
                 ).run(task_vars=combine_vars(task_vars, args['vars']))
             )
         elif args['state'] == 'file':
-            raise AnsibleActionFail('one of the following is required: content, template')
+            raise AnsibleActionFail('one of the following is required: content, file, template')
         elif args['state'] == 'present':
             display.v('Use "ansible.builtin.file" to ensure "%s" is a directory.' % args['path'])
             result.update(

tests/integration/targets/path/files/file

@@ -0,0 +1 @@
+file

tests/integration/targets/path/tasks/main.yaml

@@ -108,6 +108,45 @@
           - stats.results[0].stat.exists is true
           - contents.results[0].content | b64decode == 'content'
 
+########
+# File #
+########
+
+- name: File
+  tags: file
+  vars:
+    path: /tmp/integration/path/file
+  block:
+    - name: File | Setup path
+      ansible.builtin.file:  # noqa: risky-file-permissions
+        path: "{{ path }}"
+        state: "{{ item }}"
+      loop: [absent, directory]
+    - name: File | Converge
+      manala.path.path:
+        path: "{{ [path, item.path] | ansible.builtin.path_join }}"
+        file: "{{ item.file }}"
+      loop:
+        - path: file
+          file: file
+    - name: File | Stats
+      ansible.builtin.stat:
+        path: "{{ [path, item.path] | ansible.builtin.path_join }}"
+      register: stats
+      loop:
+        - path: file
+    - name: File | Contents
+      ansible.builtin.slurp:
+        src: "{{ [path, item.path] | ansible.builtin.path_join }}"
+      register: contents
+      loop:
+        - path: file
+    - name: File | Verify
+      ansible.builtin.assert:
+        that:
+          - stats.results[0].stat.exists is true
+          - contents.results[0].content | b64decode == 'file'
+
 ############
 # Template #
 ############