Skip to content

tox: fix environment setup #4657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .tox_helpers/runpip.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
from glob import glob
import distutils.sysconfig
import os
import shutil
import subprocess
import sys
import textwrap


VIRTUAL_ENV = os.environ['VIRTUAL_ENV']
TOX_PIP_DIR = os.path.join(VIRTUAL_ENV, 'pip')
SITE_PACKAGES = distutils.sysconfig.get_python_lib()


def pip(args):
# First things first, safeguard the environment
# original pip so it can be used for all calls.
if not os.path.exists(TOX_PIP_DIR):
os.mkdir(TOX_PIP_DIR)
# Remove executable/launchers.
for entry in glob(os.path.join(VIRTUAL_ENV, 'bin', 'pip*')):
os.unlink(entry)
# Relocate package and distribution info.
for src in (
os.path.join(SITE_PACKAGES, 'pip'),
glob(os.path.join(SITE_PACKAGES, 'pip-*.dist-info'))[0],
):
shutil.move(src, TOX_PIP_DIR)
# Create a very simple launcher that
# can be used for Linux and Windows.
with open(os.path.join(TOX_PIP_DIR, 'pip.py'), 'w') as fp:
fp.write(textwrap.dedent(
'''
import sys
from pip._vendor import pkg_resources
sys.exit(pkg_resources.load_entry_point(
'pip', 'console_scripts', 'pip'
)())
'''
).lstrip())
# And use a temporary copy of that version
# so it can uninstall itself if needed.
temp_pip = TOX_PIP_DIR + '.tmp'
try:
shutil.copytree(TOX_PIP_DIR, temp_pip)
cmd = [sys.executable, os.path.join(temp_pip, 'pip.py')]
Copy link
Member

@pradyunsg pradyunsg Aug 10, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not do python -m pip here?

(Just curious)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because this will be run with the current directory set to the source directory, and will end up using the code being tested instead.

cmd.extend(args)
subprocess.check_call(cmd)
finally:
shutil.rmtree(temp_pip)


if __name__ == '__main__':
pip(sys.argv[1:])
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ recursive-include src/pip/_vendor *.pem
recursive-include docs Makefile *.rst *.py *.bat

prune .github
prune .tox_helpers
prune .travis
prune docs/_build
prune news
Expand Down
8 changes: 7 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@ envlist =
docs, packaging, lint-py2, lint-py3,
py27, py33, py34, py35, py36, py37, pypy

[helpers]
# Wrapper for calls to pip that make sure the version being used is the
# original virtualenv (stable) version, and not the code being tested.
pip = python {toxinidir}/.tox_helpers/runpip.py

[testenv]
setenv =
# This is required in order to get UTF-8 output inside of the subprocesses
# that our tests use.
LC_CTYPE = en_US.UTF-8
deps = -r{toxinidir}/dev-requirements.txt
commands = py.test --timeout 300 []
install_command = python -m pip install {opts} {packages}
install_command = {[helpers]pip} install {opts} {packages}
list_dependencies_command = {[helpers]pip} freeze

[testenv:docs]
deps = sphinx == 1.6.1
Expand Down