Address ansible 2.15 compatibility related to AnsibleCollectionConfig (…

…#213)

.github/workflows/tox.yml

@@ -30,6 +30,7 @@ jobs:
             py38-ansible212
             py38-ansible213
             py39-ansible214
+            py311-devel
           platforms: linux,macos
           macos: minmax
   build:

.pre-commit-config.yaml

@@ -79,6 +79,7 @@ repos:
         # empty args needed in order to match mypy cli behavior
         args: ["--strict"]
         additional_dependencies:
+          - ansible-core
           - cached_property
           - packaging
           - pytest

pyproject.toml

@@ -92,6 +92,10 @@ disallow_any_generics = true
 # warn_unused_configs = True
 exclude = "test/local-content"
 
+[[tool.mypy.overrides]]
+module = "ansible.*"
+ignore_missing_imports = true
+
 [tool.isort]
 profile = "black"
 

src/ansible_compat/runtime.py

@@ -123,6 +123,25 @@ def _ensure_module_available(self) -> None:
                 "indicates a broken execution environment."
             )
 
+        # For ansible 2.15+ we need to initialize the plugin loader
+        # https://github.com/ansible/ansible-lint/issues/2945
+        if self.version >= Version("2.15.0.dev0"):
+            # pylint: disable=import-outside-toplevel
+            from ansible.plugins.loader import init_plugin_loader
+
+            init_plugin_loader([])
+        else:
+            # noinspection PyProtectedMember
+            from ansible.utils.collection_loader._collection_finder import (  # pylint: disable=import-outside-toplevel
+                _AnsibleCollectionFinder,
+            )
+
+            # noinspection PyProtectedMember
+            # pylint: disable=protected-access
+            _AnsibleCollectionFinder(
+                paths=[os.path.dirname(os.environ.get(ansible_collections_path(), "."))]
+            )._install()  # pylint: disable=protected-access
+
     def clean(self) -> None:
         """Remove content of cache_dir."""
         if self.cache_dir:

test/test_runtime.py

@@ -66,6 +66,13 @@ def test_runtime_mismatch_ansible_module(monkeypatch: MonkeyPatch) -> None:
 def test_runtime_require_module() -> None:
     """Check that require_module successful pass."""
     Runtime(require_module=True)
+    # Now we try to set the collection path, something to check if that is
+    # causing an exception, as 2.15 introduced new init code.
+    from ansible.utils.collection_loader import (  # pylint: disable=import-outside-toplevel
+        AnsibleCollectionConfig,
+    )
+
+    AnsibleCollectionConfig.playbook_paths = "."
 
 
 def test_runtime_version_fail_module(mocker: MockerFixture) -> None:

tox.ini

@@ -53,6 +53,7 @@ passenv =
   LC_ALL
   LC_CTYPE
 setenv =
+  ANSIBLE_DEVEL_WARNING='false'
   COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
   PIP_DISABLE_PIP_VERSION_CHECK = 1
   PIP_CONSTRAINT = {toxinidir}/requirements.txt