From b83cf06cc60b3f3f6492cce103df33542c85fd40 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Thu, 5 Nov 2026 13:50:25 -0800 Subject: [PATCH] feat(tools): test-partition says which packages are tested where, and fails when the classification and the workspace disagree --- tools/test-partition | 123 ++++++++++++++++++++++++++++++++++++++ tools/test-partition.json | 46 ++++++++++++++ tools/test-partition.test | 64 ++++++++++++++++++++ 3 files changed, 233 insertions(+) create mode 100755 tools/test-partition create mode 100644 tools/test-partition.json create mode 100755 tools/test-partition.test diff --git a/tools/test-partition b/tools/test-partition new file mode 100755 index 00000000..b44739eb --- /dev/null +++ b/tools/test-partition @@ -0,0 +1,123 @@ +#!/usr/bin/env bash +# Which packages of the workspace are tested where: see tools/README.md and docs/dev/build-and-test.md. +# +# tools/test-partition check fail when the classification and the workspace disagree +# tools/test-partition packages print `-p a -p b` for cargo +# tools/test-partition expr print a nextest filterset: `package(a) | package(b)` +# tools/test-partition expr recorder-macos +# the filterset of the recorder tests that run on macOS +# tools/test-partition --self-test run `check` against the tree and against deliberately broken copies +# +# The classification is tools/test-partition.json (class -> package names); it is the single source of truth +# for the CI jobs, the justfile and the Nix check sets (nix/windows). It needs only bash, cargo and jq. +# +# Environment (for the self-test): TEST_PARTITION_JSON overrides the classification file, and +# TEST_PARTITION_METADATA is a file with the output of `cargo metadata --format-version 1 --no-deps`. +set -euo pipefail + +root=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd) +json=${TEST_PARTITION_JSON:-$root/tools/test-partition.json} + +classes="neutral os_sensitive windows linux macos mixed tool none" + +# the crates a `neutral` package must not depend on, directly +platform_crates='["komorebi-windows","komorebi-macos","komorebi-linux"]' + +# the tests of the recorder that run on macOS, by their module path: the macOS flavoured sources, which +# the recorder's other tests (the platform-neutral ones) share a binary with +recorder_macos_filter='package(komorebi-recorder) & test(/^(sources::oslog|av|capture::sck|platform|power|system_state)::/)' + +die() { + echo "test-partition: $*" >&2 + exit 1 +} + +metadata() { + if [ -n "${TEST_PARTITION_METADATA:-}" ]; then + cat "$TEST_PARTITION_METADATA" + else + (cd "$root" && cargo metadata --format-version 1 --no-deps) + fi +} + +valid_class() { + case " $classes " in + *" $1 "*) return 0 ;; + *) return 1 ;; + esac +} + +check() { + local meta problems + meta=$(metadata) + problems=$( + jq -r --argjson platform "$platform_crates" --slurpfile part "$json" --arg classes "$classes" ' + ($part[0]) as $p + | [ .packages[] ] as $pkgs + | ($classes | split(" ")) as $known + | ( + # classes the file has that are not part of the contract + ($p | keys[] | select(. as $k | $known | index($k) | not) + | "unknown class \(.)"), + # a member in no class, or in two + ($pkgs[].name as $n + | [ $known[] as $c | select(($p[$c] // []) | index($n)) | $c ] as $in + | if ($in | length) == 0 then "\($n): in no class" + elif ($in | length) > 1 then "\($n): in two classes (\($in | join(", ")))" + else empty end), + # a name that is no member (stale), or listed twice in one class + ($known[] as $c | ($p[$c] // [])[] as $n + | select(($pkgs | map(.name) | index($n)) == null) + | "\($n) (\($c)): not a member of the workspace"), + ($known[] as $c | ($p[$c] // []) | group_by(.)[] | select(length > 1) + | "\(.[0]): listed twice in \($c)"), + # a neutral package that is not neutral + ($pkgs[] | select(.name as $n | ($p.neutral // []) | index($n)) + | .name as $n + | (.dependencies[] + | select(.target != null) + | "\($n): neutral, but depends on \(.name) only for \(.target)"), + (.dependencies[] | select(.name as $d | $platform | index($d)) + | "\($n): neutral, but depends on the platform crate \(.name)") + ) + ) + ' <<<"$meta" + ) + if [ -n "$problems" ]; then + echo "$problems" >&2 + echo "test-partition: tools/test-partition.json does not match the workspace" >&2 + return 1 + fi +} + +members_of() { + jq -r --arg c "$1" '.[$c] // [] | .[]' "$json" +} + +cmd=${1:-} +case "$cmd" in + check) + check + ;; + packages) + class=${2:-} + valid_class "$class" || die "unknown class '$class' (one of: $classes)" + members_of "$class" | sed 's/^/-p /' | paste -sd' ' - + ;; + expr) + class=${2:-} + if [ "$class" = recorder-macos ]; then + echo "$recorder_macos_filter" + exit 0 + fi + valid_class "$class" || die "unknown class '$class' (one of: $classes)" + members_of "$class" | sed 's/.*/package(&)/' | paste -sd'|' - | sed 's/|/ | /g' + ;; + --self-test) + exec "$root/tools/test-partition.test" "$root/tools/test-partition" + ;; + *) + sed -n '2,9p' "$0" | sed 's/^# \{0,1\}//' >&2 + exit 2 + ;; +esac diff --git a/tools/test-partition.json b/tools/test-partition.json new file mode 100644 index 00000000..2798e147 --- /dev/null +++ b/tools/test-partition.json @@ -0,0 +1,46 @@ +{ + "neutral": [ + "komorebi-backend", + "komorebi-bar-core", + "komorebi-collections", + "komorebi-core", + "komorebi-layouts", + "komorebi-scrolling", + "komorebi-settings", + "komorebi-themes", + "komorebi-version" + ], + "os_sensitive": [ + "komorebi-config", + "komorebi-protocol", + "komorebi-transport", + "komorebic-core" + ], + "windows": [ + "komorebi-windows" + ], + "linux": [ + "komorebi", + "komorebi-hotkeys", + "komorebi-linux", + "komorebic" + ], + "macos": [ + "komorebi-macos" + ], + "mixed": [ + "komorebi-bar", + "komorebi-client", + "komorebi-recorder" + ], + "tool": [ + "komorebi-e2e-agent", + "komorebi-testwin", + "schemars-nixgen" + ], + "none": [ + "komorebi-gui", + "komorebi-shortcuts", + "komorebic-no-console" + ] +} diff --git a/tools/test-partition.test b/tools/test-partition.test new file mode 100755 index 00000000..c47fb646 --- /dev/null +++ b/tools/test-partition.test @@ -0,0 +1,64 @@ +#!/usr/bin/env bash +# The self-test of tools/test-partition (`tools/test-partition --self-test`): `check` must pass on the tree and must +# fail, for the stated reason, on deliberately broken copies of the classification. +set -euo pipefail + +tool=${1:-$(dirname "${BASH_SOURCE[0]}")/test-partition} +root=$(cd "$(dirname "$tool")/.." && pwd) +work=$(mktemp -d) +trap 'rm -rf "$work"' EXIT + +# (a metadata file in TEST_PARTITION_METADATA is used instead of running cargo) +if [ -z "${TEST_PARTITION_METADATA:-}" ]; then + (cd "$root" && cargo metadata --format-version 1 --no-deps) >"$work/metadata.json" + export TEST_PARTITION_METADATA=$work/metadata.json +fi +good=$root/tools/test-partition.json +failures=0 + +# expect_fail +expect_fail() { + local name=$1 filter=$2 needle=$3 out + jq "$filter" "$good" >"$work/broken.json" + if out=$(TEST_PARTITION_JSON=$work/broken.json "$tool" check 2>&1); then + echo "FAIL $name: check passed on a broken classification" + failures=$((failures + 1)) + elif ! grep -qF -- "$needle" <<<"$out"; then + echo "FAIL $name: check failed, but not with '$needle':" + echo "$out" + failures=$((failures + 1)) + else + echo "ok $name" + fi +} + +if "$tool" check; then + echo "ok the current tree" +else + echo "FAIL the current tree" + failures=$((failures + 1)) +fi + +expect_fail "a member in no class" '.none -= ["komorebi-gui"]' "komorebi-gui: in no class" +expect_fail "a member in two classes" '.none += ["komorebi-windows"]' "komorebi-windows: in two classes" +expect_fail "a package that is no member" '.none += ["not-a-crate"]' "not-a-crate (none): not a member" +expect_fail "a package listed twice" '.none += ["komorebi-gui"]' "komorebi-gui: listed twice" +expect_fail "an unknown class" '. + {"fast": []}' "unknown class fast" +expect_fail "a neutral package with target-specific dependencies" \ + '.os_sensitive -= ["komorebi-transport"] | .neutral += ["komorebi-transport"]' \ + "komorebi-transport: neutral, but depends on uds_windows only for" +expect_fail "a neutral package that depends on a platform crate" \ + '.mixed -= ["komorebi-client"] | .neutral += ["komorebi-client"]' \ + "komorebi-client: neutral, but depends on" + +# the output formats the CI jobs rely on +[ "$("$tool" packages windows)" = "-p komorebi-windows" ] || { echo "FAIL packages windows"; failures=$((failures + 1)); } +[ "$("$tool" expr windows)" = "package(komorebi-windows)" ] || { echo "FAIL expr windows"; failures=$((failures + 1)); } +[ "$("$tool" expr macos)" = "package(komorebi-macos)" ] || { echo "FAIL expr macos"; failures=$((failures + 1)); } +"$tool" packages nonsense >/dev/null 2>&1 && { echo "FAIL an unknown class was accepted"; failures=$((failures + 1)); } + +if [ "$failures" -ne 0 ]; then + echo "$failures failure(s)" + exit 1 +fi +echo "all passed"