GH-161367: Add test and buildbottest test subcommands to Platforms/WASI

Author: brettcannon

.github/workflows/reusable-wasi.yml

@@ -64,6 +64,4 @@ jobs:
     - name: "Display build info of the host/WASI Python"
       run: python3 Platforms/WASI pythoninfo-host
     - name: "Test"
-      run: |
-        CROSS_BUILD_WASI=$(python3 Platforms/WASI path)
-        make --directory "${CROSS_BUILD_WASI}" test
+      run: python3 Platforms/WASI test

Misc/NEWS.d/next/WASI/2026-11-04-16-34-48.gh-issue-161367.bO5MGy.rst

@@ -0,0 +1,2 @@
+Add ``test`` and ``buildbottest`` commands to :file:`Platforms/WASI` for CI
+and Buildbot use, respectively.

Platforms/WASI/README.md

@@ -199,7 +199,36 @@ python3 Platforms/WASI clean
 
 ### Testing
 
-To find out where the WASI build directory is, you can run:
+After building, you can run the CI tests with:
+
+```shell
+python3 Platforms/WASI test
+```
+
+This runs `make test` in the WASI build directory.
+
+After running `gather` or `package`, you can run the buildbot tests against the
+distribution with:
+
+```shell
+python3 Platforms/WASI buildbottest
+```
+
+This uses `make buildbottest` appropriately with the binary for releasing.
+
+To test the contents of the release archive instead of the gathered files, use:
+
+```shell
+python3 Platforms/WASI buildbottest --unpack
+```
+
+This requires an archive created by `package` or `release`. It deletes the
+selected versioned distribution directory inside `dist/`, then restores it
+from the matching `.tar.xz` archive before running `make buildbottest`.
+The archive and other distributions in `dist/` are left untouched.
+
+You can also tests more directly. To find out where the WASI build directory
+is, you can run:
 
 ```shell
 python3 Platforms/WASI path

Platforms/WASI/__main__.py

@@ -5,6 +5,7 @@
     "_build",
     "_package",
     "_shared",
+    "_test",
 ]
 
 import argparse
@@ -14,6 +15,7 @@
 import _build
 import _package
 import _shared
+import _test
 
 
 def main():
@@ -76,6 +78,15 @@ def main():
     release = subcommands.add_parser(
         "release", help="Build and package for a release"
     )
+    test = subcommands.add_parser("test", help="Run the CI tests")
+    buildbottest = subcommands.add_parser(
+        "buildbottest", help="Run the buildbot tests against the distribution"
+    )
+    buildbottest.add_argument(
+        "--unpack",
+        action="store_true",
+        help="Replace the distribution directory with the release archive's contents",
+    )
     path = subcommands.add_parser(
         "path", help="Print the path to a build or distribution directory"
     )
@@ -100,6 +111,8 @@ def main():
         pythoninfo_host,
         build_host,
         release,
+        test,
+        buildbottest,
     ):
         subcommand.add_argument(
             "--quiet",
@@ -129,6 +142,13 @@ def main():
             dest="clean",
             help="Delete any relevant directories before building",
         )
+    for subcommand in build, configure_build, configure_host:
+        subcommand.add_argument(
+            "--release",
+            help="Configure build for release mode",
+            action="store_true",
+            default=False,
+        )
     for subcommand in (
         build,
         configure_build,
@@ -137,7 +157,7 @@ def main():
         build_host,
     ):
         subcommand.add_argument(
-            "args", nargs="*", help="Extra arguments to pass to `configure`"
+            "_args", nargs="*", help="Extra arguments to pass to `configure`"
         )
     for subcommand in build, configure_host, build_host, release:
         subcommand.add_argument(
@@ -167,6 +187,8 @@ def main():
         package,
         path,
         release,
+        test,
+        buildbottest,
     ):
         subcommand.add_argument(
             "--host-triple",
@@ -219,14 +241,18 @@ def main():
             _package.gather(context)
             _package.archive(context)
         case "release":
-            context.args = ["--without-static-libpython"]
+            context.release = True
             _build.clean_contents(context)
             _build.configure_build_python(context)
             _build.make_build_python(context)
             _build.configure_wasi_python(context)
             _build.make_wasi_python(context)
             _package.gather(context)
             _package.archive(context)
+        case "test":
+            _test.test(context)
+        case "buildbottest":
+            _test.buildbottest(context)
         case "path":
             paths = {
                 "build-python": "build_python_path",

Platforms/WASI/_build.py

@@ -144,8 +144,7 @@ def call(command, *, context=None, quiet=False, **kwargs):
 def configure_build_python(context, working_dir):
     """Configure the build/host Python."""
     configure = [os.path.relpath(context.checkout / "configure", working_dir)]
-    if context.args:
-        configure.extend(context.args)
+    configure.extend(context.configure_args)
 
     call(configure, context=context)
 
@@ -247,8 +246,7 @@ def configure_wasi_python(context, working_dir):
     ]
     if context.is_debug:
         configure.append("--with-pydebug")
-    if context.args:
-        configure.extend(context.args)
+    configure.extend(context.configure_args)
     call(
         configure,
         env=updated_env(env_additions | wasi_sdk_env(context)),

Platforms/WASI/_package.py

@@ -26,32 +26,18 @@ def wasmtime_script(context):
 
 script_dir=$(CDPATH= cd "$(dirname "$0")" && pwd -P)
 root=$(CDPATH= cd "$script_dir/.." && pwd -P)
-wasm_file="$root/lib/python{python_version(context)}/lib-wasm/python{python_version(context, debug_ok=True)}.wasm"
+wasm_file="$root/lib/python{context.python_version()}/lib-wasm/python{context.python_version(debug_ok=True)}.wasm"
 
 exec wasmtime run \\
     --argv0 "$wasm_file" \\
-    --config "$root/etc/python{python_version(context)}/wasmtime.toml" \\
+    --config "$root/etc/python{context.python_version()}/wasmtime.toml" \\
     --dir "/" \\
     "$wasm_file" "$@"
 """
 
 
-def python_version(context, debug_ok=False):
-    """Calculate the M.N part of Python's version.
-
-    If *debug_ok* is True, then "d" is appended as appropriate.
-    """
-    details = context.wasi_build_details
-    major = details["language"]["version_info"]["major"]
-    minor = details["language"]["version_info"]["minor"]
-    version = f"{major}.{minor}"
-    if debug_ok and context.is_debug:
-        version += "d"
-    return version
-
-
 def lib_python(context):
-    return pathlib.PurePath("lib") / f"python{python_version(context)}"
+    return pathlib.PurePath("lib") / f"python{context.python_version()}"
 
 
 def license_file(context):
@@ -101,12 +87,12 @@ def pkgconfig_files(context):
     pkgconfig = pathlib.PurePath("lib") / "pkgconfig"
     return [
         (
-            pkgconfig / f"python-{python_version(context, debug_ok=True)}.pc",
+            pkgconfig / f"python-{context.python_version(debug_ok=True)}.pc",
             misc_dir / "python.pc",
         ),
         (
             pkgconfig
-            / f"python-{python_version(context, debug_ok=True)}-embed.pc",
+            / f"python-{context.python_version(debug_ok=True)}-embed.pc",
             misc_dir / "python-embed.pc",
         ),
     ]
@@ -127,11 +113,11 @@ def pkgconfig_symlinks(pkgconfig_files, context):
         paths += [
             (
                 embed_path.parent
-                / f"python-{python_version(context)}-embed.pc",
+                / f"python-{context.python_version()}-embed.pc",
                 embed_path,
             ),
             (
-                plain_path.parent / f"python-{python_version(context)}.pc",
+                plain_path.parent / f"python-{context.python_version()}.pc",
                 plain_path,
             ),
         ]
@@ -143,7 +129,7 @@ def pyconfig_file(context):
     """Have <build>/pyconfig.h end up in include/pythonXYd?/pyconfig.h."""
     return (
         pathlib.PurePath("include")
-        / f"python{python_version(context, debug_ok=True)}"
+        / f"python{context.python_version(debug_ok=True)}"
         / "pyconfig.h",
         context.wasi_build_path / "pyconfig.h",
     )
@@ -158,7 +144,7 @@ def header_files(context):
             file_path = pathlib.Path(root) / filename
             details = (
                 pathlib.PurePath("include")
-                / f"python{python_version(context, debug_ok=True)}"
+                / f"python{context.python_version(debug_ok=True)}"
                 / file_path.relative_to(include_dir),
                 file_path,
             )
@@ -171,7 +157,7 @@ def man_file(context):
     man_dir = pathlib.PurePath("share", "man", "man1")
     man_file = context.checkout / "Misc" / "python.man"
     return (
-        man_dir / f"python{python_version(context)}.1",
+        man_dir / f"python{context.python_version()}.1",
         man_file,
     )
 
@@ -187,7 +173,7 @@ def wasmtime_config_file(context):
     config = context.checkout / "Platforms" / "WASI" / "wasmtime.toml"
     return (
         pathlib.PurePath("etc")
-        / f"python{python_version(context)}"
+        / f"python{context.python_version()}"
         / "wasmtime.toml",
         config,
     )
@@ -198,17 +184,15 @@ def wasm_file(context):
     return (
         lib_python(context)
         / "lib-wasm"
-        / f"python{python_version(context, debug_ok=True)}.wasm",
+        / f"python{context.python_version(debug_ok=True)}.wasm",
         context.wasi_build_path / "python.wasm",
     )
 
 
-def python_wasmtime_script(base, context):
+def python_wasmtime_script(context):
     """Create bin/pythonN.Md?.wasmtime."""
     script = wasmtime_script(context)
-    path = (
-        base / f"bin/python{python_version(context, debug_ok=True)}.wasmtime"
-    )
+    path = context.dist_python_interpreter
     path.parent.mkdir(parents=True, exist_ok=True)
     with open(path, "w") as f:
         f.write(script)
@@ -221,15 +205,15 @@ def python_wasmtime_symlink(path, context):
     """Symlink bin/pythonN.Md?.wasmtime.
 
     - bin/pythonN.M.wasmtime (if debug build)
-    - bin/pythonN.wasmtime (if debug build)
+    - bin/pythonN.wasmtime
     """
     symlinks = [
         path.parent / f"python{context.wasi_build_version['major']}.wasmtime"
     ]
     if context.is_debug:
         # The file already has the debug name, so the missing symlink is the non-debug name.
         symlinks.append(
-            path.parent / f"python{python_version(context)}.wasmtime"
+            path.parent / f"python{context.python_version()}.wasmtime"
         )
 
     return [(symlink, path) for symlink in symlinks]
@@ -239,7 +223,7 @@ def config_file(context):
     """Have Misc/config.sh end up at bin/pythonN.Md?.config."""
     return (
         pathlib.PurePath("bin")
-        / f"python{python_version(context, debug_ok=True)}-config",
+        / f"python{context.python_version(debug_ok=True)}-config",
         context.wasi_build_path / "Misc" / "python-config.sh",
     )
 
@@ -258,7 +242,7 @@ def config_symlink(config_path, context):
     if context.is_debug:
         # The file already has the debug name, so the missing symlink is the non-debug name.
         symlinks.append(
-            config_path.parent / f"python{python_version(context)}-config"
+            config_path.parent / f"python{context.python_version()}-config"
         )
 
     return [(symlink, config_path) for symlink in symlinks]
@@ -281,8 +265,8 @@ def symlink_files(files, base):
 
 
 def gather(context):
-    py_version = python_version(context)
-    py_d_version = python_version(context, debug_ok=True)
+    py_version = context.python_version()
+    py_d_version = context.python_version(debug_ok=True)
 
     dist = context.dist_path
     if dist.exists():
@@ -300,7 +284,7 @@ def gather(context):
     symlink_files(config_symlink(config_location[0], context), base)
 
     _shared.log("📄", f"python{py_d_version}.wasmtime", spacing=indent * 3)
-    script_path = python_wasmtime_script(base, context)
+    script_path = python_wasmtime_script(context)
     symlink_files(python_wasmtime_symlink(script_path, context), base)
 
     _shared.log("📁", "etc/", spacing=indent * 2)
@@ -353,8 +337,7 @@ def gather(context):
 
 
 def archive(context):
-    file_name = f"{context.archive_stem}.tar.xz"
-    file_path = context.dist_path / file_name
+    file_path = context.archive_path
     if file_path.exists():
         _shared.log("🧹", f"Deleting {file_path} ...")
         file_path.unlink()

Platforms/WASI/_shared.py

@@ -178,6 +178,13 @@ def wasi_sdk_path(self):
 
         return wasi_sdk_path
 
+    @functools.cached_property
+    def configure_args(self):
+        args = getattr(self, "_args", [])
+        if self.release:
+            args.extend(["--without-static-libpython"])
+        return args
+
     @functools.cached_property
     def log_path(self):
         if self._log_path is not None:
@@ -206,6 +213,27 @@ def archive_stem(self):
     def archive_dir(self):
         return self.dist_path / self.archive_stem
 
+    @functools.cached_property
+    def archive_path(self):
+        return self.dist_path / f"{self.archive_stem}.tar.xz"
+
+    @functools.cached_property
+    def dist_python_interpreter(self):
+        version = self.python_version(debug_ok=True)
+        return self.archive_dir / "bin" / f"python{version}.wasmtime"
+
+    def python_version(self, debug_ok=False):
+        """Calculate the M.N part of Python's version.
+
+        If *debug_ok* is True, then "d" is appended as appropriate.
+        """
+        major = self.wasi_build_version["major"]
+        minor = self.wasi_build_version["minor"]
+        version = f"{major}.{minor}"
+        if debug_ok and "d" in self.wasi_build_details["abi"]["flags"]:
+            version += "d"
+        return version
+
 
 def log(emoji, message, *, spacing=None):
     """Print a notification with an emoji.