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
|
# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
"""
Pytest auto configuration.
This module is run automatically by pytest, to define and enable fixtures.
"""
import os
import sys
import sysconfig
import warnings
from pathlib import Path
import pytest
from coverage import env
from coverage.exceptions import _StopEverything
from coverage.files import set_relative_directory
# Pytest will rewrite assertions in test modules, but not elsewhere.
# This tells pytest to also rewrite assertions in coveragetest.py.
pytest.register_assert_rewrite("tests.coveragetest")
pytest.register_assert_rewrite("tests.helpers")
# Pytest can take additional options:
# $set_env.py: PYTEST_ADDOPTS - Extra arguments to pytest.
pytest_plugins = "tests.balance_xdist_plugin"
@pytest.fixture(autouse=True)
def set_warnings():
"""Configure warnings to show while running tests."""
warnings.simplefilter("default")
warnings.simplefilter("once", DeprecationWarning)
# Warnings to suppress:
# How come these warnings are successfully suppressed here, but not in setup.cfg??
warnings.filterwarnings(
"ignore",
category=DeprecationWarning,
message=r".*imp module is deprecated in favour of importlib",
)
warnings.filterwarnings(
"ignore",
category=DeprecationWarning,
message=r"module 'sre_constants' is deprecated",
)
warnings.filterwarnings(
"ignore",
category=pytest.PytestRemovedIn8Warning,
)
if env.PYPY:
# pypy3 warns about unclosed files a lot.
warnings.filterwarnings("ignore", r".*unclosed file", category=ResourceWarning)
@pytest.fixture(autouse=True)
def reset_sys_path():
"""Clean up sys.path changes around every test."""
sys_path = list(sys.path)
yield
sys.path[:] = sys_path
@pytest.fixture(autouse=True)
def reset_environment():
"""Make sure a test setting an envvar doesn't leak into another test."""
old_environ = os.environ.copy()
yield
os.environ.clear()
os.environ.update(old_environ)
@pytest.fixture(autouse=True)
def reset_filesdotpy_globals():
"""coverage/files.py has some unfortunate globals. Reset them every test."""
set_relative_directory()
yield
WORKER = os.environ.get("PYTEST_XDIST_WORKER", "none")
def pytest_sessionstart():
"""Run once at the start of the test session."""
# Only in the main process...
if WORKER == "none":
# Create a .pth file for measuring subprocess coverage.
pth_dir = find_writable_pth_directory()
assert pth_dir
(pth_dir / "subcover.pth").write_text("import coverage; coverage.process_startup()\n")
# subcover.pth is deleted by pytest_sessionfinish below.
def pytest_sessionfinish():
"""Hook the end of a test session, to clean up."""
# This is called by each of the workers and by the main process.
if WORKER == "none":
for pth_dir in possible_pth_dirs(): # pragma: part covered
pth_file = pth_dir / "subcover.pth"
if pth_file.exists():
pth_file.unlink()
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_call(item):
"""Run once for each test."""
# Convert _StopEverything into skipped tests.
outcome = yield
if outcome.excinfo and issubclass(outcome.excinfo[0], _StopEverything): # pragma: only jython
pytest.skip(f"Skipping {item.nodeid} for _StopEverything: {outcome.excinfo[1]}")
def possible_pth_dirs():
"""Produce a sequence of directories for trying to write .pth files."""
# First look through sys.path, and if we find a .pth file, then it's a good
# place to put ours.
for pth_dir in map(Path, sys.path): # pragma: part covered
pth_files = list(pth_dir.glob("*.pth"))
if pth_files:
yield pth_dir
# If we're still looking, then try the Python library directory.
# https://github.com/nedbat/coveragepy/issues/339
yield Path(sysconfig.get_path("purelib")) # pragma: cant happen
def find_writable_pth_directory():
"""Find a place to write a .pth file."""
for pth_dir in possible_pth_dirs(): # pragma: part covered
try_it = pth_dir / f"touch_{WORKER}.it"
try:
try_it.write_text("foo")
except OSError: # pragma: cant happen
continue
os.remove(try_it)
return pth_dir
return None # pragma: cant happen
|