diff options
Diffstat (limited to 'test/lib/ansible_test/_internal')
| -rw-r--r-- | test/lib/ansible_test/_internal/__init__.py | 2 | ||||
| -rw-r--r-- | test/lib/ansible_test/_internal/delegation.py | 17 | ||||
| -rw-r--r-- | test/lib/ansible_test/_internal/locale_util.py | 61 | ||||
| -rw-r--r-- | test/lib/ansible_test/_internal/util.py | 16 |
4 files changed, 90 insertions, 6 deletions
diff --git a/test/lib/ansible_test/_internal/__init__.py b/test/lib/ansible_test/_internal/__init__.py index 69d93aa06d..33e773063d 100644 --- a/test/lib/ansible_test/_internal/__init__.py +++ b/test/lib/ansible_test/_internal/__init__.py @@ -14,6 +14,7 @@ from .init import ( from .util import ( ApplicationError, display, + report_locale, ) from .delegation import ( @@ -59,6 +60,7 @@ def main(cli_args=None): # type: (t.Optional[t.List[str]]) -> None display.color = config.color display.fd = sys.stderr if config.display_stderr else sys.stdout configure_timeout(config) + report_locale() display.info('RLIMIT_NOFILE: %s' % (CURRENT_RLIMIT_NOFILE,), verbosity=2) diff --git a/test/lib/ansible_test/_internal/delegation.py b/test/lib/ansible_test/_internal/delegation.py index 975b6fc7e5..112fff8fc8 100644 --- a/test/lib/ansible_test/_internal/delegation.py +++ b/test/lib/ansible_test/_internal/delegation.py @@ -7,6 +7,10 @@ import os import tempfile import typing as t +from .locale_util import ( + STANDARD_LOCALE, +) + from .io import ( make_dirs, ) @@ -256,12 +260,7 @@ def generate_command( cmd = [os.path.join(ansible_bin_path, 'ansible-test')] cmd = [python.path] + cmd - # Force the encoding used during delegation. - # This is only needed because ansible-test relies on Python's file system encoding. - # Environments that do not have the locale configured are thus unable to work with unicode file paths. - # Examples include FreeBSD and some Linux containers. env_vars = dict( - LC_ALL='en_US.UTF-8', ANSIBLE_TEST_CONTENT_ROOT=content_root, ) @@ -276,6 +275,14 @@ def generate_command( env_vars.update( PYTHONPATH=library_path, ) + else: + # When delegating to a host other than the origin, the locale must be explicitly set. + # Setting of the locale for the origin host is handled by common_environment(). + # Not all connections support setting the locale, and for those that do, it isn't guaranteed to work. + # This is needed to make sure the delegated environment is configured for UTF-8 before running Python. + env_vars.update( + LC_ALL=STANDARD_LOCALE, + ) # Propagate the TERM environment variable to the remote host when using the shell command. if isinstance(args, ShellConfig): diff --git a/test/lib/ansible_test/_internal/locale_util.py b/test/lib/ansible_test/_internal/locale_util.py new file mode 100644 index 0000000000..cb10d42d0a --- /dev/null +++ b/test/lib/ansible_test/_internal/locale_util.py @@ -0,0 +1,61 @@ +"""Initialize locale settings. This must be imported very early in ansible-test startup.""" + +from __future__ import annotations + +import locale +import sys +import typing as t + +STANDARD_LOCALE = 'en_US.UTF-8' +""" +The standard locale used by ansible-test and its subprocesses and delegated instances. +""" + +FALLBACK_LOCALE = 'C.UTF-8' +""" +The fallback locale to use when the standard locale is not available. +This was added in ansible-core 2.14 to allow testing in environments without the standard locale. +It was not needed in previous ansible-core releases since they do not verify the locale during startup. +""" + + +class LocaleError(SystemExit): + """Exception to raise when locale related errors occur.""" + def __init__(self, message: str) -> None: + super().__init__(f'ERROR: {message}') + + +def configure_locale() -> t.Tuple[str, t.Optional[str]]: + """Configure the locale, returning the selected locale and an optional warning.""" + + if (fs_encoding := sys.getfilesystemencoding()).lower() != 'utf-8': + raise LocaleError(f'ansible-test requires the filesystem encoding to be UTF-8, but "{fs_encoding}" was detected.') + + candidate_locales = STANDARD_LOCALE, FALLBACK_LOCALE + + errors: dict[str, str] = {} + warning: t.Optional[str] = None + configured_locale: t.Optional[str] = None + + for candidate_locale in candidate_locales: + try: + locale.setlocale(locale.LC_ALL, candidate_locale) + locale.getlocale() + except (locale.Error, ValueError) as ex: + errors[candidate_locale] = str(ex) + else: + configured_locale = candidate_locale + break + + if not configured_locale: + raise LocaleError('ansible-test could not initialize a supported locale:\n' + + '\n'.join(f'{key}: {value}' for key, value in errors.items())) + + if configured_locale != STANDARD_LOCALE: + warning = (f'Using locale "{configured_locale}" instead of "{STANDARD_LOCALE}". ' + 'Tests which depend on the locale may behave unexpectedly.') + + return configured_locale, warning + + +CONFIGURED_LOCALE, LOCALE_WARNING = configure_locale() diff --git a/test/lib/ansible_test/_internal/util.py b/test/lib/ansible_test/_internal/util.py index 17a88adb98..ec03c0cc6e 100644 --- a/test/lib/ansible_test/_internal/util.py +++ b/test/lib/ansible_test/_internal/util.py @@ -32,6 +32,11 @@ try: except ImportError: TypeGuard = None +from .locale_util import ( + LOCALE_WARNING, + CONFIGURED_LOCALE, +) + from .encoding import ( to_bytes, to_optional_bytes, @@ -611,7 +616,7 @@ class OutputThread(ReaderThread): def common_environment(): """Common environment used for executing all programs.""" env = dict( - LC_ALL='en_US.UTF-8', + LC_ALL=CONFIGURED_LOCALE, PATH=os.environ.get('PATH', os.path.defpath), ) @@ -651,6 +656,15 @@ def common_environment(): return env +def report_locale() -> None: + """Report the configured locale and the locale warning, if applicable.""" + + display.info(f'Configured locale: {CONFIGURED_LOCALE}', verbosity=1) + + if LOCALE_WARNING: + display.warning(LOCALE_WARNING) + + def pass_vars(required, optional): # type: (t.Collection[str], t.Collection[str]) -> t.Dict[str, str] """Return a filtered dictionary of environment variables based on the current environment.""" env = {} |