mirror of https://github.com/ansible/ansible.git
Compare commits
120 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
8a047b623d | 6 months ago |
|
|
d3f2c6d8f0 | 6 months ago |
|
|
529776f0a1 | 6 months ago |
|
|
f2a0eef867 | 6 months ago |
|
|
58496bed29 | 6 months ago |
|
|
96b97dee7c | 6 months ago |
|
|
1fe0fb0e7a | 6 months ago |
|
|
7a7427bd6f | 6 months ago |
|
|
b5a4fe62ed | 6 months ago |
|
|
0cecfd9877 | 6 months ago |
|
|
e2b831ce26 | 6 months ago |
|
|
33c55b9c25 | 6 months ago |
|
|
aae5734e0e | 6 months ago |
|
|
b95bc19853 | 6 months ago |
|
|
eb29a662f6 | 6 months ago |
|
|
0f2bc31753 | 6 months ago |
|
|
7b823720ca | 6 months ago |
|
|
a943626ce6 | 6 months ago |
|
|
9f703f7633 | 6 months ago |
|
|
36f322bb2c | 6 months ago |
|
|
a57229aa8a | 6 months ago |
|
|
bc624d35b9 | 6 months ago |
|
|
2eb107fe1f | 6 months ago |
|
|
d5e6d31d50 | 6 months ago |
|
|
92824444ea | 6 months ago |
|
|
c79c2710f4 | 6 months ago |
|
|
3a487532dd | 6 months ago |
|
|
20be3951b7 | 6 months ago |
|
|
e1a7508f6d | 6 months ago |
|
|
4ae5800849 | 6 months ago |
|
|
603e65d204 | 6 months ago |
|
|
a8c68be3b9 | 6 months ago |
|
|
744f86fbc5 | 6 months ago |
|
|
698b8d64fc | 6 months ago |
|
|
7b99b0144d | 6 months ago |
|
|
d63f9aa38d | 6 months ago |
|
|
0576ff3e65 | 6 months ago |
|
|
85283e7238 | 6 months ago |
|
|
311ef75245 | 6 months ago |
|
|
0d01da2dc2 | 6 months ago |
|
|
5fd78b07fb | 6 months ago |
|
|
8b0b54de38 | 6 months ago |
|
|
21f478e77b | 6 months ago |
|
|
40a675543f | 6 months ago |
|
|
fa2f1e4750 | 6 months ago |
|
|
2adc8ae1cd | 6 months ago |
|
|
6f7215ca36 | 6 months ago |
|
|
43b0155529 | 6 months ago |
|
|
2d800e1a4c | 6 months ago |
|
|
df60504b93 | 6 months ago |
|
|
abb1de2780 | 6 months ago |
|
|
457b40d659 | 6 months ago |
|
|
3207e55ca2 | 6 months ago |
|
|
424327c293 | 6 months ago |
|
|
cc0ef95ce8 | 6 months ago |
|
|
8bbc43efd0 | 6 months ago |
|
|
880b584124 | 6 months ago |
|
|
895af10b99 | 6 months ago |
|
|
638d711a72 | 6 months ago |
|
|
1441817ffe | 6 months ago |
|
|
01e97d7f80 | 6 months ago |
|
|
108f349e1d | 6 months ago |
|
|
35a951b611 | 6 months ago |
|
|
76fa45895d | 6 months ago |
|
|
1381fc30a3 | 6 months ago |
|
|
f771784853 | 6 months ago |
|
|
46cc5d6b90 | 6 months ago |
|
|
0ba6145aa8 | 6 months ago |
|
|
1bd8ed4437 | 6 months ago |
|
|
33c3844daa | 7 months ago |
|
|
b6fad7bbb8 | 7 months ago |
|
|
3a2248a992 | 7 months ago |
|
|
134c8ec093 | 7 months ago |
|
|
fddda73042 | 7 months ago |
|
|
60ddb2954b | 7 months ago |
|
|
b2699fade5 | 7 months ago |
|
|
5e0733288e | 7 months ago |
|
|
731b4d0242 | 7 months ago |
|
|
d6a8582da7 | 7 months ago |
|
|
204cdcee67 | 7 months ago |
|
|
df214f93a7 | 7 months ago |
|
|
27aca0abd3 | 7 months ago |
|
|
38ef2b8c25 | 7 months ago |
|
|
23f935eb0d | 7 months ago |
|
|
9fff6d433d | 7 months ago |
|
|
e8d914e992 | 7 months ago |
|
|
121871af86 | 7 months ago |
|
|
f70dbc15e5 | 7 months ago |
|
|
80af44d822 | 7 months ago |
|
|
da59710961 | 7 months ago |
|
|
c83b70a04c | 7 months ago |
|
|
c742fdc66c | 7 months ago |
|
|
7a932a93b0 | 7 months ago |
|
|
8c8717a8e4 | 7 months ago |
|
|
6054b29cb7 | 7 months ago |
|
|
131175a5a6 | 7 months ago |
|
|
0aab250fbc | 7 months ago |
|
|
dcec78b0f9 | 7 months ago |
|
|
ea22e5d0dd | 7 months ago |
|
|
867d9d3096 | 7 months ago |
|
|
e0e286c009 | 7 months ago |
|
|
1c1a271b88 | 7 months ago |
|
|
4e861fa9c8 | 7 months ago |
|
|
f898f9fec6 | 7 months ago |
|
|
4714194672 | 7 months ago |
|
|
ffbf121182 | 8 months ago |
|
|
89a4900b61 | 8 months ago |
|
|
17d4fdd883 | 8 months ago |
|
|
7fc916361e | 8 months ago |
|
|
82ea3addce | 8 months ago |
|
|
98009c811b | 8 months ago |
|
|
de7c454684 | 8 months ago |
|
|
80d5f05642 | 8 months ago |
|
|
ec0d8f3278 | 8 months ago |
|
|
c21a817c47 | 8 months ago |
|
|
85cb2baf1f | 8 months ago |
|
|
2fcfad54b0 | 8 months ago |
|
|
6f95a618af | 8 months ago |
|
|
19d9253ec9 | 8 months ago |
|
|
8d775ddced | 8 months ago |
@ -0,0 +1,490 @@
|
|||||||
|
==================================================================
|
||||||
|
ansible-core 2.19 "What Is and What Should Never Be" Release Notes
|
||||||
|
==================================================================
|
||||||
|
|
||||||
|
.. contents:: Topics
|
||||||
|
|
||||||
|
v2.19.0b6
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-06-11
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- ansiballz - Added an experimental AnsiballZ extension for remote debugging.
|
||||||
|
- ansiballz - Added support for AnsiballZ extensions.
|
||||||
|
- ansiballz - Moved AnsiballZ code coverage support into an extension.
|
||||||
|
- ansiballz - Refactored AnsiballZ and module respawn.
|
||||||
|
- template action and lookup plugin - The value of the ``ansible_managed`` variable (if set) will not be masked by the ``template`` action and lookup. Previously, the value calculated by the ``DEFAULT_MANAGED_STR`` configuration option always masked the variable value during plugin execution, preventing runtime customization.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Fix templating ``tags`` on plays and roles. (https://github.com/ansible/ansible/issues/69903)
|
||||||
|
- ansible-doc will no longer ignore docs for modules without an extension (https://github.com/ansible/ansible/issues/85279).
|
||||||
|
- display - Fix hang caused by early post-fork writers to stdout/stderr (e.g., pydevd) encountering an unreleased fork lock.
|
||||||
|
- get_url - add a check to recognize incomplete data transfers.
|
||||||
|
- include_tasks - fix templating options when used as a handler (https://github.com/ansible/ansible/pull/85015).
|
||||||
|
- templating - Fixed cases where template expression blocks halted prematurely when a Jinja macro invocation returned an undefined value.
|
||||||
|
- templating - Jinja macros returned from a template expression can now be called from another template expression.
|
||||||
|
|
||||||
|
v2.19.0b5
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-06-03
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Improved SUSE distribution detection in distribution.py by parsing VARIANT_ID from /etc/os-release for identifying SLES_SAP and SL-Micro. Falls back to /etc/products.d/baseproduct symlink for older systems.
|
||||||
|
- Remove unnecessary shebang from the ``hostname`` module.
|
||||||
|
- Use ``importlib.metadata.version()`` to detect Jinja version as jinja2.__version__ is deprecated and will be removed in Jinja 3.3.
|
||||||
|
- ansible-doc - Return dynamic stub when reporting on Jinja filters and tests not explicitly documented in Ansible
|
||||||
|
- ansible-doc - Skip listing the internal ``ansible._protomatter`` plugins unless explicitly requested
|
||||||
|
- ansible-test - Add RHEL 10.0 as a remote platform for testing.
|
||||||
|
- apt_repository - remove Python 2 support
|
||||||
|
- csvfile lookup - remove Python 2 compat
|
||||||
|
- display - Add ``help_text`` and ``obj`` to ``Display.error_as_warning``.
|
||||||
|
- display - Replace Windows newlines (``\r\n``) in display output with Unix newlines (``\n``). This ensures proper display of strings sourced from Windows hosts in environments which treat ``\r`` as ``\n``, such as Azure Pipelines.
|
||||||
|
- facts - add "Linode" for Linux VM in virtual facts
|
||||||
|
- module_utils - Add ``AnsibleModule.error_as_warning``.
|
||||||
|
- module_utils - Add ``ansible.module_utils.common.warnings.error_as_warning``.
|
||||||
|
- module_utils - Add optional ``help_text`` argument to ``AnsibleModule.warn``.
|
||||||
|
- ssh agent - Added ``SSH_AGENT_EXECUTABLE`` config to allow override of ssh-agent.
|
||||||
|
- ssh connection plugin - Added ``verbosity`` config to decouple SSH debug output verbosity from Ansible verbosity. Previously, the Ansible verbosity value was always applied to the SSH client command-line, leading to excessively verbose output. Set the ``ANSIBLE_SSH_VERBOSITY`` envvar or ``ansible_ssh_verbosity`` Ansible variable to a positive integer to increase SSH client verbosity.
|
||||||
|
- task timeout - Specifying a timeout greater than 100,000,000 now results in an error.
|
||||||
|
- templating - Added ``_ANSIBLE_TEMPLAR_SANDBOX_MODE=allow_unsafe_attributes`` environment variable to disable Jinja template attribute sandbox. (https://github.com/ansible/ansible/issues/85202)
|
||||||
|
- windows - Added support for ``#AnsibleRequires -Wrapper`` to request a PowerShell module be run through the execution wrapper scripts without any module utils specified.
|
||||||
|
- windows - Added support for running signed modules and scripts with a Windows host protected by Windows App Control/WDAC. This is a tech preview and the interface may be subject to change.
|
||||||
|
- windows - Script modules will preserve UTF-8 encoding when executing the script.
|
||||||
|
|
||||||
|
Deprecated Features
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
- The ``ShellModule.checksum`` method is now deprecated and will be removed in ansible-core 2.23. Use ``ActionBase._execute_remote_stat()`` instead.
|
||||||
|
- The ``ansible.module_utils.common.collections.count()`` function is deprecated and will be removed in ansible-core 2.23. Use ``collections.Counter()`` from the Python standard library instead.
|
||||||
|
- ``ansible.compat.importlib_resources`` is deprecated and will be removed in ansible-core 2.23. Use ``importlib.resources`` from the Python standard library instead.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Core Jinja test plugins - Builtin test plugins now always return ``bool`` to avoid spurious deprecation warnings for some malformed inputs.
|
||||||
|
- ansible-test - Disabled the ``bad-super-call`` pylint rule due to false positives.
|
||||||
|
- ansible-test - Fix incorrect handling of options with optional args (e.g. ``--color``), when followed by other options which are omitted during arg filtering (e.g. ``--docker``). Previously it was possible for non-option arguments to be incorrectly omitted in these cases. (https://github.com/ansible/ansible/issues/85173)
|
||||||
|
- ansible-test - Improve type inference for pylint deprecated checks to accommodate some type annotations.
|
||||||
|
- async_status module - The ``started`` and ``finished`` return values are now ``True`` or ``False`` instead of ``1`` or ``0``.
|
||||||
|
- constructed inventory - Use the ``default_value`` or ``trailing_separator`` in a ``keyed_groups`` entry if the expression result of ``key`` is ``None`` and not just an empty string.
|
||||||
|
- dnf5 - handle all libdnf5 specific exceptions (https://github.com/ansible/ansible/issues/84634)
|
||||||
|
- error handling - Error details and tracebacks from connection and built-in action exceptions are preserved. Previously, much of the detail was lost or mixed into the error message.
|
||||||
|
- from_yaml_all filter - `None` and empty string inputs now always return an empty list. Previously, `None` was returned in Jinja native mode and empty list in classic mode.
|
||||||
|
- local connection plugin - The command-line used to create subprocesses is now always ``str`` to avoid issues with debuggers and profilers.
|
||||||
|
- ssh agent - Fixed several potential startup hangs for badly-behaved or overloaded ssh agents.
|
||||||
|
- task timeout - Specifying a negative task timeout now results in an error.
|
||||||
|
|
||||||
|
v2.19.0b4
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-05-12
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- facts - add "CloudStack KVM Hypervisor" for Linux VM in virtual facts (https://github.com/ansible/ansible/issues/85089).
|
||||||
|
- modules - use ``AnsibleModule.warn`` instead of passing ``warnings`` to ``exit_json`` or ``fail_json`` which is deprecated.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- ansible-test - Updated the ``pylint`` sanity test to skip some deprecation validation checks when all arguments are dynamic.
|
||||||
|
- config - Preserve or apply Origin tag to values returned by config.
|
||||||
|
- config - Prevented fatal errors when ``MODULE_IGNORE_EXTS`` configuration was set.
|
||||||
|
- config - Templating failures on config defaults now issue a warning. Previously, failures silently returned an unrendered and untrusted template to the caller.
|
||||||
|
- config - ``ensure_type`` correctly propagates trust and other tags on returned values.
|
||||||
|
- config - ``ensure_type`` now converts mappings to ``dict`` when requested, instead of returning the mapping.
|
||||||
|
- config - ``ensure_type`` now converts sequences to ``list`` when requested, instead of returning the sequence.
|
||||||
|
- config - ``ensure_type`` now correctly errors when ``pathlist`` or ``pathspec`` types encounter non-string list items.
|
||||||
|
- config - ``ensure_type`` now reports an error when ``bytes`` are provided for any known ``value_type``. Previously, the behavior was undefined, but often resulted in an unhandled exception or incorrect return type.
|
||||||
|
- config - ``ensure_type`` with expected type ``int`` now properly converts ``True`` and ``False`` values to ``int``. Previously, these values were silently returned unmodified.
|
||||||
|
- convert_bool.boolean API conversion function - Unhashable values passed to ``boolean`` behave like other non-boolean convertible values, returning False or raising ``TypeError`` depending on the value of ``strict``. Previously, unhashable values always raised ``ValueError`` due to an invalid set membership check.
|
||||||
|
- dnf5 - when ``bugfix`` and/or ``security`` is specified, skip packages that do not have any such updates, even for new versions of libdnf5 where this functionality changed and it is considered failure
|
||||||
|
- plugin loader - Apply template trust to strings loaded from plugin configuration definitions and doc fragments.
|
||||||
|
- template action - Template files where the entire file's output renders as ``None`` are no longer emitted as the string "None", but instead render to an empty file as in previous releases.
|
||||||
|
|
||||||
|
v2.19.0b3
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-05-06
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- ansible-config will now show internal, but not test configuration entries. This allows for debugging but still denoting the configurations as internal use only (_ prefix).
|
||||||
|
- ansible-test - Improved ``pylint`` checks for Ansible-specific deprecation functions.
|
||||||
|
- ansible-test - Use the ``-t`` option to set the stop timeout when stopping a container. This avoids use of the ``--time`` option which was deprecated in Docker v28.0.
|
||||||
|
- collection metadata - The collection loader now parses scalar values from ``meta/runtime.yml`` as strings. This avoids issues caused by unquoted values such as versions or dates being parsed as types other than strings.
|
||||||
|
- deprecation warnings - Deprecation warning APIs automatically capture the identity of the deprecating plugin. The ``collection_name`` argument is only required to correctly attribute deprecations that occur in module_utils or other non-plugin code.
|
||||||
|
- deprecation warnings - Improved deprecation messages to more clearly indicate the affected content, including plugin name when available.
|
||||||
|
- deprecations - Collection name strings not of the form ``ns.coll`` passed to deprecation API functions will result in an error.
|
||||||
|
- deprecations - Removed support for specifying deprecation dates as a ``datetime.date``, which was included in an earlier 2.19 pre-release.
|
||||||
|
- deprecations - Some argument names to ``deprecate_value`` for consistency with existing APIs. An earlier 2.19 pre-release included a ``removal_`` prefix on the ``date`` and ``version`` arguments.
|
||||||
|
- modules - The ``AnsibleModule.deprecate`` function no longer sends deprecation messages to the target host's logging system.
|
||||||
|
|
||||||
|
Deprecated Features
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
- Passing a ``warnings` or ``deprecations`` key to ``exit_json`` or ``fail_json`` is deprecated. Use ``AnsibleModule.warn`` or ``AnsibleModule.deprecate`` instead.
|
||||||
|
- plugins - Accessing plugins with ``_``-prefixed filenames without the ``_`` prefix is deprecated.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Ansible will now ensure predictable permissions on remote artifacts, until now it only ensured executable and relied on system masks for the rest.
|
||||||
|
- dnf5 - avoid generating excessive transaction entries in the dnf5 history (https://github.com/ansible/ansible/issues/85046)
|
||||||
|
|
||||||
|
v2.19.0b2
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-04-24
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- comment filter - Improve the error message shown when an invalid ``style`` argument is provided.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Remove use of `required` parameter in `get_bin_path` which has been deprecated.
|
||||||
|
- ansible-doc - fix indentation for first line of descriptions of suboptions and sub-return values (https://github.com/ansible/ansible/pull/84690).
|
||||||
|
- ansible-doc - fix line wrapping for first line of description of options and return values (https://github.com/ansible/ansible/pull/84690).
|
||||||
|
|
||||||
|
v2.19.0b1
|
||||||
|
=========
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
| Release Date: 2025-04-14
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
|
|
||||||
|
Major Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Jinja plugins - Jinja builtin filter and test plugins are now accessible via their fully-qualified names ``ansible.builtin.{name}``.
|
||||||
|
- Task Execution / Forks - Forks no longer inherit stdio from the parent ``ansible-playbook`` process. ``stdout``, ``stderr``, and ``stdin`` within a worker are detached from the terminal, and non-functional. All needs to access stdio from a fork for controller side plugins requires use of ``Display``.
|
||||||
|
- ansible-test - Packages beneath ``module_utils`` can now contain ``__init__.py`` files.
|
||||||
|
- variables - The type system underlying Ansible's variable storage has been significantly overhauled and formalized. Attempts to store unsupported Python object types in variables now more consistently yields early warnings or errors.
|
||||||
|
- variables - To support new Ansible features, many variable objects are now represented by subclasses of their respective native Python types. In most cases, they behave indistinguishably from their original types, but some Python libraries do not handle builtin object subclasses properly. Custom plugins that interact with such libraries may require changes to convert and pass the native types.
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Added a -vvvvv log message indicating when a host fails to produce output within the timeout period.
|
||||||
|
- AnsibleModule.uri - Add option ``multipart_encoding`` for ``form-multipart`` files in body to change default base64 encoding for files
|
||||||
|
- INVENTORY_IGNORE_EXTS config, removed ``ini`` from the default list, inventory scripts using a corresponding .ini configuration are rare now and inventory.ini files are more common. Those that need to ignore the ini files for inventory scripts can still add it to configuration.
|
||||||
|
- Jinja plugins - Plugins can declare support for undefined values.
|
||||||
|
- Jinja2 version 3.1.0 or later is now required on the controller.
|
||||||
|
- Move ``follow_redirects`` parameter to module_utils so external modules can reuse it.
|
||||||
|
- PlayIterator - do not return tasks from already executed roles so specific strategy plugins do not have to do the filtering of such tasks themselves
|
||||||
|
- SSH Escalation-related -vvv log messages now include the associated host information.
|
||||||
|
- Windows - Add support for Windows Server 2025 to Ansible and as an ``ansible-test`` remote target - https://github.com/ansible/ansible/issues/84229
|
||||||
|
- Windows - refactor the async implementation to better handle errors during bootstrapping and avoid WMI when possible.
|
||||||
|
- ``ansible-galaxy collection install`` — the collection dependency resolver now prints out conflicts it hits during dependency resolution when it's taking too long and it ends up backtracking a lot. It also displays suggestions on how to help it compute the result more quickly.
|
||||||
|
- ansible, ansible-console, ansible-pull - add --flush-cache option (https://github.com/ansible/ansible/issues/83749).
|
||||||
|
- ansible-galaxy - Add support for Keycloak service accounts
|
||||||
|
- ansible-galaxy - support ``resolvelib >= 0.5.3, < 2.0.0`` (https://github.com/ansible/ansible/issues/84217).
|
||||||
|
- ansible-test - Added a macOS 15.3 remote VM, replacing 14.3.
|
||||||
|
- ansible-test - Automatically retry HTTP GET/PUT/DELETE requests on exceptions.
|
||||||
|
- ansible-test - Default to Python 3.13 in the ``base`` and ``default`` containers.
|
||||||
|
- ansible-test - Disable the ``deprecated-`` prefixed ``pylint`` rules as their results vary by Python version.
|
||||||
|
- ansible-test - Disable the ``pep8`` sanity test rules ``E701`` and ``E704`` to improve compatibility with ``black``.
|
||||||
|
- ansible-test - Improve container runtime probe error handling. When unexpected probe output is encountered, an error with more useful debugging information is provided.
|
||||||
|
- ansible-test - Replace container Alpine 3.20 with 3.21.
|
||||||
|
- ansible-test - Replace container Fedora 40 with 41.
|
||||||
|
- ansible-test - Replace remote Alpine 3.20 with 3.21.
|
||||||
|
- ansible-test - Replace remote Fedora 40 with 41.
|
||||||
|
- ansible-test - Replace remote FreeBSD 13.3 with 13.5.
|
||||||
|
- ansible-test - Replace remote FreeBSD 14.1 with 14.2.
|
||||||
|
- ansible-test - Replace remote RHEL 9.4 with 9.5.
|
||||||
|
- ansible-test - Show a more user-friendly error message when a ``runme.sh`` script is not executable.
|
||||||
|
- ansible-test - The ``yamllint`` sanity test now enforces string values for the ``!vault`` tag.
|
||||||
|
- ansible-test - Update ``nios-test-container`` to version 7.0.0.
|
||||||
|
- ansible-test - Update ``pylint`` sanity test to use version 3.3.1.
|
||||||
|
- ansible-test - Update distro containers to remove unnecessary pakages (apache2, subversion, ruby).
|
||||||
|
- ansible-test - Update sanity test requirements to latest available versions.
|
||||||
|
- ansible-test - Update the HTTP test container.
|
||||||
|
- ansible-test - Update the PyPI test container.
|
||||||
|
- ansible-test - Update the ``base`` and ``default`` containers.
|
||||||
|
- ansible-test - Update the utility container.
|
||||||
|
- ansible-test - Use Python's ``urllib`` instead of ``curl`` for HTTP requests.
|
||||||
|
- ansible-test - When detection of the current container network fails, a warning is now issued and execution continues. This simplifies usage in cases where the current container cannot be inspected, such as when running in GitHub Codespaces.
|
||||||
|
- ansible-test acme test container - bump `version to 2.3.0 <https://github.com/ansible/acme-test-container/releases/tag/2.3.0>`__ to include newer versions of Pebble, dependencies, and runtimes. This adds support for ACME profiles, ``dns-account-01`` support, and some smaller improvements (https://github.com/ansible/ansible/pull/84547).
|
||||||
|
- apt_key module - add notes to docs and errors to point at the CLI tool deprecation by Debian and alternatives
|
||||||
|
- apt_repository module - add notes to errors to point at the CLI tool deprecation by Debian and alternatives
|
||||||
|
- become plugins get new property 'pipelining' to show support or lack there of for the feature.
|
||||||
|
- callback plugins - add has_option() to CallbackBase to match other functions overloaded from AnsiblePlugin
|
||||||
|
- callback plugins - fix get_options() for CallbackBase
|
||||||
|
- copy - fix sanity test failures (https://github.com/ansible/ansible/pull/83643).
|
||||||
|
- copy - parameter ``local_follow`` was incorrectly documented as having default value ``True`` (https://github.com/ansible/ansible/pull/83643).
|
||||||
|
- cron - Provide additional error information while writing cron file (https://github.com/ansible/ansible/issues/83223).
|
||||||
|
- csvfile - let the config system do the typecasting (https://github.com/ansible/ansible/pull/82263).
|
||||||
|
- display - Deduplication of warning and error messages considers the full content of the message (including source and traceback contexts, if enabled). This may result in fewer messages being omitted.
|
||||||
|
- distribution - Added openSUSE MicroOS to Suse OS family (#84685).
|
||||||
|
- dnf5, apt - add ``auto_install_module_deps`` option (https://github.com/ansible/ansible/issues/84206)
|
||||||
|
- docs - add collection name in message from which the module is being deprecated (https://github.com/ansible/ansible/issues/84116).
|
||||||
|
- env lookup - The error message generated for a missing environment variable when ``default`` is an undefined value (e.g. ``undef('something')``) will contain the hint from that undefined value, except when the undefined value is the default of ``undef()`` with no arguments. Previously, any existing undefined hint would be ignored.
|
||||||
|
- file - enable file module to disable diff_mode (https://github.com/ansible/ansible/issues/80817).
|
||||||
|
- file - make code more readable and simple.
|
||||||
|
- filter - add support for URL-safe encoding and decoding in b64encode and b64decode (https://github.com/ansible/ansible/issues/84147).
|
||||||
|
- find - add a checksum_algorithm parameter to specify which type of checksum the module will return
|
||||||
|
- from_json filter - The filter accepts a ``profile`` argument, which defaults to ``tagless``.
|
||||||
|
- handlers - Templated handler names with syntax errors, or that resolve to ``omit`` are now skipped like handlers with undefined variables in their name.
|
||||||
|
- improved error message for yaml parsing errors in plugin documentation
|
||||||
|
- local connection plugin - A new ``become_strip_preamble`` config option (default True) was added; disable to preserve diagnostic ``become`` output in task results.
|
||||||
|
- local connection plugin - A new ``become_success_timeout`` operation-wide timeout config (default 10s) was added for ``become``.
|
||||||
|
- local connection plugin - When a ``become`` plugin's ``prompt`` value is a non-string after the ``check_password_prompt`` callback has completed, no prompt stripping will occur on stderr.
|
||||||
|
- lookup_template - add an option to trim blocks while templating (https://github.com/ansible/ansible/issues/75962).
|
||||||
|
- module - set ipv4 and ipv6 rules simultaneously in iptables module (https://github.com/ansible/ansible/issues/84404).
|
||||||
|
- module_utils - Add ``NoReturn`` type annotations to functions which never return.
|
||||||
|
- modules - PowerShell modules can now receive ``datetime.date``, ``datetime.time`` and ``datetime.datetime`` values as ISO 8601 strings.
|
||||||
|
- modules - PowerShell modules can now receive strings sourced from inline vault-encrypted strings.
|
||||||
|
- modules - Unhandled exceptions during Python module execution are now returned as structured data from the target. This allows the new traceback handling to be applied to exceptions raised on targets.
|
||||||
|
- pipelining logic has mostly moved to connection plugins so they can decide/override settings.
|
||||||
|
- plugin error handling - When raising exceptions in an exception handler, be sure to use ``raise ... from`` as appropriate. This supersedes the use of the ``AnsibleError`` arg ``orig_exc`` to represent the cause. Specifying ``orig_exc`` as the cause is still permitted. Failure to use ``raise ... from`` when ``orig_exc`` is set will result in a warning. Additionally, if the two cause exceptions do not match, a warning will be issued.
|
||||||
|
- removed harcoding of su plugin as it now works with pipelining.
|
||||||
|
- runtime-metadata sanity test - improve validation of ``action_groups`` (https://github.com/ansible/ansible/pull/83965).
|
||||||
|
- service_facts module got freebsd support added.
|
||||||
|
- ssh connection plugin - Support ``SSH_ASKPASS`` mechanism to provide passwords, making it the default, but still offering an explicit choice to use ``sshpass`` (https://github.com/ansible/ansible/pull/83936)
|
||||||
|
- ssh connection plugin now overrides pipelining when a tty is requested.
|
||||||
|
- ssh-agent - ``ansible``, ``ansible-playbook`` and ``ansible-console`` are capable of spawning or reusing an ssh-agent, allowing plugins to interact with the ssh-agent. Additionally a pure python ssh-agent client has been added, enabling easy interaction with the agent. The ssh connection plugin contains new functionality via ``ansible_ssh_private_key`` and ``ansible_ssh_private_key_passphrase``, for loading an SSH private key into the agent from a variable.
|
||||||
|
- templating - Access to an undefined variable from inside a lookup, filter, or test (which raises MarkerError) no longer ends processing of the current template. The triggering undefined value is returned as the result of the offending plugin invocation, and the template continues to execute.
|
||||||
|
- templating - Embedding ``range()`` values in containers such as lists will result in an error on use. Previously the value would be converted to a string representing the range parameters, such as ``range(0, 3)``.
|
||||||
|
- templating - Handling of omitted values is now a first-class feature of the template engine, and is usable in all Ansible Jinja template contexts. Any template that resolves to ``omit`` is automatically removed from its parent container during templating.
|
||||||
|
- templating - Template evaluation is lazier than in previous versions. Template expressions which resolve only portions of a data structure no longer result in the entire structure being templated.
|
||||||
|
- templating - Templating errors now provide more information about both the location and context of the error, especially for deeply-nested and/or indirected templating scenarios.
|
||||||
|
- templating - Unified ``omit`` behavior now requires that plugins calling ``Templar.template()`` handle cases where the entire template result is omitted, by catching the ``AnsibleValueOmittedError`` that is raised. Previously, this condition caused a randomly-generated string marker to appear in the template result.
|
||||||
|
- templating - Variables of type ``set`` and ``tuple`` are now converted to ``list`` when exiting the final pass of templating.
|
||||||
|
- to_json / to_nice_json filters - The filters accept a ``profile`` argument, which defaults to ``tagless``.
|
||||||
|
- troubleshooting - Tracebacks can be collected and displayed for most errors, warnings, and deprecation warnings (including those generated by modules). Tracebacks are no longer enabled with ``-vvv``; the behavior is directly configurable via the ``DISPLAY_TRACEBACK`` config option. Module tracebacks passed to ``fail_json`` via the ``exception`` kwarg will not be included in the task result unless error tracebacks are configured.
|
||||||
|
- undef jinja function - The ``undef`` jinja function now raises an error if a non-string hint is given. Attempting to use an undefined hint also results in an error, ensuring incorrect use of the function can be distinguished from the function's normal behavior.
|
||||||
|
- validate-modules sanity test - make sure that ``module`` and ``plugin`` ``seealso`` entries use FQCNs (https://github.com/ansible/ansible/pull/84325).
|
||||||
|
- vault - improved vault filter documentation by adding missing example content for dump_template_data.j2, refining examples for clarity, and ensuring variable consistency (https://github.com/ansible/ansible/issues/83583).
|
||||||
|
- warnings - All warnings (including deprecation warnings) issued during a task's execution are now accessible via the ``warnings`` and ``deprecations`` keys on the task result.
|
||||||
|
- when the ``dict`` lookup is given a non-dict argument, show the value of the argument and its type in the error message.
|
||||||
|
- windows - add hard minimum limit for PowerShell to 5.1. Ansible dropped support for older versions of PowerShell in the 2.16 release but this reqirement is now enforced at runtime.
|
||||||
|
- windows - refactor windows exec runner to improve efficiency and add better error reporting on failures.
|
||||||
|
- winrm - Remove need for pexpect on macOS hosts when using ``kinit`` to retrieve the Kerberos TGT. By default the code will now only use the builtin ``subprocess`` library which should handle issues with select and a high fd count and also simplify the code.
|
||||||
|
|
||||||
|
Breaking Changes / Porting Guide
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
- Support for the ``toml`` library has been removed from TOML inventory parsing and dumping. Use ``tomli`` for parsing on Python 3.10. Python 3.11 and later have built-in support for parsing. Use ``tomli-w`` to support outputting inventory in TOML format.
|
||||||
|
- assert - The ``quiet`` argument must be a commonly-accepted boolean value. Previously, unrecognized values were silently treated as False.
|
||||||
|
- conditionals - Conditional expressions that result in non-boolean values are now an error by default. Such results often indicate unintentional use of templates where they are not supported, resulting in a conditional that is always true. When this option is enabled, conditional expressions which are a literal ``None`` or empty string will evaluate as true, for backwards compatibility. The error can be temporarily changed to a deprecation warning by enabling the ``ALLOW_BROKEN_CONDITIONALS`` config option.
|
||||||
|
- first_found lookup - When specifying ``files`` or ``paths`` as a templated list containing undefined values, the undefined list elements will be discarded with a warning. Previously, the entire list would be discarded without any warning.
|
||||||
|
- internals - The ``AnsibleLoader`` and ``AnsibleDumper`` classes for working with YAML are now factory functions and cannot be extended.
|
||||||
|
- internals - The ``ansible.utils.native_jinja`` Python module has been removed.
|
||||||
|
- inventory - Invalid variable names provided by inventories result in an inventory parse failure. This behavior is now consistent with other variable name usages throughout Ansible.
|
||||||
|
- lookup plugins - Lookup plugins called as `with_(lookup)` will no longer have the `_subdir` attribute set.
|
||||||
|
- lookup plugins - ``terms`` will always be passed to ``run`` as the first positional arg, where previously it was sometimes passed as a keyword arg when using ``with_`` syntax.
|
||||||
|
- loops - Omit placeholders no longer leak between loop item templating and task templating. Previously, ``omit`` placeholders could remain embedded in loop items after templating and be used as an ``omit`` for task templating. Now, values resolving to ``omit`` are dropped immediately when loop items are templated. To turn missing values into an ``omit`` for task templating, use ``| default(omit)``. This solution is backward-compatible with previous versions of ansible-core.
|
||||||
|
- modules - Ansible modules using ``sys.excepthook`` must use a standard ``try/except`` instead.
|
||||||
|
- plugins - Any plugin that sources or creates templates must properly tag them as trusted.
|
||||||
|
- plugins - Custom Jinja plugins that accept undefined top-level arguments must opt in to receiving them.
|
||||||
|
- plugins - Custom Jinja plugins that use ``environment.getitem`` to retrieve undefined values will now trigger a ``MarkerError`` exception. This exception must be handled to allow the plugin to return a ``Marker``, or the plugin must opt-in to accepting ``Marker`` values.
|
||||||
|
- public API - The ``ansible.vars.fact_cache.FactCache`` wrapper has been removed.
|
||||||
|
- serialization of ``omit`` sentinel - Serialization of variables containing ``omit`` sentinels (e.g., by the ``to_json`` and ``to_yaml`` filters or ``ansible-inventory``) will fail if the variable has not completed templating. Previously, serialization succeeded with placeholder strings emitted in the serialized output.
|
||||||
|
- set_fact - The string values "yes", "no", "true" and "false" were previously converted (ignoring case) to boolean values when not using Jinja2 native mode. Since Jinja2 native mode is always used, this conversion no longer occurs. When boolean values are required, native boolean syntax should be used where variables are defined, such as in YAML. When native boolean syntax is not an option, the ``bool`` filter can be used to parse string values into booleans.
|
||||||
|
- template lookup - The ``convert_data`` option is deprecated and no longer has any effect. Use the ``from_json`` filter on the lookup result instead.
|
||||||
|
- templating - Access to ``_`` prefixed attributes and methods, and methods with known side effects, is no longer permitted. In cases where a matching mapping key is present, the associated value will be returned instead of an error. This increases template environment isolation and ensures more consistent behavior between the ``.`` and ``[]`` operators.
|
||||||
|
- templating - Conditionals and lookups which use embedded inline templates in Jinja string constants now display a warning. These templates should be converted to their expression equivalent.
|
||||||
|
- templating - Many Jinja plugins (filters, lookups, tests) and methods previously silently ignored undefined inputs, which often masked subtle errors. Passing an undefined argument to a Jinja plugin or method that does not declare undefined support now results in an undefined value.
|
||||||
|
- templating - Templates are always rendered in Jinja2 native mode. As a result, non-string values are no longer automatically converted to strings.
|
||||||
|
- templating - Templates resulting in ``None`` are no longer automatically converted to an empty string.
|
||||||
|
- templating - Templates with embedded inline templates that were not contained within a Jinja string constant now result in an error, as support for multi-pass templating was removed for security reasons. In most cases, such templates can be easily rewritten to avoid the use of embedded inline templates.
|
||||||
|
- templating - The ``allow_unsafe_lookups`` option no longer has any effect. Lookup plugins are responsible for tagging strings containing templates to allow evaluation as a template.
|
||||||
|
- templating - The result of the ``range()`` global function cannot be returned from a template- it should always be passed to a filter (e.g., ``random``). Previously, range objects returned from an intermediate template were always converted to a list, which is inconsistent with inline consumption of range objects.
|
||||||
|
- templating - ``#jinja2:`` overrides in templates with invalid override names or types are now templating errors.
|
||||||
|
|
||||||
|
Deprecated Features
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
- CLI - The ``--inventory-file`` option alias is deprecated. Use the ``-i`` or ``--inventory`` option instead.
|
||||||
|
- Stategy Plugins - Use of strategy plugins not provided in ``ansible.builtin`` are deprecated and do not carry any backwards compatibility guarantees going forward. A future release will remove the ability to use external strategy plugins. No alternative for third party strategy plugins is currently planned.
|
||||||
|
- ``ansible.module_utils.compat.datetime`` - The datetime compatibility shims are now deprecated. They are scheduled to be removed in ``ansible-core`` v2.21. This includes ``UTC``, ``utcfromtimestamp()`` and ``utcnow`` importable from said module (https://github.com/ansible/ansible/pull/81874).
|
||||||
|
- bool filter - Support for coercing unrecognized input values (including None) has been deprecated. Consult the filter documentation for acceptable values, or consider use of the ``truthy`` and ``falsy`` tests.
|
||||||
|
- cache plugins - The `ansible.plugins.cache.base` Python module is deprecated. Use `ansible.plugins.cache` instead.
|
||||||
|
- callback plugins - The `v2_on_any` callback method is deprecated. Use specific callback methods instead.
|
||||||
|
- callback plugins - The v1 callback API (callback methods not prefixed with `v2_`) is deprecated. Use `v2_` prefixed methods instead.
|
||||||
|
- conditionals - Conditionals using Jinja templating delimiters (e.g., ``{{``, ``{%``) should be rewritten as expressions without delimiters, unless the entire conditional value is a single template that resolves to a trusted string expression. This is useful for dynamic indirection of conditional expressions, but is limited to trusted literal string expressions.
|
||||||
|
- config - The ``ACTION_WARNINGS`` config has no effect. It previously disabled command warnings, which have since been removed.
|
||||||
|
- config - The ``DEFAULT_JINJA2_NATIVE`` option has no effect. Jinja2 native mode is now the default and only option.
|
||||||
|
- config - The ``DEFAULT_NULL_REPRESENTATION`` option has no effect. Null values are no longer automatically converted to another value during templating of single variable references.
|
||||||
|
- display - The ``Display.get_deprecation_message`` method has been deprecated. Call ``Display.deprecated`` to display a deprecation message, or call it with ``removed=True`` to raise an ``AnsibleError``.
|
||||||
|
- file loading - Loading text files with ``DataLoader`` containing data that cannot be decoded under the expected encoding is deprecated. In most cases the encoding must be UTF-8, although some plugins allow choosing a different encoding. Previously, invalid data was silently wrapped in Unicode surrogate escape sequences, often resulting in later errors or other data corruption.
|
||||||
|
- first_found lookup - Splitting of file paths on ``,;:`` is deprecated. Pass a list of paths instead. The ``split`` method on strings can be used to split variables into a list as needed.
|
||||||
|
- interpreter discovery - The ``auto_legacy`` and ``auto_legacy_silent`` options for ``INTERPRETER_PYTHON`` are deprecated. Use ``auto`` or ``auto_silent`` options instead, as they have the same effect.
|
||||||
|
- oneline callback - The ``oneline`` callback and its associated ad-hoc CLI args (``-o``, ``--one-line``) are deprecated.
|
||||||
|
- paramiko - The paramiko connection plugin has been deprecated with planned removal in 2.21.
|
||||||
|
- playbook variables - The ``play_hosts`` variable has been deprecated, use ``ansible_play_batch`` instead.
|
||||||
|
- plugin error handling - The ``AnsibleError`` constructor arg ``suppress_extended_error`` is deprecated. Using ``suppress_extended_error=True`` has the same effect as ``show_content=False``.
|
||||||
|
- template lookup - The jinja2_native option is no longer used in the Ansible Core code base. Jinja2 native mode is now the default and only option.
|
||||||
|
- templating - Support for enabling Jinja2 extensions (not plugins) has been deprecated.
|
||||||
|
- templating - The ``disable_lookups`` option has no effect, since plugins must be updated to apply trust before any templating can be performed.
|
||||||
|
- tree callback - The ``tree`` callback and its associated ad-hoc CLI args (``-t``, ``--tree``) are deprecated.
|
||||||
|
|
||||||
|
Removed Features (previously deprecated)
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
- Remove deprecated plural form of collection path (https://github.com/ansible/ansible/pull/84156).
|
||||||
|
- Removed deprecated STRING_CONVERSION_ACTION (https://github.com/ansible/ansible/issues/84220).
|
||||||
|
- encrypt - passing unsupported passlib hashtype now raises AnsibleFilterError.
|
||||||
|
- manager - remove deprecated include_delegate_to parameter from get_vars API.
|
||||||
|
- modules - Modules returning non-UTF8 strings now result in an error. The ``MODULE_STRICT_UTF8_RESPONSE`` setting can be used to disable this check.
|
||||||
|
- removed deprecated pycompat24 and compat.importlib.
|
||||||
|
- selector - remove deprecated compat.selector related files (https://github.com/ansible/ansible/pull/84155).
|
||||||
|
- windows - removed common module functions ``ConvertFrom-AnsibleJson``, ``Format-AnsibleException`` from Windows modules as they are not used and add uneeded complexity to the code.
|
||||||
|
|
||||||
|
Security Fixes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
- include_vars action - Ensure that result masking is correctly requested when vault-encrypted files are read. (CVE-2024-8775)
|
||||||
|
- task result processing - Ensure that action-sourced result masking (``_ansible_no_log=True``) is preserved. (CVE-2024-8775)
|
||||||
|
- templating - Ansible's template engine no longer processes Jinja templates in strings unless they are marked as coming from a trusted source. Untrusted strings containing Jinja template markers are ignored with a warning. Examples of trusted sources include playbooks, vars files, and many inventory sources. Examples of untrusted sources include module results and facts. Plugins which have not been updated to preserve trust while manipulating strings may inadvertently cause them to lose their trusted status.
|
||||||
|
- templating - Changes to conditional expression handling removed numerous instances of insecure multi-pass templating (which could result in execution of untrusted template expressions).
|
||||||
|
- user action won't allow ssh-keygen, chown and chmod to run on existing ssh public key file, avoiding traversal on existing symlinks (CVE-2024-9902).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Ansible will now also warn when reserved keywords are set via a module (set_fact, include_vars, etc).
|
||||||
|
- Ansible.Basic - Fix ``required_if`` check when the option value to check is unset or set to null.
|
||||||
|
- Correctly return ``False`` when using the ``filter`` and ``test`` Jinja tests on plugin names which are not filters or tests, respectively. (resolves issue https://github.com/ansible/ansible/issues/82084)
|
||||||
|
- Do not run implicit ``flush_handlers`` meta tasks when the whole play is excluded from the run due to tags specified.
|
||||||
|
- Errors now preserve stacked error messages even when YAML is involved.
|
||||||
|
- Fix a display.debug statement with the wrong param in _get_diff_data() method
|
||||||
|
- Fix disabling SSL verification when installing collections and roles from git repositories. If ``--ignore-certs`` isn't provided, the value for the ``GALAXY_IGNORE_CERTS`` configuration option will be used (https://github.com/ansible/ansible/issues/83326).
|
||||||
|
- Fix ipv6 pattern bug in lib/ansible/parsing/utils/addresses.py (https://github.com/ansible/ansible/issues/84237)
|
||||||
|
- Fix returning 'unreachable' for the overall task result. This prevents false positives when a looped task has unignored unreachable items (https://github.com/ansible/ansible/issues/84019).
|
||||||
|
- Implicit ``meta: flush_handlers`` tasks now have a parent block to prevent potential tracebacks when calling methods like ``get_play()`` on them internally.
|
||||||
|
- Improve performance on large inventories by reducing the number of implicit meta tasks.
|
||||||
|
- Jinja plugins - Errors raised will always be derived from ``AnsibleTemplatePluginError``.
|
||||||
|
- Optimize the way tasks from within ``include_tasks``/``include_role`` are inserted into the play.
|
||||||
|
- Time out waiting on become is an unreachable error (https://github.com/ansible/ansible/issues/84468)
|
||||||
|
- Use consistent multiprocessing context for action write locks
|
||||||
|
- Use the requested error message in the ansible.module_utils.facts.timeout timeout function instead of hardcoding one.
|
||||||
|
- Windows - add support for running on system where WDAC is in audit mode with ``Dynamic Code Security`` enabled.
|
||||||
|
- YAML parsing - The `!unsafe` tag no longer coerces non-string scalars to strings.
|
||||||
|
- ``ansible-galaxy`` — the collection dependency resolver now treats version specifiers starting with ``!=`` as unpinned.
|
||||||
|
- ``package``/``dnf`` action plugins - provide the reason behind the failure to gather the ``ansible_pkg_mgr`` fact to identify the package backend
|
||||||
|
- action plugins - Action plugins that raise unhandled exceptions no longer terminate playbook loops. Previously, exceptions raised by an action plugin caused abnormal loop termination and loss of loop iteration results.
|
||||||
|
- ansible-config - format galaxy server configs while dumping in JSON format (https://github.com/ansible/ansible/issues/84840).
|
||||||
|
- ansible-doc - If none of the files in files exists, path will be undefined and a direct reference will throw an UnboundLocalError (https://github.com/ansible/ansible/pull/84464).
|
||||||
|
- ansible-galaxy - Small adjustments to URL building for ``download_url`` and relative redirects.
|
||||||
|
- ansible-pull change detection will now work independently of callback or result format settings.
|
||||||
|
- ansible-test - Enable the ``sys.unraisablehook`` work-around for the ``pylint`` sanity test on Python 3.11. Previously the work-around was only enabled for Python 3.12 and later. However, the same issue has been discovered on Python 3.11.
|
||||||
|
- ansible-test - Ensure CA certificates are installed on managed FreeBSD instances.
|
||||||
|
- ansible-test - Fix support for PowerShell module_util imports with the ``-Optional`` flag.
|
||||||
|
- ansible-test - Fix support for detecting PowerShell modules importing module utils with the newer ``#AnsibleRequires`` format.
|
||||||
|
- ansible-test - Fix traceback that occurs after an interactive command fails.
|
||||||
|
- ansible-test - Fix up coverage reporting to properly translate the temporary path of integration test modules to the expected static test module path.
|
||||||
|
- ansible-test - Fixed traceback when handling certain YAML errors in the ``yamllint`` sanity test.
|
||||||
|
- ansible-test - Managed macOS instances now use the ``sudo_chdir`` option for the ``sudo`` become plugin to avoid permission errors when dropping privileges.
|
||||||
|
- ansible-vault will now correctly handle `--prompt`, previously it would issue an error about stdin if no 2nd argument was passed
|
||||||
|
- ansible_uptime_second - added ansible_uptime_seconds fact support for AIX (https://github.com/ansible/ansible/pull/84321).
|
||||||
|
- apt_key module - prevent tests from running when apt-key was removed
|
||||||
|
- base.yml - deprecated libvirt_lxc_noseclabel config.
|
||||||
|
- build - Pin ``wheel`` in ``pyproject.toml`` to ensure compatibility with supported ``setuptools`` versions.
|
||||||
|
- config - various fixes to config lookup plugin (https://github.com/ansible/ansible/pull/84398).
|
||||||
|
- copy - refactor copy module for simplicity.
|
||||||
|
- copy action now prevents user from setting internal options.
|
||||||
|
- debconf - set empty password values (https://github.com/ansible/ansible/issues/83214).
|
||||||
|
- debug - hide loop vars in debug var display (https://github.com/ansible/ansible/issues/65856).
|
||||||
|
- default callback - Error context is now shown for failing tasks that use the ``debug`` action.
|
||||||
|
- display - The ``Display.deprecated`` method once again properly handles the ``removed=True`` argument (https://github.com/ansible/ansible/issues/82358).
|
||||||
|
- distro - add support for Linux Mint Debian Edition (LMDE) (https://github.com/ansible/ansible/issues/84934).
|
||||||
|
- distro - detect Debian as os_family for LMDE 6 (https://github.com/ansible/ansible/issues/84934).
|
||||||
|
- dnf5 - Handle forwarded exceptions from dnf5-5.2.13 where a generic ``RuntimeError`` was previously raised
|
||||||
|
- dnf5 - fix ``is_installed`` check for packages that are not installed but listed as provided by an installed package (https://github.com/ansible/ansible/issues/84578)
|
||||||
|
- dnf5 - fix installing a package using ``state=latest`` when a binary of the same name as the package is already installed (https://github.com/ansible/ansible/issues/84259)
|
||||||
|
- dnf5 - fix traceback when ``enable_plugins``/``disable_plugins`` is used on ``python3-libdnf5`` versions that do not support this functionality
|
||||||
|
- dnf5 - libdnf5 - use ``conf.pkg_gpgcheck`` instead of deprecated ``conf.gpgcheck`` which is used only as a fallback
|
||||||
|
- dnf5 - matching on a binary can be achieved only by specifying a full path (https://github.com/ansible/ansible/issues/84334)
|
||||||
|
- facts - gather pagesize and calculate respective values depending upon architecture (https://github.com/ansible/ansible/issues/84773).
|
||||||
|
- facts - skip if distribution file path is directory, instead of raising error (https://github.com/ansible/ansible/issues/84006).
|
||||||
|
- find - skip ENOENT error code while recursively enumerating files. find module will now be tolerant to race conditions that remove files or directories from the target it is currently inspecting. (https://github.com/ansible/ansible/issues/84873).
|
||||||
|
- first_found lookup - Corrected return value documentation to reflect None (not empty string) for no files found.
|
||||||
|
- gather_facts action now defaults to `ansible.legacy.setup` if `smart` was set, no network OS was found and no other alias for `setup` was present.
|
||||||
|
- gather_facts action will now issues errors and warnings as appropriate if a network OS is detected but no facts modules are defined for it.
|
||||||
|
- gather_facts action, will now add setup when 'smart' appears with other modules in the FACTS_MODULES setting (#84750).
|
||||||
|
- get_url - add support for BSD-style checksum digest file (https://github.com/ansible/ansible/issues/84476).
|
||||||
|
- get_url - fix honoring ``filename`` from the ``content-disposition`` header even when the type is ``inline`` (https://github.com/ansible/ansible/issues/83690)
|
||||||
|
- host_group_vars - fixed defining the 'key' variable if the get_vars method is called with cache=False (https://github.com/ansible/ansible/issues/84384)
|
||||||
|
- include_vars - fix including previously undefined hash variables with hash_behaviour merge (https://github.com/ansible/ansible/issues/84295).
|
||||||
|
- iptables - Allows the wait parameter to be used with iptables chain creation (https://github.com/ansible/ansible/issues/84490)
|
||||||
|
- linear strategy - fix executing ``end_role`` meta tasks for each host, instead of handling these as implicit run_once tasks (https://github.com/ansible/ansible/issues/84660).
|
||||||
|
- local connection plugin - Become timeout errors now include all received data. Previously, the most recently-received data was discarded.
|
||||||
|
- local connection plugin - Ensure ``become`` success validation always occurs, even when an active plugin does not set ``prompt``.
|
||||||
|
- local connection plugin - Fixed cases where the internal ``BECOME-SUCCESS`` message appeared in task output.
|
||||||
|
- local connection plugin - Fixed hang or spurious failure when data arrived concurrently on stdout and stderr during a successful ``become`` operation validation.
|
||||||
|
- local connection plugin - Fixed hang when a become plugin expects a prompt but a password was not provided.
|
||||||
|
- local connection plugin - Fixed hang when an active become plugin incorrectly signals lack of prompt.
|
||||||
|
- local connection plugin - Fixed hang when an internal become read timeout expired before the password prompt was written.
|
||||||
|
- local connection plugin - Fixed hang when only one of stdout or stderr was closed by the ``become_exe`` subprocess.
|
||||||
|
- local connection plugin - Fixed long timeout/hang for ``become`` plugins that repeat their prompt on failure (e.g., ``sudo``, some ``su`` implementations).
|
||||||
|
- local connection plugin - Fixed silent ignore of ``become`` failures and loss of task output when data arrived concurrently on stdout and stderr during ``become`` operation validation.
|
||||||
|
- local connection plugin - Fixed task output header truncation when post-become data arrived before ``become`` operation validation had completed.
|
||||||
|
- lookup plugins - The ``terms`` arg to the ``run`` method is now always a list. Previously, there were cases where a non-list could be received.
|
||||||
|
- module arg templating - When using a templated raw task arg and a templated ``args`` keyword, args are now merged. Previously use of templated raw task args silently ignored all values from the templated ``args`` keyword.
|
||||||
|
- module defaults - Module defaults are no longer templated unless they are used by a task that does not override them. Previously, all module defaults for all modules were templated for every task.
|
||||||
|
- module respawn - limit to supported Python versions
|
||||||
|
- package_facts module when using 'auto' will return the first package manager found that provides an output, instead of just the first one, as this can be foreign and not have any packages.
|
||||||
|
- psrp - Improve stderr parsing when running raw commands that emit error records or stderr lines.
|
||||||
|
- regex_search filter - Corrected return value documentation to reflect None (not empty string) for no match.
|
||||||
|
- respawn - use copy of env variables to update existing PYTHONPATH value (https://github.com/ansible/ansible/issues/84954).
|
||||||
|
- runas become - Fix up become logic to still get the SYSTEM token with the most privileges when running as SYSTEM.
|
||||||
|
- sequence lookup - sequence query/lookups without positional arguments now return a valid list if their kwargs comprise a valid sequence expression (https://github.com/ansible/ansible/issues/82921).
|
||||||
|
- service_facts - skip lines which does not contain service names in openrc output (https://github.com/ansible/ansible/issues/84512).
|
||||||
|
- ssh - Improve the logic for parsing CLIXML data in stderr when working with Windows host. This fixes issues when the raw stderr contains invalid UTF-8 byte sequences and improves embedded CLIXML sequences.
|
||||||
|
- ssh - Raise exception when sshpass returns error code (https://github.com/ansible/ansible/issues/58133).
|
||||||
|
- ssh - connection options were incorrectly templated during ``reset_connection`` tasks (https://github.com/ansible/ansible/pull/84238).
|
||||||
|
- stability - Fixed silent process failure on unhandled IOError/OSError under ``linear`` strategy.
|
||||||
|
- su become plugin - Ensure generated regex from ``prompt_l10n`` config values is properly escaped.
|
||||||
|
- su become plugin - Ensure that password prompts are correctly detected in the presence of leading output. Previously, this case resulted in a timeout or hang.
|
||||||
|
- su become plugin - Ensure that trailing colon is expected on all ``prompt_l10n`` config values.
|
||||||
|
- sudo become plugin - The `sudo_chdir` config option allows the current directory to be set to the specified value before executing sudo to avoid permission errors when dropping privileges.
|
||||||
|
- sunos - remove hard coding of virtinfo command in facts gathering code (https://github.com/ansible/ansible/pull/84357).
|
||||||
|
- to_yaml/to_nice_yaml filters - Eliminated possibility of keyword arg collisions with internally-set defaults.
|
||||||
|
- unarchive - Clamp timestamps from beyond y2038 to representible values when unpacking zip files on platforms that use 32-bit time_t (e.g. Debian i386).
|
||||||
|
- uri - Form location correctly when the server returns a relative redirect (https://github.com/ansible/ansible/issues/84540)
|
||||||
|
- uri - Handle HTTP exceptions raised while reading the content (https://github.com/ansible/ansible/issues/83794).
|
||||||
|
- uri - mark ``url`` as required (https://github.com/ansible/ansible/pull/83642).
|
||||||
|
- user - Create Buildroot subclass as alias to Busybox (https://github.com/ansible/ansible/issues/83665).
|
||||||
|
- user - Set timeout for passphrase interaction.
|
||||||
|
- user - Update prompt for SSH key passphrase (https://github.com/ansible/ansible/issues/84484).
|
||||||
|
- user - Use higher precedence HOME_MODE as UMASK for path provided (https://github.com/ansible/ansible/pull/84482).
|
||||||
|
- user action will now require O(force) to overwrite the public part of an ssh key when generating ssh keys, as was already the case for the private part.
|
||||||
|
- user module now avoids changing ownership of files symlinked in provided home dir skeleton
|
||||||
|
- vars lookup - The ``default`` substitution only applies when trying to look up a variable which is not defined. If the variable is defined, but templates to an undefined value, the ``default`` substitution will not apply. Use the ``default`` filter to coerce those values instead.
|
||||||
|
- wait_for_connection - a warning was displayed if any hosts used a local connection (https://github.com/ansible/ansible/issues/84419)
|
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-04-14
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-04-24
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-05-06
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-05-12
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-06-03
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
release_summary: |
|
||||||
|
| Release Date: 2025-06-11
|
||||||
|
| `Porting Guide <https://docs.ansible.com/ansible-core/2.19/porting_guides/porting_guide_core_2.19.html>`__
|
||||||
@ -1,2 +1,2 @@
|
|||||||
bugfixes:
|
bugfixes:
|
||||||
- iptables - Allows the wait paramater to be used with iptables chain creation (https://github.com/ansible/ansible/issues/84490)
|
- iptables - Allows the wait parameter to be used with iptables chain creation (https://github.com/ansible/ansible/issues/84490)
|
||||||
|
|||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- "dnf5 - handle all libdnf5 specific exceptions (https://github.com/ansible/ansible/issues/84634)"
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
bugfixes:
|
||||||
|
- "ansible-doc - fix indentation for first line of descriptions of suboptions and sub-return values (https://github.com/ansible/ansible/pull/84690)."
|
||||||
|
- "ansible-doc - fix line wrapping for first line of description of options and return values (https://github.com/ansible/ansible/pull/84690)."
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- get_url - add a check to recognize incomplete data transfers.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- include_tasks - fix templating options when used as a handler (https://github.com/ansible/ansible/pull/85015).
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- dnf5 - avoid generating excessive transaction entries in the dnf5 history (https://github.com/ansible/ansible/issues/85046)
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- facts - add "CloudStack KVM Hypervisor" for Linux VM in virtual facts (https://github.com/ansible/ansible/issues/85089).
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- facts - add "Linode" for Linux VM in virtual facts
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- ansible-doc will no longer ignore docs for modules without an extension (https://github.com/ansible/ansible/issues/85279).
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansiballz - Refactored AnsiballZ and module respawn.
|
||||||
|
- ansiballz - Added support for AnsiballZ extensions.
|
||||||
|
- ansiballz - Moved AnsiballZ code coverage support into an extension.
|
||||||
|
- ansiballz - Added an experimental AnsiballZ extension for remote debugging.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansible-doc - Return dynamic stub when reporting on Jinja filters and tests not explicitly documented in Ansible
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansible-doc - Skip listing the internal ``ansible._protomatter`` plugins unless explicitly requested
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansible-test - Use the ``-t`` option to set the stop timeout when stopping a container.
|
||||||
|
This avoids use of the ``--time`` option which was deprecated in Docker v28.0.
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
bugfixes:
|
||||||
|
- ansible-test - Fix incorrect handling of options with optional args (e.g. ``--color``),
|
||||||
|
when followed by other options which are omitted during arg filtering (e.g. ``--docker``).
|
||||||
|
Previously it was possible for non-option arguments to be incorrectly omitted in these cases.
|
||||||
|
(https://github.com/ansible/ansible/issues/85173)
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- ansible-test - Updated the ``pylint`` sanity test to skip some deprecation validation checks when all arguments are dynamic.
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
bugfixes:
|
||||||
|
- ansible-test - Improve type inference for pylint deprecated checks to accommodate some type annotations.
|
||||||
|
- ansible-test - Disabled the ``bad-super-call`` pylint rule due to false positives.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansible-test - Add RHEL 10.0 as a remote platform for testing.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- "apt_repository - remove Python 2 support"
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- async_status module - The ``started`` and ``finished`` return values are now ``True`` or ``False`` instead of ``1`` or ``0``.
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
minor_changes:
|
||||||
|
- comment filter - Improve the error message shown when an invalid ``style`` argument is provided.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ansible-config will now show internal, but not test configuration entries. This allows for debugging but still denoting the configurations as internal use only (_ prefix).
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
bugfixes:
|
||||||
|
- >-
|
||||||
|
constructed inventory - Use the ``default_value`` or ``trailing_separator`` in a ``keyed_groups`` entry if the expression result of ``key``
|
||||||
|
is ``None`` and not just an empty string.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
deprecated_features:
|
||||||
|
- "``ansible.compat.importlib_resources`` is deprecated and will be removed in ansible-core 2.23. Use ``importlib.resources`` from the Python standard library instead."
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
deprecated_features:
|
||||||
|
- "The ``ShellModule.checksum`` method is now deprecated and will be removed in ansible-core 2.23. Use ``ActionBase._execute_remote_stat()`` instead."
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
minor_changes:
|
||||||
|
- modules - The ``AnsibleModule.deprecate`` function no longer sends deprecation messages to the target host's logging system.
|
||||||
|
- ansible-test - Improved ``pylint`` checks for Ansible-specific deprecation functions.
|
||||||
|
- deprecations - Removed support for specifying deprecation dates as a ``datetime.date``, which was included in an earlier 2.19 pre-release.
|
||||||
|
- deprecations - Some argument names to ``deprecate_value`` for consistency with existing APIs.
|
||||||
|
An earlier 2.19 pre-release included a ``removal_`` prefix on the ``date`` and ``version`` arguments.
|
||||||
|
- deprecations - Collection name strings not of the form ``ns.coll`` passed to deprecation API functions will result in an error.
|
||||||
|
- collection metadata - The collection loader now parses scalar values from ``meta/runtime.yml`` as strings.
|
||||||
|
This avoids issues caused by unquoted values such as versions or dates being parsed as types other than strings.
|
||||||
|
- deprecation warnings - Deprecation warning APIs automatically capture the identity of the deprecating plugin.
|
||||||
|
The ``collection_name`` argument is only required to correctly attribute deprecations that occur in module_utils or other non-plugin code.
|
||||||
|
- deprecation warnings - Improved deprecation messages to more clearly indicate the affected content, including plugin name when available.
|
||||||
|
|
||||||
|
deprecated_features:
|
||||||
|
- plugins - Accessing plugins with ``_``-prefixed filenames without the ``_`` prefix is deprecated.
|
||||||
|
- Passing a ``warnings` or ``deprecations`` key to ``exit_json`` or ``fail_json`` is deprecated.
|
||||||
|
Use ``AnsibleModule.warn`` or ``AnsibleModule.deprecate`` instead.
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
minor_changes:
|
||||||
|
- Improved SUSE distribution detection in distribution.py by parsing VARIANT_ID from /etc/os-release
|
||||||
|
for identifying SLES_SAP and SL-Micro. Falls back to /etc/products.d/baseproduct symlink for older systems.
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
minor_changes:
|
||||||
|
- display - Replace Windows newlines (``\r\n``) in display output with Unix newlines (``\n``).
|
||||||
|
This ensures proper display of strings sourced from Windows hosts in environments which treat ``\r`` as ``\n``,
|
||||||
|
such as Azure Pipelines.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- "dnf5 - when ``bugfix`` and/or ``security`` is specified, skip packages that do not have any such updates, even for new versions of libdnf5 where this functionality changed and it is considered failure"
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- Ansible will now ensure predictable permissions on remote artifacts, until now it only ensured executable and relied on system masks for the rest.
|
||||||
@ -0,0 +1,15 @@
|
|||||||
|
bugfixes:
|
||||||
|
- config - ``ensure_type`` correctly propagates trust and other tags on returned values.
|
||||||
|
- config - Prevented fatal errors when ``MODULE_IGNORE_EXTS`` configuration was set.
|
||||||
|
- config - ``ensure_type`` with expected type ``int`` now properly converts ``True`` and ``False`` values to ``int``.
|
||||||
|
Previously, these values were silently returned unmodified.
|
||||||
|
- config - ``ensure_type`` now reports an error when ``bytes`` are provided for any known ``value_type``.
|
||||||
|
Previously, the behavior was undefined, but often resulted in an unhandled exception or incorrect return type.
|
||||||
|
- config - ``ensure_type`` now converts sequences to ``list`` when requested, instead of returning the sequence.
|
||||||
|
- config - ``ensure_type`` now converts mappings to ``dict`` when requested, instead of returning the mapping.
|
||||||
|
- config - ``ensure_type`` now correctly errors when ``pathlist`` or ``pathspec`` types encounter non-string list items.
|
||||||
|
- config - Templating failures on config defaults now issue a warning.
|
||||||
|
Previously, failures silently returned an unrendered and untrusted template to the caller.
|
||||||
|
- convert_bool.boolean API conversion function - Unhashable values passed to ``boolean`` behave like other non-boolean convertible values,
|
||||||
|
returning False or raising ``TypeError`` depending on the value of ``strict``.
|
||||||
|
Previously, unhashable values always raised ``ValueError`` due to an invalid set membership check.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- from_yaml_all filter - `None` and empty string inputs now always return an empty list. Previously, `None` was returned in Jinja native mode and empty list in classic mode.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- "Remove use of `required` parameter in `get_bin_path` which has been deprecated."
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- "Use ``importlib.metadata.version()`` to detect Jinja version as jinja2.__version__ is deprecated and will be removed in Jinja 3.3."
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- local connection plugin - The command-line used to create subprocesses is now always ``str`` to avoid issues with debuggers and profilers.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- "csvfile lookup - remove Python 2 compat"
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
bugfixes:
|
||||||
|
- templating - Jinja macros returned from a template expression can now be called from another template expression.
|
||||||
|
- templating - Fixed cases where template expression blocks halted prematurely when a Jinja macro invocation returned an undefined value.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
deprecated_features:
|
||||||
|
- "The ``ansible.module_utils.common.collections.count()`` function is deprecated and will be removed in ansible-core 2.23. Use ``collections.Counter()`` from the Python standard library instead."
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
minor_changes:
|
||||||
|
- module_utils - Add optional ``help_text`` argument to ``AnsibleModule.warn``.
|
||||||
|
- module_utils - Add ``AnsibleModule.error_as_warning``.
|
||||||
|
- module_utils - Add ``ansible.module_utils.common.warnings.error_as_warning``.
|
||||||
|
- display - Add ``help_text`` and ``obj`` to ``Display.error_as_warning``.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- plugin loader - Apply template trust to strings loaded from plugin configuration definitions and doc fragments.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- display - Fix hang caused by early post-fork writers to stdout/stderr (e.g., pydevd) encountering an unreleased fork lock.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- config - Preserve or apply Origin tag to values returned by config.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- "modules - use ``AnsibleModule.warn`` instead of passing ``warnings`` to ``exit_json`` or ``fail_json`` which is deprecated."
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- templating - Added ``_ANSIBLE_TEMPLAR_SANDBOX_MODE=allow_unsafe_attributes`` environment variable to disable Jinja template attribute sandbox. (https://github.com/ansible/ansible/issues/85202)
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
bugfixes:
|
||||||
|
- ssh agent - Fixed several potential startup hangs for badly-behaved or overloaded ssh agents.
|
||||||
|
minor_changes:
|
||||||
|
- ssh agent - Added ``SSH_AGENT_EXECUTABLE`` config to allow override of ssh-agent.
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
minor_changes:
|
||||||
|
- ssh connection plugin - Added ``verbosity`` config to decouple SSH debug output verbosity from Ansible verbosity.
|
||||||
|
Previously, the Ansible verbosity value was always applied to the SSH client command-line, leading to excessively verbose output.
|
||||||
|
Set the ``ANSIBLE_SSH_VERBOSITY`` envvar or ``ansible_ssh_verbosity`` Ansible variable to a positive integer to increase SSH client verbosity.
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
bugfixes:
|
||||||
|
- task timeout - Specifying a negative task timeout now results in an error.
|
||||||
|
- error handling - Error details and tracebacks from connection and built-in action exceptions are preserved.
|
||||||
|
Previously, much of the detail was lost or mixed into the error message.
|
||||||
|
|
||||||
|
minor_changes:
|
||||||
|
- task timeout - Specifying a timeout greater than 100,000,000 now results in an error.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- template action - Template files where the entire file's output renders as ``None`` are no longer emitted as the string "None", but instead render to an empty file as in previous releases.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
bugfixes:
|
||||||
|
- Fix templating ``tags`` on plays and roles. (https://github.com/ansible/ansible/issues/69903)
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
bugfixes:
|
||||||
|
- Core Jinja test plugins - Builtin test plugins now always return ``bool`` to avoid spurious deprecation warnings for
|
||||||
|
some malformed inputs.
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
minor_changes:
|
||||||
|
- template action and lookup plugin - The value of the ``ansible_managed`` variable (if set) will not be masked by the ``template`` action and lookup.
|
||||||
|
Previously, the value calculated by the ``DEFAULT_MANAGED_STR`` configuration option always masked the variable value during plugin execution, preventing runtime customization.
|
||||||
@ -0,0 +1,2 @@
|
|||||||
|
minor_changes:
|
||||||
|
- Remove unnecessary shebang from the ``hostname`` module.
|
||||||
@ -0,0 +1,9 @@
|
|||||||
|
minor_changes:
|
||||||
|
- >-
|
||||||
|
windows - Added support for ``#AnsibleRequires -Wrapper`` to request a PowerShell module be run through the
|
||||||
|
execution wrapper scripts without any module utils specified.
|
||||||
|
- >-
|
||||||
|
windows - Added support for running signed modules and scripts with a Windows host protected by Windows App
|
||||||
|
Control/WDAC. This is a tech preview and the interface may be subject to change.
|
||||||
|
- >-
|
||||||
|
windows - Script modules will preserve UTF-8 encoding when executing the script.
|
||||||
@ -0,0 +1,101 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import dataclasses
|
||||||
|
import json
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
|
||||||
|
from ansible.module_utils._internal._ansiballz import _extensions
|
||||||
|
from ansible.module_utils._internal._ansiballz._extensions import _pydevd, _coverage
|
||||||
|
from ansible.constants import config
|
||||||
|
|
||||||
|
_T = t.TypeVar('_T')
|
||||||
|
|
||||||
|
|
||||||
|
class ExtensionManager:
|
||||||
|
"""AnsiballZ extension manager."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
debugger: _pydevd.Options | None = None,
|
||||||
|
coverage: _coverage.Options | None = None,
|
||||||
|
) -> None:
|
||||||
|
options = dict(
|
||||||
|
_pydevd=debugger,
|
||||||
|
_coverage=coverage,
|
||||||
|
)
|
||||||
|
|
||||||
|
self._debugger = debugger
|
||||||
|
self._coverage = coverage
|
||||||
|
self._extension_names = tuple(name for name, option in options.items() if option)
|
||||||
|
self._module_names = tuple(f'{_extensions.__name__}.{name}' for name in self._extension_names)
|
||||||
|
|
||||||
|
self.source_mapping: dict[str, str] = {}
|
||||||
|
|
||||||
|
@property
|
||||||
|
def debugger_enabled(self) -> bool:
|
||||||
|
"""Returns True if the debugger extension is enabled, otherwise False."""
|
||||||
|
return bool(self._debugger)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def extension_names(self) -> tuple[str, ...]:
|
||||||
|
"""Names of extensions to include in the AnsiballZ payload."""
|
||||||
|
return self._extension_names
|
||||||
|
|
||||||
|
@property
|
||||||
|
def module_names(self) -> tuple[str, ...]:
|
||||||
|
"""Python module names of extensions to include in the AnsiballZ payload."""
|
||||||
|
return self._module_names
|
||||||
|
|
||||||
|
def get_extensions(self) -> dict[str, dict[str, object]]:
|
||||||
|
"""Return the configured extensions and their options."""
|
||||||
|
extension_options: dict[str, t.Any] = {}
|
||||||
|
|
||||||
|
if self._debugger:
|
||||||
|
extension_options['_pydevd'] = dataclasses.replace(
|
||||||
|
self._debugger,
|
||||||
|
source_mapping=self._get_source_mapping(),
|
||||||
|
)
|
||||||
|
|
||||||
|
if self._coverage:
|
||||||
|
extension_options['_coverage'] = self._coverage
|
||||||
|
|
||||||
|
extensions = {extension: dataclasses.asdict(options) for extension, options in extension_options.items()}
|
||||||
|
|
||||||
|
return extensions
|
||||||
|
|
||||||
|
def _get_source_mapping(self) -> dict[str, str]:
|
||||||
|
"""Get the source mapping, adjusting the source root as needed."""
|
||||||
|
if self._debugger.source_mapping:
|
||||||
|
source_mapping = {self._translate_path(key): value for key, value in self.source_mapping.items()}
|
||||||
|
else:
|
||||||
|
source_mapping = self.source_mapping
|
||||||
|
|
||||||
|
return source_mapping
|
||||||
|
|
||||||
|
def _translate_path(self, path: str) -> str:
|
||||||
|
"""Translate a local path to a foreign path."""
|
||||||
|
for replace, match in self._debugger.source_mapping.items():
|
||||||
|
if path.startswith(match):
|
||||||
|
return replace + path[len(match) :]
|
||||||
|
|
||||||
|
return path
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def create(cls, task_vars: dict[str, object]) -> t.Self:
|
||||||
|
"""Create an instance using the provided task vars."""
|
||||||
|
return cls(
|
||||||
|
debugger=cls._get_options('_ANSIBALLZ_DEBUGGER_CONFIG', _pydevd.Options, task_vars),
|
||||||
|
coverage=cls._get_options('_ANSIBALLZ_COVERAGE_CONFIG', _coverage.Options, task_vars),
|
||||||
|
)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _get_options(cls, name: str, config_type: type[_T], task_vars: dict[str, object]) -> _T | None:
|
||||||
|
"""Parse configuration from the named environment variable as the specified type, or None if not configured."""
|
||||||
|
if (value := config.get_config_value(name, variables=task_vars)) is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
data = json.loads(value) if isinstance(value, str) else value
|
||||||
|
options = config_type(**data)
|
||||||
|
|
||||||
|
return options
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
from __future__ import annotations as _annotations
|
||||||
|
|
||||||
|
import collections.abc as _c
|
||||||
|
import typing as _t
|
||||||
|
|
||||||
|
_T_co = _t.TypeVar('_T_co', covariant=True)
|
||||||
|
|
||||||
|
|
||||||
|
class SequenceProxy(_c.Sequence[_T_co]):
|
||||||
|
"""A read-only sequence proxy."""
|
||||||
|
|
||||||
|
# DTFIX5: needs unit test coverage
|
||||||
|
|
||||||
|
__slots__ = ('__value',)
|
||||||
|
|
||||||
|
def __init__(self, value: _c.Sequence[_T_co]) -> None:
|
||||||
|
self.__value = value
|
||||||
|
|
||||||
|
@_t.overload
|
||||||
|
def __getitem__(self, index: int) -> _T_co: ...
|
||||||
|
|
||||||
|
@_t.overload
|
||||||
|
def __getitem__(self, index: slice) -> _c.Sequence[_T_co]: ...
|
||||||
|
|
||||||
|
def __getitem__(self, index: int | slice) -> _T_co | _c.Sequence[_T_co]:
|
||||||
|
if isinstance(index, slice):
|
||||||
|
return self.__class__(self.__value[index])
|
||||||
|
|
||||||
|
return self.__value[index]
|
||||||
|
|
||||||
|
def __len__(self) -> int:
|
||||||
|
return len(self.__value)
|
||||||
|
|
||||||
|
def __contains__(self, item: object) -> bool:
|
||||||
|
return item in self.__value
|
||||||
|
|
||||||
|
def __iter__(self) -> _t.Iterator[_T_co]:
|
||||||
|
yield from self.__value
|
||||||
|
|
||||||
|
def __reversed__(self) -> _c.Iterator[_T_co]:
|
||||||
|
return reversed(self.__value)
|
||||||
|
|
||||||
|
def index(self, *args) -> int:
|
||||||
|
return self.__value.index(*args)
|
||||||
|
|
||||||
|
def count(self, value: object) -> int:
|
||||||
|
return self.__value.count(value)
|
||||||
@ -0,0 +1,66 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import contextlib
|
||||||
|
import signal
|
||||||
|
import types
|
||||||
|
import typing as _t
|
||||||
|
|
||||||
|
from ansible.module_utils import datatag
|
||||||
|
|
||||||
|
|
||||||
|
class AnsibleTimeoutError(BaseException):
|
||||||
|
"""A general purpose timeout."""
|
||||||
|
|
||||||
|
_MAX_TIMEOUT = 100_000_000
|
||||||
|
"""
|
||||||
|
The maximum supported timeout value.
|
||||||
|
This value comes from BSD's alarm limit, which is due to that function using setitimer.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, timeout: int) -> None:
|
||||||
|
self.timeout = timeout
|
||||||
|
|
||||||
|
super().__init__(f"Timed out after {timeout} second(s).")
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def alarm_timeout(cls, timeout: int | None) -> _t.Iterator[None]:
|
||||||
|
"""
|
||||||
|
Context for running code under an optional timeout.
|
||||||
|
Raises an instance of this class if the timeout occurs.
|
||||||
|
|
||||||
|
New usages of this timeout mechanism are discouraged.
|
||||||
|
"""
|
||||||
|
if timeout is not None:
|
||||||
|
if not isinstance(timeout, int):
|
||||||
|
raise TypeError(f"Timeout requires 'int' argument, not {datatag.native_type_name(timeout)!r}.")
|
||||||
|
|
||||||
|
if timeout < 0 or timeout > cls._MAX_TIMEOUT:
|
||||||
|
# On BSD based systems, alarm is implemented using setitimer.
|
||||||
|
# If out-of-bounds values are passed to alarm, they will return -1, which would be interpreted as an existing timer being set.
|
||||||
|
# To avoid that, bounds checking is performed in advance.
|
||||||
|
raise ValueError(f'Timeout {timeout} is invalid, it must be between 0 and {cls._MAX_TIMEOUT}.')
|
||||||
|
|
||||||
|
if not timeout:
|
||||||
|
yield # execute the context manager's body
|
||||||
|
return # no timeout to deal with, exit immediately
|
||||||
|
|
||||||
|
def on_alarm(_signal: int, _frame: types.FrameType) -> None:
|
||||||
|
raise cls(timeout)
|
||||||
|
|
||||||
|
if signal.signal(signal.SIGALRM, on_alarm):
|
||||||
|
raise RuntimeError("An existing alarm handler was present.")
|
||||||
|
|
||||||
|
try:
|
||||||
|
try:
|
||||||
|
if signal.alarm(timeout):
|
||||||
|
raise RuntimeError("An existing alarm was set.")
|
||||||
|
|
||||||
|
yield # execute the context manager's body
|
||||||
|
finally:
|
||||||
|
# Disable the alarm.
|
||||||
|
# If the alarm fires inside this finally block, the alarm is still disabled.
|
||||||
|
# This guarantees the cleanup code in the outer finally block runs without risk of encountering the `TaskTimeoutError` from the alarm.
|
||||||
|
signal.alarm(0)
|
||||||
|
finally:
|
||||||
|
signal.signal(signal.SIGALRM, signal.SIG_DFL)
|
||||||
@ -0,0 +1,89 @@
|
|||||||
|
from __future__ import annotations as _annotations
|
||||||
|
|
||||||
|
from ansible.module_utils._internal import _errors, _messages
|
||||||
|
|
||||||
|
|
||||||
|
class ControllerEventFactory(_errors.EventFactory):
|
||||||
|
"""Factory for creating `Event` instances from `BaseException` instances on the controller."""
|
||||||
|
|
||||||
|
def _get_msg(self, exception: BaseException) -> str | None:
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
|
||||||
|
if not isinstance(exception, AnsibleError):
|
||||||
|
return super()._get_msg(exception)
|
||||||
|
|
||||||
|
return exception._original_message.strip()
|
||||||
|
|
||||||
|
def _get_formatted_source_context(self, exception: BaseException) -> str | None:
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
|
||||||
|
if not isinstance(exception, AnsibleError):
|
||||||
|
return super()._get_formatted_source_context(exception)
|
||||||
|
|
||||||
|
return exception._formatted_source_context
|
||||||
|
|
||||||
|
def _get_help_text(self, exception: BaseException) -> str | None:
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
|
||||||
|
if not isinstance(exception, AnsibleError):
|
||||||
|
return super()._get_help_text(exception)
|
||||||
|
|
||||||
|
return exception._help_text
|
||||||
|
|
||||||
|
def _get_chain(self, exception: BaseException) -> _messages.EventChain | None:
|
||||||
|
from ansible._internal._errors import _captured # avoid circular import due to AnsibleError import
|
||||||
|
|
||||||
|
if isinstance(exception, _captured.AnsibleCapturedError):
|
||||||
|
# a captured error provides its own cause event, it never has a normal __cause__
|
||||||
|
return _messages.EventChain(
|
||||||
|
msg_reason=_errors.MSG_REASON_DIRECT_CAUSE,
|
||||||
|
traceback_reason=f'The above {exception.context} exception was the direct cause of the following controller exception:',
|
||||||
|
event=exception._event,
|
||||||
|
)
|
||||||
|
|
||||||
|
return super()._get_chain(exception)
|
||||||
|
|
||||||
|
def _follow_cause(self, exception: BaseException) -> bool:
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
|
||||||
|
return not isinstance(exception, AnsibleError) or exception._include_cause_message
|
||||||
|
|
||||||
|
def _get_cause(self, exception: BaseException) -> BaseException | None:
|
||||||
|
# deprecated: description='remove support for orig_exc (deprecated in 2.23)' core_version='2.27'
|
||||||
|
|
||||||
|
cause = super()._get_cause(exception)
|
||||||
|
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
|
||||||
|
if not isinstance(exception, AnsibleError):
|
||||||
|
return cause
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ansible.utils.display import _display
|
||||||
|
except Exception: # pylint: disable=broad-except # if config is broken, this can raise things other than ImportError
|
||||||
|
_display = None
|
||||||
|
|
||||||
|
if cause:
|
||||||
|
if exception.orig_exc and exception.orig_exc is not cause and _display:
|
||||||
|
_display.warning(
|
||||||
|
msg=f"The `orig_exc` argument to `{type(exception).__name__}` was given, but differed from the cause given by `raise ... from`.",
|
||||||
|
)
|
||||||
|
|
||||||
|
return cause
|
||||||
|
|
||||||
|
if exception.orig_exc:
|
||||||
|
if _display:
|
||||||
|
# encourage the use of `raise ... from` before deprecating `orig_exc`
|
||||||
|
_display.warning(
|
||||||
|
msg=f"The `orig_exc` argument to `{type(exception).__name__}` was given without using `raise ... from orig_exc`.",
|
||||||
|
)
|
||||||
|
|
||||||
|
return exception.orig_exc
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
def _get_events(self, exception: BaseException) -> tuple[_messages.Event, ...] | None:
|
||||||
|
if isinstance(exception, BaseExceptionGroup):
|
||||||
|
return tuple(self._convert_exception(ex) for ex in exception.exceptions)
|
||||||
|
|
||||||
|
return None
|
||||||
@ -0,0 +1,240 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import abc
|
||||||
|
import collections.abc as _c
|
||||||
|
import dataclasses
|
||||||
|
import itertools
|
||||||
|
import pathlib
|
||||||
|
import textwrap
|
||||||
|
import typing as t
|
||||||
|
|
||||||
|
from ansible._internal._datatag._tags import Origin
|
||||||
|
from ansible._internal._errors import _error_factory
|
||||||
|
from ansible.module_utils._internal import _ambient_context, _event_utils, _messages, _traceback
|
||||||
|
|
||||||
|
|
||||||
|
class ContributesToTaskResult(metaclass=abc.ABCMeta):
|
||||||
|
"""Exceptions may include this mixin to contribute task result dictionary data directly to the final result."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
@abc.abstractmethod
|
||||||
|
def result_contribution(self) -> _c.Mapping[str, object]:
|
||||||
|
"""Mapping of results to apply to the task result."""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def omit_exception_key(self) -> bool:
|
||||||
|
"""Non-error exceptions (e.g., `AnsibleActionSkip`) must return `True` to ensure omission of the `exception` key."""
|
||||||
|
return False
|
||||||
|
|
||||||
|
@property
|
||||||
|
def omit_failed_key(self) -> bool:
|
||||||
|
"""Exceptions representing non-failure scenarios (e.g., `skipped`, `unreachable`) must return `True` to ensure omisson of the `failed` key."""
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class RedactAnnotatedSourceContext(_ambient_context.AmbientContextBase):
|
||||||
|
"""When active, this context will redact annotated source lines, showing only the origin."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclasses.dataclass(kw_only=True, frozen=True)
|
||||||
|
class SourceContext:
|
||||||
|
origin: Origin
|
||||||
|
annotated_source_lines: list[str]
|
||||||
|
target_line: str | None
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
msg_lines = [f'Origin: {self.origin}']
|
||||||
|
|
||||||
|
if self.annotated_source_lines:
|
||||||
|
msg_lines.append('')
|
||||||
|
msg_lines.extend(self.annotated_source_lines)
|
||||||
|
|
||||||
|
return '\n'.join(msg_lines)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_value(cls, value: t.Any) -> SourceContext | None:
|
||||||
|
"""Attempt to retrieve source and render a contextual indicator from the value's origin (if any)."""
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
|
||||||
|
if isinstance(value, Origin):
|
||||||
|
origin = value
|
||||||
|
value = None
|
||||||
|
else:
|
||||||
|
origin = Origin.get_tag(value)
|
||||||
|
|
||||||
|
if RedactAnnotatedSourceContext.current(optional=True):
|
||||||
|
return cls.error('content redacted')
|
||||||
|
|
||||||
|
if origin and origin.path:
|
||||||
|
return cls.from_origin(origin)
|
||||||
|
|
||||||
|
if value is None:
|
||||||
|
truncated_value = None
|
||||||
|
annotated_source_lines = []
|
||||||
|
else:
|
||||||
|
# DTFIX-FUTURE: cleanup/share width
|
||||||
|
try:
|
||||||
|
value = str(value)
|
||||||
|
except Exception as ex:
|
||||||
|
value = f'<< context unavailable: {ex} >>'
|
||||||
|
|
||||||
|
truncated_value = textwrap.shorten(value, width=120)
|
||||||
|
annotated_source_lines = [truncated_value]
|
||||||
|
|
||||||
|
return SourceContext(
|
||||||
|
origin=origin or Origin.UNKNOWN,
|
||||||
|
annotated_source_lines=annotated_source_lines,
|
||||||
|
target_line=truncated_value,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def error(message: str | None, origin: Origin | None = None) -> SourceContext:
|
||||||
|
return SourceContext(
|
||||||
|
origin=origin,
|
||||||
|
annotated_source_lines=[f'(source not shown: {message})'] if message else [],
|
||||||
|
target_line=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_origin(cls, origin: Origin) -> SourceContext:
|
||||||
|
"""Attempt to retrieve source and render a contextual indicator of an error location."""
|
||||||
|
from ansible.parsing.vault import is_encrypted # avoid circular import
|
||||||
|
|
||||||
|
# DTFIX-FUTURE: support referencing the column after the end of the target line, so we can indicate where a missing character (quote) needs to be added
|
||||||
|
# this is also useful for cases like end-of-stream reported by the YAML parser
|
||||||
|
|
||||||
|
# DTFIX-FUTURE: Implement line wrapping and match annotated line width to the terminal display width.
|
||||||
|
|
||||||
|
context_line_count: t.Final = 2
|
||||||
|
max_annotated_line_width: t.Final = 120
|
||||||
|
truncation_marker: t.Final = '...'
|
||||||
|
|
||||||
|
target_line_num = origin.line_num
|
||||||
|
|
||||||
|
if RedactAnnotatedSourceContext.current(optional=True):
|
||||||
|
return cls.error('content redacted', origin)
|
||||||
|
|
||||||
|
if not target_line_num or target_line_num < 1:
|
||||||
|
return cls.error(None, origin) # message omitted since lack of line number is obvious from pos
|
||||||
|
|
||||||
|
start_line_idx = max(0, (target_line_num - 1) - context_line_count) # if near start of file
|
||||||
|
target_col_num = origin.col_num
|
||||||
|
|
||||||
|
try:
|
||||||
|
with pathlib.Path(origin.path).open() as src:
|
||||||
|
first_line = src.readline()
|
||||||
|
lines = list(itertools.islice(itertools.chain((first_line,), src), start_line_idx, target_line_num))
|
||||||
|
except Exception as ex:
|
||||||
|
return cls.error(type(ex).__name__, origin)
|
||||||
|
|
||||||
|
if is_encrypted(first_line):
|
||||||
|
return cls.error('content encrypted', origin)
|
||||||
|
|
||||||
|
if len(lines) != target_line_num - start_line_idx:
|
||||||
|
return cls.error('file truncated', origin)
|
||||||
|
|
||||||
|
annotated_source_lines = []
|
||||||
|
|
||||||
|
line_label_width = len(str(target_line_num))
|
||||||
|
max_src_line_len = max_annotated_line_width - line_label_width - 1
|
||||||
|
|
||||||
|
usable_line_len = max_src_line_len
|
||||||
|
|
||||||
|
for line_num, line in enumerate(lines, start_line_idx + 1):
|
||||||
|
line = line.rstrip('\n') # universal newline default mode on `open` ensures we'll never see anything but \n
|
||||||
|
line = line.replace('\t', ' ') # mixed tab/space handling is intentionally disabled since we're both format and display config agnostic
|
||||||
|
|
||||||
|
if len(line) > max_src_line_len:
|
||||||
|
line = line[: max_src_line_len - len(truncation_marker)] + truncation_marker
|
||||||
|
usable_line_len = max_src_line_len - len(truncation_marker)
|
||||||
|
|
||||||
|
annotated_source_lines.append(f'{str(line_num).rjust(line_label_width)}{" " if line else ""}{line}')
|
||||||
|
|
||||||
|
if target_col_num and usable_line_len >= target_col_num >= 1:
|
||||||
|
column_marker = f'column {target_col_num}'
|
||||||
|
|
||||||
|
target_col_idx = target_col_num - 1
|
||||||
|
|
||||||
|
if target_col_idx + 2 + len(column_marker) > max_src_line_len:
|
||||||
|
column_marker = f'{" " * (target_col_idx - len(column_marker) - 1)}{column_marker} ^'
|
||||||
|
else:
|
||||||
|
column_marker = f'{" " * target_col_idx}^ {column_marker}'
|
||||||
|
|
||||||
|
column_marker = f'{" " * line_label_width} {column_marker}'
|
||||||
|
|
||||||
|
annotated_source_lines.append(column_marker)
|
||||||
|
elif target_col_num is None:
|
||||||
|
underline_length = len(annotated_source_lines[-1]) - line_label_width - 1
|
||||||
|
annotated_source_lines.append(f'{" " * line_label_width} {"^" * underline_length}')
|
||||||
|
|
||||||
|
return SourceContext(
|
||||||
|
origin=origin,
|
||||||
|
annotated_source_lines=annotated_source_lines,
|
||||||
|
target_line=lines[-1].rstrip('\n'), # universal newline default mode on `open` ensures we'll never see anything but \n
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def format_exception_message(exception: BaseException) -> str:
|
||||||
|
"""Return the full chain of exception messages by concatenating the cause(s) until all are exhausted."""
|
||||||
|
return _event_utils.format_event_brief_message(_error_factory.ControllerEventFactory.from_exception(exception, False))
|
||||||
|
|
||||||
|
|
||||||
|
def result_dict_from_exception(exception: BaseException, accept_result_contribution: bool = False) -> dict[str, object]:
|
||||||
|
"""Return a failed task result dict from the given exception."""
|
||||||
|
event = _error_factory.ControllerEventFactory.from_exception(exception, _traceback.is_traceback_enabled(_traceback.TracebackEvent.ERROR))
|
||||||
|
|
||||||
|
result: dict[str, object] = {}
|
||||||
|
omit_failed_key = False
|
||||||
|
omit_exception_key = False
|
||||||
|
|
||||||
|
if accept_result_contribution:
|
||||||
|
while exception:
|
||||||
|
if isinstance(exception, ContributesToTaskResult):
|
||||||
|
result = dict(exception.result_contribution)
|
||||||
|
omit_failed_key = exception.omit_failed_key
|
||||||
|
omit_exception_key = exception.omit_exception_key
|
||||||
|
break
|
||||||
|
|
||||||
|
exception = exception.__cause__
|
||||||
|
|
||||||
|
if omit_failed_key:
|
||||||
|
result.pop('failed', None)
|
||||||
|
else:
|
||||||
|
result.update(failed=True)
|
||||||
|
|
||||||
|
if omit_exception_key:
|
||||||
|
result.pop('exception', None)
|
||||||
|
else:
|
||||||
|
result.update(exception=_messages.ErrorSummary(event=event))
|
||||||
|
|
||||||
|
if 'msg' not in result:
|
||||||
|
# if nothing contributed `msg`, generate one from the exception messages
|
||||||
|
result.update(msg=_event_utils.format_event_brief_message(event))
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def result_dict_from_captured_errors(
|
||||||
|
msg: str,
|
||||||
|
*,
|
||||||
|
errors: list[_messages.ErrorSummary] | None = None,
|
||||||
|
) -> dict[str, object]:
|
||||||
|
"""Return a failed task result dict from the given error message and captured errors."""
|
||||||
|
_skip_stackwalk = True
|
||||||
|
|
||||||
|
event = _messages.Event(
|
||||||
|
msg=msg,
|
||||||
|
formatted_traceback=_traceback.maybe_capture_traceback(msg, _traceback.TracebackEvent.ERROR),
|
||||||
|
events=tuple(error.event for error in errors) if errors else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
result = dict(
|
||||||
|
failed=True,
|
||||||
|
exception=_messages.ErrorSummary(
|
||||||
|
event=event,
|
||||||
|
),
|
||||||
|
msg=_event_utils.format_event_brief_message(event),
|
||||||
|
)
|
||||||
|
|
||||||
|
return result
|
||||||
@ -0,0 +1,28 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections import abc as _c
|
||||||
|
|
||||||
|
from ansible._internal._errors._alarm_timeout import AnsibleTimeoutError
|
||||||
|
from ansible._internal._errors._error_utils import ContributesToTaskResult
|
||||||
|
from ansible.module_utils.datatag import deprecate_value
|
||||||
|
|
||||||
|
|
||||||
|
class TaskTimeoutError(AnsibleTimeoutError, ContributesToTaskResult):
|
||||||
|
"""
|
||||||
|
A task-specific timeout.
|
||||||
|
|
||||||
|
This exception provides a result dictionary via the ContributesToTaskResult mixin.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@property
|
||||||
|
def result_contribution(self) -> _c.Mapping[str, object]:
|
||||||
|
help_text = "Configure `DISPLAY_TRACEBACK` to see a traceback on timeout errors."
|
||||||
|
|
||||||
|
frame = deprecate_value(
|
||||||
|
value=help_text,
|
||||||
|
msg="The `timedout.frame` task result key is deprecated.",
|
||||||
|
help_text=help_text,
|
||||||
|
version="2.23",
|
||||||
|
)
|
||||||
|
|
||||||
|
return dict(timedout=dict(frame=frame, period=self.timeout))
|
||||||
@ -1,310 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import dataclasses
|
|
||||||
import itertools
|
|
||||||
import pathlib
|
|
||||||
import sys
|
|
||||||
import textwrap
|
|
||||||
import typing as t
|
|
||||||
|
|
||||||
from ansible.module_utils.common.messages import Detail, ErrorSummary
|
|
||||||
from ansible._internal._datatag._tags import Origin
|
|
||||||
from ansible.module_utils._internal import _ambient_context, _traceback
|
|
||||||
from ansible import errors
|
|
||||||
|
|
||||||
if t.TYPE_CHECKING:
|
|
||||||
from ansible.utils.display import Display
|
|
||||||
|
|
||||||
|
|
||||||
class RedactAnnotatedSourceContext(_ambient_context.AmbientContextBase):
|
|
||||||
"""
|
|
||||||
When active, this context will redact annotated source lines, showing only the origin.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
def _dedupe_and_concat_message_chain(message_parts: list[str]) -> str:
|
|
||||||
message_parts = list(reversed(message_parts))
|
|
||||||
|
|
||||||
message = message_parts.pop(0)
|
|
||||||
|
|
||||||
for message_part in message_parts:
|
|
||||||
# avoid duplicate messages where the cause was already concatenated to the exception message
|
|
||||||
if message_part.endswith(message):
|
|
||||||
message = message_part
|
|
||||||
else:
|
|
||||||
message = concat_message(message_part, message)
|
|
||||||
|
|
||||||
return message
|
|
||||||
|
|
||||||
|
|
||||||
def _collapse_error_details(error_details: t.Sequence[Detail]) -> list[Detail]:
|
|
||||||
"""
|
|
||||||
Return a potentially modified error chain, with redundant errors collapsed into previous error(s) in the chain.
|
|
||||||
This reduces the verbosity of messages by eliminating repetition when multiple errors in the chain share the same contextual information.
|
|
||||||
"""
|
|
||||||
previous_error = error_details[0]
|
|
||||||
previous_warnings: list[str] = []
|
|
||||||
collapsed_error_details: list[tuple[Detail, list[str]]] = [(previous_error, previous_warnings)]
|
|
||||||
|
|
||||||
for error in error_details[1:]:
|
|
||||||
details_present = error.formatted_source_context or error.help_text
|
|
||||||
details_changed = error.formatted_source_context != previous_error.formatted_source_context or error.help_text != previous_error.help_text
|
|
||||||
|
|
||||||
if details_present and details_changed:
|
|
||||||
previous_error = error
|
|
||||||
previous_warnings = []
|
|
||||||
collapsed_error_details.append((previous_error, previous_warnings))
|
|
||||||
else:
|
|
||||||
previous_warnings.append(error.msg)
|
|
||||||
|
|
||||||
final_error_details: list[Detail] = []
|
|
||||||
|
|
||||||
for error, messages in collapsed_error_details:
|
|
||||||
final_error_details.append(dataclasses.replace(error, msg=_dedupe_and_concat_message_chain([error.msg] + messages)))
|
|
||||||
|
|
||||||
return final_error_details
|
|
||||||
|
|
||||||
|
|
||||||
def _get_cause(exception: BaseException) -> BaseException | None:
|
|
||||||
# deprecated: description='remove support for orig_exc (deprecated in 2.23)' core_version='2.27'
|
|
||||||
|
|
||||||
if not isinstance(exception, errors.AnsibleError):
|
|
||||||
return exception.__cause__
|
|
||||||
|
|
||||||
if exception.__cause__:
|
|
||||||
if exception.orig_exc and exception.orig_exc is not exception.__cause__:
|
|
||||||
_get_display().warning(
|
|
||||||
msg=f"The `orig_exc` argument to `{type(exception).__name__}` was given, but differed from the cause given by `raise ... from`.",
|
|
||||||
)
|
|
||||||
|
|
||||||
return exception.__cause__
|
|
||||||
|
|
||||||
if exception.orig_exc:
|
|
||||||
# encourage the use of `raise ... from` before deprecating `orig_exc`
|
|
||||||
_get_display().warning(msg=f"The `orig_exc` argument to `{type(exception).__name__}` was given without using `raise ... from orig_exc`.")
|
|
||||||
|
|
||||||
return exception.orig_exc
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
class _TemporaryDisplay:
|
|
||||||
# DTFIX-FUTURE: generalize this and hide it in the display module so all users of Display can benefit
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def warning(*args, **kwargs):
|
|
||||||
print(f'FALLBACK WARNING: {args} {kwargs}', file=sys.stderr)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def deprecated(*args, **kwargs):
|
|
||||||
print(f'FALLBACK DEPRECATION: {args} {kwargs}', file=sys.stderr)
|
|
||||||
|
|
||||||
|
|
||||||
def _get_display() -> Display | _TemporaryDisplay:
|
|
||||||
try:
|
|
||||||
from ansible.utils.display import Display
|
|
||||||
except ImportError:
|
|
||||||
return _TemporaryDisplay()
|
|
||||||
|
|
||||||
return Display()
|
|
||||||
|
|
||||||
|
|
||||||
def _create_error_summary(exception: BaseException, event: _traceback.TracebackEvent | None = None) -> ErrorSummary:
|
|
||||||
from . import _captured # avoid circular import due to AnsibleError import
|
|
||||||
|
|
||||||
current_exception: BaseException | None = exception
|
|
||||||
error_details: list[Detail] = []
|
|
||||||
|
|
||||||
if event:
|
|
||||||
formatted_traceback = _traceback.maybe_extract_traceback(exception, event)
|
|
||||||
else:
|
|
||||||
formatted_traceback = None
|
|
||||||
|
|
||||||
while current_exception:
|
|
||||||
if isinstance(current_exception, errors.AnsibleError):
|
|
||||||
include_cause_message = current_exception._include_cause_message
|
|
||||||
edc = Detail(
|
|
||||||
msg=current_exception._original_message.strip(),
|
|
||||||
formatted_source_context=current_exception._formatted_source_context,
|
|
||||||
help_text=current_exception._help_text,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
include_cause_message = True
|
|
||||||
edc = Detail(
|
|
||||||
msg=str(current_exception).strip(),
|
|
||||||
)
|
|
||||||
|
|
||||||
error_details.append(edc)
|
|
||||||
|
|
||||||
if isinstance(current_exception, _captured.AnsibleCapturedError):
|
|
||||||
detail = current_exception.error_summary
|
|
||||||
error_details.extend(detail.details)
|
|
||||||
|
|
||||||
if formatted_traceback and detail.formatted_traceback:
|
|
||||||
formatted_traceback = (
|
|
||||||
f'{detail.formatted_traceback}\n'
|
|
||||||
f'The {current_exception.context} exception above was the direct cause of the following controller exception:\n\n'
|
|
||||||
f'{formatted_traceback}'
|
|
||||||
)
|
|
||||||
|
|
||||||
if not include_cause_message:
|
|
||||||
break
|
|
||||||
|
|
||||||
current_exception = _get_cause(current_exception)
|
|
||||||
|
|
||||||
return ErrorSummary(details=tuple(error_details), formatted_traceback=formatted_traceback)
|
|
||||||
|
|
||||||
|
|
||||||
def concat_message(left: str, right: str) -> str:
|
|
||||||
"""Normalize `left` by removing trailing punctuation and spaces before appending new punctuation and `right`."""
|
|
||||||
return f'{left.rstrip(". ")}: {right}'
|
|
||||||
|
|
||||||
|
|
||||||
def get_chained_message(exception: BaseException) -> str:
|
|
||||||
"""
|
|
||||||
Return the full chain of exception messages by concatenating the cause(s) until all are exhausted.
|
|
||||||
"""
|
|
||||||
error_summary = _create_error_summary(exception)
|
|
||||||
message_parts = [edc.msg for edc in error_summary.details]
|
|
||||||
|
|
||||||
return _dedupe_and_concat_message_chain(message_parts)
|
|
||||||
|
|
||||||
|
|
||||||
@dataclasses.dataclass(kw_only=True, frozen=True)
|
|
||||||
class SourceContext:
|
|
||||||
origin: Origin
|
|
||||||
annotated_source_lines: list[str]
|
|
||||||
target_line: str | None
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
msg_lines = [f'Origin: {self.origin}']
|
|
||||||
|
|
||||||
if self.annotated_source_lines:
|
|
||||||
msg_lines.append('')
|
|
||||||
msg_lines.extend(self.annotated_source_lines)
|
|
||||||
|
|
||||||
return '\n'.join(msg_lines)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def from_value(cls, value: t.Any) -> SourceContext | None:
|
|
||||||
"""Attempt to retrieve source and render a contextual indicator from the value's origin (if any)."""
|
|
||||||
if value is None:
|
|
||||||
return None
|
|
||||||
|
|
||||||
if isinstance(value, Origin):
|
|
||||||
origin = value
|
|
||||||
value = None
|
|
||||||
else:
|
|
||||||
origin = Origin.get_tag(value)
|
|
||||||
|
|
||||||
if RedactAnnotatedSourceContext.current(optional=True):
|
|
||||||
return cls.error('content redacted')
|
|
||||||
|
|
||||||
if origin and origin.path:
|
|
||||||
return cls.from_origin(origin)
|
|
||||||
|
|
||||||
# DTFIX-RELEASE: redaction context may not be sufficient to avoid secret disclosure without SensitiveData and other enhancements
|
|
||||||
if value is None:
|
|
||||||
truncated_value = None
|
|
||||||
annotated_source_lines = []
|
|
||||||
else:
|
|
||||||
# DTFIX-FUTURE: cleanup/share width
|
|
||||||
try:
|
|
||||||
value = str(value)
|
|
||||||
except Exception as ex:
|
|
||||||
value = f'<< context unavailable: {ex} >>'
|
|
||||||
|
|
||||||
truncated_value = textwrap.shorten(value, width=120)
|
|
||||||
annotated_source_lines = [truncated_value]
|
|
||||||
|
|
||||||
return SourceContext(
|
|
||||||
origin=origin or Origin.UNKNOWN,
|
|
||||||
annotated_source_lines=annotated_source_lines,
|
|
||||||
target_line=truncated_value,
|
|
||||||
)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def error(message: str | None, origin: Origin | None = None) -> SourceContext:
|
|
||||||
return SourceContext(
|
|
||||||
origin=origin,
|
|
||||||
annotated_source_lines=[f'(source not shown: {message})'] if message else [],
|
|
||||||
target_line=None,
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def from_origin(cls, origin: Origin) -> SourceContext:
|
|
||||||
"""Attempt to retrieve source and render a contextual indicator of an error location."""
|
|
||||||
from ansible.parsing.vault import is_encrypted # avoid circular import
|
|
||||||
|
|
||||||
# DTFIX-FUTURE: support referencing the column after the end of the target line, so we can indicate where a missing character (quote) needs to be added
|
|
||||||
# this is also useful for cases like end-of-stream reported by the YAML parser
|
|
||||||
|
|
||||||
# DTFIX-FUTURE: Implement line wrapping and match annotated line width to the terminal display width.
|
|
||||||
|
|
||||||
context_line_count: t.Final = 2
|
|
||||||
max_annotated_line_width: t.Final = 120
|
|
||||||
truncation_marker: t.Final = '...'
|
|
||||||
|
|
||||||
target_line_num = origin.line_num
|
|
||||||
|
|
||||||
if RedactAnnotatedSourceContext.current(optional=True):
|
|
||||||
return cls.error('content redacted', origin)
|
|
||||||
|
|
||||||
if not target_line_num or target_line_num < 1:
|
|
||||||
return cls.error(None, origin) # message omitted since lack of line number is obvious from pos
|
|
||||||
|
|
||||||
start_line_idx = max(0, (target_line_num - 1) - context_line_count) # if near start of file
|
|
||||||
target_col_num = origin.col_num
|
|
||||||
|
|
||||||
try:
|
|
||||||
with pathlib.Path(origin.path).open() as src:
|
|
||||||
first_line = src.readline()
|
|
||||||
lines = list(itertools.islice(itertools.chain((first_line,), src), start_line_idx, target_line_num))
|
|
||||||
except Exception as ex:
|
|
||||||
return cls.error(type(ex).__name__, origin)
|
|
||||||
|
|
||||||
if is_encrypted(first_line):
|
|
||||||
return cls.error('content encrypted', origin)
|
|
||||||
|
|
||||||
if len(lines) != target_line_num - start_line_idx:
|
|
||||||
return cls.error('file truncated', origin)
|
|
||||||
|
|
||||||
annotated_source_lines = []
|
|
||||||
|
|
||||||
line_label_width = len(str(target_line_num))
|
|
||||||
max_src_line_len = max_annotated_line_width - line_label_width - 1
|
|
||||||
|
|
||||||
usable_line_len = max_src_line_len
|
|
||||||
|
|
||||||
for line_num, line in enumerate(lines, start_line_idx + 1):
|
|
||||||
line = line.rstrip('\n') # universal newline default mode on `open` ensures we'll never see anything but \n
|
|
||||||
line = line.replace('\t', ' ') # mixed tab/space handling is intentionally disabled since we're both format and display config agnostic
|
|
||||||
|
|
||||||
if len(line) > max_src_line_len:
|
|
||||||
line = line[: max_src_line_len - len(truncation_marker)] + truncation_marker
|
|
||||||
usable_line_len = max_src_line_len - len(truncation_marker)
|
|
||||||
|
|
||||||
annotated_source_lines.append(f'{str(line_num).rjust(line_label_width)}{" " if line else ""}{line}')
|
|
||||||
|
|
||||||
if target_col_num and usable_line_len >= target_col_num >= 1:
|
|
||||||
column_marker = f'column {target_col_num}'
|
|
||||||
|
|
||||||
target_col_idx = target_col_num - 1
|
|
||||||
|
|
||||||
if target_col_idx + 2 + len(column_marker) > max_src_line_len:
|
|
||||||
column_marker = f'{" " * (target_col_idx - len(column_marker) - 1)}{column_marker} ^'
|
|
||||||
else:
|
|
||||||
column_marker = f'{" " * target_col_idx}^ {column_marker}'
|
|
||||||
|
|
||||||
column_marker = f'{" " * line_label_width} {column_marker}'
|
|
||||||
|
|
||||||
annotated_source_lines.append(column_marker)
|
|
||||||
elif target_col_num is None:
|
|
||||||
underline_length = len(annotated_source_lines[-1]) - line_label_width - 1
|
|
||||||
annotated_source_lines.append(f'{" " * line_label_width} {"^" * underline_length}')
|
|
||||||
|
|
||||||
return SourceContext(
|
|
||||||
origin=origin,
|
|
||||||
annotated_source_lines=annotated_source_lines,
|
|
||||||
target_line=lines[-1].rstrip('\n'), # universal newline default mode on `open` ensures we'll never see anything but \n
|
|
||||||
)
|
|
||||||
@ -0,0 +1,127 @@
|
|||||||
|
from __future__ import annotations as _annotations
|
||||||
|
|
||||||
|
import collections.abc as _c
|
||||||
|
import textwrap as _textwrap
|
||||||
|
|
||||||
|
from ansible.module_utils._internal import _event_utils, _messages
|
||||||
|
|
||||||
|
|
||||||
|
def format_event(event: _messages.Event, include_traceback: bool) -> str:
|
||||||
|
"""Format an event into a verbose message and traceback."""
|
||||||
|
msg = format_event_verbose_message(event)
|
||||||
|
|
||||||
|
if include_traceback:
|
||||||
|
msg += '\n' + format_event_traceback(event)
|
||||||
|
|
||||||
|
msg = msg.strip()
|
||||||
|
|
||||||
|
if '\n' in msg:
|
||||||
|
msg += '\n\n'
|
||||||
|
else:
|
||||||
|
msg += '\n'
|
||||||
|
|
||||||
|
return msg
|
||||||
|
|
||||||
|
|
||||||
|
def format_event_traceback(event: _messages.Event) -> str:
|
||||||
|
"""Format an event into a traceback."""
|
||||||
|
segments: list[str] = []
|
||||||
|
|
||||||
|
while event:
|
||||||
|
segment = event.formatted_traceback or '(traceback missing)\n'
|
||||||
|
|
||||||
|
if event.events:
|
||||||
|
child_tracebacks = [format_event_traceback(child) for child in event.events]
|
||||||
|
segment += _format_event_children("Sub-Traceback", child_tracebacks)
|
||||||
|
|
||||||
|
segments.append(segment)
|
||||||
|
|
||||||
|
if event.chain:
|
||||||
|
segments.append(f'\n{event.chain.traceback_reason}\n\n')
|
||||||
|
|
||||||
|
event = event.chain.event
|
||||||
|
else:
|
||||||
|
event = None
|
||||||
|
|
||||||
|
return ''.join(reversed(segments))
|
||||||
|
|
||||||
|
|
||||||
|
def format_event_verbose_message(event: _messages.Event) -> str:
|
||||||
|
"""
|
||||||
|
Format an event into a verbose message.
|
||||||
|
Help text, contextual information and sub-events will be included.
|
||||||
|
"""
|
||||||
|
segments: list[str] = []
|
||||||
|
original_event = event
|
||||||
|
|
||||||
|
while event:
|
||||||
|
messages = [event.msg]
|
||||||
|
chain: _messages.EventChain = event.chain
|
||||||
|
|
||||||
|
while chain and chain.follow:
|
||||||
|
if chain.event.events:
|
||||||
|
break # do not collapse a chained event with sub-events, since they would be lost
|
||||||
|
|
||||||
|
if chain.event.formatted_source_context or chain.event.help_text:
|
||||||
|
if chain.event.formatted_source_context != event.formatted_source_context or chain.event.help_text != event.help_text:
|
||||||
|
break # do not collapse a chained event with different details, since they would be lost
|
||||||
|
|
||||||
|
if chain.event.chain and chain.msg_reason != chain.event.chain.msg_reason:
|
||||||
|
break # do not collapse a chained event which has a chain with a different msg_reason
|
||||||
|
|
||||||
|
messages.append(chain.event.msg)
|
||||||
|
|
||||||
|
chain = chain.event.chain
|
||||||
|
|
||||||
|
msg = _event_utils.deduplicate_message_parts(messages)
|
||||||
|
segment = '\n'.join(_get_message_lines(msg, event.help_text, event.formatted_source_context)) + '\n'
|
||||||
|
|
||||||
|
if event.events:
|
||||||
|
child_msgs = [format_event_verbose_message(child) for child in event.events]
|
||||||
|
segment += _format_event_children("Sub-Event", child_msgs)
|
||||||
|
|
||||||
|
segments.append(segment)
|
||||||
|
|
||||||
|
if chain and chain.follow:
|
||||||
|
segments.append(f'\n{chain.msg_reason}\n\n')
|
||||||
|
|
||||||
|
event = chain.event
|
||||||
|
else:
|
||||||
|
event = None
|
||||||
|
|
||||||
|
if len(segments) > 1:
|
||||||
|
segments.insert(0, _event_utils.format_event_brief_message(original_event) + '\n\n')
|
||||||
|
|
||||||
|
return ''.join(segments)
|
||||||
|
|
||||||
|
|
||||||
|
def _format_event_children(label: str, children: _c.Iterable[str]) -> str:
|
||||||
|
"""Format the given list of child messages into a single string."""
|
||||||
|
items = list(children)
|
||||||
|
count = len(items)
|
||||||
|
lines = ['\n']
|
||||||
|
|
||||||
|
for idx, item in enumerate(items):
|
||||||
|
lines.append(f'+--[ {label} {idx + 1} of {count} ]---\n')
|
||||||
|
lines.append(_textwrap.indent(f"\n{item}\n", "| ", lambda value: True))
|
||||||
|
|
||||||
|
lines.append(f'+--[ End {label} ]---\n')
|
||||||
|
|
||||||
|
return ''.join(lines)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_message_lines(message: str, help_text: str | None, formatted_source_context: str | None) -> list[str]:
|
||||||
|
"""Return a list of message lines constructed from the given message, help text and formatted source context."""
|
||||||
|
if help_text and not formatted_source_context and '\n' not in message and '\n' not in help_text:
|
||||||
|
return [f'{message} {help_text}'] # prefer a single-line message with help text when there is no source context
|
||||||
|
|
||||||
|
message_lines = [message]
|
||||||
|
|
||||||
|
if formatted_source_context:
|
||||||
|
message_lines.append(formatted_source_context)
|
||||||
|
|
||||||
|
if help_text:
|
||||||
|
message_lines.append('')
|
||||||
|
message_lines.append(help_text)
|
||||||
|
|
||||||
|
return message_lines
|
||||||
@ -0,0 +1,91 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import atexit
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from ansible import constants as C
|
||||||
|
from ansible._internal._errors import _alarm_timeout
|
||||||
|
from ansible._internal._ssh._ssh_agent import SshAgentClient
|
||||||
|
from ansible.cli import display
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
from ansible.module_utils.common.process import get_bin_path
|
||||||
|
|
||||||
|
_SSH_AGENT_STDOUT_READ_TIMEOUT = 5 # seconds
|
||||||
|
|
||||||
|
|
||||||
|
def launch_ssh_agent() -> None:
|
||||||
|
"""If configured via `SSH_AGENT`, launch an ssh-agent for Ansible's use and/or verify access to an existing one."""
|
||||||
|
try:
|
||||||
|
_launch_ssh_agent()
|
||||||
|
except Exception as ex:
|
||||||
|
raise AnsibleError("Failed to launch ssh agent.") from ex
|
||||||
|
|
||||||
|
|
||||||
|
def _launch_ssh_agent() -> None:
|
||||||
|
ssh_agent_cfg = C.config.get_config_value('SSH_AGENT')
|
||||||
|
|
||||||
|
match ssh_agent_cfg:
|
||||||
|
case 'none':
|
||||||
|
display.debug('SSH_AGENT set to none')
|
||||||
|
return
|
||||||
|
case 'auto':
|
||||||
|
try:
|
||||||
|
ssh_agent_bin = get_bin_path(C.config.get_config_value('SSH_AGENT_EXECUTABLE'))
|
||||||
|
except ValueError as e:
|
||||||
|
raise AnsibleError('SSH_AGENT set to auto, but cannot find ssh-agent binary.') from e
|
||||||
|
|
||||||
|
ssh_agent_dir = os.path.join(C.DEFAULT_LOCAL_TMP, 'ssh_agent')
|
||||||
|
os.mkdir(ssh_agent_dir, 0o700)
|
||||||
|
sock = os.path.join(ssh_agent_dir, 'agent.sock')
|
||||||
|
display.vvv('SSH_AGENT: starting...')
|
||||||
|
|
||||||
|
try:
|
||||||
|
p = subprocess.Popen(
|
||||||
|
[ssh_agent_bin, '-D', '-s', '-a', sock],
|
||||||
|
stdin=subprocess.PIPE,
|
||||||
|
stdout=subprocess.PIPE,
|
||||||
|
stderr=subprocess.PIPE,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
except OSError as e:
|
||||||
|
raise AnsibleError('Could not start ssh-agent.') from e
|
||||||
|
|
||||||
|
atexit.register(p.terminate)
|
||||||
|
|
||||||
|
help_text = f'The ssh-agent {ssh_agent_bin!r} might be an incompatible agent.'
|
||||||
|
expected_stdout = 'SSH_AUTH_SOCK'
|
||||||
|
|
||||||
|
try:
|
||||||
|
with _alarm_timeout.AnsibleTimeoutError.alarm_timeout(_SSH_AGENT_STDOUT_READ_TIMEOUT):
|
||||||
|
stdout = p.stdout.read(len(expected_stdout))
|
||||||
|
except _alarm_timeout.AnsibleTimeoutError as e:
|
||||||
|
display.error_as_warning(
|
||||||
|
msg=f'Timed out waiting for expected stdout {expected_stdout!r} from ssh-agent.',
|
||||||
|
exception=e,
|
||||||
|
help_text=help_text,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
if stdout != expected_stdout:
|
||||||
|
display.warning(
|
||||||
|
msg=f'The ssh-agent output {stdout!r} did not match expected {expected_stdout!r}.',
|
||||||
|
help_text=help_text,
|
||||||
|
)
|
||||||
|
|
||||||
|
if p.poll() is not None:
|
||||||
|
raise AnsibleError(
|
||||||
|
message='The ssh-agent terminated prematurely.',
|
||||||
|
help_text=f'{help_text}\n\nReturn Code: {p.returncode}\nStandard Error:\n{p.stderr.read()}',
|
||||||
|
)
|
||||||
|
|
||||||
|
display.vvv(f'SSH_AGENT: ssh-agent[{p.pid}] started and bound to {sock}')
|
||||||
|
case _:
|
||||||
|
sock = ssh_agent_cfg
|
||||||
|
|
||||||
|
try:
|
||||||
|
with SshAgentClient(sock) as client:
|
||||||
|
client.list()
|
||||||
|
except Exception as e:
|
||||||
|
raise AnsibleError(f'Could not communicate with ssh-agent using auth sock {sock!r}.') from e
|
||||||
|
|
||||||
|
os.environ['SSH_AUTH_SOCK'] = os.environ['ANSIBLE_SSH_AGENT'] = sock
|
||||||
@ -1,10 +1,12 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from jinja2 import __version__ as _jinja2_version
|
import importlib.metadata
|
||||||
|
|
||||||
|
jinja2_version = importlib.metadata.version('jinja2')
|
||||||
|
|
||||||
# DTFIX-FUTURE: sanity test to ensure this doesn't drift from requirements
|
# DTFIX-FUTURE: sanity test to ensure this doesn't drift from requirements
|
||||||
_MINIMUM_JINJA_VERSION = (3, 1)
|
_MINIMUM_JINJA_VERSION = (3, 1)
|
||||||
_CURRENT_JINJA_VERSION = tuple(map(int, _jinja2_version.split('.', maxsplit=2)[:2]))
|
_CURRENT_JINJA_VERSION = tuple(map(int, jinja2_version.split('.', maxsplit=2)[:2]))
|
||||||
|
|
||||||
if _CURRENT_JINJA_VERSION < _MINIMUM_JINJA_VERSION:
|
if _CURRENT_JINJA_VERSION < _MINIMUM_JINJA_VERSION:
|
||||||
raise RuntimeError(f'Jinja version {".".join(map(str, _MINIMUM_JINJA_VERSION))} or higher is required (current version {_jinja2_version}).')
|
raise RuntimeError(f'Jinja version {".".join(map(str, _MINIMUM_JINJA_VERSION))} or higher is required (current version {jinja2_version}).')
|
||||||
|
|||||||
@ -0,0 +1,72 @@
|
|||||||
|
from __future__ import annotations as _annotations
|
||||||
|
|
||||||
|
import datetime as _datetime
|
||||||
|
import os as _os
|
||||||
|
import pwd as _pwd
|
||||||
|
import time as _time
|
||||||
|
|
||||||
|
from ansible import constants as _constants
|
||||||
|
from ansible.module_utils._internal import _datatag
|
||||||
|
|
||||||
|
|
||||||
|
def generate_ansible_template_vars(
|
||||||
|
path: str,
|
||||||
|
fullpath: str | None = None,
|
||||||
|
dest_path: str | None = None,
|
||||||
|
include_ansible_managed: bool = True,
|
||||||
|
) -> dict[str, object]:
|
||||||
|
"""
|
||||||
|
Generate and return a dictionary with variable metadata about the template specified by `fullpath`.
|
||||||
|
If `fullpath` is `None`, `path` will be used instead.
|
||||||
|
"""
|
||||||
|
# deprecated description="update the ansible.windows collection to inline this logic instead of calling this internal function" core_version="2.23"
|
||||||
|
if fullpath is None:
|
||||||
|
fullpath = _os.path.abspath(path)
|
||||||
|
|
||||||
|
template_path = fullpath
|
||||||
|
template_stat = _os.stat(template_path)
|
||||||
|
|
||||||
|
template_uid: int | str
|
||||||
|
|
||||||
|
try:
|
||||||
|
template_uid = _pwd.getpwuid(template_stat.st_uid).pw_name
|
||||||
|
except KeyError:
|
||||||
|
template_uid = template_stat.st_uid
|
||||||
|
|
||||||
|
temp_vars = dict(
|
||||||
|
template_host=_os.uname()[1],
|
||||||
|
template_path=path,
|
||||||
|
template_mtime=_datetime.datetime.fromtimestamp(template_stat.st_mtime),
|
||||||
|
template_uid=template_uid,
|
||||||
|
template_run_date=_datetime.datetime.now(),
|
||||||
|
template_destpath=dest_path,
|
||||||
|
template_fullpath=fullpath,
|
||||||
|
)
|
||||||
|
|
||||||
|
if include_ansible_managed: # only inject the config default value if the variable wasn't set
|
||||||
|
temp_vars['ansible_managed'] = _generate_ansible_managed(template_stat)
|
||||||
|
|
||||||
|
return temp_vars
|
||||||
|
|
||||||
|
|
||||||
|
def _generate_ansible_managed(template_stat: _os.stat_result) -> str:
|
||||||
|
"""Generate and return the `ansible_managed` variable."""
|
||||||
|
# deprecated description="remove the `_generate_ansible_managed` function and use a constant instead" core_version="2.23"
|
||||||
|
|
||||||
|
from ansible.template import trust_as_template
|
||||||
|
|
||||||
|
managed_default = _constants.config.get_config_value('DEFAULT_MANAGED_STR')
|
||||||
|
|
||||||
|
managed_str = managed_default.format(
|
||||||
|
# IMPORTANT: These values must be constant strings to avoid template injection.
|
||||||
|
# Use Jinja template expressions where variables are needed.
|
||||||
|
host="{{ template_host }}",
|
||||||
|
uid="{{ template_uid }}",
|
||||||
|
file="{{ template_path }}",
|
||||||
|
)
|
||||||
|
|
||||||
|
ansible_managed = _time.strftime(managed_str, _time.localtime(template_stat.st_mtime))
|
||||||
|
ansible_managed = _datatag.AnsibleTagHelper.tag_copy(managed_default, ansible_managed)
|
||||||
|
ansible_managed = trust_as_template(ansible_managed)
|
||||||
|
|
||||||
|
return ansible_managed
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
"""
|
||||||
|
Testing utilities for use in integration tests, not unit tests or non-test code.
|
||||||
|
Provides better error behavior than Python's `assert` statement.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import contextlib
|
||||||
|
import typing as t
|
||||||
|
|
||||||
|
|
||||||
|
class _Checker:
|
||||||
|
@staticmethod
|
||||||
|
def check(value: object, msg: str | None = 'Value is not truthy.') -> None:
|
||||||
|
"""Raise an `AssertionError` if the given `value` is not truthy."""
|
||||||
|
if not value:
|
||||||
|
raise AssertionError(msg)
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def hard_fail_context(msg: str) -> t.Generator[_Checker]:
|
||||||
|
"""Enter a context which converts all exceptions to `BaseException` and provides a `Checker` instance for making assertions."""
|
||||||
|
try:
|
||||||
|
yield _Checker()
|
||||||
|
except BaseException as ex:
|
||||||
|
raise BaseException(f"Hard failure: {msg}") from ex
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue