Feature: Add include option to unarchive

[sijis]

SUMMARY

This should allow users to extract specific files from an archive as desired.

Fixes #16130, #27081.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

unarchive

ANSIBLE VERSION

ansible 2.6.0a1 (feature/unarchive/add_include_option 70f23af274) last updated 2018/05/22 01:18:14 (GMT -500)
  config file = /home/saviles/data/git/github/ansible/ansible.cfg
  configured module search path = ['/home/saviles/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/saviles/data/git/github/ansible/lib/ansible
  executable location = /home/saviles/data/git/github/ansible/bin/ansible
  python version = 3.6.5 (default, Mar 29 2018, 18:20:46) [GCC 8.0.1 20180317 (Red Hat 8.0.1-0.19)]

ADDITIONAL INFORMATION

Playbook

- hosts: localhost
  vars:
    issue: 16130
    src_dir: "files/{{ issue }}"
    dst_dir: "/tmp/{{ issue }}"
  tasks:
    - name: Create directory
      file:
        state: directory
        path: "{{item}}"
      with_items:
        - "{{src_dir}}"
        - "{{dst_dir}}"
        - "{{dst_dir}}-tar"
    - name: Create files
      shell: "touch {{src_dir}}/{include,exclude}-{0..9}.txt"

    - name: Create archive file
      archive:
        format: "zip"
        path: "{{src_dir}}/*"
        dest: "{{src_dir}}.zip"
    - name: Unpack zip file
      unarchive:
        src: "{{src_dir}}.zip"
        dest: "{{dst_dir}}"
        remote_src: yes
        include:
          - 'include-2.txt'
      register: unzipped

    - name: Create archive file
      archive:
        format: "tar"
        path: "{{src_dir}}/*"
        dest: "{{src_dir}}.tar"
    - name: Unpack zip file
      unarchive:
        src: "{{src_dir}}.tar"
        dest: "{{dst_dir}}-tar"
        # remote_src: yes
        include:
          - 'include-4.txt'

Output

$ tree /tmp/16130*
/tmp/16130
└── include-2.txt
/tmp/16130-tar
└── include-4.txt

0 directories, 2 files

[ansibot]

cc @pileofrogs
click here for bot help

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/files/unarchive.py:0:0: E322 "include" is listed in the argument_spec, but not documented in the module

click here for bot help

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/files/unarchive.py:0:0: E309 version_added for new option (include) should be 2.6. Currently 0.0

click here for bot help

[sijis]

The only thing left is adding integration tests.

[sijis]

Added tests for zip archive. Need to complete for gz.

[sijis]

Added fix to tar files including tests.
I also had to rebase, as the excludes feature fix PR was added.

[cacack]

@sijis Any word on this? Writing a playbook right now that would greatly benefit from being able to whitelist the files to extract...

[tchernomax]

LGTM

though I would have use fnmatch.fnmatch(member, include) (as in exclude), but I can understand that "include" should not use glob.

[s-hertel]

Sorry for taking a while to review this one! Do you mind rebasing this, updating the version added, and adding a changelog?

This option should probably be mutually exclusive with exclude - i.e. AnsibleModule(..., mutually_exclusive=[('exclude', 'include',)])

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/unarchive.py:0:0: parameter-list-no-elements: Argument 'include' in argument_spec defines type as list but elements is not defined
lib/ansible/modules/unarchive.py:0:0: parameter-type-not-in-doc: Argument 'include' in argument_spec defines type as 'list' but documentation doesn't define type

click here for bot help

[sijis]

@samdoran Thanks for rebasing and moving this along.

[samdoran]

@sijis Sorry it took us so long to merge this. Thank you for your contribution.