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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
"""
Allows configuring optional test markers in config, see pyproject.toml.
Run optional tests with `pytest --run-optional=...`.
Mark tests to run only if an optional test ISN'T selected by prepending the mark with
"no_".
You can specify a "no_" prefix straight in config, in which case you can mark tests
to run when this tests ISN'T selected by omitting the "no_" prefix.
Specifying the name of the default behavior in `--run-optional=` is harmless.
Adapted from https://pypi.org/project/pytest-optional-tests/, (c) 2019 Reece Hart
"""
import itertools
import logging
import re
from functools import lru_cache
from typing import TYPE_CHECKING, Any
import pytest
from pytest import StashKey
log = logging.getLogger(__name__)
if TYPE_CHECKING:
from _pytest.config import Config
from _pytest.config.argparsing import Parser
from _pytest.mark.structures import MarkDecorator
from _pytest.nodes import Node
ALL_POSSIBLE_OPTIONAL_MARKERS = StashKey[frozenset[str]]()
ENABLED_OPTIONAL_MARKERS = StashKey[frozenset[str]]()
def pytest_addoption(parser: "Parser") -> None:
group = parser.getgroup("collect")
group.addoption(
"--run-optional",
action="append",
dest="run_optional",
default=None,
help="Optional test markers to run; comma-separated",
)
parser.addini("optional-tests", "List of optional tests markers", "linelist")
def pytest_configure(config: "Config") -> None:
"""Optional tests are markers.
Use the syntax in https://docs.pytest.org/en/stable/mark.html#registering-marks.
"""
# Extract the configured optional-tests from pytest's ini config in a
# version-agnostic way. Depending on pytest version, the value can be a
# string, a list of strings, or a ConfigValue wrapper (with a `.value` attr).
raw_ot_ini: Any = config.inicfg.get("optional-tests")
ot_ini_lines: list[str] = []
if raw_ot_ini:
value = getattr(raw_ot_ini, "value", raw_ot_ini)
if isinstance(value, str):
ot_ini_lines = value.strip().split("\n")
elif isinstance(value, list):
# Best-effort coercion to strings; pytest inis are textual.
ot_ini_lines = [str(v) for v in value]
else:
# Fallback: ignore unexpected shapes (non-iterable, etc.).
ot_ini_lines = []
ot_markers: set[str] = set()
ot_run: set[str] = set()
marker_re = re.compile(r"^\s*(?P<no>no_)?(?P<marker>\w+)(:\s*(?P<description>.*))?")
# Iterate over configured markers discovered above.
for ot in ot_ini_lines:
m = marker_re.match(ot)
if not m:
raise ValueError(f"{ot!r} doesn't match pytest marker syntax")
marker = (m.group("no") or "") + m.group("marker")
description = m.group("description")
config.addinivalue_line("markers", f"{marker}: {description}")
config.addinivalue_line(
"markers", f"{no(marker)}: run when `{marker}` not passed"
)
ot_markers.add(marker)
# collect requested optional tests
passed_args = config.getoption("run_optional")
if passed_args:
ot_run.update(itertools.chain.from_iterable(a.split(",") for a in passed_args))
ot_run |= {no(excluded) for excluded in ot_markers - ot_run}
ot_markers |= {no(m) for m in ot_markers}
log.info("optional tests to run: %s", ot_run)
unknown_tests = ot_run - ot_markers
if unknown_tests:
raise ValueError(f"Unknown optional tests wanted: {unknown_tests!r}")
store = config._store
store[ALL_POSSIBLE_OPTIONAL_MARKERS] = frozenset(ot_markers)
store[ENABLED_OPTIONAL_MARKERS] = frozenset(ot_run)
def pytest_collection_modifyitems(config: "Config", items: "list[Node]") -> None:
store = config._store
all_possible_optional_markers = store[ALL_POSSIBLE_OPTIONAL_MARKERS]
enabled_optional_markers = store[ENABLED_OPTIONAL_MARKERS]
for item in items:
all_markers_on_test = {m.name for m in item.iter_markers()}
optional_markers_on_test = all_markers_on_test & all_possible_optional_markers
if not optional_markers_on_test or (
optional_markers_on_test & enabled_optional_markers
):
continue
log.info("skipping non-requested optional: %s", item)
item.add_marker(skip_mark(frozenset(optional_markers_on_test)))
@lru_cache
def skip_mark(tests: frozenset[str]) -> "MarkDecorator":
names = ", ".join(sorted(tests))
return pytest.mark.skip(reason=f"Marked with disabled optional tests ({names})")
@lru_cache
def no(name: str) -> str:
if name.startswith("no_"):
return name[len("no_") :]
return "no_" + name
|
