use the override module naming convention for unpacked source directories

Standardize the naming of unpacked source
distributions to make the name predictable.

Author: dhellmann

e2e/test_bootstrap_extras.sh

@@ -41,8 +41,8 @@ $OUTDIR/work-dir/setuptools-*/build.log
 
 $OUTDIR/wheels-repo/downloads/PySocks-*.whl
 $OUTDIR/sdists-repo/downloads/PySocks-*.tar.gz
-$OUTDIR/sdists-repo/builds/PySocks-*.tar.gz
-$OUTDIR/work-dir/PySocks-*/build.log
+$OUTDIR/sdists-repo/builds/pysocks-*.tar.gz
+$OUTDIR/work-dir/pysocks-*/build.log
 "
 
 for pattern in $EXPECTED_FILES; do

src/fromager/sources.py

@@ -213,21 +213,28 @@ def _takes_arg(f: typing.Callable, arg_name: str) -> bool:
 
 def unpack_source(
     ctx: context.WorkContext,
+    req: Requirement,
+    version: Version,
     source_filename: pathlib.Path,
 ) -> tuple[pathlib.Path, bool]:
-    sdist_root_name = _sdist_root_name(source_filename)
-    unpack_dir = ctx.work_dir / sdist_root_name
+    # sdist names are less standardized and the names of the directories they
+    # contain are also not very standard. Force the names into a predictable
+    # form based on the override module name for the requirement.
+    req_name = overrides.pkgname_to_override_module(req.name)
+    expected_name = f"{req_name}-{version}"
+
+    # The unpack_dir is a parent dir where we put temporary outputs during the
+    # build process, including the unpacked source in a subdirectory.
+    unpack_dir = ctx.work_dir / expected_name
     if unpack_dir.exists():
         if ctx.cleanup:
             logger.debug("cleaning up %s", unpack_dir)
             shutil.rmtree(unpack_dir)
         else:
             logger.info("reusing %s", unpack_dir)
             return (unpack_dir / unpack_dir.name, False)
-    # We create a unique directory based on the sdist name, but that
-    # may not be the same name as the root directory of the content in
-    # the sdist (due to case, punctuation, etc.), so after we unpack
-    # it look for what was created.
+
+    # sdists might be tarballs or zip files.
     logger.debug("unpacking %s to %s", source_filename, unpack_dir)
     if str(source_filename).endswith(".tar.gz"):
         with tarfile.open(source_filename, "r") as t:
@@ -242,18 +249,26 @@ def unpack_source(
     else:
         raise ValueError(f"Do not know how to unpack source archive {source_filename}")
 
-    # if tarball named foo-2.3.1.tar.gz was downloaded, then ensure that after unpacking, the source directory's path is foo-2.3.1/foo-2.3.1
+    # We create a unique directory based on the requirement name, but that may
+    # not be the same name as the root directory of the content in the sdist
+    # (due to case, punctuation, etc.), so after we unpack it look for what was
+    # created and ensure the extracted directory matches the override module
+    # name and version of the requirement.
     unpacked_root_dir = next(iter(unpack_dir.glob("*")))
-    new_unpacked_root_dir = unpacked_root_dir.parent / sdist_root_name
-    if unpacked_root_dir.name != new_unpacked_root_dir.name:
+    if unpacked_root_dir.name != expected_name:
+        desired_name = unpacked_root_dir.parent / expected_name
         try:
-            shutil.move(str(unpacked_root_dir), str(new_unpacked_root_dir))
+            shutil.move(
+                str(unpacked_root_dir),
+                str(desired_name),
+            )
         except Exception as err:
             raise Exception(
-                f"Could not rename {unpacked_root_dir.name} to {new_unpacked_root_dir.name}: {err}"
+                f"Could not rename {unpacked_root_dir.name} to {desired_name}: {err}"
             ) from err
+        unpacked_root_dir = desired_name
 
-    return (new_unpacked_root_dir, True)
+    return (unpacked_root_dir, True)
 
 
 def patch_source(
@@ -366,7 +381,12 @@ def default_prepare_source(
     source_filename: pathlib.Path,
     version: Version,
 ) -> tuple[pathlib.Path, bool]:
-    source_root_dir, is_new = unpack_source(ctx, source_filename)
+    source_root_dir, is_new = unpack_source(
+        ctx=ctx,
+        req=req,
+        version=version,
+        source_filename=source_filename,
+    )
     if is_new:
         prepare_new_source(
             ctx=ctx,