Merge pull request #580 from dhellmann/bootstrap-hook

add hook entry point for bootstrap

Author: mergify[bot]

.github/workflows/test.yaml

@@ -97,6 +97,7 @@ jobs:
           - migrate_graph
           - override
           - pep517_build_sdist
+          - post_bootstrap_hook
           - prebuilt_wheels_alt_server
           - report_missing_dependency
           - rust_vendor

.mergify.yml

@@ -26,6 +26,7 @@ pull_request_rules:
   - name: Automatic merge on approval
     conditions:
       - and:
+          - "-draft"
           - check-success=e2e (3.11, 1.75, bootstrap, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, bootstrap_build_tags, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, bootstrap_cache, ubuntu-latest)
@@ -49,6 +50,7 @@ pull_request_rules:
           - check-success=e2e (3.11, 1.75, optimize_build, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, override, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, pep517_build_sdist, ubuntu-latest)
+          - check-success=e2e (3.11, 1.75, post_bootstrap_hook, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, prebuilt_wheel_hook, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, prebuilt_wheels_alt_server, ubuntu-latest)
           - check-success=e2e (3.11, 1.75, report_missing_dependency, ubuntu-latest)
@@ -99,6 +101,8 @@ pull_request_rules:
           - check-success=e2e (3.12, 1.75, override, ubuntu-latest)
           - check-success=e2e (3.12, 1.75, pep517_build_sdist, macos-latest)
           - check-success=e2e (3.12, 1.75, pep517_build_sdist, ubuntu-latest)
+          - check-success=e2e (3.12, 1.75, post_bootstrap_hook, macos-latest)
+          - check-success=e2e (3.12, 1.75, post_bootstrap_hook, ubuntu-latest)
           - check-success=e2e (3.12, 1.75, prebuilt_wheel_hook, macos-latest)
           - check-success=e2e (3.12, 1.75, prebuilt_wheel_hook, ubuntu-latest)
           - check-success=e2e (3.12, 1.75, prebuilt_wheels_alt_server, macos-latest)
@@ -107,7 +111,6 @@ pull_request_rules:
           - check-success=e2e (3.12, 1.75, report_missing_dependency, ubuntu-latest)
           - check-success=e2e (3.12, 1.75, rust_vendor, macos-latest)
           - check-success=e2e (3.12, 1.75, rust_vendor, ubuntu-latest)
-          - "-draft"
 
           # At least 1 reviewer
           - "#approved-reviews-by>=1"

docs/customization.md

