mirror of https://github.com/ansible/ansible.git
Compare commits
18 Commits
| Author | SHA1 | Date |
|---|---|---|
Matt Clay
|
4e861fa9c8 | 7 months ago |
|
Matt Davis
|
f898f9fec6 | 7 months ago |
|
Matt Davis
|
4714194672 | 7 months ago |
|
Abhijeet Kasurde
|
ffbf121182 | 8 months ago |
|
Brian Coca
|
89a4900b61 | 8 months ago |
|
Matt Clay
|
17d4fdd883 | 8 months ago |
|
Lee Garrett
|
7fc916361e | 8 months ago |
|
Matt Davis
|
82ea3addce | 8 months ago |
|
Matt Clay
|
98009c811b | 8 months ago |
|
Sloane Hertel
|
de7c454684 | 8 months ago |
|
Matt Clay
|
80d5f05642 | 8 months ago |
|
Matt Clay
|
ec0d8f3278 | 8 months ago |
|
Abhijeet Kasurde
|
c21a817c47 | 8 months ago |
|
Martin Krizek
|
85cb2baf1f | 8 months ago |
|
Felix Fontein
|
2fcfad54b0 | 8 months ago |
|
Matt Clay
|
6f95a618af | 8 months ago |
|
Matt Martz
|
19d9253ec9 | 8 months ago |
|
Matt Martz
|
8d775ddced | 8 months ago |
@ -0,0 +1,350 @@
|
||||
==================================================================
|
||||
ansible-core 2.19 "What Is and What Should Never Be" Release Notes
|
||||
==================================================================
|
||||
|
||||
.. contents:: Topics
|
||||
|
||||
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 will now result in an error.
|
||||
- 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.
|
||||
- display - The ``collection_name`` arg to ``Display.deprecated`` no longer has any effect. Information about the calling plugin is automatically captured by the display infrastructure, included in the displayed messages, and made available to callbacks.
|
||||
- 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 - The ``collection_name`` arg to Python module-side ``deprecate`` methods no longer has any effect. Information about the calling module is automatically captured by the warning infrastructure and included in the module result.
|
||||
- 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.
|
||||
- callback plugins - The structure of the ``exception``, ``warnings`` and ``deprecations`` values visible to callbacks has changed. Callbacks that inspect or serialize these values may require special handling.
|
||||
- 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 backwards 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``.
|
||||
- plugins - The ``listify_lookup_plugin_terms`` function is obsolete and in most cases no longer needed.
|
||||
- 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 ``ansible_managed`` variable available for certain templating scenarios, such as the ``template`` action and ``template`` lookup has been deprecated. Define and use a custom variable instead of relying on ``ansible_managed``.
|
||||
- templating - The ``disable_lookups`` option has no effect, since plugins must be updated to apply trust before any templating can be performed.
|
||||
- to_yaml/to_nice_yaml filters - Implicit YAML dumping of vaulted value ciphertext is deprecated. Set `dump_vault_tags` to explicitly specify the desired behavior.
|
||||
- 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 paramater 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
|
||||
- omitting task args - Use of omit for task args now properly falls back to args of lower precedence, such as module defaults. Previously an omitted value would obliterate values of lower precedence.
|
||||
- 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)
|
||||
|
||||
Known Issues
|
||||
------------
|
||||
|
||||
- templating - Any string value starting with ``#jinja2:`` which is templated will always be interpreted as Jinja2 configuration overrides. To include this literal value at the start of a string, a space or other character must precede it.
|
||||
- variables - Tagged values cannot be used for dictionary keys in many circumstances.
|
||||
- variables - The values ``None``, ``True`` and ``False`` cannot be tagged because they are singletons. Attempts to apply tags to these values will be silently ignored.
|
||||
@ -1,2 +1,810 @@
|
||||
ancestor: 2.18.0
|
||||
releases: {}
|
||||
releases:
|
||||
2.19.0b1:
|
||||
changes:
|
||||
breaking_changes:
|
||||
- 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.
|
||||
- callback plugins - The structure of the ``exception``, ``warnings`` and ``deprecations``
|
||||
values visible to callbacks has changed. Callbacks that inspect or serialize
|
||||
these values may require special handling.
|
||||
- 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 backwards 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.
|
||||
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`` \u2014 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 paramater 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
|
||||
- omitting task args - Use of omit for task args now properly falls back to
|
||||
args of lower precedence, such as module defaults. Previously an omitted value
|
||||
would obliterate values of lower precedence.
|
||||
- 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)
|
||||
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``.
|
||||
- plugins - The ``listify_lookup_plugin_terms`` function is obsolete and in
|
||||
most cases no longer needed.
|
||||
- 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 ``ansible_managed`` variable available for certain templating
|
||||
scenarios, such as the ``template`` action and ``template`` lookup has been
|
||||
deprecated. Define and use a custom variable instead of relying on ``ansible_managed``.
|
||||
- templating - The ``disable_lookups`` option has no effect, since plugins must
|
||||
be updated to apply trust before any templating can be performed.
|
||||
- to_yaml/to_nice_yaml filters - Implicit YAML dumping of vaulted value ciphertext
|
||||
is deprecated. Set `dump_vault_tags` to explicitly specify the desired behavior.
|
||||
- tree callback - The ``tree`` callback and its associated ad-hoc CLI args (``-t``,
|
||||
``--tree``) are deprecated.
|
||||
known_issues:
|
||||
- templating - Any string value starting with ``#jinja2:`` which is templated
|
||||
will always be interpreted as Jinja2 configuration overrides. To include this
|
||||
literal value at the start of a string, a space or other character must precede
|
||||
it.
|
||||
- variables - Tagged values cannot be used for dictionary keys in many circumstances.
|
||||
- variables - The values ``None``, ``True`` and ``False`` cannot be tagged because
|
||||
they are singletons. Attempts to apply tags to these values will be silently
|
||||
ignored.
|
||||
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 will now result in an error.
|
||||
- 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`` \u2014 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.
|
||||
- display - The ``collection_name`` arg to ``Display.deprecated`` no longer
|
||||
has any effect. Information about the calling plugin is automatically captured
|
||||
by the display infrastructure, included in the displayed messages, and made
|
||||
available to callbacks.
|
||||
- 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 - The ``collection_name`` arg to Python module-side ``deprecate``
|
||||
methods no longer has any effect. Information about the calling module is
|
||||
automatically captured by the warning infrastructure and included in the module
|
||||
result.
|
||||
- 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.
|
||||
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>`__
|
||||
|
||||
'
|
||||
removed_features:
|
||||
- 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).
|
||||
codename: What Is and What Should Never Be
|
||||
fragments:
|
||||
- 2.19.0b1_summary.yaml
|
||||
- 81709-ansible-galaxy-slow-resolution-hints.yml
|
||||
- 81812-ansible-galaxy-negative-spec-is-pinned.yml
|
||||
- 81874-deprecate-datetime-compat.yml
|
||||
- 83642-fix-sanity-ignore-for-uri.yml
|
||||
- 83643-fix-sanity-ignore-for-copy.yml
|
||||
- 83690-get_url-content-disposition-filename.yml
|
||||
- 83700-enable-file-disable-diff.yml
|
||||
- 83757-deprecate-paramiko.yml
|
||||
- 83936-ssh-askpass.yml
|
||||
- 83965-action-groups-schema.yml
|
||||
- 84008-additional-logging.yml
|
||||
- 84019-ignore_unreachable-loop.yml
|
||||
- 84149-add-flush-cache-for-adhoc-commands.yml
|
||||
- 84206-dnf5-apt-auto-install-module-deps.yml
|
||||
- 84213-ansible-galaxy-url-building.yml
|
||||
- 84229-windows-server-2025.yml
|
||||
- 84238-fix-reset_connection-ssh_executable-templated.yml
|
||||
- 84259-dnf5-latest-fix.yml
|
||||
- 84321-added-ansible_uptime_seconds_aix.yml
|
||||
- 84325-validate-modules-seealso-fqcn.yml
|
||||
- 84334-dnf5-consolidate-settings.yml
|
||||
- 84384-fix-undefined-key-host-group-vars.yml
|
||||
- 84419-fix-wait_for_connection-warning.yml
|
||||
- 84468-timeout_become_unreachable.yml
|
||||
- 84473-dict-lookup-type-error-message.yml
|
||||
- 84490-allow-iptables-chain-creation-with-wait.yml
|
||||
- 84496-CallbackBase-get_options.yml
|
||||
- 84540-uri-relative-redirect.yml
|
||||
- 84547-acme-test-container.yml
|
||||
- 84578-dnf5-is_installed-provides.yml
|
||||
- 84660-fix-meta-end_role-linear-strategy.yml
|
||||
- 84685-add-opensuse-microos.yml
|
||||
- 84705-error-message-malformed-plugin-documentation.yml
|
||||
- 84725-deprecate-strategy-plugins.yml
|
||||
- Ansible.Basic-required_if-null.yml
|
||||
- ansible-galaxy-keycloak-service-accounts.yml
|
||||
- ansible-test-added-macos-15.3.yml
|
||||
- ansible-test-containers.yml
|
||||
- ansible-test-coverage-test-files.yml
|
||||
- ansible-test-curl.yml
|
||||
- ansible-test-fix-command-traceback.yml
|
||||
- ansible-test-freebsd-nss.yml
|
||||
- ansible-test-network-detection.yml
|
||||
- ansible-test-nios-container.yml
|
||||
- ansible-test-no-exec-script.yml
|
||||
- ansible-test-probe-error-handling.yml
|
||||
- ansible-test-pylint-fix.yml
|
||||
- ansible-test-remotes.yml
|
||||
- ansible-test-update.yml
|
||||
- apt_key_bye.yml
|
||||
- become-runas-system-deux.yml
|
||||
- buildroot.yml
|
||||
- compat_removal.yml
|
||||
- config.yml
|
||||
- config_dump.yml
|
||||
- copy_validate_input.yml
|
||||
- cron_err.yml
|
||||
- csvfile-col.yml
|
||||
- cve-2024-8775.yml
|
||||
- darwin_pagesize.yml
|
||||
- debconf_empty_password.yml
|
||||
- deprecated.yml
|
||||
- distro_LMDE_6.yml
|
||||
- dnf5-exception-forwarding.yml
|
||||
- dnf5-plugins-compat.yml
|
||||
- dnf5-remove-usage-deprecated-option.yml
|
||||
- feature-uri-add-option-multipart-encoding.yml
|
||||
- file_simplify.yml
|
||||
- find-checksum.yml
|
||||
- find_enoent.yml
|
||||
- fix-ansible-galaxy-ignore-certs.yml
|
||||
- fix-cli-doc-path_undefined.yaml
|
||||
- fix-display-bug-in-action-plugin.yml
|
||||
- fix-include_vars-merge-hash.yml
|
||||
- fix-ipv6-pattern.yml
|
||||
- fix-is-filter-is-test.yml
|
||||
- fix-lookup-sequence-keyword-args-only.yml
|
||||
- fix-module-utils-facts-timeout.yml
|
||||
- fix_errors.yml
|
||||
- follow_redirects_url.yml
|
||||
- gather_facts_netos_fixes.yml
|
||||
- gather_facts_smart_fix.yml
|
||||
- get_url_bsd_style_digest.yml
|
||||
- hide-loop-vars-debug-vars.yml
|
||||
- implicit_flush_handlers_parents.yml
|
||||
- include_delegate_to.yml
|
||||
- interpreter-discovery-auto-legacy.yml
|
||||
- jinja-version.yml
|
||||
- libvirt_lxc.yml
|
||||
- local-become-fixes.yml
|
||||
- lookup_config.yml
|
||||
- macos-correct-lock.yml
|
||||
- no-inherit-stdio.yml
|
||||
- no-return.yml
|
||||
- openrc-status.yml
|
||||
- os_family.yml
|
||||
- package-dnf-action-plugins-facts-fail-msg.yml
|
||||
- package_facts_fix.yml
|
||||
- passlib.yml
|
||||
- pin-wheel.yml
|
||||
- pipelining_refactor.yml
|
||||
- playiterator-add_tasks-optimize.yml
|
||||
- ps-import-sanity.yml
|
||||
- pull_changed_fix.yml
|
||||
- remove_ini_ignored_dir.yml
|
||||
- reserved_module_chekc.yml
|
||||
- respawn-min-python.yml
|
||||
- respawn_os_env.yml
|
||||
- selector_removal.yml
|
||||
- service_facts_fbsd.yml
|
||||
- set_ipv4_and_ipv6_simultaneously.yml
|
||||
- simplify-copy-module.yml
|
||||
- skip-handlers-tagged-play.yml
|
||||
- skip-implicit-flush_handlers-no-notify.yml
|
||||
- skip-role-task-iterator.yml
|
||||
- ssh-agent.yml
|
||||
- ssh-clixml.yml
|
||||
- ssh_raise_exception.yml
|
||||
- string_conversion.yml
|
||||
- sunos_virtinfo.yml
|
||||
- templates_types_datatagging.yml
|
||||
- toml-library-support-dropped.yml
|
||||
- trim_blocks.yml
|
||||
- unarchive_timestamp_t32.yaml
|
||||
- update-resolvelib-lt-2_0_0.yml
|
||||
- uri_httpexception.yml
|
||||
- url_safe_b64_encode_decode.yml
|
||||
- user_action_fix.yml
|
||||
- user_module.yml
|
||||
- user_passphrase.yml
|
||||
- user_ssh_fix.yml
|
||||
- v2.19.0-initial-commit.yaml
|
||||
- vault_cli_fix.yml
|
||||
- vault_docs_fix.yaml
|
||||
- win-async-refactor.yml
|
||||
- win-wdac-audit.yml
|
||||
- windows-exec.yml
|
||||
- winrm-kinit-pexpect.yml
|
||||
release_date: '2025-04-14'
|
||||
2.19.0b2:
|
||||
changes:
|
||||
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).
|
||||
minor_changes:
|
||||
- comment filter - Improve the error message shown when an invalid ``style``
|
||||
argument is provided.
|
||||
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>`__
|
||||
|
||||
'
|
||||
codename: What Is and What Should Never Be
|
||||
fragments:
|
||||
- 2.19.0b2_summary.yaml
|
||||
- 84690-ansible-doc-indent-wrapping.yml
|
||||
- comment_fail.yml
|
||||
- get_bin_path-remove-use-of-deprecated-param.yml
|
||||
release_date: '2025-04-23'
|
||||
|
||||
@ -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 @@
|
||||
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,3 @@
|
||||
---
|
||||
minor_changes:
|
||||
- comment filter - Improve the error message shown when an invalid ``style`` argument is provided.
|
||||
@ -0,0 +1,2 @@
|
||||
bugfixes:
|
||||
- "Remove use of `required` parameter in `get_bin_path` which has been deprecated."
|
||||
@ -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."""
|
||||
|
||||
# DTFIX-RELEASE: 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,40 @@
|
||||
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
|
||||
from ansible.utils.display import Display
|
||||
|
||||
Display().deprecated(f'{__name__!r} is deprecated.', version='2.23', help_text='Call `json.dumps` directly instead.')
|
||||
|
||||
|
||||
def jsonify(result, format=False):
|
||||
"""Format JSON output."""
|
||||
|
||||
if result is None:
|
||||
return "{}"
|
||||
|
||||
indent = None
|
||||
if format:
|
||||
indent = 4
|
||||
|
||||
try:
|
||||
return json.dumps(result, sort_keys=True, indent=indent, ensure_ascii=False)
|
||||
except UnicodeDecodeError:
|
||||
return json.dumps(result, sort_keys=True, indent=indent)
|
||||
@ -0,0 +1,2 @@
|
||||
context/controller
|
||||
shippable/posix/group3
|
||||
@ -0,0 +1,112 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import collections.abc as c
|
||||
import functools
|
||||
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
from ansible.executor.task_result import CallbackTaskResult
|
||||
from ansible.plugins.callback import CallbackBase
|
||||
|
||||
|
||||
class CallbackModule(CallbackBase):
|
||||
# DTFIX-RELEASE: validate VaultedValue redaction behavior
|
||||
|
||||
CALLBACK_NEEDS_ENABLED = True
|
||||
seen_tr = [] # track taskresult instances to ensure every call sees a unique instance
|
||||
|
||||
expects_task_result = {
|
||||
'v2_runner_on_failed', 'v2_runner_on_ok', 'v2_runner_on_skipped', 'v2_runner_on_unreachable', 'v2_runner_on_async_poll', 'v2_runner_on_async_ok',
|
||||
'v2_runner_on_async_failed,', 'v2_playbook_on_import_for_host', 'v2_playbook_on_not_import_for_host', 'v2_on_file_diff', 'v2_runner_item_on_ok',
|
||||
'v2_runner_item_on_failed', 'v2_runner_item_on_skipped', 'v2_runner_retry',
|
||||
}
|
||||
|
||||
expects_no_task_result = {
|
||||
'v2_playbook_on_start', 'v2_playbook_on_notify', 'v2_playbook_on_no_hosts_matched', 'v2_playbook_on_no_hosts_remaining', 'v2_playbook_on_task_start',
|
||||
'v2_playbook_on_cleanup_task_start', 'v2_playbook_on_handler_task_start', 'v2_playbook_on_vars_prompt', 'v2_playbook_on_play_start',
|
||||
'v2_playbook_on_stats', 'v2_playbook_on_include', 'v2_runner_on_start',
|
||||
}
|
||||
|
||||
# we're abusing runtime assertions to signify failure in this integration test component; ensure they're not disabled by opimizations
|
||||
try:
|
||||
assert False
|
||||
except AssertionError:
|
||||
pass
|
||||
else:
|
||||
raise BaseException("this test does not function when running Python with optimization")
|
||||
|
||||
def __init__(self, *args, **kwargs) -> None:
|
||||
super().__init__(*args, **kwargs)
|
||||
self._display = MagicMock()
|
||||
|
||||
@staticmethod
|
||||
def get_first_task_result(args: c.Sequence) -> CallbackTaskResult | None:
|
||||
"""Find the first CallbackTaskResult in posargs, since the signatures are dynamic and we didn't want to use inspect signature binding."""
|
||||
return next((arg for arg in args if isinstance(arg, CallbackTaskResult)), None)
|
||||
|
||||
def v2_on_any(self, *args, **kwargs) -> None:
|
||||
"""Standard behavioral test for the v2_on_any callback method."""
|
||||
print(f'hello from v2_on_any {args=} {kwargs=}')
|
||||
if result := self.get_first_task_result(args):
|
||||
assert isinstance(result, CallbackTaskResult)
|
||||
|
||||
assert result is self._current_task_result
|
||||
|
||||
assert result not in self.seen_tr
|
||||
|
||||
self.seen_tr.append(result)
|
||||
else:
|
||||
assert self._current_task_result is None
|
||||
|
||||
def v2_method_expects_task_result(self, *args, method_name: str, **_kwargs) -> None:
|
||||
"""Standard behavioral tests for callback methods accepting a task result; wired dynamically."""
|
||||
print(f'hello from {method_name}')
|
||||
result = self.get_first_task_result(args)
|
||||
|
||||
assert result is self._current_task_result
|
||||
|
||||
assert isinstance(result, CallbackTaskResult)
|
||||
|
||||
assert result not in self.seen_tr
|
||||
|
||||
self.seen_tr.append(result)
|
||||
|
||||
has_exception = bool(result.exception)
|
||||
has_warnings = bool(result.warnings)
|
||||
has_deprecations = bool(result.deprecations)
|
||||
|
||||
self._display.reset_mock()
|
||||
|
||||
self._handle_exception(result.result) # pops exception from transformed dict
|
||||
|
||||
if has_exception:
|
||||
assert 'exception' not in result.result
|
||||
self._display._error.assert_called()
|
||||
|
||||
self._display.reset_mock()
|
||||
|
||||
self._handle_warnings(result.result) # pops warnings/deprecations from transformed dict
|
||||
|
||||
if has_warnings:
|
||||
assert 'warnings' not in result.result
|
||||
self._display._warning.assert_called()
|
||||
|
||||
if has_deprecations:
|
||||
assert 'deprecations' not in result.result
|
||||
self._display._deprecated.assert_called()
|
||||
|
||||
def v2_method_expects_no_task_result(self, *args, method_name: str, **_kwargs) -> None:
|
||||
"""Standard behavioral tests for non-task result callback methods; wired dynamically."""
|
||||
print(f'hello from {method_name}')
|
||||
|
||||
assert self.get_first_task_result(args) is None
|
||||
|
||||
assert self._current_task_result is None
|
||||
|
||||
def __getattribute__(self, item: str) -> object:
|
||||
if item in CallbackModule.expects_task_result:
|
||||
return functools.partial(CallbackModule.v2_method_expects_task_result, self, method_name=item)
|
||||
elif item in CallbackModule.expects_no_task_result:
|
||||
return functools.partial(CallbackModule.v2_method_expects_no_task_result, self, method_name=item)
|
||||
else:
|
||||
return object.__getattribute__(self, item)
|
||||
@ -0,0 +1,14 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def main() -> None:
|
||||
m = AnsibleModule({})
|
||||
m.warn("This is a warning.")
|
||||
m.deprecate("This is a deprecation.", version='9999.9')
|
||||
m.exit_json()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,5 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -eux
|
||||
|
||||
ANSIBLE_STDOUT_CALLBACK=legacy_warning_display ansible-playbook test.yml "${@}"
|
||||
@ -0,0 +1,20 @@
|
||||
- hosts: localhost
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- noisy:
|
||||
register: noisyout
|
||||
async: 5
|
||||
poll: 1
|
||||
loop: [1, 2]
|
||||
|
||||
- noisy:
|
||||
async: 5
|
||||
poll: 1
|
||||
register: noisyout
|
||||
|
||||
- debug:
|
||||
when: false
|
||||
|
||||
- debug:
|
||||
var: 1/0
|
||||
ignore_errors: true
|
||||
@ -0,0 +1,14 @@
|
||||
- hosts: testhost
|
||||
gather_facts: no
|
||||
tasks:
|
||||
- name: invoke a module that returns a warning and deprecation warning
|
||||
noisy:
|
||||
register: result
|
||||
|
||||
- name: verify the warning and deprecation are visible in templating
|
||||
assert:
|
||||
that:
|
||||
- result.warnings | length == 1
|
||||
- result.warnings[0] == "This is a warning."
|
||||
- result.deprecations | length == 1
|
||||
- result.deprecations[0].msg == "This is a deprecation."
|
||||
@ -0,0 +1,14 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def main() -> None:
|
||||
m = AnsibleModule({})
|
||||
m.warn("This is a warning.")
|
||||
m.deprecate("This is a deprecation.", version='9999.9')
|
||||
m.exit_json()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -1,2 +0,0 @@
|
||||
Provoke a python2.6 json bug
|
||||
{{ hostvars[inventory_hostname] | to_nice_json }}
|
||||
@ -1,118 +0,0 @@
|
||||
# (c) 2016, Steve Kuznetsov <skuznets@redhat.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
from ansible.executor.task_queue_manager import TaskQueueManager
|
||||
from ansible.playbook import Playbook
|
||||
from ansible.plugins.callback import CallbackBase
|
||||
from ansible.utils import context_objects as co
|
||||
|
||||
|
||||
class TestTaskQueueManagerCallbacks(unittest.TestCase):
|
||||
def setUp(self):
|
||||
inventory = MagicMock()
|
||||
variable_manager = MagicMock()
|
||||
loader = MagicMock()
|
||||
passwords = []
|
||||
|
||||
# Reset the stored command line args
|
||||
co.GlobalCLIArgs._Singleton__instance = None
|
||||
self._tqm = TaskQueueManager(inventory, variable_manager, loader, passwords)
|
||||
self._playbook = Playbook(loader)
|
||||
|
||||
# we use a MagicMock to register the result of the call we
|
||||
# expect to `v2_playbook_on_call`. We don't mock out the
|
||||
# method since we're testing code that uses `inspect` to
|
||||
# look at that method's argspec and we want to ensure this
|
||||
# test is easy to reason about.
|
||||
self._register = MagicMock()
|
||||
|
||||
def tearDown(self):
|
||||
# Reset the stored command line args
|
||||
co.GlobalCLIArgs._Singleton__instance = None
|
||||
|
||||
def test_task_queue_manager_callbacks_v2_playbook_on_start(self):
|
||||
"""
|
||||
Assert that no exceptions are raised when sending a Playbook
|
||||
start callback to a current callback module plugin.
|
||||
"""
|
||||
register = self._register
|
||||
|
||||
class CallbackModule(CallbackBase):
|
||||
"""
|
||||
This is a callback module with the current
|
||||
method signature for `v2_playbook_on_start`.
|
||||
"""
|
||||
CALLBACK_VERSION = 2.0
|
||||
CALLBACK_TYPE = 'notification'
|
||||
CALLBACK_NAME = 'current_module'
|
||||
|
||||
def v2_playbook_on_start(self, playbook):
|
||||
register(self, playbook)
|
||||
|
||||
callback_module = CallbackModule()
|
||||
self._tqm._callback_plugins.append(callback_module)
|
||||
self._tqm.send_callback('v2_playbook_on_start', self._playbook)
|
||||
register.assert_called_once_with(callback_module, self._playbook)
|
||||
|
||||
def test_task_queue_manager_callbacks_v2_playbook_on_start_wrapped(self):
|
||||
"""
|
||||
Assert that no exceptions are raised when sending a Playbook
|
||||
start callback to a wrapped current callback module plugin.
|
||||
"""
|
||||
register = self._register
|
||||
|
||||
def wrap_callback(func):
|
||||
"""
|
||||
This wrapper changes the exposed argument
|
||||
names for a method from the original names
|
||||
to (*args, **kwargs). This is used in order
|
||||
to validate that wrappers which change par-
|
||||
ameter names do not break the TQM callback
|
||||
system.
|
||||
|
||||
:param func: function to decorate
|
||||
:return: decorated function
|
||||
"""
|
||||
|
||||
def wrapper(*args, **kwargs):
|
||||
return func(*args, **kwargs)
|
||||
|
||||
return wrapper
|
||||
|
||||
class WrappedCallbackModule(CallbackBase):
|
||||
"""
|
||||
This is a callback module with the current
|
||||
method signature for `v2_playbook_on_start`
|
||||
wrapped in order to change the signature.
|
||||
"""
|
||||
CALLBACK_VERSION = 2.0
|
||||
CALLBACK_TYPE = 'notification'
|
||||
CALLBACK_NAME = 'current_module'
|
||||
|
||||
@wrap_callback
|
||||
def v2_playbook_on_start(self, playbook):
|
||||
register(self, playbook)
|
||||
|
||||
callback_module = WrappedCallbackModule()
|
||||
self._tqm._callback_plugins.append(callback_module)
|
||||
self._tqm.send_callback('v2_playbook_on_start', self._playbook)
|
||||
register.assert_called_once_with(callback_module, self._playbook)
|
||||
Loading…
Reference in New Issue