Avoid test failures on CentOS caused by locale

[oranenj]

Setting en_US.UTF-8 prevents the builds from falling back to C, which
can break some tests for no good reason.

Observed with puppet-jira, at least.

[kenyon]

Context: voxpupuli/puppet-jira#364

[bastelfreak]

@ekohl @trevor-vaughan do you think this makes sense / should that not be required and indicates broken code / should that be in beaker instead?

[ekohl]

What we do in Foreman is to set the locale on the database:
https://github.com/theforeman/puppet-foreman/blob/92eb55dd9fd343417ffd7f719ba0f54fbef0bc3f/manifests/database/postgresql.pp#L24-L25

Would that actually be a better approach? Can you check if that does work?

[bastelfreak]

I gave this a try in voxpupuli/puppet-zabbix#762 again. The tests fail if we don't set the locale in the workflow file. In the past I tried setting it in the postgresql module and that didn't work as well. I suggest we merge this here and roll it out to all nodes.

[ekohl]

I still think this can mask real issues for users and because of that I'm hesitant to merge this.

[ekohl]

So I got a bit more info now. This appears to show up more often with Puppet 7 with PostgreSQL, at least in some tests that I did. It fails on initdb which also needs locales. Right now I'm not sure what the best way to deal with this is, but at least I understand the problem better.

Trying some of these options now that I know a reproducer.

[ekohl]

So some more info.

Puppet 5 & 6 on CentOS use LANG=C while Puppet 7 uses LANG=C.UTF-8.

Output from Puppet 6 with exec { '/usr/bin/env': logouput => true }:

centos7-64.example.com 15:04:18$ puppet apply --verbose --detailed-exitcodes /tmp/apply_manifest.pp.T1Lmzt
  2021-05-27 15:04:18.760084 WARN  puppetlabs.facter -   locale environment variables were bad; continuing with LANG=C LC_ALL=C
  Info: Loading facts
  Info: Loading facts
  Notice: Compiled catalog for centos7-64.example.com in environment production in 0.13 seconds
  Info: Applying configuration version '1622127861'
  Notice: /Stage[main]/Main/Yumrepo[candlepin]/ensure: created
  Info: Yumrepo[candlepin](provider=inifile): changing mode of /etc/yum.repos.d/candlepin.repo from 600 to 644
  Notice: /Stage[main]/Main/Package[nmap]/ensure: created
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: MANPATH=:/opt/puppetlabs/puppet/share/man
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: XDG_SESSION_ID=2
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SHELL=/bin/bash
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SSH_CLIENT=172.17.0.1 50630 22
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: LD_LIBRARY_PATH=
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: PATH=/opt/puppetlabs/bin:/opt/puppetlabs/puppet/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: MAIL=/var/mail/root
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: ***
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: LANG=C
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SHLVL=1
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SSH_CONNECTION=172.17.0.1 50630 172.17.0.2 22
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: XDG_RUNTIME_DIR=/run/user/0
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: LC_ALL=C
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: DEBIAN_FRONTEND=noninteractive
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: APT_LISTBUGS_FRONTEND=none
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: APT_LISTCHANGES_FRONTEND=none
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: executed successfully
  Info: Creating state file /opt/puppetlabs/puppet/cache/state/state.yaml
  Notice: Applied catalog in 34.51 seconds

The same on Puppet 7:

centos7-64.example.com 15:03:09$ puppet apply --verbose --detailed-exitcodes /tmp/apply_manifest.pp.c7Z1uM
  Info: Loading facts
  Info: Loading facts
  Notice: Compiled catalog for centos7-64.example.com in environment production in 0.06 seconds
  Info: Applying configuration version '1622127792'
  Notice: /Stage[main]/Main/Yumrepo[candlepin]/ensure: created
  Info: Yumrepo[candlepin](provider=inifile): changing mode of /etc/yum.repos.d/candlepin.repo from 600 to 644
  Notice: /Stage[main]/Main/Package[nmap]/ensure: created
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: MANPATH=:/opt/puppetlabs/puppet/share/man
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: XDG_SESSION_ID=2
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SHELL=/bin/bash
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SSH_CLIENT=172.17.0.1 48066 22
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: LD_LIBRARY_PATH=
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: PATH=/opt/puppetlabs/bin:/opt/puppetlabs/puppet/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: MAIL=/var/mail/root
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: ***
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: LANG=C.UTF-8
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SHLVL=1
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: SSH_CONNECTION=172.17.0.1 48066 172.17.0.2 22
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: XDG_RUNTIME_DIR=/run/user/0
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: DEBIAN_FRONTEND=noninteractive
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: APT_LISTBUGS_FRONTEND=none
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: APT_LISTCHANGES_FRONTEND=none
  Notice: /Stage[main]/Main/Exec[/usr/bin/env]/returns: executed successfully
  Info: Creating state file /opt/puppetlabs/puppet/cache/state/state.yaml
  Notice: Applied catalog in 6.19 seconds

This locale (C.UTF-8) does not exist on EL 7. https://bugzilla.redhat.com/show_bug.cgi?id=1361965#c19 also states that it won't be added due to bugs and where RHEL 7 currently (maintenance mode).

It should also be noted that the en_US.UTF-8 locale is not present by default on CentOS 8 images. Merging this would break that since we don't install glibc-langpack-en by default.

I also don't know if setting these variables here moves them into the actual system that's tested.