Merge pull request #8357 from ssurbhi560/add_helper_methods

Add methods for path lookups in test_install.py and test_install_compat.py

Author: sbidoul

news/f9de5945-af83-49a7-aa42-d8f2860fcaeb.trivial

@@ -209,8 +209,8 @@ def test_pip_second_command_line_interface_works(
         'INITools-0.2-py{pyversion}.egg-info'.format(**globals())
     )
     initools_folder = script.site_packages / 'initools'
-    assert egg_info_folder in result.files_created, str(result)
-    assert initools_folder in result.files_created, str(result)
+    result.did_create(egg_info_folder)
+    result.did_create(initools_folder)
 
 
 def test_install_exit_status_code_when_no_requirements(script):
@@ -241,8 +241,8 @@ def test_basic_install_from_pypi(script):
         'INITools-0.2-py{pyversion}.egg-info'.format(**globals())
     )
     initools_folder = script.site_packages / 'initools'
-    assert egg_info_folder in result.files_created, str(result)
-    assert initools_folder in result.files_created, str(result)
+    result.did_create(egg_info_folder)
+    result.did_create(initools_folder)
 
     # Should not display where it's looking for files
     assert "Looking in indexes: " not in result.stdout
@@ -338,14 +338,14 @@ def test_install_editable_uninstalls_existing_from_path(script, data):
     assert 'Successfully installed simplewheel' in result.stdout
     simple_folder = script.site_packages / 'simplewheel'
     result.assert_installed('simplewheel', editable=False)
-    assert simple_folder in result.files_created, str(result.stdout)
+    result.did_create(simple_folder)
 
     result = script.pip(
         'install', '-e',
         to_install,
     )
     install_path = script.site_packages / 'simplewheel.egg-link'
-    assert install_path in result.files_created, str(result)
+    result.did_create(install_path)
     assert 'Found existing installation: simplewheel 1.0' in result.stdout
     assert 'Uninstalling simplewheel-' in result.stdout
     assert 'Successfully uninstalled simplewheel' in result.stdout
@@ -421,8 +421,8 @@ def test_basic_install_from_local_directory(script, data, resolver):
         script.site_packages /
         'FSPkg-0.1.dev0-py{pyversion}.egg-info'.format(**globals())
     )
-    assert fspkg_folder in result.files_created, str(result.stdout)
-    assert egg_info_folder in result.files_created, str(result)
+    result.did_create(fspkg_folder)
+    result.did_create(egg_info_folder)
 
 
 @pytest.mark.parametrize("test_type,editable", [
@@ -465,13 +465,13 @@ def test_basic_install_relative_directory(script, data, test_type, editable):
     if not editable:
         result = script.pip('install', req_path,
                             cwd=script.scratch_path)
-        assert egg_info_file in result.files_created, str(result)
-        assert package_folder in result.files_created, str(result)
+        result.did_create(egg_info_file)
+        result.did_create(package_folder)
     else:
         # Editable install.
         result = script.pip('install', '-e' + req_path,
                             cwd=script.scratch_path)
-        assert egg_link_file in result.files_created, str(result)
+        result.did_create(egg_link_file)
 
 
 def test_install_quiet(script, data):
@@ -573,8 +573,8 @@ def test_install_from_local_directory_with_symlinks_to_directories(
         script.site_packages /
         'symlinks-0.1.dev0-py{pyversion}.egg-info'.format(**globals())
     )
-    assert pkg_folder in result.files_created, str(result.stdout)
-    assert egg_info_folder in result.files_created, str(result)
+    result.did_create(pkg_folder)
+    result.did_create(egg_info_folder)
 
 
 @pytest.mark.skipif("sys.platform == 'win32' or sys.version_info < (3,)")
@@ -596,8 +596,8 @@ def test_install_from_local_directory_with_socket_file(script, data, tmpdir):
     make_socket_file(socket_file_path)
 
     result = script.pip("install", "--verbose", to_install)
-    assert package_folder in result.files_created, str(result.stdout)
-    assert egg_info_file in result.files_created, str(result)
+    result.did_create(package_folder)
+    result.did_create(egg_info_file)
     assert str(socket_file_path) in result.stderr
 
 
@@ -688,8 +688,8 @@ def test_install_curdir(script, data):
         script.site_packages /
         'FSPkg-0.1.dev0-py{pyversion}.egg-info'.format(**globals())
     )
-    assert fspkg_folder in result.files_created, str(result.stdout)
-    assert egg_info_folder in result.files_created, str(result)
+    result.did_create(fspkg_folder)
+    result.did_create(egg_info_folder)
 
 
 def test_install_pardir(script, data):
@@ -703,8 +703,8 @@ def test_install_pardir(script, data):
         script.site_packages /
         'FSPkg-0.1.dev0-py{pyversion}.egg-info'.format(**globals())
     )
