unarchive: fix non-english locales

[joneuhauser]

SUMMARY

For GNU Gettext, the LANGUAGE environment variable takes precedence over LANG or LC_ALL (http://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/The-LANGUAGE-variable.html#The-LANGUAGE-variable). On systems where LANGUAGE was set to a non-english locale, the output of the tar command was in that language, so the module didn't understand it. This lead to the module failing silently ("changed": false, but the archive was not extracted).

The issue is simply fixed by adding the LANGUAGE environment variable as well.

Tested with:

ansible [core 2.12.1]
  config file = /md1/config/ansible/ansible.cfg
  configured module search path = ['/user/hi202/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /opt/ansible/lib/python3.8/site-packages/ansible
  ansible collection location = /user/hi202/.ansible/collections:/usr/share/ansible/collections
  executable location = /opt/ansible/bin/ansible
  python version = 3.8.0 (default, Feb 25 2021, 22:10:10) [GCC 8.4.0]
  jinja version = 3.0.3
  libyaml = True

on Ubuntu 20.04, German system, i.e.

LANG=de_DE.UTF-8
LANGUAGE=de_DE:en
LC_MESSAGES="de_DE.UTF-8"

If you are affected by this issue, add

environment:
        LANGUAGE: en_US.utf8

to your play.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

unarchive

ADDITIONAL INFORMATION

Step by step reproduction:

1. Change locale as above
2. Try to unarchive a tar archive using one of the example plays in the documentation
3. Nothing is unarchived, the module shows "changed: false"

[s-hertel]

Could you add a changelog and test for this? For the test you can copy https://github.com/ansible/ansible/blob/devel/test/integration/targets/unarchive/tasks/test_non_ascii_filename.yml#L32-L66 and set the LANGUAGE env var instead.

[joneuhauser]

Thanks for having a look!

For the test you can copy https://github.com/ansible/ansible/blob/devel/test/integration/targets/unarchive/tasks/test_non_ascii_filename.yml#L32-L66 and set the LANGUAGE env var instead.

Alright, done. However it's a bit meaningless to set the LANGUAGE env var if the referenced language pack doesn't exist (and LANGUAGE=C yields the same result as LANGUAGE=en_US on my system). I added some code to ensure that the locale actually exists.

[s-hertel]

Thanks for adding the changelog!

[joneuhauser]

@s-hertel Thanks for your review and assistance with my first MR here. I'll perform the changes you suggested also on my other MR that addresses the same issue.

[s-hertel]

@joneuhauser Awesome first contribution, thanks for working on this!