@@ -336,3 +336,40 @@ def prebuilt_wheel(
         f"{req.name}: running prebuilt wheel hook for {wheel_filename}"
     )
 ```
+
+### post_bootstrap
+
+The `post_bootstrap` hook runs after a package is bootstrapped, before its
+installation dependencies are bootstrapped. It can be used to perform validation
+checks for the sdist and wheel that results from the bootstrap operation.
+
+Configure a `post_bootstrap` hook in your `pyproject.toml` like this:
+
+```toml
+[project.entry-points."fromager.hooks"]
+post_bootstrap = "package_plugins.module:function"
+```
+
+The input arguments to the `post_bootstrap` hook are the `WorkContext`,
+`Requirement` being built, the distribution name and version, and the sdist and
+wheel filenames.
+
+NOTE: The files should not be renamed or moved.
+
+NOTE: The `sdist_filename` argument can be None if the wheel is pre-built and
+the `wheel_filename` argument can be None if bootstrapping is running in
+sdist-only mode.
+
+```python
+def post_bootstrap(
+    ctx: context.WorkContext,
+    req: Requirement,
+    dist_name: str,
+    dist_version: str,
+    sdist_filename: pathlib.Path | None,
+    wheel_filename: pathlib.Path | None,
+):
+    logger.info(
+        f"{req.name}: running post bootstrap hook for {sdist_filename} and {wheel_filename}"
+    )
+```

e2e/fromager_hooks/pyproject.toml

@@ -4,9 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flit-core-overrides"
-authors = [
-    {name = "Doug Hellmann", email="dhellmann@redhat.com"},
-]
+authors = [{ name = "Doug Hellmann", email = "dhellmann@redhat.com" }]
 description = "test package"
 dynamic = ["version"]
 classifiers = [
@@ -31,3 +29,4 @@ dependencies = []
 [project.entry-points."fromager.hooks"]
 post_build = "package_plugins.hooks:after_build_wheel"
 prebuilt_wheel = "package_plugins.hooks:after_prebuilt_wheel"
+post_bootstrap = "package_plugins.hooks:after_bootstrap"

e2e/fromager_hooks/src/package_plugins/hooks.py

@@ -24,6 +24,22 @@ def after_build_wheel(
     test_file.write_text(f"{dist_name}=={dist_version}")
 
 
+def after_bootstrap(
+    ctx: context.WorkContext,
+    req: Requirement,
+    dist_name: str,
+    dist_version: str,
+    sdist_filename: pathlib.Path | None,
+    wheel_filename: pathlib.Path | None,
+):
+    logger.info(
+        f"{req.name}: running post bootstrap hook in {__name__} for {sdist_filename} and {wheel_filename}"
+    )
+    test_file = ctx.work_dir / "test-output-file.txt"
+    logger.info(f"{req.name}: post-bootstrap hook writing to {test_file}")
+    test_file.write_text(f"{dist_name}=={dist_version}")
+
+
 def after_prebuilt_wheel(
     ctx: context.WorkContext,
     req: Requirement,
@@ -34,6 +50,6 @@ def after_prebuilt_wheel(
     logger.info(
         f"{req.name}: running post build hook in {__name__} for {wheel_filename}"
     )
-    test_file =  ctx.work_dir / "test-prebuilt.txt"
+    test_file = ctx.work_dir / "test-prebuilt.txt"
     logger.info(f"{req.name}: prebuilt-wheel hook writing to {test_file}")
     test_file.write_text(f"{dist_name}=={dist_version}")

e2e/test_post_bootstrap_hook.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+# -*- indent-tabs-mode: nil; tab-width: 2; sh-indentation: 2; -*-
+
+# Test post-bootstrap hook
+
+SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+source "$SCRIPTDIR/common.sh"
+
+# What are we building?
+DIST="setuptools"
+VERSION="75.8.0"
+
+# Install hook for test
+pip install e2e/fromager_hooks
+
+# Bootstrap the project
+fromager \
+  --debug \
+    --sdists-repo="$OUTDIR/sdists-repo" \
+    --wheels-repo="$OUTDIR/wheels-repo" \
+    --work-dir="$OUTDIR/work-dir" \
+    --settings-dir="$SCRIPTDIR/prebuilt_settings" \
+    bootstrap "${DIST}==${VERSION}"
+
+
+
+EXPECTED_FILES="
+work-dir/test-output-file.txt
+"
+
+pass=true
+for f in $EXPECTED_FILES; do
+  if [ ! -f "$OUTDIR/$f" ]; then
+    echo "FAIL: Did not find $OUTDIR/$f" 1>&2
+    pass=false
+  fi
+done
+
+cat $OUTDIR/work-dir/test-output-file.txt
+
+if $pass; then
+  if ! grep -q "${DIST}==${VERSION}" $OUTDIR/work-dir/test-output-file.txt; then
+    echo "FAIL: Did not find content in post-bootstrap hook output file" 1>&2
+    pass=false
+  fi
+fi
+
+$pass

src/fromager/bootstrapper.py

@@ -17,6 +17,7 @@
     build_environment,
     dependencies,
     finders,
+    hooks,
     progress,
     resolver,
     server,
@@ -116,6 +117,7 @@ def bootstrap(self, req: Requirement, req_type: RequirementType) -> Version:
         build_env: build_environment.BuildEnvironment | None = None
         sdist_root_dir: pathlib.Path | None = None
         wheel_filename: pathlib.Path | None = None
+        sdist_filename: pathlib.Path | None = None
 
         if pbi.pre_built:
             wheel_filename, unpack_dir = self._download_prebuilt(
@@ -172,7 +174,7 @@ def bootstrap(self, req: Requirement, req_type: RequirementType) -> Version:
                     f"{req.name}=={resolved_version} ({req_type})"
                 )
                 wheel_filename = None
-                build_env = self._build_sdist(
+                sdist_filename, build_env = self._build_sdist(
                     req, resolved_version, sdist_root_dir, build_dependencies
                 )
             else:
@@ -181,10 +183,19 @@ def bootstrap(self, req: Requirement, req_type: RequirementType) -> Version:
                     f"{req.name}: building wheel {req.name}=={resolved_version} "
                     f"to get install requirements ({req_type})"
                 )
-                wheel_filename, build_env = self._build_wheel(
+                wheel_filename, sdist_filename, build_env = self._build_wheel(
                     req, resolved_version, sdist_root_dir, build_dependencies
                 )
 
+        hooks.run_post_bootstrap_hooks(
+            ctx=self.ctx,
+            req=req,
+            dist_name=canonicalize_name(req.name),
+            dist_version=str(resolved_version),
+            sdist_filename=sdist_filename,
+            wheel_filename=wheel_filename,
+        )
+
         if build_sdist_only:
             if typing.TYPE_CHECKING:
                 assert build_env is not None
@@ -251,7 +262,7 @@ def _build_sdist(
         resolved_version: Version,
         sdist_root_dir: pathlib.Path,
         build_dependencies: set[Requirement],
-    ) -> build_environment.BuildEnvironment:
+    ) -> tuple[pathlib.Path, build_environment.BuildEnvironment]:
         build_env = build_environment.BuildEnvironment(
             self.ctx,
             sdist_root_dir.parent,
@@ -262,29 +273,30 @@ def _build_sdist(
                 self.ctx, self.ctx.sdists_builds, req, str(resolved_version)
             )
             if not find_sdist_result:
-                sources.build_sdist(
+                sdist_filename = sources.build_sdist(
                     ctx=self.ctx,
                     req=req,
                     version=resolved_version,
                     sdist_root_dir=sdist_root_dir,
                     build_env=build_env,
                 )
             else:
+                sdist_filename = find_sdist_result
                 logger.info(
                     f"{req.name} have sdist version {resolved_version}: {find_sdist_result}"
                 )
         except Exception as err:
             logger.warning(f"{req.name}: failed to build source distribution: {err}")
-        return build_env
+        return (sdist_filename, build_env)
 
     def _build_wheel(
         self,
         req: Requirement,
         resolved_version: Version,
         sdist_root_dir: pathlib.Path,
         build_dependencies: set[Requirement],
-    ) -> tuple[pathlib.Path, build_environment.BuildEnvironment]:
-        build_env = self._build_sdist(
+    ) -> tuple[pathlib.Path, pathlib.Path, build_environment.BuildEnvironment]:
+        sdist_filename, build_env = self._build_sdist(
             req, resolved_version, sdist_root_dir, build_dependencies
         )
 
@@ -303,7 +315,7 @@ def _build_wheel(
         logger.info(
             f"{req.name}: built wheel for version {resolved_version}: {wheel_filename}"
         )
-        return wheel_filename, build_env
+        return wheel_filename, sdist_filename, build_env
 
     def _prepare_build_dependencies(
         self, req: Requirement, sdist_root_dir: pathlib.Path

src/fromager/hooks.py

@@ -61,6 +61,32 @@ def run_post_build_hooks(
         )
 
 
+def run_post_bootstrap_hooks(
+    ctx: context.WorkContext,
+    req: Requirement,
+    dist_name: str,
+    dist_version: str,
+    sdist_filename: pathlib.Path | None,
+    wheel_filename: pathlib.Path | None,
+) -> None:
+    hook_mgr = _get_hooks("post_bootstrap")
+    if hook_mgr.names():
+        logger.info(
+            f"{req.name}: starting post-bootstrap hooks for sdist {sdist_filename} and wheel {wheel_filename}"
+        )
+    for ext in hook_mgr:
+        # NOTE: Each hook is responsible for doing its own logging for
+        # start/stop because we don't have a good name to use here.
+        ext.plugin(
+            ctx=ctx,
+            req=req,
+            dist_name=dist_name,
+            dist_version=dist_version,
+            sdist_filename=sdist_filename,
+            wheel_filename=wheel_filename,
+        )
+
+
 def run_prebuilt_wheel_hooks(
     ctx: context.WorkContext,
     req: Requirement,