2014-05-07 16:20:14 +02:00
|
|
|
import os
|
2013-08-22 13:49:53 +02:00
|
|
|
import shutil
|
|
|
|
|
2013-08-22 04:28:15 +02:00
|
|
|
import py
|
|
|
|
import pytest
|
|
|
|
|
2013-08-24 12:43:01 +02:00
|
|
|
from tests.lib import 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
|
|
|
|
|
|
|
|
2014-07-01 02:00:35 +02:00
|
|
|
def pytest_collection_modifyitems(items):
|
|
|
|
for item in items:
|
|
|
|
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)
|
|
|
|
|
|
|
|
# We don't want to allow using the script resource if this is a
|
|
|
|
# unit test, as unit tests should not need all that heavy lifting
|
|
|
|
if set(getattr(item, "funcargnames", [])) & set(["script"]):
|
|
|
|
raise RuntimeError(
|
|
|
|
"Cannot use the ``script`` funcarg in a unit test: "
|
|
|
|
"(filename = {0}, item = {1})".format(module_path, item)
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
raise RuntimeError(
|
|
|
|
"Unknown test type (filename = {0})".format(module_path)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2013-08-22 04:28:15 +02:00
|
|
|
@pytest.fixture
|
|
|
|
def tmpdir(request):
|
|
|
|
"""
|
|
|
|
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.
|
|
|
|
|
|
|
|
This is taken from pytest itself but modified to return our typical
|
2014-02-08 03:35:37 +01:00
|
|
|
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
|
|
|
"""
|
|
|
|
name = request.node.name
|
|
|
|
name = py.std.re.sub("[\W]", "_", name)
|
|
|
|
tmp = request.config._tmpdirhandler.mktemp(name, numbered=True)
|
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.
|
|
|
|
request.addfinalizer(lambda: shutil.rmtree(str(tmp), ignore_errors=True))
|
|
|
|
|
2014-04-28 16:38:39 +02:00
|
|
|
return Path(str(tmp))
|
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: Ensure Windows will respect $HOME, including for the cache
|
|
|
|
# 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)
|
|
|
|
|
|
|
|
# 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")
|
|
|
|
|
|
|
|
# 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"
|
|
|
|
|
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"
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2013-08-22 06:39:07 +02:00
|
|
|
@pytest.fixture
|
2013-08-22 13:49:53 +02:00
|
|
|
def virtualenv(tmpdir, monkeypatch):
|
2013-08-22 06:39:07 +02:00
|
|
|
"""
|
|
|
|
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.
|
|
|
|
"""
|
2013-08-22 13:49:53 +02:00
|
|
|
# Force shutil to use the older method of rmtree that didn't use the fd
|
|
|
|
# functions. These seem to fail on Travis (and only on Travis).
|
|
|
|
monkeypatch.setattr(shutil, "_use_fd_functions", False, raising=False)
|
2013-08-24 12:43:01 +02:00
|
|
|
|
|
|
|
# Copy over our source tree so that each virtual environment is self
|
|
|
|
# contained
|
|
|
|
pip_src = tmpdir.join("pip_src").abspath
|
2014-01-28 15:17:51 +01:00
|
|
|
shutil.copytree(
|
|
|
|
SRC_DIR,
|
|
|
|
pip_src,
|
2013-08-24 12:43:01 +02:00
|
|
|
ignore=shutil.ignore_patterns(
|
2015-03-15 18:55:36 +01:00
|
|
|
"*.pyc", "__pycache__", "contrib", "docs", "tasks", "*.txt",
|
2015-03-15 12:45:50 +01:00
|
|
|
"tests", "pip.egg-info", "build", "dist", ".tox", ".git",
|
2013-08-24 12:43:01 +02:00
|
|
|
),
|
|
|
|
)
|
|
|
|
|
|
|
|
# Create the virtual environment
|
|
|
|
venv = VirtualEnvironment.create(
|
|
|
|
tmpdir.join("workspace", "venv"),
|
|
|
|
pip_source_dir=pip_src,
|
|
|
|
)
|
|
|
|
|
|
|
|
# Undo our monkeypatching of shutil
|
2013-08-22 13:49:53 +02:00
|
|
|
monkeypatch.undo()
|
|
|
|
|
|
|
|
return venv
|
2013-08-22 06:39:07 +02:00
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture
|
|
|
|
def script(tmpdir, virtualenv):
|
|
|
|
"""
|
|
|
|
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
|
|
|
|
virtualenv=virtualenv.location,
|
|
|
|
|
|
|
|
# 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,
|
|
|
|
)
|
2013-08-23 13:09:53 +02:00
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture
|
|
|
|
def data(tmpdir):
|
|
|
|
return TestData.copy(tmpdir.join("data"))
|