1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
pip/tests/functional/test_list.py
Pradyun Gedam 8981895b5e
Skip all failing tests when using venv
Our isolation logic for venv isn't correct and that is causing these
tests to fail. The culprits for this are:

  tests/lib/venv.py::VirtualEnvironment.user_site_packages
  tests/lib/venv.py::VirtualEnvironment.sitecustomize

Both these together are supposed to create an environment to isolate the
tests. However, they were written for virtualenv and make assumptions
that are not true for environments created with venv. Until we can fix
VirtualEnvironment to properly isolate the test from the underlying test
environment when using venv, these tests will continue to fail.

This is blocking an important bugfix for users facing issues with since
pip is installing packages into `--user` when run in a venv, even when
`--user` isn't visible from that environment.

As a temporary band-aid for this problem, I'm skipping these tests to
unblock us from shipping the bugfix for the aforementioned issue.

The test isolation logic should be fixed to work for venv. Once such a
fix is made, this commit should be reverted.
2019-11-05 23:02:45 +05:30

546 lines
18 KiB
Python

import json
import os
import pytest
from tests.lib.path import Path
@pytest.fixture(scope="session")
def simple_script(tmpdir_factory, script_factory, shared_data):
tmpdir = Path(str(tmpdir_factory.mktemp("pip_test_package")))
script = script_factory(tmpdir.joinpath("workspace"))
script.pip(
'install', '-f', shared_data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0',
)
return script
def test_basic_list(simple_script):
"""
Test default behavior of list command without format specifier.
"""
result = simple_script.pip('list')
assert 'simple 1.0' in result.stdout, str(result)
assert 'simple2 3.0' in result.stdout, str(result)
def test_verbose_flag(simple_script):
"""
Test the list command with the '-v' option
"""
result = simple_script.pip('list', '-v', '--format=columns')
assert 'Package' in result.stdout, str(result)
assert 'Version' in result.stdout, str(result)
assert 'Location' in result.stdout, str(result)
assert 'Installer' in result.stdout, str(result)
assert 'simple 1.0' in result.stdout, str(result)
assert 'simple2 3.0' in result.stdout, str(result)
def test_columns_flag(simple_script):
"""
Test the list command with the '--format=columns' option
"""
result = simple_script.pip('list', '--format=columns')
assert 'Package' in result.stdout, str(result)
assert 'Version' in result.stdout, str(result)
assert 'simple (1.0)' not in result.stdout, str(result)
assert 'simple 1.0' in result.stdout, str(result)
assert 'simple2 3.0' in result.stdout, str(result)
def test_format_priority(simple_script):
"""
Test that latest format has priority over previous ones.
"""
result = simple_script.pip('list', '--format=columns', '--format=freeze',
expect_stderr=True)
assert 'simple==1.0' in result.stdout, str(result)
assert 'simple2==3.0' in result.stdout, str(result)
assert 'simple 1.0' not in result.stdout, str(result)
assert 'simple2 3.0' not in result.stdout, str(result)
result = simple_script.pip('list', '--format=freeze', '--format=columns')
assert 'Package' in result.stdout, str(result)
assert 'Version' in result.stdout, str(result)
assert 'simple==1.0' not in result.stdout, str(result)
assert 'simple2==3.0' not in result.stdout, str(result)
assert 'simple 1.0' in result.stdout, str(result)
assert 'simple2 3.0' in result.stdout, str(result)
def test_local_flag(simple_script):
"""
Test the behavior of --local flag in the list command
"""
result = simple_script.pip('list', '--local', '--format=json')
assert {"name": "simple", "version": "1.0"} in json.loads(result.stdout)
def test_local_columns_flag(simple_script):
"""
Test the behavior of --local --format=columns flags in the list command
"""
result = simple_script.pip('list', '--local', '--format=columns')
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'simple (1.0)' not in result.stdout
assert 'simple 1.0' in result.stdout, str(result)
@pytest.mark.network
@pytest.mark.incompatible_with_test_venv
def test_user_flag(script, data):
"""
Test the behavior of --user flag in the list command
"""
script.pip('download', 'setuptools', 'wheel', '-d', data.packages)
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
script.pip('install', '-f', data.find_links, '--no-index',
'--user', 'simple2==2.0')
result = script.pip('list', '--user', '--format=json')
assert {"name": "simple", "version": "1.0"} \
not in json.loads(result.stdout)
assert {"name": "simple2", "version": "2.0"} in json.loads(result.stdout)
@pytest.mark.network
@pytest.mark.incompatible_with_test_venv
def test_user_columns_flag(script, data):
"""
Test the behavior of --user --format=columns flags in the list command
"""
script.pip('download', 'setuptools', 'wheel', '-d', data.packages)
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
script.pip('install', '-f', data.find_links, '--no-index',
'--user', 'simple2==2.0')
result = script.pip('list', '--user', '--format=columns')
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'simple2 (2.0)' not in result.stdout
assert 'simple2 2.0' in result.stdout, str(result)
@pytest.mark.network
def test_uptodate_flag(script, data):
"""
Test the behavior of --uptodate flag in the list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0',
)
script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index', '--uptodate',
'--format=json',
)
assert {"name": "simple", "version": "1.0"} \
not in json.loads(result.stdout) # 3.0 is latest
assert {"name": "pip-test-package", "version": "0.1.1"} \
in json.loads(result.stdout) # editables included
assert {"name": "simple2", "version": "3.0"} in json.loads(result.stdout)
@pytest.mark.network
def test_uptodate_columns_flag(script, data):
"""
Test the behavior of --uptodate --format=columns flag in the list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0',
)
script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index', '--uptodate',
'--format=columns',
)
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'Location' in result.stdout # editables included
assert 'pip-test-package (0.1.1,' not in result.stdout
assert 'pip-test-package 0.1.1' in result.stdout, str(result)
assert 'simple2 3.0' in result.stdout, str(result)
@pytest.mark.network
def test_outdated_flag(script, data):
"""
Test the behavior of --outdated flag in the list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0', 'simplewheel==1.0',
)
script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git'
'@0.1#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index', '--outdated',
'--format=json',
)
assert {"name": "simple", "version": "1.0",
"latest_version": "3.0", "latest_filetype": "sdist"} \
in json.loads(result.stdout)
assert dict(name="simplewheel", version="1.0",
latest_version="2.0", latest_filetype="wheel") \
in json.loads(result.stdout)
assert dict(name="pip-test-package", version="0.1",
latest_version="0.1.1", latest_filetype="sdist") \
in json.loads(result.stdout)
assert "simple2" not in {p["name"] for p in json.loads(result.stdout)}
@pytest.mark.network
def test_outdated_columns_flag(script, data):
"""
Test the behavior of --outdated --format=columns flag in the list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0', 'simplewheel==1.0',
)
script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git'
'@0.1#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index', '--outdated',
'--format=columns',
)
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'Latest' in result.stdout
assert 'Type' in result.stdout
assert 'simple (1.0) - Latest: 3.0 [sdist]' not in result.stdout
assert 'simplewheel (1.0) - Latest: 2.0 [wheel]' not in result.stdout
assert 'simple 1.0 3.0 sdist' in result.stdout, (
str(result)
)
assert 'simplewheel 1.0 2.0 wheel' in result.stdout, (
str(result)
)
assert 'simple2' not in result.stdout, str(result) # 3.0 is latest
@pytest.fixture(scope="session")
def pip_test_package_script(tmpdir_factory, script_factory, shared_data):
tmpdir = Path(str(tmpdir_factory.mktemp("pip_test_package")))
script = script_factory(tmpdir.joinpath("workspace"))
script.pip(
'install', '-f', shared_data.find_links, '--no-index', 'simple==1.0'
)
script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git#egg=pip-test-package'
)
return script
@pytest.mark.network
def test_editables_flag(pip_test_package_script):
"""
Test the behavior of --editables flag in the list command
"""
result = pip_test_package_script.pip('list', '--editable', '--format=json')
result2 = pip_test_package_script.pip('list', '--editable')
assert {"name": "simple", "version": "1.0"} \
not in json.loads(result.stdout)
assert os.path.join('src', 'pip-test-package') in result2.stdout
@pytest.mark.network
def test_exclude_editable_flag(pip_test_package_script):
"""
Test the behavior of --editables flag in the list command
"""
result = pip_test_package_script.pip(
'list', '--exclude-editable', '--format=json'
)
assert {"name": "simple", "version": "1.0"} in json.loads(result.stdout)
assert "pip-test-package" \
not in {p["name"] for p in json.loads(result.stdout)}
@pytest.mark.network
def test_editables_columns_flag(pip_test_package_script):
"""
Test the behavior of --editables flag in the list command
"""
result = pip_test_package_script.pip(
'list', '--editable', '--format=columns'
)
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'Location' in result.stdout
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
)
@pytest.mark.network
def test_uptodate_editables_flag(pip_test_package_script, data):
"""
test the behavior of --editable --uptodate flag in the list command
"""
result = pip_test_package_script.pip(
'list', '-f', data.find_links, '--no-index',
'--editable', '--uptodate',
)
assert 'simple' not in result.stdout
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
)
@pytest.mark.network
def test_uptodate_editables_columns_flag(pip_test_package_script, data):
"""
test the behavior of --editable --uptodate --format=columns flag in the
list command
"""
result = pip_test_package_script.pip(
'list', '-f', data.find_links, '--no-index',
'--editable', '--uptodate', '--format=columns',
)
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'Location' in result.stdout
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
)
@pytest.mark.network
def test_outdated_editables_flag(script, data):
"""
test the behavior of --editable --outdated flag in the list command
"""
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
result = script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git'
'@0.1#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index',
'--editable', '--outdated',
)
assert 'simple' not in result.stdout
assert os.path.join('src', 'pip-test-package') in result.stdout
@pytest.mark.network
def test_outdated_editables_columns_flag(script, data):
"""
test the behavior of --editable --outdated flag in the list command
"""
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
result = script.pip(
'install', '-e',
'git+https://github.com/pypa/pip-test-package.git'
'@0.1#egg=pip-test-package'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index',
'--editable', '--outdated', '--format=columns',
)
assert 'Package' in result.stdout
assert 'Version' in result.stdout
assert 'Location' in result.stdout
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
)
def test_outdated_not_required_flag(script, data):
"""
test the behavior of --outdated --not-required flag in the list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index',
'simple==2.0', 'require_simple==1.0'
)
result = script.pip(
'list', '-f', data.find_links, '--no-index', '--outdated',
'--not-required', '--format=json',
)
assert [] == json.loads(result.stdout)
def test_outdated_pre(script, data):
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
# Let's build a fake wheelhouse
script.scratch_path.joinpath("wheelhouse").mkdir()
wheelhouse_path = script.scratch_path / 'wheelhouse'
wheelhouse_path.joinpath('simple-1.1-py2.py3-none-any.whl').write_text('')
wheelhouse_path.joinpath(
'simple-2.0.dev0-py2.py3-none-any.whl'
).write_text('')
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path,
'--format=json',
)
assert {"name": "simple", "version": "1.0"} in json.loads(result.stdout)
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path, '--outdated',
'--format=json',
)
assert {"name": "simple", "version": "1.0",
"latest_version": "1.1", "latest_filetype": "wheel"} \
in json.loads(result.stdout)
result_pre = script.pip('list', '--no-index',
'--find-links', wheelhouse_path,
'--outdated', '--pre', '--format=json')
assert {"name": "simple", "version": "1.0",
"latest_version": "2.0.dev0", "latest_filetype": "wheel"} \
in json.loads(result_pre.stdout)
def test_outdated_formats(script, data):
""" Test of different outdated formats """
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
# Let's build a fake wheelhouse
script.scratch_path.joinpath("wheelhouse").mkdir()
wheelhouse_path = script.scratch_path / 'wheelhouse'
wheelhouse_path.joinpath('simple-1.1-py2.py3-none-any.whl').write_text('')
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path,
'--format=freeze',
)
assert 'simple==1.0' in result.stdout
# Check columns
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path,
'--outdated', '--format=columns',
)
assert 'Package Version Latest Type' in result.stdout
assert 'simple 1.0 1.1 wheel' in result.stdout
# Check freeze
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path,
'--outdated', '--format=freeze',
)
assert 'simple==1.0' in result.stdout
# Check json
result = script.pip(
'list', '--no-index', '--find-links', wheelhouse_path,
'--outdated', '--format=json',
)
data = json.loads(result.stdout)
assert data == [{'name': 'simple', 'version': '1.0',
'latest_version': '1.1', 'latest_filetype': 'wheel'}]
def test_not_required_flag(script, data):
script.pip(
'install', '-f', data.find_links, '--no-index', 'TopoRequires4'
)
result = script.pip('list', '--not-required', expect_stderr=True)
assert 'TopoRequires4 ' in result.stdout, str(result)
assert 'TopoRequires ' not in result.stdout
assert 'TopoRequires2 ' not in result.stdout
assert 'TopoRequires3 ' not in result.stdout
def test_list_freeze(simple_script):
"""
Test freeze formatting of list command
"""
result = simple_script.pip('list', '--format=freeze')
assert 'simple==1.0' in result.stdout, str(result)
assert 'simple2==3.0' in result.stdout, str(result)
def test_list_json(simple_script):
"""
Test json formatting of list command
"""
result = simple_script.pip('list', '--format=json')
data = json.loads(result.stdout)
assert {'name': 'simple', 'version': '1.0'} in data
assert {'name': 'simple2', 'version': '3.0'} in data
def test_list_path(tmpdir, script, data):
"""
Test list with --path.
"""
result = script.pip('list', '--path', tmpdir, '--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple', 'version': '2.0'} not in json_result
script.pip_install_local('--target', tmpdir, 'simple==2.0')
result = script.pip('list', '--path', tmpdir, '--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple', 'version': '2.0'} in json_result
@pytest.mark.incompatible_with_test_venv
def test_list_path_exclude_user(tmpdir, script, data):
"""
Test list with --path and make sure packages from --user are not picked
up.
"""
script.pip_install_local('--user', 'simple2')
script.pip_install_local('--target', tmpdir, 'simple==1.0')
result = script.pip('list', '--user', '--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple2', 'version': '3.0'} in json_result
result = script.pip('list', '--path', tmpdir, '--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple', 'version': '1.0'} in json_result
def test_list_path_multiple(tmpdir, script, data):
"""
Test list with multiple --path arguments.
"""
path1 = tmpdir / "path1"
os.mkdir(path1)
path2 = tmpdir / "path2"
os.mkdir(path2)
script.pip_install_local('--target', path1, 'simple==2.0')
script.pip_install_local('--target', path2, 'simple2==3.0')
result = script.pip('list', '--path', path1, '--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple', 'version': '2.0'} in json_result
result = script.pip('list', '--path', path1, '--path', path2,
'--format=json')
json_result = json.loads(result.stdout)
assert {'name': 'simple', 'version': '2.0'} in json_result
assert {'name': 'simple2', 'version': '3.0'} in json_result