Ensure that presence of pytest-ansible does not break ansible-test (#478)

Author: ssbarnea

.config/pydoclint-baseline.txt

@@ -142,14 +142,6 @@ src/pytest_ansible/molecule.py
     DOC103: Method `MoleculeScenario.__init__`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [name: str, parent_directory: Path, test_id: str].
 --------------------
 src/pytest_ansible/plugin.py
-    DOC101: Function `pytest_addoption`: Docstring contains fewer arguments than in function signature.
-    DOC106: Function `pytest_addoption`: The option `--arg-type-hints-in-signature` is `True` but there are no argument type hints in the signature
-    DOC107: Function `pytest_addoption`: The option `--arg-type-hints-in-signature` is `True` but not all args in the signature have type hints
-    DOC103: Function `pytest_addoption`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [parser: ].
-    DOC101: Function `pytest_configure`: Docstring contains fewer arguments than in function signature.
-    DOC106: Function `pytest_configure`: The option `--arg-type-hints-in-signature` is `True` but there are no argument type hints in the signature
-    DOC107: Function `pytest_configure`: The option `--arg-type-hints-in-signature` is `True` but not all args in the signature have type hints
-    DOC103: Function `pytest_configure`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [config: ].
     DOC101: Function `pytest_collect_file`: Docstring contains fewer arguments than in function signature.
     DOC103: Function `pytest_collect_file`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [file_path: Path | None, parent: pytest.Collector].
     DOC201: Function `pytest_collect_file` does not have a return section in docstring

.gitignore

@@ -174,3 +174,4 @@ _readthedocs
 
 # JetBrains
 .idea
+tests/fixtures/ansible_collections/test/test/tests/output

pyproject.toml

@@ -371,6 +371,7 @@ required-imports = ["from __future__ import annotations"]
 [tool.ruff.lint.per-file-ignores]
 "_version.py" = ["SIM108"]
 "tests/**" = ["SLF001", "S101", "S602", "T201"]
+"tests/fixtures/ansible_collections/test/test/tests/unit/plugins/modules/test_pool.py" = ["INP001"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

src/pytest_ansible/has_version.py

@@ -2,15 +2,27 @@
 
 from __future__ import annotations
 
-import ansible
 
-from packaging.version import parse as parse_version
+has_ansible_v2 = False
+has_ansible_v24 = False
+has_ansible_v28 = False
+has_ansible_v29 = False
+has_ansible_v212 = False
+has_ansible_v213 = False
+has_ansible_v219 = False
 
+try:
+    import ansible
 
-has_ansible_v2 = parse_version(ansible.__version__) >= parse_version("2.0.0")
-has_ansible_v24 = parse_version(ansible.__version__) >= parse_version("2.4.0")
-has_ansible_v28 = parse_version(ansible.__version__) >= parse_version("2.8.0.dev0")
-has_ansible_v29 = parse_version(ansible.__version__) >= parse_version("2.9.0")
-has_ansible_v212 = parse_version(ansible.__version__) >= parse_version("2.12.0")
-has_ansible_v213 = parse_version(ansible.__version__) >= parse_version("2.13.0")
-has_ansible_v219 = parse_version(ansible.__version__) >= parse_version("2.19.0.dev0")
+    from packaging.version import parse as parse_version
+
+    has_ansible_v2 = parse_version(ansible.__version__) >= parse_version("2.0.0")
+    has_ansible_v24 = parse_version(ansible.__version__) >= parse_version("2.4.0")
+    has_ansible_v28 = parse_version(ansible.__version__) >= parse_version("2.8.0.dev0")
+    has_ansible_v29 = parse_version(ansible.__version__) >= parse_version("2.9.0")
+    has_ansible_v212 = parse_version(ansible.__version__) >= parse_version("2.12.0")
+    has_ansible_v213 = parse_version(ansible.__version__) >= parse_version("2.13.0")
+    has_ansible_v219 = parse_version(ansible.__version__) >= parse_version("2.19.0.dev0")
+
+except (ImportError, AttributeError):
+    pass

src/pytest_ansible/plugin.py

@@ -10,13 +10,20 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
-import ansible
-import ansible.constants
-import ansible.errors
-import ansible.utils
-import ansible.utils.display
 import pytest
 
+
+try:
+    import ansible
+    import ansible.constants
+    import ansible.errors
+    import ansible.utils
+    import ansible.utils.display
+
+    HAS_ANSIBLE = True
+except ImportError:
+    HAS_ANSIBLE = False
+
 from typing_extensions import deprecated
 
 from pytest_ansible.fixtures import (
@@ -86,8 +93,14 @@ def _load_scenarios(config: pytest.Config) -> None:
         logger.warning(msg)
 
 
-def pytest_addoption(parser):  # type: ignore[no-untyped-def]  # noqa: ANN001, ANN201
-    """Add options to control ansible."""
+def pytest_addoption(parser: pytest.Parser) -> None:
+    """Add options to control ansible.
+
+    Args:
+        parser: pytest.Parser
+    """
+    if not HAS_ANSIBLE:
+        return
     group = parser.getgroup("pytest-ansible")
     group.addoption(
         "--inventory",
@@ -226,8 +239,14 @@ def pytest_addoption(parser):  # type: ignore[no-untyped-def]  # noqa: ANN001, A
     parser.addini("ansible", "Ansible integration", "args")
 
 
-def pytest_configure(config):  # type: ignore[no-untyped-def]  # noqa: ANN001, ANN201
-    """Validate --ansible-* parameters."""
+def pytest_configure(config: pytest.Config) -> None:
+    """Validate --ansible-* parameters.
+
+    Args:
+        config: pytest.Config
+    """
+    if not HAS_ANSIBLE:
+        return
     config.addinivalue_line("markers", "ansible(**kwargs): Ansible integration")
 
     # Enable connection debugging
@@ -265,6 +284,8 @@ def pytest_collect_file(
     parent: pytest.Collector,
 ) -> Node | None:
     """Transform each found molecule.yml into a pytest test."""  # noqa: DOC201
+    if not hasattr(parent.config.option, "molecule"):
+        return None
     if not parent.config.option.molecule:
         return None
     if not HAS_MOLECULE:  # pragma: no cover

tests/fixtures/ansible_collections/test/test/tests/unit/plugins/modules/test_pool.py

@@ -0,0 +1 @@
+"""Sample test file."""

tests/test_ansible_test.py

@@ -0,0 +1,17 @@
+"""Checks compatibility with ansible-test."""
+
+from __future__ import annotations
+
+import subprocess  # noqa: S404
+
+
+def test_ansible_test() -> None:
+    """Test for params."""
+    proc = subprocess.run(
+        "ansible-test units --target-python default",  # noqa: S607
+        shell=True,
+        capture_output=True,
+        cwd="tests/fixtures/ansible_collections/test/test",
+        check=False,
+    )
+    assert proc.returncode == 0

tests/test_host_manager.py

@@ -96,6 +96,7 @@ def test_host_manager_getitem(host_pattern, num_hosts, hosts, include_extra_inve
         assert _hosts[host_pattern]
 
 
+@skip_ansible_219
 @pytest.mark.parametrize(
     ("host_pattern", "num_hosts"),
     NEGATIVE_HOST_PATTERNS,
@@ -149,6 +150,7 @@ def test_host_manager_slice(host_slice, num_hosts, hosts, include_extra_inventor
 
 
 # pylint: disable=pointless-statement
+@skip_ansible_219
 @pytest.mark.parametrize(
     "host_slice",
     NEGATIVE_HOST_SLICES,
@@ -184,6 +186,7 @@ def test_host_manager_not_getattr(  # type: ignore[no-untyped-def]  # noqa: ANN2
         getattr(_hosts, host_pattern)
 
 
+@skip_ansible_219
 def test_defaults(request):  # type: ignore[no-untyped-def]  # noqa: ANN001, ANN201, D103
     from ansible.constants import DEFAULT_TRANSPORT  # pylint: disable=no-name-in-module