Add force_archive option to archive module to allow archiving and compression of single files

[markafarrell]

SUMMARY

This PR enables a user to force the archive module to create an archive when working with a single file. (Rather than just compressing the file)

NOTE: This is not applicable to zip files as the default behaviour for zipping a single file is to archive already.

NOTE: This PR does not change the default behaviour of the module.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

lib/ansible/modules/files/archive.py

ADDITIONAL INFORMATION

Before PR

1. Create a file to be archived

echo asdf > test.file

2. Archive the file

ansible localhost -m archive -a "dest=test.tar.gz path=test.file"

3. List the files in the archive

tar --list -f test.tar.gz

No files are listed as the tar archive was not created the file was only compressed using gzip.

4. Decompress file using gunzip

cat test.tar.gz | gunzip

Output:

asdf

Contents of file is shown after being decompressed as the tar archive was not created the file was only compressed using gzip.

After PR:

1. Create a file to be archived

echo asdf > test.file

2. Archive the file

ansible localhost -m archive -a "dest=test.tar.gz path=test.file force_archive=true"

3. List the files in the archive

tar --list -f test.tar.gz

Output:

test.file

test.file is correctly listed

[ansibot]

Hi @markafarrell, thank you for submitting this pull-request!

click here for bot help

[markafarrell]

@bendoh I noticed a closed issue #33563, that mentions that the intended behavior of the archive module when passed a single file is to only compress the file (not archive it).

Would you consider the above as a possible solution to this. It maintains the current behavior of the module, while allowing the user to choose to create an archive of a single file if that is what they want.

I believe this is a good half-way house and adds needed functionality without breaking backwards compatibility.

[bendoh]

I like it!

shipit

[markafarrell]

close and re-open to re-run ci

[markafarrell]

@bendoh Do I need to do anything else to get this merged?

[ansibot]

@markafarrell this PR contains the following merge commits:

• 4a690ba

Please rebase your branch to remove these commits.

click here for bot help

[bendoh]

shipit

[markafarrell]

@bendoh It looks like there is no entry in https://github.com/ansible/ansible/blob/devel/.github/BOTMETA.yml for this module (which I think is why ansibot is not adding the shipit label and hence it not being merged) Any idea how to get that fixed?

[bendoh]

Other than just adding myself, I do not. Can that be done as part of this PR?

[jctanner]

@bendoh as the module author, you are automatically considered the maintainer so you don't need to be added to BOTMETA.yml

rebuild_merge

[markafarrell]

@jctanner Why didn't @bendoh saying shipit cause ansibot to add the shipit tag then?

[jctanner]

@markafarrell because it takes more than one shipit to put a pullrequest into a shipit state.

https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md#when-will-your-pull-request-be-merged