Fix setuptools_wheel fixture (pypa#4308)

Author: abravalheri

newsfragments/4308.misc.rst

@@ -0,0 +1,2 @@
+Fix ``setuptools_wheel`` fixture and avoid the recursive creation of
+``build/lib/build/lib/build/...`` directories in the project root during tests.

setuptools/tests/fixtures.py

@@ -63,30 +63,46 @@ def sample_project(tmp_path):
 # sdist and wheel artifacts should be stable across a round of tests
 # so we can build them once per session and use the files as "readonly"
 
+# In the case of setuptools, building the wheel without sdist may cause
+# it to contain the `build` directory, and therefore create situations with
+# `setuptools/build/lib/build/lib/...`. To avoid that, build both artifacts at once.
 
-@pytest.fixture(scope="session")
-def setuptools_sdist(tmp_path_factory, request):
-    prebuilt = os.getenv("PRE_BUILT_SETUPTOOLS_SDIST")
-    if prebuilt and os.path.exists(prebuilt):  # pragma: no cover
-        return Path(prebuilt).resolve()
 
+def _build_distributions(tmp_path_factory, request):
     with contexts.session_locked_tmp_dir(
-        request, tmp_path_factory, "sdist_build"
+        request, tmp_path_factory, "dist_build"
     ) as tmp:  # pragma: no cover
-        dist = next(tmp.glob("*.tar.gz"), None)
-        if dist:
-            return dist
+        sdist = next(tmp.glob("*.tar.gz"), None)
+        wheel = next(tmp.glob("*.whl"), None)
+        if sdist and wheel:
+            return (sdist, wheel)
+
+        # Sanity check: should not create recursive setuptools/build/lib/build/lib/...
+        assert not Path(request.config.rootdir, "build/lib/build").exists()
 
         subprocess.check_output([
             sys.executable,
             "-m",
             "build",
-            "--sdist",
             "--outdir",
             str(tmp),
             str(request.config.rootdir),
         ])
-        return next(tmp.glob("*.tar.gz"))
+
+        # Sanity check: should not create recursive setuptools/build/lib/build/lib/...
+        assert not Path(request.config.rootdir, "build/lib/build").exists()
+
+        return next(tmp.glob("*.tar.gz")), next(tmp.glob("*.whl"))
+
+
+@pytest.fixture(scope="session")
+def setuptools_sdist(tmp_path_factory, request):
+    prebuilt = os.getenv("PRE_BUILT_SETUPTOOLS_SDIST")
+    if prebuilt and os.path.exists(prebuilt):  # pragma: no cover
+        return Path(prebuilt).resolve()
+
+    sdist, _ = _build_distributions(tmp_path_factory, request)
+    return sdist
 
 
 @pytest.fixture(scope="session")
@@ -95,23 +111,8 @@ def setuptools_wheel(tmp_path_factory, request):
     if prebuilt and os.path.exists(prebuilt):  # pragma: no cover
         return Path(prebuilt).resolve()
 
-    with contexts.session_locked_tmp_dir(
-        request, tmp_path_factory, "wheel_build"
-    ) as tmp:  # pragma: no cover
-        dist = next(tmp.glob("*.whl"), None)
-        if dist:
-            return dist
-
-        subprocess.check_output([
-            sys.executable,
-            "-m",
-            "build",
-            "--wheel",
-            "--outdir",
-            str(tmp),
-            str(request.config.rootdir),
-        ])
-        return next(tmp.glob("*.whl"))
+    _, wheel = _build_distributions(tmp_path_factory, request)
+    return wheel
 
 
 @pytest.fixture