Merge pull request #1524 from moreati/ansible14

Ansible 14 compatibility

Author: moreati

.github/workflows/tests.yml

@@ -118,8 +118,10 @@ jobs:
             python_version: '3.14'
           - tox_env: py314-m_ans-ans13
             python_version: '3.14'
+          - tox_env: py314-m_ans-ans14
+            python_version: '3.14'
 
-          - tox_env: py314-m_ans-ans13-s_lin
+          - tox_env: py314-m_ans-ans14-s_lin
             python_version: '3.14'
 
           - tox_env: py314-m_mtg
@@ -171,17 +173,17 @@ jobs:
     name: macos ${{ matrix.tox_env }}
     # https://github.com/actions/runner-images/blob/main/images/macos/macos-15-Readme.md
     runs-on: macos-15
-    timeout-minutes: 15
+    timeout-minutes: 20
     env:
       MITOGEN_TEST_SKIP_CONTAINER_TESTS: 1
 
     strategy:
       fail-fast: false
       matrix:
         include:
-          - tox_env: py314-m_lcl-ans13
+          - tox_env: py314-m_lcl-ans14
             python_version: '3.14'
-          - tox_env: py314-m_lcl-ans13-s_lin
+          - tox_env: py314-m_lcl-ans14-s_lin
             python_version: '3.14'
 
           - tox_env: py314-m_mtg

ansible_mitogen/mixins.py

