summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/testing/fixtures.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
commit2fe34b6444502079dc0b84365ce82dbc92de308e (patch)
tree8fedcab52bbbc3db6c5aa909a88a7a7b81685018 /src/ansiblelint/testing/fixtures.py
parentInitial commit. (diff)
downloadansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.tar.xz
ansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.zip
Adding upstream version 6.17.2.upstream/6.17.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/ansiblelint/testing/fixtures.py')
-rw-r--r--src/ansiblelint/testing/fixtures.py63
1 files changed, 63 insertions, 0 deletions
diff --git a/src/ansiblelint/testing/fixtures.py b/src/ansiblelint/testing/fixtures.py
new file mode 100644
index 0000000..814a076
--- /dev/null
+++ b/src/ansiblelint/testing/fixtures.py
@@ -0,0 +1,63 @@
+"""PyTest Fixtures.
+
+They should not be imported, instead add code below to your root conftest.py
+file:
+
+pytest_plugins = ['ansiblelint.testing']
+"""
+from __future__ import annotations
+
+import copy
+from typing import TYPE_CHECKING
+
+import pytest
+
+from ansiblelint.config import Options, options
+from ansiblelint.constants import DEFAULT_RULESDIR
+from ansiblelint.rules import RulesCollection
+from ansiblelint.testing import RunFromText
+
+if TYPE_CHECKING:
+ from collections.abc import Iterator
+
+ from _pytest.fixtures import SubRequest
+
+
+# The sessions scope does not apply to xdist, so we will still have one
+# session for each worker, but at least it will a limited number.
+@pytest.fixture(name="default_rules_collection", scope="session")
+def fixture_default_rules_collection() -> RulesCollection:
+ """Return default rule collection."""
+ assert DEFAULT_RULESDIR.is_dir()
+ # For testing we want to manually enable opt-in rules
+ test_options = copy.deepcopy(options)
+ test_options.enable_list = ["no-same-owner"]
+ # That is instantiated very often and do want to avoid ansible-galaxy
+ # install errors due to concurrency.
+ test_options.offline = True
+ return RulesCollection(rulesdirs=[DEFAULT_RULESDIR], options=test_options)
+
+
+@pytest.fixture()
+def default_text_runner(default_rules_collection: RulesCollection) -> RunFromText:
+ """Return RunFromText instance for the default set of collections."""
+ return RunFromText(default_rules_collection)
+
+
+@pytest.fixture()
+def rule_runner(request: SubRequest, config_options: Options) -> RunFromText:
+ """Return runner for a specific rule class."""
+ rule_class = request.param
+ config_options.enable_list.append(rule_class().id)
+ collection = RulesCollection(options=config_options)
+ collection.register(rule_class())
+ return RunFromText(collection)
+
+
+@pytest.fixture(name="config_options")
+def fixture_config_options() -> Iterator[Options]:
+ """Return configuration options that will be restored after testrun."""
+ global options # pylint: disable=global-statement,invalid-name # noqa: PLW0603
+ original_options = copy.deepcopy(options)
+ yield options
+ options = original_options