Added clean_parent argument for the archive state #55418
Conversation
ghost
requested a review
from 
|
The only thing that I test is the conflict check between clean and clean_parent. |
Oloremo
force-pushed
the
54012-clean-parent-archive
branch
2 times, most recently
from
8931c63 to
6ab9c01
Compare
salt/states/archive.py
Outdated
| @@ -522,6 +523,12 @@ def extracted(name, | |||
|
|
|||
| .. versionadded:: 2016.11.1 | |||
|
|
|||
| clean_parent : False | |||
| Set this to ``True`` to remove a parent archive directory before the extration. | |||
There was a problem hiding this comment.
I would reword this like so:
If ``True``, and the archive is extracted, delete the parent
directory (i.e. the directory into which the archive is extracted), and
then re-create that directory before extracting. Note that ``clean``
and ``clean_parent`` are mutually exclusive.
salt/states/archive.py
Outdated
| @@ -1076,6 +1083,11 @@ def extracted(name, | |||
| )) | |||
| return ret | |||
|
|
|||
| if clean and clean_parent: | |||
| ret['comment'] = "You can't set both 'clean' and 'clean_parent' to True." | |||
There was a problem hiding this comment.
We don't typically use the phrasing "you can't". Instead, can you change this to Only one of 'clean' and 'clean_parent' can be set to True?
| try: | ||
| salt.utils.files.rm_rf(name.rstrip(os.sep)) | ||
| ret['changes'].setdefault( | ||
| 'removed', "Directory {} was removed prior to the extraction".format(name)) |
There was a problem hiding this comment.
Since you've removed the directory, you need to recreate it now. And you also need to take into account the value of the makedirs argument when you do. Otherwise, the destination directory won't exist when it comes time to extract, and the extraction will fail.
There was a problem hiding this comment.
Correct me if I'm wrong but parent directory going to be created no matter what:
1286 if not os.path.isdir(name):
1287 __states__['file.directory'](name, user=user, makedirs=True)
1288 created_destdir = True
There was a problem hiding this comment.
Ahh yes, you are correct. I mistakenly thought that this state used a makedirs param, I must have been confusing it with something else.
Oloremo
force-pushed
the
54012-clean-parent-archive
branch
from
027b3c6 to
4692664
Compare
|
Did a rebase + added a changelog |
|
re-run full centos7-py2-m2crypto |
|
re-run full amazon2-py2 |
salt/states/archive.py
Outdated
| ret['comment'] += ( | ||
| ' Since the \'clean_parent\' option is enabled, the ' | ||
| 'destination parent directory would be removed first ' | ||
| 'and than re-created and the archive would be ' |
There was a problem hiding this comment.
Typo:
| 'and than re-created and the archive would be ' | |
| 'and then re-created and the archive would be ' |
Could also be re-written to include the actual path that will be purged (using .format). But definitely fix the typo.
Oloremo
force-pushed
the
54012-clean-parent-archive
branch
from
d86cc9e to
9047b01
Compare
What does this PR do?
Adding new argument
clean_parentto the archive state. This allows the state to remove parent directory before the extraction.What issues does this PR fix or reference?
#54012
Previous Behavior
archive state was unable to do so by itself.
New Behavior
archive state now able to remove parent directory if requested
Tests written?
Yes... kinda.
Commits signed with GPG?
Yes