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
|
# SPDX-License-Identifier: MIT
import contextlib
import contextvars
import importlib.metadata
import os
import os.path
import shutil
import stat
import sys
import sysconfig
import tempfile
from functools import partial, update_wrapper
import pytest
import build.env
def pytest_addoption(parser):
os.environ['PYTHONWARNINGS'] = 'ignore:DEPRECATION::pip._internal.cli.base_command' # for when not run within tox
os.environ['PIP_DISABLE_PIP_VERSION_CHECK'] = '1' # do not pollute stderr with upgrade advisory
parser.addoption('--run-integration', action='store_true', help='run the integration tests')
parser.addoption('--only-integration', action='store_true', help='only run the integration tests')
PYPY3_WIN_VENV_BAD = (
sys.implementation.name == 'pypy' and sys.implementation.version < (7, 3, 9) and sys.platform.startswith('win')
)
PYPY3_WIN_M = 'https://foss.heptapod.net/pypy/pypy/-/issues/3323 and https://foss.heptapod.net/pypy/pypy/-/issues/3321'
def pytest_collection_modifyitems(config, items):
skip_int = pytest.mark.skip(reason='integration tests not run (no --run-integration flag)')
skip_other = pytest.mark.skip(reason='only integration tests are run (got --only-integration flag)')
if config.getoption('--run-integration') and config.getoption('--only-integration'): # pragma: no cover
msg = "--run-integration and --only-integration can't be used together, choose one"
raise pytest.UsageError(msg)
if len(items) == 1: # do not require flags if called directly
return
for item in items:
is_integration_file = is_integration(item)
if PYPY3_WIN_VENV_BAD and item.get_closest_marker('pypy3323bug') and os.environ.get('PYPY3323BUG', None):
item.add_marker(pytest.mark.xfail(reason=PYPY3_WIN_M, strict=False))
if PYPY3_WIN_VENV_BAD and item.get_closest_marker('isolated'):
if not (is_integration_file and item.originalname == 'test_build') or (
hasattr(item, 'callspec') and '--no-isolation' not in item.callspec.params.get('args', [])
):
item.add_marker(pytest.mark.xfail(reason=PYPY3_WIN_M, strict=True))
if is_integration_file: # pragma: no cover
if not config.getoption('--run-integration') and not config.getoption('--only-integration'):
item.add_marker(skip_int)
elif config.getoption('--only-integration'): # pragma: no cover
item.add_marker(skip_other)
# run integration tests after unit tests
items.sort(key=lambda i: 1 if is_integration(i) else 0)
def is_integration(item):
return os.path.basename(item.location[0]) == 'test_integration.py'
def pytest_runtest_call(item: pytest.Item):
if item.get_closest_marker('contextvars'):
if isinstance(item, pytest.Function):
wrapped_function = partial(contextvars.copy_context().run, item.obj)
item.obj = update_wrapper(wrapped_function, item.obj)
else:
msg = 'cannot rewrap non-function item'
raise RuntimeError(msg)
@pytest.fixture
def local_pip(monkeypatch):
monkeypatch.setattr(build.env._PipBackend, '_has_valid_outer_pip', None)
@pytest.fixture(autouse=True, params=[False])
def has_virtualenv(request, monkeypatch):
if request.param is not None:
monkeypatch.setattr(build.env._PipBackend, '_has_virtualenv', request.param)
@pytest.fixture(scope='session', autouse=True)
def ensure_syconfig_vars_created():
# the config vars are globally cached and may use get_path, make sure they are created
sysconfig.get_config_vars()
@pytest.fixture
def packages_path():
return os.path.realpath(os.path.join(__file__, '..', 'packages'))
def generate_package_path_fixture(package_name):
@pytest.fixture
def fixture(packages_path):
return os.path.join(packages_path, package_name)
return fixture
# Generate path fixtures dynamically.
package_names = os.listdir(os.path.join(os.path.dirname(__file__), 'packages'))
for package_name in package_names:
normalized_name = package_name.replace('-', '_')
fixture_name = f'package_{normalized_name}'
globals()[fixture_name] = generate_package_path_fixture(package_name)
@pytest.fixture
def test_no_permission(packages_path):
path = os.path.join(packages_path, 'test-no-permission')
file = os.path.join(path, 'pyproject.toml')
orig_stat = os.stat(file).st_mode
os.chmod(file, ~stat.S_IRWXU)
yield os.path.join(packages_path, 'test-no-permission')
os.chmod(file, orig_stat)
@pytest.fixture
def tmp_dir():
path = tempfile.mkdtemp(prefix='python-build-test-')
yield path
shutil.rmtree(path)
def pytest_report_header() -> str:
interesting_packages = [
'build',
'colorama',
'filelock',
'packaging',
'pip',
'pyproject_hooks',
'setuptools',
'tomli',
'virtualenv',
'wheel',
]
valid = []
for package in interesting_packages:
# Old versions of importlib_metadata made this FileNotFoundError
with contextlib.suppress(ModuleNotFoundError, FileNotFoundError):
valid.append(f'{package}=={importlib.metadata.version(package)}')
reqs = ' '.join(valid)
return f'installed packages of interest: {reqs}'
|