Coverage for tests / conftest.py: 100.000%

1# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 

2# For details: https://github.com/coveragepy/coveragepy/blob/main/NOTICE.txt 

3 

4""" 

5Pytest auto configuration. 

6 

7This module is run automatically by pytest, to define and enable fixtures. 

8""" 

9 

10from __future__ import annotations 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

11 

12import os 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

13import sys 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

14import warnings 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

15 

16from collections.abc import Iterable 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

17 

18import pytest 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

19 

20from coverage.files import set_relative_directory 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

21from coverage.patch import create_pth_files 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

22 

23from tests import testenv 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

24 

25 

26# Pytest will rewrite assertions in test modules, but not elsewhere. 

27# This tells pytest to also rewrite assertions in these files: 

28pytest.register_assert_rewrite("tests.coveragetest") 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

29pytest.register_assert_rewrite("tests.helpers") 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

30 

31# Pytest can take additional options: 

32# $set_env.py: PYTEST_ADDOPTS - Extra arguments to pytest. 

33 

34pytest_plugins = [ 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

35 "tests.select_plugin", 

36] 

37 

38 

39@pytest.fixture(autouse=True) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

40def set_warnings() -> None: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

41 """Configure warnings to show while running tests.""" 

42 warnings.simplefilter("default") 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

43 warnings.simplefilter("once", DeprecationWarning) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

44 

45 # Warnings to suppress: 

46 # How come these warnings are successfully suppressed here, but not in pyproject.toml?? 

47 

48 # Note: when writing the regex for the message, it's matched with re.match, 

49 # so it has to match the beginning of the message. Add ".*" to make it 

50 # match something in the middle of the message. 

51 

52 # Don't warn about unclosed SQLite connections. 

53 # We don't close ":memory:" databases because we don't have a way to connect 

54 # to them more than once if we close them. In real coverage.py uses, there 

55 # are only a couple of them, but our test suite makes many and we get warned 

56 # about them all. 

57 # Python3.13 added this warning, but the behavior has been the same all along, 

58 # without any reported problems, so just quiet the warning. 

59 # https://github.com/python/cpython/issues/105539 

60 warnings.filterwarnings("ignore", r"unclosed database", category=ResourceWarning) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

61 

62 # We have a test that has a return in a finally: test_bug_1891. 

63 warnings.filterwarnings("ignore", "'return' in a 'finally' block", category=SyntaxWarning) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

64 

65 # For when our own tests can't use sysmon though it was requested. 

66 warnings.filterwarnings("ignore", r".*no-sysmon") 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

67 if testenv.REQUESTED_CORE != "ctrace": 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

68 warnings.filterwarnings("ignore", r".*no-ctracer") 42 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOP

69 

70 

71@pytest.fixture(autouse=True) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

72def reset_sys_path() -> Iterable[None]: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

73 """Clean up sys.path changes around every test.""" 

74 sys_path = list(sys.path) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

75 yield 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

76 sys.path[:] = sys_path 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

77 

78 

79@pytest.fixture(autouse=True) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

80def reset_environment() -> Iterable[None]: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

81 """Make sure a test setting an envvar doesn't leak into another test.""" 

82 old_environ = os.environ.copy() 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

83 yield 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

84 os.environ.clear() 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

85 os.environ.update(old_environ) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

86 

87 

88@pytest.fixture(autouse=True) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

89def reset_filesdotpy_globals() -> None: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

90 """coverage/files.py has some unfortunate globals. Reset them every test.""" 

91 set_relative_directory() 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

92 

93 

94@pytest.fixture(autouse=True) 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

95def force_local_pyc_files() -> None: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

96 """Ensure that .pyc files are written next to source files.""" 

97 # For some tests, we need .pyc files written in the current directory, 

98 # so override any local setting. 

99 sys.pycache_prefix = None 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

100 

101 

102# Give this an underscored name so pylint won't complain when we use the fixture. 

103@pytest.fixture(name="_create_pth_file") 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

104def create_pth_file_fixture() -> Iterable[None]: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

105 """Create and clean up a .pth file for tests that need it for subprocesses.""" 

106 pth_files = create_pth_files() 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

107 try: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

108 yield 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

109 finally: 

110 for p in pth_files: 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP

111 p.unlink() 69 ctx1QaRbScTdUeVfWgXhYiZj0k1l2m3n4o5pq6rs7tu8vw9xy!zA#BC$DE%FG'HI(JK)LMNOP