-    assert fspkg_folder in result.files_created, str(result.stdout)
-    assert egg_info_folder in result.files_created, str(result)
+    result.did_create(fspkg_folder)
+    result.did_create(egg_info_folder)
 
 
 @pytest.mark.network
@@ -746,7 +746,7 @@ def test_install_using_install_option_and_editable(script, tmpdir):
         script.venv / 'src' / 'pip-test-package' /
         folder / 'pip-test-package' + script.exe
     )
-    assert script_file in result.files_created
+    result.did_create(script_file)
 
 
 @pytest.mark.network
@@ -775,7 +775,7 @@ def test_install_package_with_same_name_in_curdir(script):
         script.site_packages /
         'mock-0.6.0-py{pyversion}.egg-info'.format(**globals())
     )
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
 
 mock100_setup_py = textwrap.dedent('''\
@@ -796,7 +796,7 @@ def test_install_folder_using_dot_slash(script):
         script.site_packages /
         'mock-100.1-py{pyversion}.egg-info'.format(**globals())
     )
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
 
 def test_install_folder_using_slash_in_the_end(script):
@@ -811,7 +811,7 @@ def test_install_folder_using_slash_in_the_end(script):
         script.site_packages /
         'mock-100.1-py{pyversion}.egg-info'.format(**globals())
     )
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
 
 def test_install_folder_using_relative_path(script):
@@ -827,7 +827,7 @@ def test_install_folder_using_relative_path(script):
         script.site_packages /
         'mock-100.1-py{pyversion}.egg-info'.format(**globals())
     )
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
 
 @pytest.mark.network
@@ -841,8 +841,8 @@ def test_install_package_which_contains_dev_in_name(script):
         script.site_packages /
         'django_devserver-0.0.4-py{pyversion}.egg-info'.format(**globals())
     )
-    assert devserver_folder in result.files_created, str(result.stdout)
-    assert egg_info_folder in result.files_created, str(result)
+    result.did_create(devserver_folder)
+    result.did_create(egg_info_folder)
 
 
 def test_install_package_with_target(script):
@@ -851,37 +851,31 @@ def test_install_package_with_target(script):
     """
     target_dir = script.scratch_path / 'target'
     result = script.pip_install_local('-t', target_dir, "simple==1.0")
-    assert Path('scratch') / 'target' / 'simple' in result.files_created, (
-        str(result)
-    )
+    result.did_create(Path('scratch') / 'target' / 'simple')
 
     # Test repeated call without --upgrade, no files should have changed
     result = script.pip_install_local(
         '-t', target_dir, "simple==1.0", expect_stderr=True,
     )
-    assert not Path('scratch') / 'target' / 'simple' in result.files_updated
+    result.did_not_update(Path('scratch') / 'target' / 'simple')
 
     # Test upgrade call, check that new version is installed
     result = script.pip_install_local('--upgrade', '-t',
                                       target_dir, "simple==2.0")
-    assert Path('scratch') / 'target' / 'simple' in result.files_updated, (
-        str(result)
-    )
+    result.did_update(Path('scratch') / 'target' / 'simple')
     egg_folder = (
         Path('scratch') / 'target' /
         'simple-2.0-py{pyversion}.egg-info'.format(**globals()))
-    assert egg_folder in result.files_created, (
-        str(result)
-    )
+    result.did_create(egg_folder)
 
     # Test install and upgrade of single-module package
     result = script.pip_install_local('-t', target_dir, 'singlemodule==0.0.0')
     singlemodule_py = Path('scratch') / 'target' / 'singlemodule.py'
-    assert singlemodule_py in result.files_created, str(result)
+    result.did_create(singlemodule_py)
 
     result = script.pip_install_local('-t', target_dir, 'singlemodule==0.0.1',
                                       '--upgrade')
-    assert singlemodule_py in result.files_updated, str(result)
+    result.did_update(singlemodule_py)
 
 
 @pytest.mark.parametrize("target_option", ['--target', '-t'])
@@ -917,7 +911,7 @@ def test_install_nonlocal_compatible_wheel(script, data):
     assert result.returncode == SUCCESS
 
     distinfo = Path('scratch') / 'target' / 'simplewheel-2.0-1.dist-info'
-    assert distinfo in result.files_created
+    result.did_create(distinfo)
 
     # Test install without --target
     result = script.pip(
@@ -948,7 +942,7 @@ def test_install_nonlocal_compatible_wheel_path(script, data):
     assert result.returncode == SUCCESS
 
     distinfo = Path('scratch') / 'target' / 'simplewheel-2.0.dist-info'
-    assert distinfo in result.files_created
+    result.did_create(distinfo)
 
     # Test a full path requirement (without --target)
     result = script.pip(
@@ -1008,7 +1002,7 @@ def test_install_package_with_root(script, data):
         os.path.join(script.scratch, 'root'),
         normal_install_path
     )
-    assert root_path in result.files_created, str(result)
+    result.did_create(root_path)
 
     # Should show find-links location in output
     assert "Looking in indexes: " not in result.stdout
@@ -1030,7 +1024,7 @@ def test_install_package_with_prefix(script, data):
         distutils.sysconfig.get_python_lib(prefix=rel_prefix_path) /
         'simple-1.0-py{}.egg-info'.format(pyversion)
     )
-    assert install_path in result.files_created, str(result)
+    result.did_create(install_path)
 
 
 def test_install_editable_with_prefix(script):
@@ -1061,7 +1055,7 @@ def test_install_editable_with_prefix(script):
 
     # assert pkga is installed at correct location
     install_path = script.scratch / site_packages / 'pkga.egg-link'
-    assert install_path in result.files_created, str(result)
+    result.did_create(install_path)
 
 
 def test_install_package_conflict_prefix_and_user(script, data):
@@ -1125,10 +1119,10 @@ def test_url_req_case_mismatch_no_index(script, data):
     # only Upper-1.0.tar.gz should get installed.
     egg_folder = script.site_packages / \
         'Upper-1.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
     egg_folder = script.site_packages / \
         'Upper-2.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder not in result.files_created, str(result)
+    result.did_not_create(egg_folder)
 
 
 def test_url_req_case_mismatch_file_index(script, data):
@@ -1154,10 +1148,10 @@ def test_url_req_case_mismatch_file_index(script, data):
     # only Upper-1.0.tar.gz should get installed.
     egg_folder = script.site_packages / \
         'Dinner-1.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
     egg_folder = script.site_packages / \
         'Dinner-2.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder not in result.files_created, str(result)
+    result.did_not_create(egg_folder)
 
 
 def test_url_incorrect_case_no_index(script, data):
@@ -1173,10 +1167,10 @@ def test_url_incorrect_case_no_index(script, data):
     # only Upper-2.0.tar.gz should get installed.
     egg_folder = script.site_packages / \
         'Upper-1.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder not in result.files_created, str(result)
+    result.did_not_create(egg_folder)
     egg_folder = script.site_packages / \
         'Upper-2.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
 
 def test_url_incorrect_case_file_index(script, data):
@@ -1193,10 +1187,10 @@ def test_url_incorrect_case_file_index(script, data):
     # only Upper-2.0.tar.gz should get installed.
     egg_folder = script.site_packages / \
         'Dinner-1.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder not in result.files_created, str(result)
+    result.did_not_create(egg_folder)
     egg_folder = script.site_packages / \
         'Dinner-2.0-py{pyversion}.egg-info'.format(**globals())
-    assert egg_folder in result.files_created, str(result)
+    result.did_create(egg_folder)
 
     # Should show index-url location in output
     assert "Looking in indexes: " in result.stdout
@@ -1658,8 +1652,8 @@ def test_installed_files_recorded_in_deterministic_order(script, data):
     installed_files_path = (
         script.site_packages / egg_info / 'installed-files.txt'
     )
-    assert fspkg_folder in result.files_created, str(result.stdout)
-    assert installed_files_path in result.files_created, str(result)
+    result.did_create(fspkg_folder)
+    result.did_create(installed_files_path)
 
     installed_files_path = result.files_created[installed_files_path].full
     installed_files_lines = [
@@ -1728,8 +1722,8 @@ def test_target_install_ignores_distutils_config_install_prefix(script):
 
     relative_target = os.path.relpath(target, script.base_path)
     relative_script_base = os.path.relpath(prefix, script.base_path)
-    assert relative_target in result.files_created
-    assert relative_script_base not in result.files_created
+    result.did_create(relative_target)
+    result.did_not_create(relative_script_base)
 
 
 @pytest.mark.incompatible_with_test_venv
@@ -1744,7 +1738,7 @@ def test_user_config_accepted(script):
     assert "Successfully installed simplewheel" in result.stdout
 
     relative_user = os.path.relpath(script.user_site_path, script.base_path)
-    assert join(relative_user, 'simplewheel') in result.files_created
+    result.did_create(join(relative_user, 'simplewheel'))
 
 
 @pytest.mark.parametrize(

tests/functional/test_install.py

@@ -32,13 +32,17 @@ def test_debian_egg_name_workaround(script):
     # so even if this test runs on a Debian/Ubuntu system with broken
     # setuptools, since our test runs inside a venv we'll still have the normal
     # .egg-info
-    assert egg_info in result.files_created, \
-        "Couldn't find {egg_info}".format(**locals())
+    result.did_create(
+        egg_info,
+        message="Couldn't find {egg_info}".format(**locals())
+    )
 
     # The Debian no-pyversion version of the .egg-info
     mangled = os.path.join(script.site_packages, "INITools-0.2.egg-info")
-    assert mangled not in result.files_created, \
-        "Found unexpected {mangled}".format(**locals())
+    result.did_not_create(
+        mangled,
+        message="Found unexpected {mangled}".format(**locals())
+    )
 
     # Simulate a Debian install by copying the .egg-info to their name for it
     full_egg_info = os.path.join(script.base_path, egg_info)