Add New Module file_remove #11032
Add New Module file_remove #11032
Conversation
ansibullbot
added
integration
This comment was marked as resolved.
This comment was marked as resolved.
ansibullbot
added
ci_verified
shahargolshani
force-pushed
the
dev/file_remove
branch
from
5b8e67c to
fc19d13
Compare
ansibullbot
removed
ci_verified
shahargolshani
force-pushed
the
dev/file_remove
branch
from
fc19d13 to
c2250a8
Compare
felixfontein
added
check-before-release
|
The typing errors are unrelated and have been fixed in another PR. |
shahargolshani
force-pushed
the
dev/file_remove
branch
2 times, most recently
from
482a0e2 to
cdb95e8
Compare
russoz
left a comment
russoz
left a comment
There was a problem hiding this comment.
hi @shahargolshani Thanks for your contribution!
Overall it looks good, just a few adjustments. I have not checked the logic of the tests, but the use case for this is not very complex, I am trusting they are covering what's needed.
| try: | ||
| re.compile(pattern) | ||
| except re.error as e: | ||
| module.fail_json(msg=f"Invalid regular expression pattern: {to_native(e)}") |
There was a problem hiding this comment.
This is redundant, since we no longer support Python 2, more occurrences around the code should be adjusted.
| module.fail_json(msg=f"Invalid regular expression pattern: {to_native(e)}") | |
| module.fail_json(msg=f"Invalid regular expression pattern: {e}") |
| # SPDX-License-Identifier: GPL-3.0-or-later | ||
|
|
||
| azp/posix/3 | ||
| destructive |
There was a problem hiding this comment.
Arguably not, since everything is created and destroyed within a temporary directory. @felixfontein what do you think?
There was a problem hiding this comment.
Yes, this isn't needed. The tests aren't installing/removing/modifying packages, system config files, services etc. or doing similar destructive things, which this aliases entry is for.
felixfontein
left a comment
felixfontein
left a comment
There was a problem hiding this comment.
Thanks for your contribution!
| - This module removes files from a specified directory that match a given pattern. | ||
| - The pattern can include wildcards and regular expressions. | ||
| - By default, only files in the specified directory are removed (non-recursive). | ||
| - Use the O(recursive) option to search and remove files in subdirectories. |
There was a problem hiding this comment.
I think some fewer paragraphs would be better here:
| - This module removes files from a specified directory that match a given pattern. | |
| - The pattern can include wildcards and regular expressions. | |
| - By default, only files in the specified directory are removed (non-recursive). | |
| - Use the O(recursive) option to search and remove files in subdirectories. | |
| - This module removes files from a specified directory that match a given pattern. | |
| The pattern can include wildcards and regular expressions. | |
| - By default, only files in the specified directory are removed (non-recursive). | |
| Use the O(recursive) option to search and remove files in subdirectories. |
| check_mode: | ||
| description: Can run in check_mode and return changed status without modifying the target. | ||
| support: full | ||
| diff_mode: | ||
| description: Will return details on what has changed (or possibly needs changing in check_mode). | ||
| support: full |
There was a problem hiding this comment.
Please remove the descriptions and use the appropriate doc fragment (see basically every other module in this collection).
| pattern: | ||
| description: | ||
| - Pattern to match files for removal. | ||
| - Supports wildcards (*, ?, [seq], [!seq]) for glob-style matching. |
There was a problem hiding this comment.
| - Supports wildcards (*, ?, [seq], [!seq]) for glob-style matching. | |
| - Supports wildcards (V(*), V(?), V([seq]), V([!seq])) for glob-style matching. |
| - V(file) - remove only regular files. | ||
| - V(link) - remove only symbolic links. | ||
| - V(any) - remove both files and symbolic links. | ||
| type: str | ||
| choices: ['file', 'link', 'any'] |
There was a problem hiding this comment.
| - V(file) - remove only regular files. | |
| - V(link) - remove only symbolic links. | |
| - V(any) - remove both files and symbolic links. | |
| type: str | |
| choices: ['file', 'link', 'any'] | |
| type: str | |
| choices: | |
| file: remove only regular files. | |
| link: remove only symbolic links. | |
| any: remove both files and symbolic links. |
|
|
||
| msg: | ||
| description: Status message. | ||
| type: str | ||
| returned: always | ||
| sample: "Removed 2 files matching pattern '*.log'" |
There was a problem hiding this comment.
We generally don't document standard return values.
| msg: | |
| description: Status message. | |
| type: str | |
| returned: always | |
| sample: "Removed 2 files matching pattern '*.log'" |
5 participants
SUMMARY
This PR introduces a new module,
file_remove, designed to idempotently delete a single file from a target host.Rationale: This module serves as an enhancement for many file deletion cases not currently supported by ansible.builtin.file with state=absent.
Pattern-based deletion: It allows using regular expressions to remove multiple files that match a specific pattern (e.g., all *.log or *.tmp files) in a single task.
Design: This avoids the common workaround of using ansible.builtin.find, registering the results, and then looping over them with ansible.builtin.file. This module performs that entire operation idempotently in one step.
This new module provides a more powerful and intuitive interface for these common "clean-up" style operations.
changelog: New Module
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION