From 616e75a82d7a8979773f732ab61c71bea7f17363 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Tue, 20 Oct 2026 16:34:40 +0200 Subject: [PATCH] ci: remove superseded standalone macOS build --- README.md | 8 +-- docs/macos.md | 125 +++++++++++------------------------- docs/releases.md | 8 +-- scripts/build-macos.sh | 49 -------------- scripts/test-macos-build.py | 93 --------------------------- 5 files changed, 45 insertions(+), 238 deletions(-) delete mode 100755 scripts/build-macos.sh delete mode 100644 scripts/test-macos-build.py diff --git a/README.md b/README.md index 1169e03..890f455 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,10 @@ From the repository root: cargo run --release ``` -For Apple Silicon and Intel macOS binaries built from Linux, run -`./scripts/build-macos.sh`; see [macOS build requirements and validation](docs/macos.md). -The [release workflow](docs/releases.md) packages both macOS architectures -alongside Linux and Windows. +For Apple Silicon and Intel macOS binaries built from Linux, use the +[release workflow](docs/releases.md): `./release.sh --compile-only` packages +both macOS architectures alongside Linux and Windows. See +[macOS requirements and validation](docs/macos.md). Use `cargo run --release -- --live` to confirm the usual connection and scan settings, then display repeated complete sweeps until stopped. Number keys select diff --git a/docs/macos.md b/docs/macos.md index d65ec16..60c622b 100644 --- a/docs/macos.md +++ b/docs/macos.md @@ -1,106 +1,55 @@ # Building macOS binaries from Linux -The [release workflow](releases.md) now builds and packages both Apple targets -alongside Linux and Windows with `./release.sh --compile-only`. Use that workflow -for release artifacts; it validates Mach-O files and includes them in checksums -and cargo-binstall archives before publication. - -For a standalone diagnostic build, run from a Linux checkout with a working -Podman or Docker installation: +Use the [release workflow](releases.md) with a working Podman or Docker backend +and a publisher supporting automated Apple builds: ```console -./scripts/build-macos.sh +./release.sh --compile-only ``` -The script prefers Podman when available. Select Docker explicitly with -`CONTAINER_ENGINE=docker ./scripts/build-macos.sh`. It works from another -directory too, using the checkout containing the script. Network access is -needed for the initial container and crate downloads. No Mac, Xcode installation -on the host, interactive container session, or publication token is required. +This builds and packages Apple Silicon and Intel macOS alongside Linux and +Windows. To build only the Apple targets: -## Toolchain and dependencies +```console +./release.sh --compile-only --target aarch64-apple-darwin --target x86_64-apple-darwin +``` -The script pins the upstream -[cargo-zigbuild container](https://github.com/rust-cross/cargo-zigbuild) -by SHA-256 manifest digest. The inspected image contains Rust 1.93.0, -cargo-zigbuild 0.23.4, Zig 0.16.0, both Apple Rust targets, and the macOS 11.3 SDK -at `/opt/MacOSX11.3.sdk` (`SDKROOT`). See the upstream -[Dockerfile](https://github.com/rust-cross/cargo-zigbuild/blob/main/Dockerfile) -for SDK provenance and image construction; the digest in the script, rather -than the moving upstream branch, identifies our actual build environment. +Select the backend with `CROSS_CONTAINER_ENGINE=podman` or `docker`. Network +access is needed for initial container and crate downloads. No Mac, host Xcode +installation or publication token is required. The standalone Apple build +wrapper has been removed; the publisher owns compilation and packaging. + +## Toolchain and outputs + +[`rust-release.toml`](../rust-release.toml) declares the immutable cargo-zigbuild +image digest, SDK path and **macOS 13.0** deployment minimum for both Apple +architectures. See the [release contract and prerequisites](releases.md) for +tool installation, artifact naming and the compiler/SDK policy. The upstream +[cargo-zigbuild Dockerfile](https://github.com/rust-cross/cargo-zigbuild/blob/main/Dockerfile) +documents SDK provenance; our configured digest identifies the actual image. The SDK supplies IOKit and CoreFoundation for the existing `serialport` -dependency. No additional Cargo dependency or Homebrew package was necessary. -Linux's libudev and Windows's resource compiler are not needed for Apple -targets. The normal default features include both the terminal UI and serial -transport; these builds do not disable serial support to avoid linking it. +dependency. The normal default features include terminal UI and serial transport. +Linux's libudev and Windows's resource compiler are not needed for Apple targets. -The declared deployment minimum is **macOS 13.0**, for both architectures. -During verification, requesting 11.0 still produced a 13.0 Mach-O minimum -with this toolchain. The script therefore explicitly requests 13.0. Supporting -older systems requires a separately verified toolchain and runtime testing; -the SDK directory's version is not the executable's deployment minimum. - -The image pin fixes the compiler/SDK inputs, and `--locked` preserves the -dependency graph. This is not a claim of bit-for-bit reproducibility. -Container updates should rerun the checks below and inspect deployment -versions and dynamic dependencies before changing the pin. - -## Outputs - -Both release binaries are produced in one invocation: - -| Architecture | Executable | -| --- | --- | -| Apple Silicon | `target/apple/aarch64-apple-darwin/release/tiny-wb` | -| Intel | `target/apple/x86_64-apple-darwin/release/tiny-wb` | - -These are separate Mach-O executables, not a universal binary or `.app` bundle. -Cargo downloads, compilation outputs, and Zig caches live under ignored -`target/apple/`. Generated files belong to the invoking user. The container -mounts the checkout to compile it; use a checkout without concurrent builds -writing into the same Apple target directory. - -The diagnostic script only compiles and does not package or upload these -outputs. The publisher builds its own Apple artifacts in publisher-owned output -directories. Neither workflow supplies a Developer ID signature or notarization. +The publisher prints its output directory under ignored `dist/release-*/`. +Each Apple target produces a standalone executable and a cargo-binstall `.tgz` +archive, covered by the common `SHA256SUMS`. These are separate Mach-O binaries; +there is no universal binary, `.app` bundle, Developer ID signature or notarization. ## Verification -Wrapper regression tests run without containers or network access: +Run the normal [local quality gates](security-and-ci.md#local-verification), +`python3 scripts/test-release.py`, and the compile-only command above. +The publisher checks Apple architecture, `LC_BUILD_VERSION` minimum of 13.0, +system dynamic dependencies, archive layout and checksums. Inspect the printed +output directory and run `sha256sum -c SHA256SUMS` from that directory. +Linux cannot execute the Apple binaries, so their runtime checks are skipped. -```console -sh -n scripts/build-macos.sh -python3 scripts/test-macos-build.py -``` - -Run the normal [local quality gates](security-and-ci.md#local-verification) -and the real build script. On Linux with LLVM tools installed, inspect: - -```console -file target/apple/*-apple-darwin/release/tiny-wb -llvm-objdump --macho --dylibs-used target/apple/aarch64-apple-darwin/release/tiny-wb -llvm-objdump --macho --private-headers target/apple/aarch64-apple-darwin/release/tiny-wb -llvm-objdump --macho --dylibs-used target/apple/x86_64-apple-darwin/release/tiny-wb -llvm-objdump --macho --private-headers target/apple/x86_64-apple-darwin/release/tiny-wb -``` - -Check the architecture, `LC_BUILD_VERSION` minimum of 13.0, and that loaded -libraries are Apple system paths rather than container/build-machine paths. - -Observed on **2026-10-20**: both default-feature release binaries cross-compiled -on Linux using rootless Podman. Their dynamic dependencies were IOKit, -CoreFoundation, libSystem, libobjc, libiconv, and libcharset, all under -`/System/Library/Frameworks/` or `/usr/lib/`. A separate -`cargo zigbuild --locked --release --all-targets --all-features` invocation -with both Apple targets also compiled and linked the tests and examples. -The native Linux formatting, MSRV, feature-matrix checks/tests, Rustdoc, -Clippy, and release build passed. Docker execution is covered only by wrapper -argument tests, not a real Docker build. - -Execution on macOS, terminal interaction, serial enumeration, actual USB -acquisition, Gatekeeper behavior, Jenkins execution, and publication remain -unverified. Cross-compiling tests does not run them on macOS. +The [recorded four-target verification](releases.md#macos-migration-verification-on-2026-10-20) +used rootless Podman and passed these checks for both Apple architectures. +Docker execution, native macOS terminal interaction, serial enumeration, actual +USB acquisition, Gatekeeper behavior, Jenkins and publication remain unverified. On a Mac, first run `./tiny-wb --help`, then use the [mock-device workflow](mock-device.md) for simulated acquisition and the diff --git a/docs/releases.md b/docs/releases.md index 0b10466..5fe88d7 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -2,8 +2,8 @@ The release matrix includes Linux, Windows, Apple Silicon and Intel macOS. Apple builds require a Linux release host and macOS 13.0 or newer to run. -See [macOS cross-compilation](macos.md) for native validation and the optional -diagnostic build script. +See [macOS cross-compilation](macos.md) for platform requirements and native +validation. `release.sh` delegates to the deliberately named [`rust_realease`](https://proxy.dandaedre.com/gitea/idle-org/rust_realease). @@ -93,8 +93,8 @@ intentionally replaced so releases use the reviewed, tracked configuration. The Apple image digest, deployment minimum and SDK path are explicit in `[build.apple]`. `CROSS_CONTAINER_ENGINE` selects the engine for both backends; -Apple builds ignore `CROSS_CONFIG`. No separate `build-macos.sh` invocation is -needed. The publisher checks Mach-O architecture, deployment minimum and system +Apple builds ignore `CROSS_CONFIG`. All targets use the same release entry point. +The publisher checks Mach-O architecture, deployment minimum and system library paths, then packages the binaries into the same release as Cross outputs. The four-target matrix produces eight payload assets plus `SHA256SUMS`. Apple executables are unsigned and unnotarized; there is no universal binary or diff --git a/scripts/build-macos.sh b/scripts/build-macos.sh deleted file mode 100755 index 78edfc9..0000000 --- a/scripts/build-macos.sh +++ /dev/null @@ -1,49 +0,0 @@ -#!/bin/sh -# Compile-only Apple builds. See docs/macos.md for prerequisites and validation. -set -eu - -if [ "$#" -ne 0 ]; then - echo "usage: $0 (set CONTAINER_ENGINE=podman or docker)" >&2 - exit 2 -fi - -engine=${CONTAINER_ENGINE:-} -if [ -z "$engine" ]; then - if command -v podman >/dev/null 2>&1; then - engine=podman - else - engine=docker - fi -fi -case "$engine" in - podman|docker) ;; - *) echo "CONTAINER_ENGINE must be podman or docker" >&2; exit 2 ;; -esac -command -v "$engine" >/dev/null 2>&1 || { - echo "Install Podman or Docker before building macOS binaries." >&2 - exit 1 -} - -repository_dir=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd -P) -# Pin the complete compiler/SDK environment, not the mutable latest tag. -image=ghcr.io/rust-cross/cargo-zigbuild@sha256:9b4f6b3eb9e8f9fefb3960fe288ddba576627d66d9eff851ce7f62d2455564a5 -mkdir -p "$repository_dir/target/apple" - -# Keep generated files owned by the invoking user on both container engines. -set -- run --rm --user "$(id -u):$(id -g)" -if [ "$engine" = podman ]; then - set -- "$@" --userns=keep-id -fi -"$engine" "$@" \ - -v "$repository_dir:/io" -w /io \ - -e HOME=/tmp \ - -e CARGO_HOME=/io/target/apple/cargo-home \ - -e CARGO_TARGET_DIR=/io/target/apple \ - -e ZIG_GLOBAL_CACHE_DIR=/io/target/apple/zig-cache \ - -e MACOSX_DEPLOYMENT_TARGET=13.0 \ - "$image" \ - cargo zigbuild --locked --release --bin tiny-wb \ - --target aarch64-apple-darwin --target x86_64-apple-darwin - -echo "Apple Silicon: $repository_dir/target/apple/aarch64-apple-darwin/release/tiny-wb" -echo "Intel: $repository_dir/target/apple/x86_64-apple-darwin/release/tiny-wb" diff --git a/scripts/test-macos-build.py b/scripts/test-macos-build.py deleted file mode 100644 index f7d2ddf..0000000 --- a/scripts/test-macos-build.py +++ /dev/null @@ -1,93 +0,0 @@ -#!/usr/bin/env python3 -"""Check the macOS wrapper without downloading images or starting containers.""" - -import json -import os -from pathlib import Path -import shutil -import subprocess -import tempfile -import unittest - - -SOURCE = Path(__file__).resolve().parent / "build-macos.sh" - - -class MacOSBuildTests(unittest.TestCase): - def setUp(self): - self.temp = tempfile.TemporaryDirectory() - self.addCleanup(self.temp.cleanup) - self.root = Path(self.temp.name) - self.repo = self.root / "checkout with spaces" - (self.repo / "scripts").mkdir(parents=True) - self.script = self.repo / "scripts" / SOURCE.name - shutil.copy2(SOURCE, self.script) - self.record = self.root / "arguments.json" - self.bin = self.root / "bin" - self.bin.mkdir() - for engine in ("podman", "docker"): - stub = self.bin / engine - stub.write_text( - "#!/usr/bin/env python3\n" - "import json, os, sys\n" - "with open(os.environ['ARGUMENT_RECORD'], 'w') as stream:\n" - " json.dump(sys.argv[1:], stream)\n" - "sys.exit(int(os.environ.get('ENGINE_STATUS', '0')))\n" - ) - stub.chmod(0o755) - self.env = { - **os.environ, - "PATH": f"{self.bin}:{os.environ['PATH']}", - "ARGUMENT_RECORD": str(self.record), - "CONTAINER_ENGINE": "podman", - } - - def run_script(self, *args): - return subprocess.run( - ["sh", str(self.script), *args], - cwd=self.root, - env=self.env, - text=True, - capture_output=True, - ) - - def test_build_from_elsewhere_with_spaces_and_pinned_environment(self): - result = self.run_script() - self.assertEqual(result.returncode, 0, result.stderr) - args = json.loads(self.record.read_text()) - self.assertIn(f"{self.repo}:/io", args) - self.assertIn("--userns=keep-id", args) - self.assertIn(f"{os.getuid()}:{os.getgid()}", args) - self.assertIn("MACOSX_DEPLOYMENT_TARGET=13.0", args) - image = next(arg for arg in args if arg.startswith("ghcr.io/")) - self.assertRegex(image, r"@sha256:[0-9a-f]{64}$") - self.assertIn("--locked", args) - self.assertIn("aarch64-apple-darwin", args) - self.assertIn("x86_64-apple-darwin", args) - self.assertTrue((self.repo / "target/apple").is_dir()) - - def test_docker_uses_caller_without_podman_namespace_option(self): - self.env["CONTAINER_ENGINE"] = "docker" - self.assertEqual(self.run_script().returncode, 0) - args = json.loads(self.record.read_text()) - self.assertIn("--user", args) - self.assertNotIn("--userns=keep-id", args) - - def test_failed_build_does_not_report_success(self): - self.env["ENGINE_STATUS"] = "42" - result = self.run_script() - self.assertEqual(result.returncode, 42) - self.assertNotIn("Apple Silicon:", result.stdout) - - def test_invalid_engine_is_rejected_before_invocation(self): - self.env["CONTAINER_ENGINE"] = "docker --privileged" - self.assertEqual(self.run_script().returncode, 2) - self.assertFalse(self.record.exists()) - - def test_arguments_are_rejected_before_invocation(self): - self.assertEqual(self.run_script("--publish").returncode, 2) - self.assertFalse(self.record.exists()) - - -if __name__ == "__main__": - unittest.main()