1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
|
"""PyTest Fixtures."""
import os
import platform
import subprocess
import sys
import warnings
from importlib.util import find_spec
from pathlib import Path
import pytest
# Ensure we always run from the root of the repository
if Path.cwd() != Path(__file__).parent:
os.chdir(Path(__file__).parent)
# checking if user is running pytest without installing test dependencies:
missing = [
module for module in ["ansible", "black"] if not find_spec(module)
]
if missing:
pytest.exit(
reason=f"FATAL: Missing modules: {', '.join(missing)} -- probably you missed installing test requirements with: pip install -e '.[test]'",
returncode=1,
)
# See: https://github.com/pytest-dev/pytest/issues/1402#issuecomment-186299177
def pytest_configure(config: pytest.Config) -> None:
"""Ensure we run preparation only on master thread when running in parallel."""
if is_help_option_present(config):
return
def is_help_option_present(config: pytest.Config) -> bool:
"""Return true if pytest invocation was not about running tests."""
return any(config.getoption(x) for x in ["--fixtures", "--help", "--collect-only"])
def is_master(config: pytest.Config) -> bool:
"""Return true if is run on master thread."""
return not hasattr(config, "workerinput")
# ruff: noqa: E402
from ansible.module_utils.common.yaml import ( # pylint: disable=wrong-import-position
HAS_LIBYAML,
)
if not HAS_LIBYAML:
# While presence of libyaml is not required for runtime, we keep this error
# fatal here in order to be sure that we spot libyaml errors during testing.
arch = platform.machine()
if arch not in ("arm64", "x86_64"):
warnings.warn(
f"This architecture ({arch}) is not supported by libyaml, performance will be degraded.",
category=pytest.PytestWarning,
stacklevel=1,
)
else:
pytest.fail(
"FATAL: For testing, we require pyyaml to be installed with its native extension, missing it would make testing 3x slower and risk missing essential bugs.",
)
@pytest.fixture(name="project_path")
def fixture_project_path() -> Path:
"""Fixture to linter root folder."""
return Path(__file__).resolve().parent
|