Add ansible-core version check to k8s lookup turbo mode (#1253) (#1254)

* feat(lookup): add ansible-core version check for turbo mode in k8s lookup

Add ansible-core version checking to the k8s lookup plugin to match the
behavior already implemented in module_utils/ansiblemodule.py.

When ENABLE_TURBO_MODE is set and ansible-core >= 2.19.0:
- Emit deprecation warning for ENABLE_TURBO_MODE
- Emit version warning explaining turbo mode is unsupported
- Disable turbo mode and fall back to standard LookupBase

This prevents confusing tracebacks when cloud.common (which declares
requires_ansible '>=2.15.0,<2.19') is used on newer ansible-core versions
where it is not fully compatible.

Changes:
- Import ansible_version and LooseVersion
- Add TURBO_UNSUPPORTED_CORE = "2.19.0" constant
- Check version before enabling turbo mode
- Disable turbo mode and warn if version >= 2.19.0

Addresses reviewer feedback on PR #1251 to add version testing to the
lookup plugin matching the module implementation.



* test(lookup): add unit tests for k8s turbo mode version check

Add comprehensive unit tests for the ansible-core version checking logic
in the k8s lookup plugin's turbo mode handling.

Tests validate that when ENABLE_TURBO_MODE is set:
- Turbo mode is disabled on ansible-core >= 2.19.0 (tests 2.19.0 and 2.21.4)
- Turbo mode is enabled on ansible-core < 2.19.0 (tests 2.18.0)
- Appropriate deprecation and version warnings are shown
- Standard LookupBase is used when turbo mode is disabled

Tests also verify that when ENABLE_TURBO_MODE is not set:
- No deprecation or warning messages are shown
- Turbo mode remains disabled
- Standard LookupBase is used

Implementation follows pytest best practices:
- Autouse fixture for module cleanup between tests
- Parametrized tests to avoid duplication (2.19.0 and 2.21.4 share logic)
- Mock assertion methods (assert_called, assert_not_called)
- Module-level import of StandardLookupBase to avoid repetition

Simplified and maintainable: 71 lines vs initial 139-line implementation
(49% reduction through deduplication and better abstractions).



* style: format with black

* fixup! test(lookup): add unit tests for k8s turbo mode version check

* docs: add changelog fragment for k8s lookup turbo version check

Add changelog entry documenting that the k8s lookup plugin now ignores
ENABLE_TURBO_MODE on ansible-core >= 2.19.0 and falls back to standard
LookupBase instead of failing with a traceback.

This complements the existing deprecate-enable-turbo-mode.yml fragment
which covers the module implementation, by documenting the lookup plugin
fix specifically.



* fixup! fixup! test(lookup): add unit tests for k8s turbo mode version check

* fixup! fixup! fixup! test(lookup): add unit tests for k8s turbo mode version check

---------


(cherry picked from commit c46180bb6f)

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
patchback[bot]
2026-09-15 16:42:50 +01:00
committed by GitHub
co-authored by Don Naro Claude Sonnet 4.5
parent 90e868aa37
commit 1016f80aee
3 changed files with 112 additions and 0 deletions
@@ -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