Rework PipTestResult for detection of modern editables

Author: sbidoul

tests/functional/test_install.py

@@ -437,7 +437,9 @@ def test_install_editable_uninstalls_existing(
     to_install = data.packages.joinpath("pip_test_package-0.1.tar.gz")
     result = script.pip_install_local(to_install)
     assert "Successfully installed pip-test-package" in result.stdout
-    result.assert_installed("piptestpackage", editable=False)
+    result.assert_installed(
+        "piptestpackage", dist_name="pip-test-package", editable=False
+    )
 
     result = script.pip(
         "install",
@@ -449,7 +451,9 @@ def test_install_editable_uninstalls_existing(
             )
         ),
     )
-    result.assert_installed("pip-test-package", with_files=[".git"])
+    result.assert_installed(
+        "piptestpackage", dist_name="pip-test-package", with_files=[".git"]
+    )
     assert "Found existing installation: pip-test-package 0.1" in result.stdout
     assert "Uninstalling pip-test-package-" in result.stdout
     assert "Successfully uninstalled pip-test-package" in result.stdout

tests/functional/test_install_user.py

@@ -75,7 +75,7 @@ def test_install_subversion_usersite_editable_with_distribute(
                 )
             ),
         )
-        result.assert_installed("INITools", use_user_site=True)
+        result.assert_installed("INITools")
 
     def test_install_from_current_directory_into_usersite(
         self, script: PipTestEnvironment, data: TestData

tests/functional/test_install_vcs_git.py

@@ -183,7 +183,9 @@ def test_install_editable_from_git_with_https(
     url_path = "pypa/pip-test-package.git"
     local_url = _github_checkout(url_path, tmpdir, egg="pip-test-package")
     result = script.pip("install", "-e", local_url)
-    result.assert_installed("pip-test-package", with_files=[".git"])
+    result.assert_installed(
+        "piptestpackage", dist_name="pip-test-package", with_files=[".git"]
+    )
 
 
 @pytest.mark.network
@@ -193,11 +195,12 @@ def test_install_noneditable_git(script: PipTestEnvironment) -> None:
     """
     result = script.pip(
         "install",
-        "git+https://github.com/pypa/pip-test-package.git"
-        "@0.1.1#egg=pip-test-package",
+        "git+https://github.com/pypa/[email protected]#egg=pip-test-package",
     )
     dist_info_folder = script.site_packages / "pip_test_package-0.1.1.dist-info"
-    result.assert_installed("piptestpackage", without_egg_link=True, editable=False)
+    result.assert_installed(
+        "piptestpackage", dist_name="pip-test-package", editable=False
+    )
     result.did_create(dist_info_folder)
 
 

tests/functional/test_install_wheel.py

@@ -38,15 +38,15 @@ def test_install_from_future_wheel_version(
 
     result = script.pip("install", package, "--no-index", expect_error=True)
     with pytest.raises(TestFailure):
-        result.assert_installed("futurewheel", without_egg_link=True, editable=False)
+        result.assert_installed("futurewheel", editable=False)
 
     package = make_wheel_with_file(
         name="futurewheel",
         version="1.9",
         wheel_metadata_updates={"Wheel-Version": "1.9"},
     ).save_to_dir(tmpdir)
     result = script.pip("install", package, "--no-index", expect_stderr=True)
-    result.assert_installed("futurewheel", without_egg_link=True, editable=False)
+    result.assert_installed("futurewheel", editable=False)
 
 
 @pytest.mark.parametrize(
@@ -67,7 +67,7 @@ def test_install_from_broken_wheel(
     package = data.packages.joinpath(wheel_name)
     result = script.pip("install", package, "--no-index", expect_error=True)
     with pytest.raises(TestFailure):
-        result.assert_installed("futurewheel", without_egg_link=True, editable=False)
+        result.assert_installed("futurewheel", editable=False)
 
 
 def test_basic_install_from_wheel(

tests/lib/__init__.py

@@ -34,7 +34,6 @@
 from pip._internal.models.selection_prefs import SelectionPreferences
 from pip._internal.models.target_python import TargetPython
 from pip._internal.network.session import PipSession
-from pip._internal.utils.egg_link import _egg_link_names
 
 from tests.lib.venv import VirtualEnvironment
 from tests.lib.wheel import make_wheel
@@ -294,12 +293,6 @@ def files_updated(self) -> FoundFiles:
     def files_deleted(self) -> FoundFiles:
         return FoundFiles(self._impl.files_deleted)
 
-    def _get_egg_link_path_created(self, egg_link_paths: list[str]) -> str | None:
-        for egg_link_path in egg_link_paths:
-            if egg_link_path in self.files_created:
-                return egg_link_path
-        return None
-
     def get_created_direct_url_path(self, pkg: str) -> Path | None:
         dist_info_prefix = canonicalize_name(pkg).replace("-", "_") + "-"
         for filename in self.files_created:
@@ -321,81 +314,50 @@ def get_created_direct_url(self, pkg: str) -> DirectUrl | None:
     def assert_installed(
         self,
         pkg_name: str,
+        *,
+        dist_name: str | None = None,
         editable: bool = True,
+        editable_vcs: bool = True,
         with_files: list[str] | None = None,
         without_files: list[str] | None = None,
-        without_egg_link: bool = False,
-        use_user_site: bool = False,
         sub_dir: str | None = None,
     ) -> None:
+        if dist_name is None:
+            dist_name = pkg_name
         with_files = with_files or []
         without_files = without_files or []
         e = self.test_env
 
-        if editable:
+        if editable and editable_vcs:
             pkg_dir = e.venv / "src" / canonicalize_name(dist_name)
             # If package was installed in a sub directory
             if sub_dir:
                 pkg_dir = pkg_dir / sub_dir
+        elif editable and not editable_vcs:
+            pkg_dir = None
+            assert not with_files
+            assert not without_files
         else:
-            without_egg_link = True
             pkg_dir = e.site_packages / pkg_name
 
-        if use_user_site:
-            egg_link_paths = [
-                e.user_site / egg_link_name
-                for egg_link_name in _egg_link_names(pkg_name)
-            ]
-        else:
-            egg_link_paths = [
-                e.site_packages / egg_link_name
-                for egg_link_name in _egg_link_names(pkg_name)
-            ]
-
-        egg_link_path_created = self._get_egg_link_path_created(egg_link_paths)
-        if without_egg_link:
-            if egg_link_path_created:
+        direct_url = self.get_created_direct_url(dist_name)
+        if not editable:
+            if direct_url and direct_url.is_local_editable():
                 raise TestFailure(
-                    f"unexpected egg link file created: {egg_link_path_created!r}\n"
+                    "unexpected editable direct_url.json created: "
+                    f"{self.get_created_direct_url_path(dist_name)!r}\n"
                     f"{self}"
                 )
         else:
-            if not egg_link_path_created:
-                raise TestFailure(
-                    f"expected egg link file missing: {egg_link_paths!r}\n{self}"
-                )
-
-            egg_link_file = self.files_created[egg_link_path_created]
-            egg_link_contents = egg_link_file.bytes.replace(os.linesep, "\n")
-
-            # FIXME: I don't understand why there's a trailing . here
-            if not (
-                egg_link_contents.endswith("\n.")
-                and egg_link_contents[:-2].endswith(os.fspath(pkg_dir))
-            ):
-                expected_ending = f"{pkg_dir}\n."
+            if not direct_url or not direct_url.is_local_editable():
                 raise TestFailure(
-                    textwrap.dedent(
-                        f"""
-                        Incorrect egg_link file {egg_link_file!r}
-                        Expected ending: {expected_ending!r}
-                        ------- Actual contents -------
-                        {egg_link_contents!r}
-                        -------------------------------
-                        """
-                    ).strip()
+                    f"{dist_name!r} not installed as editable: direct_url.json "
+                    "not found or not editable\n"
+                    f"{self.get_created_direct_url_path(dist_name)!r}\n"
+                    f"{self}"
                 )
 
-        if use_user_site:
-            pth_file = e.user_site / "easy-install.pth"
-        else:
-            pth_file = e.site_packages / "easy-install.pth"
-
-        if (pth_file in self.files_updated) == without_egg_link:
-            maybe = "" if without_egg_link else "not "
-            raise TestFailure(f"{pth_file} unexpectedly {maybe}updated by install")
-
-        if (pkg_dir in self.files_created) == (os.curdir in without_files):
+        if pkg_dir and (pkg_dir in self.files_created) == (os.curdir in without_files):
             maybe = "not " if os.curdir in without_files else ""
             files = sorted(p.as_posix() for p in self.files_created)
             raise TestFailure(