2018-10-08 18:09:53 +02:00
|
|
|
import compileall
|
2018-11-29 09:50:33 +01:00
|
|
|
import fnmatch
|
2017-03-26 17:18:29 +02:00
|
|
|
import io
|
2014-05-07 16:20:14 +02:00
|
|
|
import os
|
2013-08-22 13:49:53 +02:00
|
|
|
import shutil
|
2017-05-14 00:23:17 +02:00
|
|
|
import subprocess
|
2017-03-26 17:18:29 +02:00
|
|
|
import sys
|
2013-08-22 13:49:53 +02:00
|
|
|
|
2017-06-13 14:17:00 +02:00
|
|
|
import pytest
|
2017-03-26 17:49:02 +02:00
|
|
|
import six
|
2018-10-08 18:09:53 +02:00
|
|
|
from setuptools.wheel import Wheel
|
2017-03-26 17:49:02 +02:00
|
|
|
|
2017-08-31 17:48:18 +02:00
|
|
|
import pip._internal
|
2018-10-08 18:09:53 +02:00
|
|
|
from tests.lib import DATA_DIR, SRC_DIR, TestData
|
2013-08-22 04:28:15 +02:00
|
|
|
from tests.lib.path import Path
|
2013-08-22 06:39:07 +02:00
|
|
|
from tests.lib.scripttest import PipTestEnvironment
|
|
|
|
from tests.lib.venv import VirtualEnvironment
|
2013-08-22 04:28:15 +02:00
|
|
|
|
|
|
|
|
2018-07-30 16:27:58 +02:00
|
|
|
def pytest_addoption(parser):
|
|
|
|
parser.addoption(
|
|
|
|
"--keep-tmpdir", action="store_true",
|
|
|
|
default=False, help="keep temporary test directories"
|
|
|
|
)
|
2018-10-09 08:23:03 +02:00
|
|
|
parser.addoption("--use-venv", action="store_true",
|
|
|
|
help="use venv for virtual environment creation")
|
2018-07-30 16:27:58 +02:00
|
|
|
|
|
|
|
|
2018-10-09 08:23:03 +02:00
|
|
|
def pytest_collection_modifyitems(config, items):
|
2014-07-01 02:00:35 +02:00
|
|
|
for item in items:
|
2015-03-19 22:24:25 +01:00
|
|
|
if not hasattr(item, 'module'): # e.g.: DoctestTextfile
|
|
|
|
continue
|
2017-05-19 05:18:45 +02:00
|
|
|
|
|
|
|
# Mark network tests as flaky
|
2017-06-17 18:21:14 +02:00
|
|
|
if item.get_marker('network') is not None and "CI" in os.environ:
|
2017-05-19 05:18:45 +02:00
|
|
|
item.add_marker(pytest.mark.flaky(reruns=3))
|
|
|
|
|
2018-10-09 08:23:03 +02:00
|
|
|
if six.PY3:
|
|
|
|
if (item.get_marker('incompatible_with_test_venv') and
|
|
|
|
config.getoption("--use-venv")):
|
|
|
|
item.add_marker(pytest.mark.skip(
|
|
|
|
'Incompatible with test venv'))
|
|
|
|
if (item.get_marker('incompatible_with_venv') and
|
|
|
|
sys.prefix != sys.base_prefix):
|
|
|
|
item.add_marker(pytest.mark.skip(
|
|
|
|
'Incompatible with venv'))
|
|
|
|
|
2014-07-01 02:00:35 +02:00
|
|
|
module_path = os.path.relpath(
|
|
|
|
item.module.__file__,
|
|
|
|
os.path.commonprefix([__file__, item.module.__file__]),
|
|
|
|
)
|
|
|
|
|
2014-08-29 21:42:06 +02:00
|
|
|
module_root_dir = module_path.split(os.pathsep)[0]
|
2015-02-24 13:46:10 +01:00
|
|
|
if (module_root_dir.startswith("functional") or
|
|
|
|
module_root_dir.startswith("integration") or
|
|
|
|
module_root_dir.startswith("lib")):
|
2014-07-01 02:00:35 +02:00
|
|
|
item.add_marker(pytest.mark.integration)
|
2014-08-29 21:42:06 +02:00
|
|
|
elif module_root_dir.startswith("unit"):
|
2014-07-01 02:00:35 +02:00
|
|
|
item.add_marker(pytest.mark.unit)
|
|
|
|
else:
|
|
|
|
raise RuntimeError(
|
2017-12-15 06:56:04 +01:00
|
|
|
"Unknown test type (filename = {})".format(module_path)
|
2014-07-01 02:00:35 +02:00
|
|
|
)
|
|
|
|
|
|
|
|
|
2018-10-17 18:59:12 +02:00
|
|
|
@pytest.fixture(scope='session')
|
|
|
|
def tmpdir_factory(request, tmpdir_factory):
|
|
|
|
""" Modified `tmpdir_factory` session fixture
|
|
|
|
that will automatically cleanup after itself.
|
|
|
|
"""
|
|
|
|
yield tmpdir_factory
|
|
|
|
if not request.config.getoption("--keep-tmpdir"):
|
|
|
|
tmpdir_factory.getbasetemp().remove(ignore_errors=True)
|
|
|
|
|
|
|
|
|
2016-07-22 02:24:31 +02:00
|
|
|
@pytest.yield_fixture
|
2018-07-30 16:27:58 +02:00
|
|
|
def tmpdir(request, tmpdir):
|
2013-08-22 04:28:15 +02:00
|
|
|
"""
|
|
|
|
Return a temporary directory path object which is unique to each test
|
|
|
|
function invocation, created as a sub directory of the base temporary
|
|
|
|
directory. The returned object is a ``tests.lib.path.Path`` object.
|
|
|
|
|
2016-07-22 02:24:31 +02:00
|
|
|
This uses the built-in tmpdir fixture from pytest itself but modified
|
|
|
|
to return our typical path object instead of py.path.local as well as
|
|
|
|
deleting the temporary directories at the end of each test case.
|
2013-08-22 04:28:15 +02:00
|
|
|
"""
|
2016-07-22 02:24:31 +02:00
|
|
|
assert tmpdir.isdir()
|
|
|
|
yield Path(str(tmpdir))
|
2014-02-08 03:35:37 +01:00
|
|
|
# Clear out the temporary directory after the test has finished using it.
|
|
|
|
# This should prevent us from needing a multiple gigabyte temporary
|
|
|
|
# directory while running the tests.
|
2018-07-30 16:27:58 +02:00
|
|
|
if not request.config.getoption("--keep-tmpdir"):
|
2018-07-30 15:19:41 +02:00
|
|
|
tmpdir.remove(ignore_errors=True)
|
2013-08-22 06:39:07 +02:00
|
|
|
|
|
|
|
|
2014-05-07 16:20:14 +02:00
|
|
|
@pytest.fixture(autouse=True)
|
|
|
|
def isolate(tmpdir):
|
|
|
|
"""
|
|
|
|
Isolate our tests so that things like global configuration files and the
|
|
|
|
like do not affect our test results.
|
|
|
|
|
|
|
|
We use an autouse function scoped fixture because we want to ensure that
|
|
|
|
every test has it's own isolated home directory.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# TODO: Figure out how to isolate from *system* level configuration files
|
|
|
|
# as well as user level configuration files.
|
|
|
|
|
|
|
|
# Create a directory to use as our home location.
|
|
|
|
home_dir = os.path.join(str(tmpdir), "home")
|
|
|
|
os.makedirs(home_dir)
|
|
|
|
|
|
|
|
# Create a directory to use as a fake root
|
|
|
|
fake_root = os.path.join(str(tmpdir), "fake-root")
|
|
|
|
os.makedirs(fake_root)
|
|
|
|
|
2017-10-06 21:51:42 +02:00
|
|
|
if sys.platform == 'win32':
|
|
|
|
# Note: this will only take effect in subprocesses...
|
|
|
|
home_drive, home_path = os.path.splitdrive(home_dir)
|
|
|
|
os.environ.update({
|
|
|
|
'USERPROFILE': home_dir,
|
|
|
|
'HOMEDRIVE': home_drive,
|
|
|
|
'HOMEPATH': home_path,
|
|
|
|
})
|
|
|
|
for env_var, sub_path in (
|
|
|
|
('APPDATA', 'AppData/Roaming'),
|
|
|
|
('LOCALAPPDATA', 'AppData/Local'),
|
|
|
|
):
|
|
|
|
path = os.path.join(home_dir, *sub_path.split('/'))
|
|
|
|
os.environ[env_var] = path
|
|
|
|
os.makedirs(path)
|
|
|
|
else:
|
|
|
|
# Set our home directory to our temporary directory, this should force
|
|
|
|
# all of our relative configuration files to be read from here instead
|
|
|
|
# of the user's actual $HOME directory.
|
|
|
|
os.environ["HOME"] = home_dir
|
|
|
|
# Isolate ourselves from XDG directories
|
|
|
|
os.environ["XDG_DATA_HOME"] = os.path.join(home_dir, ".local", "share")
|
|
|
|
os.environ["XDG_CONFIG_HOME"] = os.path.join(home_dir, ".config")
|
|
|
|
os.environ["XDG_CACHE_HOME"] = os.path.join(home_dir, ".cache")
|
|
|
|
os.environ["XDG_RUNTIME_DIR"] = os.path.join(home_dir, ".runtime")
|
|
|
|
os.environ["XDG_DATA_DIRS"] = ":".join([
|
|
|
|
os.path.join(fake_root, "usr", "local", "share"),
|
|
|
|
os.path.join(fake_root, "usr", "share"),
|
|
|
|
])
|
|
|
|
os.environ["XDG_CONFIG_DIRS"] = os.path.join(fake_root, "etc", "xdg")
|
2014-05-07 16:20:14 +02:00
|
|
|
|
|
|
|
# Configure git, because without an author name/email git will complain
|
|
|
|
# and cause test failures.
|
|
|
|
os.environ["GIT_CONFIG_NOSYSTEM"] = "1"
|
|
|
|
os.environ["GIT_AUTHOR_NAME"] = "pip"
|
|
|
|
os.environ["GIT_AUTHOR_EMAIL"] = "pypa-dev@googlegroups.com"
|
|
|
|
|
2014-12-24 01:37:00 +01:00
|
|
|
# We want to disable the version check from running in the tests
|
|
|
|
os.environ["PIP_DISABLE_PIP_VERSION_CHECK"] = "true"
|
|
|
|
|
2018-04-23 11:41:34 +02:00
|
|
|
# Make sure tests don't share a requirements tracker.
|
|
|
|
os.environ.pop('PIP_REQ_TRACKER', None)
|
|
|
|
|
2017-10-06 21:51:42 +02:00
|
|
|
# FIXME: Windows...
|
2014-05-07 16:20:14 +02:00
|
|
|
os.makedirs(os.path.join(home_dir, ".config", "git"))
|
|
|
|
with open(os.path.join(home_dir, ".config", "git", "config"), "wb") as fp:
|
|
|
|
fp.write(
|
|
|
|
b"[user]\n\tname = pip\n\temail = pypa-dev@googlegroups.com\n"
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2018-04-15 00:33:28 +02:00
|
|
|
@pytest.fixture(scope='session')
|
|
|
|
def pip_src(tmpdir_factory):
|
2018-11-29 09:50:33 +01:00
|
|
|
def not_code_files_and_folders(path, names):
|
|
|
|
# In the root directory, ignore all folders except "src"
|
|
|
|
if path == SRC_DIR:
|
|
|
|
folders = {name for name in names if os.path.isdir(path / name)}
|
|
|
|
return folders - {"src"}
|
|
|
|
|
|
|
|
# Ignore all compiled files and egg-info.
|
|
|
|
ignored = list()
|
|
|
|
for pattern in ["__pycache__", "*.pyc", "pip.egg-info"]:
|
|
|
|
ignored.extend(fnmatch.filter(names, pattern))
|
|
|
|
return set(ignored)
|
|
|
|
|
2018-04-15 00:33:28 +02:00
|
|
|
pip_src = Path(str(tmpdir_factory.mktemp('pip_src'))).join('pip_src')
|
|
|
|
# Copy over our source tree so that each use is self contained
|
2014-01-28 15:17:51 +01:00
|
|
|
shutil.copytree(
|
|
|
|
SRC_DIR,
|
2018-04-15 00:33:28 +02:00
|
|
|
pip_src.abspath,
|
2018-11-29 09:50:33 +01:00
|
|
|
ignore=not_code_files_and_folders,
|
2013-08-24 12:43:01 +02:00
|
|
|
)
|
2018-04-15 00:33:28 +02:00
|
|
|
return pip_src
|
|
|
|
|
|
|
|
|
2018-10-08 18:09:53 +02:00
|
|
|
def _common_wheel_editable_install(tmpdir_factory, common_wheels, package):
|
|
|
|
wheel_candidates = list(common_wheels.glob('%s-*.whl' % package))
|
|
|
|
assert len(wheel_candidates) == 1, wheel_candidates
|
|
|
|
install_dir = Path(str(tmpdir_factory.mktemp(package))) / 'install'
|
|
|
|
Wheel(wheel_candidates[0]).install_as_egg(install_dir)
|
|
|
|
(install_dir / 'EGG-INFO').rename(install_dir / '%s.egg-info' % package)
|
|
|
|
assert compileall.compile_dir(str(install_dir), quiet=1)
|
|
|
|
return install_dir
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture(scope='session')
|
|
|
|
def setuptools_install(tmpdir_factory, common_wheels):
|
|
|
|
return _common_wheel_editable_install(tmpdir_factory,
|
|
|
|
common_wheels,
|
|
|
|
'setuptools')
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture(scope='session')
|
|
|
|
def wheel_install(tmpdir_factory, common_wheels):
|
|
|
|
return _common_wheel_editable_install(tmpdir_factory,
|
|
|
|
common_wheels,
|
|
|
|
'wheel')
|
|
|
|
|
|
|
|
|
|
|
|
def install_egg_link(venv, project_name, egg_info_dir):
|
|
|
|
with open(venv.site / 'easy-install.pth', 'a') as fp:
|
|
|
|
fp.write(str(egg_info_dir.abspath) + '\n')
|
|
|
|
with open(venv.site / (project_name + '.egg-link'), 'w') as fp:
|
|
|
|
fp.write(str(egg_info_dir) + '\n.')
|
|
|
|
|
|
|
|
|
2018-04-15 00:33:28 +02:00
|
|
|
@pytest.yield_fixture(scope='session')
|
2018-10-09 08:23:03 +02:00
|
|
|
def virtualenv_template(request, tmpdir_factory, pip_src,
|
2018-10-08 18:09:53 +02:00
|
|
|
setuptools_install, common_wheels):
|
|
|
|
|
2018-10-09 08:23:03 +02:00
|
|
|
if six.PY3 and request.config.getoption('--use-venv'):
|
|
|
|
venv_type = 'venv'
|
|
|
|
else:
|
|
|
|
venv_type = 'virtualenv'
|
|
|
|
|
2013-08-24 12:43:01 +02:00
|
|
|
# Create the virtual environment
|
2018-10-08 18:09:53 +02:00
|
|
|
tmpdir = Path(str(tmpdir_factory.mktemp('virtualenv')))
|
2018-10-09 08:23:03 +02:00
|
|
|
venv = VirtualEnvironment(tmpdir.join("venv_orig"), venv_type=venv_type)
|
2018-10-08 18:09:53 +02:00
|
|
|
|
|
|
|
# Install setuptools and pip.
|
|
|
|
install_egg_link(venv, 'setuptools', setuptools_install)
|
|
|
|
pip_editable = Path(str(tmpdir_factory.mktemp('pip'))) / 'pip'
|
|
|
|
pip_src.copytree(pip_editable)
|
|
|
|
assert compileall.compile_dir(str(pip_editable), quiet=1)
|
|
|
|
subprocess.check_call([venv.bin / 'python', 'setup.py', '-q', 'develop'],
|
|
|
|
cwd=pip_editable)
|
|
|
|
|
|
|
|
# Drop (non-relocatable) launchers.
|
|
|
|
for exe in os.listdir(venv.bin):
|
|
|
|
if not (
|
|
|
|
exe.startswith('python') or
|
|
|
|
exe.startswith('libpy') # Don't remove libpypy-c.so...
|
|
|
|
):
|
|
|
|
(venv.bin / exe).remove()
|
|
|
|
|
|
|
|
# Enable user site packages.
|
|
|
|
venv.user_site_packages = True
|
2017-10-06 21:51:42 +02:00
|
|
|
|
2017-09-01 23:31:03 +02:00
|
|
|
# Rename original virtualenv directory to make sure
|
|
|
|
# it's not reused by mistake from one of the copies.
|
|
|
|
venv_template = tmpdir / "venv_template"
|
2018-10-08 18:09:53 +02:00
|
|
|
venv.move(venv_template)
|
|
|
|
yield venv
|
2013-08-24 12:43:01 +02:00
|
|
|
|
2015-04-01 03:39:45 +02:00
|
|
|
|
2017-09-01 23:31:03 +02:00
|
|
|
@pytest.yield_fixture
|
|
|
|
def virtualenv(virtualenv_template, tmpdir, isolate):
|
|
|
|
"""
|
|
|
|
Return a virtual environment which is unique to each test function
|
|
|
|
invocation created inside of a sub directory of the test function's
|
|
|
|
temporary directory. The returned object is a
|
|
|
|
``tests.lib.venv.VirtualEnvironment`` object.
|
|
|
|
"""
|
|
|
|
venv_location = tmpdir.join("workspace", "venv")
|
2018-10-08 18:09:53 +02:00
|
|
|
yield VirtualEnvironment(venv_location, virtualenv_template)
|
2013-08-22 06:39:07 +02:00
|
|
|
|
|
|
|
|
2018-10-08 18:09:53 +02:00
|
|
|
@pytest.fixture
|
|
|
|
def with_wheel(virtualenv, wheel_install):
|
|
|
|
install_egg_link(virtualenv, 'wheel', wheel_install)
|
|
|
|
|
|
|
|
|
2013-08-22 06:39:07 +02:00
|
|
|
@pytest.fixture
|
2019-01-11 11:12:44 +01:00
|
|
|
def script(tmpdir, virtualenv, deprecated_python):
|
2013-08-22 06:39:07 +02:00
|
|
|
"""
|
|
|
|
Return a PipTestEnvironment which is unique to each test function and
|
|
|
|
will execute all commands inside of the unique virtual environment for this
|
|
|
|
test function. The returned object is a
|
|
|
|
``tests.lib.scripttest.PipTestEnvironment``.
|
|
|
|
"""
|
|
|
|
return PipTestEnvironment(
|
|
|
|
# The base location for our test environment
|
2013-08-23 12:42:31 +02:00
|
|
|
tmpdir.join("workspace"),
|
2013-08-22 06:39:07 +02:00
|
|
|
|
|
|
|
# Tell the Test Environment where our virtualenv is located
|
2018-10-08 18:09:53 +02:00
|
|
|
virtualenv=virtualenv,
|
2013-08-22 06:39:07 +02:00
|
|
|
|
|
|
|
# Do not ignore hidden files, they need to be checked as well
|
|
|
|
ignore_hidden=False,
|
|
|
|
|
|
|
|
# We are starting with an already empty directory
|
|
|
|
start_clear=False,
|
|
|
|
|
|
|
|
# We want to ensure no temporary files are left behind, so the
|
|
|
|
# PipTestEnvironment needs to capture and assert against temp
|
|
|
|
capture_temp=True,
|
|
|
|
assert_no_temp=True,
|
2019-01-11 11:12:44 +01:00
|
|
|
|
|
|
|
# Deprecated python versions produce an extra deprecation warning
|
2019-03-20 14:35:28 +01:00
|
|
|
pip_expect_warning=deprecated_python,
|
2013-08-22 06:39:07 +02:00
|
|
|
)
|
2013-08-23 13:09:53 +02:00
|
|
|
|
|
|
|
|
2017-05-14 00:23:17 +02:00
|
|
|
@pytest.fixture(scope="session")
|
2018-10-08 18:09:53 +02:00
|
|
|
def common_wheels():
|
2017-05-14 00:23:17 +02:00
|
|
|
"""Provide a directory with latest setuptools and wheel wheels"""
|
2018-10-08 18:09:53 +02:00
|
|
|
return DATA_DIR.join('common_wheels')
|
2017-05-14 00:23:17 +02:00
|
|
|
|
|
|
|
|
2013-08-23 13:09:53 +02:00
|
|
|
@pytest.fixture
|
|
|
|
def data(tmpdir):
|
|
|
|
return TestData.copy(tmpdir.join("data"))
|
2017-03-26 17:17:02 +02:00
|
|
|
|
|
|
|
|
|
|
|
class InMemoryPipResult(object):
|
|
|
|
def __init__(self, returncode, stdout):
|
|
|
|
self.returncode = returncode
|
|
|
|
self.stdout = stdout
|
|
|
|
|
|
|
|
|
|
|
|
class InMemoryPip(object):
|
|
|
|
def pip(self, *args):
|
|
|
|
orig_stdout = sys.stdout
|
2017-03-26 17:49:02 +02:00
|
|
|
if six.PY3:
|
|
|
|
stdout = io.StringIO()
|
|
|
|
else:
|
|
|
|
stdout = io.BytesIO()
|
|
|
|
sys.stdout = stdout
|
2017-03-26 17:17:02 +02:00
|
|
|
try:
|
2017-08-31 17:48:18 +02:00
|
|
|
returncode = pip._internal.main(list(args))
|
2017-03-26 17:17:02 +02:00
|
|
|
except SystemExit as e:
|
|
|
|
returncode = e.code or 0
|
|
|
|
finally:
|
|
|
|
sys.stdout = orig_stdout
|
|
|
|
return InMemoryPipResult(returncode, stdout.getvalue())
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture
|
|
|
|
def in_memory_pip():
|
|
|
|
return InMemoryPip()
|
2019-01-11 11:12:44 +01:00
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture
|
|
|
|
def deprecated_python():
|
2019-01-31 00:58:48 +01:00
|
|
|
"""Used to indicate whether pip deprecated this python version"""
|
2019-01-19 21:01:33 +01:00
|
|
|
return sys.version_info[:2] in [(3, 4), (2, 7)]
|