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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
|
from __future__ import annotations
import os
import re
from typing import TYPE_CHECKING
import pytest
import pyvista
if TYPE_CHECKING:
from pytest_mock import MockerFixture
pytest_plugins = 'pytester'
class PytesterStdoutParser:
def __init__(self, regex: re.Pattern[str] | str):
self.regex = re.compile(regex) if isinstance(regex, str) else regex
def parse(self, results: pytest.RunResult):
return [
m.groupdict()
for line in results.stdout.str().splitlines()
if (m := re.match(self.regex, line))
]
class _ReportDescriptor:
def __init__(self):
self._status = None
def __set_name__(self, owner, name: str):
self._status = name
def __get__(self, obj: RunResultsReport, objtype=None):
return [t['name'] for t in obj.results if t['status'] == self._status.upper()]
class RunResultsReport:
passed = _ReportDescriptor()
skipped = _ReportDescriptor()
failed = _ReportDescriptor()
error = _ReportDescriptor()
xpassed = _ReportDescriptor()
xfailed = _ReportDescriptor()
def __init__(self, results: list[dict[str, str]]):
self.results = results
@pytest.fixture
def results_parser(monkeypatch: pytest.MonkeyPatch):
"""
Results parser for all tests ran with a --verbose flag.
It enables to get the test name (last part of the test path)
as well as the status.
Results can be passed to the `RunResultsReport` class to better interact
with them.
"""
monkeypatch.setenv('PYTEST_ADDOPTS', '-v')
regex = re.compile(
r'.*(?P<name>test_[\w\[\]]*) (?P<status>\w*) .*\[.*%\]$',
)
return PytesterStdoutParser(regex=regex)
@pytest.fixture(autouse=True)
def _load_current_config(
pytestconfig: pytest.Config,
pytester: pytest.Pytester,
):
with (pytestconfig.rootpath / 'pyproject.toml').open('r') as file:
toml = pytester.makepyprojecttoml(file.read())
with (pytestconfig.rootpath / 'tests/conftest.py').open('r') as file:
conftest = pytester.makeconftest(file.read())
yield
toml.unlink()
conftest.unlink()
def test_warnings_turned_to_errors(
pytester: pytest.Pytester,
results_parser: PytesterStdoutParser,
):
tests = """
import pytest, warnings
def test_warning():
warnings.warn("foo",Warning)
def test_no_warnings():
...
"""
p = pytester.makepyfile(tests)
results = pytester.runpytest(p)
results.assert_outcomes(
passed=1,
failed=1,
)
results = results_parser.parse(results=results)
report = RunResultsReport(results)
assert 'test_warning' in report.failed
assert 'test_no_warnings' in report.passed
@pytest.mark.parametrize('greater', [True, False])
def test_warning_vtk(
pytester: pytest.Pytester,
results_parser: PytesterStdoutParser,
monkeypatch: pytest.MonkeyPatch,
greater: bool,
):
tests = """
import pytest, warnings
def test_warning():
msg = "`np.bool` is a deprecated alias for the builtin `bool`. To silence this warning, use `bool` by itself. Doing this will not modify any behavior and is safe. If you specifically wanted the numpy scalar type, use `np.bool_` here."
warnings.warn(msg, DeprecationWarning)
""" # noqa: E501
monkeypatch.setattr(pyvista, 'vtk_version_info', (9, 0) if not greater else (9, 1))
p = pytester.makepyfile(tests)
results = pytester.runpytest(p)
results.assert_outcomes(
passed=1 if not greater else 0,
failed=0 if not greater else 1,
)
results = results_parser.parse(results=results)
report = RunResultsReport(results)
assert 'test_warning' in (report.failed if greater else report.passed)
@pytest.mark.parametrize('cml', [True, False])
def test_downloads_mark(
cml,
pytester: pytest.Pytester,
results_parser: PytesterStdoutParser,
):
tests = """
import pytest
@pytest.mark.needs_download
def test_downloads():
...
def test_no_downloads():
...
"""
cml = '--test_downloads' if cml else ''
p = pytester.makepyfile(tests)
results = pytester.runpytest(p, cml)
results.assert_outcomes(
skipped=0 if cml else 1,
passed=2 if cml else 1,
)
results = results_parser.parse(results=results)
report = RunResultsReport(results)
assert 'test_no_downloads' in report.passed
assert 'test_downloads' in (report.passed if cml else report.skipped)
@pytest.mark.skipif(os.name != 'nt', reason='Needs Windows platform to run')
def test_skip_windows(
pytester: pytest.Pytester,
results_parser: PytesterStdoutParser,
):
tests = """
import pytest
@pytest.mark.skip_windows
def test_skipped():
...
def test_not_skipped():
...
@pytest.mark.skip_windows(foo=1)
def test_skipped_wrong():
...
"""
p = pytester.makepyfile(tests)
results = pytester.runpytest(p)
results.assert_outcomes(skipped=1, passed=1, errors=1)
results.stdout.re_match_lines(
[
r'.*Marker `skip_windows` called with incorrect arguments\.',
r".*Signature should be: @pytest\.mark\.skip_windows\(reason: str = 'Test fails on "
r"Windows'\)",
]
)
results = results_parser.parse(results=results)
report = RunResultsReport(results)
assert 'test_not_skipped' in report.passed
assert 'test_skipped' in report.skipped
assert 'test_skipped_wrong' in report.error
@pytest.fixture
def _patch_uses_egl(mocker: MockerFixture):
from pyvista.plotting.utilities import gl_checks
m = mocker.patch.object(gl_checks, 'uses_egl')
m.return_value = True
@pytest.mark.usefixtures('_patch_uses_egl')
def test_skip_egl(
pytester: pytest.Pytester,
results_parser: PytesterStdoutParser,
):
tests = """
import pytest
@pytest.mark.skip_egl
def test_skipped():
...
@pytest.mark.skip_egl(reason="foo")
def test_skipped_message():
...
@pytest.mark.skip_egl("bar")
def test_skipped_message_args():
...
def test_not_skipped():
...
@pytest.mark.skip_egl(foo=1)
def test_skipped_wrong():
...
"""
p = pytester.makepyfile(tests)
results = pytester.runpytest(p)
results.stdout.re_match_lines(
[
r'.*Marker `skip_egl` called with incorrect arguments\.',
r'.*Signature should be: @pytest\.mark\.skip_egl\(reason.*\)',
]
)
results.assert_outcomes(
skipped=3,
passed=1,
errors=1,
)
results = results_parser.parse(results=results)
report = RunResultsReport(results)
assert 'test_not_skipped' in report.passed
assert 'test_skipped' in report.skipped
assert 'test_skipped_message_args' in report.skipped
assert 'test_skipped_message' in report.skipped
assert 'test_skipped_wrong' in report.error
@pytest.fixture
def _patch_mac_system(mocker: MockerFixture):
import platform
m = mocker.patch.object(platform, 'system')
m.return_value = 'Darwin'
|