diff --git a/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml b/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml new file mode 100644 index 00000000..1bea8754 --- /dev/null +++ b/changelogs/fragments/1253-k8s-lookup-turbo-version-check.yml @@ -0,0 +1,5 @@ +--- +bugfixes: + - k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. + Fall back to the standard ``LookupBase`` instead of failing with a traceback + (https://github.com/ansible-collections/kubernetes.core/pull/1253). diff --git a/plugins/lookup/k8s.py b/plugins/lookup/k8s.py index 1f508082..9028ef29 100644 --- a/plugins/lookup/k8s.py +++ b/plugins/lookup/k8s.py @@ -211,6 +211,7 @@ RETURN = """ import os from ansible.errors import AnsibleError +from ansible.module_utils.ansible_release import __version__ as ansible_version from ansible.module_utils.common._collections_compat import KeysView from ansible.module_utils.common.validation import check_type_bool from ansible.utils.display import Display @@ -220,9 +221,17 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import ( create_definitions, ) +from ansible_collections.kubernetes.core.plugins.module_utils.version import ( + LooseVersion, +) display = Display() +# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the +# import still succeeds, so the version has to be checked explicitly: relying on +# ImportError alone lets turbo mode fail later with an unrelated traceback. +TURBO_UNSUPPORTED_CORE = "2.19.0" + try: enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE")) except TypeError: @@ -236,6 +245,15 @@ if enable_turbo_mode: version="8.0.0", collection_name="kubernetes.core", ) + if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE): + display.warning( + "ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires " + "the cloud.common collection, which supports ansible-core < %s only. " + "Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE) + ) + enable_turbo_mode = False + +if enable_turbo_mode: try: from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import ( TurboLookupBase as LookupBase, diff --git a/tests/unit/plugins/lookup/test_k8s_turbo.py b/tests/unit/plugins/lookup/test_k8s_turbo.py new file mode 100644 index 00000000..9a18050a --- /dev/null +++ b/tests/unit/plugins/lookup/test_k8s_turbo.py @@ -0,0 +1,89 @@ +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +import sys +from unittest.mock import MagicMock, patch + +import pytest +from ansible.plugins.lookup import LookupBase as StandardLookupBase + + +class TestK8sTurboMode: + """Test turbo mode version checking in k8s lookup plugin.""" + + @pytest.fixture(autouse=True) + def cleanup_k8s_module(self): + """Ensure clean module state before each test.""" + sys.modules.pop("ansible_collections.kubernetes.core.plugins.lookup.k8s", None) + + @pytest.mark.parametrize("ansible_version", ["2.19.0", "2.21.4"]) + def test_turbo_mode_disabled_on_newer_ansible(self, monkeypatch, ansible_version): + """Test that turbo mode is disabled on ansible-core >= 2.19.0.""" + monkeypatch.setenv("ENABLE_TURBO_MODE", "true") + mock_display = MagicMock() + + with patch.dict( + "sys.modules", + { + "ansible.module_utils.ansible_release": MagicMock( + __version__=ansible_version + ), + "ansible.utils.display": MagicMock(Display=lambda: mock_display), + }, + ): + from ansible_collections.kubernetes.core.plugins.lookup import k8s + + mock_display.deprecated.assert_called() + assert ( + "ENABLE_TURBO_MODE is deprecated" + in mock_display.deprecated.call_args[0][0] + ) + + mock_display.warning.assert_called() + assert ( + f"ENABLE_TURBO_MODE is ignored on ansible-core {ansible_version}" + in mock_display.warning.call_args[0][0] + ) + assert "ansible-core < 2.19.0 only" in mock_display.warning.call_args[0][0] + + assert k8s.LookupBase == StandardLookupBase + + def test_turbo_mode_enabled_on_ansible_core_2_18(self, monkeypatch): + """Test that turbo mode is still enabled on ansible-core < 2.19.0.""" + monkeypatch.setenv("ENABLE_TURBO_MODE", "true") + mock_display = MagicMock() + mock_turbo_lookup = MagicMock() + + with patch.dict( + "sys.modules", + { + "ansible.module_utils.ansible_release": MagicMock(__version__="2.18.0"), + "ansible.utils.display": MagicMock(Display=lambda: mock_display), + "ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup": mock_turbo_lookup, + }, + ): + from ansible_collections.kubernetes.core.plugins.lookup import ( # noqa: F401 + k8s, + ) + + mock_display.deprecated.assert_called() + assert not mock_display.warning.called + + def test_turbo_mode_disabled_when_env_not_set(self, monkeypatch): + """Test that turbo mode is disabled when ENABLE_TURBO_MODE is not set.""" + monkeypatch.delenv("ENABLE_TURBO_MODE", raising=False) + mock_display = MagicMock() + + with patch.dict( + "sys.modules", + { + "ansible.module_utils.ansible_release": MagicMock(__version__="2.18.0"), + "ansible.utils.display": MagicMock(Display=lambda: mock_display), + }, + ): + from ansible_collections.kubernetes.core.plugins.lookup import k8s + + mock_display.deprecated.assert_not_called() + mock_display.warning.assert_not_called() + assert k8s.LookupBase == StandardLookupBase