Merge pull request #13 from manala/feat/find-module

feat: Add a "find" module

Author: nervo

CHANGELOG.md

@@ -10,6 +10,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/find.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from ansible.plugins.action import ActionBase
+
+from pathlib import Path
+
+
+class ActionModule(ActionBase):
+    '''Return a list of paths based on specific criteria'''
+
+    def run(self, tmp=None, task_vars=None):
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+
+        validation, args = self.validate_argument_spec(
+            argument_spec={
+                'path': {'type': 'path', 'required': True},
+                'patterns': {'type': 'list', 'default': [], 'elements': 'str'},
+                'excludes': {'type': 'list', 'elements': 'str'},
+            },
+        )
+
+        find = self._execute_module(
+            module_name='ansible.builtin.find',
+            module_args={
+                'paths': [args['path']],
+                'file_type': 'file',
+                'patterns': args['patterns'],
+                'excludes': args['excludes'],
+            },
+            task_vars=task_vars,
+        )
+
+        files = find.pop('files')
+
+        result.update(find)
+        result['paths'] = []
+
+        for file in files:
+            result['paths'].append({
+                'path': str(Path(file['path']).relative_to(Path(args['path']))),
+                'state': 'file',
+                'user': file['pw_name'],
+                'group': file['gr_name'],
+                'mode': file['mode'],
+            })
+
+        return result

plugins/modules/find.py

@@ -0,0 +1,18 @@
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import annotations
+
+DOCUMENTATION = '''
+---
+module: find
+short_description: Return a list of paths based on specific criteria
+description:
+  - Return a list of paths based on specific criteria
+author:
+  - Manala (@manala)
+'''
+
+EXAMPLES = '''
+- name: Find
+  manala.path.find:
+'''

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

@@ -0,0 +1,32 @@
+---
+
+- name: Find
+  vars:
+    path: /tmp/integration/find
+  block:
+    - name: Find | Setup root
+      ansible.builtin.file:  # noqa: risky-file-permissions
+        path: "{{ path }}"
+        state: "{{ item }}"
+      loop: [absent, directory]
+    - name: Find | Setup paths
+      manala.path.path:
+        path: "{{ [path, item.path] | ansible.builtin.path_join }}"
+        content: "{{ item.content }}"
+      loop:
+        - path: foo
+          content: foo
+        - path: bar
+          content: bar
+    - name: Find | Converge
+      manala.path.find:
+        path: "{{ path }}"
+      register: paths
+    - name: Find | Verify
+      vars:
+        expected:
+          - { path: foo, state: file, user: lazy, group: lazy, mode: "0644" }
+          - { path: bar, state: file, user: lazy, group: lazy, mode: "0644" }
+      ansible.builtin.assert:
+        that:
+          - (paths.paths | ansible.builtin.difference(expected)) | length == 0