Update tests that were looking for egg-link files to detect editables

Author: sbidoul

tests/functional/test_install.py

@@ -16,6 +16,7 @@
 import pytest
 
 from pip._internal.cli.status_codes import ERROR, SUCCESS
+from pip._internal.models.direct_url import DirectUrl
 from pip._internal.models.index import PyPI, TestPyPI
 from pip._internal.utils.misc import rmtree
 from pip._internal.utils.urls import path_to_url
@@ -478,8 +479,7 @@ def test_install_editable_uninstalls_existing_from_path(
         "-e",
         to_install,
     )
-    install_path = script.site_packages / "simplewheel.egg-link"
-    result.did_create(install_path)
+    result.assert_installed("simplewheel", editable=True)
     assert "Found existing installation: simplewheel 1.0" in result.stdout
     assert "Uninstalling simplewheel-" in result.stdout
     assert "Successfully uninstalled simplewheel" in result.stdout
@@ -575,7 +575,6 @@ def test_basic_install_relative_directory(
     Test installing a requirement using a relative path.
     """
     dist_info_folder = script.site_packages / "fspkg-0.1.dev0.dist-info"
-    egg_link_file = script.site_packages / "FSPkg.egg-link"
     package_folder = script.site_packages / "fspkg"
 
     # Compute relative install path to FSPkg from scratch path.
@@ -599,7 +598,9 @@ def test_basic_install_relative_directory(
     else:
         # Editable install.
         result = script.pip("install", "-e", req_path, cwd=script.scratch_path)
-        result.did_create(egg_link_file)
+        direct_url = result.get_created_direct_url("fspkg")
+        assert direct_url
+        assert direct_url.is_local_editable()
 
 
 def test_install_quiet(script: PipTestEnvironment, data: TestData) -> None:
@@ -1374,7 +1375,9 @@ def _test_install_editable_with_prefix(
     result = script.pip("install", "--editable", pkga_path, "--prefix", prefix_path)
 
     # assert pkga is installed at correct location
-    install_path = script.scratch / site_packages / "pkga.egg-link"
+    install_path = (
+        script.scratch / site_packages / "pkga-0.1.dist-info" / "direct_url.json"
+    )
     result.did_create(install_path)
 
     return result
@@ -1400,7 +1403,11 @@ def test_install_editable_with_target(script: PipTestEnvironment) -> None:
     target.mkdir()
     result = script.pip("install", "--editable", pkg_path, "--target", target)
 
-    result.did_create(script.scratch / "target" / "pkg.egg-link")
+    direct_url_path = result.get_created_direct_url_path("pkg")
+    assert direct_url_path
+    assert direct_url_path.parent.parent == target
+    direct_url = DirectUrl.from_json(direct_url_path.read_text())
+    assert direct_url.is_local_editable()
     result.did_create(script.scratch / "target" / "watching_testrunner.py")
 
 

tests/functional/test_install_reqs.py

@@ -217,7 +217,6 @@ def test_relative_requirements_file(
 
     """
     dist_info_folder = script.site_packages / "fspkg-0.1.dev0.dist-info"
-    egg_link_file = script.site_packages / "FSPkg.egg-link"
     package_folder = script.site_packages / "fspkg"
 
     # Compute relative install path to FSPkg from scratch path.
@@ -249,7 +248,9 @@ def test_relative_requirements_file(
             result = script.pip(
                 "install", "-vvv", "-r", reqs_file.name, cwd=script.scratch_path
             )
-            result.did_create(egg_link_file)
+            direct_url = result.get_created_direct_url("fspkg")
+            assert direct_url
+            assert direct_url.is_local_editable()
 
 
 @pytest.mark.xfail
@@ -384,9 +385,8 @@ def test_install_local_editable_with_extras(
     res = script.pip_install_local(
         "-e", f"{to_install}[bar]", allow_stderr_warning=True
     )
-    res.did_update(script.site_packages / "easy-install.pth")
-    res.did_create(script.site_packages / "LocalExtras.egg-link")
-    res.did_create(script.site_packages / "simple")
+    res.assert_installed("LocalExtras", editable=True, editable_vcs=False)
+    res.assert_installed("simple", editable=False)
 
 
 def test_install_collected_dependencies_first(script: PipTestEnvironment) -> None:

tests/functional/test_new_resolver.py

@@ -5,7 +5,6 @@
 from typing import TYPE_CHECKING, Callable, Protocol
 
 import pytest
-from packaging.utils import canonicalize_name
 
 from tests.conftest import ScriptFactory
 from tests.lib import (
@@ -20,20 +19,6 @@
 MakeFakeWheel = Callable[[str, str, str], pathlib.Path]
 
 
-def assert_editable(script: PipTestEnvironment, *args: str) -> None:
-    # This simply checks whether all of the listed packages have a
-    # corresponding .egg-link file installed.
-    # TODO: Implement a more rigorous way to test for editable installations.
-    egg_links = {f"{canonicalize_name(arg)}.egg-link" for arg in args}
-    actual_egg_links = {
-        f"{canonicalize_name(p.stem)}.egg-link"
-        for p in script.site_packages_path.glob("*.egg-link")
-    }
-    assert (
-        egg_links <= actual_egg_links
-    ), f"{args!r} not all found in {script.site_packages_path!r}"
-
-
 @pytest.fixture
 def make_fake_wheel(script: PipTestEnvironment) -> MakeFakeWheel:
     def _make_fake_wheel(name: str, version: str, wheel_tag: str) -> pathlib.Path:
@@ -339,7 +324,7 @@ def test_new_resolver_installs_editable(script: PipTestEnvironment) -> None:
         source_dir,
     )
     script.assert_installed(base="0.1.0", dep="0.1.0")
-    assert_editable(script, "dep")
+    script.assert_installed_editable("dep")
 
 
 @pytest.mark.parametrize(
@@ -1871,7 +1856,7 @@ def test_new_resolver_succeeds_on_matching_constraint_and_requirement(
 
     script.assert_installed(test_pkg="0.1.0")
     if editable:
-        assert_editable(script, "test_pkg")
+        script.assert_installed_editable("test_pkg")
 
 
 def test_new_resolver_applies_url_constraint_to_dep(script: PipTestEnvironment) -> None:

tests/lib/__init__.py

@@ -738,6 +738,17 @@ def assert_not_installed(self, *args: str) -> None:
         expected = {canonicalize_name(k) for k in args}
         assert not (expected & installed), f"{expected!r} contained in {installed!r}"
 
+    def assert_installed_editable(self, dist_name: str) -> None:
+        dist_name = canonicalize_name(dist_name)
+        ret = self.pip("list", "--format=json")
+        installed = json.loads(ret.stdout)
+        assert any(
+            x
+            for x in installed
+            if canonicalize_name(x["name"]) == dist_name
+            and x.get("editable_project_location")
+        )
+
 
 # FIXME ScriptTest does something similar, but only within a single
 # ProcResult; this generalizes it so states can be compared across