pip/tests/functional/test_cache.py

import os
import re
import shutil
from glob import glob

import pytest


@pytest.fixture
def cache_dir(script):
    result = script.run(
        'python', '-c',
        'from pip._internal.locations import USER_CACHE_DIR;'
        'print(USER_CACHE_DIR)'
    )
    return result.stdout.strip()


@pytest.fixture
def wheel_cache_dir(cache_dir):
    return os.path.normcase(os.path.join(cache_dir, 'wheels'))


@pytest.fixture
def wheel_cache_files(wheel_cache_dir):
    destination = os.path.join(wheel_cache_dir, 'arbitrary', 'pathname')

    if not os.path.exists(destination):
        return []

    filenames = glob(os.path.join(destination, '*.whl'))
    files = []
    for filename in filenames:
        files.append(os.path.join(destination, filename))
    return files


@pytest.fixture
def populate_wheel_cache(wheel_cache_dir):
    destination = os.path.join(wheel_cache_dir, 'arbitrary', 'pathname')
    os.makedirs(destination)

    files = [
        ('yyy-1.2.3', os.path.join(destination, 'yyy-1.2.3-py3-none-any.whl')),
        ('zzz-4.5.6', os.path.join(destination, 'zzz-4.5.6-py3-none-any.whl')),
        ('zzz-4.5.7', os.path.join(destination, 'zzz-4.5.7-py3-none-any.whl')),
        ('zzz-7.8.9', os.path.join(destination, 'zzz-7.8.9-py3-none-any.whl')),
    ]

    for _name, filename in files:
        with open(filename, 'w'):
            pass

    return files


@pytest.fixture
def empty_wheel_cache(wheel_cache_dir):
    if os.path.exists(wheel_cache_dir):
        shutil.rmtree(wheel_cache_dir)


def list_matches_wheel(wheel_name, lines):
    """Returns True if any line in `lines`, which should be the output of
    a `pip cache list` call, matches `wheel_name`.

    E.g., If wheel_name is `foo-1.2.3` it searches for a line starting with
          `- foo-1.2.3-py3-none-any.whl `."""
    expected = ' - {}-py3-none-any.whl '.format(wheel_name)
    return any(map(lambda l: l.startswith(expected), lines))


@pytest.fixture
def remove_matches_wheel(wheel_cache_dir):
    """Returns True if any line in `lines`, which should be the output of
    a `pip cache remove`/`pip cache purge` call, matches `wheel_name`.

    E.g., If wheel_name is `foo-1.2.3`, it searches for a line equal to
    `Removed <wheel cache dir>/arbitrary/pathname/foo-1.2.3-py3-none-any.whl`.
    """

    def _remove_matches_wheel(wheel_name, lines):
        wheel_filename = '{}-py3-none-any.whl'.format(wheel_name)

        # The "/arbitrary/pathname/" bit is an implementation detail of how
        # the `populate_wheel_cache` fixture is implemented.
        expected = 'Removed {}/arbitrary/pathname/{}'.format(
            wheel_cache_dir, wheel_filename,
        )
        return expected in lines

    return _remove_matches_wheel


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_info(script, wheel_cache_dir, wheel_cache_files):
    result = script.pip('cache', 'info')

    assert 'Location: {}'.format(wheel_cache_dir) in result.stdout
    num_wheels = len(wheel_cache_files)
    assert 'Number of wheels: {}'.format(num_wheels) in result.stdout


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_list(script):
    """Running `pip cache list` should return exactly what the
    populate_wheel_cache fixture adds."""
    result = script.pip('cache', 'list')
    lines = result.stdout.splitlines()
    assert list_matches_wheel('yyy-1.2.3', lines)
    assert list_matches_wheel('zzz-4.5.6', lines)
    assert list_matches_wheel('zzz-4.5.7', lines)
    assert list_matches_wheel('zzz-7.8.9', lines)


@pytest.mark.usefixtures("empty_wheel_cache")
def test_cache_list_with_empty_cache(script):
    """Running `pip cache list` with an empty cache should print
    "Nothing cached." and exit."""
    result = script.pip('cache', 'list')
    assert result.stdout == "Nothing cached.\n"


def test_cache_list_too_many_args(script):
    """Passing `pip cache list` too many arguments should cause an error."""
    script.pip('cache', 'list', 'aaa', 'bbb',
               expect_error=True)


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_list_name_match(script):
    """Running `pip cache list zzz` should list zzz-4.5.6, zzz-4.5.7,
    zzz-7.8.9, but nothing else."""
    result = script.pip('cache', 'list', 'zzz', '--verbose')
    lines = result.stdout.splitlines()

    assert not list_matches_wheel('yyy-1.2.3', lines)
    assert list_matches_wheel('zzz-4.5.6', lines)
    assert list_matches_wheel('zzz-4.5.7', lines)
    assert list_matches_wheel('zzz-7.8.9', lines)


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_list_name_and_version_match(script):
    """Running `pip cache list zzz-4.5.6` should list zzz-4.5.6, but
    nothing else."""
    result = script.pip('cache', 'list', 'zzz-4.5.6', '--verbose')
    lines = result.stdout.splitlines()

    assert not list_matches_wheel('yyy-1.2.3', lines)
    assert list_matches_wheel('zzz-4.5.6', lines)
    assert not list_matches_wheel('zzz-4.5.7', lines)
    assert not list_matches_wheel('zzz-7.8.9', lines)


@pytest.mark.usefixture("populate_wheel_cache")
def test_cache_remove_no_arguments(script):
    """Running `pip cache remove` with no arguments should cause an error."""
    script.pip('cache', 'remove', expect_error=True)


def test_cache_remove_too_many_args(script):
    """Passing `pip cache remove` too many arguments should cause an error."""
    script.pip('cache', 'remove', 'aaa', 'bbb',
               expect_error=True)


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_remove_name_match(script, remove_matches_wheel):
    """Running `pip cache remove zzz` should remove zzz-4.5.6 and zzz-7.8.9,
    but nothing else."""
    result = script.pip('cache', 'remove', 'zzz', '--verbose')
    lines = result.stdout.splitlines()

    assert not remove_matches_wheel('yyy-1.2.3', lines)
    assert remove_matches_wheel('zzz-4.5.6', lines)
    assert remove_matches_wheel('zzz-4.5.7', lines)
    assert remove_matches_wheel('zzz-7.8.9', lines)


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_remove_name_and_version_match(script, remove_matches_wheel):
    """Running `pip cache remove zzz-4.5.6` should remove zzz-4.5.6, but
    nothing else."""
    result = script.pip('cache', 'remove', 'zzz-4.5.6', '--verbose')
    lines = result.stdout.splitlines()

    assert not remove_matches_wheel('yyy-1.2.3', lines)
    assert remove_matches_wheel('zzz-4.5.6', lines)
    assert not remove_matches_wheel('zzz-4.5.7', lines)
    assert not remove_matches_wheel('zzz-7.8.9', lines)


@pytest.mark.usefixtures("populate_wheel_cache")
def test_cache_purge(script):
    result = script.pip('cache', 'purge', 'aaa', '--verbose',
                        expect_error=True)
    assert 'yyy-1.2.3' not in result.stdout
    assert 'zzz-4.5.6' not in result.stdout

    result = script.pip('cache', 'purge', '--verbose')
    assert 'yyy-1.2.3' in result.stdout
    assert 'zzz-4.5.6' in result.stdout