Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d4a1db7243 | ||
|
|
18acc31a28 | ||
|
|
d780fe007a | ||
|
|
f18bad36f3 | ||
|
|
d7ae81dce9 | ||
|
|
10c93a3246 | ||
|
|
50ff6c60ce | ||
|
|
cfe1f5be3b | ||
|
|
22e9106606 | ||
|
|
c6b67c3b86 | ||
|
|
77aacef528 | ||
|
|
9bab162d64 | ||
|
|
d0bbed568c | ||
|
|
41142e707a | ||
|
|
7f106e2deb | ||
|
|
5cdce25329 | ||
|
|
01dd9ca287 | ||
|
|
cb4c56679d | ||
|
|
d0ecaea174 | ||
|
|
a77cd3a682 | ||
|
|
c3efda87c3 | ||
|
|
afbaac0c0e | ||
|
|
c287aaaf58 | ||
|
|
6e09624120 | ||
|
|
1edc446940 | ||
|
|
f86f34bd90 | ||
|
|
ff0724f96a | ||
|
|
41d2bd6d91 | ||
|
|
8a75ee40bc | ||
|
|
75be20163d | ||
|
|
0013dd45c2 | ||
|
|
a3ee239900 | ||
|
|
5fc08e408e | ||
|
|
5098be30d1 | ||
|
|
1323dc1571 | ||
|
|
848a78ed5f | ||
|
|
8d092ae417 | ||
|
|
7445b05e57 | ||
|
|
faae4ee145 | ||
|
|
942801ee4b | ||
|
|
8de1bdffd4 | ||
|
|
77237023e3 | ||
|
|
fc573f075a | ||
|
|
1c364d4ff1 | ||
|
|
d54bd6473f | ||
|
|
a5b07d22ae | ||
|
|
3d17326460 | ||
|
|
56339a5eca | ||
|
|
00bb760451 | ||
|
|
5f472435a7 | ||
|
|
f22fe19a4d | ||
|
|
8ab83edc73 | ||
|
|
601da0548b | ||
|
|
4592b927ad | ||
|
|
5e347315e2 | ||
|
|
603c49a395 | ||
|
|
bc8e0535d1 | ||
|
|
cf1eaebae1 | ||
|
|
f89f220f3e | ||
|
|
c18a37eebc | ||
|
|
d3a06d682f | ||
|
|
4d530721dc | ||
|
|
0b691ca943 | ||
|
|
ed0f781851 |
@@ -0,0 +1,33 @@
|
||||
name: public-benchmark-pages
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: [build-test-release]
|
||||
types: [completed]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-public-benchmark-pages
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: alkane-pages
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install SSH client
|
||||
run: bash ci/ensure-build-deps.sh ssh
|
||||
- name: Render measured benchmark history
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py render
|
||||
- name: Publish public benchmark page
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
BENCH_PAGES_DEPLOY_KEY: ${{ secrets.BENCH_PAGES_DEPLOY_KEY }}
|
||||
run: python3 ci/publish-bench-pages.py toolkit
|
||||
- name: Clean generated page
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -0,0 +1,21 @@
|
||||
name: completed-ci-badge
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: [build-test-release, next-build]
|
||||
types: [completed]
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: alkane-fast
|
||||
container:
|
||||
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
permissions:
|
||||
actions: read
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Publish last completed attempt
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/last-attempt-badge.py
|
||||
@@ -0,0 +1,81 @@
|
||||
name: next-build
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [next]
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-next
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
candidate:
|
||||
runs-on: alkane-ci
|
||||
container:
|
||||
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
CARGO_BUILD_JOBS: 2
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Check runner image pins
|
||||
run: python3 ci/check-runner-image.py
|
||||
- name: Install build dependencies
|
||||
run: bash ci/ensure-build-deps.sh base
|
||||
- name: Configure bounded Rust compiler cache
|
||||
run: bash ci/configure-rust-cache.sh
|
||||
- name: Compute wxWidgets cache key
|
||||
id: wx-key
|
||||
run: bash ci/wx-cache-key.sh
|
||||
- name: Check prebuilt wxWidgets
|
||||
id: wx-image
|
||||
run: bash ci/check-wx-image-prefix.sh
|
||||
- id: wx-cache
|
||||
if: steps.wx-image.outputs.available != 'true'
|
||||
uses: actions/cache/restore@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
- name: Build wxWidgets
|
||||
id: wx-build
|
||||
run: bash ci/ensure-wx-prefix.sh
|
||||
- name: Save vendored wxWidgets build
|
||||
if: steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
|
||||
uses: actions/cache/save@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
- name: Build release candidate
|
||||
run: cargo build --release -p alkane-gui -p alkane-artifacts -p alkane-flash -p alkane-cli --offline
|
||||
- name: Select candidate version
|
||||
id: version
|
||||
run: bash ci/compute-rc-version.sh >> "$GITHUB_OUTPUT"
|
||||
- name: Package candidate
|
||||
if: steps.version.outputs.release == 'true'
|
||||
run: |
|
||||
mkdir -p dist
|
||||
cp target/release/alkane-toolkit dist/
|
||||
tar -C dist -czf "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz" alkane-toolkit
|
||||
- name: Create private prerelease
|
||||
if: steps.version.outputs.release == 'true'
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/release-rc.py "${{ steps.version.outputs.tag }}" true "dist/alkane-toolkit-${{ steps.version.outputs.version }}-linux-x86_64.tar.gz"
|
||||
- name: Rust compiler cache statistics
|
||||
if: always()
|
||||
run: |
|
||||
if [ -n "${SCCACHE_DIR:-}" ]; then
|
||||
sccache --show-stats
|
||||
fi
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -6,10 +6,22 @@ on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-main
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
actions: write
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: alkane-ci
|
||||
container:
|
||||
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
CARGO_BUILD_JOBS: 2
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
# Set once for the whole job so build/clippy/test/bench steps don't each
|
||||
# re-export it (round 18 #12).
|
||||
@@ -20,43 +32,65 @@ jobs:
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Check runner image pins
|
||||
run: python3 ci/check-runner-image.py
|
||||
|
||||
- name: Compute version
|
||||
id: ver
|
||||
run: bash ci/compute-version.sh | tee -a "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Test version logic
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: bash ci/test-compute-version.sh
|
||||
|
||||
- name: Last-attempt badge checks
|
||||
run: python3 ci/test-last-attempt-badge.py
|
||||
|
||||
- name: Benchmark history checks
|
||||
run: python3 ci/test-bench-history.py
|
||||
|
||||
- name: Benchmark suite checks
|
||||
run: python3 ci/test-bench-badge.py
|
||||
|
||||
- name: Install build dependencies
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends \
|
||||
libssl-dev pkg-config ca-certificates >/dev/null
|
||||
echo "libssl-dev + pkg-config installed (openssl-sys needs them)"
|
||||
run: bash ci/ensure-build-deps.sh all
|
||||
|
||||
- name: Configure bounded Rust compiler cache
|
||||
run: bash ci/configure-rust-cache.sh
|
||||
|
||||
- name: Compute wxWidgets cache key
|
||||
id: wx-key
|
||||
run: bash ci/wx-cache-key.sh
|
||||
|
||||
- name: Check prebuilt wxWidgets
|
||||
id: wx-image
|
||||
run: bash ci/check-wx-image-prefix.sh
|
||||
|
||||
- name: Cache vendored wxWidgets build
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
uses: actions/cache@v4
|
||||
if: steps.wx-image.outputs.available != 'true'
|
||||
id: wx-cache
|
||||
uses: actions/cache/restore@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
|
||||
- name: Build wxWidgets (once, then cached)
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
else
|
||||
echo "wx prefix restored from cache"
|
||||
fi
|
||||
id: wx-build
|
||||
run: bash ci/ensure-wx-prefix.sh
|
||||
|
||||
- name: Save vendored wxWidgets build
|
||||
if: steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
|
||||
uses: actions/cache/save@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
|
||||
- name: Clippy (our crate, warnings are errors)
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
rustup component add clippy >/dev/null 2>&1 || true
|
||||
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
|
||||
cargo clippy --workspace --exclude alkane-gui --exclude wx-rs --all-targets --offline -- -D warnings
|
||||
|
||||
- name: Set crate version to ${{ steps.ver.outputs.version }}
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
@@ -65,35 +99,36 @@ jobs:
|
||||
grep -m1 '^version' Cargo.toml
|
||||
|
||||
- name: Build release
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
cargo build --release -p alkane-gui --offline
|
||||
|
||||
- name: Unit tests
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
cargo test -p alkane-gui --offline
|
||||
set -o pipefail
|
||||
cargo test -p alkane-gui --offline 2>&1 | tee tests-gui.txt
|
||||
cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline 2>&1 | tee tests-core.txt
|
||||
cat tests-gui.txt tests-core.txt > tests-current.txt
|
||||
|
||||
- name: Load previous main benchmark measurement
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py prepare
|
||||
|
||||
- name: Microbenchmarks
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
# Capture the bench stdout for the weighted-average delta badge (round 19
|
||||
# #1) while keeping the step a hard gate: pipefail preserves cargo's exit
|
||||
# code (each bench asserts its own absolute ceiling) even through tee.
|
||||
# Require every declared benchmark before publishing history or a release.
|
||||
set -o pipefail
|
||||
cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_ \
|
||||
cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1 \
|
||||
| tee bench-current.txt
|
||||
python3 ci/bench-badge.py --current bench-current.txt \
|
||||
--baseline badges/bench-baseline.json --no-write
|
||||
|
||||
- name: Headless UI self-test
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
|
||||
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
|
||||
BIN=target/release/alkane-toolkit
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
|
||||
|
||||
- name: Dependency audit (best-effort)
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if command -v cargo-audit >/dev/null 2>&1; then
|
||||
@@ -102,77 +137,66 @@ jobs:
|
||||
echo "cargo-audit not installed on this runner; skipping"
|
||||
fi
|
||||
|
||||
# Merge coverage from the unit tests AND the headless self-test (ci/coverage.sh)
|
||||
# so the committed badge reflects real coverage, not the tests-only number a
|
||||
# plain `cargo llvm-cov` reports. Best-effort: cargo-llvm-cov is fetched as a
|
||||
# prebuilt binary because the vendored .cargo/config blocks `cargo install`,
|
||||
# and the instrumented rebuild is slow, so a failure here never blocks a
|
||||
# release. Feeds steps.cov.outputs.pct to the badge refresh below. xvfb is
|
||||
# already installed by the self-test step above.
|
||||
- name: Coverage (best-effort)
|
||||
- name: Rust compiler cache statistics
|
||||
if: always()
|
||||
run: |
|
||||
if [ -n "${SCCACHE_DIR:-}" ]; then
|
||||
sccache --show-stats
|
||||
fi
|
||||
|
||||
# Merge coverage from unit tests and the headless UI self-test. A failed
|
||||
# measurement must not publish a stale badge or create a release.
|
||||
- name: Coverage
|
||||
id: cov
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
set -euo pipefail
|
||||
rustup component add llvm-tools-preview >/dev/null 2>&1 || true
|
||||
if ! command -v cargo-llvm-cov >/dev/null 2>&1; then
|
||||
V=0.8.7
|
||||
URL="https://github.com/taiki-e/cargo-llvm-cov/releases/download/v${V}/cargo-llvm-cov-x86_64-unknown-linux-gnu.tar.gz"
|
||||
DEST="${CARGO_HOME:-$HOME/.cargo}/bin"
|
||||
mkdir -p "$DEST"
|
||||
curl -fsSL "$URL" | tar -xz -C "$DEST" && export PATH="$DEST:$PATH" \
|
||||
|| echo "cargo-llvm-cov download failed"
|
||||
fi
|
||||
if command -v cargo-llvm-cov >/dev/null 2>&1; then
|
||||
PCT=$(bash ci/coverage.sh --summary-only 2>/dev/null \
|
||||
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
|
||||
if [ -n "$PCT" ]; then
|
||||
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
|
||||
echo "line coverage (tests + self-test): ${PCT}%"
|
||||
else
|
||||
echo "coverage report produced no TOTAL line; badge left as committed"
|
||||
fi
|
||||
else
|
||||
echo "cargo-llvm-cov unavailable; coverage badge left as committed"
|
||||
fi
|
||||
[ "$(cargo llvm-cov --version)" = 'cargo-llvm-cov 0.8.7' ]
|
||||
PCT=$(bash ci/coverage.sh --summary-only \
|
||||
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
|
||||
[ -n "$PCT" ] || { echo "coverage report produced no TOTAL line" >&2; exit 1; }
|
||||
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
|
||||
echo "line coverage (tests + self-test): ${PCT}%"
|
||||
|
||||
# Refresh the committed README badges from live metrics and push any change
|
||||
# back to main. Best-effort: a locked-down runner that can't push must not
|
||||
# fail the release. A badges-only push does not bump the version (see
|
||||
# compute-version.sh), so it does not loop back into another release.
|
||||
- name: Refresh badges
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
continue-on-error: true
|
||||
env:
|
||||
TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Microbenchmark coverage
|
||||
id: benchcov
|
||||
run: |
|
||||
PASS=$(cargo test -p alkane-gui --offline 2>&1 \
|
||||
| grep -hoE '[0-9]+ passed' | grep -oE '[0-9]+' | awk '{s+=$1} END{print s+0}')
|
||||
# Update the coverage badge only when the coverage step produced a number;
|
||||
# otherwise leave the committed coverage.svg untouched.
|
||||
COV="${{ steps.cov.outputs.pct }}"
|
||||
COV_ARG=""
|
||||
[ -n "$COV" ] && COV_ARG="--coverage $COV"
|
||||
# Weighted-average microbench delta vs the previous release (round 19 #1).
|
||||
# bench-badge.py also rewrites badges/bench-baseline.json, which is
|
||||
# committed below with the SVGs (badges/* does not trip a release bump).
|
||||
BENCH_DELTA=$(python3 ci/bench-badge.py --current bench-current.txt \
|
||||
--baseline badges/bench-baseline.json 2>/dev/null || echo NEW)
|
||||
python3 ci/gen-badges.py --tests "${PASS:-0}" $COV_ARG \
|
||||
--bench-delta "${BENCH_DELTA:-NEW}" --bench "row-render + scan-parse"
|
||||
if [ -n "$(git status --porcelain badges)" ]; then
|
||||
git config user.name "alkane-ci"
|
||||
git config user.email "ci@bluefla.re"
|
||||
git add badges
|
||||
git commit -m "ci: refresh README badges [skip release]"
|
||||
API="${GITHUB_API_URL:-https://gitea.bluefla.re/api/v1}"
|
||||
HOST="${API%/api/v1}"
|
||||
git -c http.extraheader="Authorization: token ${TOKEN}" \
|
||||
push "${HOST}/${GITHUB_REPOSITORY}.git" "HEAD:main" || echo "badge push skipped"
|
||||
else
|
||||
echo "badges unchanged"
|
||||
fi
|
||||
set -euo pipefail
|
||||
command -v cargo-llvm-cov >/dev/null
|
||||
PCT=$(bash ci/bench-coverage.sh --summary-only \
|
||||
| awk '/^TOTAL/{gsub(/%/,"",$10); print $10}')
|
||||
[ -n "$PCT" ] || { echo "microbenchmark coverage unavailable" >&2; exit 1; }
|
||||
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
|
||||
echo "microbenchmark line coverage: ${PCT}%"
|
||||
|
||||
- name: Generate measured badges
|
||||
run: |
|
||||
set -euo pipefail
|
||||
PASS=$(grep -E '^test result: ' tests-current.txt \
|
||||
| grep -oE '[0-9]+ passed' | grep -oE '[0-9]+' \
|
||||
| awk '{s+=$1} END{print s+0}')
|
||||
[ "$PASS" -gt 0 ] || { echo "no passing tests counted" >&2; exit 1; }
|
||||
BENCH_DELTA=$(python3 ci/bench-badge.py --current bench-current.txt \
|
||||
--baseline badges/bench-baseline.json --no-write)
|
||||
python3 ci/gen-badges.py --tests "$PASS" \
|
||||
--coverage "${{ steps.cov.outputs.pct }}" \
|
||||
--bench-coverage "${{ steps.benchcov.outputs.pct }}" \
|
||||
--bench-delta "$BENCH_DELTA" --clippy clean
|
||||
|
||||
- name: Publish measured badges
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/publish-metrics.py
|
||||
|
||||
- name: Record private benchmark history
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/bench_history.py publish
|
||||
|
||||
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
|
||||
with:
|
||||
name: alkane-toolkit-benchmark-site-preview
|
||||
path: bench-site/index.html
|
||||
- name: Package artifact
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
id: pkg
|
||||
@@ -197,22 +221,12 @@ jobs:
|
||||
- name: Create Gitea release + upload artifact
|
||||
if: steps.ver.outputs.release == 'true'
|
||||
env:
|
||||
TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TAG="${{ steps.ver.outputs.tag }}"
|
||||
API="${GITHUB_API_URL:-https://gitea.bluefla.re/api/v1}"
|
||||
REPO="${GITHUB_REPOSITORY}"
|
||||
body="Automated ${{ steps.ver.outputs.bump }} release from ${GITHUB_SHA}."
|
||||
rel=$(curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" \
|
||||
"${API}/repos/${REPO}/releases" \
|
||||
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${GITHUB_SHA}\",\"name\":\"${TAG}\",\"body\":\"${body}\"}")
|
||||
id=$(echo "$rel" | grep -oE '"id":[0-9]+' | head -1 | cut -d: -f2)
|
||||
if [ -z "$id" ]; then echo "release create failed: $rel"; exit 1; fi
|
||||
curl -sS -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/gzip" \
|
||||
"${API}/repos/${REPO}/releases/${id}/assets?name=${{ steps.pkg.outputs.assetname }}" \
|
||||
--data-binary @"${{ steps.pkg.outputs.asset }}" | grep -oE '"browser_download_url":"[^"]+"' || true
|
||||
echo "Released ${TAG}"
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
run: python3 ci/release-rc.py "${{ steps.ver.outputs.tag }}" false "${{ steps.pkg.outputs.asset }}"
|
||||
|
||||
- name: No release needed
|
||||
if: steps.ver.outputs.release != 'true'
|
||||
run: echo "No backend/UI change since ${{ steps.ver.outputs.last_tag }} - skipping release."
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
name: source
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [next]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-source-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
check:
|
||||
runs-on: alkane-fast
|
||||
container:
|
||||
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
env:
|
||||
CARGO_BUILD_JOBS: 2
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Check runner image pins
|
||||
run: python3 ci/check-runner-image.py
|
||||
- name: Source checks
|
||||
run: cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
@@ -1,62 +1,156 @@
|
||||
name: verify
|
||||
|
||||
# Pre-merge quality gate: clippy + build + tests + microbenchmarks + the headless
|
||||
# UI self-test, plus a best-effort dependency audit. Runs on pull requests and on
|
||||
# pushes to any branch EXCEPT main (main is gated by release.yml, which repeats
|
||||
# these checks before it cuts a release -- so no work is duplicated on main).
|
||||
# Full quality gate for pull requests to main.
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches-ignore: [main]
|
||||
branches: [main]
|
||||
|
||||
concurrency:
|
||||
group: alkane-toolkit-verify-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
verify:
|
||||
runs-on: alkane-ci
|
||||
runs-on: alkane-verify
|
||||
container:
|
||||
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
env:
|
||||
CARGO_TARGET_DIR: target
|
||||
CARGO_BUILD_JOBS: 2
|
||||
WX_PREFIX: /root/.cache/wx-3.3.3-linux
|
||||
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
apt-get update -qq
|
||||
apt-get install -y -qq --no-install-recommends \
|
||||
libssl-dev pkg-config ca-certificates >/dev/null
|
||||
|
||||
- name: Cache vendored wxWidgets build
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: wx-3.3.3-${{ runner.os }}-${{ hashFiles('thirdparty/wx-rs/VERSION') }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Build wxWidgets (once, then cached)
|
||||
- name: Check runner image pins
|
||||
run: python3 ci/check-runner-image.py
|
||||
|
||||
- name: Detect changed surface
|
||||
id: surface
|
||||
run: python3 ci/pr-surface.py >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Check documentation change
|
||||
if: steps.surface.outputs.surface == 'documentation'
|
||||
run: |
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
base="$(git merge-base HEAD "origin/$GITHUB_BASE_REF")"
|
||||
git diff --check "$base" HEAD
|
||||
if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' --; then
|
||||
echo "private key material found in tracked source" >&2
|
||||
exit 1
|
||||
else
|
||||
echo "wx prefix restored from cache"
|
||||
status=$?
|
||||
[ "$status" -eq 1 ]
|
||||
|
||||
- name: Check CI change surface
|
||||
if: steps.surface.outputs.surface != 'documentation'
|
||||
run: python3 ci/test-pr-surface.py
|
||||
|
||||
- name: Check workflow-only change
|
||||
if: steps.surface.outputs.surface == 'workflow'
|
||||
run: |
|
||||
python3 - <<'PY'
|
||||
from pathlib import Path
|
||||
import yaml
|
||||
for path in Path('.gitea/workflows').glob('*.yml'):
|
||||
yaml.load(path.read_text(), Loader=yaml.BaseLoader)
|
||||
PY
|
||||
python3 ci/check-runner-image.py
|
||||
for script in ci/*.sh; do bash -n "$script"; done
|
||||
base="$(git merge-base HEAD "origin/$GITHUB_BASE_REF")"
|
||||
git diff --check "$base" HEAD
|
||||
if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' --; then
|
||||
echo "private key material found in tracked source" >&2
|
||||
exit 1
|
||||
else
|
||||
status=$?
|
||||
[ "$status" -eq 1 ]
|
||||
fi
|
||||
|
||||
- name: Install build dependencies
|
||||
if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full'
|
||||
run: bash ci/ensure-build-deps.sh base
|
||||
|
||||
- name: Configure bounded Rust compiler cache
|
||||
if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full'
|
||||
run: bash ci/configure-rust-cache.sh
|
||||
|
||||
- name: Compute wxWidgets cache key
|
||||
id: wx-key
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: bash ci/wx-cache-key.sh
|
||||
|
||||
- name: Check prebuilt wxWidgets
|
||||
id: wx-image
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: bash ci/check-wx-image-prefix.sh
|
||||
|
||||
- name: Cache vendored wxWidgets build
|
||||
if: steps.surface.outputs.surface == 'full' && steps.wx-image.outputs.available != 'true'
|
||||
id: wx-cache
|
||||
uses: actions/cache/restore@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
|
||||
- name: Build wxWidgets (once, then cached)
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
id: wx-build
|
||||
run: bash ci/ensure-wx-prefix.sh
|
||||
|
||||
- name: Save vendored wxWidgets build
|
||||
if: steps.surface.outputs.surface == 'full' && steps.wx-cache.outputs.cache-hit != 'true' && steps.wx-build.outputs.built == 'true'
|
||||
uses: actions/cache/save@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: /root/.cache/wx-3.3.3-linux
|
||||
key: ${{ steps.wx-key.outputs.key }}
|
||||
|
||||
- name: Clippy (our crate, warnings are errors)
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: |
|
||||
rustup component add clippy >/dev/null 2>&1 || true
|
||||
cargo clippy -p alkane-gui --no-deps --release --bins --offline -- -D warnings
|
||||
cargo clippy --workspace --exclude alkane-gui --exclude wx-rs --all-targets --offline -- -D warnings
|
||||
|
||||
- name: Headless crate checks
|
||||
if: steps.surface.outputs.surface == 'headless'
|
||||
env:
|
||||
PACKAGES: ${{ steps.surface.outputs.packages }}
|
||||
run: |
|
||||
rustup component add clippy >/dev/null 2>&1 || true
|
||||
args=()
|
||||
for package in $PACKAGES; do
|
||||
case "$package" in
|
||||
alkane-access|alkane-artifacts|alkane-cli|alkane-flash) args+=(-p "$package") ;;
|
||||
*) echo "unrecognized crate: $package" >&2; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
[ "${#args[@]}" -gt 0 ]
|
||||
cargo clippy "${args[@]}" --all-targets --offline -- -D warnings
|
||||
cargo test "${args[@]}" --offline
|
||||
|
||||
- name: Build
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: cargo build --release -p alkane-gui --offline
|
||||
|
||||
- name: Unit tests
|
||||
run: cargo test -p alkane-gui --offline
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: |
|
||||
cargo test -p alkane-gui --offline
|
||||
cargo test --workspace --exclude alkane-gui --exclude wx-rs --offline
|
||||
|
||||
- name: Microbenchmarks
|
||||
run: cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: cargo test -p alkane-gui -p alkane-artifacts --release --offline -- --ignored --nocapture bench_ --test-threads=1
|
||||
|
||||
- name: Headless UI self-test
|
||||
if: steps.surface.outputs.surface == 'full'
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -y -qq --no-install-recommends \
|
||||
xvfb xauth dbus-x11 fonts-dejavu-core >/dev/null
|
||||
bash ci/ensure-build-deps.sh ui
|
||||
BIN=target/release/alkane-toolkit
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
|
||||
|
||||
@@ -65,6 +159,7 @@ jobs:
|
||||
# runner must not fail the gate on it. Accepted advisories live in
|
||||
# .cargo/audit.toml.
|
||||
- name: Dependency audit (best-effort)
|
||||
if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if command -v cargo-audit >/dev/null 2>&1; then
|
||||
@@ -72,3 +167,12 @@ jobs:
|
||||
else
|
||||
echo "cargo-audit not installed on this runner; skipping"
|
||||
fi
|
||||
- name: Rust compiler cache statistics
|
||||
if: always() && (steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full')
|
||||
run: |
|
||||
if [ -n "${SCCACHE_DIR:-}" ]; then
|
||||
sccache --show-stats
|
||||
fi
|
||||
- name: Clean generated Toolkit build
|
||||
if: always()
|
||||
run: python3 ci/cleanup-generated.py
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/target
|
||||
**/target
|
||||
.claude/
|
||||
__pycache__/
|
||||
|
||||
@@ -40,12 +40,15 @@ name = "alkane-artifacts"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-core",
|
||||
"sha2",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "alkane-cli"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-artifacts",
|
||||
"alkane-core",
|
||||
]
|
||||
|
||||
@@ -69,7 +72,11 @@ dependencies = [
|
||||
name = "alkane-flash"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"alkane-artifacts",
|
||||
"alkane-core",
|
||||
"sha2",
|
||||
"tempfile",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
|
||||
@@ -1,116 +1,60 @@
|
||||
# alkane-toolkit
|
||||
# Alkane Toolkit
|
||||
|
||||
[](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
[](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
A cross-platform desktop toolkit for discovering, monitoring, and re-flashing
|
||||
ASIC miners. It scans a fleet over the network, shows live health and hashrate
|
||||
in a sortable table, and installs **stock** or **alkaneOS** firmware onto a
|
||||
control board whatever it currently runs (stock, VNish/AnthillOS, Braiins OS+,
|
||||
LuxOS, ePIC, HiveOn, BixBit, WardenOS).
|
||||
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through
|
||||
a patched [wx-rs bridge](thirdparty/wx-rs). Firmware installation is under
|
||||
development.
|
||||
|
||||
The core and UI are pure Rust; the native window is wxWidgets driven through a
|
||||
vendored, patched [wx-rs](thirdparty/wx-rs) bridge, so there is no Electron,
|
||||
no web view, and a single self-contained binary per platform.
|
||||
|
||||
## What it does
|
||||
|
||||
- **Discover** a fleet by CIDR or IP range and identify each miner's make,
|
||||
model, control board, and firmware (via a vendored [asic-rs](vendor/asic-rs)).
|
||||
- **Monitor** hashrate vs. expected, per-board health, chip temperatures, fans,
|
||||
PSU state, and pool workers, with an Excel-style filter and drag-reorderable
|
||||
columns.
|
||||
- **Operate** miners from a right-click menu: flash the locate light, pause /
|
||||
resume, restart, set a power or hashrate target, select a firmware profile
|
||||
(LuxOS/VNish presets), configure pools, set the timezone, and change the
|
||||
password -- each action offered only when every selected miner supports it.
|
||||
- **Install firmware**: push stock or aftermarket images, or revert an
|
||||
aftermarket miner to stock, behind a typed confirmation.
|
||||
|
||||
Discovery and telemetry are read-only and safe to run against any fleet; every
|
||||
mutating action is capability-gated and, where destructive, confirmed.
|
||||
|
||||
## Build and run (Debian/Ubuntu)
|
||||
## Run locally
|
||||
|
||||
```sh
|
||||
scripts/build-wx-linux.sh # once: builds the vendored wxWidgets 3.3.3 into ~/.cache
|
||||
scripts/build-gui-linux.sh # cargo build --release -p alkane-gui
|
||||
~/.cache/alkane-tk-target/release/alkane-toolkit
|
||||
scripts/build-wx-linux.sh
|
||||
scripts/build-gui-linux.sh
|
||||
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit
|
||||
```
|
||||
|
||||
Runtime needs GTK 3: `sudo apt install libgtk-3-0`. To explore the UI with no
|
||||
hardware, run the offline demo fleet:
|
||||
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan
|
||||
uses offline fixtures and does not contact hardware. For Windows and macOS,
|
||||
use the matching `scripts/build-gui-*.sh` script.
|
||||
|
||||
```sh
|
||||
ALKANE_FAKE_SCAN=1 alkane-toolkit
|
||||
```
|
||||
## Current scope
|
||||
|
||||
Windows and macOS share all GUI code; only the C++ bridge and wx build differ
|
||||
(`scripts/build-gui-windows.sh` needs an msys2 toolchain, `-macos.sh` needs a
|
||||
Mac).
|
||||
- Discover miners by CIDR or IP range with vendored [asic-rs](vendor/asic-rs).
|
||||
- Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
|
||||
- Filter and sort the desktop table; inspect probes with `miner_probe`.
|
||||
|
||||
## Command-line probe
|
||||
|
||||
`miner_probe` is a headless companion for hardware checks that should not go
|
||||
through the window event loop -- discovery, telemetry, and each write action:
|
||||
|
||||
```sh
|
||||
miner_probe scan 10.0.0.0/24 # discover + telemetry (TSV)
|
||||
miner_probe presets 10.0.0.5 # list a firmware's selectable profiles
|
||||
miner_probe setpreset 10.0.0.5 540MHz
|
||||
```
|
||||
|
||||
Run `miner_probe` with no arguments for the full verb list.
|
||||
Discovery is read-only. The installer and operator actions remain in the
|
||||
[implementation plan](docs/IMPLEMENTATION-PLAN.md) and
|
||||
[firmware matrix](docs/aftermarket-parity-roadmap.md).
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
export WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config"
|
||||
export CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" # keep the target tree off the source share
|
||||
|
||||
cargo test -p alkane-gui # unit tests
|
||||
cargo test -p alkane-gui --release -- --ignored bench_ # microbenchmarks
|
||||
cargo clippy -p alkane-gui --no-deps --bins -- -D warnings # lint gate
|
||||
xvfb-run -a env ALKANE_SELFTEST=1 \
|
||||
"$CARGO_TARGET_DIR/release/alkane-toolkit" # headless UI self-test
|
||||
ci/coverage.sh --summary-only # coverage (tests + self-test)
|
||||
WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config" \
|
||||
CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" \
|
||||
cargo test -p alkane-gui --offline
|
||||
```
|
||||
|
||||
CI mirrors these: `verify.yml` runs the lint, tests, benchmarks, self-test, and
|
||||
a best-effort dependency audit on every pull request and branch push;
|
||||
`release.yml` repeats them on `main` and cuts an `X.Y.Z` release with the built
|
||||
binary attached when the change warrants it. Dependencies are vendored under
|
||||
`vendor/`, so builds never touch the network.
|
||||
Keep build output off the source share. `main` runs full CI and publishes
|
||||
qualifying releases; `next` builds `-rc` candidates. Badges measure host
|
||||
code, not installation support. See the public
|
||||
[benchmark history](https://blueflare.gitea.bluefla.re/alkane-benchmarks/toolkit/).
|
||||
|
||||
## Architecture
|
||||
## Firmware safety
|
||||
|
||||
- `crates/alkane-gui` -- the application: scan engine, data model, wxWidgets UI,
|
||||
and the `miner_probe` CLI (the other `crates/alkane-*` are early scaffolding).
|
||||
- `vendor/asic-rs` -- the miner-discovery and control library, vendored and
|
||||
extended through numbered patches under `thirdparty/asic-rs/patches`.
|
||||
- `thirdparty/wx-rs` -- the patched wxWidgets bridge (see `docs/adr/0002`,
|
||||
`0003`).
|
||||
|
||||
See [`docs/IMPLEMENTATION-PLAN.md`](docs/IMPLEMENTATION-PLAN.md) for the roadmap
|
||||
and [`docs/aftermarket-parity-roadmap.md`](docs/aftermarket-parity-roadmap.md)
|
||||
for the firmware config/scan parity work.
|
||||
|
||||
## Firmware safety rules
|
||||
|
||||
Encoded in code, from alkane-sdk `docs/install-methods.md`:
|
||||
|
||||
1. Never write the bootloader or secure region.
|
||||
2. Verify on a channel the installer does not control.
|
||||
3. Reboot is root-only; a dropped SSH connection can still be success.
|
||||
4. A packer is per board; never reuse one across boards.
|
||||
5. Boot-switch handling is an explicit, verified step.
|
||||
Installation must follow the [SDK install rules](https://gitea.bluefla.re/blueflare/alkane-sdk/src/branch/main/docs/install-methods.md):
|
||||
use the exact board's packer and boot-switch procedure, verify through an
|
||||
independent channel, and never write bootloader or secure regions.
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the [MIT license](LICENSE).
|
||||
[MIT](LICENSE). Vendored dependencies keep their own terms.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"bench_parse_line_near_max_addrs": 6024293.0,
|
||||
"bench_parse_targets_many_ranges_near_cap": 222610900.0,
|
||||
"bench_render_cells": 20214728.0,
|
||||
"bench_sort_by_each_column": 4018989.0,
|
||||
"bench_targets_to_cidrs_large_range": 3617810.0,
|
||||
"bench_upsert_cold_start_population": 57182111.0,
|
||||
"bench_view_pipeline": 901801.0,
|
||||
"bench_view_pipeline_default_sort": 2044453.0,
|
||||
"bench_view_pipeline_with_filter": 2139556.0
|
||||
"bench_parse_line_near_max_addrs": 807160.0,
|
||||
"bench_parse_targets_many_ranges_near_cap": 54465485.0,
|
||||
"bench_render_cells": 3503112.0,
|
||||
"bench_sort_by_each_column": 486975.0,
|
||||
"bench_targets_to_cidrs_large_range": 482167.0,
|
||||
"bench_upsert_cold_start_population": 8315814.0,
|
||||
"bench_view_pipeline": 191794.0,
|
||||
"bench_view_pipeline_default_sort": 193214.0,
|
||||
"bench_view_pipeline_with_filter": 253085.0
|
||||
}
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="128.0" height="20" role="img" aria-label="bench coverage: 7%">
|
||||
<title>bench coverage: 7%</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="128.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="103.0" height="20" fill="#555"/>
|
||||
<rect x="103.0" width="25.0" height="20" fill="#e05d44"/>
|
||||
<rect width="128.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="51.5" y="15" fill="#010101" fill-opacity=".3">bench coverage</text>
|
||||
<text x="51.5" y="14">bench coverage</text>
|
||||
<text x="115.5" y="15" fill="#010101" fill-opacity=".3">7%</text>
|
||||
<text x="115.5" y="14">7%</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 946 B |
@@ -1,19 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="147.5" height="20" role="img" aria-label="bench: -25.6% vs prev">
|
||||
<title>bench: -25.6% vs prev</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="bench: +7.4% vs prev">
|
||||
<title>bench: +7.4% vs prev</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="147.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<clipPath id="r"><rect width="141.0" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="44.5" height="20" fill="#555"/>
|
||||
<rect x="44.5" width="103.0" height="20" fill="#4c1"/>
|
||||
<rect width="147.5" height="20" fill="url(#s)"/>
|
||||
<rect x="44.5" width="96.5" height="20" fill="#dfb317"/>
|
||||
<rect width="141.0" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">bench</text>
|
||||
<text x="22.2" y="14">bench</text>
|
||||
<text x="96.0" y="15" fill="#010101" fill-opacity=".3">-25.6% vs prev</text>
|
||||
<text x="96.0" y="14">-25.6% vs prev</text>
|
||||
<text x="92.8" y="15" fill="#010101" fill-opacity=".3">+7.4% vs prev</text>
|
||||
<text x="92.8" y="14">+7.4% vs prev</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 952 B After Width: | Height: | Size: 950 B |
@@ -1,5 +1,5 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="lines of code: 13.6k">
|
||||
<title>lines of code: 13.6k</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="141.0" height="20" role="img" aria-label="lines of code: 13.7K">
|
||||
<title>lines of code: 13.7K</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
@@ -13,7 +13,7 @@
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="48.2" y="15" fill="#010101" fill-opacity=".3">lines of code</text>
|
||||
<text x="48.2" y="14">lines of code</text>
|
||||
<text x="118.8" y="15" fill="#010101" fill-opacity=".3">13.6k</text>
|
||||
<text x="118.8" y="14">13.6k</text>
|
||||
<text x="118.8" y="15" fill="#010101" fill-opacity=".3">13.7K</text>
|
||||
<text x="118.8" y="14">13.7K</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 952 B After Width: | Height: | Size: 952 B |
@@ -1,19 +1,19 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="95.5" height="20" role="img" aria-label="clippy: clean">
|
||||
<title>clippy: clean</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="108.5" height="20" role="img" aria-label="code quality: A">
|
||||
<title>code quality: A</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
</linearGradient>
|
||||
<clipPath id="r"><rect width="95.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<clipPath id="r"><rect width="108.5" height="20" rx="3" fill="#fff"/></clipPath>
|
||||
<g clip-path="url(#r)">
|
||||
<rect width="51.0" height="20" fill="#555"/>
|
||||
<rect x="51.0" width="44.5" height="20" fill="#4c1"/>
|
||||
<rect width="95.5" height="20" fill="url(#s)"/>
|
||||
<rect width="90.0" height="20" fill="#555"/>
|
||||
<rect x="90.0" width="18.5" height="20" fill="#4c1"/>
|
||||
<rect width="108.5" height="20" fill="url(#s)"/>
|
||||
</g>
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="25.5" y="15" fill="#010101" fill-opacity=".3">clippy</text>
|
||||
<text x="25.5" y="14">clippy</text>
|
||||
<text x="73.2" y="15" fill="#010101" fill-opacity=".3">clean</text>
|
||||
<text x="73.2" y="14">clean</text>
|
||||
<text x="45.0" y="15" fill="#010101" fill-opacity=".3">code quality</text>
|
||||
<text x="45.0" y="14">code quality</text>
|
||||
<text x="99.2" y="15" fill="#010101" fill-opacity=".3">A</text>
|
||||
<text x="99.2" y="14">A</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 916 B After Width: | Height: | Size: 927 B |
@@ -1,5 +1,5 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="tests: 93 passing">
|
||||
<title>tests: 93 passing</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="tests: 95 passing">
|
||||
<title>tests: 95 passing</title>
|
||||
<linearGradient id="s" x2="0" y2="100%">
|
||||
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||
<stop offset="1" stop-opacity=".1"/>
|
||||
@@ -13,7 +13,7 @@
|
||||
<g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
|
||||
<text x="22.2" y="15" fill="#010101" fill-opacity=".3">tests</text>
|
||||
<text x="22.2" y="14">tests</text>
|
||||
<text x="83.0" y="15" fill="#010101" fill-opacity=".3">93 passing</text>
|
||||
<text x="83.0" y="14">93 passing</text>
|
||||
<text x="83.0" y="15" fill="#010101" fill-opacity=".3">95 passing</text>
|
||||
<text x="83.0" y="14">95 passing</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
Before Width: | Height: | Size: 935 B After Width: | Height: | Size: 935 B |
@@ -0,0 +1,54 @@
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Write small badge artifacts to the private Gitea CI badge branch."""
|
||||
|
||||
import base64
|
||||
import json
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
BADGE_BRANCH = "ci-badges"
|
||||
|
||||
|
||||
def request_json(url: str, token: str, method: str = "GET",
|
||||
payload: dict | None = None) -> dict:
|
||||
body = None if payload is None else json.dumps(payload).encode()
|
||||
request = Request(url, data=body, method=method,
|
||||
headers={"Authorization": f"token {token}",
|
||||
"Content-Type": "application/json"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def publish_file(api: str, repo: str, filename: str, data: bytes,
|
||||
token: str, message: str, max_bytes: int = 65_536) -> None:
|
||||
if not filename or filename.startswith("/") or any(
|
||||
part in ("", ".", "..") for part in filename.split("/")):
|
||||
raise ValueError("invalid badge path")
|
||||
if len(data) > max_bytes:
|
||||
raise ValueError("artifact exceeds size limit")
|
||||
path = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}"
|
||||
encoded = base64.b64encode(data).decode("ascii")
|
||||
for attempt in range(3):
|
||||
try:
|
||||
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
|
||||
if base64.b64decode(current["content"]) == data:
|
||||
return
|
||||
sha = current["sha"]
|
||||
method = "PUT"
|
||||
except HTTPError as error:
|
||||
if error.code != 404:
|
||||
raise
|
||||
sha = None
|
||||
method = "POST"
|
||||
payload = {"branch": BADGE_BRANCH, "content": encoded,
|
||||
"message": message + " [skip ci]"}
|
||||
if sha is not None:
|
||||
payload["sha"] = sha
|
||||
try:
|
||||
request_json(path, token, method, payload)
|
||||
return
|
||||
except HTTPError as error:
|
||||
if error.code not in (409, 422) or attempt == 2:
|
||||
raise
|
||||
raise RuntimeError("badge write did not complete")
|
||||
@@ -1,27 +1,8 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Compute the weighted-average microbenchmark delta versus the previous release.
|
||||
|
||||
Reads the captured stdout of `cargo test ... --ignored --nocapture bench_` (whose
|
||||
timings are Rust `Duration` Debug strings: "12.3ms", "512us"/"512µs", "840ns",
|
||||
"1.2s"), compares each bench to a committed baseline of the previous release's
|
||||
numbers, and prints the time-weighted average change as a signed percentage:
|
||||
|
||||
(sum(current) / sum(baseline) - 1) * 100 over benches present in both
|
||||
|
||||
Weighting by duration means the slow benches dominate, so the number tracks
|
||||
overall wall-time change rather than giving a tiny bench equal say. Then the
|
||||
baseline is rewritten with the current numbers, so the next release compares
|
||||
against this one ("the previous commit").
|
||||
|
||||
Usage:
|
||||
bench-badge.py --current bench-current.txt --baseline badges/bench-baseline.json
|
||||
|
||||
Prints the delta as a plain number (e.g. "-3.2", or "NEW" when there is no
|
||||
usable baseline) to stdout. The baseline JSON lives under badges/ so committing
|
||||
it back does not trip compute-version.sh's path-based release bump.
|
||||
"""
|
||||
"""Check the Toolkit benchmark suite and compare it with the prior release."""
|
||||
import argparse
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
@@ -29,9 +10,17 @@ import sys
|
||||
# A Duration Debug token: a number immediately followed by a time unit, with the
|
||||
# multi-char units listed before the bare "s" so alternation prefers them. The
|
||||
# trailing (?![a-zA-Z]) stops "s" in words like "rows"/"cidrs" from matching.
|
||||
_DUR = re.compile(r"([0-9]+(?:\.[0-9]+)?)\s*(ns|µs|us|ms|s)(?![a-zA-Z])")
|
||||
_UNIT_NS = {"ns": 1.0, "us": 1e3, "µs": 1e3, "ms": 1e6, "s": 1e9}
|
||||
_NAME = re.compile(r"^(bench_[A-Za-z0-9_]+)\s*:")
|
||||
_DUR = re.compile(r"([0-9]+(?:\.[0-9]+)?)\s*(ns|\u00b5s|us|ms|s)(?![a-zA-Z])")
|
||||
_UNIT_NS = {"ns": 1.0, "us": 1e3, "\u00b5s": 1e3, "ms": 1e6, "s": 1e9}
|
||||
_NAME = re.compile(r"^(?:test [A-Za-z0-9_:]+ \.\.\. )?(bench_[A-Za-z0-9_]+)\s*:")
|
||||
EXPECTED_BENCHES = {
|
||||
"bench_verify_artifact", "bench_naming_transforms",
|
||||
"bench_parse_line_near_max_addrs", "bench_parse_targets_many_ranges_near_cap",
|
||||
"bench_targets_to_cidrs_large_range", "bench_view_pipeline",
|
||||
"bench_render_cells", "bench_health_diagnostics",
|
||||
"bench_view_pipeline_default_sort", "bench_sort_by_each_column",
|
||||
"bench_view_pipeline_with_filter", "bench_upsert_cold_start_population",
|
||||
}
|
||||
|
||||
|
||||
def parse_bench(text: str) -> dict:
|
||||
@@ -44,12 +33,33 @@ def parse_bench(text: str) -> dict:
|
||||
continue
|
||||
durs = _DUR.findall(line)
|
||||
if not durs:
|
||||
continue
|
||||
raise ValueError(f"missing timing for {m.group(1)}")
|
||||
val, unit = durs[-1]
|
||||
out[m.group(1)] = float(val) * _UNIT_NS[unit]
|
||||
elapsed = float(val) * _UNIT_NS[unit]
|
||||
if m.group(1) in out or not math.isfinite(elapsed) or elapsed <= 0:
|
||||
raise ValueError(f"duplicate or invalid timing for {m.group(1)}")
|
||||
out[m.group(1)] = elapsed
|
||||
return out
|
||||
|
||||
|
||||
def require_suite(results: dict) -> dict:
|
||||
if results.keys() != EXPECTED_BENCHES:
|
||||
raise ValueError("microbenchmark results differ from the declared suite")
|
||||
return results
|
||||
|
||||
|
||||
def benchmark_delta(current: dict, baseline: dict) -> float | None:
|
||||
"""Average each comparable benchmark's percentage improvement."""
|
||||
if not baseline:
|
||||
return None
|
||||
changes = [(baseline[name] - current[name]) / baseline[name]
|
||||
for name in baseline]
|
||||
delta = math.fsum(changes) / len(changes) * 100
|
||||
if not math.isfinite(delta):
|
||||
raise ValueError("benchmark comparison is not finite")
|
||||
return delta
|
||||
|
||||
|
||||
def main() -> int:
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("--current", required=True, help="captured bench stdout")
|
||||
@@ -59,32 +69,34 @@ def main() -> int:
|
||||
|
||||
try:
|
||||
with open(args.current, encoding="utf-8") as fh:
|
||||
current = parse_bench(fh.read())
|
||||
except OSError as e:
|
||||
current = require_suite(parse_bench(fh.read()))
|
||||
except (OSError, ValueError) as e:
|
||||
print(f"bench-badge: cannot read current results: {e}", file=sys.stderr)
|
||||
print("NEW")
|
||||
return 0
|
||||
|
||||
if not current:
|
||||
print("bench-badge: no bench lines parsed from current results", file=sys.stderr)
|
||||
print("NEW")
|
||||
return 0
|
||||
return 1
|
||||
|
||||
baseline = {}
|
||||
try:
|
||||
with open(args.baseline, encoding="utf-8") as fh:
|
||||
baseline = {k: float(v) for k, v in json.load(fh).items()}
|
||||
except (OSError, ValueError):
|
||||
baseline = {}
|
||||
baseline = json.load(fh)
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
except (OSError, ValueError) as e:
|
||||
print(f"bench-badge: invalid baseline: {e}", file=sys.stderr)
|
||||
return 1
|
||||
if (not isinstance(baseline, dict)
|
||||
or not set(baseline).issubset(current)
|
||||
or any(not isinstance(value, (int, float)) or isinstance(value, bool)
|
||||
or not math.isfinite(value) or value <= 0
|
||||
for value in baseline.values())):
|
||||
print("bench-badge: invalid or retired benchmark in baseline", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
common = [k for k in current if k in baseline and baseline[k] > 0]
|
||||
if common:
|
||||
sum_new = sum(current[k] for k in common)
|
||||
sum_old = sum(baseline[k] for k in common)
|
||||
delta = (sum_new / sum_old - 1.0) * 100.0 if sum_old > 0 else 0.0
|
||||
print(f"{delta:.1f}")
|
||||
else:
|
||||
print("NEW")
|
||||
try:
|
||||
delta = benchmark_delta(current, baseline)
|
||||
except ValueError as error:
|
||||
print(f"bench-badge: {error}", file=sys.stderr)
|
||||
return 1
|
||||
print("NEW" if delta is None else f"{delta:.1f}")
|
||||
|
||||
if not args.no_write:
|
||||
os.makedirs(os.path.dirname(args.baseline) or ".", exist_ok=True)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
# Measure only instrumented microbenchmarks, excluding unit and UI tests.
|
||||
set -euo pipefail
|
||||
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-config}"
|
||||
cargo llvm-cov clean --workspace
|
||||
cargo llvm-cov --no-report --offline --release -p alkane-gui -p alkane-artifacts -- \
|
||||
--ignored --nocapture bench_
|
||||
cargo llvm-cov report --release --ignore-filename-regex '(thirdparty|vendor)/' "$@"
|
||||
@@ -0,0 +1,227 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Keep measured main-branch benchmarks in the private CI artifact branch."""
|
||||
|
||||
import argparse
|
||||
import base64
|
||||
from datetime import datetime, timezone
|
||||
import html
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
from pathlib import Path
|
||||
import re
|
||||
import subprocess
|
||||
import importlib.util
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote
|
||||
import yaml
|
||||
|
||||
from badge_store import BADGE_BRANCH, publish_file, request_json
|
||||
from bench_host import identity as benchmark_host
|
||||
|
||||
bench_spec = importlib.util.spec_from_file_location(
|
||||
"bench_badge", Path(__file__).with_name("bench-badge.py"))
|
||||
bench_badge = importlib.util.module_from_spec(bench_spec)
|
||||
bench_spec.loader.exec_module(bench_badge)
|
||||
|
||||
INDEX = "history/index.json"
|
||||
MAX_INDEX_ENTRIES = 50
|
||||
BENCH_INPUT_PATHS = (
|
||||
"Cargo.toml", "Cargo.lock", ".cargo", "crates", "thirdparty", "vendor",
|
||||
"rust-toolchain.toml", "ci/bench-badge.py", "ci/bench_host.py",
|
||||
"ci/ensure-build-deps.sh", "ci/ensure-wx-prefix.sh",
|
||||
"ci/configure-rust-cache.sh", "ci/wx-cache-key.sh",
|
||||
)
|
||||
|
||||
|
||||
def read_artifact(api: str, repo: str, token: str, filename: str):
|
||||
url = f"{api}/repos/{repo}/contents/{quote(filename, safe='/')}?ref={BADGE_BRANCH}"
|
||||
try:
|
||||
value = request_json(url, token)
|
||||
except HTTPError as error:
|
||||
if error.code == 404:
|
||||
return None
|
||||
raise
|
||||
return json.loads(base64.b64decode(value["content"]))
|
||||
|
||||
|
||||
def valid_benches(metrics: dict) -> dict[str, float]:
|
||||
values = metrics.get("bench_ns_per_op")
|
||||
if not isinstance(values, dict) or not values:
|
||||
raise ValueError("benchmark measurements are missing")
|
||||
if any(not isinstance(key, str) or not re.fullmatch(r"[A-Za-z0-9_]+", key)
|
||||
or not isinstance(value, (float, int)) or isinstance(value, bool)
|
||||
or not math.isfinite(value) or value <= 0 for key, value in values.items()):
|
||||
raise ValueError("benchmark measurements are invalid")
|
||||
return values
|
||||
|
||||
|
||||
def git_distance(ancestor: str, sha: str) -> int | None:
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", ancestor) or not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
return None
|
||||
result = subprocess.run(("git", "rev-list", "--count", f"{ancestor}..{sha}"),
|
||||
capture_output=True, text=True, check=False)
|
||||
if result.returncode != 0:
|
||||
return None
|
||||
ancestor_check = subprocess.run(("git", "merge-base", "--is-ancestor", ancestor, sha),
|
||||
capture_output=True, check=False)
|
||||
return int(result.stdout.strip()) if ancestor_check.returncode == 0 else None
|
||||
|
||||
|
||||
def previous_entry(index: dict, sha: str, distance=None, host=None) -> dict | None:
|
||||
distance = distance or git_distance
|
||||
choices = []
|
||||
for entry in index.get("entries", []):
|
||||
ancestor = entry.get("sha")
|
||||
if ancestor == sha or not isinstance(ancestor, str):
|
||||
continue
|
||||
if host is not None and entry.get("metrics", {}).get("bench_host") != host:
|
||||
continue
|
||||
gap = distance(ancestor, sha)
|
||||
if gap is not None and gap > 0:
|
||||
choices.append((gap, entry))
|
||||
if not choices:
|
||||
return None
|
||||
return min(choices, key=lambda item: item[0])[1]
|
||||
|
||||
|
||||
def previous_measurement(index: dict, sha: str, distance=None, host=None) -> dict:
|
||||
entry = previous_entry(index, sha, distance, host)
|
||||
return valid_benches(entry["metrics"]) if entry else {}
|
||||
|
||||
|
||||
def benchmark_build_settings(sha: str, root: Path | str = ".") -> dict:
|
||||
source = subprocess.check_output(
|
||||
("git", "show", f"{sha}:.gitea/workflows/release.yml"),
|
||||
cwd=root, text=True)
|
||||
job = yaml.load(source, Loader=yaml.BaseLoader)["jobs"]["release"]
|
||||
commands = {step.get("name", ""): step.get("run") for step in job["steps"]}
|
||||
selected = ("Install build dependencies", "Configure bounded Rust compiler cache",
|
||||
"Build wxWidgets (once, then cached)", "Build release", "Microbenchmarks")
|
||||
return {"image": job["container"]["image"], "env": job.get("env", {}),
|
||||
"commands": {name: commands.get(name) for name in selected}}
|
||||
|
||||
|
||||
def same_benchmark_inputs(ancestor: str, sha: str, root: Path | str = ".") -> bool:
|
||||
"""Identify changes that only reroute CI without changing benchmark inputs."""
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", ancestor) or not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
raise ValueError("invalid benchmark comparison commit")
|
||||
diff = subprocess.run(("git", "diff", "--quiet", ancestor, sha, "--",
|
||||
*BENCH_INPUT_PATHS), cwd=root, check=False)
|
||||
if diff.returncode not in (0, 1):
|
||||
raise ValueError("cannot inspect benchmark input changes")
|
||||
if diff.returncode == 1:
|
||||
return False
|
||||
try:
|
||||
return benchmark_build_settings(ancestor, root) == benchmark_build_settings(sha, root)
|
||||
except (KeyError, TypeError, subprocess.CalledProcessError, yaml.YAMLError):
|
||||
return False
|
||||
|
||||
|
||||
def updated_index(index: dict, sha: str, metrics: dict, timestamp: str) -> dict:
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
raise ValueError("invalid commit SHA")
|
||||
valid_benches(metrics)
|
||||
entries = [entry for entry in index.get("entries", []) if entry.get("sha") != sha]
|
||||
entries.append({"sha": sha, "timestamp": timestamp, "metrics": metrics})
|
||||
return {"schema": 1, "entries": entries[-MAX_INDEX_ENTRIES:]}
|
||||
|
||||
|
||||
def render_html(index: dict) -> str:
|
||||
entries = list(reversed(index.get("entries", [])))
|
||||
names = sorted({name for entry in entries
|
||||
for name in valid_benches(entry["metrics"])})
|
||||
rows = []
|
||||
for entry in entries:
|
||||
sha = entry["sha"]
|
||||
if not re.fullmatch(r"[0-9a-f]{40}", sha):
|
||||
raise ValueError("invalid commit SHA in history")
|
||||
cells = [f'<td><a href="https://gitea.bluefla.re/blueflare/alkane-toolkit/commit/{sha}">{sha[:10]}</a></td>',
|
||||
f'<td>{html.escape(entry["timestamp"])}</td>']
|
||||
values = valid_benches(entry["metrics"])
|
||||
host = entry["metrics"].get("bench_host", {})
|
||||
host_label = host.get("cpu_model", "unknown") if isinstance(host, dict) else "unknown"
|
||||
cells.append(f'<td>{html.escape(str(host_label))}</td>')
|
||||
context = entry["metrics"].get("bench_context", {})
|
||||
if isinstance(context, dict) and context.get("schema") == 1:
|
||||
context_label = "same inputs" if context.get("same_inputs") else "changed inputs"
|
||||
else:
|
||||
context_label = "unclassified"
|
||||
cells.append(f'<td>{context_label}</td>')
|
||||
cells += [f'<td>{values[name]:.3f}</td>' if name in values else '<td>new</td>'
|
||||
for name in names]
|
||||
rows.append("<tr>" + "".join(cells) + "</tr>")
|
||||
headings = "".join(f"<th scope=\"col\">{html.escape(name)} (ns/op)</th>" for name in names)
|
||||
return ("<!doctype html>\n<html lang=\"en\"><head><meta charset=\"utf-8\">"
|
||||
"<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">"
|
||||
"<title>Alkane Toolkit benchmarks</title><style>"
|
||||
"body{font:16px system-ui,sans-serif;max-width:1100px;margin:2rem auto;padding:0 1rem;color:#17212b}"
|
||||
"h1{font-size:2rem}p{max-width:70ch;line-height:1.5}"
|
||||
"table{border-collapse:collapse;min-width:100%}th,td{padding:.5rem;border-bottom:1px solid #ccd3da;text-align:right}"
|
||||
"th:first-child,td:first-child{text-align:left}th:nth-child(2),td:nth-child(2){text-align:left}"
|
||||
"th{background:#edf2f6;position:sticky;top:0}a{color:#145a9a}"
|
||||
".scroll{overflow-x:auto}small{color:#55616d}</style></head><body>"
|
||||
"<h1>Alkane Toolkit microbenchmarks</h1>"
|
||||
"<p>Measured on main CI. Lower ns/op is faster. Runner load affects results. "
|
||||
"Same inputs marks a repeat of the benchmark source and build settings. "
|
||||
"A new benchmark has no earlier comparison.</p>"
|
||||
f"<p><small>Most recent {len(entries)} measured commits. Full per-commit JSON is retained "
|
||||
"in the private ci-badges branch.</small></p>"
|
||||
f"<div class=\"scroll\"><table><thead><tr><th scope=\"col\">Commit</th>"
|
||||
f"<th scope=\"col\">UTC</th><th scope=\"col\">CPU</th>"
|
||||
f"<th scope=\"col\">Inputs</th>{headings}</tr></thead><tbody>{''.join(rows)}"
|
||||
"</tbody></table></div></body></html>\n")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("action", choices=("prepare", "publish", "render"))
|
||||
args = parser.parse_args()
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
index = read_artifact(api, repo, token, INDEX) or {"schema": 1, "entries": []}
|
||||
if index.get("schema") != 1 or not isinstance(index.get("entries"), list):
|
||||
raise ValueError("unsupported benchmark history index")
|
||||
if args.action == "prepare":
|
||||
entry = previous_entry(index, sha, host=benchmark_host())
|
||||
baseline = valid_benches(entry["metrics"]) if entry else {}
|
||||
same_inputs = same_benchmark_inputs(entry["sha"], sha) if entry else False
|
||||
Path("badges").mkdir(exist_ok=True)
|
||||
Path("badges/bench-baseline.json").write_text(json.dumps(baseline) + "\n")
|
||||
Path("badges/bench-context.json").write_text(
|
||||
json.dumps({"schema": 1, "same_inputs": same_inputs,
|
||||
"baseline_sha": entry["sha"] if entry else None}) + "\n")
|
||||
print(f"Loaded {len(baseline)} prior benchmark measurements; "
|
||||
f"same inputs: {str(same_inputs).lower()}")
|
||||
return
|
||||
if args.action == "render":
|
||||
if not index["entries"]:
|
||||
raise ValueError("no measured benchmark history to publish")
|
||||
Path("bench-site").mkdir(exist_ok=True)
|
||||
Path("bench-site/index.html").write_text(render_html(index))
|
||||
print(f"Rendered {len(index['entries'])} measured benchmark commits")
|
||||
return
|
||||
context = json.loads(Path("badges/bench-context.json").read_text())
|
||||
if (not isinstance(context, dict) or context.get("schema") != 1 or
|
||||
not isinstance(context.get("same_inputs"), bool)):
|
||||
raise ValueError("invalid benchmark comparison context")
|
||||
metrics = {"bench_ns_per_op": bench_badge.require_suite(bench_badge.parse_bench(
|
||||
Path("bench-current.txt").read_text())), "bench_host": benchmark_host(),
|
||||
"bench_context": context}
|
||||
timestamp = datetime.now(timezone.utc).isoformat(timespec="seconds")
|
||||
index = updated_index(index, sha, metrics, timestamp)
|
||||
record = json.dumps(index["entries"][-1], indent=2).encode() + b"\n"
|
||||
publish_file(api, repo, f"history/{sha}.json", record, token,
|
||||
"Record Alkane Toolkit benchmarks", max_bytes=1_048_576)
|
||||
publish_file(api, repo, INDEX, json.dumps(index, indent=2).encode() + b"\n",
|
||||
token, "Update Alkane Toolkit benchmark index", max_bytes=1_048_576)
|
||||
Path("bench-site").mkdir(exist_ok=True)
|
||||
Path("bench-site/index.html").write_text(render_html(index))
|
||||
print(f"Recorded benchmarks for {sha[:10]}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Identify the CPU class used for comparable CI microbenchmark baselines."""
|
||||
|
||||
import os
|
||||
import platform
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def identity() -> dict[str, object]:
|
||||
model = "unknown"
|
||||
cpuinfo = Path("/proc/cpuinfo")
|
||||
if cpuinfo.is_file():
|
||||
for line in cpuinfo.read_text(errors="replace").splitlines():
|
||||
if line.startswith(("model name\t", "Hardware\t", "Processor\t")):
|
||||
model = line.partition(":")[2].strip()[:160]
|
||||
break
|
||||
return {"architecture": platform.machine(), "cpu_model": model,
|
||||
"logical_cpus": os.cpu_count() or 1}
|
||||
@@ -0,0 +1,64 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Keep Toolkit CI on the verified Alkane runner image."""
|
||||
|
||||
from pathlib import Path
|
||||
import re
|
||||
import sys
|
||||
|
||||
import yaml
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
IMAGE = (ROOT / "ci/runner-image.txt").read_text().strip()
|
||||
|
||||
|
||||
def main() -> int:
|
||||
if not re.fullmatch(
|
||||
r"gitea\.bluefla\.re/blueflare/alkane-ci@sha256:[0-9a-f]{64}", IMAGE
|
||||
):
|
||||
print("Runner image must be pinned by Gitea registry digest", file=sys.stderr)
|
||||
return 1
|
||||
for path in sorted((ROOT / ".gitea/workflows").glob("*.yml")):
|
||||
workflow = yaml.load(path.read_text(), Loader=yaml.BaseLoader)
|
||||
for name, job in workflow.get("jobs", {}).items():
|
||||
if job.get("runs-on") not in {"alkane-ci", "alkane-fast", "alkane-verify"}:
|
||||
continue
|
||||
if job.get("container", {}).get("image") != IMAGE:
|
||||
print(f"{path.name}: {name} has a different runner image", file=sys.stderr)
|
||||
return 1
|
||||
pages = yaml.load(
|
||||
(ROOT / ".gitea/workflows/bench-pages.yml").read_text(),
|
||||
Loader=yaml.BaseLoader,
|
||||
)
|
||||
if (pages["on"]["workflow_run"]["workflows"] != ["build-test-release"]
|
||||
or pages["jobs"]["publish"].get("runs-on") != "alkane-pages"):
|
||||
print("Benchmark Pages must follow main CI on the Pages runner", file=sys.stderr)
|
||||
return 1
|
||||
release = yaml.load(
|
||||
(ROOT / ".gitea/workflows/release.yml").read_text(),
|
||||
Loader=yaml.BaseLoader,
|
||||
)
|
||||
if release["jobs"]["release"].get("runs-on") != "alkane-ci":
|
||||
print("Main release must use the dedicated Alkane build pool", file=sys.stderr)
|
||||
return 1
|
||||
if any("ci/publish-bench-pages.py" in step.get("run", "")
|
||||
for step in release["jobs"]["release"]["steps"]):
|
||||
print("Main release must not publish Pages from GARM", file=sys.stderr)
|
||||
return 1
|
||||
source = yaml.load(
|
||||
(ROOT / ".gitea/workflows/source.yml").read_text(),
|
||||
Loader=yaml.BaseLoader,
|
||||
)
|
||||
triggers = source["on"]
|
||||
if (triggers.get("pull_request", {}).get("branches") != ["next"]
|
||||
or "push" in triggers or "workflow_dispatch" not in triggers):
|
||||
print("Source checks must not duplicate main pull request verification",
|
||||
file=sys.stderr)
|
||||
return 1
|
||||
print("Toolkit runner image pins: PASS")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
@@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
# Avoid a runner-local cache download when the pinned image has this source.
|
||||
set -euo pipefail
|
||||
|
||||
prefix="${WX_PREFIX:?WX_PREFIX is required}"
|
||||
expected="$(awk '$1 == "sha256:" {print $2}' thirdparty/wxwidgets/VERSION)"
|
||||
[[ "$expected" =~ ^[0-9a-f]{64}$ ]]
|
||||
available=false
|
||||
if [ ! -L "$prefix" ] && [ ! -L "$prefix/.alkane-source-sha256" ] &&
|
||||
[ -x "$prefix/bin/wx-config" ] &&
|
||||
[ -s "$prefix/lib/libwx_gtk3u-3.3.a" ] &&
|
||||
[ "$(cat "$prefix/.alkane-source-sha256" 2>/dev/null || true)" = "$expected" ]; then
|
||||
available=true
|
||||
fi
|
||||
printf 'available=%s\n' "$available" >> "${GITHUB_OUTPUT:?GITHUB_OUTPUT is required}"
|
||||
@@ -0,0 +1,53 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Remove generated Toolkit CI work after the release asset is uploaded."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import sys
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
DIRECTORIES = ("target", "dist", "coverage", "bench-site")
|
||||
FILES = ("bench-current.txt",)
|
||||
BADGE_FILES = ("bench-baseline.json", "bench-context.json")
|
||||
|
||||
|
||||
def cleanup() -> None:
|
||||
if not os.environ.get("GITHUB_RUN_ID"):
|
||||
raise ValueError("cleanup is restricted to CI runs")
|
||||
for name in DIRECTORIES:
|
||||
path = ROOT / name
|
||||
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
|
||||
raise ValueError(f"unsafe generated directory: {path}")
|
||||
if path.is_dir():
|
||||
shutil.rmtree(path)
|
||||
print(f"Removed generated directory: {name}")
|
||||
elif path.exists():
|
||||
raise ValueError(f"expected a generated directory: {path}")
|
||||
for name in FILES:
|
||||
path = ROOT / name
|
||||
if path.is_symlink() or path.parent.resolve() != ROOT.resolve():
|
||||
raise ValueError(f"unsafe generated file: {path}")
|
||||
if path.is_file():
|
||||
path.unlink()
|
||||
print(f"Removed generated file: {name}")
|
||||
badge_dir = ROOT / "badges"
|
||||
if badge_dir.is_symlink():
|
||||
raise ValueError("unsafe generated badge directory")
|
||||
for name in BADGE_FILES:
|
||||
path = badge_dir / name
|
||||
if path.is_symlink() or path.parent.resolve() != badge_dir.resolve():
|
||||
raise ValueError(f"unsafe generated badge file: {path}")
|
||||
if path.is_file():
|
||||
path.unlink()
|
||||
print(f"Removed generated badge file: {name}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
cleanup()
|
||||
except (OSError, ValueError) as error:
|
||||
print(f"ERROR: Toolkit cleanup: {error}", file=sys.stderr)
|
||||
raise SystemExit(1)
|
||||
@@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
# Convert the next final version into a monotonically numbered prerelease.
|
||||
set -euo pipefail
|
||||
result="$(bash ci/compute-version.sh)"
|
||||
release="$(printf '%s\n' "$result" | sed -n 's/^release=//p')"
|
||||
if [ "$release" != true ]; then
|
||||
echo "release=false"
|
||||
exit 0
|
||||
fi
|
||||
version="$(printf '%s\n' "$result" | sed -n 's/^version=//p')"
|
||||
last="$(git tag -l "v${version}-rc.*" | sed -n "s/^v${version//./\.}-rc\.\([0-9][0-9]*\)$/\1/p" | sort -n | tail -1)"
|
||||
next=$(( ${last:-0} + 1 ))
|
||||
echo "release=true"
|
||||
echo "version=${version}-rc.${next}"
|
||||
echo "tag=v${version}-rc.${next}"
|
||||
@@ -18,7 +18,7 @@ X=0
|
||||
[ -f "$x_file" ] && X=$(tr -dc '0-9' < "$x_file")
|
||||
X=${X:-0}
|
||||
|
||||
last=$(git tag -l 'v*.*.*' | sort -V | tail -1 || true)
|
||||
last=$(git tag -l 'v*.*.*' | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -1 || true)
|
||||
if [ -n "$last" ]; then
|
||||
v=${last#v}; lx=${v%%.*}; rest=${v#*.}; ly=${rest%%.*}; lz=${rest##*.}
|
||||
changed=$(git diff --name-only "$last"..HEAD)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
# Reuse Rust compiler results on persistent CI runners.
|
||||
set -euo pipefail
|
||||
|
||||
[ "$(sccache --version)" = 'sccache 0.18.0' ] || {
|
||||
echo 'CI image has an unexpected sccache version' >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
toolcache="${RUNNER_TOOL_CACHE:-}"
|
||||
if [ -z "$toolcache" ] || [ -L "$toolcache" ] ||
|
||||
[ ! -d "$toolcache" ] || [ ! -w "$toolcache" ]; then
|
||||
echo 'Persistent runner tool cache is unavailable; compiling without sccache'
|
||||
exit 0
|
||||
fi
|
||||
|
||||
cache_dir="$toolcache/alkane-toolkit-rust-sccache"
|
||||
if [ -L "$cache_dir" ]; then
|
||||
echo 'Rust cache path is a symlink' >&2
|
||||
exit 1
|
||||
fi
|
||||
umask 077
|
||||
mkdir -p "$cache_dir"
|
||||
if [ ! -d "$cache_dir" ] || [ ! -w "$cache_dir" ]; then
|
||||
echo 'Rust cache directory is unavailable' >&2
|
||||
exit 1
|
||||
fi
|
||||
chmod 0700 "$cache_dir"
|
||||
|
||||
{
|
||||
printf 'RUSTC_WRAPPER=%s\n' "$(command -v sccache)"
|
||||
printf 'SCCACHE_DIR=%s\n' "$cache_dir"
|
||||
printf 'SCCACHE_CACHE_SIZE=2G\n'
|
||||
printf 'CARGO_INCREMENTAL=0\n'
|
||||
} >> "${GITHUB_ENV:?GITHUB_ENV is required}"
|
||||
echo 'Bounded Rust compiler cache configured for Alkane Toolkit'
|
||||
@@ -2,10 +2,11 @@
|
||||
# Measure line coverage from BOTH the unit tests AND the headless UI self-test.
|
||||
#
|
||||
# The self-test (ALKANE_SELFTEST=1) builds the real wxWidgets table, renders every
|
||||
# fixture through the real widgets, and checks each cell against the model -- it
|
||||
# exercises most of ui.rs. Because it runs as a separate binary invocation, a plain
|
||||
# `cargo llvm-cov` (which only runs the #[test]s) never counts it, so ui.rs shows
|
||||
# ~4% even though it is integration-tested. This combines both runs' coverage.
|
||||
# fixture through the real widgets, and checks each cell against the model.
|
||||
# It covers the fixture-rendering path, while interactive event handlers need
|
||||
# separate tests. Because it runs as a separate binary invocation, a plain
|
||||
# `cargo llvm-cov` (which only runs the #[test]s) never counts it. This
|
||||
# combines both runs' coverage.
|
||||
#
|
||||
# Usage: ci/coverage.sh [extra `cargo llvm-cov report` args, e.g. --summary-only]
|
||||
set -euo pipefail
|
||||
@@ -16,21 +17,23 @@ export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-conf
|
||||
# default; override with CARGO_LLVM_COV_FLAGS if you need something else.
|
||||
read -ra CARGO_FLAGS <<<"${CARGO_LLVM_COV_FLAGS:---offline}"
|
||||
|
||||
# A display for the self-test's real widgets.
|
||||
need_xvfb() { command -v xvfb-run >/dev/null 2>&1; }
|
||||
# A display is required for the self-test; skipping it would publish an
|
||||
# incomplete coverage number as if the measured test set had run.
|
||||
if ! command -v xvfb-run >/dev/null 2>&1; then
|
||||
echo "coverage.sh: xvfb-run is required for the UI self-test" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cargo llvm-cov clean --workspace
|
||||
|
||||
# 1. Unit tests.
|
||||
# 1. Unit tests for the GUI and all first-party headless crates.
|
||||
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" -p alkane-gui --bin alkane-toolkit
|
||||
cargo llvm-cov --no-report "${CARGO_FLAGS[@]}" \
|
||||
--workspace --exclude alkane-gui --exclude wx-rs
|
||||
|
||||
# 2. Headless UI self-test, under the same instrumentation, its coverage appended.
|
||||
if need_xvfb; then
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 \
|
||||
cargo llvm-cov run --no-report "${CARGO_FLAGS[@]}" --bin alkane-toolkit
|
||||
else
|
||||
echo "coverage.sh: xvfb-run not found; skipping the self-test run (unit tests only)" >&2
|
||||
fi
|
||||
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 \
|
||||
cargo llvm-cov run --no-report "${CARGO_FLAGS[@]}" --bin alkane-toolkit
|
||||
|
||||
# 3. Merged report, our source only (vendored asic-rs + the patched wx-rs bridge
|
||||
# are out of scope).
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
# Use the preinstalled CI image or install missing packages on older runners.
|
||||
set -euo pipefail
|
||||
|
||||
mode="${1:?usage: ensure-build-deps.sh base|ui|all|ssh}"
|
||||
case "$mode" in
|
||||
base) packages=(libssl-dev pkg-config ca-certificates) ;;
|
||||
ui) packages=(xvfb xauth dbus-x11 fonts-dejavu-core) ;;
|
||||
ssh) packages=(openssh-client) ;;
|
||||
all) packages=(libssl-dev pkg-config ca-certificates openssh-client
|
||||
xvfb xauth dbus-x11 fonts-dejavu-core) ;;
|
||||
*) echo "unknown dependency set: $mode" >&2; exit 2 ;;
|
||||
esac
|
||||
|
||||
installed="$(dpkg-query -W -f='${Package} ${Status}\n' "${packages[@]}" 2>/dev/null || true)"
|
||||
missing=()
|
||||
for package in "${packages[@]}"; do
|
||||
if ! grep -Fxq "$package install ok installed" <<< "$installed"; then
|
||||
missing+=("$package")
|
||||
fi
|
||||
done
|
||||
if [ "${#missing[@]}" -eq 0 ]; then
|
||||
printf 'Build packages already installed: %s\n' "$mode"
|
||||
exit 0
|
||||
fi
|
||||
printf 'Installing %s missing build packages\n' "${#missing[@]}"
|
||||
apt-get update -qq
|
||||
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends "${packages[@]}"
|
||||
@@ -0,0 +1,43 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
# Use the matching image or cache prefix; rebuild after a vendored source bump.
|
||||
set -euo pipefail
|
||||
|
||||
prefix="${WX_PREFIX:?WX_PREFIX is required}"
|
||||
if [ -L "$prefix" ] || [ -L "$prefix/.alkane-source-sha256" ]; then
|
||||
echo 'refusing symlinked wxWidgets prefix or source marker' >&2
|
||||
exit 1
|
||||
fi
|
||||
expected="$(awk '$1 == "sha256:" {print $2}' thirdparty/wxwidgets/VERSION)"
|
||||
[[ "$expected" =~ ^[0-9a-f]{64}$ ]] || {
|
||||
echo 'invalid pinned wxWidgets source digest' >&2
|
||||
exit 1
|
||||
}
|
||||
marker="$prefix/.alkane-source-sha256"
|
||||
if [ -e "$marker" ] && [ "$(cat "$marker")" != "$expected" ]; then
|
||||
python3 - "$prefix" <<'PY'
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import sys
|
||||
|
||||
prefix = Path(sys.argv[1])
|
||||
allowed = Path('/root/.cache/wx-3.3.3-linux')
|
||||
if prefix != allowed or prefix.is_symlink():
|
||||
raise SystemExit('refusing unsafe wxWidgets prefix reset')
|
||||
if prefix.is_dir():
|
||||
shutil.rmtree(prefix)
|
||||
PY
|
||||
fi
|
||||
built=false
|
||||
if [ ! -x "$prefix/bin/wx-config" ] ||
|
||||
[ ! -s "$prefix/lib/libwx_gtk3u-3.3.a" ]; then
|
||||
bash scripts/build-wx-linux.sh
|
||||
built=true
|
||||
else
|
||||
echo 'wx prefix available from matching image or cache'
|
||||
fi
|
||||
[ -s "$prefix/lib/libwx_gtk3u-3.3.a" ]
|
||||
printf '%s\n' "$expected" > "$marker"
|
||||
if [ -n "${GITHUB_OUTPUT:-}" ]; then
|
||||
printf 'built=%s\n' "$built" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
@@ -1,10 +1,8 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Generate self-contained shields-style SVG badges into badges/.
|
||||
|
||||
Self-hosted Gitea renders a README's relative image links straight from the
|
||||
repo, so committing the SVGs (rather than depending on an external badge
|
||||
service that would have to reach a possibly-private Gitea) is the robust choice.
|
||||
CI regenerates them from live metrics and commits any changes back.
|
||||
Main CI regenerates SVGs from measured metrics and publishes them to the
|
||||
private ci-badges branch. The README loads those authenticated raw artifacts.
|
||||
|
||||
Usage:
|
||||
gen-badges.py --tests N --coverage PCT --bench "label" [--out badges]
|
||||
@@ -13,7 +11,10 @@ Metrics not passed on the command line are computed here (LOC from the source
|
||||
tree, dependency count from Cargo.lock, license from Cargo.toml).
|
||||
"""
|
||||
import argparse
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
from pathlib import Path
|
||||
import re
|
||||
import sys
|
||||
|
||||
@@ -109,13 +110,13 @@ def loc_color(n: int) -> str:
|
||||
|
||||
|
||||
def bench_color(delta_pct: float) -> str:
|
||||
# Negative delta = faster than the previous release. A +/-2% dead band absorbs
|
||||
# the run-to-run jitter of microbenchmarks on a shared CI runner.
|
||||
if delta_pct <= -2.0:
|
||||
# Positive delta means faster than the previous release. A +/-2% band
|
||||
# absorbs run-to-run jitter on the dedicated CI runner.
|
||||
if delta_pct >= 2.0:
|
||||
return "brightgreen"
|
||||
if delta_pct < 2.0:
|
||||
if delta_pct > -2.0:
|
||||
return "blue"
|
||||
if delta_pct < 10.0:
|
||||
if delta_pct > -10.0:
|
||||
return "yellow"
|
||||
return "orange"
|
||||
|
||||
@@ -132,10 +133,26 @@ def cov_color(pct: float) -> str:
|
||||
return "red"
|
||||
|
||||
|
||||
def quality_grade(clippy: str | None) -> str:
|
||||
if clippy is None:
|
||||
return "pending"
|
||||
return "A" if clippy == "clean" else "F"
|
||||
|
||||
|
||||
def human(n: int) -> str:
|
||||
if n >= 1000:
|
||||
return f"{n / 1000:.1f}k".replace(".0k", "k")
|
||||
return str(n)
|
||||
suffixes = ("", "K", "M", "G")
|
||||
value = float(n)
|
||||
index = 0
|
||||
while value >= 999.5 and index < len(suffixes) - 1:
|
||||
value /= 1000
|
||||
index += 1
|
||||
if value >= 100:
|
||||
number = f"{value:.0f}"
|
||||
elif value >= 10:
|
||||
number = f"{value:.1f}".rstrip("0").rstrip(".")
|
||||
else:
|
||||
number = f"{value:.2f}".rstrip("0").rstrip(".")
|
||||
return number + suffixes[index]
|
||||
|
||||
|
||||
def main() -> int:
|
||||
@@ -144,13 +161,16 @@ def main() -> int:
|
||||
ap.add_argument("--root", default=".")
|
||||
ap.add_argument("--tests", type=int, default=None)
|
||||
ap.add_argument("--coverage", type=float, default=None)
|
||||
ap.add_argument("--bench-coverage", type=float, default=None)
|
||||
ap.add_argument("--bench", default=None)
|
||||
# Weighted-average microbench delta vs the previous release, as a signed
|
||||
# percentage string (e.g. "-3.2"), or "NEW"/"" when there is no baseline yet
|
||||
# (round 19 #1). Takes precedence over --bench for the bench badge.
|
||||
# Mean per-benchmark improvement vs the previous release, as a signed
|
||||
# percentage string, or "NEW" when there is no baseline.
|
||||
ap.add_argument("--bench-delta", default=None)
|
||||
ap.add_argument("--clippy", default="clean")
|
||||
ap.add_argument("--clippy", choices=("clean", "failed"))
|
||||
args = ap.parse_args()
|
||||
for value in (args.coverage, args.bench_coverage):
|
||||
if value is not None and (not math.isfinite(value) or not 0 <= value <= 100):
|
||||
ap.error("coverage must be a finite percentage between 0 and 100")
|
||||
|
||||
os.makedirs(os.path.join(args.root, args.out), exist_ok=True)
|
||||
|
||||
@@ -167,13 +187,27 @@ def main() -> int:
|
||||
write("loc", "lines of code", human(loc), loc_color(loc))
|
||||
write("license", "license", lic, "blue")
|
||||
write("dependencies", "dependencies", str(deps), "blue")
|
||||
write("quality", "clippy", args.clippy, "brightgreen" if args.clippy == "clean" else "orange")
|
||||
grade = quality_grade(args.clippy)
|
||||
write("quality", "code quality", grade,
|
||||
{"A": "brightgreen", "B": "yellowgreen", "C": "yellow",
|
||||
"D": "orange", "F": "red", "pending": "lightgrey"}[grade])
|
||||
if args.tests is not None:
|
||||
write("tests", "tests", f"{args.tests} passing", "brightgreen")
|
||||
if args.coverage is not None:
|
||||
write("coverage", "coverage", f"{args.coverage:.0f}%", cov_color(args.coverage))
|
||||
# Bench badge: prefer the weighted-average delta vs the previous release; fall
|
||||
# back to the static label (first run, or when the delta could not be computed).
|
||||
write("bench-coverage", "bench coverage",
|
||||
f"{args.bench_coverage:.0f}%" if args.bench_coverage is not None else "pending",
|
||||
cov_color(args.bench_coverage) if args.bench_coverage is not None else "lightgrey")
|
||||
context_path = Path(args.root) / args.out / "bench-context.json"
|
||||
same_inputs = False
|
||||
if context_path.is_file():
|
||||
context = json.loads(context_path.read_text())
|
||||
if (not isinstance(context, dict) or context.get("schema") != 1 or
|
||||
not isinstance(context.get("same_inputs"), bool)):
|
||||
raise ValueError("invalid benchmark comparison context")
|
||||
same_inputs = context["same_inputs"]
|
||||
# Bench badge: prefer the mean per-benchmark improvement vs the previous
|
||||
# release. Use the static label when no comparison is available.
|
||||
delta = None
|
||||
if args.bench_delta not in (None, "", "NEW"):
|
||||
try:
|
||||
@@ -181,9 +215,12 @@ def main() -> int:
|
||||
except ValueError:
|
||||
delta = None
|
||||
if delta is not None:
|
||||
# Negative = faster than the previous release (good).
|
||||
msg = f"{'+' if delta > 0 else ''}{delta:.1f}% vs prev"
|
||||
write("bench", "bench", msg, bench_color(delta))
|
||||
# Positive = faster than the previous release.
|
||||
msg = f"{'+' if delta > 0 else ''}{delta:.1f}%"
|
||||
if same_inputs:
|
||||
write("bench", "bench", msg + " same inputs", "lightgrey")
|
||||
else:
|
||||
write("bench", "bench", msg + " vs prev", bench_color(delta))
|
||||
elif args.bench_delta == "NEW":
|
||||
write("bench", "bench", "baseline set", "blue")
|
||||
elif args.bench is not None:
|
||||
|
||||
@@ -0,0 +1,115 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish the last completed main/next CI result to a private badge branch."""
|
||||
|
||||
import base64
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from urllib.error import HTTPError
|
||||
from urllib.parse import quote, urlencode
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
|
||||
WORKFLOWS = {"release.yml": "main", "next.yml": "next"}
|
||||
BADGE_BRANCH = "ci-badges"
|
||||
|
||||
|
||||
def badge(branch: str, conclusion: str, run_id: int) -> bytes:
|
||||
passed = conclusion == "success"
|
||||
word = "pass" if passed else "fail"
|
||||
color = "#2ea043" if passed else "#d1242f"
|
||||
title = f"CI {branch}: last completed attempt {word} (run {run_id})"
|
||||
return (f'<svg xmlns="http://www.w3.org/2000/svg" width="102" height="20" '
|
||||
f'role="img" aria-label="{title}"><title>{title}</title>'
|
||||
'<rect width="102" height="20" rx="3" fill="#555"/>'
|
||||
f'<path d="M39 0h60a3 3 0 0 1 3 3v14a3 3 0 0 1-3 3H39z" fill="{color}"/>'
|
||||
'<text x="20" y="14" fill="#fff" text-anchor="middle" '
|
||||
'font-family="sans-serif" font-size="11">CI</text>'
|
||||
f'<text x="70" y="14" fill="#fff" text-anchor="middle" '
|
||||
f'font-family="sans-serif" font-size="11">{word}</text></svg>\n').encode()
|
||||
|
||||
|
||||
def request_json(url: str, token: str, method: str = "GET",
|
||||
payload: dict | None = None) -> dict:
|
||||
body = None if payload is None else json.dumps(payload).encode()
|
||||
request = Request(url, data=body, method=method,
|
||||
headers={"Authorization": f"token {token}",
|
||||
"Content-Type": "application/json"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def latest_completed(api: str, repo: str, workflow: str, branch: str,
|
||||
token: str) -> tuple[int, str]:
|
||||
path = quote(workflow, safe="")
|
||||
latest = None
|
||||
for page in range(1, 21):
|
||||
query = urlencode({"branch": branch, "limit": 50, "page": page})
|
||||
url = f"{api}/repos/{repo}/actions/workflows/{path}/runs?{query}"
|
||||
runs = request_json(url, token).get("workflow_runs", [])
|
||||
for run in runs:
|
||||
if run.get("head_branch") != branch or run.get("status") != "completed":
|
||||
continue
|
||||
if run.get("conclusion") not in ("success", "failure"):
|
||||
continue
|
||||
candidate = (int(run["id"]), run["conclusion"])
|
||||
if latest is None or candidate[0] > latest[0]:
|
||||
latest = candidate
|
||||
if len(runs) < 50:
|
||||
break
|
||||
if latest is None:
|
||||
raise RuntimeError(f"no completed {branch} run found for {workflow}")
|
||||
return latest
|
||||
|
||||
|
||||
def publish(api: str, repo: str, branch: str, data: bytes, token: str) -> None:
|
||||
path = f"{api}/repos/{repo}/contents/{branch}.svg"
|
||||
encoded = base64.b64encode(data).decode("ascii")
|
||||
for attempt in range(3):
|
||||
try:
|
||||
current = request_json(path + "?ref=" + BADGE_BRANCH, token)
|
||||
current_data = base64.b64decode(current["content"])
|
||||
if current_data == data:
|
||||
return
|
||||
sha = current["sha"]
|
||||
method = "PUT"
|
||||
except HTTPError as error:
|
||||
if error.code != 404:
|
||||
raise
|
||||
sha = None
|
||||
method = "POST"
|
||||
payload = {"branch": BADGE_BRANCH, "content": encoded,
|
||||
"message": f"Record completed {branch} CI attempt"}
|
||||
if sha is not None:
|
||||
payload["sha"] = sha
|
||||
try:
|
||||
request_json(path, token, method, payload)
|
||||
return
|
||||
except HTTPError as error:
|
||||
if error.code not in (409, 422) or attempt == 2:
|
||||
raise
|
||||
raise RuntimeError("badge write did not complete")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
event = json.loads(Path(os.environ["GITHUB_EVENT_PATH"]).read_text())
|
||||
if event.get("action") != "completed":
|
||||
raise RuntimeError("expected a completed workflow_run event")
|
||||
run = event["workflow_run"]
|
||||
workflow = run["path"].split("@", 1)[0].rsplit("/", 1)[-1]
|
||||
expected_branch = WORKFLOWS.get(workflow)
|
||||
if expected_branch is None or run.get("head_branch") != expected_branch:
|
||||
raise RuntimeError("unexpected workflow or branch")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
if event["repository"]["full_name"] != repo:
|
||||
raise RuntimeError("repository mismatch")
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
run_id, conclusion = latest_completed(api, repo, workflow, expected_branch, token)
|
||||
publish(api, repo, expected_branch, badge(expected_branch, conclusion, run_id), token)
|
||||
print(f"{expected_branch} badge records completed run {run_id}: {conclusion}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,122 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Classify a pull request for scoped CI checks."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
import sys
|
||||
import tomllib
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
DOC_FILES = {"README.md", "CONTRIBUTING.md", "CHANGELOG.md"}
|
||||
HEADLESS_CRATES = {"alkane-access", "alkane-artifacts", "alkane-cli", "alkane-flash"}
|
||||
|
||||
|
||||
def documentation_only(paths: list[str]) -> bool:
|
||||
return bool(paths) and all(
|
||||
path in DOC_FILES or
|
||||
(path.startswith("docs/") and Path(path).suffix in {".md", ".txt"})
|
||||
for path in paths
|
||||
)
|
||||
|
||||
|
||||
def workflow_only(paths: list[str]) -> bool:
|
||||
"""Limit the cheap PR check to workflow YAML, never policy code."""
|
||||
return bool(paths) and all(
|
||||
path.startswith(".gitea/workflows/") and
|
||||
len(Path(path).parts) == 3 and Path(path).suffix == ".yml"
|
||||
for path in paths
|
||||
)
|
||||
|
||||
|
||||
def headless_packages(paths: list[str]) -> list[str]:
|
||||
"""Return tested reverse dependents for code outside the GUI graph."""
|
||||
changed: set[str] = set()
|
||||
if not paths:
|
||||
return []
|
||||
for path in paths:
|
||||
parts = Path(path).parts
|
||||
if (len(parts) < 4 or parts[0] != "crates" or
|
||||
parts[1] not in HEADLESS_CRATES or
|
||||
parts[2] not in {"src", "tests"} or
|
||||
Path(path).suffix != ".rs"):
|
||||
return []
|
||||
changed.add(parts[1])
|
||||
|
||||
try:
|
||||
manifests = {}
|
||||
for path in (ROOT / "crates").glob("*/Cargo.toml"):
|
||||
manifest = tomllib.loads(path.read_text())
|
||||
name = manifest["package"]["name"]
|
||||
if name != path.parent.name:
|
||||
return []
|
||||
manifests[name] = manifest
|
||||
if not changed <= manifests.keys() or "alkane-gui" not in manifests:
|
||||
return []
|
||||
|
||||
def dependencies(value: object) -> set[str]:
|
||||
found: set[str] = set()
|
||||
if isinstance(value, dict):
|
||||
for key, nested in value.items():
|
||||
if key in {"dependencies", "dev-dependencies", "build-dependencies"}:
|
||||
for dep_name, spec in nested.items():
|
||||
found.add(spec.get("package", dep_name) if isinstance(spec, dict)
|
||||
else dep_name)
|
||||
else:
|
||||
found.update(dependencies(nested))
|
||||
return found & manifests.keys()
|
||||
|
||||
graph = {name: dependencies(manifest) for name, manifest in manifests.items()}
|
||||
affected = changed.copy()
|
||||
while True:
|
||||
added = {name for name, deps in graph.items() if deps & affected} - affected
|
||||
if not added:
|
||||
break
|
||||
affected.update(added)
|
||||
return [] if "alkane-gui" in affected else sorted(affected)
|
||||
except (OSError, KeyError, TypeError, ValueError):
|
||||
return []
|
||||
|
||||
|
||||
def changed_paths() -> list[str]:
|
||||
if os.environ.get("GITHUB_EVENT_NAME") != "pull_request":
|
||||
raise ValueError("not a pull request")
|
||||
if os.environ.get("GITHUB_BASE_REF") != "main":
|
||||
raise ValueError("unknown base branch")
|
||||
merge_base = subprocess.check_output(
|
||||
["git", "-C", str(ROOT), "merge-base", "HEAD",
|
||||
"refs/remotes/origin/main"],
|
||||
stderr=subprocess.DEVNULL, text=True,
|
||||
).strip()
|
||||
if len(merge_base) != 40:
|
||||
raise ValueError("missing merge base")
|
||||
raw = subprocess.check_output(
|
||||
["git", "-C", str(ROOT), "diff", "--no-renames", "--name-only", "-z",
|
||||
merge_base, "HEAD"], stderr=subprocess.DEVNULL,
|
||||
)
|
||||
return [path.decode("utf-8", "surrogateescape")
|
||||
for path in raw.split(b"\0") if path]
|
||||
|
||||
|
||||
def main() -> None:
|
||||
try:
|
||||
paths = changed_paths()
|
||||
docs = documentation_only(paths)
|
||||
workflow = workflow_only(paths) if not docs else False
|
||||
packages = headless_packages(paths) if not docs and not workflow else []
|
||||
except (OSError, subprocess.CalledProcessError, ValueError):
|
||||
paths = []
|
||||
docs = False
|
||||
workflow = False
|
||||
packages = []
|
||||
surface = ("documentation" if docs else "workflow" if workflow else
|
||||
"headless" if packages else "full")
|
||||
print(f"surface={surface}")
|
||||
print(f"packages={' '.join(packages)}")
|
||||
print(f"Changed paths: {len(paths)}", file=sys.stderr)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,121 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish a measured benchmark page to the public, data-only Pages repo."""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shlex
|
||||
import subprocess
|
||||
import tempfile
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
PAGES_REPO = "ssh://git@gitea.bluefla.re:2222/blueflare/alkane-benchmarks.git"
|
||||
GUARD_REPO = "https://gitea.bluefla.re/blueflare/alkane-benchmarks.git"
|
||||
GUARD_COMMIT = "ea160545c49bc419a245692deda8dd7db7a611eb"
|
||||
PAGES_HOST = "gitea.bluefla.re"
|
||||
PAGES_HOST_FINGERPRINT = "SHA256:lqB5cmC9E5HNeg/lkzdOwQ++I8A70Wx7lnNs6liN24g"
|
||||
PAGES_HOST_KEY = "[gitea.bluefla.re]:2222 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIO1II6NkmRW+QAd+Wj+7qbNrA8Oo+/N/WRog4hELskn/"
|
||||
|
||||
|
||||
def run(*args: str, env: dict[str, str] | None = None,
|
||||
cwd: Path | None = None) -> subprocess.CompletedProcess[str]:
|
||||
return subprocess.run(args, env=env, cwd=cwd, text=True,
|
||||
capture_output=True, check=True)
|
||||
|
||||
|
||||
def current_main_sha() -> str:
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
request = Request(f"{api}/repos/{repo}/branches/main",
|
||||
headers={"Authorization": f"token {token}"})
|
||||
with urlopen(request, timeout=20) as response:
|
||||
branch = json.load(response)
|
||||
return branch["commit"]["id"]
|
||||
|
||||
|
||||
def publish(site: str) -> None:
|
||||
if os.environ.get("GITHUB_REF") != "refs/heads/main":
|
||||
raise ValueError("benchmark Pages publication requires main")
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
if current_main_sha() != sha:
|
||||
print("Skipping benchmark page from a superseded main commit")
|
||||
return
|
||||
page = Path("bench-site/index.html").read_bytes()
|
||||
if not page.startswith(b"<!doctype html>") or len(page) > 1_048_576:
|
||||
raise ValueError("invalid benchmark page")
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-pages-") as directory:
|
||||
temporary = Path(directory)
|
||||
guard_checkout = temporary / "guard"
|
||||
run("git", "clone", "--quiet", "--single-branch", "--branch", "next",
|
||||
GUARD_REPO, str(guard_checkout))
|
||||
guard_source = run("git", "show", f"{GUARD_COMMIT}:ci/validate_site.py",
|
||||
cwd=guard_checkout).stdout
|
||||
guard_script = temporary / "validate_site.py"
|
||||
guard_script.write_text(guard_source)
|
||||
run("python3", str(guard_script), "--page", site,
|
||||
str(Path("bench-site/index.html").resolve()))
|
||||
key = os.environ["BENCH_PAGES_DEPLOY_KEY"]
|
||||
if not key.startswith("-----BEGIN OPENSSH PRIVATE KEY-----"):
|
||||
raise ValueError("missing benchmark Pages deploy key")
|
||||
key_path = temporary / "deploy_key"
|
||||
key_path.write_text(key.rstrip("\n") + "\n")
|
||||
key_path.chmod(0o600)
|
||||
known_hosts = temporary / "known_hosts"
|
||||
known_hosts.write_text(PAGES_HOST_KEY + "\n")
|
||||
fingerprint = run("ssh-keygen", "-lf", str(known_hosts)).stdout.split()[1]
|
||||
if fingerprint != PAGES_HOST_FINGERPRINT:
|
||||
raise ValueError("benchmark Pages SSH host key changed")
|
||||
git_env = os.environ.copy()
|
||||
ssh_command = (f"ssh -i {shlex.quote(str(key_path))} -o IdentitiesOnly=yes "
|
||||
f"-o UserKnownHostsFile={shlex.quote(str(known_hosts))} "
|
||||
"-o StrictHostKeyChecking=yes -o ConnectTimeout=10")
|
||||
git_env["GIT_SSH_COMMAND"] = ssh_command
|
||||
git_env["GIT_TERMINAL_PROMPT"] = "0"
|
||||
checkout = temporary / "site"
|
||||
run("git", "clone", "--quiet", "--single-branch", "--branch", "gh-pages",
|
||||
PAGES_REPO, str(checkout), env=git_env)
|
||||
run("git", "config", "user.name", "Alkane CI", cwd=checkout)
|
||||
run("git", "config", "user.email", "ci@bluefla.re", cwd=checkout)
|
||||
for attempt in range(3):
|
||||
if current_main_sha() != sha:
|
||||
print("Skipping benchmark page from a superseded main commit")
|
||||
return
|
||||
run("git", "fetch", "--quiet", "origin", "gh-pages", env=git_env,
|
||||
cwd=checkout)
|
||||
run("git", "checkout", "-q", "-B", "bench-publish", "origin/gh-pages",
|
||||
cwd=checkout)
|
||||
destination = checkout / site / "index.html"
|
||||
destination.parent.mkdir(exist_ok=True)
|
||||
destination.write_bytes(page)
|
||||
run("git", "add", f"{site}/index.html", cwd=checkout)
|
||||
changed = subprocess.run(("git", "diff", "--cached", "--quiet"),
|
||||
cwd=checkout, check=False)
|
||||
if changed.returncode == 0:
|
||||
print(f"{site} benchmark page is already current")
|
||||
return
|
||||
if changed.returncode != 1:
|
||||
raise RuntimeError("cannot compare benchmark page")
|
||||
run("git", "commit", "-q", "-m",
|
||||
f"Update {site} benchmarks for {sha[:10]} [skip ci]", cwd=checkout)
|
||||
pushed = subprocess.run(("git", "push", "--quiet", "origin",
|
||||
"HEAD:gh-pages"), env=git_env, cwd=checkout,
|
||||
text=True, capture_output=True, check=False)
|
||||
if pushed.returncode == 0:
|
||||
print(f"Published {site} benchmark page for {sha[:10]}")
|
||||
return
|
||||
if attempt == 2:
|
||||
raise RuntimeError(f"benchmark Pages push failed: {pushed.stderr.strip()}")
|
||||
raise RuntimeError("benchmark Pages publication did not complete")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("site", choices=("sdk", "os", "toolkit"))
|
||||
publish(parser.parse_args().site)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Publish measured toolkit badges to the private Gitea badge branch."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
from badge_store import publish_file
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
NAMES = ("tests", "coverage", "bench", "bench-coverage", "loc",
|
||||
"dependencies", "quality", "license")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
api = os.environ["GITHUB_API_URL"].rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
token = os.environ["GITEA_TOKEN"]
|
||||
for name in NAMES:
|
||||
data = (ROOT / "badges" / f"{name}.svg").read_bytes()
|
||||
if not data.lstrip().startswith(b"<svg"):
|
||||
raise ValueError(f"invalid {name} SVG")
|
||||
publish_file(api, repo, f"badges/{name}.svg", data, token,
|
||||
f"Update measured {name} badge")
|
||||
print(f"Published {len(NAMES)} measured badge SVGs")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Create one Gitea release and attach files using the runner's scoped token."""
|
||||
|
||||
import json
|
||||
import os
|
||||
import pathlib
|
||||
import sys
|
||||
import urllib.error
|
||||
import urllib.parse
|
||||
import urllib.request
|
||||
|
||||
|
||||
def request(url, payload, content_type):
|
||||
headers = {
|
||||
"Authorization": "token " + os.environ["GITEA_TOKEN"],
|
||||
"Content-Type": content_type,
|
||||
}
|
||||
req = urllib.request.Request(url, data=payload, headers=headers, method="POST")
|
||||
with urllib.request.urlopen(req, timeout=60) as response:
|
||||
return json.load(response)
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) < 4:
|
||||
sys.exit("usage: release.py TAG PRERELEASE FILE [FILE ...]")
|
||||
tag, prerelease, *files = sys.argv[1:]
|
||||
api = os.environ.get("GITHUB_API_URL", "https://gitea.bluefla.re/api/v1").rstrip("/")
|
||||
repo = os.environ["GITHUB_REPOSITORY"]
|
||||
sha = os.environ["GITHUB_SHA"]
|
||||
body = f"Automated Alkane toolkit build from {sha}."
|
||||
metadata = {
|
||||
"tag_name": tag,
|
||||
"target_commitish": sha,
|
||||
"name": tag,
|
||||
"body": body,
|
||||
"prerelease": prerelease.lower() == "true",
|
||||
}
|
||||
try:
|
||||
release = request(f"{api}/repos/{repo}/releases", json.dumps(metadata).encode(), "application/json")
|
||||
except urllib.error.HTTPError as exc:
|
||||
sys.exit(f"release creation failed: HTTP {exc.code}")
|
||||
release_id = release["id"]
|
||||
for name in files:
|
||||
path = pathlib.Path(name)
|
||||
query = urllib.parse.urlencode({"name": path.name})
|
||||
try:
|
||||
request(f"{api}/repos/{repo}/releases/{release_id}/assets?{query}",
|
||||
path.read_bytes(), "application/octet-stream")
|
||||
except urllib.error.HTTPError as exc:
|
||||
sys.exit(f"asset upload failed for {path.name}: HTTP {exc.code}")
|
||||
print(f"Created {tag} with {len(files)} assets")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1 @@
|
||||
gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
|
||||
@@ -0,0 +1,55 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Check that every Toolkit benchmark contributes to the release badge."""
|
||||
|
||||
import importlib.util
|
||||
import re
|
||||
from pathlib import Path
|
||||
import unittest
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
spec = importlib.util.spec_from_file_location("bench_badge", ROOT / "ci/bench-badge.py")
|
||||
assert spec is not None and spec.loader is not None
|
||||
badge = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(badge)
|
||||
badge_spec = importlib.util.spec_from_file_location("gen_badges", ROOT / "ci/gen-badges.py")
|
||||
assert badge_spec is not None and badge_spec.loader is not None
|
||||
gen_badges = importlib.util.module_from_spec(badge_spec)
|
||||
badge_spec.loader.exec_module(gen_badges)
|
||||
|
||||
|
||||
class BenchBadgeTests(unittest.TestCase):
|
||||
def test_declared_suite_matches_rust_benchmarks(self):
|
||||
names = set()
|
||||
for directory in (ROOT / "crates/alkane-gui/src", ROOT / "crates/alkane-artifacts/src"):
|
||||
for path in directory.rglob("*.rs"):
|
||||
names.update(re.findall(
|
||||
r'#\[test\]\s*#\[ignore(?:\s*=\s*"[^"]*")?\]\s*'
|
||||
r'fn (bench_[A-Za-z0-9_]+)\s*\(', path.read_text()))
|
||||
self.assertEqual(names, badge.EXPECTED_BENCHES)
|
||||
|
||||
def test_incomplete_duplicate_and_malformed_results_fail(self):
|
||||
lines = [f"test tests::{name} ... {name}: 10ms/op"
|
||||
for name in sorted(badge.EXPECTED_BENCHES)]
|
||||
values = badge.require_suite(badge.parse_bench("\n".join(lines)))
|
||||
self.assertEqual(len(values), 12)
|
||||
with self.assertRaisesRegex(ValueError, "declared suite"):
|
||||
badge.require_suite(badge.parse_bench("\n".join(lines[:-1])))
|
||||
with self.assertRaisesRegex(ValueError, "duplicate"):
|
||||
badge.parse_bench("\n".join(lines + [lines[0]]))
|
||||
with self.assertRaisesRegex(ValueError, "missing timing"):
|
||||
badge.parse_bench(lines[0].replace("10ms/op", "missing"))
|
||||
|
||||
def test_badge_averages_each_benchmark_improvement(self):
|
||||
current = {"short": 50.0, "long": 900.0}
|
||||
baseline = {"short": 100.0, "long": 1000.0}
|
||||
self.assertEqual(badge.benchmark_delta(current, baseline), 30.0)
|
||||
self.assertAlmostEqual(badge.benchmark_delta(baseline, current), -55.5555556)
|
||||
self.assertIsNone(badge.benchmark_delta(current, {}))
|
||||
self.assertEqual(gen_badges.bench_color(30.0), "brightgreen")
|
||||
self.assertEqual(gen_badges.bench_color(-55.5555556), "orange")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,130 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Exercise benchmark history selection and safe site rendering."""
|
||||
|
||||
import sys
|
||||
import json
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from bench_history import (bench_badge, git_distance, previous_measurement, render_html,
|
||||
same_benchmark_inputs, updated_index)
|
||||
|
||||
|
||||
class HistoryTests(unittest.TestCase):
|
||||
def test_cargo_nocapture_benchmark_lines_are_parsed(self):
|
||||
output = (
|
||||
"test tests::bench_verify_artifact ... bench_verify_artifact: 208.302µs\n"
|
||||
"test model::tests::bench_render_cells ... bench_render_cells: "
|
||||
"5000 rows x 10 cols = 8.007185ms/full-render (bytes=13553600)\n"
|
||||
"bench_direct: 12ns/op\n"
|
||||
)
|
||||
self.assertEqual(bench_badge.parse_bench(output), {
|
||||
"bench_verify_artifact": 208_302.0,
|
||||
"bench_render_cells": 8_007_185.0,
|
||||
"bench_direct": 12.0,
|
||||
})
|
||||
|
||||
def test_retry_uses_previous_commit(self):
|
||||
first = "a" * 40
|
||||
second = "b" * 40
|
||||
index = {"schema": 1, "entries": [
|
||||
{"sha": first, "timestamp": "2026-01-01T00:00:00+00:00",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 10.0}}},
|
||||
{"sha": second, "timestamp": "2026-01-02T00:00:00+00:00",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 8.0}}}]}
|
||||
self.assertEqual(previous_measurement(index, second,
|
||||
lambda ancestor, sha: 1 if ancestor == first else None),
|
||||
{"hash": 10.0})
|
||||
updated = updated_index(index, second, {"bench_ns_per_op": {"hash": 7.5}},
|
||||
"2026-01-03T00:00:00+00:00")
|
||||
self.assertEqual(len(updated["entries"]), 2)
|
||||
self.assertEqual(updated["entries"][-1]["metrics"]["bench_ns_per_op"]["hash"], 7.5)
|
||||
|
||||
def test_invalid_measurement_and_sha_rejected(self):
|
||||
self.assertIsNone(git_distance("--bad", "a" * 40))
|
||||
with self.assertRaises(ValueError):
|
||||
updated_index({}, "bad", {"bench_ns_per_op": {"hash": 1}}, "now")
|
||||
with self.assertRaises(ValueError):
|
||||
updated_index({}, "a" * 40, {"bench_ns_per_op": {"hash": -1}}, "now")
|
||||
|
||||
def test_baseline_must_match_cpu_class(self):
|
||||
host = {"architecture": "x86_64", "cpu_model": "A", "logical_cpus": 8}
|
||||
other = {"architecture": "x86_64", "cpu_model": "B", "logical_cpus": 8}
|
||||
index = {"entries": [{"sha": "a" * 40, "metrics": {
|
||||
"bench_ns_per_op": {"hash": 10.0}, "bench_host": host}}]}
|
||||
distance = lambda _ancestor, _sha: 1
|
||||
self.assertEqual(previous_measurement(index, "b" * 40, distance, host),
|
||||
{"hash": 10.0})
|
||||
self.assertEqual(previous_measurement(index, "b" * 40, distance, other), {})
|
||||
|
||||
def test_routing_change_is_marked_same_inputs_but_code_or_build_change_is_not(self):
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-bench-inputs-") as directory:
|
||||
root = Path(directory)
|
||||
workflow = root / ".gitea/workflows/release.yml"
|
||||
workflow.parent.mkdir(parents=True)
|
||||
code = root / "crates/alkane-gui/src/main.rs"
|
||||
code.parent.mkdir(parents=True)
|
||||
code.write_text("fn main() {}\n")
|
||||
workflow.write_text(
|
||||
"jobs:\n release:\n runs-on: alkane-verify\n"
|
||||
" container:\n image: pinned-image\n"
|
||||
" env:\n RUSTFLAGS: stable\n steps:\n"
|
||||
" - name: Build release\n run: cargo build --release\n"
|
||||
" - name: Microbenchmarks\n run: cargo test --release bench_\n")
|
||||
|
||||
def git(*args):
|
||||
return subprocess.check_output(("git", "-C", str(root), *args),
|
||||
text=True, stderr=subprocess.DEVNULL).strip()
|
||||
|
||||
git("init", "-q")
|
||||
git("config", "user.name", "CI Test")
|
||||
git("config", "user.email", "ci@example.invalid")
|
||||
git("add", ".")
|
||||
git("commit", "-qm", "base")
|
||||
base = git("rev-parse", "HEAD")
|
||||
workflow.write_text(workflow.read_text().replace("alkane-verify", "alkane-ci"))
|
||||
git("commit", "-qam", "route")
|
||||
route = git("rev-parse", "HEAD")
|
||||
self.assertTrue(same_benchmark_inputs(base, route, root))
|
||||
code.write_text("fn main() { println!(\"changed\"); }\n")
|
||||
git("commit", "-qam", "code")
|
||||
changed_code = git("rev-parse", "HEAD")
|
||||
self.assertFalse(same_benchmark_inputs(route, changed_code, root))
|
||||
workflow.write_text(workflow.read_text().replace("RUSTFLAGS: stable", "RUSTFLAGS: tuned"))
|
||||
git("commit", "-qam", "flags")
|
||||
flags = git("rev-parse", "HEAD")
|
||||
self.assertFalse(same_benchmark_inputs(changed_code, flags, root))
|
||||
|
||||
def test_badge_keeps_raw_delta_and_marks_identical_inputs(self):
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-bench-badge-context-") as directory:
|
||||
root = Path(directory)
|
||||
badges = root / "badges"
|
||||
badges.mkdir()
|
||||
(badges / "bench-context.json").write_text(
|
||||
json.dumps({"schema": 1, "same_inputs": True, "baseline_sha": "a" * 40}))
|
||||
command = (sys.executable, str(Path(__file__).with_name("gen-badges.py")),
|
||||
"--root", str(root), "--bench-delta=-36.4")
|
||||
subprocess.run(command, check=True, capture_output=True)
|
||||
self.assertIn("-36.4% same inputs", (badges / "bench.svg").read_text())
|
||||
(badges / "bench-context.json").unlink()
|
||||
subprocess.run(command, check=True, capture_output=True)
|
||||
self.assertIn("-36.4% vs prev", (badges / "bench.svg").read_text())
|
||||
|
||||
def test_site_escapes_history_content(self):
|
||||
entry = {"sha": "a" * 40, "timestamp": "<script>alert(1)</script>",
|
||||
"metrics": {"bench_ns_per_op": {"hash": 10.0},
|
||||
"bench_host": {"cpu_model": "<script>cpu</script>"},
|
||||
"bench_context": {"schema": 1, "same_inputs": True}}}
|
||||
page = render_html({"entries": [entry]})
|
||||
self.assertIn("<script>", page)
|
||||
self.assertNotIn("<script>", page)
|
||||
self.assertIn("10.000", page)
|
||||
self.assertIn("same inputs", page)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Check that queued CI runs do not displace the last completed result."""
|
||||
|
||||
import importlib.util
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch
|
||||
import xml.etree.ElementTree as ET
|
||||
|
||||
path = Path(__file__).with_name("last-attempt-badge.py")
|
||||
spec = importlib.util.spec_from_file_location("last_attempt_badge", path)
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
|
||||
|
||||
def runs(_url, _token):
|
||||
return {"workflow_runs": [
|
||||
{"id": 105, "head_branch": "main", "status": "completed", "conclusion": "cancelled"},
|
||||
{"id": 104, "head_branch": "main", "status": "queued", "conclusion": None},
|
||||
{"id": 103, "head_branch": "main", "status": "completed", "conclusion": "failure"},
|
||||
{"id": 102, "head_branch": "main", "status": "completed", "conclusion": "success"},
|
||||
]}
|
||||
|
||||
|
||||
with patch.object(module, "request_json", runs):
|
||||
assert module.latest_completed("https://example.invalid/api/v1", "owner/repo",
|
||||
"release.yml", "main", "token") == (103, "failure")
|
||||
|
||||
svg = module.badge("main", "failure", 103)
|
||||
root = ET.fromstring(svg)
|
||||
assert root.attrib["aria-label"] == "CI main: last completed attempt fail (run 103)"
|
||||
assert b">fail</text>" in svg
|
||||
assert b"#d1242f" in svg
|
||||
assert b">pass</text>" in module.badge("next", "success", 108)
|
||||
print("last completed CI badge: queued run ignored, pass/fail SVGs valid")
|
||||
@@ -0,0 +1,193 @@
|
||||
#!/usr/bin/env python3
|
||||
# SPDX-License-Identifier: MIT
|
||||
"""Check that unknown changes cannot take a scoped CI path."""
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import subprocess
|
||||
import tempfile
|
||||
|
||||
import importlib.util
|
||||
import yaml
|
||||
|
||||
|
||||
SCRIPT = Path(__file__).with_name("pr-surface.py")
|
||||
ROOT = SCRIPT.parents[1]
|
||||
spec = importlib.util.spec_from_file_location("pr_surface", SCRIPT)
|
||||
assert spec and spec.loader
|
||||
pr_surface = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(pr_surface)
|
||||
|
||||
|
||||
def git(directory: Path, *args: str) -> str:
|
||||
return subprocess.check_output(
|
||||
["git", "-C", str(directory), *args], text=True,
|
||||
stderr=subprocess.DEVNULL,
|
||||
).strip()
|
||||
|
||||
|
||||
def check_workflow_contract() -> None:
|
||||
"""Keep the short workflow check from silently dropping release gates."""
|
||||
required = {
|
||||
"release.yml": ("main", "release", (
|
||||
"Check runner image pins", "Clippy (our crate, warnings are errors)",
|
||||
"Build release", "Unit tests", "Microbenchmarks",
|
||||
"Headless UI self-test", "Coverage", "Microbenchmark coverage",
|
||||
"Generate measured badges", "Publish measured badges",
|
||||
"Record private benchmark history", "Create Gitea release + upload artifact",
|
||||
"Clean generated Toolkit build",
|
||||
)),
|
||||
"next.yml": ("next", "candidate", (
|
||||
"Check runner image pins", "Build release candidate",
|
||||
"Create private prerelease", "Clean generated Toolkit build",
|
||||
)),
|
||||
"verify.yml": ("main", "verify", (
|
||||
"Check runner image pins", "Detect changed surface",
|
||||
"Check CI change surface", "Check workflow-only change",
|
||||
"Clippy (our crate, warnings are errors)", "Build", "Unit tests",
|
||||
"Microbenchmarks", "Headless UI self-test", "Clean generated Toolkit build",
|
||||
)),
|
||||
}
|
||||
for filename, (branch, job_name, gates) in required.items():
|
||||
path = ROOT / ".gitea/workflows" / filename
|
||||
workflow = yaml.load(path.read_text(), Loader=yaml.BaseLoader)
|
||||
event = "pull_request" if filename == "verify.yml" else "push"
|
||||
assert workflow["on"][event]["branches"] == [branch], path
|
||||
job = workflow["jobs"][job_name]
|
||||
assert job["runs-on"] in {"alkane-ci", "alkane-verify"}, path
|
||||
steps = job["steps"]
|
||||
names = [step.get("name") for step in steps]
|
||||
positions = [names.index(gate) for gate in gates]
|
||||
assert positions == sorted(positions), path
|
||||
assert steps[positions[-1]].get("if") == "always()", path
|
||||
for gate, position in zip(gates[:-1], positions[:-1]):
|
||||
condition = steps[position].get("if")
|
||||
if gate in {"Create Gitea release + upload artifact",
|
||||
"Create private prerelease"}:
|
||||
assert condition is not None and "release == 'true'" in condition, path
|
||||
elif filename == "verify.yml" and gate in {
|
||||
"Build", "Unit tests", "Microbenchmarks",
|
||||
"Clippy (our crate, warnings are errors)",
|
||||
"Headless UI self-test"}:
|
||||
assert condition == "steps.surface.outputs.surface == 'full'", path
|
||||
elif filename == "verify.yml" and gate == "Check CI change surface":
|
||||
assert condition == "steps.surface.outputs.surface != 'documentation'", path
|
||||
elif filename == "verify.yml" and gate == "Check workflow-only change":
|
||||
assert condition == "steps.surface.outputs.surface == 'workflow'", path
|
||||
else:
|
||||
assert condition is None, path
|
||||
|
||||
|
||||
def main() -> None:
|
||||
check_workflow_contract()
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-toolkit-workflow-policy-") as directory:
|
||||
global ROOT
|
||||
saved_root = ROOT
|
||||
ROOT = Path(directory)
|
||||
(ROOT / ".gitea/workflows").mkdir(parents=True)
|
||||
for filename in ("release.yml", "next.yml", "verify.yml"):
|
||||
shutil.copyfile(saved_root / ".gitea/workflows" / filename,
|
||||
ROOT / ".gitea/workflows" / filename)
|
||||
release = ROOT / ".gitea/workflows/release.yml"
|
||||
original = release.read_text()
|
||||
release.write_text(original.replace("- name: Coverage", "- name: Skipped coverage", 1))
|
||||
try:
|
||||
check_workflow_contract()
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
raise AssertionError("removing the coverage gate passed workflow policy")
|
||||
ROOT = saved_root
|
||||
assert pr_surface.documentation_only(["README.md", "docs/setup.md"])
|
||||
assert pr_surface.workflow_only([".gitea/workflows/release.yml"])
|
||||
for paths in ([], ["ci/pr-surface.py"], ["ci/coverage.sh"],
|
||||
["ci/check-runner-image.py"],
|
||||
[".gitea/workflows/release.yml", "ci/check-runner-image.py"],
|
||||
[".gitea/workflows/release.yml", "crates/alkane-gui/src/main.rs"],
|
||||
[".gitea/workflows/../release.yml"]):
|
||||
assert not pr_surface.workflow_only(paths), paths
|
||||
for paths in ([], ["docs/generated.json"], ["src/main.rs"],
|
||||
["README.md", "ci/pr-surface.py"]):
|
||||
assert not pr_surface.documentation_only(paths), paths
|
||||
assert pr_surface.headless_packages(["crates/alkane-cli/src/main.rs"]) == ["alkane-cli"]
|
||||
assert pr_surface.headless_packages(["crates/alkane-artifacts/src/lib.rs"]) == [
|
||||
"alkane-artifacts", "alkane-cli", "alkane-flash",
|
||||
]
|
||||
assert pr_surface.headless_packages([
|
||||
"crates/alkane-access/src/lib.rs", "crates/alkane-flash/tests/update.rs",
|
||||
]) == ["alkane-access", "alkane-flash"]
|
||||
for paths in ([], ["crates/alkane-core/src/lib.rs"],
|
||||
["crates/alkane-discovery/src/lib.rs"],
|
||||
["crates/alkane-gui/src/main.rs"],
|
||||
["crates/alkane-artifacts/Cargo.toml"],
|
||||
["crates/alkane-cli/src/main.rs", "Cargo.lock"],
|
||||
["crates/alkane-cli/src/main.rs", "ci/pr-surface.py"],
|
||||
["crates/alkane-cli/README.md"]):
|
||||
assert pr_surface.headless_packages(paths) == [], paths
|
||||
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-toolkit-graph-") as directory:
|
||||
root = Path(directory)
|
||||
for name, extra in (
|
||||
("alkane-gui", ""),
|
||||
("alkane-artifacts", ""),
|
||||
("alkane-flash", 'alkane-artifacts = { path = "../alkane-artifacts" }\n'),
|
||||
):
|
||||
crate = root / "crates" / name
|
||||
crate.mkdir(parents=True)
|
||||
(crate / "Cargo.toml").write_text(
|
||||
f'[package]\nname = "{name}"\nversion = "0.1.0"\n'
|
||||
f'[dependencies]\n{extra}'
|
||||
)
|
||||
saved_root = pr_surface.ROOT
|
||||
try:
|
||||
pr_surface.ROOT = root
|
||||
changed = ["crates/alkane-artifacts/src/lib.rs"]
|
||||
assert pr_surface.headless_packages(changed) == [
|
||||
"alkane-artifacts", "alkane-flash",
|
||||
]
|
||||
with (root / "crates/alkane-gui/Cargo.toml").open("a") as stream:
|
||||
stream.write('alkane-flash = { path = "../alkane-flash" }\n')
|
||||
assert pr_surface.headless_packages(changed) == []
|
||||
finally:
|
||||
pr_surface.ROOT = saved_root
|
||||
|
||||
with tempfile.TemporaryDirectory(prefix="alkane-toolkit-pr-surface-") as directory:
|
||||
repo = Path(directory)
|
||||
git(repo, "init", "-q")
|
||||
git(repo, "config", "user.name", "CI Test")
|
||||
git(repo, "config", "user.email", "ci@example.invalid")
|
||||
(repo / "README.md").write_text("initial\n")
|
||||
git(repo, "add", "README.md")
|
||||
git(repo, "commit", "-qm", "base")
|
||||
base = git(repo, "rev-parse", "HEAD")
|
||||
git(repo, "update-ref", "refs/remotes/origin/main", base)
|
||||
(repo / "README.md").write_text("documentation change\n")
|
||||
git(repo, "commit", "-qam", "docs")
|
||||
saved_root = pr_surface.ROOT
|
||||
saved_env = dict(os.environ)
|
||||
try:
|
||||
pr_surface.ROOT = repo
|
||||
os.environ["GITHUB_EVENT_NAME"] = "pull_request"
|
||||
os.environ["GITHUB_BASE_REF"] = "main"
|
||||
assert pr_surface.changed_paths() == ["README.md"]
|
||||
git(repo, "checkout", "-q", "-b", "rename-check", base)
|
||||
git(repo, "mv", "README.md", "code.rs")
|
||||
git(repo, "commit", "-qm", "rename")
|
||||
assert set(pr_surface.changed_paths()) == {"README.md", "code.rs"}
|
||||
os.environ.pop("GITHUB_BASE_REF")
|
||||
try:
|
||||
pr_surface.changed_paths()
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
raise AssertionError("missing base must fall back to full checks")
|
||||
finally:
|
||||
pr_surface.ROOT = saved_root
|
||||
os.environ.clear()
|
||||
os.environ.update(saved_env)
|
||||
print("Toolkit PR change surface: documentation, workflow, headless, and fallback PASS")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
# Key the native wxWidgets prefix to its tracked source and build toolchain.
|
||||
set -euo pipefail
|
||||
|
||||
material="$({
|
||||
git rev-parse HEAD:thirdparty/wxwidgets/wxWidgets-3.3.3
|
||||
git rev-parse HEAD:scripts/build-wx-linux.sh
|
||||
cat thirdparty/wx-rs/VERSION
|
||||
gcc -dumpmachine
|
||||
gcc -dumpfullversion
|
||||
pkg-config --modversion gtk+-3.0
|
||||
mapfile -t modules < <(pkg-config --list-all | awk '{print $1}' | LC_ALL=C sort -u)
|
||||
for module in "${modules[@]}"; do
|
||||
printf '%s=%s\n' "$module" "$(pkg-config --modversion "$module" 2>/dev/null || printf unavailable)"
|
||||
done
|
||||
getconf GNU_LIBC_VERSION
|
||||
} )"
|
||||
digest="$(printf '%s\n' "$material" | sha256sum | cut -c1-24)"
|
||||
key="wx-3.3.3-$digest"
|
||||
if [ -n "${GITHUB_OUTPUT:-}" ]; then
|
||||
printf 'key=%s\n' "$key" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
printf '%s\n' "$key"
|
||||
fi
|
||||
@@ -1 +1,219 @@
|
||||
// alkane-access
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Bounded, read-only SSH probes for board identification.
|
||||
|
||||
use std::fs;
|
||||
use std::io::{self, Read};
|
||||
use std::net::IpAddr;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::process::{Command, Stdio};
|
||||
use std::thread;
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
const MAX_PROBE_BYTES: usize = 64 * 1024;
|
||||
const PROBE_TIMEOUT: Duration = Duration::from_secs(12);
|
||||
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum Probe {
|
||||
KernelRelease,
|
||||
MtdTable,
|
||||
DeviceTreeModel,
|
||||
}
|
||||
|
||||
impl Probe {
|
||||
fn command(self) -> &'static str {
|
||||
match self {
|
||||
Self::KernelRelease => "uname -r",
|
||||
Self::MtdTable => "cat /proc/mtd",
|
||||
Self::DeviceTreeModel => "cat /proc/device-tree/model",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum AccessError {
|
||||
InvalidTarget,
|
||||
InvalidKnownHosts,
|
||||
Timeout,
|
||||
OutputTooLarge,
|
||||
RemoteFailure,
|
||||
Io(io::Error),
|
||||
}
|
||||
|
||||
impl From<io::Error> for AccessError {
|
||||
fn from(error: io::Error) -> Self {
|
||||
Self::Io(error)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct SshTarget {
|
||||
address: IpAddr,
|
||||
port: u16,
|
||||
user: String,
|
||||
known_hosts: PathBuf,
|
||||
}
|
||||
|
||||
impl SshTarget {
|
||||
pub fn new(
|
||||
address: IpAddr,
|
||||
port: u16,
|
||||
user: &str,
|
||||
known_hosts: &Path,
|
||||
) -> Result<Self, AccessError> {
|
||||
if port == 0
|
||||
|| user.is_empty()
|
||||
|| !user
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'_' | b'-' | b'.'))
|
||||
{
|
||||
return Err(AccessError::InvalidTarget);
|
||||
}
|
||||
if !known_hosts.is_absolute()
|
||||
|| !fs::metadata(known_hosts).is_ok_and(|metadata| metadata.is_file())
|
||||
{
|
||||
return Err(AccessError::InvalidKnownHosts);
|
||||
}
|
||||
Ok(Self {
|
||||
address,
|
||||
port,
|
||||
user: user.to_owned(),
|
||||
known_hosts: known_hosts.to_owned(),
|
||||
})
|
||||
}
|
||||
|
||||
fn command(&self, probe: Probe) -> Command {
|
||||
let mut command = Command::new("ssh");
|
||||
command
|
||||
.arg("-F")
|
||||
.arg("none")
|
||||
.arg("-o")
|
||||
.arg("BatchMode=yes")
|
||||
.arg("-o")
|
||||
.arg("StrictHostKeyChecking=yes")
|
||||
.arg("-o")
|
||||
.arg("GlobalKnownHostsFile=none")
|
||||
.arg("-o")
|
||||
.arg(format!("UserKnownHostsFile={}", self.known_hosts.display()))
|
||||
.arg("-o")
|
||||
.arg("ConnectTimeout=5")
|
||||
.arg("-o")
|
||||
.arg("ServerAliveInterval=5")
|
||||
.arg("-o")
|
||||
.arg("ServerAliveCountMax=1")
|
||||
.arg("-o")
|
||||
.arg("RequestTTY=no")
|
||||
.arg("-p")
|
||||
.arg(self.port.to_string())
|
||||
.arg(format!("{}@{}", self.user, self.address))
|
||||
.arg(probe.command());
|
||||
command
|
||||
}
|
||||
|
||||
pub fn probe(&self, probe: Probe) -> Result<Vec<u8>, AccessError> {
|
||||
run_bounded(self.command(probe))
|
||||
}
|
||||
}
|
||||
|
||||
fn collect_bounded<R: Read + Send + 'static>(
|
||||
mut reader: R,
|
||||
) -> thread::JoinHandle<Result<Vec<u8>, AccessError>> {
|
||||
thread::spawn(move || {
|
||||
let mut data = Vec::new();
|
||||
let mut chunk = [0_u8; 4096];
|
||||
loop {
|
||||
let count = reader.read(&mut chunk)?;
|
||||
if count == 0 {
|
||||
return Ok(data);
|
||||
}
|
||||
if data.len() + count > MAX_PROBE_BYTES {
|
||||
return Err(AccessError::OutputTooLarge);
|
||||
}
|
||||
data.extend_from_slice(&chunk[..count]);
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn run_bounded(command: Command) -> Result<Vec<u8>, AccessError> {
|
||||
run_bounded_with_timeout(command, PROBE_TIMEOUT)
|
||||
}
|
||||
|
||||
fn run_bounded_with_timeout(
|
||||
mut command: Command,
|
||||
timeout: Duration,
|
||||
) -> Result<Vec<u8>, AccessError> {
|
||||
command
|
||||
.stdin(Stdio::null())
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::piped());
|
||||
let mut child = command.spawn()?;
|
||||
let stdout = collect_bounded(child.stdout.take().expect("piped stdout"));
|
||||
let stderr = collect_bounded(child.stderr.take().expect("piped stderr"));
|
||||
let deadline = Instant::now() + timeout;
|
||||
let result = loop {
|
||||
if let Some(status) = child.try_wait()? {
|
||||
break status.success();
|
||||
}
|
||||
if Instant::now() >= deadline {
|
||||
let _ = child.kill();
|
||||
let _ = child.wait();
|
||||
let _ = stdout.join();
|
||||
let _ = stderr.join();
|
||||
return Err(AccessError::Timeout);
|
||||
}
|
||||
thread::sleep(Duration::from_millis(10));
|
||||
};
|
||||
let output = stdout.join().map_err(|_| AccessError::RemoteFailure)??;
|
||||
let error_output = stderr.join().map_err(|_| AccessError::RemoteFailure)??;
|
||||
if !result || !error_output.is_empty() {
|
||||
return Err(AccessError::RemoteFailure);
|
||||
}
|
||||
Ok(output)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn target_rejects_injected_user_and_unknown_host_file() {
|
||||
let address = "127.0.0.1".parse().unwrap();
|
||||
assert!(matches!(
|
||||
SshTarget::new(
|
||||
address,
|
||||
22,
|
||||
"root;id",
|
||||
Path::new("/etc/ssh/ssh_known_hosts")
|
||||
),
|
||||
Err(AccessError::InvalidTarget)
|
||||
));
|
||||
assert!(matches!(
|
||||
SshTarget::new(address, 22, "root", Path::new("relative-known-hosts")),
|
||||
Err(AccessError::InvalidKnownHosts)
|
||||
));
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn bounded_runner_rejects_excess_output_and_failed_command() {
|
||||
let mut success = Command::new("/bin/sh");
|
||||
success.args(["-c", "printf board"]);
|
||||
assert_eq!(run_bounded(success).unwrap(), b"board");
|
||||
let mut overflow = Command::new("/bin/sh");
|
||||
overflow.args(["-c", "head -c 70000 /dev/zero"]);
|
||||
assert!(matches!(
|
||||
run_bounded(overflow),
|
||||
Err(AccessError::OutputTooLarge)
|
||||
));
|
||||
let mut failed = Command::new("/bin/sh");
|
||||
failed.args(["-c", "exit 7"]);
|
||||
assert!(matches!(
|
||||
run_bounded(failed),
|
||||
Err(AccessError::RemoteFailure)
|
||||
));
|
||||
let mut hanging = Command::new("/bin/sleep");
|
||||
hanging.arg("1");
|
||||
assert!(matches!(
|
||||
run_bounded_with_timeout(hanging, Duration::from_millis(20)),
|
||||
Err(AccessError::Timeout)
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,5 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
sha2.workspace = true
|
||||
thiserror.workspace = true
|
||||
|
||||
@@ -1 +1,257 @@
|
||||
// alkane-artifacts
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Verify local firmware artifacts before an install path consumes them.
|
||||
|
||||
use sha2::{Digest, Sha256};
|
||||
use std::collections::HashSet;
|
||||
use std::fs::File;
|
||||
use std::io::{Read, Seek, SeekFrom};
|
||||
use std::path::{Component, Path, PathBuf};
|
||||
use thiserror::Error;
|
||||
|
||||
const SEED: &str = include_str!("../data/manifest-seed.csv");
|
||||
const HEADER: &str = "sha256,size_bytes,path,family,format,applicability";
|
||||
|
||||
#[derive(Clone, Debug, Eq, PartialEq)]
|
||||
pub struct ArtifactRecord {
|
||||
pub sha256: String,
|
||||
pub size_bytes: u64,
|
||||
pub path: PathBuf,
|
||||
pub family: String,
|
||||
pub format: String,
|
||||
pub applicability: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Error)]
|
||||
pub enum VerifyError {
|
||||
#[error("artifact I/O: {0}")]
|
||||
Io(#[from] std::io::Error),
|
||||
#[error("manifest line {0} is invalid")]
|
||||
Manifest(usize),
|
||||
#[error("artifact size differs from manifest")]
|
||||
Size,
|
||||
#[error("artifact signature does not match its declared format")]
|
||||
Signature,
|
||||
#[error("artifact SHA-256 differs from manifest")]
|
||||
Digest,
|
||||
#[error("artifact format is not recognized")]
|
||||
UnsupportedFormat,
|
||||
}
|
||||
|
||||
/// A verified, rewound descriptor. Consumers should read this descriptor
|
||||
/// directly instead of reopening the path after verification.
|
||||
pub struct VerifiedArtifact {
|
||||
file: File,
|
||||
record: ArtifactRecord,
|
||||
}
|
||||
|
||||
impl VerifiedArtifact {
|
||||
pub fn record(&self) -> &ArtifactRecord {
|
||||
&self.record
|
||||
}
|
||||
|
||||
pub fn reader(&mut self) -> &mut File {
|
||||
&mut self.file
|
||||
}
|
||||
|
||||
/// Recheck the same descriptor immediately before a guarded write.
|
||||
pub fn revalidate(&mut self) -> Result<(), VerifyError> {
|
||||
verify_open_file(&mut self.file, &self.record)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn seed_manifest() -> Result<Vec<ArtifactRecord>, VerifyError> {
|
||||
parse_manifest(SEED)
|
||||
}
|
||||
|
||||
pub fn parse_manifest(text: &str) -> Result<Vec<ArtifactRecord>, VerifyError> {
|
||||
let mut lines = text.lines();
|
||||
if lines.next() != Some(HEADER) {
|
||||
return Err(VerifyError::Manifest(1));
|
||||
}
|
||||
let mut paths = HashSet::new();
|
||||
let mut records = Vec::new();
|
||||
for (line_number, line) in lines.enumerate() {
|
||||
let line_number = line_number + 2;
|
||||
let parts: Vec<_> = line.splitn(6, ',').collect();
|
||||
if parts.len() != 6 || parts.iter().any(|part| part.trim().is_empty()) {
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
let digest = parts[0];
|
||||
let path = PathBuf::from(parts[2]);
|
||||
if digest.len() != 64
|
||||
|| !digest.bytes().all(|byte| byte.is_ascii_hexdigit())
|
||||
|| !path
|
||||
.components()
|
||||
.all(|part| matches!(part, Component::Normal(_)))
|
||||
|| !paths.insert(path.clone())
|
||||
{
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
let size_bytes = parts[1]
|
||||
.parse::<u64>()
|
||||
.map_err(|_| VerifyError::Manifest(line_number))?;
|
||||
if size_bytes == 0 {
|
||||
return Err(VerifyError::Manifest(line_number));
|
||||
}
|
||||
records.push(ArtifactRecord {
|
||||
sha256: digest.to_ascii_lowercase(),
|
||||
size_bytes,
|
||||
path,
|
||||
family: parts[3].to_owned(),
|
||||
format: parts[4].to_owned(),
|
||||
applicability: parts[5].to_owned(),
|
||||
});
|
||||
}
|
||||
if records.is_empty() {
|
||||
return Err(VerifyError::Manifest(1));
|
||||
}
|
||||
Ok(records)
|
||||
}
|
||||
|
||||
fn signature_matches(format: &str, first: &[u8]) -> Result<bool, VerifyError> {
|
||||
let prefix: &[u8] = match format {
|
||||
"IMAGEWTY-SD" | "update-zip" | "zip-installer" => b"PK\x03\x04",
|
||||
"ubifs" => b"\x31\x18\x10\x06",
|
||||
"swu" => b"070702",
|
||||
"wm-package-0x9a5ba57c" => b"\x7c\xa5\x5b\x9a",
|
||||
"bmu" => b"\x26\x01",
|
||||
"bin-AES-container" => b"\x3f\x0a\x64\xae",
|
||||
_ => return Err(VerifyError::UnsupportedFormat),
|
||||
};
|
||||
Ok(first.starts_with(prefix))
|
||||
}
|
||||
|
||||
pub fn verify_file(path: &Path, record: &ArtifactRecord) -> Result<VerifiedArtifact, VerifyError> {
|
||||
let mut file = File::open(path)?;
|
||||
verify_open_file(&mut file, record)?;
|
||||
Ok(VerifiedArtifact {
|
||||
file,
|
||||
record: record.clone(),
|
||||
})
|
||||
}
|
||||
|
||||
fn verify_open_file(file: &mut File, record: &ArtifactRecord) -> Result<(), VerifyError> {
|
||||
if file.metadata()?.len() != record.size_bytes {
|
||||
return Err(VerifyError::Size);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
let mut first = [0_u8; 16];
|
||||
let length = file.read(&mut first)?;
|
||||
if !signature_matches(&record.format, &first[..length])? {
|
||||
return Err(VerifyError::Signature);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
let mut hasher = Sha256::new();
|
||||
let mut buffer = [0_u8; 64 * 1024];
|
||||
let mut read_bytes = 0_u64;
|
||||
loop {
|
||||
let length = file.read(&mut buffer)?;
|
||||
if length == 0 {
|
||||
break;
|
||||
}
|
||||
read_bytes += length as u64;
|
||||
hasher.update(&buffer[..length]);
|
||||
}
|
||||
if read_bytes != record.size_bytes {
|
||||
return Err(VerifyError::Size);
|
||||
}
|
||||
let digest = hasher.finalize();
|
||||
let actual: String = digest.iter().map(|byte| format!("{byte:02x}")).collect();
|
||||
if actual != record.sha256 {
|
||||
return Err(VerifyError::Digest);
|
||||
}
|
||||
file.seek(SeekFrom::Start(0))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::io::Write;
|
||||
|
||||
#[test]
|
||||
fn manifest_has_unique_safe_records() {
|
||||
let records = seed_manifest().unwrap();
|
||||
assert_eq!(records.len(), 14);
|
||||
let traversal = format!("{HEADER}\n{},12,../escape,bin,bmu,all\n", "0".repeat(64));
|
||||
assert!(matches!(
|
||||
parse_manifest(&traversal),
|
||||
Err(VerifyError::Manifest(2))
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn checks_size_signature_and_digest_before_consumption() {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-artifact-test-{}", std::process::id()));
|
||||
let bytes = b"PK\x03\x04example";
|
||||
let mut file = File::create(&path).unwrap();
|
||||
file.write_all(bytes).unwrap();
|
||||
drop(file);
|
||||
let mut record = ArtifactRecord {
|
||||
sha256: Sha256::digest(bytes)
|
||||
.iter()
|
||||
.map(|byte| format!("{byte:02x}"))
|
||||
.collect(),
|
||||
size_bytes: bytes.len() as u64,
|
||||
path: PathBuf::from("fixture.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let mut verified = verify_file(&path, &record).unwrap();
|
||||
verified.revalidate().unwrap();
|
||||
let mut replay = Vec::new();
|
||||
verified.reader().read_to_end(&mut replay).unwrap();
|
||||
assert_eq!(replay, bytes);
|
||||
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
|
||||
assert!(matches!(verified.revalidate(), Err(VerifyError::Digest)));
|
||||
std::fs::write(&path, bytes).unwrap();
|
||||
verified.revalidate().unwrap();
|
||||
record.size_bytes += 1;
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Size)
|
||||
));
|
||||
record.size_bytes -= 1;
|
||||
record.format = "ubifs".to_owned();
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Signature)
|
||||
));
|
||||
record.format = "update-zip".to_owned();
|
||||
record.sha256 = "0".repeat(64);
|
||||
assert!(matches!(
|
||||
verify_file(&path, &record),
|
||||
Err(VerifyError::Digest)
|
||||
));
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "microbenchmark"]
|
||||
fn bench_verify_artifact() {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-artifact-bench-{}", std::process::id()));
|
||||
let mut bytes = vec![0x42_u8; 65_536];
|
||||
bytes[..4].copy_from_slice(b"PK\x03\x04");
|
||||
std::fs::write(&path, &bytes).unwrap();
|
||||
let record = ArtifactRecord {
|
||||
sha256: Sha256::digest(&bytes)
|
||||
.iter()
|
||||
.map(|byte| format!("{byte:02x}"))
|
||||
.collect(),
|
||||
size_bytes: bytes.len() as u64,
|
||||
path: PathBuf::from("bench.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let started = std::time::Instant::now();
|
||||
for _ in 0..100 {
|
||||
std::hint::black_box(verify_file(&path, &record).unwrap());
|
||||
}
|
||||
println!("bench_verify_artifact: {:?}", started.elapsed() / 100);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,4 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
alkane-artifacts = { path = "../alkane-artifacts" }
|
||||
|
||||
@@ -1,4 +1,31 @@
|
||||
//! Headless driver over the same engine the GUI uses.
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Headless entry point for read-only artifact verification.
|
||||
|
||||
use alkane_artifacts::{seed_manifest, verify_file};
|
||||
use std::path::Path;
|
||||
|
||||
fn run() -> Result<(), Box<dyn std::error::Error>> {
|
||||
let args: Vec<_> = std::env::args().collect();
|
||||
if args.len() != 4 || args[1] != "verify-artifact" {
|
||||
return Err("usage: alkane-cli verify-artifact <manifest-path> <local-file>".into());
|
||||
}
|
||||
let record = seed_manifest()?
|
||||
.into_iter()
|
||||
.find(|item| item.path == Path::new(&args[2]))
|
||||
.ok_or("artifact path is absent from the seed manifest")?;
|
||||
let verified = verify_file(Path::new(&args[3]), &record)?;
|
||||
println!(
|
||||
"verified {} {} {} bytes",
|
||||
verified.record().family,
|
||||
verified.record().format,
|
||||
verified.record().size_bytes
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() {
|
||||
println!("alkane-toolkit-cli: scaffold");
|
||||
if let Err(error) = run() {
|
||||
eprintln!("artifact verification failed: {error}");
|
||||
std::process::exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,3 +6,7 @@ license.workspace = true
|
||||
|
||||
[dependencies]
|
||||
alkane-core = { path = "../alkane-core" }
|
||||
alkane-artifacts = { path = "../alkane-artifacts" }
|
||||
sha2.workspace = true
|
||||
thiserror.workspace = true
|
||||
tempfile = "3"
|
||||
|
||||
@@ -1 +1,446 @@
|
||||
// alkane-flash
|
||||
// SPDX-License-Identifier: MIT
|
||||
//! Guarded write sequence for a verified artifact and an SDK partition plan.
|
||||
//! Board transport adapters must supply serial, recovery and readback evidence.
|
||||
|
||||
use alkane_artifacts::VerifiedArtifact;
|
||||
use sha2::{Digest, Sha256};
|
||||
use std::io::{Read, Seek, SeekFrom, Write};
|
||||
use thiserror::Error;
|
||||
|
||||
pub struct PartitionSpec {
|
||||
pub name: String,
|
||||
pub capacity_bytes: u64,
|
||||
pub secure: bool,
|
||||
pub boot_critical: bool,
|
||||
}
|
||||
|
||||
pub struct BackupEvidence {
|
||||
pub location: String,
|
||||
pub bytes: u64,
|
||||
pub sha256: [u8; 32],
|
||||
}
|
||||
|
||||
pub struct WriteReceipt {
|
||||
pub partition: String,
|
||||
pub backup: BackupEvidence,
|
||||
pub image_sha256: [u8; 32],
|
||||
}
|
||||
|
||||
pub trait Writer {
|
||||
type Error: std::fmt::Display;
|
||||
|
||||
fn channel_id(&self) -> &str;
|
||||
fn serial_console_attached(&mut self) -> Result<bool, Self::Error>;
|
||||
fn recovery_image_ready(&mut self, partition: &PartitionSpec) -> Result<bool, Self::Error>;
|
||||
fn backup(&mut self, partition: &PartitionSpec) -> Result<BackupEvidence, Self::Error>;
|
||||
fn write(
|
||||
&mut self,
|
||||
partition: &PartitionSpec,
|
||||
image: &mut dyn Read,
|
||||
image_size: u64,
|
||||
) -> Result<(), Self::Error>;
|
||||
}
|
||||
|
||||
pub trait IndependentReadback {
|
||||
type Error: std::fmt::Display;
|
||||
|
||||
fn channel_id(&self) -> &str;
|
||||
fn sha256(&mut self, partition: &PartitionSpec, length: u64) -> Result<[u8; 32], Self::Error>;
|
||||
}
|
||||
|
||||
#[derive(Debug, Error, Eq, PartialEq)]
|
||||
pub enum FlashError {
|
||||
#[error("secure partition write refused")]
|
||||
SecurePartition,
|
||||
#[error("image exceeds partition capacity")]
|
||||
ImageTooLarge,
|
||||
#[error("boot-critical write requires an attached serial console")]
|
||||
SerialRequired,
|
||||
#[error("boot-critical write requires verified recovery media")]
|
||||
RecoveryRequired,
|
||||
#[error("readback must use an independent channel")]
|
||||
SameChannel,
|
||||
#[error("complete backup evidence is missing")]
|
||||
BackupIncomplete,
|
||||
#[error("post-write readback differs from the image")]
|
||||
ReadbackMismatch,
|
||||
#[error("verified image has an invalid digest")]
|
||||
InvalidDigest,
|
||||
#[error("image changed since verification")]
|
||||
ArtifactChanged,
|
||||
#[error("writer did not consume the complete image")]
|
||||
IncompleteWrite,
|
||||
#[error("write transport: {0}")]
|
||||
Write(String),
|
||||
#[error("readback transport: {0}")]
|
||||
Readback(String),
|
||||
#[error("artifact I/O: {0}")]
|
||||
ArtifactIo(String),
|
||||
}
|
||||
|
||||
fn digest_bytes(hex: &str) -> Result<[u8; 32], FlashError> {
|
||||
if hex.len() != 64 {
|
||||
return Err(FlashError::InvalidDigest);
|
||||
}
|
||||
let mut result = [0_u8; 32];
|
||||
for (index, pair) in hex.as_bytes().chunks_exact(2).enumerate() {
|
||||
let text = std::str::from_utf8(pair).map_err(|_| FlashError::InvalidDigest)?;
|
||||
result[index] = u8::from_str_radix(text, 16).map_err(|_| FlashError::InvalidDigest)?;
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
fn stage_verified_artifact(
|
||||
artifact: &mut VerifiedArtifact,
|
||||
size: u64,
|
||||
expected: [u8; 32],
|
||||
) -> Result<std::fs::File, FlashError> {
|
||||
let mut staged = tempfile::tempfile().map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
artifact
|
||||
.reader()
|
||||
.seek(SeekFrom::Start(0))
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
let mut source = DigestReader {
|
||||
inner: artifact.reader(),
|
||||
remaining: size,
|
||||
digest: Sha256::new(),
|
||||
};
|
||||
std::io::copy(&mut source, &mut staged).map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
if source.remaining != 0 || <[u8; 32]>::from(source.digest.finalize()) != expected {
|
||||
return Err(FlashError::ArtifactChanged);
|
||||
}
|
||||
staged
|
||||
.flush()
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
staged
|
||||
.seek(SeekFrom::Start(0))
|
||||
.map_err(|e| FlashError::ArtifactIo(e.to_string()))?;
|
||||
Ok(staged)
|
||||
}
|
||||
|
||||
struct DigestReader<'a> {
|
||||
inner: &'a mut dyn Read,
|
||||
remaining: u64,
|
||||
digest: Sha256,
|
||||
}
|
||||
|
||||
impl Read for DigestReader<'_> {
|
||||
fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
|
||||
let limit = buffer
|
||||
.len()
|
||||
.min(usize::try_from(self.remaining).unwrap_or(usize::MAX));
|
||||
let length = self.inner.read(&mut buffer[..limit])?;
|
||||
self.remaining -= length as u64;
|
||||
self.digest.update(&buffer[..length]);
|
||||
Ok(length)
|
||||
}
|
||||
}
|
||||
|
||||
/// Stop before reboot. The caller must still prove live boot and persistence.
|
||||
pub fn write_verified<W: Writer, R: IndependentReadback>(
|
||||
partition: &PartitionSpec,
|
||||
artifact: &mut VerifiedArtifact,
|
||||
writer: &mut W,
|
||||
readback: &mut R,
|
||||
) -> Result<WriteReceipt, FlashError> {
|
||||
if partition.secure {
|
||||
return Err(FlashError::SecurePartition);
|
||||
}
|
||||
let size = artifact.record().size_bytes;
|
||||
if size == 0 || partition.capacity_bytes == 0 || size > partition.capacity_bytes {
|
||||
return Err(FlashError::ImageTooLarge);
|
||||
}
|
||||
if writer.channel_id().is_empty()
|
||||
|| readback.channel_id().is_empty()
|
||||
|| writer.channel_id() == readback.channel_id()
|
||||
{
|
||||
return Err(FlashError::SameChannel);
|
||||
}
|
||||
if partition.boot_critical {
|
||||
if !writer
|
||||
.serial_console_attached()
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?
|
||||
{
|
||||
return Err(FlashError::SerialRequired);
|
||||
}
|
||||
if !writer
|
||||
.recovery_image_ready(partition)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?
|
||||
{
|
||||
return Err(FlashError::RecoveryRequired);
|
||||
}
|
||||
}
|
||||
artifact
|
||||
.revalidate()
|
||||
.map_err(|_| FlashError::ArtifactChanged)?;
|
||||
let expected = digest_bytes(&artifact.record().sha256)?;
|
||||
// The source path may change while backup or transport I/O runs. Copy and
|
||||
// verify it before any device write; the anonymous file is removed on drop.
|
||||
let mut staged = stage_verified_artifact(artifact, size, expected)?;
|
||||
let backup = writer
|
||||
.backup(partition)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?;
|
||||
if backup.location.is_empty()
|
||||
|| backup.bytes != partition.capacity_bytes
|
||||
|| backup.sha256 == [0; 32]
|
||||
{
|
||||
return Err(FlashError::BackupIncomplete);
|
||||
}
|
||||
let mut stream = DigestReader {
|
||||
inner: &mut staged,
|
||||
remaining: size,
|
||||
digest: Sha256::new(),
|
||||
};
|
||||
writer
|
||||
.write(partition, &mut stream, size)
|
||||
.map_err(|e| FlashError::Write(e.to_string()))?;
|
||||
if stream.remaining != 0 {
|
||||
return Err(FlashError::IncompleteWrite);
|
||||
}
|
||||
let written_digest: [u8; 32] = stream.digest.finalize().into();
|
||||
if written_digest != expected {
|
||||
return Err(FlashError::ArtifactChanged);
|
||||
}
|
||||
let actual = readback
|
||||
.sha256(partition, size)
|
||||
.map_err(|e| FlashError::Readback(e.to_string()))?;
|
||||
if actual != expected {
|
||||
return Err(FlashError::ReadbackMismatch);
|
||||
}
|
||||
Ok(WriteReceipt {
|
||||
partition: partition.name.clone(),
|
||||
backup,
|
||||
image_sha256: expected,
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use alkane_artifacts::{verify_file, ArtifactRecord};
|
||||
use std::path::PathBuf;
|
||||
|
||||
const SHA: &str = "bf7d458495ed067341c7148cd3d30e6d383a2113b2cfb37de12959e057a52528";
|
||||
const IMAGE: &[u8] = b"PK\x03\x04payload";
|
||||
|
||||
struct MockWriter {
|
||||
serial: bool,
|
||||
recovery: bool,
|
||||
backup_bytes: u64,
|
||||
max_read: Option<u64>,
|
||||
writes: usize,
|
||||
contents: Vec<u8>,
|
||||
mutate_source_on_write: Option<PathBuf>,
|
||||
}
|
||||
|
||||
impl Writer for MockWriter {
|
||||
type Error = &'static str;
|
||||
|
||||
fn channel_id(&self) -> &str {
|
||||
"ssh"
|
||||
}
|
||||
fn serial_console_attached(&mut self) -> Result<bool, Self::Error> {
|
||||
Ok(self.serial)
|
||||
}
|
||||
fn recovery_image_ready(&mut self, _: &PartitionSpec) -> Result<bool, Self::Error> {
|
||||
Ok(self.recovery)
|
||||
}
|
||||
fn backup(&mut self, _: &PartitionSpec) -> Result<BackupEvidence, Self::Error> {
|
||||
Ok(BackupEvidence {
|
||||
location: "recovery/partition.img".to_owned(),
|
||||
bytes: self.backup_bytes,
|
||||
sha256: [1; 32],
|
||||
})
|
||||
}
|
||||
fn write(
|
||||
&mut self,
|
||||
_: &PartitionSpec,
|
||||
image: &mut dyn Read,
|
||||
_: u64,
|
||||
) -> Result<(), Self::Error> {
|
||||
self.writes += 1;
|
||||
if let Some(path) = &self.mutate_source_on_write {
|
||||
std::fs::write(path, b"PK\x03\x04changed").map_err(|_| "mutation failed")?;
|
||||
}
|
||||
if let Some(limit) = self.max_read {
|
||||
image
|
||||
.take(limit)
|
||||
.read_to_end(&mut self.contents)
|
||||
.map_err(|_| "read failed")?;
|
||||
} else {
|
||||
image
|
||||
.read_to_end(&mut self.contents)
|
||||
.map_err(|_| "read failed")?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
struct MockReadback {
|
||||
channel: &'static str,
|
||||
digest: [u8; 32],
|
||||
}
|
||||
|
||||
impl IndependentReadback for MockReadback {
|
||||
type Error = &'static str;
|
||||
|
||||
fn channel_id(&self) -> &str {
|
||||
self.channel
|
||||
}
|
||||
fn sha256(&mut self, _: &PartitionSpec, _: u64) -> Result<[u8; 32], Self::Error> {
|
||||
Ok(self.digest)
|
||||
}
|
||||
}
|
||||
|
||||
fn artifact(suffix: &str) -> (PathBuf, VerifiedArtifact) {
|
||||
let path =
|
||||
std::env::temp_dir().join(format!("alkane-flash-test-{}-{suffix}", std::process::id()));
|
||||
std::fs::write(&path, IMAGE).unwrap();
|
||||
let record = ArtifactRecord {
|
||||
sha256: SHA.to_owned(),
|
||||
size_bytes: IMAGE.len() as u64,
|
||||
path: PathBuf::from("fixture.zip"),
|
||||
family: "test".to_owned(),
|
||||
format: "update-zip".to_owned(),
|
||||
applicability: "test".to_owned(),
|
||||
};
|
||||
let verified = verify_file(&path, &record).unwrap();
|
||||
(path, verified)
|
||||
}
|
||||
|
||||
fn writer() -> MockWriter {
|
||||
MockWriter {
|
||||
serial: true,
|
||||
recovery: true,
|
||||
backup_bytes: 4096,
|
||||
max_read: None,
|
||||
writes: 0,
|
||||
contents: Vec::new(),
|
||||
mutate_source_on_write: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn partition() -> PartitionSpec {
|
||||
PartitionSpec {
|
||||
name: "rootfs".to_owned(),
|
||||
capacity_bytes: 4096,
|
||||
secure: false,
|
||||
boot_critical: true,
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn refuses_secure_and_unrecoverable_writes_before_device_mutation() {
|
||||
let (path, mut image) = artifact("refusals");
|
||||
let mut target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
target.secure = true;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SecurePartition)
|
||||
));
|
||||
target.secure = false;
|
||||
target.capacity_bytes = 1;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ImageTooLarge)
|
||||
));
|
||||
target.capacity_bytes = 4096;
|
||||
writer.serial = false;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SerialRequired)
|
||||
));
|
||||
writer.serial = true;
|
||||
writer.recovery = false;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::RecoveryRequired)
|
||||
));
|
||||
writer.recovery = true;
|
||||
writer.backup_bytes = 1;
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::BackupIncomplete)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn requires_independent_matching_readback() {
|
||||
let (path, mut image) = artifact("readback");
|
||||
let target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "ssh",
|
||||
digest: [0; 32],
|
||||
};
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::SameChannel)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
readback.channel = "serial";
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ReadbackMismatch)
|
||||
));
|
||||
assert_eq!(writer.writes, 1);
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
writer.contents.clear();
|
||||
readback.digest = digest_bytes(SHA).unwrap();
|
||||
let receipt = write_verified(&target, &mut image, &mut writer, &mut readback).unwrap();
|
||||
assert_eq!(receipt.image_sha256, readback.digest);
|
||||
assert_eq!(receipt.backup.bytes, 4096);
|
||||
assert_eq!(writer.writes, 2);
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn refuses_changed_or_partially_consumed_artifacts() {
|
||||
let (path, mut image) = artifact("changed");
|
||||
let target = partition();
|
||||
let mut writer = writer();
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
std::fs::write(&path, b"PK\x03\x04changed").unwrap();
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::ArtifactChanged)
|
||||
));
|
||||
assert_eq!(writer.writes, 0);
|
||||
|
||||
std::fs::write(&path, IMAGE).unwrap();
|
||||
writer.max_read = Some(4);
|
||||
assert!(matches!(
|
||||
write_verified(&target, &mut image, &mut writer, &mut readback),
|
||||
Err(FlashError::IncompleteWrite)
|
||||
));
|
||||
assert_eq!(writer.writes, 1);
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_verified_snapshot_when_source_changes_during_transport() {
|
||||
let (path, mut image) = artifact("mutated-during-write");
|
||||
let mut writer = writer();
|
||||
writer.mutate_source_on_write = Some(path.clone());
|
||||
let mut readback = MockReadback {
|
||||
channel: "serial",
|
||||
digest: digest_bytes(SHA).unwrap(),
|
||||
};
|
||||
let receipt = write_verified(&partition(), &mut image, &mut writer, &mut readback).unwrap();
|
||||
assert_eq!(receipt.image_sha256, digest_bytes(SHA).unwrap());
|
||||
assert_eq!(writer.contents, IMAGE);
|
||||
assert_eq!(std::fs::read(&path).unwrap(), b"PK\x03\x04changed");
|
||||
std::fs::remove_file(path).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2604,6 +2604,38 @@ mod tests {
|
||||
assert!(per.as_millis() < 100, "cell rendering regressed: {per:?}");
|
||||
}
|
||||
|
||||
/// Microbenchmark: component health scores and operator-facing diagnostics
|
||||
/// recomputed when scan results refresh the table.
|
||||
#[test]
|
||||
#[ignore]
|
||||
fn bench_health_diagnostics() {
|
||||
use std::hint::black_box;
|
||||
use std::time::Instant;
|
||||
|
||||
let rows = bench_fleet();
|
||||
let iters = 1000u32;
|
||||
let start = Instant::now();
|
||||
let mut sink = 0usize;
|
||||
for _ in 0..iters {
|
||||
for row in &rows {
|
||||
for facet in [
|
||||
HealthFacet::Overall,
|
||||
HealthFacet::Power,
|
||||
HealthFacet::Fans,
|
||||
HealthFacet::Boards,
|
||||
] {
|
||||
sink += black_box(row.health_score(facet)) as usize;
|
||||
}
|
||||
sink += row.health_summary().len();
|
||||
sink += row.health_tooltips(4, 3).iter().map(String::len).sum::<usize>();
|
||||
}
|
||||
}
|
||||
black_box(sink);
|
||||
let per = start.elapsed() / iters;
|
||||
println!("bench_health_diagnostics: {} rows = {:?}/refresh", rows.len(), per);
|
||||
assert!(per.as_millis() < 20, "health diagnostics regressed: {per:?}/refresh");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn selection_survives_upsert() {
|
||||
let mut rows = bench_fleet();
|
||||
|
||||
@@ -58,7 +58,11 @@ pub fn firmware_family(raw: &str) -> (String, Option<String>) {
|
||||
// Vendor prefixes asic-rs prepends on stock-firmware family strings, matched
|
||||
// case-insensitively.
|
||||
for vendor in ["AntMiner", "WhatsMiner"] {
|
||||
if trimmed.len() > vendor.len() && trimmed[..vendor.len()].eq_ignore_ascii_case(vendor) {
|
||||
if trimmed.len() > vendor.len()
|
||||
&& trimmed
|
||||
.get(..vendor.len())
|
||||
.is_some_and(|prefix| prefix.eq_ignore_ascii_case(vendor))
|
||||
{
|
||||
let rest = trimmed[vendor.len()..].trim();
|
||||
if !rest.is_empty() {
|
||||
return (rest.to_string(), Some(vendor.to_string()));
|
||||
@@ -477,6 +481,35 @@ mod tests {
|
||||
assert_eq!(firmware_family("Braiins"), ("Braiins".to_string(), None));
|
||||
// A bare vendor word with nothing after it is left as-is (not emptied).
|
||||
assert_eq!(firmware_family("AntMiner"), ("AntMiner".to_string(), None));
|
||||
// Firmware strings arrive from the network and may contain UTF-8 at
|
||||
// the byte position used to check a vendor prefix.
|
||||
let non_ascii = "AntMine\u{e9} Stock";
|
||||
assert_eq!(firmware_family(non_ascii), (non_ascii.to_string(), None));
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "microbenchmark"]
|
||||
fn bench_naming_transforms() {
|
||||
let cases = [
|
||||
("Antminer", "S19jPro", "AntMiner Stock", "Xilinx"),
|
||||
("Antminer", "S21Pro", "VNish", "CVITek"),
|
||||
("Whatsminer", "M30SPlusVE40", "WhatsMiner Stock", "H616"),
|
||||
("Whatsminer", "M50SPlusPlusVK30", "Braiins", "H6"),
|
||||
];
|
||||
let iterations = 20_000;
|
||||
let started = std::time::Instant::now();
|
||||
for index in 0..iterations {
|
||||
let (make, model, firmware, board) = cases[index % cases.len()];
|
||||
let clean = clean_model(make, model);
|
||||
std::hint::black_box(firmware_family(firmware));
|
||||
std::hint::black_box(control_board_code(make, board, &clean));
|
||||
std::hint::black_box(chip_type_for_model(make, model));
|
||||
std::hint::black_box(clean);
|
||||
}
|
||||
let elapsed = started.elapsed();
|
||||
let per = elapsed / iterations as u32;
|
||||
println!("bench_naming_transforms: {per:?}/record");
|
||||
assert!(elapsed < std::time::Duration::from_millis(500));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# UI Spec — primary view
|
||||
# Primary view
|
||||
|
||||
Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
|
||||
## Header (above the table)
|
||||
## Header
|
||||
|
||||
- **KPI block, top left — 6 KPIs:**
|
||||
- **KPI block, top left: 6 KPIs:**
|
||||
1. Total miners
|
||||
2. Hashing
|
||||
3. Slow
|
||||
@@ -31,7 +31,7 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
4. Cooling (fan)
|
||||
5. Firmware
|
||||
6. Pool worker account name
|
||||
7. …then the remaining statistics in registry order.
|
||||
7. Remaining statistics in registry order.
|
||||
|
||||
## Data sources
|
||||
|
||||
@@ -45,10 +45,10 @@ Source: operator description, 2026-09-15. Status: ACCEPTED (v1 scope).
|
||||
ships with the board registry; missing band = excluded from Slow, counted
|
||||
in Hashing).
|
||||
|
||||
## Implementation notes
|
||||
## Implementation
|
||||
|
||||
- wxWidgets: the view is a `wxDataViewListCtrl`/`wxDataViewCtrl` (virtual
|
||||
list — thousands of rows without materializing cells), checkbox column +
|
||||
list for thousands of rows without materializing cells), checkbox column +
|
||||
IP column fixed via attribute/serializer, drag reorder via `wxReorderable`
|
||||
column events, sort via column header click events mapped to the model.
|
||||
- Filter panel: per-column distinct-value checklist with text search,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ADR 0001: Recipes as data, interpreted by one engine
|
||||
# ADR 0001: Recipe engine
|
||||
|
||||
Status: ACCEPTED
|
||||
Date: 2026-09-14
|
||||
|
||||
@@ -1,41 +1,27 @@
|
||||
# ADR 0002: GUI bindings — wxWidgets shell in C++ + Rust core, spike to revisit
|
||||
# ADR 0002: GUI bindings
|
||||
|
||||
Status: RESOLVED 2026-09-15 - the operator chose Option B (pure Rust via
|
||||
wx-rs) with vendoring (ADR-0003). wx-rs 0.2.0 was extended via the patch
|
||||
queue: Linux/GTK3 wx-config build path plus the widget bridge (panel,
|
||||
sizers, static text, button, text ctrl, checkbox, checklistbox, dialog,
|
||||
data view list ctrl, timer). The app ships this way; no C++ shell.
|
||||
Date: 2026-09-14
|
||||
Resolved: 2026-09-15
|
||||
|
||||
## Context
|
||||
|
||||
The toolkit must present a native cross-platform GUI (wxWidgets chosen).
|
||||
Rust bindings to wxWidgets checked on crates.io 2026-09-14:
|
||||
|
||||
- `wxRust` 0.0.1-alpha — unmaintained since 2022.
|
||||
- `wx-rs` 0.2.0 (2023, self-contained) — ~6k downloads, no 1.0.
|
||||
|
||||
Betting the GUI on alpha bindings risks weeks of binding-gap debugging
|
||||
(paste-heavy widgets, worker threads + event loops, GTK/WinCocoa quirks).
|
||||
The toolkit needs a native wxWidgets GUI. At the time of evaluation,
|
||||
`wxRust` 0.0.1-alpha had seen no maintenance since 2022, and `wx-rs`
|
||||
0.2.0 lacked widgets needed for the Toolkit.
|
||||
|
||||
## Decision
|
||||
|
||||
Default: **thin C++17 wxWidgets shell (`gui/`) + Rust core exposed over a
|
||||
small stable C ABI** (cdylib from `alkane-core`, header generated with
|
||||
cbindgen). The shell holds frames, lists, the install wizard, and event
|
||||
glue only — no business logic, no safety logic. All invariants, engines,
|
||||
and tests live in Rust where they are testable headlessly.
|
||||
The operator chose a Rust GUI through a vendored, patched `wx-rs` 0.2.0.
|
||||
The patch queue adds the Linux/GTK3 build path and bindings for panels,
|
||||
sizers, controls, dialogs, data views, timers, and event dispatch. The
|
||||
application uses this bridge; it has no separate C++ shell.
|
||||
|
||||
Gate: M0 runs a time-boxed `wx-rs` spike (window + list/tree + wizard flow
|
||||
+ worker-thread progress + cancel on Linux and Windows). If the spike is
|
||||
solid, flip to pure Rust; either way the decision is recorded before M3.
|
||||
The original proposal was a small C++17 wxWidgets shell calling a Rust
|
||||
core through a C ABI. The `wx-rs` spike met the GUI need, so that proposal
|
||||
was not adopted.
|
||||
|
||||
## Consequences
|
||||
|
||||
- The repo builds two things: a Rust workspace and a small C++ app linked
|
||||
against the core cdylib. CMake in `gui/`.
|
||||
- Core API surface stays small and event-oriented (discover, identify,
|
||||
plan, execute, cancel, progress events, log tail) — good FFI hygiene and
|
||||
a natural match for the CLI too (D4).
|
||||
- If wx-rs wins the spike, the C ABI is kept as an integration boundary for
|
||||
scripted/HIL use anyway.
|
||||
- Keep business logic and safety checks in testable Rust code.
|
||||
- Carry wx-rs changes as numbered patches under `thirdparty/wx-rs/patches`.
|
||||
- Recheck the bridge on Linux, Windows, and macOS packaging changes.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ADR 0003: Vendoring policy — pristine upstream archives + patch queue
|
||||
# ADR 0003: Vendoring
|
||||
|
||||
Status: ACCEPTED
|
||||
Date: 2026-09-15
|
||||
@@ -42,7 +42,7 @@ thirdparty/
|
||||
|
||||
Rules:
|
||||
|
||||
1. Never edit a vendored pristine tree in place — every local change is a
|
||||
1. Never edit a vendored pristine tree in place. Every local change is a
|
||||
patch in `patches/`, applied by the build in numeric order. This makes
|
||||
an upstream update: replace pristine archive, `git apply` surviving
|
||||
patches, rebase the rest.
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# scripts/build-wx-linux.sh to produce it).
|
||||
set -e
|
||||
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
trap 'bash "$REPO/scripts/clean-old-builds.sh" || true' 0
|
||||
WX_PREFIX="${1:-$HOME/.cache/wx-3.3.3-linux}"
|
||||
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
|
||||
"$REPO/scripts/build-wx-linux.sh"
|
||||
|
||||
@@ -6,6 +6,21 @@ REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
SRC="$REPO/thirdparty/wxwidgets/wxWidgets-3.3.3"
|
||||
BUILD="$HOME/.cache/wxbuild/wxWidgets-3.3.3"
|
||||
PREFIX="$HOME/.cache/wx-3.3.3-linux"
|
||||
cleanup_wx_build() {
|
||||
python3 - "$BUILD" "$HOME/.cache/wxbuild" <<'PY'
|
||||
from pathlib import Path
|
||||
import shutil
|
||||
import sys
|
||||
|
||||
build, parent = map(Path, sys.argv[1:])
|
||||
if (build.name != "wxWidgets-3.3.3" or build.parent != parent
|
||||
or build.is_symlink() or parent.is_symlink()):
|
||||
raise SystemExit("refusing unsafe wxWidgets build cleanup path")
|
||||
if build.is_dir():
|
||||
shutil.rmtree(build)
|
||||
PY
|
||||
}
|
||||
trap cleanup_wx_build 0
|
||||
[ -d "$BUILD" ] || { mkdir -p "$HOME/.cache/wxbuild"; cp -r "$SRC" "$BUILD"; }
|
||||
[ -d "$BUILD" ] || { echo "thirdparty wxWidgets tree missing"; exit 1; }
|
||||
chmod +x "$BUILD/configure" "$BUILD/config.guess" "$BUILD/config.sub" "$BUILD/install-sh" 2>/dev/null || true
|
||||
|
||||
@@ -18,6 +18,15 @@
|
||||
set -uo pipefail
|
||||
|
||||
TARGET="${CARGO_TARGET_DIR:-$HOME/.cache/alkane-tk-target}"
|
||||
REPO="$(cd "$(dirname "$0")/.." && pwd)"
|
||||
case "$(realpath -m "$TARGET")" in
|
||||
"$HOME/.cache/alkane-tk-target"|"$REPO/target") ;;
|
||||
*) echo "clean-old-builds: refusing unexpected target $TARGET" >&2; exit 1 ;;
|
||||
esac
|
||||
if [ -L "$TARGET" ]; then
|
||||
echo "clean-old-builds: refusing symlink target $TARGET" >&2
|
||||
exit 1
|
||||
fi
|
||||
if [ ! -d "$TARGET" ]; then
|
||||
echo "clean-old-builds: no target dir at $TARGET (nothing to do)"
|
||||
exit 0
|
||||
|
||||
@@ -8,13 +8,13 @@
|
||||
#
|
||||
# Usage: scripts/ui-screenshot.sh [out.png] [--live] [binary]
|
||||
set -u
|
||||
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
REPO=$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
WX_PREFIX="${WX_PREFIX:-$HOME/.cache/wx-3.3.3-linux}"
|
||||
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$WX_PREFIX/bin/wx-config}"
|
||||
|
||||
OUT="${1:-alkane-toolkit.png}"
|
||||
LIVE=0; BIN=""
|
||||
shift 2>/dev/null || true
|
||||
[ "$#" -eq 0 ] || shift
|
||||
for a in "$@"; do
|
||||
case "$a" in
|
||||
--live) LIVE=1 ;;
|
||||
@@ -32,17 +32,31 @@ if [ -z "$BIN" ]; then
|
||||
fi
|
||||
[ -x "$BIN" ] || { echo "binary not found: $BIN" >&2; exit 3; }
|
||||
|
||||
DISP=":98"
|
||||
FAKE_ENV="ALKANE_FAKE_SCAN=1"
|
||||
[ "$LIVE" = "1" ] && FAKE_ENV=""
|
||||
|
||||
Xvfb "$DISP" -screen 0 1280x850x24 -nolisten tcp >/dev/null 2>&1 &
|
||||
DISPLAY_FILE=$(mktemp)
|
||||
XPID=""; APID=""; WARM=""
|
||||
cleanup() {
|
||||
[ -z "$APID" ] || kill "$APID" 2>/dev/null || true
|
||||
[ -z "$WARM" ] || kill "$WARM" 2>/dev/null || true
|
||||
[ -z "$XPID" ] || kill "$XPID" 2>/dev/null || true
|
||||
rm -f "$DISPLAY_FILE"
|
||||
}
|
||||
trap cleanup EXIT
|
||||
Xvfb -displayfd 3 -screen 0 1280x850x24 -nolisten tcp 3>"$DISPLAY_FILE" >/dev/null 2>&1 &
|
||||
XPID=$!
|
||||
sleep 1.2
|
||||
for _ in {1..30}; do
|
||||
[ -s "$DISPLAY_FILE" ] && break
|
||||
kill -0 "$XPID" 2>/dev/null || { echo "Xvfb exited before startup" >&2; exit 3; }
|
||||
sleep 0.1
|
||||
done
|
||||
[ -s "$DISPLAY_FILE" ] || { echo "Xvfb did not start" >&2; exit 3; }
|
||||
DISP=":$(cat "$DISPLAY_FILE")"
|
||||
# warm the font/GTK caches so the first window map is not stalled
|
||||
DISPLAY="$DISP" xclock >/dev/null 2>&1 & WARM=$!; sleep 1.2; kill "$WARM" 2>/dev/null
|
||||
# shellcheck disable=SC2086
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 $FAKE_ENV "$BIN" >/dev/null 2>&1 &
|
||||
if [ "$LIVE" = "1" ]; then
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 "$BIN" >/dev/null 2>&1 &
|
||||
else
|
||||
DISPLAY="$DISP" GDK_BACKEND=x11 ALKANE_FAKE_SCAN=1 "$BIN" >/dev/null 2>&1 &
|
||||
fi
|
||||
APID=$!
|
||||
WID=""; t=0
|
||||
while [ "$t" -lt 25 ]; do
|
||||
@@ -52,10 +66,6 @@ while [ "$t" -lt 25 ]; do
|
||||
[ -n "$line" ] && { WID=$(echo "$line" | awk '{print $1}'); break; }
|
||||
done
|
||||
sleep 2 # let it paint and drain a scan tick
|
||||
if [ -n "$WID" ]; then
|
||||
DISPLAY="$DISP" import -window "$WID" "$OUT" && echo "wrote $OUT (window $WID, ${t}s)"
|
||||
else
|
||||
DISPLAY="$DISP" import -window root "$OUT"; echo "no app window; captured root -> $OUT" >&2
|
||||
fi
|
||||
kill "$APID" 2>/dev/null
|
||||
kill "$XPID" 2>/dev/null
|
||||
[ -n "$WID" ] || { echo "no app window mapped" >&2; exit 1; }
|
||||
DISPLAY="$DISP" import -window "$WID" "$OUT" || exit 1
|
||||
echo "wrote $OUT (window $WID, ${t}s)"
|
||||
|
||||