@@ -373,7 +373,10 @@ def _execute_module(self, module_name=None, module_args=None, tmp=None,
             self._connection.context = None
 
         self._connection._connect()
-        result = ansible_mitogen.planner.invoke(
+
+        # Ansible <= 13 (ansible-core <= 2.20): dict
+        # Ansible >= 14 (ansible-core >= 2.21): UnifiedTaskResult
+        task_result = ansible_mitogen.planner.invoke(
             ansible_mitogen.planner.Invocation(
                 action=self,
                 connection=self._connection,
@@ -393,59 +396,56 @@ def _execute_module(self, module_name=None, module_args=None, tmp=None,
             self._remove_tmp_path(tmp)
 
         # prevents things like discovered_interpreter_* or ansible_discovered_interpreter_* from being set
-        ansible.vars.clean.remove_internal_keys(result)
+        try:
+            task_result.remove_internal_keys()
+        except AttributeError:
+            ansible.vars.clean.remove_internal_keys(task_result)
 
         # taken from _execute_module of ansible 2.8.6
         # propagate interpreter discovery results back to the controller
         if self._discovered_interpreter_key:
-            if result.get('ansible_facts') is None:
-                result['ansible_facts'] = {}
-
             # only cache discovered_interpreter if we're not running a rediscovery
             # rediscovery happens in places like docker connections that could have different
             # python interpreters than the main host
             if not self._mitogen_rediscovered_interpreter:
-                result['ansible_facts'][self._discovered_interpreter_key] = self._discovered_interpreter
+                di_key = self._discovered_interpreter_key
+                di_val = self._discovered_interpreter
+                try:
+                    task_result.set_fact(di_key, di_val)
+                except AttributeError:
+                    task_result.setdefault('ansible_facts', {})[di_key] = di_val
 
         discovery_warnings = getattr(self, '_discovery_warnings', [])
         if discovery_warnings:
-            if result.get('warnings') is None:
-                result['warnings'] = []
-            result['warnings'].extend(discovery_warnings)
+            try:
+                task_result._extend_warnings(discovery_warnings)
+            except AttributeError:
+                task_result.setdefault('warnings', []).extend(discovery_warnings)
 
         discovery_deprecation_warnings = getattr(self, '_discovery_deprecation_warnings', [])
         if discovery_deprecation_warnings:
-            if result.get('deprecations') is None:
-                result['deprecations'] = []
-            result['deprecations'].extend(discovery_deprecation_warnings)
+            try:
+                task_result._extend_deprecations(discovery_deprecation_warnings)
+            except AttributeError:
+                task_result.setdefault('deprecations', []).extend(discovery_deprecation_warnings)
 
-        return ansible.utils.unsafe_proxy.wrap_var(result)
+        if ansible_mitogen.utils.ansible_version[:2] >= (2, 21):
+            task_result = task_result.as_result_dict(for_round_trip=True)
+        return ansible.utils.unsafe_proxy.wrap_var(task_result)
 
     def _postprocess_response(self, result):
-        """
-        Apply fixups mimicking ActionBase._execute_module(); this is copied
-        verbatim from action/__init__.py, the guts of _parse_returned_data are
-        garbage and should be removed or reimplemented once tests exist.
-
-        :param dict result:
-            Dictionary with format::
-
-                {
-                    "rc": int,
-                    "stdout": "stdout data",
-                    "stderr": "stderr data"
-                }
-        """
         if ansible_mitogen.utils.ansible_version[:2] >= (2, 19):
             data = self._parse_returned_data(result, profile='legacy')
         else:
             data = self._parse_returned_data(result)
 
-        # Cutpasted from the base implementation.
-        if 'stdout' in data and 'stdout_lines' not in data:
-            data['stdout_lines'] = (data['stdout'] or u'').splitlines()
-        if 'stderr' in data and 'stderr_lines' not in data:
-            data['stderr_lines'] = (data['stderr'] or u'').splitlines()
+        # ansible-core >= 2.21: done in UnifiedTaskResult.as_result_dict()
+        if ansible_mitogen.utils.ansible_version[:2] <= (2, 20):
+            # Cutpasted from the base implementation.
+            if 'stdout' in data and 'stdout_lines' not in data:
+                data['stdout_lines'] = (data['stdout'] or u'').splitlines()
+            if 'stderr' in data and 'stderr_lines' not in data:
+                data['stderr_lines'] = (data['stderr'] or u'').splitlines()
 
         return data
 

ansible_mitogen/transport_config.py

@@ -79,6 +79,11 @@
 
 LOG = logging.getLogger(__name__)
 
+if ansible_mitogen.utils.ansible_version[:2] >= (2, 21):
+    _INTERPRETER_DISCOVERY_MODES = frozenset(['auto', 'auto_silent'])
+else:
+    _INTERPRETER_DISCOVERY_MODES = frozenset(['auto', 'auto_legacy', 'auto_silent', 'auto_legacy_silent'])
+
 if ansible_mitogen.utils.ansible_version[:2] >= (2, 19):
     _FALLBACK_INTERPRETER = ansible.executor.interpreter_discovery._FALLBACK_INTERPRETER
 elif ansible_mitogen.utils.ansible_version[:2] >= (2, 17):
@@ -98,7 +103,7 @@ def run_interpreter_discovery_if_necessary(s, candidates, task_vars, action, red
     if action._mitogen_discovering_interpreter:
         return action._mitogen_interpreter_candidate
 
-    if s in ['auto', 'auto_legacy', 'auto_silent', 'auto_legacy_silent']:
+    if s in _INTERPRETER_DISCOVERY_MODES:
         # python is the only supported interpreter_name as of Ansible 2.8.8
         interpreter_name = 'python'
         discovered_interpreter_config = u'discovered_interpreter_%s' % interpreter_name

docs/ansible_detailed.rst

@@ -145,7 +145,9 @@ Noteworthy Differences
   +-----------------+ 3.11 - 3.14     |
   | 12              |                 |
   +-----------------+-----------------+
-  | 13              | 3.12 - 3.14     |
+  | 13              |                 |
+  +-----------------+ 3.12 - 3.14     |
+  | 14              |                 |
   +-----------------+-----------------+
 
   Verify your installation is running one of these versions by checking

docs/changelog.rst

@@ -21,8 +21,11 @@ To avail of fixes in an unreleased version, please download a ZIP file
 In progress (unreleased)
 ------------------------
 
+* :gh:issue:`1523` :mod:`ansible_mitogen`: First Ansible 14 support
 * :gh:issue:`1518` :mod:`mitogen`: Fix sudo authentication when the translated
   password prompt doesn't contain U+003A COLON
+* :gh:issue:`1523` tests: Split auto, auto_legacy, auto_legacy_silent
+  interpreter discovery tests
 
 
 v0.3.48 (2026-05-22)

tests/ansible/integration/async/result_shell_echo_hi.yml

@@ -5,6 +5,10 @@
   tasks:
 
   - name: Async shell
+    vars:
+      # Ansible >= 14 (ansible-core >= 2.21) omits the "invocation" key by
+      # default, https://github.com/ansible/ansible/pull/86771
+      ansible_inject_invocation: true
     shell: echo hi; echo there >&2
     async: 100
     poll: 0
@@ -26,6 +30,7 @@
         - async_out.cmd == "echo hi; echo there >&2"
         - 'async_out.delta.startswith("0:00:")'
         - async_out.end.startswith("20")
+        - async_out.invocation is defined
         - async_out.invocation.module_args._raw_params == "echo hi; echo there >&2"
         - async_out.invocation.module_args._uses_shell == True
         - async_out.invocation.module_args.chdir == None

tests/ansible/integration/async/runner_with_polling_and_timeout.yml

@@ -21,6 +21,10 @@
           job1.msg == "async task did not complete within the requested time" or
           job1.msg == "async task did not complete within the requested time - 1s" or
           job1.msg == "Job reached maximum time limit of 1 seconds."
+          or (
+            ansible_version_major_minor is version('2.21', '>=', strict=True)
+            and job1.msg == "async task produced unparsable results"
+          )
       fail_msg: |
         job1={{ job1 }}
   tags:

tests/ansible/integration/interpreter_discovery/all.yml

@@ -1,2 +1,4 @@
 - import_playbook: complex_args.yml
-- import_playbook: ansible_2_8_tests.yml
+- import_playbook: auto.yml
+- import_playbook: auto_legacy.yml
+- import_playbook: auto_legacy_silent.yml

…erpreter_discovery/ansible_2_8_tests.yml …tegration/interpreter_discovery/auto.ymltests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml renamed to tests/ansible/integration/interpreter_discovery/auto.yml tests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml renamed to tests/ansible/integration/interpreter_discovery/auto.yml

@@ -1,6 +1,5 @@
 # ripped and ported from https://github.com/ansible/ansible/pull/50163/files, when interpreter discovery was added to ansible
----
-- name: integration/interpreter_discovery/ansible_2_8_tests.yml, baseline
+- name: integration/interpreter_discovery/auto.yml, linear
   hosts: test-targets
   strategy: linear
   tasks:
@@ -12,7 +11,7 @@
       register: linear_auto_result
 
 
-- name: integration/interpreter_discovery/ansible_2_8_tests.yml
+- name: integration/interpreter_discovery/auto.yml
   hosts: test-targets
   gather_facts: true
   tasks:
@@ -69,48 +68,6 @@
                 or not (echoout.running_python.sys.platform == "darwin"
                         and echoout.running_python.platform.release.major == 20)
 
-
-        - name: test that auto_legacy gives a dep warning when /usr/bin/python present but != auto result
-          block:
-          - name: clear facts to force interpreter discovery to run
-            meta: clear_facts
-
-          - name: trigger discovery with auto_legacy
-            vars:
-              ansible_python_interpreter: auto_legacy
-            ping:
-            register: legacy
-
-          - name: check for dep warning (only on platforms where auto result is not /usr/bin/python and legacy is) for ansible 2.8-2.11
-            # from ansible 2.12 on this changed
-            #  - https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_5.html#python-interpreter-discovery
-            #  - https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html
-            # default discovery method is now auto and will default to python3
-            # and the message changed from a deprecation warning to a real warning that can not be suppressed by
-            # using deprecation_warnings=False
-            assert:
-              that:
-              - legacy.deprecations | default([]) | length > 0
-              fail_msg: |
-                legacy={{ legacy }}
-            # only check for a dep warning if legacy returned /usr/bin/python and auto didn't
-            when:
-              - legacy.ansible_facts.discovered_interpreter_python == '/usr/bin/python'
-              - auto_out.ansible_facts.discovered_interpreter_python != '/usr/bin/python'
-              - ansible_version_major_minor is version('2.12', '<', strict=True)
-
-          - name: check for warning (only on platforms where auto result is not /usr/bin/python and legacy is) from ansible 2.12 on
-            assert:
-              that:
-              - legacy.warnings | default([]) | length > 0
-              fail_msg: |
-                legacy={{ legacy }}
-            # only check for a warning if legacy returned /usr/bin/python and auto didn't
-            when:
-              - legacy.ansible_facts.discovered_interpreter_python == '/usr/bin/python'
-              -  auto_out.ansible_facts.discovered_interpreter_python != '/usr/bin/python'
-              -  ansible_version_major_minor is version('2.12', '>=', strict=True)
-
         - name: test that auto_silent never warns and got the same answer as auto
           block:
           - name: clear facts to force interpreter discovery to run
@@ -129,25 +86,6 @@
               fail_msg: |
                 auto_silent_out={{ auto_silent_out }}
 
-
-        - name: test that auto_legacy_silent never warns and got the same answer as auto_legacy
-          block:
-          - name: clear facts to force interpreter discovery to run
-            meta: clear_facts
-
-          - name: trigger discovery with auto_legacy_silent
-            vars:
-              ansible_python_interpreter: auto_legacy_silent
-            ping:
-            register: legacy_silent
-
-          - assert:
-              that:
-                - legacy_silent.warnings is not defined
-                - legacy_silent.ansible_facts.discovered_interpreter_python == legacy.ansible_facts.discovered_interpreter_python
-              fail_msg: |
-                legacy_silent={{ legacy_silent }}
-
         - name: ensure modules can't set discovered_interpreter_X or ansible_X_interpreter
           block:
           - test_echo_module:
@@ -180,5 +118,3 @@
           - meta: clear_facts
       when:
         - ansible_version_major_minor is version('2.8', '>=', strict=True)
-  tags:
-    - ansible_2_8_tests

tests/ansible/integration/interpreter_discovery/auto_legacy.yml

@@ -0,0 +1,53 @@
+- name: integration/interpreter_discovery/auto_legacy.yml
+  hosts: test-targets
+  gather_facts: true
+  tasks:
+    - meta: end_play
+      when:
+        # Ansible 14 (ansible-core 2.21) removed auto_legacy & auto_legacy_silent
+        - ansible_version_major_minor is version('2.7', '<=', strict=True)
+          or ansible_version_major_minor is version('2.21', '>=', strict=True)
+
+    - meta: clear_facts
+    - name: Discover with auto
+      vars:
+        ansible_python_interpreter: auto
+      ping:
+      register: auto_result
+
+    - meta: clear_facts
+    - name: Discover with auto_legacy
+      vars:
+        ansible_python_interpreter: auto_legacy
+      ping:
+      register: auto_legacy_result
+
+    - name: check for dep warning (only on platforms where auto result is not /usr/bin/python and legacy is) for ansible 2.8-2.11
+      # from ansible 2.12 on this changed
+      #  - https://docs.ansible.com/ansible/devel/porting_guides/porting_guide_5.html#python-interpreter-discovery
+      #  - https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html
+      # default discovery method is now auto and will default to python3
+      # and the message changed from a deprecation warning to a real warning that can not be suppressed by
+      # using deprecation_warnings=False
+      assert:
+        that:
+        - auto_legacy_result.deprecations | default([]) | length > 0
+        fail_msg: |
+          auto_legacy_result={{ auto_legacy_result }}
+      # only check for a dep warning if auto_legacy returned /usr/bin/python and auto didn't
+      when:
+        - ansible_version_major_minor is version('2.12', '<', strict=True)
+        - auto_legacy_result.ansible_facts.discovered_interpreter_python == '/usr/bin/python'
+        - auto_result.ansible_facts.discovered_interpreter_python != '/usr/bin/python'
+
+    - name: check for warning (only on platforms where auto result is not /usr/bin/python and legacy is) from ansible 2.12 on
+      assert:
+        that:
+        - auto_legacy_result.warnings | default([]) | length > 0
+        fail_msg: |
+          auto_legacy_result={{ auto_legacy_result }}
+      # only check for a warning if auto_legacy returned /usr/bin/python and auto didn't
+      when:
+        - ansible_version_major_minor is version('2.12', '>=', strict=True)
+        - auto_legacy_result.ansible_facts.discovered_interpreter_python == '/usr/bin/python'
+        - auto_result.ansible_facts.discovered_interpreter_python != '/usr/bin/python'