Compare commits

...
160 Commits
Author SHA1 Message Date
noahandClaude Opus 5.5 1da1b88201 build-gui-macos: build like CI, without --locked
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 7m24s
verify / verify-windows (pull_request) Successful in 5m10s
A release sets the crate version first, which changes the workspace
entries in Cargo.lock; --locked then refuses to build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 16:04:55 -06:00
noah d9dc60918c Merge pull request 'macOS build: universal app for Apple Silicon and Intel, macOS 11+' (#23) from macos-build into main
build-test-release / release (push) Successful in 13m52s
build-test-release / windows (push) Successful in 6m2s
2026-11-03 14:41:23 -07:00
noahandClaude Opus 5.5 bb31a7befc macOS build: universal app for Apple Silicon and Intel, macOS 11+
verify / verify (pull_request) Successful in 7m33s
source / check (pull_request) Skipped
verify / verify-windows (pull_request) Successful in 5m48s
- scripts/build-wx-macos.sh: static, monolithic, universal (arm64 +
  x86_64) wxOSX/Cocoa 3.3.3 from the vendored tree, with wx's bundled
  image/zlib/regex/expat so the app links only system frameworks.
  Minimum macOS 11.0: current SDKs' libc++ supports nothing older.
- scripts/build-gui-macos.sh: builds both Rust targets against that
  prefix and merges them with lipo.
- ci/package-macos.py: "Alkane Toolkit.app" (Info.plist, icon, local
  network usage string), ad-hoc signed, zipped with ditto as
  alkane-toolkit-vX.Y.Z-macos-universal.zip with LICENSE and README.
- crates/alkane-gui/macos: app icon (.icns) from the same glyph as the
  Windows icon, plus the script that makes it.
- wx-rs patch 0009: macOS goes through wx-config (drops the universal
  -arch flags, maps -framework), reports logical sizes like GTK/MSW
  instead of narrowing floats to ints, and links clang's compiler
  runtime for wxOSX's @available checks.
- docs/macos.md, README and the manual's install chapter.

Verified on an M1 running macOS 27.0.1: both slices build, all
workspace unit tests pass, and the headless UI self-test passes 52/52
on arm64.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 15:26:56 -06:00
noah b1b7a3dbc0 Merge pull request 'SSH login in Credentials; default range 192.168.1.1/24; legal publisher name' (#22) from ssh-login-default-range-publisher into main
build-test-release / windows (push) Successful in 6m15s
build-test-release / release (push) Successful in 14m19s
2026-11-03 12:24:19 -07:00
noahandClaude Opus 5.5 8275f893dd SSH login in the Credentials dialog; default range 192.168.1.1/24; legal publisher name
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 7m55s
verify / verify-windows (pull_request) Successful in 5m8s
- Credentials dialog: new "SSH (restore)" row for the control-board SSH
  login used by the Braiins restore-to-stock. The username defaults to
  root; the password is masked and never re-displayed, and a blank
  password keeps the saved one. Reset to defaults also clears it.
  ssh-credentials.txt no longer has to be written by hand.
- Default scan range is now 192.168.1.1/24 (scans 192.168.1.0/24), and
  the range dialog's examples use that subnet.
- Windows version info, zip README, LICENSE and docs name the publisher
  as on the signing certificate: BlueFlare Energy Solutions Inc.
- Manual updated for all three.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 13:08:21 -06:00
noah 36f12d6d4e Merge pull request 'Attribute quality-dashboard coverage to crates' (#21) from fix-crate-coverage into main
build-test-release / release (push) Successful in 13m41s
build-test-release / windows (push) Successful in 5m48s
2026-11-03 10:51:30 -07:00
noahandClaude Opus 5.5 a4d82bf45b Attribute coverage to crates when llvm-cov strips the crates/ prefix
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 9m42s
verify / verify-windows (pull_request) Successful in 6m29s
The quality dashboard put every file under "other" because llvm-cov
prints paths relative to their common prefix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 11:34:15 -06:00
noah d925414bc8 Merge pull request 'Own Pages site (manual, quality dashboard, benchmarks); remove internal notes' (#20) from repo-cleanup into main
build-test-release / windows (push) Successful in 7m8s
build-test-release / release (push) Successful in 15m41s
2026-11-03 10:10:21 -07:00
noahandClaude Opus 5.5 9f9fe18926 Add the user manual
Ten chapters in docs/manual, published at /manual/ on the project site:
getting started, scanning, the table, health icons, actions, settings and
credentials, restore to stock, export, command line, troubleshooting.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 10:57:38 -06:00
noahandClaude Opus 5.5 d8d044f439 Give the toolkit its own Pages site with a code-quality dashboard
https://blueflare.gitea.bluefla.re/alkane-toolkit/ is built from this repo
(gh-pages) after every main run: overview, manual, a quality dashboard and the
benchmark history, which no longer goes to alkane-benchmarks. The quality
grade is now Clippy/rustfmt plus the line-coverage band (the coverage badge's
own colour bands), not only the Clippy result, and main CI publishes the full
measurement (per-crate and per-file coverage, LOC per crate) as quality.json
for the dashboard. README badges link to their pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 10:57:37 -06:00
noahandClaude Opus 5.5 517bee9b9e Take internal working notes and bench details out of the public repo
AGENTS.md, HANDOFF.md, code-review-report.md, the implementation plan and the
aftermarket parity roadmap described the internal bench, its addresses and
in-house firmware; they now live in the private miner-firmware workspace and
are git-ignored here. The remaining docs and the fixture header no longer
point at them or at local infrastructure.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 10:57:37 -06:00
noah 10d7fd6d95 Merge pull request 'Show hashboards and SHA-256 for VNish models asic-rs does not know' (#19) from fix/vnish-unknown-model-boards into main 2026-11-03 08:48:11 -07:00
noahandClaude Opus 5.5 9b440a46e3 Show hashboards and SHA-256 for VNish models asic-rs does not know
VNish reports the 88-chip S19 as "Antminer S19 (88)", which asic-rs parses
to an Unknown model with no hardware table. The VNish backends sized the
board list from that table, so all three live chains were dropped and the
Health column drew no hashboard icons for hashing miners; the same model also
got an Unknown hash algorithm. Size boards from the chains the miner reports
when the table is missing, and infer the algorithm from the Antminer family
letter (helper shared with the stock backend). asic-rs patch 0034.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 09:32:28 -06:00
noah c3b0dc6c8a Merge pull request 'Say in the Windows zip README whether the executable is signed' (#18) from windows-signed-readme into main 2026-11-03 07:21:11 -07:00
noahandClaude Opus 5.5 bfda29a845 Say in the Windows zip's README whether the executable is signed
Signing is now on (Azure Artifact Signing profile alkane-toolkit); the README
tells site users how to confirm the Blueflare signature, or that an unsigned
build will trip SmartScreen.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 08:07:21 -06:00
noah 2c58cbac48 Merge pull request 'Sign the Windows build with Azure Artifact Signing' (#17) from windows-signing into main 2026-11-02 19:51:15 -07:00
noahandClaude Opus 5.5 174b162dfd Sign the Windows build with Azure Artifact Signing
- ci/sign-windows.sh signs alkane-toolkit.exe from Linux with jsign through
  the blueflaresigning account (RFC 3161 timestamped), using the
  least-privilege CI service principal alkane-toolkit-ci-signer. It is a
  no-op until the repository variable AZURE_SIGNING_PROFILE names a
  certificate profile; after that any signing failure fails the build.
- release.yml and next.yml sign before packaging; windows-native.yml checks
  the signature with Get-AuthenticodeSignature on real Windows and requires
  Valid once signing is on.
- CI image adds a Java runtime and a checksum-pinned jsign 7.6 (re-pinned);
  windows-ci.sh fetches the same jar on older images.
- scripts/enable-windows-signing.sh turns signing on after Microsoft
  approves the publisher identity validation: creates the PublicTrust
  certificate profile, narrows the signer role to it, sets the variable.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 20:38:21 -06:00
noah cbf0f70cf6 Merge pull request 'Run the native Windows job past the default execution policy' (#16) from fix/windows-native-shell into main 2026-11-02 18:30:31 -07:00
noahandClaude Opus 5.5 332a3f7419 Scope the PR private-key check to first-party sources
The documentation- and workflow-only PR checks grepped every tracked file
for private-key headers, so the test fixtures inside vendored upstream
crates (openssl, rustls-pemfile, aws-lc) failed every such PR.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 19:29:05 -06:00
noahandClaude Opus 5.5 3931b6348f Run the native Windows job's steps past the default execution policy
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 19:25:54 -06:00
noah 69b1b6e6fb Merge pull request 'Add a native Windows build, tested and released by CI' (#15) from windows-port into main
Merge pull request 'Add a native Windows build, tested and released by CI' (#15) from windows-port into main
2026-11-02 18:00:26 -07:00
noahandClaude Opus 5.5 a732f01ac9 Document the Windows build, its CI and the native test runner
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 18:32:56 -06:00
noahandClaude Opus 5.5 6da34a55e8 Build, test and release the Windows build in CI
- ci/windows-ci.sh is the one definition of every Windows step (toolchain,
  clippy, build, tests and UI self-test under Wine, packaging, test bundle);
  verify, release and next only call it.
- release.yml: a windows job builds, tests and packages
  alkane-toolkit-vX.Y.Z-windows-x86_64.zip; the release job waits for it
  and attaches the zip next to the Linux tarball. next.yml does the same
  for -rc candidates, verify.yml runs the Windows gates on PRs.
- windows-native.yml (advisory, never gates a release) runs main's
  cross-built unit tests and UI self-test on real Windows 11 through the
  self-hosted VM runner (label alkane-windows).
- CI image: ci/images/alkane-ci.Dockerfile layers mingw-w64, Wine with a
  ready prefix, the rustup target and a prebuilt wxMSW prefix on the
  previously verified image; ci/images/build-image.sh pushes it and pins
  the digest. wx prefix/cache scripts take a linux|windows argument.
- CI checks the wx-rs patch queue; versioning treats the GUI build script,
  Windows resources and assets as release-relevant; the workflow contract
  test covers the Windows gates.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 18:32:55 -06:00
noahandClaude Opus 5.5 be5edfc2bf Port the toolkit GUI to Windows (wxMSW, cross-built with mingw-w64)
Build: the wx-rs build script chose the platform with cfg!(), which in a
build script describes the build host, so a Linux-to-Windows build took the
GTK path. It now reads CARGO_CFG_TARGET_*, and Windows/GNU builds through
wx-config exactly like GTK, against a static wxMSW from
scripts/build-wx-windows.sh. The C++ runtime is linked statically, so the
.exe imports only Windows system DLLs. crates/alkane-gui/build.rs embeds an
application manifest (Common Controls v6, per-monitor DPI v2, UTF-8 code
page, Windows 10/11), the icon and version info.

Bridge on wxMSW (patches 0007/0008):
- the upstream frame's invisible "OSX key events" child sat above the UI on
  MSW and swallowed every click and key; it is no longer created there
- light/dark is chosen before the first window (wxMSW ignores it later) and
  follows the Windows app mode, with dark grid rules for the data view
- the generic wxDataViewCtrl gets mouse input in its inner main window, so
  drag-select and the per-cell / per-icon tooltips bind there (GTK keeps
  its native GtkTreeView paths; the icon hit-test is shared)
- sizes cross the Rust/C++ boundary in DIPs (identity on GTK), so columns,
  icons, KPI cards and the status bar scale at 125-200 %
- vector shapes go through GDI+ (anti-aliased like Cairo on GTK); selected
  rows use the themed list-view text colour like the native renderer
- the frame never opens larger than the monitor work area; title-bar icon
  from the executable; upstream menu insert no longer reads UTF-8 as UTF-16

App: OS differences live in alkane_core::platform (settings in
%APPDATA%\alkane-toolkit, owner-only secret files, NUL, console-less helper
processes). SSH password logins use SSH_ASKPASS with the toolkit itself as
the helper on every platform, replacing sshpass, which Windows lacks.
Release builds are GUI-subsystem; headless modes attach to the parent
console.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 18:32:44 -06:00
noahandClaude Opus 5.5 569ef9dcd8 Make the wx-rs patch queue reproducible and checkable
The queue had drifted from the patched tree it describes: 0003 predated
rounds 12-19 of bridge work, 0005 no longer applied on top of it, and the
Cargo.toml note and the case-duplicate readme.md were in no patch at all.
Vendor the pristine crates.io crate (sha256 pinned in VERSION) and add
scripts/wx_rs_patches.py: 'check' rebuilds the tree from upstream + patches
and requires an exact match, 'capture' records an edit as the next patch.
0002/0003 are regenerated to the current bridge files (0005's GTK tooltip
fix is folded into 0003); 0005 now carries the packaging leftovers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 18:32:30 -06:00
noahandClaude Opus 5.5 b1313fd059 Restore wxWidgets files the tarball's own .gitignores kept out of git
The vendored wxWidgets 3.3.3 tree was missing 44 files of the pinned release
tarball (pnglibconf.h, PCRE2's configure and libtool files, libtiff build/):
the tarball ships nested .gitignore files, so a plain git add dropped them.
Linux links the system libpng/pcre2 and never noticed; the builtin libraries
the Windows build uses need them. The tree now matches the tarball
(sha256 81b09d6d...) byte for byte; VERSION says how to re-vendor safely.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 18:32:14 -06:00
noah 9ad8b56c1f Gate first-party Toolkit Rust formatting 2026-10-20 19:42:41 -06:00
noah 28f8f9ce80 Install rustfmt before CI format gates 2026-10-20 19:32:20 -06:00
noah d35cedd056 Describe formatting in quality badge 2026-10-20 19:30:25 -06:00
noah a825299ebc Format first-party GUI and gate Rust style 2026-10-20 19:29:43 -06:00
noah a17f108050 Clarify Toolkit quality badge scope 2026-10-20 19:28:47 -06:00
noah 3faa35ea70 Clarify Toolkit quality badge scope 2026-10-20 19:11:50 -06:00
noah 16490dd3b9 Merge pull request 'Isolate trusted toolkit jobs from fast runner' (#10) from ci/isolate-fast-runner-main into main 2026-10-20 18:58:53 -06:00
noah e6ae9d9d50 Isolate trusted toolkit jobs from fast runner 2026-10-20 18:45:04 -06:00
noah fc1ed3e4e5 Merge pull request 'Clarify Toolkit control and flashing scope' (#8) from docs/readme-scope into main 2026-10-19 23:52:32 -06:00
noah d7a914258e ci: close documentation-only verification block 2026-10-19 23:42:07 -06:00
noah 2108f47eea docs: clarify toolkit control and flash scope 2026-10-19 23:38:44 -06:00
noah d4a1db7243 Merge pull request 7: ci benchmark input context 2026-10-19 07:23:37 -06:00
noah 18acc31a28 ci: mark benchmark deltas with unchanged build inputs 2026-10-19 07:04:44 -06:00
noah d780fe007a Merge pull request 'ci: scope Toolkit workflow-only pull request checks' (#6) from ci/workflow-only-pr into main 2026-10-19 06:45:20 -06:00
noah f18bad36f3 ci: scope Toolkit workflow-only pull request checks 2026-10-19 06:31:16 -06:00
noah d7ae81dce9 Merge pull request 'ci: restore Toolkit main release to Alkane build pool' (#5) from ci/restore-main-release-pool into main 2026-10-19 06:30:16 -06:00
noah 10c93a3246 ci: route full Toolkit main release to Alkane build pool 2026-10-19 06:18:28 -06:00
noah 50ff6c60ce Merge pull request 'Use persistent Alkane cache for Toolkit main releases' (#4) from ci/static-main-release into main 2026-10-19 05:11:16 -06:00
noah cfe1f5be3b Run Toolkit main release on persistent Alkane verifier 2026-10-19 04:13:38 -06:00
noah 22e9106606 Merge pull request 'Use bounded Rust cache in Toolkit main and next CI' (#3) from ci/cache-main-and-next into main
Use bounded Rust cache on Toolkit main and next
2026-10-19 00:04:50 -06:00
noah c6b67c3b86 Bound Toolkit release compiler parallelism to measured memory 2026-10-18 23:53:33 -06:00
noah 77aacef528 Use bounded Rust cache in Toolkit main and next CI 2026-10-18 23:51:54 -06:00
noah 9bab162d64 Merge pull request 'Scope Toolkit PR checks and use prebuilt CI tools' (#2) from ci/docs-pr-fast-path into main
Speed Toolkit CI with scoped PR checks and bounded compiler caching
2026-10-18 23:49:27 -06:00
noah d0bbed568c Pilot bounded Rust compiler cache in Toolkit verification 2026-10-18 23:01:58 -06:00
noah 41142e707a Avoid duplicate source job for Toolkit main PRs 2026-10-18 22:35:04 -06:00
noah 7f106e2deb Use prebuilt CI tools and skip redundant wx cache transfer 2026-10-18 22:28:35 -06:00
noah 5cdce25329 Skip wx cache upload when image supplies the library 2026-10-18 22:15:27 -06:00
noah 01dd9ca287 Reject symlinked wx prefix markers 2026-10-18 22:02:48 -06:00
noah cb4c56679d Verify wx source provenance before reusing prefix 2026-10-18 21:56:00 -06:00
noah d0ecaea174 Publish Toolkit benchmarks on Pages runner after main CI 2026-10-18 21:50:25 -06:00
noah a77cd3a682 Include every Toolkit crate in unit coverage 2026-10-18 21:31:36 -06:00
noah c3efda87c3 Cover all Toolkit crates and pin CI image 2026-10-18 21:29:33 -06:00
noah afbaac0c0e Scope headless crate PR checks to reverse dependencies 2026-10-18 21:04:36 -06:00
noah c287aaaf58 Save wxWidgets cache before later quality checks 2026-10-18 21:04:35 -06:00
noah 6e09624120 Key wxWidgets cache to available native packages 2026-10-18 21:04:33 -06:00
noah 1edc446940 Skip redundant Toolkit package setup on prepared runners 2026-10-18 21:04:32 -06:00
noah f86f34bd90 Skip heavyweight Toolkit checks for documentation-only PRs 2026-10-18 21:04:30 -06:00
noah ff0724f96a Merge pull request 'Consolidate Toolkit CI setup and gate benchmark publication' (#1) from ci/release-setup-pages-order into main 2026-10-18 21:02:52 -06:00
noah 41d2bd6d91 Key wxWidgets cache to source and toolchain inputs 2026-10-18 20:15:24 -06:00
noah 8a75ee40bc Isolate Toolkit pull request verification from release queue 2026-10-18 20:13:17 -06:00
noah 75be20163d Stop scheduled Toolkit benchmark republishing 2026-10-18 20:03:45 -06:00
noah 0013dd45c2 Separate fast Toolkit checks from full main verification 2026-10-18 20:01:37 -06:00
noah a3ee239900 Route short Toolkit checks to Alkane fast runner 2026-10-18 20:01:35 -06:00
noah 5fc08e408e Use lightweight checks for Toolkit feature and next changes 2026-10-18 20:01:32 -06:00
noah 5098be30d1 Consolidate setup and gate benchmark publication 2026-10-18 20:01:26 -06:00
noah 1323dc1571 Add bounded read-only SSH board probes 2026-10-17 08:00:36 -06:00
noah 848a78ed5f docs: shorten Toolkit entry guide 2026-10-17 01:42:12 -06:00
noah 8d092ae417 Publish Toolkit benchmarks on the standing Alkane runner 2026-10-17 01:21:21 -06:00
noah 7445b05e57 Validate public benchmark page before upload 2026-10-16 08:46:06 -06:00
noah faae4ee145 Publish Toolkit benchmarks to public Pages site 2026-10-16 07:19:42 -06:00
noah 942801ee4b Bound queued Toolkit CI attempts per branch 2026-10-16 07:08:39 -06:00
noah 8de1bdffd4 Average benchmark improvements equally in Toolkit badge 2026-10-16 06:02:42 -06:00
noah 77237023e3 Require complete Toolkit benchmarks before release 2026-10-16 05:11:44 -06:00
noah fc573f075a Benchmark health diagnostics on representative miners 2026-10-15 20:19:18 -06:00
noah 1c364d4ff1 Guard UTF-8 naming and repair headless screenshots 2026-10-15 20:10:19 -06:00
noah d54bd6473f Stage verified flash images before device writes 2026-10-15 19:10:28 -06:00
noah a5b07d22ae Grade Toolkit code quality from static checks 2026-10-15 19:03:34 -06:00
Noah 3d17326460 Simplify Toolkit docs and update installer status 2026-10-15 14:36:09 -06:00
noah 56339a5eca Clean candidate build after prerelease decision 2026-10-15 12:43:30 -06:00
noah 00bb760451 Clean generated Toolkit builds after CI and local GUI builds 2026-10-15 11:51:55 -06:00
noah 5f472435a7 Parse Rust test harness benchmark output 2026-10-15 04:06:32 -06:00
noah f22fe19a4d Compare toolkit benchmarks on matching CPU classes 2026-10-15 03:36:53 -06:00
noah 8ab83edc73 Derive toolkit quality grade from measured coverage 2026-10-15 03:34:11 -06:00
noah 601da0548b Revalidate artifacts and guard complete flash streams 2026-10-14 20:54:29 -06:00
noah 4592b927ad Use Gitea-compatible pinned artifact upload 2026-10-14 20:51:23 -06:00
noah 5e347315e2 Publish measured toolkit badges from main CI 2026-10-14 20:44:35 -06:00
noah 603c49a395 Guard verified artifact writes with recovery checks 2026-10-14 20:40:22 -06:00
noah bc8e0535d1 Verify toolkit firmware artifacts before install 2026-10-14 20:31:04 -06:00
noah cf1eaebae1 Record private toolkit benchmark history 2026-10-14 20:21:19 -06:00
noah f89f220f3e Standardize toolkit CI badges and scoped release auth 2026-10-14 20:05:49 -06:00
alkane-ci c18a37eebc ci: refresh README badges [skip release] 2026-10-13 23:27:22 +00:00
noah d3a06d682f Read benchmark coverage from release objects 2026-10-13 12:09:59 -06:00
noah 4d530721dc Trim CI script trailing blank lines 2026-10-13 11:54:00 -06:00
noah 0b691ca943 Add next release candidates and main branch gates 2026-10-13 11:53:22 -06:00
alkane-ci ed0f781851 ci: refresh README badges [skip release] 2026-10-02 16:16:14 +00:00
noahandClaude Opus 4.8 613132035a feat(gui,asic-rs): hashboard yellow-not-red, power-limit column, chip/HB/PSU-serial coverage
Round 21 (three reported items).

1. A hashboard that is still mining near full hashrate but has some failed chips
   now shows yellow (degraded), not red. VNish emits per-board chip failures as
   Warning while the board is mining (Error only when the board is not mining),
   and board_healths() renders a warning-only board as Degraded instead of Down.
   Verified live on 10.4.0.193 (mining ~83%, dead chips -> yellow).

2. New "Power limit" column: the configured power-target setpoint in watts
   (MinerRow.power_limit_w, from a Power tuning target). WhatsMiner shows its
   "Power Limit" (e.g. 2500 W); the value was already scanned but had no dedicated
   column. Numeric (sortable/filterable), Performance category, opt-in.

3. Chip + hashboard model coverage:
   - VNish hashboard model scanned from factory-info board_model (A3HB70601,
     BHB42603, ...) -- 147-unit fleet gains HB model. Both VNish backends.
   - WhatsMiner v1/v2 PSU serial scanned from get_psu serial_no (was hardcoded
     None). 48-unit fleet gains PSU serial.
   - Chip type derived from the detected model for Antminer hardware (VNish/stock/
     LuxOS/Braiins/UMC never report a chip string on the wire), in naming.rs:
     S21Pro->BM1370, S19jPro->BM1362, S19KPro->BM1366, S19/T19->BM1398, etc.
     Only high-confidence mappings; WhatsMiner and unknown models stay blank.
   PSU Vmin/Vmax remain Braiins/ePIC-only (not on the wire for WhatsMiner/VNish/
   Antminer -- confirmed live).

asic-rs patch 0033. 95 unit tests pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-10-02 10:09:07 -06:00
alkane-ci b3dc5a336e ci: refresh README badges [skip release] 2026-09-24 21:33:46 +00:00
noahandClaude Opus 4.8 a4d0cb65f0 fix(gui,vnish): hashrate 0-vs-dash, paused health colours, VNish per-hashboard faults
- Hashrate cell: a readable 0 hashrate now shows "0.00T" instead of a dash. The
  dash is reserved for an unreadable/absent hashrate. New MinerRow.hashrate_known
  records whether the miner reported a value; combined_si/num_value key off it,
  and scan/fixtures set it from data.hashrate.is_some().
- Paused-miner Health icons: the control board (brain) and PSU keep their true
  health (green when fine) instead of turning blue; fans turn blue only when
  actually stopped (0 RPM) and stay green while spinning; hashboards stay blue
  while paused (idle is the expected state).
- VNish per-hashboard faults: DataField::Messages now also reads the summary
  chains (chip_statuses red/orange + per-chain state) and emits one message per
  faulted board, attributed to MinerComponent::HashBoard{idx}, so the Health
  column reds the specific board and its tooltip carries the fault instead of it
  landing on the brain. Applied to v1_2_0 and v1_3_0. patch 0032.

Verified live: VNish 10.7.1.25 -> "Hashboard 2: 1 degraded chip(s)" on board idx
1; healthy 10.7.1.122 -> no messages. 93 unit tests pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-24 15:14:20 -06:00
alkane-ci 29b9b17c67 ci: refresh README badges [skip release] 2026-09-24 19:32:29 +00:00
noahandClaude Opus 4.8 8deecf3558 fix(gui): paused/stopped miners shown as broken (red) instead of paused (blue)
A miner an operator has stopped (e.g. 10.4.1.122, VNish miner_state "stopped" ->
OperatingState::Stopped) was read as broken: red hashboards and counted under "not
hashing" instead of "Paused".

Two causes:
1. is_paused() only matched the literal "pause" substring, so "Stopped"/"Stopping"/
   "Suspended" -- every other firmware's word for an intentional, resumable halt --
   fell through to not-paused. Now matches pause/stop/suspend (Error stays broken).
2. encode_component_health applied the paused-blue treatment to hashboards only
   (round 19 #19), so a paused miner's idle fans/power still rendered red. A stopped
   miner's off components are expected, not faults: colour every reported component
   blue when paused (an undetected/Unreachable one still stays grey -- "not present"
   is not "paused").

Verified live against 10.4.1.122 on a headless build: the row now shows all-blue
health (power grey, honestly unreachable) and counts under the Paused KPI, where it
previously showed red boards + "not hashing".

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-24 13:08:18 -06:00
alkane-ci 3a6a190ce1 ci: refresh README badges [skip release] 2026-09-24 16:25:36 +00:00
noahandClaude Opus 4.8 1f0a4cbe76 fix(gui): health icon tooltips never showed -- tip area used wrong coordinates
Round 19 #2. The health-icon hover tooltips never appeared because the GTK
query-tooltip handler built the per-icon "tip area" from gtk_tree_view_get_cell_area
(BIN-WINDOW coordinates) and passed it to gtk_tooltip_set_tip_area, which expects
WIDGET coordinates. The area was offset upward by the column-header height, so it
did not contain the pointer, and GTK suppresses any tooltip whose tip area excludes
the cursor -- so nothing showed. The Errors column worked because it sets no tip
area. Prior fixes (rounds 15/18/19) only tuned the icon slot math, which was already
correct; the coordinate-system mismatch was the actual cause.

Convert the slot rectangle from bin-window to widget coordinates with
gtk_tree_view_convert_bin_window_to_widget_coords before gtk_tooltip_set_tip_area.
The slot hit-test (block_left/adv, in bin-window coords) is unchanged and still
matches DrawShape's uniform health-icon advance. wx-rs patch 0005.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-24 10:03:58 -06:00
alkane-ci fbc43216fb ci: refresh README badges [skip release] 2026-09-24 00:27:48 +00:00
noahandClaude Opus 4.8 a4fcb6e763 asic-rs telemetry: VNish fan%/temps, WhatsMiner chip type, and auto-tuner status
Round 19 #10 telemetry extension, live-verified. Two logical changes (patches 0030
and 0031) shipped together; they populate existing GUI columns plus one new "Tuner"
column.

VNish + WhatsMiner (patch 0030, no core/GUI change):
- VNish v1_2_0 + v1_3_0: fan duty % (summary /miner/cooling/fan_duty) and board temp
  thresholds (settings restart_temp -> dangerous, auto cooling param -> target).
  Live-verified 10.4.1.50 (81 / 90 / 65). No PSU serial exposed -> stays None.
- WhatsMiner chip type (per user, do not drop): v1/v2 summary "Chip Data" merged
  into hashboards -> BoardData.chip_type (first token); v3 chipdataN -> chip_type and
  hash-board ("K40") -> hashboard_model.

Auto-tuner status (patch 0031):
- New DataField::TunerStatus + MinerData.tuner_status (Option<String>), riding the
  existing GetOperatingState trait via a defaulted parse_tuner_status.
- Braiins: performance/tuner-state overall_tuner_state via the BOS+ TunerState enum
  (Disabled/Stable/Tuning/Error/Continuous/Preheat) -- mapping from the bos-plus-api
  proto. ePIC: PerpetualTune -> Off/Optimized/Tuning. Others -> None.
- GUI: new "Tuner" column (Health & status category, auto-hidden when empty).

All values live-verified against the corpus miners (ePIC 10.4.1.6, LuxOS 10.4.1.60,
Braiins 10.4.1.83, VNish 10.4.1.50). Fixture tests assert every parsed value.
ALL_COLUMNS 71 -> 72.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 18:10:57 -06:00
alkane-ci 76409b0d3b ci: refresh README badges [skip release] 2026-09-23 23:57:28 +00:00
noahandClaude Opus 4.8 4aec6d40ad asic-rs telemetry: board temp thresholds -> target/hot/dangerous (LuxOS, Braiins; remap ePIC)
Round 19 #10 telemetry extension. Live-verified against the corpus miners, this
remodels the board temperature thresholds to item #10's target/hot/dangerous scheme
and adds the LuxOS and Braiins backends. Supersedes the ePIC-only critical/shutdown
model shipped in v0.72.0.

Core (asic-rs-core):
- MinerData: temp_critical/temp_shutdown -> temp_target/temp_hot/temp_dangerous.
- parse_temperature_limits (defaulted on the existing GetFluidTemperature trait)
  now returns (target, hot, dangerous); parse_data wires all three fields.

Backends (each reads an already-fetched or single command; live-verified):
- LuxOS: new tempctrl RPC; ChipTarget/ChipHot/ChipDangerous (live 10.4.1.60 = 83/93/100).
- Braiins v25_07 + v26_04: configuration/constraints cooling_constraints defaults
  (live 10.4.1.83 = 60/80/90); WEB_CONSTRAINTS already fetched for tuning caps.
- ePIC remap: Shutdown Temp -> hot, Critical Temp -> dangerous, no target.
- VNish (settings restart_temp/param) handled in a follow-up (needs settings auth);
  Antminer/WhatsMiner expose no thresholds -> (None,None,None).

GUI: the two temp columns (Critical/Shutdown) become three (Target/Hot/Dangerous),
right-aligned, Temperature category, auto-hidden when empty. MinerRow gains
temp_target_c/temp_hot_c/temp_dangerous_c; to_row reads them. ALL_COLUMNS 70 -> 71.

Fixtures captured from live: luxminer tempctrl.json, braiins configuration_constraints.json.
Fixture tests for epic, luxminer, braiins v26_04 assert the parsed thresholds. Patch 0029.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 17:40:33 -06:00
alkane-ci 33a116d9fd ci: refresh README badges [skip release] 2026-09-23 23:10:06 +00:00
noahandClaude Opus 4.8 45d9632590 asic-rs telemetry T3-temps: board temperature thresholds (critical / shutdown)
Round 19 #10 telemetry extension. Adds the board temperature safety thresholds
("board dangerous temp" from item #10).

Core (asic-rs-core):
- New DataField::TemperatureLimits; MinerData gains temp_critical and temp_shutdown
  (Celsius).
- Rides the existing GetFluidTemperature trait via a defaulted parse_temperature_limits
  method returning (critical, shutdown) -- no supertrait blast radius; parse_data
  wires both fields in.

Backend:
- ePIC: summary /Misc Critical Temp + Shutdown Temp (already-fetched summary).
- Antminer/WhatsMiner expose no thresholds; LuxOS needs an unwired tempctrl command
  (no fixture) and VNish/Braiins need live verification -> left for a live-verified
  pass, all inherit (None, None).

GUI: two new columns (Critical temp / Shutdown temp), right-aligned, Temperature
category, auto-hidden when empty. MinerRow gains temp_critical_c / temp_shutdown_c;
to_row reads them. ALL_COLUMNS 68 -> 70.

Fixture test for epic asserts the parsed thresholds. Patch 0028.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 16:53:57 -06:00
alkane-ci 0265370be2 ci: refresh README badges [skip release] 2026-09-23 22:43:35 +00:00
noahandClaude Opus 4.8 fadd851e04 asic-rs telemetry T3-fan: miner-level fan duty cycle (fan speed %)
Round 19 #10 / #8 telemetry extension. Adds the fan duty cycle as a miner-level
percentage -- the normalized fan-load indicator the GUI wanted alongside per-fan
RPMs. No firmware exposes a maximum fan RPM, so a true actual/maximum pair is not
possible; the duty cycle is the closest normalized signal.

Core (asic-rs-core):
- New DataField::FanSpeedPercent; MinerData gains fan_speed_percent (Option<f64>).
- Modeled as a top-level miner-level value (most firmwares report a single duty),
  so FanData is untouched -- no Eq removal / literal churn across its 17 crates.
- Rides the existing GetFans trait via a defaulted parse_fan_speed_percent method
  (no supertrait blast radius); parse_data wires it in.

Backends (read already-fetched commands, no extra round-trips):
- ePIC: summary /Fans/Fans Speed (single %).
- LuxOS: max of FANS[].Speed.
- Braiins v25_07 + v26_04: max of cooling fans[].target_speed_ratio x 100.
- Antminer (pwm via config) and VNish (fan_duty) have no data fixtures -> left for a
  live-verified pass; WhatsMiner is firmware-locked -> None.

GUI: new "Fan %" column (right-aligned, Cooling category, auto-hidden when empty).
MinerRow gains fan_speed_percent; to_row reads it. ALL_COLUMNS 67 -> 68.

Fixture tests: epic, luxminer, braiins v26_04 assert the parsed percentage. Patch 0027.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 16:28:14 -06:00
alkane-ci 24f9d9682d ci: refresh README badges [skip release] 2026-09-23 22:10:04 +00:00
noahandClaude Opus 4.8 3f9fc4a24b asic-rs telemetry T2b: cumulative share stats (difficulty acc/rej, stale, blocks)
Round 19 #10 telemetry extension, tier 2b. Adds the cumulative share statistics
from item #10 end to end: difficulty-weighted accepted/rejected work, raw stale
share count, and blocks found.

Core (asic-rs-core):
- New ShareSummary sub-struct (data/share.rs) with a parse_cgminer_share_summary
  helper reading a cgminer/btminer SUMMARY[0] object.
- New DataField::ShareSummary; MinerData gains share_summary.
- Rides the existing GetBestShare trait via a defaulted parse_share_summary method
  (no new supertrait bound, no per-backend empty impl); parse_data wires it in.

Backends (read the already-fetched SUMMARY, so no extra round-trips; these are
miner-level aggregates -> top-level MinerData fields, not per-pool PoolData):
- Antminer v2020 + v2023_07, LuxOS, WhatsMiner V1 + V2 override parse_share_summary.
- Braiins (no cumulative difficulty), ePIC (current difficulty only), WhatsMiner V3
  and VNish expose none and inherit None -- fixtures confirm.

GUI: four new columns (Diff acc / Diff rej / Stale / Blocks), right-aligned, in the
Pools category, auto-hidden when empty. MinerRow gains the four fields; to_row reads
them from share_summary. ALL_COLUMNS 63 -> 67.

Fixture tests: whatsminer v1 and antminer v2020 assert the parsed values. Patch 0026.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 15:51:57 -06:00
alkane-ci 8ab607de6c ci: refresh README badges [skip release] 2026-09-23 21:30:23 +00:00
noahandClaude Opus 4.8 a60bb34e64 asic-rs telemetry T2a: rolling average hashrate windows (1m/5m/15m/24h)
Round 19 #10 telemetry extension, tier 2. Adds the rolling average hashrate
windows the GUI asked for (1M/5M/15M/24H) end to end.

Core (asic-rs-core):
- New HashrateAverages sub-struct (data/hashrate.rs): avg_1m/5m/15m/24h, each an
  Option<HashRate> carrying the same unit and algorithm as the current hashrate.
- New DataField::HashrateAverages; MinerData gains hashrate_averages.
- The windows ride the EXISTING GetHashrate trait via a new defaulted
  parse_hashrate_averages method (default None), so no new supertrait bound and no
  empty impl in every backend -- only the backends that expose the data override
  it. parse_data wires it in.

Backends (all read a command the collector already fetches -> no extra round-trips;
each window is filtered to > 0 and the whole struct is dropped when every window is
absent, so a firmware that reports nothing keeps hashrate_averages = None):
- WhatsMiner V1: btminer summary MHS 1m/5m/15m (MegaHash); no 24h.
- WhatsMiner V3: get.miner.status summary hash-1min / hash-15min (TeraHash) only.
- LuxOS: summary GHS 1m/5m/15m/24h (GigaHash) -- full window set.
- Braiins v25_07 + v26_04: miner_stats real_hashrate last_1m/5m/15m/24h (GigaHash).
- Antminer (5s/30m/av only), WhatsMiner V2 (av only), ePIC/VNish (session average
  only), sealminer: no standard 1/5/15 window -> inherit None. This is honest: the
  fixtures confirm those firmwares do not expose the standard windows.

GUI: four new columns (HR 1m/5m/15m/24h), single TH/s value each, right-aligned,
blank when the window is not reported, auto-hidden when empty across the fleet.
MinerRow gains the four ths fields; to_row populates them from hashrate_averages.

Fixture tests: whatsminer v1 and braiins v26_04 gain assertions on the parsed
windows (value, unit, and the expected present/absent pattern). Patch 0025.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 15:08:27 -06:00
alkane-ci c944897807 ci: refresh README badges [skip release] 2026-09-23 20:45:46 +00:00
noahandClaude Opus 4.8 a6e22581d7 asic-rs telemetry T1b: WhatsMiner V3 PSU serial + ePIC chip/HB type
Round 19 #10 telemetry extension, tier 1 sub-batch B. Both ride existing
DataFields (Psu/Hashboards) on already-fetched commands (no extra round-trips)
and reuse the PsuInfo.serial / BoardData.chip_type+hashboard_model fields added
in T1a, so no core or GUI change -- the existing columns just populate for more
firmwares. Patch 0024; fixture tests pass.

- WhatsMiner V3: add a DataField::Psu location (get.device.info /msg/power) and a
  parse_psu that reads model/type, sw/hwversion, and the serial (sn). V3 had no
  PSU parse at all (default None) despite the data being fetched for PsuFans.
- ePIC: parse_hashboards now reads capabilities "Chip Type" (e.g. "BM1366") and
  "Model Subtype" (e.g. "BHB56801"), applied to every board (capabilities reports
  them miner-wide). The capabilities command is already fetched for Hashboards.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 14:31:36 -06:00
alkane-ci b15de7f747 ci: refresh README badges [skip release] 2026-09-23 20:18:33 +00:00
noahandClaude Opus 4.8 f887affd6d asic-rs telemetry T1a: PSU serial + chip/HB type + best-share
Extend vendored asic-rs to scan more per-firmware telemetry (round 19 #10
follow-up, tier 1 sub-batch A). All new values ride on existing DataFields
(Psu/Hashboards/BestShare) and commands already fetched, so no new core
DataField plumbing and no extra network round-trips. Patch 0023.

Vendored (asic-rs):
- PsuInfo gains `serial`. Braiins v26_04 parse_psu corrected to read model_name
  + fw_version (it used the numeric type code as the model and dropped the fw
  version) and to capture serial_number. ePIC / WhatsMiner v1/v2 report no serial.
- BoardData gains `chip_type` (e.g. "BM1370") + `hashboard_model` (e.g.
  "A3HB70601"); Braiins miner/hw/hashboards populates both.
- best_share (all-time) wired for Antminer v2020 and WhatsMiner v1/v2 from the
  already-fetched summary "Best Share" (those backends had the empty default).
- refresh-checksums --all; existing braiins/antminer/whatsminer fixture tests pass.

GUI:
- MinerRow gains chip_type, hashboard_model, psu_serial; populated in to_row.
- New columns: Chip, HB model, PSU serial. Best share now populates for Antminer
  and WhatsMiner (column already existed).

Feasibility analysis (5-agent, all firmwares) recorded in memory; further tiers
(fan %, rolling hashrate averages, difficulty/shares, temp thresholds, WhatsMiner
V3 / VNish PSU serial) follow. Confirmed genuinely-unavailable: fan max RPM,
WhatsMiner/LuxOS real logs, chip type on Antminer/LuxOS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 14:01:33 -06:00
alkane-ci e5e6b0f1e1 ci: refresh README badges [skip release] 2026-09-23 18:40:11 +00:00
noahandClaude Opus 4.8 ad28dab542 round 19 review fixes + Health-column alignment + badge-push fix
Health column (operator-reported): give every component-health icon a UNIFORM
fixed-width slot in the SegmentRenderer (GetSize + DrawShape), so power/control/
fan/board icons line up in fixed columns across rows regardless of glyph aspect,
and left-align the icon columns (Health/Access/Light) so the block anchors at a
consistent left edge. The per-icon tooltip hit-test uses the same uniform slot.

Code-review-harness fixes:
- High: isolate per-miner telemetry with catch_unwind so one miner's get_data
  panic can't abort the whole scan (and strand the fast-path partial rows).
- Medium: fill the zebra stripe across the full cell for right-aligned colored
  columns (was anchored at the content's left edge, leaving the left unstriped).
- Medium: lower the scan-concurrency ceiling 512 -> 256 (128 is fully reliable,
  192 already dropped responders on the live fleet).
- Medium: board voltage/frequency sort key skips placeholder-zero boards
  (avg_positive), matching how the cell renders them as "-".
- Low: saturating_add for accepted/rejected share sums; moved an orphaned doc
  comment; corrected a stale comment.

CI: fix the README-badge push-back -- `git push -c http.extraheader` is invalid
(`-c` must precede the subcommand), so the badge/coverage/bench-baseline commit
never actually reached main; now `git -c http.extraheader=... push`. This also
lets the bench-delta baseline persist so the delta can compute.

Demo: the offline-demo paused miner now has detected (idle) hashboards so the
paused-blue Health icons (round 19 #19) are exercised.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 12:21:03 -06:00
noahandClaude Opus 4.8 42e3bf8f5b round 19: columns, scan speed, per-firmware logs, more scanned fields
Table/columns:
- Fix the "columns shrink to tiny" bug on language change / add / hide (#3, #24):
  the rebuild-time capped autosize read column widths before GTK's measurement
  landed. Columns keep their default widths; autosize is on-demand only.
- Right-align every column except IP (#21): new alignment param on the bridge
  append calls; the SegmentRenderer and the tooltip hit-test honour it.
- "Auto-size all columns" header menu item; Ctrl+A selects all rows (#4).
- Remove the Boards (dots) column (#7).
- Split the slash-joined Fan column into per-fan columns Fan 1-4 (#8).
- Efficiency: unit moved into the value and made algorithm-aware (J/TH for
  SHA256 families, J/kSol for Equihash), fixing the blank/garbage figure on
  non-SHA256 miners (#9, #23).
- Pool account column before Worker by default (#22).

Scan:
- Fast scan (#18): emit a lightweight identity row the instant a miner is
  identified, then upsert the full telemetry row when get_data completes.
- User-adjustable scan concurrency with a bounded max (#25).
- Surface more scanned values as columns (#10): current tuning target, accepted
  / rejected shares + reject %, and per-hashboard hashrate / voltage / frequency.

Logs (#11-16): fetch the miner log through asic-rs's per-backend read_logs()
instead of the narrow curl paths, fixing Braiins / LuxOS / Z15 / BixBit / stock
Antminer; WhatsMiner keeps the fault-code fallback (no API log). Removed the
summary tidbits from the log viewer (#13).

Misc: fix per-icon health tooltips (advance math matched to the renderer) (#2);
paused miners show blue hashboard icons, healthy stays green (#19); state-aware
Pause/Resume in the right-click menu (#20); export opens a column-picker dialog
(#6) and the default filename carries a UTC timestamp (#5); the scan status bar
says "Scan Paused" / "Scan Stopped" and no longer overwrites Stop with paused
(#17); the bench badge shows the weighted-average microbench delta vs the
previous release (#1).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 11:40:21 -06:00
noahandClaude Opus 4.8 4154a50ed0 ci: measure coverage in the release job and auto-update the badge
Add a best-effort Coverage step to release.yml: it adds the llvm-tools-preview
rustup component, fetches cargo-llvm-cov as a prebuilt binary (the vendored
.cargo/config blocks `cargo install` from crates.io), runs ci/coverage.sh to
merge unit-test and headless self-test line coverage, and feeds the TOTAL
line-coverage percent to the badge refresh so badges/coverage.svg tracks the
real number on every release. The step is gated on a release and marked
continue-on-error, so coverage tooling can never block a release.

coverage.sh now runs its instrumented builds --offline by default (the
dependency tree is fully vendored), overridable via CARGO_LLVM_COV_FLAGS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 09:32:41 -06:00
noahandClaude Opus 4.8 0ab822940e coverage: count the headless self-test, reporting ~46% (was ~35%)
The self-test builds the real wxWidgets table and renders every fixture through
the real widgets, exercising ~27% of ui.rs (up from ~4%) -- but it runs as a
separate binary, so a plain `cargo llvm-cov` (which only runs the #[test]s) never
counted it, understating coverage. New ci/coverage.sh runs both the unit tests and
the self-test under one instrumentation pass and merges them, excluding the
vendored asic-rs / patched wx-rs from the report.

Our-source line coverage is now ~46% (model 81%, naming 95%, fixtures 100%,
credentials 92%); the remainder is click-driven dialogs and live-miner network
I/O, which unit tests can't reach without hardware or heavy mocks. Badge, report,
and README dev section updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 08:09:02 -06:00
noahandClaude Opus 4.8 c1aa6db834 license: unify under MIT
Collapse the dual MIT OR Apache-2.0 licensing to MIT only (operator's choice):
set the workspace `license` field to "MIT" (all crates inherit it), replace
LICENSE-MIT + LICENSE-APACHE with a single LICENSE file, and update the README
license section and the license badge. deny.toml keeps its permissive allow-list
(that governs dependency licenses, which remain a mix of MIT/Apache-2.0/BSD/etc.);
only its project-license comment changed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-23 08:05:11 -06:00
noahandClaude Opus 4.8 7feab6117b item 12 finale: shrink the release binary + code-review report
[profile.release] opt-level="s" + fat LTO + one codegen unit + strip cuts the
Linux binary from ~38M to ~19M (50%). panic stays "unwind" deliberately: the scan
runs many miners on tokio tasks and the wx dispatch relies on unwinding, so one
miner's panic must never abort the whole app. Verified: stripped binary, SELFTEST
PASS, 99 tests, clippy clean.

Adds code-review-report.md: the ship verdict and a full accounting of the five
recursive review rounds (all confirmed critical/high fixed; remaining items are
documented perf/dev-CLI tradeoffs). Badges refreshed (tests 99, coverage ~35%).

This completes the round-18 marathon: all 12 queued items plus Round C G3 (LuxOS
named presets) and G7 (per-board V/F read side), CI hardening (verify/release
split, clippy gate, audit, badges), README + docs, and the recursive multi-agent
code review.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 21:02:09 -06:00
noahandClaude Opus 4.8 808fd4de1d review wave 7: fifth-round findings (creds, scan race, refill throttle)
Fifth (final) review round; this clears its functional findings:

- HIGH config actions / pool writes could run concurrently with a live scan
  (start_action / apply_pools guarded flash + restore but not scanning); added
  the self.scanning guard, and begin_scan now defers while an action/restore runs,
  closing the race symmetrically.
- HIGH blanking a per-firmware credential row saved a live ("","") override that
  then broke that firmware's auth fleet-wide; a fully-blank row now clears the
  override (use the shipped default).
- HIGH a ChangePassword action never updated the toolkit's own saved credentials,
  so after a fleet-wide change it locked itself out; on full success it now updates
  the saved global password (and on a partial change logs a reconcile note rather
  than guessing).
- HIGH/perf fill_rows re-rated: a scan's streaming rows triggered a whole-table
  refill on every fast tick. New rows_dirty latch flushes the refill at most once
  per second during a scan (immediately once it ends).
- MED an indeterminate access-probe result no longer blanks a miner's already-known
  locked/unlocked state.
- LOW compute-version.sh header doc corrected to match the broadened rule;
  release.yml sets WX_RS_WXCONFIG once at job level instead of per step.

Accepted (documented) perf items that remain: per-render health recompute and
per-column cell-string allocation (small, fleet-scale), the linear upsert scan,
and synchronous scan-range parsing (bounded by the range caps).

99 tests + clippy-clean + selftest green. This was review round 5 (the harness's
iteration cap); every confirmed critical/high across all five rounds is fixed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 20:59:03 -06:00
noahandClaude Opus 4.8 63ada5bb99 review wave 6: fourth-round findings (masked prompt, board grey, timeouts)
Fourth review round found further issues, two being gaps in earlier fixes; this
clears the actionable ones:

- HIGH board_healths() painted a genuinely-undetected board RED when a fault text
  also named it (e.g. "chain 2 not found" -> Board(2)); an undetected board now
  stays grey, matching the documented grey-vs-red invariant. Regression-tested.
- HIGH the Change-password prompt used an unmasked field (the Credentials dialog
  was masked in wave 1 but this prompt was missed) -> masked for PromptKind::Password.
- MED the WhatsMiner access probe aborted all remaining password candidates on one
  transient error -> transient errors now skip to the next candidate and never
  report a confident "locked" when the answer was really indeterminate.
- MED config actions / refresh / pools / flash ignored the operator's configured
  scan timeout (used asic-rs's 10s default) -> configured_factory now applies it,
  so a slow-link action reaches the same miners a longer-timeout scan found.
- MED the auto-rescan loop set a bogus "scanning..." status even when the scan was
  deferred (mid-flash) -> begin_scan reports whether it started.
- LOW is_aml_140mm matched every S21, not just the S21 Pro its doc names -> fixed.
- Offline fixtures now reuse scan::infer_pic instead of a diverging copy.

Accepted (documented) from this round: miner_probe's argv secrets (diagnostic CLI),
the rebuild_table/update_headers sort-marker duplication, the LuxOS substring
success check (command-specific reply), restore/flash target snapshot (dialogs are
modal), non-cancellable restore/probe batches, Braiins host-key (LAN reflash), and
the perf items (per-tick refill, health recompute, linear upsert, cell formatting).

99 tests + clippy-clean + selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 20:29:52 -06:00
noahandClaude Opus 4.8 52b7c3f2a1 review wave 5: third-round findings (unreachable column, races, panics, DoS)
Third review round (over the wave 3/4 fixes) surfaced further findings, mostly in
new code paths; this clears them:

- HIGH the fully-built "Boards" column (Column::Hashboards: renderer, sort/filter
  logic, tests, a self-test check) was missing from ALL_COLUMNS, so it was
  unreachable in the UI and its self-test check was dead. Added to ALL_COLUMNS
  (opt-in; Health still shows composite board health by default) and the self-test
  now makes it visible -- the dot-sentinel check is live again.
- HIGH apply_pools() could start a pool write during a restore-to-stock (it sets
  self.action directly, bypassing start_action's guard) -> same restore guard.
- HIGH superseding an in-flight action/pools job left the old miners' Health cells
  frozen on the "…ing" label forever (the replaced handle's drain never runs) ->
  clear the superseded action's op-status.
- HIGH clean_antminer() byte-sliced a miner-supplied model string without a
  char-boundary check (panic DoS) -> use get(..9).
- MED access-probe errors were silently discarded -> surfaced in the indicator.
- MED the pool-password file was briefly world-readable before chmod -> created
  0600 from the start (OpenOptions mode).
- MED a miner-controlled log response was buffered unbounded (OOM DoS) -> capped.
- MED the language-menu id range was hardcoded (and 790-794 collided with the
  pool-preset / fw-preset dialog ids!) -> derived from Lang::all() and moved the
  dialog ids to a clear block.
- LOW restore_vnish now sends the unlock body via stdin (password off argv), and
  the LuxOS restore treats a reboot-dropped/empty reply as success.

Remaining round-3 findings are the previously-accepted perf tradeoffs (bulk-serial
writes, per-tick refill, per-render health recompute, linear upsert), documented
in code and in code-review-report.md.

99 tests + clippy-clean + selftest green (Boards-column check now live).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 19:53:56 -06:00
noahandClaude Opus 4.8 571c2305aa review wave 4: remaining round-2 findings (filters, creds, restore, panics)
Clears the rest of the second review round's confirmed findings:

- HIGH the Boards numeric filter compared the composite sort score (online*100+
  total) instead of the board count, so a filter like "Boards <= 3" matched
  nothing on healthy 3-board miners. num_value now returns the detected count;
  regression-tested with per-board health present (the path the old test missed).
- HIGH the WhatsMiner access probe ignored the operator's saved scan password
  (tried only admin/super), mis-reporting writable miners as locked. It now tries
  the caller's password first.
- HIGH firmware flash and config actions were not blocked during a restore-to-
  stock; start_action and both flash guards now refuse while a restore runs.
- MED log tail() could panic slicing at a non-UTF8 char boundary -> nudge to a
  boundary first (regression-tested).
- MED board_index_from_text grabbed an unrelated number far past the keyword
  (e.g. a temperature) -> only accept a number immediately after the keyword.
- MED a restore worker-thread spawn failure wedged the restore subsystem forever
  -> emit Done on spawn failure and treat a disconnected channel as done.
- MED LuxOS restore reported failure when the miner rebooted mid-reply -> an empty
  reply or dropped connection after a successful logon is the expected reboot.
- MED two tests raced on the process-global $HOME -> a shared serialization lock.
- LOW CSV export now neutralizes spreadsheet formula-injection prefixes on
  miner-supplied fields.
- Made miner_probe's global-only credential resolution explicit (it can't share
  the GUI's per-firmware configured_factory across the bin boundary).

99 tests (+3 regression tests) + clippy-clean + selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 19:30:29 -06:00
noahandClaude Opus 4.8 79ecc100d3 review wave 3: log-fetch credential leak + JSON escaping + column-scan cost
Second review round (over the wave 1/2 fixes) surfaced further, mostly new-path
findings; this clears the substantive ones:

- HIGH log_scan.rs passed miner admin credentials on the curl command line (same
  class as the access-probe leak fixed in wave 1). Its curl() now takes optional
  stdin: the Antminer digest login goes through a curl config on stdin (-K -),
  the VNish unlock password through the POST body on stdin (-d @-), and the
  timeout path reaps the child so it no longer leaks a zombie.
- MEDIUM JSON injection/breakage: the VNish unlock body and the LuxOS
  uninstall command spliced a password / miner-supplied SessionID into JSON with
  format!. Both now build the JSON with serde_json, which escapes correctly.
- MEDIUM column scan cost: fill_rows computed table_columns() twice (my wave-2
  built_columns check added one), and with auto-hide-empty on that scans every
  cell of every row each time. It is now computed once and reused.

Accepted, documented tradeoffs from this round: miner_probe's setpools takes the
pool password as a CLI arg (inherent to a diagnostic CLI; it is the low-sensitivity
mining worker password), MinerRow::upsert_into's linear scan is fine at the tool's
fleet scale (hundreds), and bulk config-action writes stay serial deliberately.

96 tests + clippy-clean + selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 19:18:27 -06:00
noahandClaude Opus 4.8 51b4eb2556 review wave 2: scan concurrency, table-column lockstep, background log fetch
Continuing the recursive review's confirmed findings:

- HIGH scan telemetry was serial: the consumer awaited each responder's to_row
  (get_data + presets, several REST calls) inline in the identification stream
  loop, so telemetry ran one miner at a time. Now buffer_unordered runs it
  concurrently up to SCAN_CONCURRENCY_LIMIT; identification (which buffers
  internally) is unaffected, and telemetry only hits live responders.
- HIGH table columns diverged from the built widget with auto-hide-empty on:
  (1) drag-reorder was silently rejected because column_reordered fed
  table_columns() (empty-filtered) to apply_visible_reorder, which compared it to
  display_columns() (unfiltered) -- apply_visible_reorder now reorders the shown
  subset in place; (2) a column flipping non-empty mid-scan left the widget stale,
  so fill_rows now rebuilds when the shown set no longer matches built_columns.
  Both covered by a new unit test.
- HIGH viewing a miner's log blocked the wx UI thread for up to ~20s. The fetch
  now runs on a background thread; the viewer opens from the tick drain when the
  result lands (tick returns the dialog for dispatch to show modally).
- LOW start_pools_action's fake branch now honours the cancel flag like its
  siblings.
- Documented the intentional tradeoffs the review flagged: scan-restart uses
  cooperative cancellation (a hard join would freeze the UI), and the aftermarket
  re-probe stays per-scan for freshness (firmware can change between scans).

96 tests (+subset-reorder) + clippy-clean + selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 19:02:39 -06:00
noahandClaude Opus 4.8 3b18219e4e review wave 1: fix the critical restore false-success + security/correctness findings
From the recursive multi-agent review (18 confirmed findings). This wave clears
the critical, four highs, and several mediums/lows:

- CRITICAL restore.rs: a Braiins SSH restore reported SUCCESS on a wrong password
  or unreachable miner. run_with_timeout now captures the exit code and drains
  stderr on its own thread (also fixing the medium stderr-pipe stall), and a new
  testable classify_braiins() treats an ssh auth/connection failure (stderr
  diagnostic, empty stdout, non-zero exit) as failure while still reading a
  dropped connection / timeout as the expected reboot. Unit-tested.
- HIGH restore exclusivity: apply_restore_confirm now refuses when a scan/refresh/
  action/flash or another restore is in flight, so this destructive action never
  overlaps or orphans a running restore handle.
- HIGH secrets off the command line: Braiins SSH uses `sshpass -e` (env, not -p),
  and the access-probe curl passes credentials through a config on stdin (-K -)
  instead of `-u user:pass`; both were visible in the process list. New masked
  password field (wxTE_PASSWORD bridge) so the Credentials dialog no longer
  renders saved passwords in the clear.
- MEDIUM correctness: per-board Chip-temp readings are now index-aligned with the
  boards (a missing middle board shows "-" instead of shifting later boards left).
- MEDIUM: saved pool lists (which can hold a pool password) are chmod 0600.
- LOW: access-probe curl timeout now reaps the child (no zombie).

95 tests (+classify_braiins) + clippy-clean + selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 18:45:56 -06:00
noahandClaude Opus 4.8 bcc0ba38b6 ci: install clippy component before the gate; classify all GUI src as backend
Run 82 failed because the alkane-ci image ships no clippy component
("cargo-clippy is not installed for the toolchain"). Both workflows now
`rustup component add clippy` before the gate.

Also broadened compute-version.sh: any crates/alkane-gui/src/* file is backend
logic (previously only scan.rs/model.rs/main.rs were, so a fix confined to
naming.rs / pool_prefs.rs / restore.rs / access_probe.rs / credentials.rs would
never cut a release). ui.rs/fixtures.rs/bin still match the UI arm first. All 9
compute-version tests pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 18:22:32 -06:00
noahandClaude Opus 4.8 749cdc4eed item 12: CI verify/release split, dependency audit, README + badges
CI is now two workflows: verify.yml (pull requests + non-main pushes) runs the
clippy gate, build, unit tests, microbenchmarks, the headless self-test, and a
best-effort dependency audit; release.yml (main) repeats the clippy gate + audit
before its existing build/test/selftest/package/release, then refreshes the
committed README badges and pushes any change back (best-effort, and a badges-
only push does not bump the version, so it does not loop).

Security: cargo audit found a build-time-only advisory (h2 0.3 in the wx-rs
build script's reqwest 0.11 subtree, never linked into the runtime binary and
never executed on Linux). The vendored/offline tree can't upgrade it without
re-vendoring, so it is documented and accepted in .cargo/audit.toml (mirrored in
deny.toml with the project's permissive-license policy).

Badges: ci/gen-badges.py emits self-contained shields-style SVGs into badges/
(tests, coverage 36%, bench, LOC 12.5k, clippy clean, dependencies, license) --
committed and referenced by relative path so a self-hosted Gitea renders them
with no external service. README rewritten around what the toolkit actually does
today (discover / monitor / operate / install), with build, CLI, dev, and
architecture sections and the dual-license note.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 18:17:31 -06:00
noahandClaude Opus 4.8 19e469ebc4 item 12: clippy-clean our crate + add LICENSE files
Cleared all clippy findings in alkane-gui (cargo clippy --no-deps): mechanical
fixes via clippy --fix (redundant imports, useless format!, manual_contains,
manual_is_multiple_of, unnecessary_map_or, unused parens) plus manual fixes:

- type_complexity: factored the segment tuple into model::{Rgb, Segment} aliases.
- large_enum_variant: #[allow] on ScanMsg/RefreshMsg with a note -- Row is the
  common variant, so boxing it to shrink the rare Started/Done would add an
  allocation per miner on the hot path.
- dead code: removed unused SHAPE_PULSE_DOT, ColorKind::Accent, clear_op_status,
  and RestoreMsg's unread `total`; kept the restore/access-probe cancel handles
  (workers honour cancellation; UI stop control pending) under #[allow].
- question_mark, needless_range_loop, drop_non_drop, doc_lazy_continuation fixes.

Only vendored wx-rs warnings remain (out of scope). Added LICENSE-MIT and
LICENSE-APACHE (Cargo.toml already declares MIT OR Apache-2.0). 94 tests +
selftest green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 18:01:49 -06:00
noahandClaude Opus 4.8 6cd732dec5 Round C G7 (read side): per-board voltage/frequency in the board tooltip
Surfaces the per-hashboard configured voltage (V) and frequency (MHz) that
asic-rs already reads into BoardData but the toolkit dropped. Added
MinerRow.board_voltages / board_frequencies (index-aligned with the boards,
0.0 where unreported), populated at scan time, and appended to the per-board
Health tooltip as extra middot segments after actual/expected hashrate.

Verified live on LuxOS S19j Pro (10.4.1.60): boards report 12.73 V (frequency
is None in LuxOS's live stats path -- a pre-existing backend gap; the tooltip
omits absent values). miner_probe `msgs` now prints board freq/volt too.

The G7 WRITE path (per-board V/F override) stays deferred: no firmware accepts
Manual targets today and a bad voltage can damage a board, so per the parity
roadmap it is bench-only and not shipped.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 17:40:32 -06:00
noahandClaude Opus 4.8 95b8428c12 Round C G3: named firmware presets (LuxOS) end to end
The flagship structured-tuning parity item: list and select a firmware's named
profiles/presets, not just map a watts number onto one.

Backend (vendored asic-rs, patch 0022): LuxOS now implements SupportsPresets
(get_presets reads the live `profiles` RPC) and a real SupportsTuningConfig
(set_tuning_config routes Preset(name) -> profileset, Power -> set_power_limit).
Unit-tested (parse_profiles_to_presets); verified live-read on two production
LuxOS S19j Pro (10.4.1.60/.67). VNish already exposed presets.

GUI: MinerCaps.supports_presets + MinerRow.presets (read live at scan time for
preset-capable miners; ~1 RPC per such miner per 300 s rescan). New "Set
profile..." right-click item opens a selector populated from the profiles
common to the whole selection (so the chosen name is valid on every target),
applied via the new ConfigAction::Preset. Offline fixtures seed demo presets.

CLI: `miner_probe presets <ip>` (list) and `setpreset <ip> <name>` (select).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 17:34:26 -06:00
noahandClaude Opus 4.8 a7ed34b8e4 gui: pool "+" "Add new..." opens a preset manager window (round 18 #8b)
The pool-field "+" menu previously offered a one-shot "Add new" (append
the current box value) plus a "Remove saved value" submenu. Both are now
replaced by "Add new...", which opens a small manager window: a multiline
editable list of all saved values for that field, seeded with the current
box value as the last line. Save rewrites the whole saved list at once.

- pool_prefs: new save_all() rewrites a field's saved list; the trim /
  drop-empties / drop-presets / de-dup step is factored into a pure
  dedupe_saved() with unit tests. Removed the now-unused add_saved /
  remove_saved.
- ui: build_pool_presets_dialog + apply_pool_presets, wired to
  ID_POOL_PRESETS_SAVE/CANCEL; "+" menu shows "Add new..." and no longer
  builds the remove submenu; ID_POOL_MENU_REMOVE_BASE dropped.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 17:10:45 -06:00
noahandClaude Opus 4.8 b839e9012d gui: default column widths fit contents, capped (round 18 #10)
Columns previously always opened at generous fixed defaults, wasting
horizontal space. Now, the first time the table is populated after a
(re)build, each column is sized to the smaller of its content-fit width
(wxCOL_WIDTH_AUTOSIZE, floored at 24px) and its configured default (the
cap). Done once per rebuild via a new columns_autosized latch, so a
user's later manual resize is preserved -- scan-update refills skip it.

New bridge: wxbr_dvlc_autosize_col_capped (SetWidth AUTOSIZE, read back,
floor, clamp to cap, SetWidth) + Widget::dvlc_autosize_col_capped.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 17:01:25 -06:00
noahandClaude Opus 4.8 d378a484d6 ui: attribute hashboard faults + pools dialog + widths (round 18 #5/#8a/#8c)
- #5 Antminer-hardware firmwares (stock/VNish/Braiins/LuxOS) report faults with no
  component, so a real per-board fault landed on the control-board tooltip instead
  of the board it names. messages_to_faults now recovers the board index from the
  self-describing message text ("Chain 2 ...", "hashboard 0 ...", "Slot 1 ...") so
  the issue shows on the right hashboard's tooltip. WhatsMiner (which does attribute
  HashBoard{idx}) is unchanged.
- #8a The pools dialog is widened so the rightmost "+" preset buttons (Password
  column) are no longer clipped off a too-narrow dialog.
- #8c The pool column headers now span field-width + the 34px "+" button, so the
  "Address/Account/Worker/Password" titles line up with the boxes below them.

board_index unit test + SELFTEST pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 16:52:24 -06:00
noahandClaude Opus 4.8 64e084ddee ui: per-icon tooltip repositioning + Zcash units/expected (round 18 #4a/#6/#7)
- #4a Health-column tooltips now reposition per icon: the query-tooltip handler
  scopes GTK's tip area to the hovered icon's slot, so moving across icons hides
  the old tooltip and shows a fresh one at the new position (was stuck in place).
- #6 Plain Antminer Z15 firmware omits the expected hashrate (the Z15j reports it),
  so it's filled from the model nameplate (420 KSol/s) -- the actual/expected
  column + colour now work for Z15 like every other miner.
- #7 Equihash hashrate now shows correct units: Sol/s (not TH/s). The stored value
  is Sol/s/1e12, so ths*1e12 recovers the Sol/s count; the per-board tooltip and
  the hashrate KPI card now label Equihash as Sol/s with an SI prefix.

Unit tests (equihash_hashrate_units) + health tests pass; SELFTEST PASS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 16:45:45 -06:00
noahandClaude Opus 4.8 93bd528430 health: PSU-fault colour rules + per-board actual/expected tooltip (round 18 #2/#3/#4b)
- #2 A PSU fault while the miner is mining is now a warning (yellow) not a failure
  (red); a fault on a non-mining miner stays red. Fixes WhatsMiners flagged red
  while running fine.
- #4b A PSU fault no longer greys the hashboards. Board colour reflects the board's
  own state: running -> green, faulted (e.g. WhatsMiner 540/560) -> red, and grey
  ONLY when the board is genuinely not detected. Stall-reddened boards the fault
  codes don't name are still exonerated to green; undetected boards stay grey.
- #3 The per-board tooltip shows actual / expected hashrate (e.g. "2  .  33.5 / 35.0
  TH/s"); a not-detected board shows "not detected". Adds MinerRow.board_expected_
  hashrates (from BoardData.expected_hashrate) + an algorithm-aware hashrate unit
  (Equihash -> Sol/s, groundwork for #7).

Health tests updated + pass; SELFTEST PASS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 16:36:00 -06:00
noahandClaude Opus 4.8 e45e6eaf91 ui: shrink brain icon, light toggle, blank all unknown-PIC (round 18 #1/#9/#11)
- #1 The control-board (brain) Health icon is drawn at 82% in its full slot, like
  the fan, so it no longer reads oversized (slot advance + tooltip hit-test unchanged).
- #9 The right-click menu now shows a single state-based light toggle: "Stop
  flashing lights" when any selected miner's locate light is on, else "Flash lights".
- #11 The PIC column is blank for every unknown case (non-Antminer makes and
  unclassifiable Antminer models) -- no more "?".

SELFTEST PASS; pic test updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 16:28:26 -06:00
noahandClaude Opus 4.8 e5a6cc2b5e psu: extend PSU-info scan to Braiins + WhatsMiner (R5/G15)
Round 17 R5/G15. The PSU version/Vmin/Vmax columns + tooltip now populate for
Braiins and WhatsMiner, not just ePIC.

- Braiins (patch 0020): miner/details -> psu_info gives the PSU type (117, the
  same APW12 ePIC reports) + rated voltage min/max. Verified live on 10.4.1.83/.27:
  model 117, Vmin 11.96 V, Vmax 15.2 V.
- WhatsMiner v1/v2 (patch 0021): get_psu -> model + hw/sw version (no DC output or
  rated envelope exposed). Verified live on 10.8.1.214 (v2): model P221C, version
  H20201205. v3 uses a different response shape and no v3 unit was available, so
  it's left as a follow-up.
- Also fixes a pre-existing broken test (test_whatsminer_v1_parse_messages never
  mocked get_error_code -> always returned 0 messages; CI runs only the GUI
  selftest so it was never caught). whatsminer backend tests now 41/41.

SELFTEST PASS; braiins + whatsminer backend suites green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 16:07:53 -06:00
noahandClaude Opus 4.8 6fb73c9746 firmware: detect + label Bixbit and Hiveon (own colours)
Bixbit and Hiveon keep the stock Antminer web API, so asic-rs identifies them as
"AntMiner Stock". Distinguish them at scan time from the cgminer `version` reply:
Bixbit tags it with BixFirmware/BixMiner/BixAPIVersion (definitive; verified live on
a Bixbit S19j Pro at 10.4.1.70); Hiveon carries a "hiveon" marker (best-effort --
no live Hiveon unit to confirm the exact signature yet). A real stock miner (no
marker) stays "Stock".

Firmware column colours: Bixbit -> pinkish-red (223,62,102, their logo); Hiveon ->
darker logo orange (228,112,24), with "hiveon" added to the existing hive/hiveos
alias. The probe is a short, timeout-bounded cgminer query run only for Antminer
miners that first identified as stock.

SELFTEST PASS. Hiveon detection to be re-verified once a Hiveon miner is available.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 14:15:43 -06:00
noahandClaude Opus 4.8 49985631d4 antminer: read best-share fleet-wide + Bixbit "Power Estimated" wattage (R7)
Round 17 R7. Flashing Bixbit onto fleet units surfaced two Antminer scan gaps
(patch 0019): the stock v2023_07 backend never fetched best-share at all
(DataField::BestShare had no source), so it was blank for every stock/Bixbit
Antminer; and it read wattage only from the cgminer stats, which Bixbit-based
firmware leaves at 0 (real draw is in the summary as "Power Estimated").

Now maps BestShare/SessionBestShare to the cgminer summary and adds a
"Power Estimated" wattage fallback (stock power still wins when present).

Verified live: Bixbit S19j Pro (10.4.1.70) now reads 2615 W + best-share
178930671; stock S21 Pro (10.4.1.90) now reads best-share 299464394 -- both were
blank before. 36 antminer backend tests + SELFTEST pass, no wattage regression.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 13:34:01 -06:00
noahandClaude Opus 4.8 8fe61ec427 psu: PSU info scan + version/Vmin/Vmax columns + tooltip V/A (R5/G15)
Round 17 R5/G15. asic-rs had no PSU telemetry. Adds an optional PsuInfo to
MinerData (model, version, rated voltage min/max, live output voltage/current),
a DataField::Psu, and a default parse_psu backends override (patch 0018). ePIC
populates it by merging the summary "Power Supply Stats" with the capabilities
"Psu Info".

GUI: three new columns -- "PSU version", "PSU Vmin", "PSU Vmax" (Hardware group in
the picker) -- and the R2 power tooltip now shows the PSU output voltage (and
amperage when the firmware reports a non-zero current; ePIC leaves current 0, so
it shows just the voltage).

Verified live on ePIC S19j Pro (10.4.1.6/.10): model 117, fw 22, Vmin 11.877 V,
Vmax 15.182 V, output ~13.2 V. 8 model tests + 18 ePIC backend tests + SELFTEST
pass. Non-ePIC firmware leave the PSU fields blank until they add parse_psu.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 12:24:26 -06:00
noahandClaude Opus 4.8 34a1a1f3b1 tuning: structured power + hashrate target dialogs (Round C)
Round 17 C, first GUI increment. Adds "Set power target..." and "Set hashrate
target..." to the right-click config menu, each a value prompt that shows the
miner's current target and the firmware-advertised valid range, and validates the
entry against it.

- Power target routes through the existing set_power_limit path (LuxOS/Braiins/
  WhatsMiner; VNish stays masked per operator guidance). Where the firmware
  advertises an envelope (Braiins: 944-6435 W) the prompt shows and enforces it.
- Hashrate target routes through set_tuning_config for firmware that tunes by
  hashrate (ePIC). The apply path preserves the firmware's current tuning
  algorithm and scaling config (ePIC's set_tuning_config requires both), reading
  them back before writing the new target.

Model gains: MinerRow.tuning_target_label + power/hashrate target min/max
(from data.tuning_capabilities), and MinerCaps.hashrate_target (set when the miner
actively tunes by hashrate via set_tuning_config). miner_probe's settune verb now
mirrors the same algorithm+scaling-preserving apply path.

Verified live (reversibly, restored after): ePIC S19j Pro (10.4.1.6) hashrate
94->92->94 TH via set_tuning_config Ok(true); LuxOS/Braiins power targets via
set_power_limit (see the luxminer profile-name fix). Model tests + SELFTEST pass.

Presets (G3) and per-board manual V/F (G7) are deferred: no firmware enumerates
its presets through the standard tuning_capabilities API.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 11:33:43 -06:00
noahandClaude Opus 4.8 0db89d6c55 miner_probe: add tune (read) + settune (write) verbs for structured tuning
Round 17 C groundwork. `tune <ip>` dumps a miner's structured-tuning surface --
what it supports (power_limit / tuning_percent / tuning_config), its current
target, and the capability envelope (power/hashrate min-max or preset list) the
firmware advertises. `settune <ip> <power|hashrate> <v>` applies a target via
set_tuning_config where supported (ePIC/VNish/WM), falling back to the plain
power-limit setter for a power target on firmware that tunes by power
(LuxOS/Braiins).

Used to map the live fleet before wiring the GUI: ePIC tunes by hashrate via
set_tuning_config (needs an algorithm + scaling config); LuxOS/Braiins tune by
power via set_power_limit; VNish/WM accept set_tuning_config; only Braiins
advertises a min/max envelope; preset lists are not exposed by any firmware's
tuning_capabilities.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 11:21:07 -06:00
noahandClaude Opus 4.8 08b3d56864 luxminer: set power-limit profile by name so the default profile is reachable
Round 17 C, found via live tuning verification. LuxOS set_power_limit mapped
watts to a profile but applied it by the profile's Step. The factory "default"
profile has Step "0", which LuxOS profileset reads as an empty parameter
("Missing profile parameter"), so the setter could never select the default and
a miner nudged off it by a watts limit could not be returned to its factory
point. Key on the profile Name instead (patch 0017).

Verified live on a LuxOS S19j Pro (10.4.1.60): set_power_limit(2700)->480MHz/2632W,
set_power_limit(2900)->default/2794W (previously errored). Unit test updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 11:20:51 -06:00
noahandClaude Opus 4.8 4e825f3ee5 health: bare-data per-component tooltips (R2)
Round 17 R2. The Health column's per-icon tooltips were prose ("Hashboard 3:
faulted", "Power supply: OK (drawing power)"). Replace them with just the data an
operator wants:

- Hashboards: an operating board shows its number counting DOWN (n-1..0, left to
  right) and its hashrate ("2  ·  33.5 TH/s"); a faulted board shows its error
  message with the firmware code; a board the failed PSU left untested shows
  "unpowered". No "Hashboard N:" prose.
- Fans: just the RPM ("4700 rpm"), unless the fan has a fault (then the error+code).
- Control board: its own and un-attributed faults with codes, else a short OK.
- Power: a healthy PSU's output voltage + amperage when reported, else a short OK;
  a faulted PSU shows the error and code.

Adds per-board hashrate (BoardData.hashrate) and the firmware error code
(MinerMessage.code) to the model, and forward-compatible PSU output V/A fields.
asic-rs does not yet expose PSU output V/A (roadmap G15), so the healthy-PSU
tooltip shows "PSU OK" until that lands, at which point it auto-upgrades to "V / A".

Unit tests (faults_attribute, health_tooltips_are_bare_data_round17_r2) pass;
SELFTEST PASS. Live data confirmed available (per-board hashrate + fan RPM on the
Braiins corpus miners).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 10:45:15 -06:00
noahandClaude Opus 4.8 8e67c50fe0 health/pic: shrink fan icon (R1), blank PIC for non-Antminers (R6), add build cleanup
Round 17 queue.

R1 -- the cooling-fan icon in the Health column read as oversized next to the
brain/chip/bolt icons. All four use a square 512x512 viewBox at the same slot
size, so the fan only *looked* bigger because the Font Awesome fan glyph fills
its box more. Draw the fan at 80% size, centred in its full-size slot, so the
slot advance and the per-icon tooltip hit-test (both keyed to the full width)
are unchanged and nothing else moves.

R6 -- WhatsMiner and other non-Antminer makes showed "?" in the PIC column. A
per-board PIC MCU is an Antminer hashboard property with no meaning elsewhere, so
the cell now shows nothing for non-Antminer brands; an unknown *Antminer* model
still shows "?".

Build hygiene (user ask) -- add scripts/clean-old-builds.sh to reclaim the local
cargo target dir. The app/CLI ship as release and tests run under --release, so
the debug tree, cross-compile trees, and coverage tree are disposable; a stray
cargo check had grown the debug tree to 38G and filled the disk. The script drops
those, keeps the warm release build, and is meant to run after each release push.

SELFTEST PASS; model tests (pic_locked, faults_attribute, health) pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 10:31:51 -06:00
noahandClaude Opus 4.8 da0d1582be scan: cap identification concurrency at 128 to fix Braiins value dropout (R4)
Round 17 R4. Scanning most values from Braiins OS units failed under a
full fleet scan: a /24 returned watts=0 and no best-share/temps/fw for
Braiins miners (and dropped a few responders entirely), while the same
miner scanned in isolation populated fully.

Root cause: asic-rs picks a scan concurrency of 1000 for any range up to
/22, so a /24 fires all ~254 address probes at once. Over a real link
(the fleet is reached across a WireGuard VPN, and a subnet full of dead
IPs holds every TCP connect open for the whole identification timeout)
that burst starves the per-responder get_data. A Braiins miner fans out
~12 authenticated REST calls; under the burst they drop miner/stats, so
"most values" come back blank. It is not FD exhaustion (nofile is 500k),
not the per-call timeout, and not an auth race.

Fix: cap identification concurrency at 128 in the app (GUI scan +
miner_probe). On the live fleet 128 was the highest cap that stayed fully
reliable -- 192 already dropped responders, 254 blanked a Braiins miner.
A /24 still finishes in ~35s; larger ranges just take proportionally
longer and stay correct.

Belt-and-suspenders in the braiins backend (patch 0016): single-flight
the login (one auth instead of ~12 concurrent) and widen the defensive
get_data timeout 5s -> 15s.

Verified live: 10.4.1.0/24 now populates both Braiins corpus miners
(.27 watts=2748 best=55217110, .83 watts=2749) fully and misses no
responders (65/65). SELFTEST PASS.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 09:59:27 -06:00
noahandClaude Opus 4.8 7f802c568f Scan progress: smooth per-address counter (was jumping ~1%/second)
The scan counter jumped in big steps (e.g. +45 for a 4590-address scan) because
(a) progress was only emitted every total/100 addresses and (b) the drain timer
ran once per second, so the gauge only refreshed ~1 Hz. The +45 was total/100, not
a chosen value.

Fix, both cheap:
- scan.rs emits progress per address (throttled only above 5000 addresses to bound
  channel traffic) instead of every 1%.
- ui.rs runs the scan/drain timer at 200 ms (5 Hz) so the counter climbs smoothly;
  drain_scan coalesces the many per-address updates into ONE gauge/status update
  per drain (no extra repaints). A tick accumulator keeps the once-per-second work
  (auto-rescan countdown, idle status) at 1 Hz despite the faster tick.

Net: the counter now climbs several times a second in small increments; overhead
is negligible (unbounded mpsc sends are cheap and the gauge still repaints once per
tick). No user-facing setting added -- the smoothness is size-independent.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Djv3oncM4LxTS5tb61Ako6
2026-09-22 09:21:33 -06:00
238 changed files with 90641 additions and 2211 deletions
+20
View File
@@ -0,0 +1,20 @@
# cargo-audit configuration (read by `cargo audit` from the project root).
#
# The two entries below are accepted, documented exceptions -- both live only in
# the wx-rs BUILD-dependency tree (reqwest 0.11, used by wx-rs's build.rs to
# download the wxWidgets source on Windows/macOS). On Linux download_dist()
# returns before ever constructing an HTTP client, and none of this is linked
# into the runtime binary, which talks to miners over asic-rs's reqwest 0.13
# (hyper 1.x / h2 0.4). The build tree is fully vendored and offline, so these
# cannot be upgraded without re-vendoring a newer reqwest.
#
# Re-review whenever the vendored dependency set is refreshed.
[advisories]
ignore = [
# h2 0.3 unbounded empty DATA frames (DoS). Build-time only; our build-time
# HTTP client only fetches a fixed HTTPS URL, and only on Windows/macOS.
"RUSTSEC-2026-0258",
# rustls-pemfile 1.0.4 unmaintained. Same build-only reqwest 0.11 subtree.
"RUSTSEC-2025-0134",
]
+21
View File
@@ -0,0 +1,21 @@
name: completed-ci-badge
on:
workflow_run:
workflows: [build-test-release, next-build]
types: [completed]
jobs:
publish:
runs-on: alkane-verify
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
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
+166
View File
@@ -0,0 +1,166 @@
name: next-build
on:
push:
branches: [next]
concurrency:
group: alkane-toolkit-next
cancel-in-progress: false
permissions:
contents: write
jobs:
# Windows build of the candidate (see release.yml's windows job); the
# candidate job attaches its zip next to the Linux tarball.
windows:
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
env:
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_WINDOWS_PREFIX: /root/.cache/wx-3.3.3-mingw
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Select candidate version
id: version
run: bash ci/compute-rc-version.sh >> "$GITHUB_OUTPUT"
- name: Install Windows toolchain
if: steps.version.outputs.release == 'true'
run: bash ci/windows-ci.sh toolchain
- name: Configure bounded Rust compiler cache
if: steps.version.outputs.release == 'true'
run: bash ci/configure-rust-cache.sh
- name: Compute wxMSW cache key
if: steps.version.outputs.release == 'true'
id: wx-key
run: bash ci/wx-cache-key.sh windows
- name: Check prebuilt wxMSW
if: steps.version.outputs.release == 'true'
id: wx-image
run: bash ci/check-wx-image-prefix.sh windows
- id: wx-cache
if: steps.version.outputs.release == 'true' && steps.wx-image.outputs.available != 'true'
uses: actions/cache/restore@v4
continue-on-error: true
with:
path: /root/.cache/wx-3.3.3-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxMSW
if: steps.version.outputs.release == 'true'
id: wx-build
run: bash ci/ensure-wx-prefix.sh windows
- name: Save vendored wxMSW build
if: steps.version.outputs.release == 'true' && 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-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Build Windows candidate
if: steps.version.outputs.release == 'true'
run: bash ci/windows-ci.sh build
- name: Sign Windows candidate (Azure Artifact Signing)
if: steps.version.outputs.release == 'true'
env:
AZURE_SIGNING_PROFILE: ${{ vars.AZURE_SIGNING_PROFILE }}
AZURE_SIGNING_TENANT_ID: ${{ secrets.AZURE_SIGNING_TENANT_ID }}
AZURE_SIGNING_CLIENT_ID: ${{ secrets.AZURE_SIGNING_CLIENT_ID }}
AZURE_SIGNING_CLIENT_SECRET: ${{ secrets.AZURE_SIGNING_CLIENT_SECRET }}
run: bash ci/windows-ci.sh sign
- name: Package Windows candidate
if: steps.version.outputs.release == 'true'
run: bash ci/windows-ci.sh package "${{ steps.version.outputs.version }}"
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
if: steps.version.outputs.release == 'true'
with:
name: alkane-toolkit-windows
path: dist/alkane-toolkit-v*-windows-x86_64.zip
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
candidate:
needs: windows
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
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: Fetch Windows candidate
if: steps.version.outputs.release == 'true'
uses: https://github.com/ChristopherHX/gitea-download-artifact@75635f32b4c1c41c4b3d64e8f85210112ed4c9c7
with:
name: alkane-toolkit-windows
path: dist/windows
- name: Create private prerelease
if: steps.version.outputs.release == 'true'
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: |
set -euo pipefail
V="${{ steps.version.outputs.version }}"
WIN="dist/windows/alkane-toolkit-v${V}-windows-x86_64.zip"
[ -s "$WIN" ] || { echo "Windows candidate for ${V} is missing" >&2; exit 1; }
python3 ci/release-rc.py "${{ steps.version.outputs.tag }}" true \
"dist/alkane-toolkit-${V}-linux-x86_64.tar.gz" "$WIN"
- 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
+47
View File
@@ -0,0 +1,47 @@
name: pages
# The project site, https://blueflare.gitea.bluefla.re/alkane-toolkit/ :
# overview, user manual (docs/manual), code-quality dashboard (from the
# quality record main CI publishes with the badges) and benchmark history.
# Rebuilt after every main build-test-release run and published to this
# repository's gh-pages branch.
on:
workflow_run:
workflows: [build-test-release]
types: [completed]
workflow_dispatch:
concurrency:
group: alkane-toolkit-pages
cancel-in-progress: false
jobs:
publish:
runs-on: alkane-verify
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Install page tools
run: bash ci/ensure-build-deps.sh pages
- name: Render measured benchmark history
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/bench_history.py render
- name: Fetch measured quality record
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/fetch-quality.py quality.json
- name: Build site
run: |
python3 ci/build-pages.py --out site --quality quality.json \
--bench bench-site/index.html --sha "$GITHUB_SHA"
- name: Publish site
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
run: python3 ci/publish-pages.py site
- name: Clean generated site
if: always()
run: python3 ci/cleanup-generated.py
+292 -45
View File
@@ -1,16 +1,33 @@
name: build-test-release
# Runs on every merge/push to main: build the GUI, run tests + a microbenchmark,
# and (when the change warrants it) cut an X.Y.Z release with the binary attached.
# Runs on every merge/push to main: build the GUI for Linux and Windows, run the
# tests + a microbenchmark, and (when the change warrants it) cut an X.Y.Z
# release with both binaries attached.
on:
push:
branches: [main]
concurrency:
group: alkane-toolkit-main
cancel-in-progress: false
permissions:
contents: write
actions: write
jobs:
release:
# Windows build of the same commit: cross-compiled with mingw-w64 against the
# vendored wxMSW, unit-tested and UI-self-tested under Wine, packaged as a
# zip. The release job below waits for it and attaches the zip next to the
# Linux tarball, so a release never ships one platform without the other.
windows:
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
env:
WX_PREFIX: /root/.cache/wx-3.3.3-linux
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_WINDOWS_PREFIX: /root/.cache/wx-3.3.3-mingw
steps:
- name: Checkout (full history for tags)
uses: actions/checkout@v4
@@ -21,33 +38,178 @@ jobs:
id: ver
run: bash ci/compute-version.sh | tee -a "$GITHUB_OUTPUT"
- name: Test version logic
- name: Install Windows toolchain
run: bash ci/windows-ci.sh toolchain
- name: Configure bounded Rust compiler cache
run: bash ci/configure-rust-cache.sh
- name: Compute wxMSW cache key
id: wx-key
run: bash ci/wx-cache-key.sh windows
- name: Check prebuilt wxMSW
id: wx-image
run: bash ci/check-wx-image-prefix.sh windows
- name: Cache vendored wxMSW build
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-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxMSW (once, then cached)
id: wx-build
run: bash ci/ensure-wx-prefix.sh windows
- name: Save vendored wxMSW 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-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Clippy (Windows target, warnings are errors)
run: bash ci/windows-ci.sh clippy
- name: Set crate version to ${{ steps.ver.outputs.version }}
if: steps.ver.outputs.release == 'true'
run: |
sed -i "0,/^version = \".*\"/s//version = \"${{ steps.ver.outputs.version }}\"/" Cargo.toml
grep -m1 '^version' Cargo.toml
- name: Build release (Windows)
run: bash ci/windows-ci.sh build
- name: Unit tests (Windows build, under Wine)
run: bash ci/windows-ci.sh test
- name: Headless UI self-test (Windows build, under Wine)
run: bash ci/windows-ci.sh selftest
- name: Sign Windows executable (Azure Artifact Signing)
env:
AZURE_SIGNING_PROFILE: ${{ vars.AZURE_SIGNING_PROFILE }}
AZURE_SIGNING_TENANT_ID: ${{ secrets.AZURE_SIGNING_TENANT_ID }}
AZURE_SIGNING_CLIENT_ID: ${{ secrets.AZURE_SIGNING_CLIENT_ID }}
AZURE_SIGNING_CLIENT_SECRET: ${{ secrets.AZURE_SIGNING_CLIENT_SECRET }}
run: bash ci/windows-ci.sh sign
- name: Package Windows artifact
if: steps.ver.outputs.release == 'true'
run: bash ci/windows-ci.sh package "${{ steps.ver.outputs.version }}"
- name: Bundle Windows test executables
run: bash ci/windows-ci.sh test-bundle
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
if: steps.ver.outputs.release == 'true'
with:
name: alkane-toolkit-windows
path: dist/alkane-toolkit-v*-windows-x86_64.zip
# Consumed by .gitea/workflows/windows-native.yml on the Windows VM runner.
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@81f940d004763f986ba3582c007fd842dd5cb0d7
with:
name: alkane-toolkit-windows-tests
path: |
dist/alkane-toolkit-windows-tests.zip
target/x86_64-pc-windows-gnu/release/alkane-toolkit.exe
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
release:
needs: windows
runs-on: alkane-ci
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
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).
WX_RS_WXCONFIG: /root/.cache/wx-3.3.3-linux/bin/wx-config
steps:
- name: Checkout (full history for tags)
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Check wx-rs patch queue reproduces the patched tree
run: python3 scripts/wx_rs_patches.py check
- name: Check first-party Rust formatting
run: |
rustup component add rustfmt >/dev/null
cargo fmt -p alkane-gui -p alkane-artifacts -p alkane-flash -p alkane-cli -p alkane-access -p alkane-core -- --check
- name: Compute version
id: ver
run: bash ci/compute-version.sh | tee -a "$GITHUB_OUTPUT"
- name: Test version logic
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'
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)
run: |
if [ ! -x "$WX_PREFIX/bin/wx-config" ]; then
bash scripts/build-wx-linux.sh
else
echo "wx prefix restored from cache"
fi
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'
@@ -56,31 +218,107 @@ jobs:
grep -m1 '^version' Cargo.toml
- name: Build release
if: steps.ver.outputs.release == 'true'
run: |
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
cargo build --release -p alkane-gui --offline
- name: Unit tests
if: steps.ver.outputs.release == 'true'
run: |
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
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: |
export WX_RS_WXCONFIG="$WX_PREFIX/bin/wx-config"
cargo test -p alkane-gui --release --offline -- --ignored --nocapture bench_
# Require every declared benchmark before publishing history or a release.
set -o pipefail
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)
continue-on-error: true
run: |
if command -v cargo-audit >/dev/null 2>&1; then
cargo audit || echo "cargo audit reported findings (accepted ones in .cargo/audit.toml)"
else
echo "cargo-audit not installed on this runner; skipping"
fi
- 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
run: |
set -euo pipefail
rustup component add llvm-tools-preview >/dev/null 2>&1 || true
[ "$(cargo llvm-cov --version)" = 'cargo-llvm-cov 0.8.7' ]
# Keep the whole table: gen-badges turns it into the per-crate and
# per-file breakdown on the Pages quality dashboard.
bash ci/coverage.sh --summary-only | tee coverage-summary.txt
PCT=$(awk '/^TOTAL/{gsub(/%/,"",$10); print $10}' coverage-summary.txt)
[ -n "$PCT" ] || { echo "coverage report produced no TOTAL line" >&2; exit 1; }
echo "pct=${PCT}" >> "$GITHUB_OUTPUT"
echo "line coverage (tests + self-test): ${PCT}%"
- name: Microbenchmark coverage
id: benchcov
run: |
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 \
--coverage-summary coverage-summary.txt
- 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
@@ -102,25 +340,34 @@ jobs:
echo "asset=dist/${NAME}.tar.gz" >> "$GITHUB_OUTPUT"
echo "assetname=${NAME}.tar.gz" >> "$GITHUB_OUTPUT"
- name: Fetch Windows artifact
if: steps.ver.outputs.release == 'true'
uses: https://github.com/ChristopherHX/gitea-download-artifact@75635f32b4c1c41c4b3d64e8f85210112ed4c9c7
with:
name: alkane-toolkit-windows
path: dist/windows
- name: Locate Windows artifact
if: steps.ver.outputs.release == 'true'
id: winpkg
run: |
set -euo pipefail
V="${{ steps.ver.outputs.version }}"
ZIP="dist/windows/alkane-toolkit-v${V}-windows-x86_64.zip"
[ -s "$ZIP" ] || { echo "Windows artifact for v${V} is missing" >&2; ls -lR dist/windows >&2; exit 1; }
echo "asset=$ZIP" >> "$GITHUB_OUTPUT"
- name: Create Gitea release + upload artifact
if: steps.ver.outputs.release == 'true'
env:
TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITEA_TOKEN: ${{ secrets.GITEA_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}"
python3 ci/release-rc.py "${{ steps.ver.outputs.tag }}" false \
"${{ steps.pkg.outputs.asset }}" "${{ steps.winpkg.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
+27
View File
@@ -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:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
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
+266
View File
@@ -0,0 +1,266 @@
name: verify
# Full quality gate for pull requests to main.
on:
pull_request:
branches: [main]
concurrency:
group: alkane-toolkit-verify-${{ github.ref }}
cancel-in-progress: true
jobs:
verify:
runs-on: alkane-verify
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
outputs:
surface: ${{ steps.surface.outputs.surface }}
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
with:
fetch-depth: 0
- name: Check runner image pins
run: python3 ci/check-runner-image.py
- name: Check wx-rs patch queue reproduces the patched tree
run: python3 scripts/wx_rs_patches.py check
- 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: |
base="$(git merge-base HEAD "origin/$GITHUB_BASE_REF")"
git diff --check "$base" HEAD
# Vendored upstream trees carry their own test-fixture keys (openssl,
# rustls-pemfile, aws-lc); only first-party sources are checked.
if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' -- ':!vendor' ':!thirdparty'; then
echo "private key material found in tracked source" >&2
exit 1
else
status=$?
[ "$status" -eq 1 ]
fi
- name: Check CI change surface
if: steps.surface.outputs.surface != 'documentation'
run: python3 ci/test-pr-surface.py
- name: Check first-party Rust formatting
if: steps.surface.outputs.surface == 'headless' || steps.surface.outputs.surface == 'full'
run: |
rustup component add rustfmt >/dev/null
cargo fmt -p alkane-gui -p alkane-artifacts -p alkane-flash -p alkane-cli -p alkane-access -p alkane-core -- --check
- 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
# Vendored upstream trees carry their own test-fixture keys (openssl,
# rustls-pemfile, aws-lc); only first-party sources are checked.
if git grep -nIE '^[[:space:]]*-----BEGIN (RSA |EC |OPENSSH )?PRIVATE KEY-----[[:space:]]*$' -- ':!vendor' ':!thirdparty'; 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
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
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: |
bash ci/ensure-build-deps.sh ui
BIN=target/release/alkane-toolkit
xvfb-run -a env GDK_BACKEND=x11 ALKANE_SELFTEST=1 "$BIN"
# Advisory audit is best-effort: it needs the RustSec DB over the network,
# which the vendored/offline build otherwise never touches, so a locked-down
# 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
cargo audit || echo "cargo audit reported findings (see .cargo/audit.toml for accepted ones)"
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
# The Windows build of the same change (main's release gate, run on the PR):
# clippy for the Windows target, the release .exe, every unit test under
# Wine, and the headless UI self-test under Wine. Only for changes that can
# affect the binary (the "full" surface).
verify-windows:
needs: verify
if: needs.verify.outputs.surface == 'full'
runs-on: alkane-verify
container:
image: gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
env:
CARGO_TARGET_DIR: target
CARGO_BUILD_JOBS: 2
WX_WINDOWS_PREFIX: /root/.cache/wx-3.3.3-mingw
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Windows toolchain
run: bash ci/windows-ci.sh toolchain
- name: Configure bounded Rust compiler cache
run: bash ci/configure-rust-cache.sh
- name: Compute wxMSW cache key
id: wx-key
run: bash ci/wx-cache-key.sh windows
- name: Check prebuilt wxMSW
id: wx-image
run: bash ci/check-wx-image-prefix.sh windows
- name: Cache vendored wxMSW build
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-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Build wxMSW (once, then cached)
id: wx-build
run: bash ci/ensure-wx-prefix.sh windows
- name: Save vendored wxMSW 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-mingw
key: ${{ steps.wx-key.outputs.key }}
- name: Clippy (Windows target, warnings are errors)
run: bash ci/windows-ci.sh clippy
- name: Build (Windows)
run: bash ci/windows-ci.sh build
- name: Unit tests (Windows build, under Wine)
run: bash ci/windows-ci.sh test
- name: Headless UI self-test (Windows build, under Wine)
run: bash ci/windows-ci.sh selftest
- name: Clean generated Toolkit build
if: always()
run: python3 ci/cleanup-generated.py
+101
View File
@@ -0,0 +1,101 @@
name: windows-native
# Smoke test on real Windows. The self-hosted runner in the Windows 11 test VM
# (label alkane-windows, host mode; see docs/windows.md) takes the Windows
# build that main's build-test-release run cross-compiled -- the release .exe
# and every unit-test executable, which already passed under Wine there -- and
# runs them natively: real Win32, real comctl32/visual styles, real DPI and
# real Windows networking.
#
# Advisory by design: a separate workflow, so it never gates or delays a
# release, and while the VM is off the job simply waits for the runner.
on:
workflow_run:
workflows: [build-test-release]
types: [completed]
workflow_dispatch:
inputs:
run_id:
description: build-test-release run whose Windows build to test
required: true
permissions:
actions: read
contents: read
jobs:
native:
if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
runs-on: alkane-windows
timeout-minutes: 30
env:
RUN_ID: ${{ github.event.workflow_run.id || inputs.run_id }}
# Windows' default execution policy (Restricted) refuses the script files
# the runner writes for each step; bypass it for these steps only, so the
# runner works without changing the machine's policy.
defaults:
run:
shell: powershell -NoProfile -NonInteractive -ExecutionPolicy Bypass -File {0}
steps:
- name: Fetch the cross-built Windows build
env:
TOKEN: ${{ github.token }}
API: ${{ github.api_url }}/repos/${{ github.repository }}
run: |
$ErrorActionPreference = 'Stop'
$ProgressPreference = 'SilentlyContinue'
$work = Join-Path ([IO.Path]::GetTempPath()) "alkane-native-$env:RUN_ID"
Remove-Item -Recurse -Force $work -ErrorAction SilentlyContinue
New-Item -ItemType Directory $work | Out-Null
$auth = @{ Authorization = "token $env:TOKEN" }
$list = Invoke-RestMethod -Headers $auth "$env:API/actions/runs/$env:RUN_ID/artifacts"
$art = $list.artifacts | Where-Object { $_.name -eq 'alkane-toolkit-windows-tests' } |
Select-Object -First 1
if (-not $art) { throw "run $env:RUN_ID has no alkane-toolkit-windows-tests artifact" }
Invoke-WebRequest -Headers $auth -Uri $art.archive_download_url -OutFile "$work\artifact.zip"
Expand-Archive "$work\artifact.zip" "$work\artifact"
$bundle = Get-ChildItem -Recurse "$work\artifact" -Filter alkane-toolkit-windows-tests.zip |
Select-Object -First 1
Expand-Archive $bundle.FullName "$work\tests"
$exe = Get-ChildItem -Recurse "$work\artifact" -Filter alkane-toolkit.exe | Select-Object -First 1
Copy-Item $exe.FullName "$work\alkane-toolkit.exe"
"ALKANE_NATIVE=$work" | Out-File -Append -Encoding utf8 $env:GITHUB_ENV
$os = Get-ItemProperty 'HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion'
"Testing run $env:RUN_ID on Windows $($os.DisplayVersion) build $($os.CurrentBuild)"
- name: Authenticode signature (native Windows)
env:
SIGNING_ENABLED: ${{ vars.AZURE_SIGNING_PROFILE }}
run: |
# Windows itself judges the signature: chain to a trusted root,
# intact file hash, valid timestamp. Required once signing is on.
$sig = Get-AuthenticodeSignature "$env:ALKANE_NATIVE\alkane-toolkit.exe"
Write-Host "Signature: $($sig.Status) $($sig.StatusMessage)"
if ($sig.SignerCertificate) { Write-Host "Signer: $($sig.SignerCertificate.Subject)" }
if ($sig.TimeStamperCertificate) { Write-Host "Timestamp: $($sig.TimeStamperCertificate.Subject)" }
if ($env:SIGNING_ENABLED -and $sig.Status -ne 'Valid') { exit 1 }
- name: Unit tests (native Windows)
run: |
$failed = @()
foreach ($test in Get-Content "$env:ALKANE_NATIVE\tests\tests.txt") {
Write-Host "== $test"
& "$env:ALKANE_NATIVE\tests\$test"
if ($LASTEXITCODE -ne 0) { $failed += $test }
}
if ($failed) { Write-Host "FAILED: $($failed -join ', ')"; exit 1 }
- name: Headless UI self-test (native Windows)
run: |
# A GUI-subsystem executable: wait for it and read its redirected output.
$env:ALKANE_SELFTEST = '1'
$out = "$env:ALKANE_NATIVE\selftest.txt"
$p = Start-Process -FilePath "$env:ALKANE_NATIVE\alkane-toolkit.exe" -Wait -PassThru `
-NoNewWindow -RedirectStandardOutput $out -RedirectStandardError "$out.err"
Get-Content $out, "$out.err"
if ($p.ExitCode -ne 0) { exit $p.ExitCode }
- name: Remove the downloaded build
if: always()
run: |
if ($env:ALKANE_NATIVE) { Remove-Item -Recurse -Force $env:ALKANE_NATIVE -ErrorAction SilentlyContinue }
+6
View File
@@ -1,3 +1,9 @@
/target
**/target
.claude/
__pycache__/
# Internal working notes live outside this public repository.
/AGENTS.md
/HANDOFF.md
/CLAUDE.md
code-review-report*.md
Generated
+7
View File
@@ -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]]
+13 -1
View File
@@ -13,9 +13,21 @@ members = [
[workspace.package]
version = "0.1.0"
edition = "2021"
license = "MIT OR Apache-2.0"
license = "MIT"
[workspace.dependencies]
thiserror = "2"
serde = { version = "1", features = ["derive"] }
sha2 = "0.10"
# Release binary: small, self-contained, and fast enough for a fleet GUI whose
# hot path is network I/O, not CPU (round 18 #12). opt-level "s" + fat LTO +
# one codegen unit + symbol stripping cut the binary substantially. panic stays
# "unwind" on purpose: the scan runs many miners on tokio tasks and the wx event
# dispatch relies on unwinding so one miner's panic never aborts the whole app.
[profile.release]
opt-level = "s"
lto = "fat"
codegen-units = 1
strip = true
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 BlueFlare Energy Solutions Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+60 -27
View File
@@ -1,38 +1,71 @@
# alkane-toolkit
# Alkane Toolkit
Cross-platform desktop toolkit (Rust core, native GUI) to install **stock** or
**alkaneOS** firmware on ASIC miner control boards, whatever they currently run
(stock, Vnish/AnthillOS, Braiins OS+, LuxOS, ePIC, BixBit, WardenOS).
[![CI](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/main.svg)](https://gitea.bluefla.re/blueflare/alkane-toolkit/actions)
[![tests](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/tests.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/)
[![coverage](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/coverage.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/#coverage)
[![bench](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/bench.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/bench/)
[![bench coverage](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/bench-coverage.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/)
[![lines of code](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/loc.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/#coverage)
[![code quality](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/quality.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/)
[![dependencies](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/dependencies.svg)](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/)
[![license](https://gitea.bluefla.re/blueflare/alkane-toolkit/raw/branch/ci-badges/badges/license.svg)](LICENSE)
Sibling to [alkane-sdk](https://gitea.bluefla.re/blueflare/alkane-sdk): the SDK
owns board knowledge and build outputs; this toolkit is the orchestration
engine and operator UI that executes its install recipes safely.
The badges link to the [project site](https://blueflare.gitea.bluefla.re/alkane-toolkit/): the [manual](https://blueflare.gitea.bluefla.re/alkane-toolkit/manual/),
the [code-quality dashboard](https://blueflare.gitea.bluefla.re/alkane-toolkit/quality/) (how the grade is set, coverage by
crate and file) and the [benchmark history](https://blueflare.gitea.bluefla.re/alkane-toolkit/bench/).
## Status
Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through
a patched [wx-rs bridge](thirdparty/wx-rs). In-app image flashing is disabled
while that path is reworked.
M1 primary view ships: discovery (vendored asic-rs 0.8.1) + the UI-SPEC
table (6 KPIs, sortable/drag-reorderable columns, row checkboxes, scan-range
editor, Excel-style filter, columns panel). Pure-Rust GUI on wxWidgets via
vendored + patched wx-rs (docs/adr/0002, 0003).
## Build + run (Debian)
## Run locally
```sh
scripts/build-wx-linux.sh # once: builds vendored wx 3.3.3 to ~/.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
```
Windows/macOS: `scripts/build-gui-windows.sh` (needs a Windows/msys2
toolchain) and `scripts/build-gui-macos.sh` (needs a Mac) - the GUI code is
shared; only the C++ bridge + wx differ per platform.
The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan
uses offline fixtures and does not contact hardware.
See `docs/IMPLEMENTATION-PLAN.md` for the roadmap.
Windows 10/11 builds are cross-compiled on Linux (`scripts/build-wx-windows.sh`,
then `scripts/build-gui-windows.sh`) and attached to every release as a
self-contained `alkane-toolkit.exe`; see [docs/windows.md](docs/windows.md).
macOS builds run on a Mac (`scripts/build-wx-macos.sh`, then
`scripts/build-gui-macos.sh`) and produce one universal app for Apple Silicon
and Intel, macOS 11 or later; see [docs/macos.md](docs/macos.md).
## Hard rules (from alkane-sdk `docs/install-methods.md`, encoded in code)
## Current scope
1. Never write the bootloader/secure region.
2. Verify on a channel the installer does not control.
3. Reboot is root-only; a dropped SSH connection can be success.
4. A packer is per board; never reuse across boards.
5. Boot-switch handling is an explicit, verified step.
- 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`.
- Use controls supported by the selected firmware and restore supported
aftermarket firmware to stock.
Discovery is read-only. Control and restore actions change miners. Check the
selected devices before applying them.
## Development
```sh
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
```
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
[benchmark history](https://blueflare.gitea.bluefla.re/alkane-toolkit/bench/).
## Firmware safety
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
[MIT](LICENSE). Vendored dependencies keep their own terms.
+11
View File
@@ -0,0 +1,11 @@
{
"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
}
+19
View File
@@ -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

+19
View File
@@ -0,0 +1,19 @@
<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="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="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="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>

After

Width:  |  Height:  |  Size: 950 B

+19
View File
@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="95.5" height="20" role="img" aria-label="coverage: 44%">
<title>coverage: 44%</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>
<g clip-path="url(#r)">
<rect width="64.0" height="20" fill="#555"/>
<rect x="64.0" width="31.5" height="20" fill="#dfb317"/>
<rect width="95.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="32.0" y="15" fill="#010101" fill-opacity=".3">coverage</text>
<text x="32.0" y="14">coverage</text>
<text x="79.8" y="15" fill="#010101" fill-opacity=".3">44%</text>
<text x="79.8" y="14">44%</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 919 B

+19
View File
@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="121.5" height="20" role="img" aria-label="dependencies: 349">
<title>dependencies: 349</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="121.5" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="90.0" height="20" fill="#555"/>
<rect x="90.0" width="31.5" height="20" fill="#007ec6"/>
<rect width="121.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="45.0" y="15" fill="#010101" fill-opacity=".3">dependencies</text>
<text x="45.0" y="14">dependencies</text>
<text x="105.8" y="15" fill="#010101" fill-opacity=".3">349</text>
<text x="105.8" y="14">349</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 940 B

+19
View File
@@ -0,0 +1,19 @@
<svg xmlns="http://www.w3.org/2000/svg" width="89.0" height="20" role="img" aria-label="license: MIT">
<title>license: MIT</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="89.0" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="57.5" height="20" fill="#555"/>
<rect x="57.5" width="31.5" height="20" fill="#007ec6"/>
<rect width="89.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="28.8" y="15" fill="#010101" fill-opacity=".3">license</text>
<text x="28.8" y="14">license</text>
<text x="73.2" y="15" fill="#010101" fill-opacity=".3">MIT</text>
<text x="73.2" y="14">MIT</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 915 B

+19
View File
@@ -0,0 +1,19 @@
<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"/>
</linearGradient>
<clipPath id="r"><rect width="141.0" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="96.5" height="20" fill="#555"/>
<rect x="96.5" width="44.5" height="20" fill="#007ec6"/>
<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="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.7K</text>
<text x="118.8" y="14">13.7K</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 952 B

+19
View File
@@ -0,0 +1,19 @@
<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="108.5" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<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="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>

After

Width:  |  Height:  |  Size: 927 B

+19
View File
@@ -0,0 +1,19 @@
<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"/>
</linearGradient>
<clipPath id="r"><rect width="121.5" 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="77.0" height="20" fill="#4c1"/>
<rect width="121.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="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">95 passing</text>
<text x="83.0" y="14">95 passing</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 935 B

+54
View File
@@ -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")
+110
View File
@@ -0,0 +1,110 @@
#!/usr/bin/env python3
"""Check the Toolkit benchmark suite and compare it with the prior release."""
import argparse
import json
import math
import os
import re
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|\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:
"""Map each bench name to its timing in nanoseconds (the last Duration on the
line, since every bench prints its timing last)."""
out = {}
for line in text.splitlines():
m = _NAME.match(line.strip())
if not m:
continue
durs = _DUR.findall(line)
if not durs:
raise ValueError(f"missing timing for {m.group(1)}")
val, unit = durs[-1]
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")
ap.add_argument("--baseline", required=True, help="baseline JSON (read + rewrite)")
ap.add_argument("--no-write", action="store_true", help="do not update the baseline")
args = ap.parse_args()
try:
with open(args.current, encoding="utf-8") as fh:
current = require_suite(parse_bench(fh.read()))
except (OSError, ValueError) as e:
print(f"bench-badge: cannot read current results: {e}", file=sys.stderr)
return 1
baseline = {}
try:
with open(args.baseline, encoding="utf-8") as fh:
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
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)
with open(args.baseline, "w", encoding="utf-8") as fh:
json.dump({k: round(v, 1) for k, v in sorted(current.items())}, fh, indent=2)
fh.write("\n")
return 0
if __name__ == "__main__":
sys.exit(main())
+8
View File
@@ -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)/' "$@"
+227
View File
@@ -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()
+19
View File
@@ -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}
+293
View File
@@ -0,0 +1,293 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Build the Alkane Toolkit Pages site (served from this repo's gh-pages).
build-pages.py --out site [--manual docs/manual] [--quality quality.json]
[--bench bench-site/index.html] [--sha SHA]
Pages:
/ overview and downloads
/manual/ the user manual, one page per docs/manual/NN-name.md chapter
/quality/ code-quality dashboard from the measured quality.json that main
CI publishes next to the badges (ci/gen-badges.py)
/bench/ the measured benchmark history (ci/bench_history.py render)
Every value taken from CI data is HTML-escaped; the manual is Markdown written
in this repository.
"""
import argparse
import html
import json
import re
import shutil
from pathlib import Path
import markdown
REPO = "https://gitea.bluefla.re/blueflare/alkane-toolkit"
RELEASES = REPO + "/releases"
SECTIONS = (("", "Overview"), ("manual/", "Manual"), ("quality/", "Code quality"),
("bench/", "Benchmarks"))
CSS = """
:root { --bg:#ffffff; --fg:#1f2328; --muted:#59636e; --line:#d1d9e0; --card:#f6f8fa;
--accent:#d9822b; --link:#0969da; --good:#1a7f37; --warn:#9a6700; --bad:#cf222e; }
@media (prefers-color-scheme: dark) { :root { --bg:#0d1117; --fg:#e6edf3; --muted:#9198a1;
--line:#30363d; --card:#151b23; --link:#4493f8; --good:#3fb950; --warn:#d29922; --bad:#f85149; } }
* { box-sizing: border-box; }
body { margin:0; background:var(--bg); color:var(--fg);
font:16px/1.55 system-ui,-apple-system,"Segoe UI",Roboto,Ubuntu,sans-serif; }
a { color:var(--link); text-decoration:none; } a:hover { text-decoration:underline; }
header { border-bottom:1px solid var(--line); }
header .bar, main { max-width:1040px; margin:0 auto; padding:0 16px; }
header .bar { display:flex; align-items:center; gap:24px; height:56px; flex-wrap:wrap; }
header .brand { font-weight:700; color:var(--fg); display:flex; gap:8px; align-items:center; }
header .brand i { width:20px; height:20px; border-radius:5px; background:var(--accent); display:inline-block; }
header nav { display:flex; gap:18px; flex-wrap:wrap; }
header nav a { color:var(--muted); } header nav a.on { color:var(--fg); font-weight:600; }
main { padding:28px 16px 64px; }
h1 { font-size:1.9rem; margin:.2em 0 .4em; } h2 { margin-top:1.8em; border-bottom:1px solid var(--line); padding-bottom:.25em; }
code { background:var(--card); border:1px solid var(--line); border-radius:5px; padding:.1em .35em; font-size:.92em; }
pre { background:var(--card); border:1px solid var(--line); border-radius:8px; padding:12px; overflow:auto; }
pre code { border:0; padding:0; }
table { border-collapse:collapse; width:100%; margin:1em 0; display:block; overflow-x:auto; }
th, td { border:1px solid var(--line); padding:6px 10px; text-align:left; vertical-align:top; }
th { background:var(--card); }
td.num, th.num { text-align:right; font-variant-numeric:tabular-nums; white-space:nowrap; }
.cards { display:grid; grid-template-columns:repeat(auto-fill,minmax(180px,1fr)); gap:12px; margin:1.2em 0; }
.card { background:var(--card); border:1px solid var(--line); border-radius:10px; padding:14px; }
.card b { display:block; font-size:1.6rem; } .card span { color:var(--muted); font-size:.9rem; }
.good { color:var(--good); } .warn { color:var(--warn); } .bad { color:var(--bad); }
.bar-cell { min-width:120px; } .meter { height:8px; background:var(--line); border-radius:4px; overflow:hidden; }
.meter i { display:block; height:100%; }
.layout { display:grid; grid-template-columns:220px 1fr; gap:32px; }
.layout aside ol { padding-left:1.2em; margin:0; } .layout aside li { margin:.3em 0; }
.layout aside a.on { font-weight:600; color:var(--fg); }
@media (max-width:760px) { .layout { grid-template-columns:1fr; } }
.buttons a { display:inline-block; margin:4px 8px 4px 0; padding:8px 14px; border-radius:8px;
border:1px solid var(--line); background:var(--card); color:var(--fg); }
.buttons a.primary { background:var(--accent); border-color:var(--accent); color:#fff; }
footer { color:var(--muted); font-size:.85rem; margin-top:48px; }
"""
def page(title: str, body: str, depth: int, current: str, sha: str) -> str:
up = "../" * depth
nav = "".join(
f'<a href="{up}{path}"{" class=on" if path == current else ""}>{label}</a>'
for path, label in SECTIONS)
built = f"Built from {html.escape(sha[:10])}. " if sha else ""
return f"""<!doctype html>
<html lang="en"><head><meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{html.escape(title)} - Alkane Toolkit</title>
<link rel="stylesheet" href="{up}style.css"></head>
<body><header><div class="bar"><a class="brand" href="{up}"><i></i>Alkane Toolkit</a>
<nav>{nav}<a href="{RELEASES}">Downloads</a><a href="{REPO}">Source</a></nav></div></header>
<main>{body}
<footer>{built}Alkane Toolkit is MIT licensed.</footer></main></body></html>
"""
def write(out: Path, rel: str, text: str) -> None:
path = out / rel
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text(text, encoding="utf-8")
# ---- manual -----------------------------------------------------------------
def chapters(manual: Path) -> list[tuple[str, str, str]]:
"""(slug, title, markdown) for docs/manual/NN-slug.md, in file-name order."""
out = []
for path in sorted(manual.glob("[0-9][0-9]-*.md")):
text = path.read_text(encoding="utf-8")
m = re.search(r"^# (.+)$", text, re.M)
title = m.group(1).strip() if m else path.stem
out.append((path.stem[3:], title, text))
return out
def build_manual(out: Path, manual: Path, sha: str) -> None:
items = chapters(manual)
if not items:
raise SystemExit(f"no manual chapters in {manual}")
def toc(current: str) -> str:
links = "".join(
f'<li><a href="{slug}.html"{" class=on" if slug == current else ""}>'
f"{html.escape(title)}</a></li>" for slug, title, _ in items)
return f"<aside><ol>{links}</ol></aside>"
for slug, title, text in items:
# Chapters link to each other as NN-name.md in the repo; on the site
# they are name.html.
text = re.sub(r"\]\((?:\./)?[0-9][0-9]-([a-z0-9-]+)\.md(#[^)]*)?\)", r"](\1.html\2)", text)
body_html = markdown.markdown(text, extensions=["tables", "fenced_code", "toc"])
write(out, f"manual/{slug}.html",
page(title, f'<div class="layout">{toc(slug)}<article>{body_html}</article></div>',
1, "manual/", sha))
first = items[0][0]
listing = "".join(f'<li><a href="{s}.html">{html.escape(t)}</a></li>' for s, t, _ in items)
write(out, "manual/index.html",
page("Manual", f"<h1>Manual</h1><p>Start with "
f'<a href="{first}.html">{html.escape(items[0][1])}</a>.</p><ol>{listing}</ol>',
1, "manual/", sha))
# ---- quality dashboard ---------------------------------------------------------
def pct_class(pct: float | None) -> str:
if pct is None:
return ""
return "good" if pct >= 80 else "warn" if pct >= 40 else "bad"
def meter(pct: float) -> str:
colour = {"good": "var(--good)", "warn": "var(--warn)", "bad": "var(--bad)"}[pct_class(pct)]
return f'<div class="meter"><i style="width:{max(0.0, min(pct, 100.0)):.1f}%;background:{colour}"></i></div>'
def build_quality(out: Path, quality: dict | None, sha: str) -> None:
e = html.escape
if not quality:
write(out, "quality/index.html", page(
"Code quality", "<h1>Code quality</h1><p>No measurement has been published yet; "
"the next main build will fill this page.</p>", 1, "quality/", sha))
return
grade = str(quality.get("grade", "pending"))
cov = quality.get("coverage_pct")
bench_cov = quality.get("bench_coverage_pct")
delta = quality.get("bench_delta_pct")
def card(value: str, label: str, cls: str = "") -> str:
return f'<div class="card"><b class="{cls}">{value}</b><span>{label}</span></div>'
cards = "".join([
card(e(grade), "Quality grade", {"A": "good", "B": "good", "C": "warn"}.get(grade, "bad")),
card(e(str(quality.get("tests_passed", "-"))), "Tests passing", "good"),
card(f"{cov:.1f}%" if cov is not None else "-", "Line coverage", pct_class(cov)),
card(f"{bench_cov:.1f}%" if bench_cov is not None else "-", "Benchmark coverage", pct_class(bench_cov)),
card(e(str(quality.get("clippy") or "-")), "Clippy (warnings are errors)",
"good" if quality.get("clippy") == "clean" else "bad"),
card(e(str(quality.get("rustfmt") or "-")), "rustfmt", "good" if quality.get("rustfmt") == "clean" else ""),
card(f"{quality.get('loc', 0):,}", "Lines of Rust"),
card(e(str(quality.get("dependencies", "-"))), "Crates in Cargo.lock"),
card((f"{'+' if delta > 0 else ''}{delta:.1f}%" if delta is not None else "-"),
"Benchmarks vs previous" + (" (same inputs)" if quality.get("bench_same_inputs") else ""),
"" if delta is None else "good" if delta >= 2 else "" if delta > -2 else "warn"),
])
bands = ", ".join(f"{e(str(letter))} at {floor:.0f}% or more"
for floor, letter in quality.get("grade_bands", []))
grade_rule = (f"<p>The grade is F if Clippy or rustfmt fails on main. Otherwise it is the "
f"line-coverage band: {bands}, and F below that. The coverage badge uses the "
f"same bands for its colour, so the two never disagree.</p>")
crates = quality.get("coverage_by_crate", {})
loc = quality.get("loc_by_crate", {})
rows = []
for name in sorted(set(crates) | set(loc)):
c = crates.get(name)
if c and c["lines"]:
pct = 100.0 * (c["lines"] - c["missed"]) / c["lines"]
cov_cells = (f'<td class="num {pct_class(pct)}">{pct:.1f}%</td>'
f'<td class="bar-cell">{meter(pct)}</td>'
f'<td class="num">{c["lines"] - c["missed"]:,} / {c["lines"]:,}</td>')
else:
cov_cells = '<td class="num">-</td><td></td><td class="num">-</td>'
rows.append(f"<tr><td>{e(name)}</td>{cov_cells}<td class='num'>{loc.get(name, 0):,}</td></tr>")
crate_table = ("<table><tr><th>Crate</th><th class=num>Line coverage</th><th></th>"
"<th class=num>Covered lines</th><th class=num>Lines of Rust</th></tr>"
+ "".join(rows) + "</table>")
files = sorted(quality.get("coverage_by_file", []),
key=lambda r: (r["lines"] - r["missed"]) / r["lines"] if r["lines"] else 1)
file_rows = "".join(
f"<tr><td><code>{e(r['file'])}</code></td>"
f"<td class='num {pct_class(100.0 * (r['lines'] - r['missed']) / r['lines'])}'>"
f"{100.0 * (r['lines'] - r['missed']) / r['lines']:.1f}%</td>"
f"<td class='num'>{r['missed']:,}</td><td class='num'>{r['lines']:,}</td></tr>"
for r in files if r["lines"])
file_table = ("<table><tr><th>File (least covered first)</th><th class=num>Coverage</th>"
"<th class=num>Uncovered lines</th><th class=num>Lines</th></tr>"
+ file_rows + "</table>") if file_rows else ""
measured = str(quality.get("sha", ""))[:10]
of_build = f" (this page: <code>{e(measured)}</code>)" if measured else ""
body = f"""<h1>Code quality</h1>
<p>Measured by main CI on every build{of_build}:
unit tests, line coverage (unit tests plus the headless UI self-test), Clippy with
warnings as errors, and rustfmt. Windows builds run the same tests under Wine and
on real Windows 11.</p>
<div class="cards">{cards}</div>
<h2 id="grade">How the grade is set</h2>{grade_rule}
<h2 id="coverage">Coverage by crate</h2>{crate_table}
<h2 id="files">Coverage by file</h2>{file_table}
<p>The dependency count is every package in <code>Cargo.lock</code>, direct and
transitive. Lines of Rust count every <code>.rs</code> line under <code>crates/</code>,
tests included.</p>"""
write(out, "quality/index.html", page("Code quality", body, 1, "quality/", sha))
# ---- benchmarks + overview -------------------------------------------------------
def build_bench(out: Path, bench: Path | None, sha: str) -> None:
if bench is None or not bench.is_file():
write(out, "bench/index.html", page(
"Benchmarks", "<h1>Benchmarks</h1><p>No benchmark history yet.</p>", 1, "bench/", sha))
return
rendered = bench.read_text(encoding="utf-8")
# The history renderer emits a complete document; keep its body (and its
# own styles) under the site's header.
styles = "".join(re.findall(r"<style[^>]*>.*?</style>", rendered, re.S | re.I))
m = re.search(r"<body[^>]*>(.*)</body>", rendered, re.S | re.I)
inner = m.group(1) if m else rendered
text = page("Benchmarks", inner, 1, "bench/", sha)
write(out, "bench/index.html", text.replace("</head>", styles + "</head>", 1))
def build_index(out: Path, quality: dict | None, sha: str) -> None:
grade = html.escape(str((quality or {}).get("grade", "pending")))
body = f"""<h1>Alkane Toolkit</h1>
<p>Desktop discovery and monitoring for ASIC miners on your network: find every
miner in your IP ranges, see hashrate, power, temperatures, fans and hashboard
health at a glance, and run the controls each firmware supports.</p>
<div class="buttons"><a class="primary" href="{RELEASES}">Download for Windows or Linux</a>
<a href="manual/">Read the manual</a><a href="quality/">Code quality: {grade}</a>
<a href="bench/">Benchmarks</a></div>
<h2>Platforms</h2>
<ul><li><b>Windows 10 and 11</b> (x86_64): one signed, self-contained <code>alkane-toolkit.exe</code>.</li>
<li><b>Linux</b> (x86_64, GTK 3): one binary.</li></ul>
<p>Every release is built, tested and signed by CI from the public source.</p>"""
write(out, "index.html", page("Overview", body, 0, "", sha))
def main() -> None:
ap = argparse.ArgumentParser(description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter)
ap.add_argument("--out", required=True)
ap.add_argument("--manual", default="docs/manual")
ap.add_argument("--quality", default=None)
ap.add_argument("--bench", default=None)
ap.add_argument("--sha", default="")
args = ap.parse_args()
out = Path(args.out)
if out.exists():
shutil.rmtree(out)
out.mkdir(parents=True)
quality = None
if args.quality and Path(args.quality).is_file():
quality = json.loads(Path(args.quality).read_text())
if not isinstance(quality, dict) or quality.get("schema") != 1:
raise SystemExit("unsupported quality.json")
(out / "style.css").write_text(CSS.strip() + "\n", encoding="utf-8")
build_index(out, quality, args.sha)
build_manual(out, Path(args.manual), args.sha)
build_quality(out, quality, args.sha)
build_bench(out, Path(args.bench) if args.bench else None, args.sha)
print(f"built {sum(1 for _ in out.rglob('*.html'))} pages in {out}")
if __name__ == "__main__":
main()
+68
View File
@@ -0,0 +1,68 @@
#!/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") in {"alkane-fast", "alkane-pages"}
and "secrets." in str(job)):
print(f"{path.name}: {name} exposes a secret to the fast runner", file=sys.stderr)
return 1
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/pages.yml").read_text(),
Loader=yaml.BaseLoader,
)
if (pages["on"]["workflow_run"]["workflows"] != ["build-test-release"]
or pages["jobs"]["publish"].get("runs-on") != "alkane-verify"):
print("Pages must follow main CI on the trusted verifier", 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-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())
+22
View File
@@ -0,0 +1,22 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Avoid a runner-local cache download when the pinned image has this source.
# check-wx-image-prefix.sh [linux|windows]
set -euo pipefail
case "${1:-linux}" in
linux) prefix="${WX_PREFIX:?WX_PREFIX is required}"; library=lib/libwx_gtk3u-3.3.a ;;
windows) prefix="${WX_WINDOWS_PREFIX:?WX_WINDOWS_PREFIX is required}"
library=lib/libwx_mswu-3.3-x86_64-w64-mingw32.a ;;
*) echo "unknown wx platform: $1" >&2; exit 2 ;;
esac
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/$library" ] &&
[ "$(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}"
+53
View File
@@ -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", "site")
FILES = ("bench-current.txt", "coverage-summary.txt", "quality.json")
BADGE_FILES = ("bench-baseline.json", "bench-context.json", "quality.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)
+15
View File
@@ -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}"
+14 -7
View File
@@ -2,9 +2,10 @@
# Compute the next release version for alkane-toolkit from the latest release
# tag and the paths changed since it. Version scheme X.Y.Z:
# X - major, bumped manually (ci/version-x.txt); a bump resets Y.Z to 0.0
# Y - backend-logic changes (core/discovery/access/flash/artifacts/cli,
# scan+model+main in the GUI crate, build/CI config); resets Z to 0
# Z - UI changes (the GUI view + fixtures + the wx-rs widget bridge)
# Y - backend-logic changes (the alkane-* crates and any GUI crate source
# other than the view files below, plus vendored deps and build/CI config);
# resets Z to 0
# Z - UI changes (the GUI view: ui.rs + fixtures.rs + bin/ + the wx-rs bridge)
# When both backend and UI changed, backend wins (bump Y). Docs-only changes
# produce no release.
#
@@ -17,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)
@@ -35,11 +36,17 @@ crates/alkane-gui/src/bin/*)
ui=true ;;
crates/alkane-core/*|crates/alkane-discovery/*|crates/alkane-access/*|\
crates/alkane-flash/*|crates/alkane-artifacts/*|crates/alkane-cli/*|\
crates/alkane-gui/src/scan.rs|crates/alkane-gui/src/model.rs|\
crates/alkane-gui/src/main.rs|Cargo.toml|Cargo.lock|.gitea/*|ci/*|scripts/*|\
crates/alkane-gui/src/*|crates/alkane-gui/Cargo.toml|crates/alkane-gui/build.rs|\
crates/alkane-gui/windows/*|crates/alkane-gui/assets/*|\
Cargo.toml|Cargo.lock|.gitea/*|ci/*|scripts/*|\
vendor/*|thirdparty/asic-rs/*)
# Any other GUI source file (naming, scan, model, pool_prefs, restore,
# access_probe, credentials, ...) is backend logic, as is how the binary
# is built and packaged (build.rs, the Windows manifest/icon/version
# resources, embedded assets). ui.rs/fixtures.rs/bin
# match the UI arm above first, so they still bump Z, not Y.
backend=true ;;
*) : ;; # docs, HANDOFF, README, thirdparty/wxwidgets tree: no bump
*) : ;; # docs, README, thirdparty/wxwidgets tree: no bump
esac
done <<< "$changed"
+37
View File
@@ -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'
+40
View File
@@ -0,0 +1,40 @@
#!/usr/bin/env bash
# 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 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
export WX_RS_WXCONFIG="${WX_RS_WXCONFIG:-$HOME/.cache/wx-3.3.3-linux/bin/wx-config}"
# The dependency tree is fully vendored, so the instrumented builds run offline by
# default; override with CARGO_LLVM_COV_FLAGS if you need something else.
read -ra CARGO_FLAGS <<<"${CARGO_LLVM_COV_FLAGS:---offline}"
# 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 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.
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).
cargo llvm-cov report --ignore-filename-regex '(thirdparty|vendor)/' "$@"
+35
View File
@@ -0,0 +1,35 @@
#!/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|windows|pages}"
case "$mode" in
base) packages=(libssl-dev pkg-config ca-certificates) ;;
ui) packages=(xvfb xauth dbus-x11 fonts-dejavu-core) ;;
ssh) packages=(openssh-client) ;;
pages) packages=(python3-markdown) ;;
all) packages=(libssl-dev pkg-config ca-certificates openssh-client
xvfb xauth dbus-x11 fonts-dejavu-core) ;;
# Windows cross build (mingw-w64, posix threads) + Wine for its tests.
windows) packages=(libssl-dev pkg-config ca-certificates
gcc-mingw-w64-x86-64-posix g++-mingw-w64-x86-64-posix
binutils-mingw-w64-x86-64 mingw-w64-x86-64-dev wine wine64 xvfb xauth
openjdk-21-jre-headless) ;;
*) 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[@]}"
+58
View File
@@ -0,0 +1,58 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Use the matching image or cache prefix; rebuild after a vendored source bump.
# ensure-wx-prefix.sh [linux|windows] (default linux: wxGTK in $WX_PREFIX;
# windows: the mingw wxMSW prefix in $WX_WINDOWS_PREFIX)
set -euo pipefail
platform="${1:-linux}"
case "$platform" in
linux)
prefix="${WX_PREFIX:?WX_PREFIX is required}"
allowed=/root/.cache/wx-3.3.3-linux
library=lib/libwx_gtk3u-3.3.a
build=scripts/build-wx-linux.sh ;;
windows)
prefix="${WX_WINDOWS_PREFIX:?WX_WINDOWS_PREFIX is required}"
allowed=/root/.cache/wx-3.3.3-mingw
library=lib/libwx_mswu-3.3-x86_64-w64-mingw32.a
build=scripts/build-wx-windows.sh ;;
*) echo "unknown wx platform: $platform" >&2; exit 2 ;;
esac
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" "$allowed" <<'PY'
from pathlib import Path
import shutil
import sys
prefix = Path(sys.argv[1])
allowed = Path(sys.argv[2])
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/$library" ]; then
WX_WINDOWS_PREFIX="$prefix" sh "$build"
built=true
else
echo 'wx prefix available from matching image or cache'
fi
[ -s "$prefix/$library" ]
printf '%s\n' "$expected" > "$marker"
if [ -n "${GITHUB_OUTPUT:-}" ]; then
printf 'built=%s\n' "$built" >> "$GITHUB_OUTPUT"
fi
+41
View File
@@ -0,0 +1,41 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Download the measured quality record (badges/quality.json on ci-badges).
fetch-quality.py OUT.json
Writes nothing (and exits 0) when main CI has not published one yet, so the
Pages build shows a "not measured yet" dashboard instead of failing.
"""
import base64
import json
import os
from pathlib import Path
import sys
from urllib.error import HTTPError
from urllib.request import Request, urlopen
def main() -> None:
out = Path(sys.argv[1])
api = os.environ["GITHUB_API_URL"].rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
url = f"{api}/repos/{repo}/contents/badges/quality.json?ref=ci-badges"
request = Request(url, headers={"Authorization": f"token {os.environ['GITEA_TOKEN']}"})
try:
with urlopen(request, timeout=20) as response:
content = base64.b64decode(json.load(response)["content"])
except HTTPError as error:
if error.code == 404:
print("No quality record published yet")
return
raise
if not isinstance(json.loads(content), dict):
sys.exit("invalid quality record")
out.write_bytes(content)
print(f"Fetched quality record ({len(content)} bytes)")
if __name__ == "__main__":
main()
+330
View File
@@ -0,0 +1,330 @@
#!/usr/bin/env python3
"""Generate self-contained shields-style SVG badges into badges/.
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]
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
# Approximate per-character width at 11px DejaVu Sans, in 1/10 px, matching the
# shields "flat" look closely enough for a fixed-width monospace-ish render.
CHAR_W = 6.5
PAD = 6.0
COLORS = {
"green": "#4c1",
"brightgreen": "#4c1",
"yellowgreen": "#a4a61d",
"yellow": "#dfb317",
"orange": "#fe7d37",
"red": "#e05d44",
"blue": "#007ec6",
"lightgrey": "#9f9f9f",
"grey": "#555",
}
def text_width(s: str) -> float:
return len(s) * CHAR_W + 2 * PAD
def badge_svg(label: str, message: str, color: str,
description: str | None = None) -> str:
color = COLORS.get(color, color)
lw = round(text_width(label), 1)
mw = round(text_width(message), 1)
total = round(lw + mw, 1)
lx = round(lw / 2, 1)
mx = round(lw + mw / 2, 1)
# Text is drawn twice (a dark shadow then the light glyphs) for the shields look.
description = description or f"{label}: {message}"
return f'''<svg xmlns="http://www.w3.org/2000/svg" width="{total}" height="20" role="img" aria-label="{description}">
<title>{description}</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="{total}" height="20" rx="3" fill="#fff"/></clipPath>
<g clip-path="url(#r)">
<rect width="{lw}" height="20" fill="#555"/>
<rect x="{lw}" width="{mw}" height="20" fill="{color}"/>
<rect width="{total}" 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="{lx}" y="15" fill="#010101" fill-opacity=".3">{label}</text>
<text x="{lx}" y="14">{label}</text>
<text x="{mx}" y="15" fill="#010101" fill-opacity=".3">{message}</text>
<text x="{mx}" y="14">{message}</text>
</g>
</svg>
'''
def count_loc(root: str) -> int:
total = 0
for base in ("crates",):
for dirpath, _dirs, files in os.walk(os.path.join(root, base)):
for f in files:
if f.endswith(".rs"):
try:
with open(os.path.join(dirpath, f), encoding="utf-8", errors="ignore") as fh:
total += sum(1 for _ in fh)
except OSError:
pass
return total
def count_deps(root: str) -> int:
lock = os.path.join(root, "Cargo.lock")
try:
with open(lock, encoding="utf-8") as fh:
return sum(1 for line in fh if line.startswith("name = "))
except OSError:
return 0
def read_license(root: str) -> str:
try:
with open(os.path.join(root, "Cargo.toml"), encoding="utf-8") as fh:
for line in fh:
m = re.match(r'\s*license\s*=\s*"([^"]+)"', line)
if m:
return m.group(1)
except OSError:
pass
return "unknown"
def loc_color(n: int) -> str:
return "blue"
def bench_color(delta_pct: float) -> str:
# 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:
return "blue"
if delta_pct > -10.0:
return "yellow"
return "orange"
def cov_color(pct: float) -> str:
if pct >= 80:
return "brightgreen"
if pct >= 60:
return "yellowgreen"
if pct >= 40:
return "yellow"
if pct >= 20:
return "orange"
return "red"
# Code-quality grade (shown on the badge and explained on the Pages quality
# dashboard). Lint failures fail the grade outright; otherwise the grade is the
# measured line-coverage band, using the same bands as the coverage badge
# colour, so the two badges can never disagree.
GRADE_BANDS = ((80.0, "A"), (60.0, "B"), (40.0, "C"), (20.0, "D"))
GRADE_COLORS = {"A": "brightgreen", "B": "yellowgreen", "C": "yellow",
"D": "orange", "F": "red", "pending": "lightgrey"}
def quality_grade(clippy: str | None, coverage: float | None = None) -> str:
if clippy is None or (clippy == "clean" and coverage is None):
return "pending"
if clippy != "clean":
return "F"
for floor, grade in GRADE_BANDS:
if coverage >= floor:
return grade
return "F"
def coverage_by_file(summary_path: str | None, root: str) -> list[dict]:
"""Per-file line coverage from a `cargo llvm-cov --summary-only` table.
Columns: Filename, Regions, Missed Regions, Cover, Functions, Missed
Functions, Executed, Lines, Missed Lines, Cover, ...
"""
if not summary_path:
return []
rows = []
root_abs = os.path.abspath(root).rstrip("/") + "/"
for line in Path(summary_path).read_text(errors="replace").splitlines():
cols = line.split()
if len(cols) < 10 or cols[0] in ("Filename", "TOTAL") or not cols[0].endswith(".rs"):
continue
try:
lines, missed = int(cols[7]), int(cols[8])
except ValueError:
continue
name = cols[0][len(root_abs):] if cols[0].startswith(root_abs) else cols[0]
# llvm-cov drops the prefix every file shares, so when only workspace
# crates are measured "crates/alkane-gui/src/x.rs" is printed as
# "alkane-gui/src/x.rs". Put the prefix back.
first = Path(name).parts[0] if Path(name).parts else ""
if not name.startswith("crates/") and (Path(root) / "crates" / first).is_dir():
name = f"crates/{name}"
rows.append({"file": name, "lines": lines, "missed": missed})
return rows
def crate_of(path: str) -> str:
parts = Path(path).parts
if "crates" in parts and parts.index("crates") + 1 < len(parts):
return parts[parts.index("crates") + 1]
if "wx-rs-0.2.0-patched" in parts:
return "wx-rs (bridge)"
return "other"
def loc_by_crate(root: str) -> dict[str, int]:
out: dict[str, int] = {}
crates = Path(root) / "crates"
for path in sorted(crates.glob("*/**/*.rs")):
crate = path.relative_to(crates).parts[0]
with open(path, encoding="utf-8", errors="ignore") as fh:
out[crate] = out.get(crate, 0) + sum(1 for _ in fh)
return out
def human(n: int) -> str:
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:
ap = argparse.ArgumentParser()
ap.add_argument("--out", default="badges")
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)
# 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", choices=("clean", "failed"))
# The full `cargo llvm-cov --summary-only` table, for the per-crate and
# per-file breakdown in quality.json (the Pages quality dashboard).
ap.add_argument("--coverage-summary", default=None)
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)
def write(name, label, message, color, description=None):
path = os.path.join(args.root, args.out, name + ".svg")
with open(path, "w", encoding="utf-8") as fh:
fh.write(badge_svg(label, message, color, description))
print(f"wrote {path}: {label}={message}")
loc = count_loc(args.root)
deps = count_deps(args.root)
lic = read_license(args.root)
write("loc", "lines of code", human(loc), loc_color(loc))
write("license", "license", lic, "blue")
write("dependencies", "dependencies", str(deps), "blue")
grade = quality_grade(args.clippy, args.coverage)
write("quality", "code quality", grade, GRADE_COLORS[grade],
f"code quality: {grade} (Clippy, rustfmt and line coverage)")
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))
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:
delta = float(args.bench_delta)
except ValueError:
delta = None
if delta is not None:
# 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:
write("bench", "bench", args.bench, "blue")
# Everything above, plus the per-crate breakdowns, for the Pages quality
# dashboard (ci/build-pages.py).
files = coverage_by_file(args.coverage_summary, args.root)
crates: dict[str, dict] = {}
for row in files:
c = crates.setdefault(crate_of(row["file"]), {"lines": 0, "missed": 0})
c["lines"] += row["lines"]
c["missed"] += row["missed"]
quality = {
"schema": 1,
"sha": os.environ.get("GITHUB_SHA", ""),
"grade": grade,
"grade_bands": [[floor, letter] for floor, letter in GRADE_BANDS],
"clippy": args.clippy,
"rustfmt": "clean" if args.clippy is not None else None,
"tests_passed": args.tests,
"coverage_pct": args.coverage,
"bench_coverage_pct": args.bench_coverage,
"bench_delta_pct": delta,
"bench_same_inputs": same_inputs,
"loc": loc,
"loc_by_crate": loc_by_crate(args.root),
"dependencies": deps,
"license": lic,
"coverage_by_crate": crates,
"coverage_by_file": files,
}
path = os.path.join(args.root, args.out, "quality.json")
with open(path, "w", encoding="utf-8") as fh:
json.dump(quality, fh, indent=1, sort_keys=True)
print(f"wrote {path}")
return 0
if __name__ == "__main__":
sys.exit(main())
+59
View File
@@ -0,0 +1,59 @@
# syntax=docker/dockerfile:1
# Alkane Toolkit CI image (ci/runner-image.txt pins the pushed digest).
#
# Layered on the previously verified image, so every Linux job keeps exactly
# the toolchain it had (Rust 1.97.1, prebuilt wxGTK prefix, sccache,
# cargo-llvm-cov), and adds what the Windows jobs need:
# - mingw-w64 (posix threads) and the rustup target x86_64-pc-windows-gnu
# - a prebuilt static wxMSW 3.3.3 prefix, built from the vendored source by
# scripts/build-wx-windows.sh and stamped with the source digest the same
# way as the wxGTK prefix (ci/ensure-wx-prefix.sh rebuilds on a mismatch)
# - Wine with an initialised prefix, to run the Windows tests and self-test
# - a Java runtime and jsign (checksum-pinned), to Authenticode-sign the .exe
# through Azure Artifact Signing (ci/sign-windows.sh)
#
# Build and push from the workstation with ci/images/build-image.sh.
ARG BASE=gitea.bluefla.re/blueflare/alkane-ci@sha256:9d2a992bbcb91014af3c85d2e1ec8c5990701cecf83fd06c8d46f9ef13dbd948
FROM ${BASE}
RUN DEBIAN_FRONTEND=noninteractive apt-get update -qq \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends \
gcc-mingw-w64-x86-64-posix g++-mingw-w64-x86-64-posix \
binutils-mingw-w64-x86-64 mingw-w64-x86-64-dev \
wine wine64 xvfb xauth openjdk-21-jre-headless \
&& rm -rf /var/lib/apt/lists/*
# jsign (Maven Central net.jsign:jsign; keep in step with ci/windows-ci.sh).
ARG JSIGN_VERSION=7.6
ARG JSIGN_SHA256=6cf58aa080e7ff82656f320cff8d4a3bff30408df8766806dcba3740dd839fa5
RUN mkdir -p /opt/jsign \
&& curl -sSfL -o /opt/jsign/jsign.jar \
"https://repo1.maven.org/maven2/net/jsign/jsign/${JSIGN_VERSION}/jsign-${JSIGN_VERSION}.jar" \
&& echo "${JSIGN_SHA256} /opt/jsign/jsign.jar" | sha256sum -c - \
&& java -jar /opt/jsign/jsign.jar --help >/dev/null
RUN rustup target add x86_64-pc-windows-gnu
# The build context is the repository root, filtered by
# alkane-ci.Dockerfile.dockerignore down to the wx source and its build script.
COPY thirdparty/wxwidgets /tmp/alkane/thirdparty/wxwidgets
COPY scripts/build-wx-windows.sh /tmp/alkane/scripts/build-wx-windows.sh
RUN HOME=/root WX_WINDOWS_PREFIX=/root/.cache/wx-3.3.3-mingw \
sh /tmp/alkane/scripts/build-wx-windows.sh \
&& awk '$1 == "sha256:" {print $2}' /tmp/alkane/thirdparty/wxwidgets/VERSION \
> /root/.cache/wx-3.3.3-mingw/.alkane-source-sha256 \
&& rm -rf /tmp/alkane
# A ready Wine prefix saves ~10 s per job (scripts/wine-run.sh reuses it).
RUN WINEPREFIX=/root/.cache/alkane-wine WINEDEBUG=-all \
WINEDLLOVERRIDES='winemenubuilder.exe=d;mscoree=d;mshtml=d' \
sh -c 'wineboot --init; wineboot --shutdown; wineserver -w' >/dev/null 2>&1; \
test -f /root/.cache/alkane-wine/system.reg
RUN test -s /root/.cache/wx-3.3.3-mingw/lib/libwx_mswu-3.3-x86_64-w64-mingw32.a \
&& test "$(/root/.cache/wx-3.3.3-mingw/bin/wx-config --version)" = 3.3.3 \
&& test -s /root/.cache/wx-3.3.3-linux/lib/libwx_gtk3u-3.3.a \
&& x86_64-w64-mingw32-g++-posix --version >/dev/null \
&& wine --version \
&& test -s /opt/jsign/jsign.jar \
&& rustup target list --installed | grep -qx x86_64-pc-windows-gnu
@@ -0,0 +1,4 @@
# Only what the image build copies: the vendored wx tree and its build script.
*
!thirdparty/wxwidgets/**
!scripts/build-wx-windows.sh
+39
View File
@@ -0,0 +1,39 @@
#!/bin/sh
# Build the CI image from ci/images/alkane-ci.Dockerfile, push it to the Gitea
# registry, and pin the pushed digest in ci/runner-image.txt and every
# workflow (ci/check-runner-image.py enforces the pin).
#
# Run on the workstation, which holds the registry credential; it is passed to
# a throwaway Docker config that is deleted afterwards, never to a runner.
# ci/images/build-image.sh TAG e.g. ci/images/build-image.sh windows-2026-11-02
set -eu
TAG=${1:?usage: build-image.sh TAG}
REPO=$(CDPATH= cd -- "$(dirname -- "$0")/../.." && pwd)
REGISTRY=gitea.bluefla.re
IMAGE=$REGISTRY/blueflare/alkane-ci
TOKEN_FILE=${GITEA_TOKEN_FILE:-$HOME/.config/gitea/token}
cd "$REPO"
DOCKER_CONFIG=$(mktemp -d)
export DOCKER_CONFIG
trap 'rm -rf "$DOCKER_CONFIG"' 0
user=$(curl -sS --config - "https://$REGISTRY/api/v1/user" <<CFG | python3 -c 'import json,sys; print(json.load(sys.stdin)["login"])'
header = "Authorization: token $(cat "$TOKEN_FILE")"
CFG
)
docker login "$REGISTRY" -u "$user" --password-stdin < "$TOKEN_FILE" >/dev/null
DOCKER_BUILDKIT=1 docker build -f ci/images/alkane-ci.Dockerfile -t "$IMAGE:$TAG" .
docker push "$IMAGE:$TAG" >/dev/null
digest=$(docker inspect --format '{{range .RepoDigests}}{{println .}}{{end}}' "$IMAGE:$TAG" \
| grep "^$IMAGE@sha256:" | head -1)
[ -n "$digest" ] || { echo "no registry digest for $IMAGE:$TAG" >&2; exit 1; }
old=$(cat ci/runner-image.txt)
printf '%s\n' "$digest" > ci/runner-image.txt
grep -rl "$old" .gitea/workflows | while read -r f; do
python3 - "$f" "$old" "$digest" <<'PY'
import pathlib, sys
p, old, new = pathlib.Path(sys.argv[1]), sys.argv[2], sys.argv[3]
p.write_text(p.read_text().replace(old, new))
PY
done
python3 ci/check-runner-image.py
echo "pinned $digest"
+115
View File
@@ -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()
+109
View File
@@ -0,0 +1,109 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Package the universal macOS build as an app bundle, for release.
package-macos.py VERSION BINARY OUT_DIR
BINARY is the universal (arm64 + x86_64) alkane-toolkit executable made by
scripts/build-gui-macos.sh. Writes
dist/alkane-toolkit-vVERSION-macos-universal.zip holding "Alkane Toolkit.app",
LICENSE and README.txt, and prints its path. Runs on macOS (lipo, codesign,
ditto).
The bundle is ad-hoc signed only (Apple Silicon refuses to run unsigned
code); it is not signed with a Developer ID or notarized, so Gatekeeper asks
the user to confirm the first launch. README.txt says how.
"""
import pathlib
import plistlib
import shutil
import subprocess
import sys
import tempfile
ROOT = pathlib.Path(__file__).resolve().parents[1]
APP = "Alkane Toolkit.app"
BUNDLE_ID = "re.bluefla.alkane-toolkit"
MIN_MACOS = "11.0"
def run(*args: str) -> str:
return subprocess.run(args, check=True, capture_output=True, text=True).stdout
def build_app(version: str, binary: pathlib.Path, dest: pathlib.Path) -> pathlib.Path:
archs = run("lipo", "-archs", str(binary)).split()
if sorted(archs) != ["arm64", "x86_64"]:
sys.exit(f"{binary} is not a universal arm64 + x86_64 binary: {archs}")
app = dest / APP
macos = app / "Contents" / "MacOS"
resources = app / "Contents" / "Resources"
macos.mkdir(parents=True)
resources.mkdir()
shutil.copy2(binary, macos / "alkane-toolkit")
shutil.copy2(ROOT / "crates/alkane-gui/macos/alkane-toolkit.icns", resources)
info = {
"CFBundleName": "Alkane Toolkit",
"CFBundleDisplayName": "Alkane Toolkit",
"CFBundleIdentifier": BUNDLE_ID,
"CFBundleExecutable": "alkane-toolkit",
"CFBundleIconFile": "alkane-toolkit",
"CFBundlePackageType": "APPL",
"CFBundleShortVersionString": version,
"CFBundleVersion": version,
"CFBundleInfoDictionaryVersion": "6.0",
"LSMinimumSystemVersion": MIN_MACOS,
"NSHighResolutionCapable": True,
"NSPrincipalClass": "NSApplication",
# The scanner talks to miners on the local network.
"NSLocalNetworkUsageDescription":
"Alkane Toolkit scans your local network to find and manage miners.",
"NSHumanReadableCopyright":
"Copyright (c) 2026 BlueFlare Energy Solutions Inc. (MIT License)",
}
with open(app / "Contents" / "Info.plist", "wb") as fh:
plistlib.dump(info, fh)
(app / "Contents" / "PkgInfo").write_text("APPL????")
# Ad-hoc signature over the whole bundle (the linker's per-slice
# signatures do not cover Info.plist or the resources).
run("codesign", "--force", "--sign", "-", "--timestamp=none", str(app))
run("codesign", "--verify", "--strict", str(app))
return app
def release(version: str, binary: str, out_dir: str) -> None:
name = f"alkane-toolkit-v{version}-macos-universal"
out = pathlib.Path(out_dir).resolve() / f"{name}.zip"
out.parent.mkdir(parents=True, exist_ok=True)
readme = (
f"alkane-toolkit v{version} (macOS, Apple Silicon and Intel)\n"
"\n"
f"Runs on macOS {MIN_MACOS} (Big Sur) or later. Drag \"Alkane Toolkit\"\n"
"to Applications, then open it.\n"
"\n"
"The app is not notarized by Apple, so the first launch is blocked\n"
"with a warning. To allow it once:\n"
" - macOS 15 or later: try to open it, then System Settings >\n"
" Privacy & Security > \"Open Anyway\" for Alkane Toolkit.\n"
" - macOS 11 to 14: Control-click the app, choose Open, then Open.\n"
"Or, in Terminal: xattr -dr com.apple.quarantine \"/Applications/Alkane Toolkit.app\"\n"
"\n"
"Settings are stored in ~/.config/alkane-toolkit/.\n"
"Manual: https://blueflare.gitea.bluefla.re/alkane-toolkit/manual/\n"
)
with tempfile.TemporaryDirectory(prefix="alkane-macos-") as tmp:
folder = pathlib.Path(tmp) / name
folder.mkdir()
build_app(version, pathlib.Path(binary), folder)
shutil.copy2(ROOT / "LICENSE", folder / "LICENSE")
(folder / "README.txt").write_text(readme)
out.unlink(missing_ok=True)
run("ditto", "-c", "-k", "--keepParent", str(folder), str(out))
print(out)
if __name__ == "__main__":
if len(sys.argv) != 4:
sys.exit(__doc__)
release(*sys.argv[1:])
+108
View File
@@ -0,0 +1,108 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Package the cross-built Windows toolkit for release and for native testing.
package-windows.py release VERSION EXE OUT_DIR
dist/alkane-toolkit-vVERSION-windows-x86_64.zip: one folder holding
alkane-toolkit.exe, LICENSE and a README.txt. Prints the zip path.
package-windows.py tests CARGO_JSON OUT_ZIP
A bundle of the test executables `cargo test --no-run
--message-format=json` reported (CARGO_JSON is that output), plus
tests.txt naming each one. The native Windows job runs every listed
executable on real Windows; the same binaries already ran under Wine.
"""
import json
import pathlib
import struct
import sys
import zipfile
ROOT = pathlib.Path(__file__).resolve().parents[1]
TARGET = "x86_64-pc-windows-gnu"
def release(version: str, exe: str, out_dir: str) -> None:
exe_path = pathlib.Path(exe)
if exe_path.suffix != ".exe" or not exe_path.is_file():
sys.exit(f"not a Windows executable: {exe}")
signed = _has_authenticode_signature(exe_path)
name = f"alkane-toolkit-v{version}-windows-x86_64"
out = pathlib.Path(out_dir) / f"{name}.zip"
out.parent.mkdir(parents=True, exist_ok=True)
readme = (
f"alkane-toolkit v{version} (Windows x86_64)\r\n"
"\r\n"
"Run alkane-toolkit.exe. No installer and no extra runtime are needed:\r\n"
"the executable is self-contained and runs on Windows 10 and 11.\r\n"
"\r\n"
+ (
"The executable is signed by BlueFlare Energy Solutions Inc. (Azure Artifact Signing). To check:\r\n"
"right-click alkane-toolkit.exe > Properties > Digital Signatures.\r\n"
if signed else
"This build is not code-signed, so Windows SmartScreen may warn on first\r\n"
"run: choose More info > Run anyway.\r\n"
)
+ "\r\n"
"Settings are kept in %APPDATA%\\alkane-toolkit.\r\n"
"SSH-based actions use the OpenSSH client built into Windows (ssh.exe);\r\n"
"HTTP actions use curl.exe, also built in.\r\n"
"\r\n"
"Offline demo: run from a Command Prompt with\r\n"
" set ALKANE_FAKE_SCAN=1 && alkane-toolkit.exe\r\n"
)
with zipfile.ZipFile(out, "w", zipfile.ZIP_DEFLATED) as z:
z.write(exe_path, f"{name}/alkane-toolkit.exe")
z.write(ROOT / "LICENSE", f"{name}/LICENSE.txt")
z.writestr(f"{name}/README.txt", readme)
print(out)
def _has_authenticode_signature(exe: pathlib.Path) -> bool:
"""True if the PE file carries a certificate table (an Authenticode signature)."""
data = exe.read_bytes()
pe = struct.unpack_from("<I", data, 0x3C)[0]
magic = struct.unpack_from("<H", data, pe + 24)[0]
dirs = pe + 24 + (96 if magic == 0x10B else 112)
return struct.unpack_from("<II", data, dirs + 4 * 8)[1] > 0
def tests(cargo_json: str, out_zip: str) -> None:
executables = []
for line in pathlib.Path(cargo_json).read_text().splitlines():
try:
message = json.loads(line)
except json.JSONDecodeError:
continue
if (message.get("reason") == "compiler-artifact"
and message.get("profile", {}).get("test")
and message.get("executable")):
executables.append(pathlib.Path(message["executable"]))
executables = sorted(set(executables))
if not executables:
sys.exit("no test executables in the cargo output")
out = pathlib.Path(out_zip)
out.parent.mkdir(parents=True, exist_ok=True)
with zipfile.ZipFile(out, "w", zipfile.ZIP_DEFLATED) as z:
names = []
for exe in executables:
if exe.suffix != ".exe" or TARGET not in exe.parts:
sys.exit(f"not a {TARGET} test executable: {exe}")
z.write(exe, exe.name)
names.append(exe.name)
z.writestr("tests.txt", "\n".join(names) + "\n")
print(f"{out} ({len(executables)} test executables)")
def main() -> None:
if len(sys.argv) == 5 and sys.argv[1] == "release":
release(*sys.argv[2:])
elif len(sys.argv) == 4 and sys.argv[1] == "tests":
tests(*sys.argv[2:])
else:
sys.exit(__doc__)
if __name__ == "__main__":
main()
+122
View File
@@ -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()
+37
View File
@@ -0,0 +1,37 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Publish measured toolkit badges to the private Gitea badge branch."""
import json
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")
# The full measurement record behind the badges, read by the Pages
# quality dashboard (ci/build-pages.py).
data = (ROOT / "badges" / "quality.json").read_bytes()
if not isinstance(json.loads(data), dict):
raise ValueError("invalid quality.json")
publish_file(api, repo, "badges/quality.json", data, token,
"Update measured quality record", max_bytes=262_144)
print(f"Published {len(NAMES)} measured badge SVGs and quality.json")
if __name__ == "__main__":
main()
+79
View File
@@ -0,0 +1,79 @@
#!/usr/bin/env python3
# SPDX-License-Identifier: MIT
"""Publish the built Pages site to this repository's gh-pages branch.
publish-pages.py SITE_DIR
Served at https://blueflare.gitea.bluefla.re/alkane-toolkit/ by the Pages
server, which serves the gh-pages branch of public repositories. Each publish
is one orphan commit (force-pushed), so the branch never accumulates history.
Only main may publish, and a run for a superseded main commit skips.
"""
import json
import os
from pathlib import Path
import shutil
import subprocess
import sys
import tempfile
from urllib.request import Request, urlopen
BRANCH = "gh-pages"
MAX_BYTES = 20 * 1024 * 1024
def current_main_sha(api: str, repo: str, token: str) -> str:
request = Request(f"{api}/repos/{repo}/branches/main",
headers={"Authorization": f"token {token}"})
with urlopen(request, timeout=20) as response:
return json.load(response)["commit"]["id"]
def git(*args: str, cwd: Path, env: dict | None = None) -> None:
subprocess.run(("git", *args), cwd=cwd, env=env, check=True)
def main() -> None:
if len(sys.argv) != 2:
sys.exit(__doc__)
site = Path(sys.argv[1])
if not (site / "index.html").is_file():
sys.exit(f"{site} has no index.html")
size = sum(p.stat().st_size for p in site.rglob("*") if p.is_file())
if size > MAX_BYTES:
sys.exit(f"site is {size} bytes, over the {MAX_BYTES} byte limit")
for path in site.rglob("*"):
if path.is_file() and path.suffix not in {".html", ".css", ".svg", ".png", ".json"}:
sys.exit(f"unexpected file type on the site: {path}")
api = os.environ["GITHUB_API_URL"].rstrip("/")
repo = os.environ["GITHUB_REPOSITORY"]
sha = os.environ["GITHUB_SHA"]
token = os.environ["GITEA_TOKEN"]
if os.environ.get("GITHUB_REF") != "refs/heads/main":
sys.exit("Pages publication requires main")
if current_main_sha(api, repo, token) != sha:
print("Skipping Pages for a superseded main commit")
return
server = api.removesuffix("/api/v1")
with tempfile.TemporaryDirectory(prefix="alkane-pages-") as directory:
work = Path(directory)
shutil.copytree(site, work, dirs_exist_ok=True)
env = dict(os.environ, GIT_TERMINAL_PROMPT="0")
git("init", "-q", "-b", BRANCH, cwd=work)
git("-c", "user.name=Alkane CI", "-c", "user.email=ci@noreply.gitea.bluefla.re",
"add", "-A", cwd=work)
git("-c", "user.name=Alkane CI", "-c", "user.email=ci@noreply.gitea.bluefla.re",
"commit", "-q", "-m", f"Publish site for {sha[:10]} [skip ci]", cwd=work)
# The token is read from the environment by the credential helper at
# push time; it never appears on a command line or in the remote URL.
helper = '!f() { echo username=alkane-ci; echo "password=$GITEA_TOKEN"; }; f'
git("-c", f"credential.helper={helper}", "push", "-q", "--force",
f"{server}/{repo}.git", f"HEAD:refs/heads/{BRANCH}", cwd=work, env=env)
print(f"Published Pages for {sha[:10]} to {BRANCH}")
if __name__ == "__main__":
main()
+56
View File
@@ -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()
+1
View File
@@ -0,0 +1 @@
gitea.bluefla.re/blueflare/alkane-ci@sha256:4929b2979851f1f12fb8f92ef74236ae4c2ea735a41ead94a16af416a4f0a1a5
+88
View File
@@ -0,0 +1,88 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Authenticode-sign Windows executables with Azure Artifact Signing (formerly
# Trusted Signing), from Linux, with jsign. Every signature is RFC 3161
# timestamped: the signing certificates live only a few days, the timestamp is
# what keeps a signature valid after that.
#
# ci/sign-windows.sh FILE.exe [FILE.exe ...]
#
# Configuration (environment):
# AZURE_SIGNING_PROFILE certificate profile name; EMPTY = signing not set
# up yet: the files are left unsigned (exit 0)
# AZURE_SIGNING_ACCOUNT signing account (default blueflaresigning)
# AZURE_SIGNING_ENDPOINT account endpoint (default https://wus2.codesigning.azure.net)
# Credentials, one of:
# AZURE_SIGNING_TENANT_ID + AZURE_SIGNING_CLIENT_ID + AZURE_SIGNING_CLIENT_SECRET
# (the CI service principal alkane-toolkit-ci-signer, role
# "Artifact Signing Certificate Profile Signer" on the account only)
# AZURE_SIGNING_TOKEN an access token for https://codesigning.azure.net,
# e.g. from `az account get-access-token --resource https://codesigning.azure.net`
# ALKANE_JSIGN_JAR jsign jar (default /opt/jsign/jsign.jar, from the CI image)
#
# Once a profile is configured, any failure fails the job: a release is never
# shipped half-signed or silently unsigned.
set -euo pipefail
[ "$#" -gt 0 ] || { sed -n '3,25p' "$0" >&2; exit 2; }
profile="${AZURE_SIGNING_PROFILE:-}"
if [ -z "$profile" ]; then
echo "Windows code signing is not enabled (AZURE_SIGNING_PROFILE unset); leaving $* unsigned"
exit 0
fi
account="${AZURE_SIGNING_ACCOUNT:-blueflaresigning}"
endpoint="${AZURE_SIGNING_ENDPOINT:-https://wus2.codesigning.azure.net}"
jar="${ALKANE_JSIGN_JAR:-/opt/jsign/jsign.jar}"
[ -f "$jar" ] || { echo "jsign not found at $jar" >&2; exit 1; }
if [ -z "${AZURE_SIGNING_TOKEN:-}" ]; then
: "${AZURE_SIGNING_TENANT_ID:?signing credentials missing}"
: "${AZURE_SIGNING_CLIENT_ID:?signing credentials missing}"
: "${AZURE_SIGNING_CLIENT_SECRET:?signing credentials missing}"
# Client-credentials token for the signing service. The secret and token
# stay in this process's environment, never on a command line.
AZURE_SIGNING_TOKEN="$(python3 - <<'PY'
import json, os, sys, urllib.parse, urllib.request
body = urllib.parse.urlencode({
"grant_type": "client_credentials",
"client_id": os.environ["AZURE_SIGNING_CLIENT_ID"],
"client_secret": os.environ["AZURE_SIGNING_CLIENT_SECRET"],
"scope": "https://codesigning.azure.net/.default",
}).encode()
url = f"https://login.microsoftonline.com/{os.environ['AZURE_SIGNING_TENANT_ID']}/oauth2/v2.0/token"
try:
with urllib.request.urlopen(url, body, timeout=60) as r:
print(json.load(r)["access_token"])
except Exception as e:
sys.exit(f"could not get a signing token: {e}")
PY
)"
fi
export AZURE_SIGNING_TOKEN
for file in "$@"; do
java -jar "$jar" \
--storetype TRUSTEDSIGNING \
--keystore "${endpoint#https://}" \
--storepass env:AZURE_SIGNING_TOKEN \
--alias "$account/$profile" \
--alg SHA-256 \
--tsaurl http://timestamp.acs.microsoft.com --tsmode RFC3161 \
--tsretries 3 --tsretrywait 10 \
--name "Alkane Toolkit" \
--url https://gitea.bluefla.re/blueflare/alkane-toolkit \
"$file"
# jsign fails on any error; also make sure a signature actually landed in
# the PE certificate table before the file goes anywhere.
python3 - "$file" <<'PY'
import struct, sys
data = open(sys.argv[1], "rb").read()
pe = struct.unpack_from("<I", data, 0x3C)[0]
magic = struct.unpack_from("<H", data, pe + 24)[0]
dirs = pe + 24 + (96 if magic == 0x10B else 112)
offset, size = struct.unpack_from("<II", data, dirs + 4 * 8) # IMAGE_DIRECTORY_ENTRY_SECURITY
if size == 0:
sys.exit(f"{sys.argv[1]}: no Authenticode signature after signing")
print(f"{sys.argv[1]}: signed ({size} byte certificate table)")
PY
done
+97
View File
@@ -0,0 +1,97 @@
#!/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 tempfile
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")
def test_quality_grade_follows_lint_and_coverage(self):
# A lint failure fails the grade; otherwise it is the coverage band,
# with the same floors as the coverage badge colour.
self.assertEqual(gen_badges.quality_grade("failed", 95.0), "F")
self.assertEqual(gen_badges.quality_grade("clean", 85.0), "A")
self.assertEqual(gen_badges.quality_grade("clean", 65.6), "B")
self.assertEqual(gen_badges.quality_grade("clean", 48.0), "C")
self.assertEqual(gen_badges.quality_grade("clean", 25.0), "D")
self.assertEqual(gen_badges.quality_grade("clean", 5.0), "F")
self.assertEqual(gen_badges.quality_grade("clean"), "pending")
self.assertEqual(gen_badges.quality_grade(None, 90.0), "pending")
for pct in (85.0, 65.6, 48.0, 25.0):
grade = gen_badges.quality_grade("clean", pct)
self.assertEqual(gen_badges.GRADE_COLORS[grade], gen_badges.cov_color(pct))
def test_coverage_table_is_split_by_crate(self):
with tempfile.TemporaryDirectory(prefix="alkane-cov-") as directory:
summary = Path(directory) / "summary.txt"
summary.write_text(
"Filename Regions Missed Regions Cover Functions Missed Functions "
"Executed Lines Missed Lines Cover\n"
"crates/alkane-gui/src/ui.rs 10 5 50.00% 4 2 50.00% 100 60 40.00%\n"
"crates/alkane-core/src/platform.rs 4 0 100.00% 2 0 100.00% 50 5 90.00%\n"
"TOTAL 14 5 64.29% 6 2 66.67% 150 65 56.67%\n")
rows = gen_badges.coverage_by_file(str(summary), directory)
self.assertEqual([r["file"] for r in rows],
["crates/alkane-gui/src/ui.rs", "crates/alkane-core/src/platform.rs"])
self.assertEqual(rows[0]["missed"], 60)
self.assertEqual(gen_badges.crate_of(rows[1]["file"]), "alkane-core")
def test_coverage_table_restores_the_stripped_crates_prefix(self):
with tempfile.TemporaryDirectory(prefix="alkane-cov-") as directory:
(Path(directory) / "crates" / "alkane-cli").mkdir(parents=True)
summary = Path(directory) / "summary.txt"
summary.write_text(
"alkane-cli/src/main.rs 4 4 0.00% 1 1 0.00% 23 23 0.00%\n")
rows = gen_badges.coverage_by_file(str(summary), directory)
self.assertEqual(rows[0], {"file": "crates/alkane-cli/src/main.rs",
"lines": 23, "missed": 23})
self.assertEqual(gen_badges.crate_of(rows[0]["file"]), "alkane-cli")
if __name__ == "__main__":
unittest.main()
+130
View File
@@ -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("&lt;script&gt;", page)
self.assertNotIn("<script>", page)
self.assertIn("10.000", page)
self.assertIn("same inputs", page)
if __name__ == "__main__":
unittest.main()
+6
View File
@@ -53,6 +53,12 @@ R="$(new_repo)"; mkdir -p "$R/ci"; printf '2' > "$R/ci/version-x.txt"
printf 'x' > "$R/README.md"; commit "$R" init
run_case first_release_prebumped_x "$R" version=2.0.0 bump=initial release=true
# 3b. Windows packaging (build script / resources) is release-relevant: bumps Y
R="$(new_repo)"; mkdir -p "$R/ci" "$R/crates/alkane-gui/windows"; printf '0' > "$R/ci/version-x.txt"
printf 'x' > "$R/README.md"; commit "$R" init; git -C "$R" tag v1.2.3
printf '<assembly/>' > "$R/crates/alkane-gui/windows/alkane-toolkit.exe.manifest"; commit "$R" winres
run_case windows_resources_bump "$R" version=1.3.0 bump=backend release=true
# 3. Backend path change bumps Y
R="$(new_repo)"; mkdir -p "$R/ci" "$R/crates/alkane-gui/src"; printf '0' > "$R/ci/version-x.txt"
printf 'x' > "$R/README.md"; commit "$R" init; git -C "$R" tag v1.2.3
+35
View File
@@ -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")
+218
View File
@@ -0,0 +1,218 @@
#!/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", "Check first-party Rust formatting",
"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",
)),
("release.yml", "main", "windows", (
"Clippy (Windows target, warnings are errors)", "Build release (Windows)",
"Unit tests (Windows build, under Wine)",
"Headless UI self-test (Windows build, under Wine)",
"Sign Windows executable (Azure Artifact Signing)",
"Package Windows artifact", "Clean generated Toolkit build",
)),
("next.yml", "next", "candidate", (
"Check runner image pins", "Build release candidate",
"Create private prerelease", "Clean generated Toolkit build",
)),
("next.yml", "next", "windows", (
"Build Windows candidate", "Sign Windows candidate (Azure Artifact Signing)",
"Package Windows candidate",
"Clean generated Toolkit build",
)),
("verify.yml", "main", "verify", (
"Check runner image pins", "Detect changed surface",
"Check CI change surface", "Check first-party Rust formatting",
"Check workflow-only change",
"Clippy (our crate, warnings are errors)", "Build", "Unit tests",
"Microbenchmarks", "Headless UI self-test", "Clean generated Toolkit build",
)),
("verify.yml", "main", "verify-windows", (
"Clippy (Windows target, warnings are errors)", "Build (Windows)",
"Unit tests (Windows build, under Wine)",
"Headless UI self-test (Windows build, under Wine)",
"Clean generated Toolkit build",
)),
]
for filename, branch, job_name, gates in required:
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", "Package Windows artifact",
"Build Windows candidate", "Package Windows candidate",
"Sign Windows candidate (Azure Artifact Signing)"}:
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 first-party Rust formatting":
assert condition == ("steps.surface.outputs.surface == 'headless' || "
"steps.surface.outputs.surface == 'full'"), 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()
+85
View File
@@ -0,0 +1,85 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Every Windows CI step in one place, so verify (PRs), the main release and the
# next-branch candidates build and test the .exe the same way:
#
# windows-ci.sh toolchain mingw-w64 + Wine + the rustup target
# windows-ci.sh clippy clippy for x86_64-pc-windows-gnu, -D warnings
# windows-ci.sh build release alkane-toolkit.exe
# windows-ci.sh test all unit tests, run under Wine
# windows-ci.sh selftest headless UI self-test under Wine + Xvfb
# windows-ci.sh sign Authenticode-sign alkane-toolkit.exe through
# Azure Artifact Signing (ci/sign-windows.sh;
# a no-op until AZURE_SIGNING_PROFILE is set)
# windows-ci.sh package VERSION dist/alkane-toolkit-vVERSION-windows-x86_64.zip
# windows-ci.sh test-bundle dist/alkane-toolkit-windows-tests.zip (for
# the native Windows job)
#
# The wxMSW prefix comes from the CI image or ci/ensure-wx-prefix.sh windows.
set -euo pipefail
cd "$(git rev-parse --show-toplevel)"
export WX_WINDOWS_PREFIX="${WX_WINDOWS_PREFIX:-/root/.cache/wx-3.3.3-mingw}"
export ALKANE_WINEPREFIX="${ALKANE_WINEPREFIX:-/root/.cache/alkane-wine}"
# shellcheck source=../scripts/windows-cross-env.sh
. scripts/windows-cross-env.sh
target="$ALKANE_WIN_TARGET"
out_dir="${CARGO_TARGET_DIR:-target}"
exe="$out_dir/$target/release/alkane-toolkit.exe"
# The GUI crate's tests link wx and some create windows; Wine wants a display.
headless() { xvfb-run -a -s '-screen 0 1280x850x24' "$@"; }
case "${1:-}" in
toolchain)
bash ci/ensure-build-deps.sh windows
rustup target list --installed | grep -qx "$target" || rustup target add "$target"
# jsign ships in the CI image; fetch the same pinned jar on older images.
jsign_version=7.6
jsign_sha256=6cf58aa080e7ff82656f320cff8d4a3bff30408df8766806dcba3740dd839fa5
if [ ! -s /opt/jsign/jsign.jar ]; then
mkdir -p /opt/jsign
curl -sSfL -o /opt/jsign/jsign.jar \
"https://repo1.maven.org/maven2/net/jsign/jsign/$jsign_version/jsign-$jsign_version.jar"
echo "$jsign_sha256 /opt/jsign/jsign.jar" | sha256sum -c -
fi
;;
clippy)
rustup component add clippy >/dev/null 2>&1 || true
cargo clippy -p alkane-gui --no-deps --release --bins --target "$target" --offline -- -D warnings
cargo clippy --workspace --exclude alkane-gui --exclude wx-rs --all-targets \
--target "$target" --offline -- -D warnings
;;
build)
cargo build --release -p alkane-gui --target "$target" --offline
# One self-contained .exe: any toolchain DLL import would fail on a clean
# Windows machine, so refuse to ship one.
if x86_64-w64-mingw32-objdump -p "$exe" | grep -iE 'DLL Name: (libstdc|libgcc|libwinpthread)'; then
echo "alkane-toolkit.exe imports a mingw runtime DLL" >&2
exit 1
fi
;;
test)
headless cargo test --workspace --exclude wx-rs --target "$target" --offline 2>&1 \
| tee tests-windows.txt
;;
selftest)
bash scripts/ui-selftest-windows.sh "$exe"
;;
sign)
bash ci/sign-windows.sh "$exe"
;;
package)
python3 ci/package-windows.py release "${2:?usage: windows-ci.sh package VERSION}" "$exe" dist
;;
test-bundle)
mkdir -p dist
cargo test --workspace --exclude wx-rs --target "$target" --offline --no-run \
--message-format=json > "$out_dir/windows-tests.json"
python3 ci/package-windows.py tests "$out_dir/windows-tests.json" \
dist/alkane-toolkit-windows-tests.zip
;;
*)
sed -n '3,19p' "$0" >&2
exit 2
;;
esac
+40
View File
@@ -0,0 +1,40 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# Key a wxWidgets prefix to its tracked source and build toolchain.
# wx-cache-key.sh [linux|windows]
set -euo pipefail
platform="${1:-linux}"
if [ "$platform" = windows ]; then
material="$({
git rev-parse HEAD:thirdparty/wxwidgets/wxWidgets-3.3.3
git rev-parse HEAD:scripts/build-wx-windows.sh
x86_64-w64-mingw32-g++-posix -dumpmachine
x86_64-w64-mingw32-g++-posix -dumpfullversion
} )"
digest="$(printf '%s\n' "$material" | sha256sum | cut -c1-24)"
key="wx-3.3.3-mingw-$digest"
if [ -n "${GITHUB_OUTPUT:-}" ]; then printf 'key=%s\n' "$key" >> "$GITHUB_OUTPUT"; else printf '%s\n' "$key"; fi
exit 0
fi
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
+219 -1
View File
@@ -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 = alkane_core::platform::quiet_command("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)
));
}
}
+2
View File
@@ -6,3 +6,5 @@ license.workspace = true
[dependencies]
alkane-core = { path = "../alkane-core" }
sha2.workspace = true
thiserror.workspace = true
+257 -1
View File
@@ -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();
}
}
+1
View File
@@ -6,3 +6,4 @@ license.workspace = true
[dependencies]
alkane-core = { path = "../alkane-core" }
alkane-artifacts = { path = "../alkane-artifacts" }
+29 -2
View File
@@ -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);
}
}
+2
View File
@@ -1 +1,3 @@
// alkane-core
pub mod platform;
+148
View File
@@ -0,0 +1,148 @@
//! The few places the toolkit's behaviour depends on the operating system,
//! kept together so the rest of the code stays platform-neutral.
//!
//! - where per-user settings live ([`config_dir`]),
//! - how a secret file is written so only its owner can read it
//! ([`write_private`]),
//! - the null device for tools that insist on an output path ([`NULL_DEVICE`]),
//! - how helper programs (`ssh`, `curl`) are started from the GUI without a
//! console window popping up on Windows ([`quiet_command`]).
use std::path::{Path, PathBuf};
use std::process::Command;
/// Directory name of the toolkit's settings under the per-user config root.
pub const APP_DIR: &str = "alkane-toolkit";
/// Environment variable whose value is the per-user config root on this
/// platform: `HOME` (settings in `$HOME/.config/alkane-toolkit`) on Unix,
/// `APPDATA` (settings in `%APPDATA%\alkane-toolkit`) on Windows. Tests point it
/// at a scratch directory.
#[cfg(not(windows))]
pub const CONFIG_ROOT_VAR: &str = "HOME";
#[cfg(windows)]
pub const CONFIG_ROOT_VAR: &str = "APPDATA";
/// The per-user settings directory (not created here).
///
/// Unix keeps the long-standing `$HOME/.config/alkane-toolkit`. Windows uses
/// the roaming application-data folder, `%APPDATA%\alkane-toolkit`, which is
/// where Windows applications keep per-user settings and which the user
/// profile's ACL already restricts to its owner. A missing variable falls back
/// to the working directory, as before.
pub fn config_dir() -> PathBuf {
let root = std::env::var_os(CONFIG_ROOT_VAR).unwrap_or_else(|| ".".into());
if cfg!(windows) {
PathBuf::from(root).join(APP_DIR)
} else {
PathBuf::from(root).join(".config").join(APP_DIR)
}
}
/// `config_dir()/file`.
pub fn config_path(file: &str) -> PathBuf {
config_dir().join(file)
}
/// The null device, for tools that want an output path (`curl -o`,
/// `ssh -o UserKnownHostsFile=`).
#[cfg(not(windows))]
pub const NULL_DEVICE: &str = "/dev/null";
#[cfg(windows)]
pub const NULL_DEVICE: &str = "NUL";
/// Write `data` to `path` so only the owner can read it.
///
/// On Unix the file is created 0600 (so a secret is never momentarily
/// world-readable between write and chmod), and a pre-existing file is
/// re-tightened while it is still empty, before the plaintext is written. On
/// Windows the settings directory inherits the user profile's owner-only ACL,
/// so a plain write already has the equivalent protection.
pub fn write_private(path: &Path, data: &[u8]) -> std::io::Result<()> {
#[cfg(unix)]
{
use std::io::Write;
use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
let mut f = std::fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.mode(0o600)
.open(path)?;
f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
f.write_all(data)
}
#[cfg(not(unix))]
{
std::fs::write(path, data)
}
}
/// A [`Command`] for a helper program run in the background of the GUI.
///
/// On Windows a console program (`ssh.exe`, `curl.exe`) started from a GUI
/// process gets a new console window by default, so every probe would flash a
/// black window; `CREATE_NO_WINDOW` suppresses that while keeping its piped
/// stdin/stdout/stderr. Elsewhere this is `Command::new`.
pub fn quiet_command(program: &str) -> Command {
#[allow(unused_mut)]
let mut command = Command::new(program);
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
command.creation_flags(CREATE_NO_WINDOW);
}
command
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn config_dir_is_under_the_platform_root() {
let dir = config_dir();
assert!(dir.ends_with(APP_DIR), "{dir:?}");
if cfg!(windows) {
assert!(!dir.to_string_lossy().contains(".config"), "{dir:?}");
} else {
assert!(dir.parent().unwrap().ends_with(".config"), "{dir:?}");
}
assert_eq!(config_path("x.txt"), dir.join("x.txt"));
}
#[test]
fn write_private_round_trips_and_restricts() {
let dir = std::env::temp_dir().join(format!("alkane-private-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let path = dir.join("secret.txt");
write_private(&path, b"one").unwrap();
write_private(&path, b"two").unwrap();
assert_eq!(std::fs::read(&path).unwrap(), b"two");
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
let mode = std::fs::metadata(&path).unwrap().permissions().mode() & 0o777;
assert_eq!(mode, 0o600);
}
std::fs::remove_dir_all(&dir).unwrap();
}
#[test]
fn quiet_command_runs_with_piped_output() {
// `cmd /C echo` and `sh -c echo` are the platform's own shells.
let mut command = if cfg!(windows) {
let mut c = quiet_command("cmd");
c.args(["/C", "echo alkane"]);
c
} else {
let mut c = quiet_command("sh");
c.args(["-c", "echo alkane"]);
c
};
let out = command.output().unwrap();
assert!(out.status.success());
assert!(String::from_utf8_lossy(&out.stdout).contains("alkane"));
}
}
+4
View File
@@ -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"
+446 -1
View File
@@ -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();
}
}
+91
View File
@@ -0,0 +1,91 @@
//! Build script for the alkane-toolkit binary. On Windows targets it compiles
//! windows/alkane-toolkit.rc (application manifest, icon, version info, and
//! wxMSW's stock resources) and links the result into the GUI executable only.
//! Other targets need nothing here.
use std::env;
use std::path::PathBuf;
use std::process::Command;
fn main() {
println!("cargo:rerun-if-changed=build.rs");
if env::var("CARGO_CFG_TARGET_OS").as_deref() != Ok("windows") {
return;
}
for f in [
"alkane-toolkit.rc",
"alkane-toolkit.exe.manifest",
"alkane-toolkit.ico",
] {
println!("cargo:rerun-if-changed=windows/{f}");
}
println!("cargo:rerun-if-env-changed=WX_RS_WXCONFIG");
if let Err(e) = compile_resources() {
panic!("alkane-gui: Windows resources: {e}");
}
}
fn compile_resources() -> Result<(), String> {
// The resource compiler and wx's resource include path come from the same
// wx-config the wx-rs bridge builds against, so they always match the
// linked wxMSW (and the mingw cross windres when cross-compiling).
let wxconfig = env::var("WX_RS_WXCONFIG").unwrap_or_else(|_| "wx-config".into());
let run = |arg: &str| -> Result<String, String> {
let out = Command::new(&wxconfig)
.arg(arg)
.output()
.map_err(|e| format!("cannot run {wxconfig} {arg}: {e}"))?;
if !out.status.success() {
return Err(format!("{wxconfig} {arg} failed"));
}
String::from_utf8(out.stdout).map_err(|e| e.to_string())
};
let rescomp = run("--rescomp")?;
let mut words = rescomp.split_whitespace();
let windres = words.next().ok_or("wx-config --rescomp printed nothing")?;
let mut args: Vec<String> = words.map(str::to_owned).collect();
// rcdefs.h lives in the build-specific setup directory, which --rescomp
// omits; it is the -I entry of --cxxflags.
for flag in run("--cxxflags")?.split_whitespace() {
if let Some(dir) = flag.strip_prefix("-I") {
args.push("--include-dir".into());
args.push(dir.into());
}
}
let version = env::var("CARGO_PKG_VERSION").unwrap_or_default();
let mut parts = version
.split(['.', '-', '+'])
.map(|p| p.parse::<u16>().unwrap_or(0));
let (major, minor, patch) = (
parts.next().unwrap_or(0),
parts.next().unwrap_or(0),
parts.next().unwrap_or(0),
);
let manifest_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").map_err(|e| e.to_string())?);
let out =
PathBuf::from(env::var("OUT_DIR").map_err(|e| e.to_string())?).join("alkane-toolkit-res.o");
let status = Command::new(windres)
.args(&args)
.arg("--include-dir")
.arg(manifest_dir.join("windows"))
.arg(format!("--define=ALKANE_VER_MAJOR={major}"))
.arg(format!("--define=ALKANE_VER_MINOR={minor}"))
.arg(format!("--define=ALKANE_VER_PATCH={patch}"))
.arg(format!("--define=ALKANE_VER_STR=\\\"{version}\\\""))
.arg("--input")
.arg(manifest_dir.join("windows/alkane-toolkit.rc"))
.arg("--output-format=coff")
.arg("--output")
.arg(&out)
.status()
.map_err(|e| format!("cannot run {windres}: {e}"))?;
if !status.success() {
return Err(format!("{windres} failed ({status})"));
}
// Only the GUI binary carries the manifest/icon; miner_probe stays a plain
// console tool. A linked object (not an archive member) is never dropped by
// the linker, which is what keeps the resource section in the .exe.
println!("cargo:rustc-link-arg-bin=alkane-toolkit={}", out.display());
Ok(())
}
Binary file not shown.
+34
View File
@@ -0,0 +1,34 @@
#!/bin/sh
# Regenerate alkane-toolkit.icns (the macOS app icon) from the in-repo
# microchip glyph: the same white chip on a rounded amber tile as the Windows
# icon, at the sizes macOS asks for (16-1024 px). Needs rsvg-convert,
# ImageMagick and python3; the .icns is committed, so a build never runs this.
set -e
cd "$(dirname "$0")"
GLYPH=../assets/icons/microchip-solid-full.svg
TMP=$(mktemp -d)
trap 'rm -rf "$TMP"' 0
sed 's/currentColor/#ffffff/g; s/<svg /<svg fill="#ffffff" /' "$GLYPH" > "$TMP/glyph.svg"
for s in 16 32 64 128 256 512 1024; do
# Apple's grid: the tile fills ~80% of the canvas, centred.
t=$((s * 80 / 100)); m=$(((s - t) / 2)); r=$((t * 22 / 100))
g=$((t * 60 / 100)); o=$(((s - g) / 2))
rsvg-convert -w "$g" -h "$g" "$TMP/glyph.svg" -o "$TMP/g$s.png"
convert -size "${s}x${s}" xc:none -fill '#d9822b' \
-draw "roundrectangle $m,$m $((m + t - 1)),$((m + t - 1)) $r,$r" \
"$TMP/g$s.png" -geometry "+$o+$o" -composite "PNG32:$TMP/i$s.png"
done
python3 - "$TMP" alkane-toolkit.icns <<'PY'
import pathlib, struct, sys
tmp, out = pathlib.Path(sys.argv[1]), sys.argv[2]
# ICNS element types that hold PNG data, by pixel size.
types = [("icp4", 16), ("icp5", 32), ("icp6", 64), ("ic07", 128), ("ic08", 256),
("ic09", 512), ("ic10", 1024), ("ic11", 32), ("ic12", 64), ("ic13", 256),
("ic14", 512)]
body = b""
for kind, size in types:
data = (tmp / f"i{size}.png").read_bytes()
body += kind.encode() + struct.pack(">I", len(data) + 8) + data
pathlib.Path(out).write_bytes(b"icns" + struct.pack(">I", len(body) + 8) + body)
PY
echo "wrote $(pwd)/alkane-toolkit.icns"
+142 -41
View File
@@ -29,10 +29,10 @@ use std::net::{SocketAddr, TcpStream};
use std::process::Command;
use std::time::Duration;
use aes::cipher::{block_padding::ZeroPadding, BlockEncryptMut, KeyInit};
use aes::Aes256;
use aes::cipher::{BlockEncryptMut, KeyInit, block_padding::ZeroPadding};
use base64::Engine;
use base64::engine::general_purpose::STANDARD as BASE64;
use base64::Engine;
use sha2::{Digest, Sha256};
type Aes256EcbEnc = ecb::Encryptor<Aes256>;
@@ -42,9 +42,9 @@ type Aes256EcbEnc = ecb::Encryptor<Aes256>;
/// authenticated/unauthorized answer is `None`.
pub fn classify_http_code(code: &str) -> Option<bool> {
match code.trim() {
"200" | "204" => Some(false), // authenticated -> unlocked/writable
"401" | "403" => Some(true), // rejected -> locked/view-only
_ => None, // 000 (no connect), 404, 5xx, ... -> unknown
"200" | "204" => Some(false), // authenticated -> unlocked/writable
"401" | "403" => Some(true), // rejected -> locked/view-only
_ => None, // 000 (no connect), 404, 5xx, ... -> unknown
}
}
@@ -61,27 +61,45 @@ fn endpoint(_firmware: &str) -> &'static str {
/// could not run at all.
pub fn probe_access(ip: &str, make: &str, user: &str, pass: &str) -> Result<Option<bool>, String> {
if make.eq_ignore_ascii_case("whatsminer") {
return Ok(probe_whatsminer_access(ip, &whatsminer_password_candidates()));
// Try the caller's saved scan password first (round 18 #12: it was being
// ignored for WhatsMiner, so a miner opened with the operator's real
// password was mis-reported as locked), then the per-firmware override and
// factory defaults. All attempts are non-mutating.
let mut candidates = Vec::new();
if !pass.is_empty() {
candidates.push(pass.to_string());
}
for c in whatsminer_password_candidates() {
if !candidates.contains(&c) {
candidates.push(c);
}
}
return Ok(probe_whatsminer_access(ip, &candidates));
}
let url = format!("http://{ip}{}", endpoint(make));
let userpass = format!("{user}:{pass}");
let mut cmd = Command::new("curl");
let mut cmd = alkane_core::platform::quiet_command("curl");
cmd.args([
"-s",
"-o",
"/dev/null",
alkane_core::platform::NULL_DEVICE,
"-w",
"%{http_code}",
"--digest",
"-u",
&userpass,
"--connect-timeout",
"5",
"--max-time",
"9",
"-K",
"-", // read the rest of the config (the credentials) from stdin
&url,
]);
let out = wait_with_timeout(cmd, Duration::from_secs(12))?;
// The user:pass goes through a curl config on stdin, never argv, so it can't
// be read from the process list (round 18 #12).
let config = format!(
"user = \"{}\"\n",
curl_config_quote(&format!("{user}:{pass}"))
);
let out = wait_with_timeout(cmd, Duration::from_secs(12), Some(config.as_bytes()))?;
// curl prints the status code to stdout regardless of exit status (000 on a
// connection failure), so classify the code rather than the exit status.
let code = String::from_utf8_lossy(&out.stdout);
@@ -89,11 +107,26 @@ pub fn probe_access(ip: &str, make: &str, user: &str, pass: &str) -> Result<Opti
}
/// Run a command with a wall-clock timeout (curl can hang past --max-time on a
/// black-holed host).
fn wait_with_timeout(mut cmd: Command, timeout: Duration) -> Result<std::process::Output, String> {
use std::io::Read;
cmd.stdout(std::process::Stdio::piped()).stderr(std::process::Stdio::piped());
/// black-holed host). `stdin_data`, when set, is written to the child's stdin and
/// the pipe closed -- used to feed a curl config (with the credentials) instead
/// of putting them on the command line (round 18 #12).
fn wait_with_timeout(
mut cmd: Command,
timeout: Duration,
stdin_data: Option<&[u8]>,
) -> Result<std::process::Output, String> {
use std::io::{Read, Write};
cmd.stdout(std::process::Stdio::piped())
.stderr(std::process::Stdio::piped());
if stdin_data.is_some() {
cmd.stdin(std::process::Stdio::piped());
}
let mut child = cmd.spawn().map_err(|e| format!("spawn curl: {e}"))?;
if let Some(data) = stdin_data {
if let Some(mut si) = child.stdin.take() {
let _ = si.write_all(data);
} // dropping `si` closes the pipe so curl stops reading the config
}
let start = std::time::Instant::now();
loop {
match child.try_wait().map_err(|e| e.to_string())? {
@@ -106,11 +139,16 @@ fn wait_with_timeout(mut cmd: Command, timeout: Duration) -> Result<std::process
if let Some(mut e) = child.stderr.take() {
let _ = e.read_to_end(&mut stderr);
}
return Ok(std::process::Output { status, stdout, stderr });
return Ok(std::process::Output {
status,
stdout,
stderr,
});
}
None => {
if start.elapsed() >= timeout {
let _ = child.kill();
let _ = child.wait(); // reap so we never leave a zombie (round 18 #12)
return Err("curl timed out".into());
}
std::thread::sleep(Duration::from_millis(100));
@@ -119,11 +157,17 @@ fn wait_with_timeout(mut cmd: Command, timeout: Duration) -> Result<std::process
}
}
/// Escape a value for a curl `--config` file (double-quoted string).
fn curl_config_quote(s: &str) -> String {
s.replace('\\', "\\\\").replace('"', "\\\"")
}
/// Passwords to try for a WhatsMiner access check: a user-set per-firmware
/// override (round 12 #13) wins; otherwise the two factory defaults ("admin" for
/// V1/V2, "super" for V3). All attempts are non-mutating, so trying both is safe.
fn whatsminer_password_candidates() -> Vec<String> {
if let Some((_, pass)) = crate::credentials::load_firmware_credentials().get("WhatsMiner Stock") {
if let Some((_, pass)) = crate::credentials::load_firmware_credentials().get("WhatsMiner Stock")
{
if !pass.is_empty() {
return vec![pass.clone()];
}
@@ -135,9 +179,17 @@ fn whatsminer_password_candidates() -> Vec<String> {
/// get_error_code command and format them one per line for the log viewer
/// (round 12 #12). Returns None if the miner does not answer.
pub fn whatsminer_get_error_code(ip: &str) -> Option<String> {
let resp = wm_rpc(ip, "{\"command\":\"get_error_code\"}", Duration::from_secs(6)).ok()?;
let resp = wm_rpc(
ip,
"{\"command\":\"get_error_code\"}",
Duration::from_secs(6),
)
.ok()?;
let v: serde_json::Value = serde_json::from_str(&resp).ok()?;
let codes = v.get("Msg").and_then(|m| m.get("error_code")).and_then(|c| c.as_array());
let codes = v
.get("Msg")
.and_then(|m| m.get("error_code"))
.and_then(|c| c.as_array());
let mut lines = vec![format!("WhatsMiner get_error_code ({ip}):")];
match codes {
Some(arr) if !arr.is_empty() => {
@@ -163,7 +215,9 @@ fn wm_rpc(ip: &str, payload: &str, timeout: Duration) -> Result<String, String>
let mut stream = TcpStream::connect_timeout(&addr, timeout).map_err(|e| e.to_string())?;
stream.set_read_timeout(Some(timeout)).ok();
stream.set_write_timeout(Some(timeout)).ok();
stream.write_all(payload.as_bytes()).map_err(|e| e.to_string())?;
stream
.write_all(payload.as_bytes())
.map_err(|e| e.to_string())?;
let mut buf = Vec::new();
let mut chunk = [0u8; 4096];
loop {
@@ -178,7 +232,9 @@ fn wm_rpc(ip: &str, payload: &str, timeout: Duration) -> Result<String, String>
Err(_) => break,
}
}
Ok(String::from_utf8_lossy(&buf).trim_matches('\u{0}').to_string())
Ok(String::from_utf8_lossy(&buf)
.trim_matches('\u{0}')
.to_string())
}
/// AES-256-ECB encrypt `data` under SHA256(pwd_md5), base64-encoded -- the exact
@@ -205,49 +261,78 @@ fn wm_aes_ecb_enc(pwd_md5: &str, data: &str) -> Option<String> {
fn probe_whatsminer_access(ip: &str, passwords: &[String]) -> Option<bool> {
let timeout = Duration::from_secs(6);
let mut reachable = false;
// A transient error on one candidate must not abandon the others (round 18 #12):
// skip to the next candidate, but remember it happened so we never report a
// confident "locked" when the answer was really indeterminate.
let mut errored = false;
for pass in passwords {
// 1. get_token (no auth) -> salt / newsalt / time.
let tok_resp = match wm_rpc(ip, "{\"command\":\"get_token\"}", timeout) {
Ok(s) => s,
Err(_) => return None,
Err(_) => {
errored = true;
continue;
}
};
let v: serde_json::Value = match serde_json::from_str(&tok_resp) {
Ok(v) => v,
Err(_) => return None,
Err(_) => {
errored = true;
continue;
}
};
let Some(msg) = v.get("Msg") else { return None };
let (Some(salt), Some(newsalt), Some(time)) = (
msg.get("salt").and_then(|s| s.as_str()),
msg.get("newsalt").and_then(|s| s.as_str()),
msg.get("time").and_then(|s| s.as_str()),
) else {
return None;
let (Some(salt), Some(newsalt), Some(time)) = v
.get("Msg")
.map(|msg| {
(
msg.get("salt").and_then(|s| s.as_str()),
msg.get("newsalt").and_then(|s| s.as_str()),
msg.get("time").and_then(|s| s.as_str()),
)
})
.unwrap_or((None, None, None))
else {
errored = true;
continue;
};
reachable = true;
// 2. Derive the md5crypt password hash + write-token from the password.
let crypted = md5crypt::md5crypt(pass.as_bytes(), salt.as_bytes());
let full = String::from_utf8_lossy(&crypted);
let Some(pwd_md5) = full.split('$').nth(3) else { continue };
let sign_crypted = md5crypt::md5crypt(format!("{pwd_md5}{time}").as_bytes(), newsalt.as_bytes());
let Some(pwd_md5) = full.split('$').nth(3) else {
continue;
};
let sign_crypted =
md5crypt::md5crypt(format!("{pwd_md5}{time}").as_bytes(), newsalt.as_bytes());
let sign_full = String::from_utf8_lossy(&sign_crypted);
let host_sign = sign_full.split('$').nth(3).unwrap_or("");
// 3. Send an encrypted, read-only `summary`. If the AES key (from the
// password) is right the miner replies encrypted; if wrong it returns
// a plaintext "enc json load err".
let cmd = format!("{{\"command\":\"summary\",\"token\":\"{host_sign}\"}}");
let Some(enc) = wm_aes_ecb_enc(pwd_md5, &cmd) else { continue };
let Some(enc) = wm_aes_ecb_enc(pwd_md5, &cmd) else {
continue;
};
let payload = format!("{{\"enc\":1,\"data\":\"{enc}\"}}");
let resp = match wm_rpc(ip, &payload, timeout) {
Ok(s) => s,
Err(_) => return None,
Err(_) => {
errored = true;
continue;
}
};
if resp.contains("\"enc\"") {
return Some(false); // accepted -> unlocked/writable
}
// rejected -> try the next candidate password
}
// Reached the miner and every candidate password was rejected -> locked.
if reachable { Some(true) } else { None }
// Only report "locked" when we cleanly reached the miner and every candidate
// was rejected with no transient errors; otherwise the result is indeterminate.
if reachable && !errored {
Some(true)
} else {
None
}
}
#[cfg(test)]
@@ -256,14 +341,30 @@ mod tests {
#[test]
fn classify_codes() {
assert_eq!(classify_http_code("200"), Some(false), "authenticated -> unlocked");
assert_eq!(
classify_http_code("200"),
Some(false),
"authenticated -> unlocked"
);
assert_eq!(classify_http_code("204"), Some(false));
assert_eq!(classify_http_code("401"), Some(true), "unauthorized -> locked");
assert_eq!(
classify_http_code("401"),
Some(true),
"unauthorized -> locked"
);
assert_eq!(classify_http_code("403"), Some(true));
assert_eq!(classify_http_code("000"), None, "no connection -> unknown");
assert_eq!(classify_http_code("404"), None, "endpoint absent -> unknown");
assert_eq!(
classify_http_code("404"),
None,
"endpoint absent -> unknown"
);
assert_eq!(classify_http_code("500"), None);
assert_eq!(classify_http_code(" 200 "), Some(false), "whitespace tolerated");
assert_eq!(
classify_http_code(" 200 "),
Some(false),
"whitespace tolerated"
);
assert_eq!(classify_http_code(""), None);
}
+122
View File
@@ -0,0 +1,122 @@
//! Non-interactive SSH password logins without `sshpass`.
//!
//! OpenSSH (Linux, and the `ssh.exe` built into Windows 10/11) asks the
//! program named by `SSH_ASKPASS` for a password when `SSH_ASKPASS_REQUIRE=force`
//! (OpenSSH 8.4+). The toolkit names its own executable: when ssh runs it with
//! [`ROLE_ENV`] set, `main()` calls [`serve_if_askpass`] first thing, which
//! prints the password from [`SECRET_ENV`] and exits before any GUI starts.
//!
//! This replaces `sshpass`, which Windows does not have, with one mechanism for
//! every platform. Like `sshpass -e` the password travels in the child's
//! environment, never on a command line where the process list would show it.
use std::ffi::OsStr;
use std::process::{Command, Stdio};
/// Set (to "1") in the environment of an ssh child whose askpass helper is us.
pub const ROLE_ENV: &str = "ALKANE_SSH_ASKPASS";
/// The password the askpass helper hands back to ssh.
pub const SECRET_ENV: &str = "ALKANE_SSH_SECRET";
/// If this process is ssh's askpass helper, answer the prompt and return the
/// exit code to use; otherwise `None` and the app starts normally.
pub fn serve_if_askpass() -> Option<i32> {
std::env::var_os(ROLE_ENV)?;
let prompt = std::env::args_os().nth(1).unwrap_or_default();
Some(answer(&prompt, std::env::var_os(SECRET_ENV).as_deref()))
}
/// Print the secret for a password prompt. Anything else ssh might ask through
/// askpass (a host-key "yes/no" confirmation, a passphrase for a key we never
/// configured) is refused, so a changed prompt can never be answered with the
/// password by accident.
fn answer(prompt: &OsStr, secret: Option<&OsStr>) -> i32 {
let Some(secret) = secret else { return 1 };
if !is_password_prompt(&prompt.to_string_lossy()) {
return 1;
}
use std::io::Write;
let mut out = std::io::stdout().lock();
if out
.write_all(secret.to_string_lossy().as_bytes())
.and_then(|_| out.write_all(b"\n"))
.and_then(|_| out.flush())
.is_err()
{
return 1;
}
0
}
fn is_password_prompt(prompt: &str) -> bool {
let p = prompt.to_ascii_lowercase();
p.contains("password") && !p.contains("yes/no")
}
/// Configure an `ssh` command to log in with `password` and never block on a
/// terminal prompt. ssh tries password (and keyboard-interactive) auth once;
/// a wrong password fails fast with "Permission denied" instead of hanging.
pub fn ssh_with_password(cmd: &mut Command, password: &str) -> Result<(), String> {
let exe = std::env::current_exe().map_err(|e| format!("locate askpass helper: {e}"))?;
cmd.env("SSH_ASKPASS", exe)
.env("SSH_ASKPASS_REQUIRE", "force")
.env(ROLE_ENV, "1")
.env(SECRET_ENV, password)
.stdin(Stdio::null());
Ok(())
}
/// ssh `-o` options that go with [`ssh_with_password`].
pub const PASSWORD_AUTH_OPTIONS: [&str; 4] = [
"-o",
"PreferredAuthentications=password,keyboard-interactive",
"-o",
"NumberOfPasswordPrompts=1",
];
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn only_password_prompts_are_answered() {
assert!(is_password_prompt("root@10.0.0.1's password: "));
assert!(is_password_prompt("Password:"));
assert!(!is_password_prompt(
"Are you sure you want to continue connecting (yes/no/[fingerprint])?"
));
assert!(!is_password_prompt(
"Enter passphrase for key '/x/id_ed25519':"
));
assert_eq!(
answer(OsStr::new("Password:"), None),
1,
"no secret -> refuse"
);
assert_eq!(
answer(OsStr::new("Continue (yes/no)?"), Some(OsStr::new("pw"))),
1
);
}
#[test]
fn ssh_command_gets_askpass_environment() {
let mut cmd = Command::new("ssh");
ssh_with_password(&mut cmd, "hunter2").unwrap();
let env: std::collections::HashMap<_, _> = cmd
.get_envs()
.map(|(k, v)| (k.to_owned(), v.map(|v| v.to_owned())))
.collect();
assert_eq!(
env[OsStr::new("SSH_ASKPASS_REQUIRE")].as_deref(),
Some(OsStr::new("force"))
);
assert_eq!(
env[OsStr::new(SECRET_ENV)].as_deref(),
Some(OsStr::new("hunter2"))
);
assert!(env[OsStr::new("SSH_ASKPASS")].is_some());
// The password is never an argument.
assert!(cmd.get_args().all(|a| a != "hunter2"));
}
}
+287 -13
View File
@@ -1,6 +1,6 @@
//! miner_probe -- a read-only (by default) asic-rs diagnostic for live-hardware
//! verification of the round-9 power-limit work. It reuses the same MinerFactory
//! + saved-credential setup the GUI uses (see crate::credentials), but as a
//! and saved-credential setup the GUI uses (see crate::credentials), but as a
//! standalone CLI so hardware checks don't go through the wx event loop.
//!
//! Usage:
@@ -19,18 +19,19 @@
//! ALKANE_PROBE_USER / ALKANE_PROBE_PASS if set (so a test can authenticate
//! without touching the app's saved config).
use asic_rs::MinerFactory;
use asic_rs::core::traits::miner::MinerAuth;
use asic_rs::MinerFactory;
use futures_util::StreamExt;
use measurements::Power;
fn load_creds() -> Option<(String, String)> {
if let (Ok(u), Ok(pw)) = (std::env::var("ALKANE_PROBE_USER"), std::env::var("ALKANE_PROBE_PASS")) {
if let (Ok(u), Ok(pw)) = (
std::env::var("ALKANE_PROBE_USER"),
std::env::var("ALKANE_PROBE_PASS"),
) {
return Some((u, pw));
}
let home = std::env::var("HOME").ok()?;
let p = std::path::PathBuf::from(home)
.join(".config/alkane-toolkit/scan-credentials.txt");
let p = alkane_core::platform::config_path("scan-credentials.txt");
let s = std::fs::read_to_string(p).ok()?;
let mut l = s.lines();
let u = l.next()?.to_string();
@@ -39,12 +40,17 @@ fn load_creds() -> Option<(String, String)> {
}
fn factory() -> MinerFactory {
// This diagnostic CLI is a separate binary from the GUI, so it cannot share
// the GUI's credentials::configured_factory. It applies only the global scan
// credentials to every firmware; the GUI's per-firmware credential overrides
// are NOT read here (round 18 #12), which the message below makes explicit so a
// probe result is never mistaken for what the GUI (with overrides) would see.
let mut f = MinerFactory::new();
if let Some((u, pw)) = load_creds() {
for fw in asic_rs::factory::default_firmware_registry() {
f = f.with_firmware_discovery_auth(fw.as_ref(), MinerAuth::new(u.clone(), pw.clone()));
}
eprintln!("(using saved scan credentials for discovery auth)");
eprintln!("(using the global scan credentials; per-firmware overrides are not applied)");
} else {
eprintln!("(no saved credentials -- backends use their default auth)");
}
@@ -62,6 +68,18 @@ async fn scan(cidrs: &[String]) {
}
};
}
// Cap identification concurrency to match the GUI (see
// scan::SCAN_CONCURRENCY_LIMIT). asic-rs defaults to 1000, which over a real
// link starves the per-responder get_data -- Braiins miners drop most values
// (watts=0, no best-share) and some responders are missed entirely. 128 is the
// highest cap that stayed fully reliable on the live fleet. ALKANE_PROBE_CONCURRENCY
// overrides it for diagnostics.
let concurrency = std::env::var("ALKANE_PROBE_CONCURRENCY")
.ok()
.and_then(|c| c.parse::<usize>().ok())
.unwrap_or(128);
eprintln!("(scan concurrency = {concurrency})");
f = f.with_concurrent_limit(concurrency);
println!("ip\tmake\tfirmware\tfw_version\tmodel_id\tcontrol_board\twatts\tsupports_power_limit\tsupports_tuning\tbest_share\tsession_best_share");
let mut stream = f.scan_stream_with_ip();
let mut found = 0usize;
@@ -75,8 +93,14 @@ async fn scan(cidrs: &[String]) {
.map(|c| c.to_string())
.unwrap_or_default();
let fw_ver = data.firmware_version.clone().unwrap_or_default();
let bs = data.best_share.map(|v| format!("{v:.0}")).unwrap_or_default();
let sbs = data.session_best_share.map(|v| format!("{v:.0}")).unwrap_or_default();
let bs = data
.best_share
.map(|v| format!("{v:.0}"))
.unwrap_or_default();
let sbs = data
.session_best_share
.map(|v| format!("{v:.0}"))
.unwrap_or_default();
println!(
"{ip}\t{}\t{}\t{}\t{}\t{}\t{watts:.0}\t{}\t{}\t{bs}\t{sbs}",
data.device_info.make,
@@ -263,6 +287,12 @@ async fn msgs(ip_s: &str) {
match f.scan_miner(ip).await {
Ok(Some(m)) => {
let d = m.get_data().await;
let th = |h: &Option<asic_rs::core::data::hashrate::HashRate>| {
h.clone().map(|x| {
x.as_unit(asic_rs::core::data::hashrate::HashRateUnit::TeraHash)
.value
})
};
println!(
"{ip}: {} {} hashboards={:?} expected={:?}",
d.device_info.firmware,
@@ -270,13 +300,32 @@ async fn msgs(ip_s: &str) {
d.hashboards.len(),
d.expected_hashboards,
);
println!(
" TOTAL hashrate={:?} TH wattage={:?} W fluid/env_temp={:?} best_share={:?}",
th(&d.hashrate),
d.wattage.as_ref().map(|p| p.as_watts()),
d.fluid_temperature.as_ref().map(|t| t.as_celsius()),
d.best_share,
);
let fans: Vec<i64> = d
.fans
.iter()
.map(|f| f.rpm.as_ref().map(|r| r.as_rpm() as i64).unwrap_or(-1))
.collect();
println!(" fans(rpm)={fans:?} psu_fans={}", d.psu_fans.len());
for b in d.hashboards.iter() {
println!(
" board position={} hashrate={:?} chips={:?}/{:?}",
" board pos={} hr={:?}TH chips={:?}/{:?} board_temp={:?} outlet_temp={:?} freq={:?}MHz volt={:?}V chip_type={:?} hb_model={:?}",
b.position,
b.hashrate.clone().map(|h| h.as_unit(asic_rs::core::data::hashrate::HashRateUnit::TeraHash).value),
th(&b.hashrate),
b.working_chips,
b.expected_chips,
b.board_temperature.as_ref().map(|t| t.as_celsius()),
b.outlet_chip_temperature.as_ref().map(|t| t.as_celsius()),
b.frequency.as_ref().map(|f| f.as_megahertz()),
b.voltage.as_ref().map(|v| v.as_volts()),
b.chip_type,
b.hashboard_model,
);
}
if d.messages.is_empty() {
@@ -350,7 +399,7 @@ async fn lifecycle(ip_s: &str, verb: &str) {
/// Read (no tz arg) or set the miner's timezone (round 16 / G10). Capability-gated.
async fn timezone(ip_s: &str, tz: Option<&str>) {
use asic_rs::core::config::timezone::{Tz, TimezoneConfig};
use asic_rs::core::config::timezone::{TimezoneConfig, Tz};
let Ok(ip) = ip_s.parse::<std::net::IpAddr>() else {
eprintln!("bad ip {ip_s}");
return;
@@ -436,9 +485,219 @@ async fn factoryreset(ip_s: &str) {
}
}
/// READ-ONLY: dump a miner's structured-tuning surface -- what it supports, its
/// current target, and the capability envelope (power/hashrate min-max, or the
/// preset/mode list) the firmware advertises. Drives the round-17 C tuning work:
/// it shows what each live firmware actually offers before any write is wired up.
async fn tune(ip_s: &str) {
let ip: std::net::IpAddr = match ip_s.parse() {
Ok(ip) => ip,
Err(e) => {
eprintln!("bad ip {ip_s}: {e}");
return;
}
};
let f = factory();
match f.scan_miner(ip).await {
Ok(Some(m)) => {
let data = m.get_data().await;
println!(
"{ip}: {} {} {}",
data.device_info.make, data.device_info.firmware, data.device_info.model
);
println!(
" supports: power_limit={} tuning_percent={} tuning_config={}",
m.supports_set_power_limit(),
m.supports_set_tuning_percent(),
m.supports_tuning_config(),
);
println!(" psu={:?}", data.psu);
println!(" tuning_percent={:?}", data.tuning_percent);
println!(" tuning_target={:?}", data.tuning_target);
match &data.tuning_capabilities {
Some(c) => {
println!(" caps.power={:?}", c.power);
println!(" caps.hashrate={:?}", c.hashrate);
match &c.presets {
Some(p) => {
println!(" caps.presets.default={:?}", p.default);
println!(" caps.presets[{}]:", p.presets.len());
for t in &p.presets {
println!(" - {t:?}");
}
}
None => println!(" caps.presets=None"),
}
}
None => println!(" tuning_capabilities=None"),
}
}
Ok(None) => eprintln!("no miner at {ip}"),
Err(e) => eprintln!("scan_miner {ip}: {e}"),
}
}
/// WRITE (reversible): apply a structured tuning target via set_tuning_config.
/// `settune <ip> power <watts>` or `settune <ip> hashrate <ths>`. Prints the
/// prior target so the caller can restore it. Used to verify the set_tuning_config
/// path on live corpus hardware (round 17 C) before wiring it into the GUI.
async fn settune(ip_s: &str, kind: &str, value: f64) {
use asic_rs::core::config::tuning::TuningConfig;
use asic_rs::core::data::hashrate::HashRateUnit;
use asic_rs::core::data::miner::TuningTarget;
let ip: std::net::IpAddr = match ip_s.parse() {
Ok(ip) => ip,
Err(e) => {
eprintln!("bad ip {ip_s}: {e}");
return;
}
};
let f = factory();
match f.scan_miner(ip).await {
Ok(Some(m)) => {
let before = m.get_data().await;
eprintln!(
"target {ip}: {} {} {} (supports_tuning_config={}); prior target = {:?}",
before.device_info.make,
before.device_info.firmware,
before.device_info.model,
m.supports_tuning_config(),
before.tuning_target,
);
let target = match kind {
"power" => TuningTarget::Power(Power::from_watts(value)),
// Clone the miner's current HashRate to inherit its algorithm
// (HashAlgorithm is not publicly re-exported, so it cannot be named
// directly), overriding just the value and unit.
"hashrate" => match before.hashrate.clone() {
Some(mut hr) => {
hr.value = value;
hr.unit = HashRateUnit::TeraHash;
TuningTarget::HashRate(hr)
}
None => {
eprintln!(
"miner reports no current hashrate; cannot build a hashrate target"
);
return;
}
},
_ => {
eprintln!("kind must be 'power' or 'hashrate'");
return;
}
};
// Route by what the firmware actually supports: structured
// set_tuning_config where available (ePIC/VNish/WM), else the plain
// power-limit setter for a power target (LuxOS/Braiins tune by power
// and expose no set_tuning_config).
if m.supports_tuning_config() {
// Mirror the GUI apply path: preserve the firmware's current tuning
// algorithm + scaling (ePIC requires both for set_tuning_config).
let mut cfg = TuningConfig::new(target);
if let Some(algo) = m.get_tuning_config().await.ok().and_then(|c| c.algorithm) {
cfg = cfg.with_algorithm(algo);
}
let scaling = m.get_scaling_config().await.ok();
match m.set_tuning_config(cfg, scaling).await {
Ok(v) => println!("set_tuning_config({kind} {value}) -> Ok({v})"),
Err(e) => println!("set_tuning_config({kind} {value}) -> Err: {e:#}"),
}
} else if kind == "power" && m.supports_set_power_limit() {
match m.set_power_limit(Power::from_watts(value)).await {
Ok(v) => println!(
"set_power_limit({value} W) -> Ok({v}) [tuning_config unsupported]"
),
Err(e) => println!("set_power_limit({value} W) -> Err: {e:#}"),
}
} else {
println!("no structured-tuning path for {kind} on this firmware");
}
let after = m.get_data().await;
println!(" target now = {:?}", after.tuning_target);
}
Ok(None) => eprintln!("no miner at {ip}"),
Err(e) => eprintln!("scan_miner {ip}: {e}"),
}
}
/// READ: list the firmware's selectable profiles/presets (roadmap G3).
async fn presets(ip_s: &str) {
let ip: std::net::IpAddr = match ip_s.parse() {
Ok(ip) => ip,
Err(e) => {
eprintln!("bad ip {ip_s}: {e}");
return;
}
};
let f = factory();
match f.scan_miner(ip).await {
Ok(Some(m)) => {
if !m.supports_presets() {
println!("{ip}: firmware does not expose named presets");
return;
}
let list = m.get_presets().await;
if list.is_empty() {
println!("{ip}: no presets reported");
return;
}
for p in list {
match (p.pretty, p.status) {
(Some(pretty), Some(status)) => println!("{}\t{pretty}\t[{status}]", p.name),
(Some(pretty), None) => println!("{}\t{pretty}", p.name),
(None, _) => println!("{}", p.name),
}
}
}
Ok(None) => eprintln!("no miner at {ip}"),
Err(e) => eprintln!("scan_miner {ip}: {e}"),
}
}
/// WRITE (reversible): select a named firmware profile/preset (roadmap G3).
/// `setpreset <ip> <name>`. Prints the prior target so it can be restored.
async fn setpreset(ip_s: &str, name: &str) {
use asic_rs::core::config::tuning::TuningConfig;
use asic_rs::core::data::miner::TuningTarget;
let ip: std::net::IpAddr = match ip_s.parse() {
Ok(ip) => ip,
Err(e) => {
eprintln!("bad ip {ip_s}: {e}");
return;
}
};
let f = factory();
match f.scan_miner(ip).await {
Ok(Some(m)) => {
let before = m.get_data().await;
eprintln!(
"target {ip}: {} {} {} (supports_presets={}); prior target = {:?}",
before.device_info.make,
before.device_info.firmware,
before.device_info.model,
m.supports_presets(),
before.tuning_target,
);
let cfg = TuningConfig::new(TuningTarget::Preset(name.to_string()));
match m.set_tuning_config(cfg, None).await {
Ok(v) => println!("set_tuning_config(preset {name}) -> Ok({v})"),
Err(e) => println!("set_tuning_config(preset {name}) -> Err: {e:#}"),
}
let after = m.get_data().await;
println!(" target now = {:?}", after.tuning_target);
}
Ok(None) => eprintln!("no miner at {ip}"),
Err(e) => eprintln!("scan_miner {ip}: {e}"),
}
}
fn main() {
let args: Vec<String> = std::env::args().collect();
let rt = match tokio::runtime::Builder::new_current_thread().enable_all().build() {
let rt = match tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
{
Ok(rt) => rt,
Err(e) => {
eprintln!("tokio runtime: {e}");
@@ -467,6 +726,17 @@ fn main() {
rt.block_on(setpools(&args[2], &args[3], &args[4], &args[5]))
}
Some("msgs") if args.len() == 3 => rt.block_on(msgs(&args[2])),
Some("tune") if args.len() == 3 => rt.block_on(tune(&args[2])),
Some("presets") if args.len() == 3 => rt.block_on(presets(&args[2])),
Some("setpreset") if args.len() == 4 => rt.block_on(setpreset(&args[2], &args[3])),
Some("settune") if args.len() == 5 && matches!(args[3].as_str(), "power" | "hashrate") => {
let value: f64 = args[4].parse().unwrap_or(-1.0);
if value <= 0.0 {
eprintln!("value must be a positive number");
std::process::exit(2);
}
rt.block_on(settune(&args[2], &args[3], value));
}
Some("timezone") if args.len() == 3 => rt.block_on(timezone(&args[2], None)),
Some("timezone") if args.len() == 4 => rt.block_on(timezone(&args[2], Some(&args[3]))),
Some("passwd") if args.len() == 4 => rt.block_on(passwd(&args[2], &args[3])),
@@ -479,6 +749,8 @@ fn main() {
\x20 scan <cidr> [<cidr>...] discover + telemetry (TSV)\n\
\x20 hashrate <cidr> [<cidr>...] raw hashrate/algo dump\n\
\x20 msgs <ip> structured faults + per-board data\n\
\x20 tune <ip> structured-tuning support + capability envelope\n\
\x20 presets <ip> list selectable firmware profiles/presets\n\
\n\
WRITE (MUTATES the miner -- use the test-bed miners, not production):\n\
\x20 light <ip> <on|off> set the locate light\n\
@@ -487,6 +759,8 @@ fn main() {
\x20 resume <ip> resume mining\n\
\x20 restart <ip> restart/reboot\n\
\x20 setpl <ip> <watts> set power limit\n\
\x20 settune <ip> <power|hashrate> <v> set a structured tuning target (prints prior)\n\
\x20 setpreset <ip> <name> select a named firmware profile/preset (prints prior)\n\
\x20 setpools <ip> <url> <user> <pass> set the default pool group\n\
\x20 timezone <ip> [<IANA>] read (no arg) or set the timezone\n\
\x20 passwd <ip> <newpass> change the web/API password (DANGEROUS)\n\
+121 -56
View File
@@ -6,11 +6,11 @@
//! firmware registry, so `scan`'s callers never have to think about it.
use std::collections::HashMap;
use std::io::Write;
use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
use asic_rs::MinerFactory;
use alkane_core::platform::write_private;
use asic_rs::core::traits::miner::MinerAuth;
use asic_rs::MinerFactory;
use crate::scan::config_path;
@@ -40,20 +40,9 @@ fn save_creds_file(file: &str, user: &str, pass: &str) -> std::io::Result<()> {
if let Some(dir) = p.parent() {
std::fs::create_dir_all(dir)?;
}
// Open (and create) with mode 0600 up front so a freshly created file is
// never world/group-readable, even for the instant before the write. For a
// pre-existing file the create mode is ignored, so also tighten it to 0600
// while it is still empty (post-truncate, pre-write) -- the plaintext is
// never on disk under a looser mode.
let mut f = std::fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.mode(0o600)
.open(&p)?;
f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
f.write_all(format!("{user}\n{pass}\n").as_bytes())?;
Ok(())
// Owner-only from creation on (0600 on Unix, re-tightened if the file
// already existed): the plaintext is never on disk under a looser mode.
write_private(&p, format!("{user}\n{pass}\n").as_bytes())
}
fn clear_creds_file(file: &str) -> std::io::Result<()> {
@@ -80,13 +69,26 @@ pub fn load_ssh_credentials() -> Option<(String, String)> {
load_creds_file(SSH_CREDENTIALS_FILE)
}
/// Save the SSH username/password (0600). Retained for a future SSH-login dialog
/// now that the SSH PIC probe that used to save it has been removed (round 14 #5).
#[allow(dead_code)]
/// Save the SSH username/password (0600), from the Credentials dialog.
pub fn save_ssh_credentials(user: &str, pass: &str) -> std::io::Result<()> {
save_creds_file(SSH_CREDENTIALS_FILE, user, pass)
}
/// Remove the saved SSH login, if any. Not an error if none was saved.
pub fn clear_ssh_credentials() -> std::io::Result<()> {
clear_creds_file(SSH_CREDENTIALS_FILE)
}
/// The SSH username to use: the saved one, or `root` (the control-board login
/// on every firmware the restore flow drives over SSH) when none was entered.
pub fn ssh_user_or_default(user: &str) -> String {
if user.trim().is_empty() {
"root".to_string()
} else {
user.trim().to_string()
}
}
/// Remove the saved web/API credentials, if any. Not an error if none were saved.
pub fn clear_credentials() -> std::io::Result<()> {
match clear_creds_file(CREDENTIALS_FILE) {
@@ -164,20 +166,14 @@ pub fn save_firmware_credentials(map: &HashMap<String, (String, String)>) -> std
if let Some(dir) = p.parent() {
std::fs::create_dir_all(dir)?;
}
let mut f = std::fs::OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.mode(0o600)
.open(&p)?;
f.set_permissions(std::fs::Permissions::from_mode(0o600))?;
let mut names: Vec<&String> = map.keys().collect();
names.sort();
let mut body = String::new();
for name in names {
let (user, pass) = &map[name];
f.write_all(format!("{name}\t{user}\t{pass}\n").as_bytes())?;
body.push_str(&format!("{name}\t{user}\t{pass}\n"));
}
Ok(())
write_private(&p, body.as_bytes())
}
/// Remove the per-firmware overrides file, if any. Not an error if none exists.
@@ -191,7 +187,12 @@ pub fn clear_firmware_credentials() -> std::io::Result<()> {
/// otherwise the backend falls back to its own default auth. With nothing saved
/// this is plain `MinerFactory::new()`.
pub fn configured_factory() -> MinerFactory {
let mut factory = MinerFactory::new();
// Apply the operator's configured identification timeout to every factory
// (round 18 #12: config actions / refresh / pools / flash previously used
// asic-rs's 10s default, so on a slow link they could fail to reach miners a
// longer-timeout scan had found). start_scan may still override it explicitly.
let mut factory = MinerFactory::new()
.with_identification_timeout_secs(crate::scan::load_scan_timeout().max(1));
let global = load_credentials();
let per_fw = load_firmware_credentials();
if global.is_none() && per_fw.is_empty() {
@@ -213,24 +214,47 @@ pub fn configured_factory() -> MinerFactory {
mod tests {
use super::*;
/// Unix: the file is mode 0600. Windows relies on the profile directory's
/// owner-only ACL (see `alkane_core::platform::write_private`), so only
/// existence is checked there.
fn assert_owner_only(path: &std::path::Path, why: &str) {
let meta = std::fs::metadata(path).unwrap();
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
assert_eq!(meta.permissions().mode() & 0o777, 0o600, "{why}");
}
#[cfg(not(unix))]
assert!(meta.is_file(), "{why}");
}
#[test]
fn credentials_round_trip_and_file_perms() {
// config_path() reads $HOME; point it at a private temp dir. HOME is
// process-global, so this stays one test and restores HOME afterward
// (matching the pattern used by scan::tests::auto_secs_round_trip_and_defaults).
let prev = std::env::var_os("HOME");
// process-global, so serialise against other HOME-mutating tests via the
// shared lock and restore HOME afterward (round 18 #12).
let _home = crate::model::HOME_TEST_LOCK
.lock()
.unwrap_or_else(|e| e.into_inner());
let root_var = alkane_core::platform::CONFIG_ROOT_VAR;
let prev = std::env::var_os(root_var);
let dir = std::env::temp_dir().join(format!("alkane-cred-test-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
std::env::set_var("HOME", &dir);
std::env::set_var(root_var, &dir);
assert_eq!(load_credentials(), None, "no file -> None");
save_credentials("admin", "hunter2").unwrap();
assert_eq!(load_credentials(), Some(("admin".to_string(), "hunter2".to_string())));
assert_eq!(
load_credentials(),
Some(("admin".to_string(), "hunter2".to_string()))
);
let meta = std::fs::metadata(config_path(CREDENTIALS_FILE)).unwrap();
assert_eq!(meta.permissions().mode() & 0o777, 0o600, "credentials file must be 0600");
assert_owner_only(
&config_path(CREDENTIALS_FILE),
"credentials file must be 0600",
);
// configured_factory() must construct in both branches without panicking:
// with saved credentials (fans auth across every firmware backend) ...
@@ -240,15 +264,20 @@ mod tests {
// 0600 by save_credentials (the create-mode is ignored for an existing
// file, so the explicit set_permissions is what protects it).
let path = config_path(CREDENTIALS_FILE);
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o644)).unwrap();
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o644)).unwrap();
}
save_credentials("admin2", "s3cr3t").unwrap();
let meta = std::fs::metadata(&path).unwrap();
assert_owner_only(
&path,
"save over a pre-existing 0644 file must re-tighten to 0600",
);
assert_eq!(
meta.permissions().mode() & 0o777,
0o600,
"save over a pre-existing 0644 file must re-tighten to 0600"
load_credentials(),
Some(("admin2".to_string(), "s3cr3t".to_string()))
);
assert_eq!(load_credentials(), Some(("admin2".to_string(), "s3cr3t".to_string())));
clear_credentials().unwrap();
// ... and with no saved credentials (plain MinerFactory::new()).
@@ -256,38 +285,74 @@ mod tests {
assert_eq!(load_credentials(), None, "cleared -> None");
clear_credentials().unwrap(); // idempotent: clearing an already-clear store is not an error
// SSH login: separate file, same 0600 rule, clear is idempotent.
assert_eq!(load_ssh_credentials(), None, "no SSH file -> None");
save_ssh_credentials("root", "ssh-pass").unwrap();
assert_owner_only(
&config_path(SSH_CREDENTIALS_FILE),
"SSH creds file must be 0600",
);
assert_eq!(
load_ssh_credentials(),
Some(("root".to_string(), "ssh-pass".to_string()))
);
assert_eq!(
load_credentials(),
None,
"SSH save leaves the web login alone"
);
clear_ssh_credentials().unwrap();
assert_eq!(load_ssh_credentials(), None, "cleared -> None");
clear_ssh_credentials().unwrap();
assert_eq!(ssh_user_or_default(""), "root");
assert_eq!(ssh_user_or_default(" admin "), "admin");
// Per-firmware overrides (round 12 #13). Kept in this same test because
// HOME is process-global: a second #[test] mutating it would race under
// cargo's default parallel runner.
assert!(load_firmware_credentials().is_empty(), "no file -> empty map");
assert!(
load_firmware_credentials().is_empty(),
"no file -> empty map"
);
let mut fw = HashMap::new();
fw.insert("WhatsMiner Stock".to_string(), ("super".to_string(), "sup3r".to_string()));
fw.insert(
"WhatsMiner Stock".to_string(),
("super".to_string(), "sup3r".to_string()),
);
fw.insert("VNish".to_string(), ("".to_string(), "hunter2".to_string()));
save_firmware_credentials(&fw).unwrap();
// 0600, and it round-trips (an empty username survives the tab format).
let fwpath = config_path(FIRMWARE_CREDENTIALS_FILE);
assert_eq!(
std::fs::metadata(&fwpath).unwrap().permissions().mode() & 0o777,
0o600,
"per-firmware creds file must be 0600"
);
assert_owner_only(&fwpath, "per-firmware creds file must be 0600");
let back = load_firmware_credentials();
assert_eq!(back.get("WhatsMiner Stock"), Some(&("super".into(), "sup3r".into())));
assert_eq!(
back.get("WhatsMiner Stock"),
Some(&("super".into(), "sup3r".into()))
);
assert_eq!(back.get("VNish"), Some(&("".into(), "hunter2".into())));
assert_eq!(back.len(), 2);
// Shipped-default lookup: known firmware resolves, unknown blanks.
assert_eq!(firmware_default_for("AntMiner Stock"), ("root".into(), "root".into()));
assert_eq!(firmware_default_for("nonexistent"), (String::new(), String::new()));
assert_eq!(
firmware_default_for("AntMiner Stock"),
("root".into(), "root".into())
);
assert_eq!(
firmware_default_for("nonexistent"),
(String::new(), String::new())
);
// Overrides + no global still builds a factory.
let _ = configured_factory();
// Saving an empty map clears the file (no stale overrides linger).
save_firmware_credentials(&HashMap::new()).unwrap();
assert!(load_firmware_credentials().is_empty(), "empty save -> cleared");
assert!(
load_firmware_credentials().is_empty(),
"empty save -> cleared"
);
clear_firmware_credentials().unwrap(); // idempotent
match prev {
Some(v) => std::env::set_var("HOME", v),
None => std::env::remove_var("HOME"),
Some(v) => std::env::set_var(root_var, v),
None => std::env::remove_var(root_var),
}
let _ = std::fs::remove_dir_all(&dir);
}
+144 -28
View File
@@ -9,13 +9,43 @@
use crate::model::{BoardHealth, MinerRow};
/// Escape one CSV field: quote it when it contains a comma, quote, CR or LF, and
/// double any embedded quotes.
/// A compact UTC timestamp "YYYYMMDD-HHMMSS" for a default export filename
/// (round 19 #5). UTC keeps this dependency-free (no chrono) and unambiguous.
pub fn timestamp_utc() -> String {
let secs = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_secs())
.unwrap_or(0);
let sod = secs % 86_400;
let (h, mi, s) = (sod / 3600, (sod % 3600) / 60, sod % 60);
// Civil date from days since 1970-01-01 (Howard Hinnant's civil_from_days).
let z = (secs / 86_400) as i64 + 719_468;
let era = if z >= 0 { z } else { z - 146_096 } / 146_097;
let doe = z - era * 146_097; // [0, 146096]
let yoe = (doe - doe / 1460 + doe / 36_524 - doe / 146_096) / 365; // [0, 399]
let doy = doe - (365 * yoe + yoe / 4 - yoe / 100); // [0, 365]
let mp = (5 * doy + 2) / 153; // [0, 11]
let d = doy - (153 * mp + 2) / 5 + 1; // [1, 31]
let m = if mp < 10 { mp + 3 } else { mp - 9 }; // [1, 12]
let y = yoe + era * 400 + i64::from(m <= 2);
format!("{y:04}{m:02}{d:02}-{h:02}{mi:02}{s:02}")
}
/// Escape one CSV field: neutralise spreadsheet formula injection, then quote it
/// when it contains a comma, quote, CR or LF (doubling any embedded quotes).
///
/// Miner-supplied fields (hostname, worker, serial, ...) can start with a formula
/// trigger; prefixing a single quote makes Excel/Sheets treat the cell as text so
/// opening the export can't execute an injected formula (round 18 #12).
fn esc(s: &str) -> String {
if s.contains([',', '"', '\n', '\r']) {
format!("\"{}\"", s.replace('"', "\"\""))
let mut val = s.to_string();
if val.starts_with(['=', '+', '-', '@', '\t', '\r']) {
val.insert(0, '\'');
}
if val.contains([',', '"', '\n', '\r']) {
format!("\"{}\"", val.replace('"', "\"\""))
} else {
s.to_string()
val
}
}
@@ -70,41 +100,116 @@ fn scalar_columns() -> Vec<Col> {
("slow", |r| r.slow.to_string()),
("paused", |r| r.paused.to_string()),
("pic", |r| opt_bool(r.pic_present, "PIC", "noPIC")),
("write_locked", |r| opt_bool(r.write_locked, "locked", "unlocked")),
("light_flashing", |r| opt_bool(r.light_flashing, "on", "off")),
("write_locked", |r| {
opt_bool(r.write_locked, "locked", "unlocked")
}),
("light_flashing", |r| {
opt_bool(r.light_flashing, "on", "off")
}),
("hashrate_ths", |r| num(r.hashrate_ths)),
("expected_ths", |r| num(r.expected_ths)),
("efficiency_j_th", |r| num(r.efficiency)),
("power_w", |r| num(r.power_w)),
("tuning_percent", |r| r.tuning_percent.map(|v| v.to_string()).unwrap_or_default()),
("tuning_percent", |r| {
r.tuning_percent.map(|v| v.to_string()).unwrap_or_default()
}),
("chip_temp_c", |r| num(r.chip_temp_c)),
("fluid_temp_c", |r| num(r.fluid_temp_c)),
("env_temp_c", |r| num(r.env_temp_c)),
("outlet_temp_c", |r| num(r.outlet_temp_c)),
("psu_fan_rpm", |r| num(r.psu_fan_rpm)),
("fan_count", |r| r.fan_count.map(|v| v.to_string()).unwrap_or_default()),
("expected_fans", |r| r.expected_fans.map(|v| v.to_string()).unwrap_or_default()),
("total_chips", |r| r.total_chips.map(|v| v.to_string()).unwrap_or_default()),
("expected_chips", |r| r.expected_chips.map(|v| v.to_string()).unwrap_or_default()),
("hashboards", |r| r.hashboards.map(|v| v.to_string()).unwrap_or_default()),
("expected_hashboards", |r| r.expected_hashboards.map(|v| v.to_string()).unwrap_or_default()),
("uptime_secs", |r| if r.uptime_secs > 0 { r.uptime_secs.to_string() } else { String::new() }),
("fan_count", |r| {
r.fan_count.map(|v| v.to_string()).unwrap_or_default()
}),
("expected_fans", |r| {
r.expected_fans.map(|v| v.to_string()).unwrap_or_default()
}),
("total_chips", |r| {
r.total_chips.map(|v| v.to_string()).unwrap_or_default()
}),
("expected_chips", |r| {
r.expected_chips.map(|v| v.to_string()).unwrap_or_default()
}),
("hashboards", |r| {
r.hashboards.map(|v| v.to_string()).unwrap_or_default()
}),
("expected_hashboards", |r| {
r.expected_hashboards
.map(|v| v.to_string())
.unwrap_or_default()
}),
("uptime_secs", |r| {
if r.uptime_secs > 0 {
r.uptime_secs.to_string()
} else {
String::new()
}
}),
("best_share", |r| r.best_share.map(num).unwrap_or_default()),
("session_best_share", |r| r.session_best_share.map(num).unwrap_or_default()),
("pool_account", |r| r.worker.split_once('.').map(|(a, _)| a).unwrap_or(&r.worker).to_string()),
("session_best_share", |r| {
r.session_best_share.map(num).unwrap_or_default()
}),
("pool_account", |r| {
r.worker
.split_once('.')
.map(|(a, _)| a)
.unwrap_or(&r.worker)
.to_string()
}),
("pool_url", |r| r.pool_url.clone()),
("errors", |r| r.errors.join("; ")),
]
}
/// Build the full CSV for `rows`. Empty rows still emit a header line.
pub fn rows_to_csv(rows: &[MinerRow]) -> String {
let cols = scalar_columns();
// Widest variable-length fields across the set.
let max_board_temps = rows.iter().map(|r| r.board_temps.len()).max().unwrap_or(0);
let max_fans = rows.iter().map(|r| r.fan_rpms.len()).max().unwrap_or(0);
let max_boards = rows.iter().map(|r| r.board_status.len()).max().unwrap_or(0);
let max_pools = rows.iter().map(|r| r.pools.len()).max().unwrap_or(0);
// Group keys for the four variable-length field families (each expands to
// per-index columns). Shown as single checkboxes in the export picker (round 19 #6).
pub const GROUP_BOARD_TEMPS: &str = "board temps";
pub const GROUP_FANS: &str = "fan rpms";
pub const GROUP_BOARD_STATUS: &str = "board status";
pub const GROUP_POOLS: &str = "pools";
/// Every selectable export field, in output order: each scalar column header,
/// then the four variable-length group keys.
pub fn export_field_names() -> Vec<String> {
let mut v: Vec<String> = scalar_columns()
.iter()
.map(|(h, _)| (*h).to_string())
.collect();
v.push(GROUP_BOARD_TEMPS.to_string());
v.push(GROUP_FANS.to_string());
v.push(GROUP_BOARD_STATUS.to_string());
v.push(GROUP_POOLS.to_string());
v
}
/// Build the CSV for `rows` including only the selected fields (scalar column
/// headers and/or the group keys above), in the fixed output order (round 19 #6).
/// Empty rows still emit a header line.
pub fn rows_to_csv_selected(
rows: &[MinerRow],
selected: &std::collections::HashSet<String>,
) -> String {
let cols: Vec<Col> = scalar_columns()
.into_iter()
.filter(|(h, _)| selected.contains(*h))
.collect();
// A group's columns appear only when it is selected; an unselected group's
// width stays 0, so the header/value loops below emit nothing for it.
let width = |want: bool, f: &dyn Fn(&MinerRow) -> usize| -> usize {
if want {
rows.iter().map(f).max().unwrap_or(0)
} else {
0
}
};
let max_board_temps = width(selected.contains(GROUP_BOARD_TEMPS), &|r| {
r.board_temps.len()
});
let max_fans = width(selected.contains(GROUP_FANS), &|r| r.fan_rpms.len());
let max_boards = width(selected.contains(GROUP_BOARD_STATUS), &|r| {
r.board_status.len()
});
let max_pools = width(selected.contains(GROUP_POOLS), &|r| r.pools.len());
// Header.
let mut headers: Vec<String> = cols.iter().map(|(h, _)| (*h).to_string()).collect();
@@ -135,7 +240,13 @@ pub fn rows_to_csv(rows: &[MinerRow]) -> String {
vals.push(r.fan_rpms.get(i).map(|&t| num(t)).unwrap_or_default());
}
for i in 0..max_boards {
vals.push(r.board_status.get(i).map(board_health_str).unwrap_or("").to_string());
vals.push(
r.board_status
.get(i)
.map(board_health_str)
.unwrap_or("")
.to_string(),
);
}
for i in 0..max_pools {
let (u, w) = r.pools.get(i).cloned().unwrap_or_default();
@@ -164,9 +275,14 @@ mod tests {
fan_rpms: vec![6000.0, 6100.0],
..Default::default()
},
MinerRow { ip: "10.0.0.2".into(), model: "M30S".into(), ..Default::default() },
MinerRow {
ip: "10.0.0.2".into(),
model: "M30S".into(),
..Default::default()
},
];
let csv = rows_to_csv(&rows);
let all: std::collections::HashSet<String> = export_field_names().into_iter().collect();
let csv = rows_to_csv_selected(&rows, &all);
let lines: Vec<&str> = csv.lines().collect();
assert_eq!(lines.len(), 3, "header + 2 rows");
assert!(lines[0].starts_with("ip,model,brand,"));
+251 -44
View File
@@ -1,6 +1,6 @@
//! Bench-fleet fixtures: the expected hardware output of the 9 boards on
//! 10.255.1.0/24 (see ../../../HANDOFF.md section 7 and the parent project's
//! [removed]). These are the reference values the workflow tests compare
//! Fixture fleet: the expected hardware output of nine representative miners
//! (one per control-board family / firmware). These are the reference values
//! the workflow tests compare
//! the application's actual output against, and the rows the offline
//! `ALKANE_FAKE_SCAN` demo mode renders. Only miners that respond become rows,
//! so there is no synthetic "offline" fixture.
@@ -42,9 +42,22 @@ impl Board {
let slow = is_slow(self.mining, self.hashrate, self.expected);
// A few extra metrics so the demo/offline mode shows non-empty values
// for some of the additional columns.
let last_octet: u8 = self.ip.rsplit('.').next().and_then(|s| s.parse().ok()).unwrap_or(0);
let last_octet: u8 = self
.ip
.rsplit('.')
.next()
.and_then(|s| s.parse().ok())
.unwrap_or(0);
let (boards, chips, efficiency) = if self.mining {
(Some(3u32), Some(210u32), if self.hashrate > 0.0 { self.power / self.hashrate } else { 0.0 })
(
Some(3u32),
Some(210u32),
if self.hashrate > 0.0 {
self.power / self.hashrate
} else {
0.0
},
)
} else {
(None, None, 0.0)
};
@@ -60,6 +73,23 @@ impl Board {
} else {
vec![]
};
// Per-board hashrate for the R2 Health tooltip demo: split the total three
// ways with a little variety (index-aligned with the 3 boards).
let board_hashrates = if self.mining && self.hashrate > 0.0 {
vec![
self.hashrate * 0.34,
self.hashrate * 0.35,
self.hashrate * 0.31,
]
} else {
vec![]
};
// Per-board configured frequency/voltage for the G7 read-side tooltip demo.
let (board_frequencies, board_voltages) = if self.mining {
(vec![590.0, 590.0, 565.0], vec![13.50, 13.50, 13.35])
} else {
(vec![], vec![])
};
// Air-cooled WhatsMiners report an ambient reading (asic-rs surfaces it in
// its fluid_temperature field); the scan routes it to env_temp for
// air-cooled models, so the demo mirrors that (round 11 #17).
@@ -79,6 +109,11 @@ impl Board {
"10.255.1.166" => vec![Ok, Ok, Missing],
_ => vec![Ok, Ok, Ok],
}
} else if self.paused {
// A paused miner's boards are physically present but idle (asic-rs
// reports active=false -> Fault), so the Health column shows them blue
// rather than red (round 19 #19); the offline demo mirrors that.
vec![Fault, Fault, Fault]
} else {
vec![]
};
@@ -97,6 +132,8 @@ impl Board {
let control_board = crate::naming::control_board_code(self.make, self.board, &model);
let cpu = crate::naming::control_board_cpu(self.make, self.board, &model);
let board_code = crate::naming::control_board_board(self.make, self.board, &model);
// Computed before `model` is moved into the struct literal below.
let pic_present = crate::scan::infer_pic(&model);
MinerRow {
ip: self.ip.to_string(),
selected: false,
@@ -108,7 +145,14 @@ impl Board {
cpu,
board_code,
hashrate_ths: self.hashrate,
// A miner that is mining or paused reported a current hashrate (a paused
// one reports 0 -> "0.00T"); the blank stock demo miner reports none, so
// it keeps the "-" dash (round 19 follow-up).
hashrate_known: self.mining || self.paused,
expected_ths: self.expected,
board_hashrates,
board_voltages,
board_frequencies,
efficiency,
power_w: self.power,
chip_temp_c: self.temp,
@@ -120,24 +164,52 @@ impl Board {
slow,
paused: self.paused,
// offline defaults to false (online); these bench rows are reachable.
mac: format!("AA:BB:CC:00:{:02X}:{last_octet:02X}", last_octet.wrapping_mul(3)),
mac: format!(
"AA:BB:CC:00:{:02X}:{last_octet:02X}",
last_octet.wrapping_mul(3)
),
hostname: format!("miner-{last_octet}"),
hashboards: boards,
expected_hashboards: Some(3),
board_status,
total_chips: chips,
psu_fan_rpm: if self.mining { self.fan * 0.9 } else { 0.0 },
uptime_secs: if self.mining { 3600 * 24 * 2 + 3600 * 5 } else { 0 },
// PSU info demo (round 17 R5): mining units show a version + rated
// envelope + live output, so the columns and the R2 PSU tooltip render.
psu_version: if self.mining {
"22 (117)".to_string()
} else {
String::new()
},
psu_voltage_min_v: self.mining.then_some(11.88),
psu_voltage_max_v: self.mining.then_some(15.18),
psu_out_voltage_v: self.mining.then_some(13.2),
psu_out_current_a: self.mining.then_some(210.0),
uptime_secs: if self.mining {
3600 * 24 * 2 + 3600 * 5
} else {
0
},
// One unit is "being located" so the Light column's yellow dot is
// demonstrable offline (round 11 #10).
light_flashing: Some(self.ip == "10.255.1.167"),
pool_url: if self.worker.is_empty() { String::new() } else { "stratum+tcp://pool.blueflare:3333".to_string() },
pool_url: if self.worker.is_empty() {
String::new()
} else {
"stratum+tcp://pool.blueflare:3333".to_string()
},
pools: if self.worker.is_empty() {
Vec::new()
} else {
vec![
("stratum+tcp://pool.blueflare:3333".to_string(), self.worker.to_string()),
("stratum+tcp://backup.blueflare:3333".to_string(), format!("{}_bak", self.worker)),
(
"stratum+tcp://pool.blueflare:3333".to_string(),
self.worker.to_string(),
),
(
"stratum+tcp://backup.blueflare:3333".to_string(),
format!("{}_bak", self.worker),
),
]
},
operating_state: if self.paused {
@@ -157,6 +229,8 @@ impl Board {
resume: self.mining,
power_limit: self.mining,
tuning: self.mining,
hashrate_target: self.mining,
supports_presets: self.mining,
firmware_flash,
pools: true,
timezone: self.mining,
@@ -167,13 +241,9 @@ impl Board {
// show variety offline). control_board is derived above via naming.
algorithm: "SHA256".to_string(),
control_board,
pic_present: if self.model_id.contains("S21") {
Some(false) // noPIC example
} else if self.make.eq_ignore_ascii_case("antminer") {
Some(true)
} else {
None // WhatsMiner: unknown over the network
},
// Use the same PIC inference the live scan uses (round 18 #12: the demo
// previously reimplemented a simplified version that disagreed with it).
pic_present,
// Access: idle/view-only units (no worker) shown locked; the rest
// unlocked. (Live rows infer this from control capabilities.)
write_locked: Some(self.worker.is_empty()),
@@ -187,6 +257,26 @@ impl Board {
} else {
Vec::new()
},
// Demo firmware presets (round 18 / G3) so the "Set profile..." dialog
// is exercisable offline on units that advertise preset support.
presets: if self.mining {
vec![
crate::model::MinerPreset {
name: "default".into(),
pretty: Some("2794 W ~ 121.8 TH @ 590 MHz".into()),
},
crate::model::MinerPreset {
name: "540MHz".into(),
pretty: Some("2485 W ~ 111.5 TH @ 540 MHz".into()),
},
crate::model::MinerPreset {
name: "490MHz".into(),
pretty: Some("2192 W ~ 101.1 TH @ 490 MHz".into()),
},
]
} else {
Vec::new()
},
..Default::default()
}
}
@@ -204,35 +294,152 @@ pub fn bench_fleet() -> Vec<MinerRow> {
let boards = [
// firmware families span the palette (Stock/VNish/Braiins/LuxOS/ePIC/
// Hive/BixBit/Alkane) so the offline demo shows the Firmware colouring.
Board { ip: "10.255.1.112", make: "Antminer", model_id: "S17", board: "Xilinx", firmware: "Stock", fw_version: "",
hashrate: 0.0, expected: 0.0, power: 0.0, temp: 0.0, fan: 0.0,
worker: "", mining: false, paused: false },
Board { ip: "10.255.1.166", make: "Antminer", model_id: "S19", board: "BeagleBoneBlack", firmware: "VNish", fw_version: "1.2.8",
hashrate: 95.0, expected: 96.0, power: 3250.0, temp: 65.0, fan: 4200.0,
worker: "blueflare.s19", mining: true, paused: false },
Board { ip: "10.255.1.152", make: "Antminer", model_id: "S19jPro", board: "AMLogic", firmware: "Braiins", fw_version: "25.05.1",
hashrate: 100.0, expected: 104.0, power: 3100.0, temp: 62.0, fan: 3900.0,
worker: "blueflare.s19jpro", mining: true, paused: false },
Board { ip: "10.255.1.167", make: "Antminer", model_id: "S19KPro", board: "AMLogic", firmware: "LuxOS", fw_version: "2024.9.0",
hashrate: 120.0, expected: 128.0, power: 3300.0, temp: 68.0, fan: 4500.0,
worker: "blueflare.s19kpro", mining: true, paused: false },
Board { ip: "10.255.1.149", make: "Antminer", model_id: "S21Pro", board: "CVITek", firmware: "ePIC", fw_version: "1.0.3",
hashrate: 60.0, expected: 200.0, power: 1500.0, temp: 55.0, fan: 3000.0,
worker: "blueflare.s21pro", mining: true, paused: false }, // slow: 60/200 = 30%
Board { ip: "10.255.1.126", make: "Whatsminer", model_id: "M30SVE40", board: "H3", firmware: "Stock", fw_version: "H3.0.1",
hashrate: 92.0, expected: 96.0, power: 3400.0, temp: 70.0, fan: 4800.0,
worker: "blueflare.h3", mining: true, paused: false },
Board { ip: "10.255.1.131", make: "Whatsminer", model_id: "M30SPlusVE40", board: "H616", firmware: "Hive", fw_version: "1.0",
hashrate: 100.0, expected: 100.0, power: 3450.0, temp: 71.0, fan: 4900.0,
worker: "blueflare.h616", mining: true, paused: false },
Board { ip: "10.255.1.148", make: "Whatsminer", model_id: "M50VH50", board: "H6", firmware: "BixBit", fw_version: "2.1",
hashrate: 118.0, expected: 122.0, power: 3300.0, temp: 66.0, fan: 4600.0,
worker: "blueflare.m50", mining: true, paused: false },
Board {
ip: "10.255.1.112",
make: "Antminer",
model_id: "S17",
board: "Xilinx",
firmware: "Stock",
fw_version: "",
hashrate: 0.0,
expected: 0.0,
power: 0.0,
temp: 0.0,
fan: 0.0,
worker: "",
mining: false,
paused: false,
},
Board {
ip: "10.255.1.166",
make: "Antminer",
model_id: "S19",
board: "BeagleBoneBlack",
firmware: "VNish",
fw_version: "1.2.8",
hashrate: 95.0,
expected: 96.0,
power: 3250.0,
temp: 65.0,
fan: 4200.0,
worker: "blueflare.s19",
mining: true,
paused: false,
},
Board {
ip: "10.255.1.152",
make: "Antminer",
model_id: "S19jPro",
board: "AMLogic",
firmware: "Braiins",
fw_version: "25.05.1",
hashrate: 100.0,
expected: 104.0,
power: 3100.0,
temp: 62.0,
fan: 3900.0,
worker: "blueflare.s19jpro",
mining: true,
paused: false,
},
Board {
ip: "10.255.1.167",
make: "Antminer",
model_id: "S19KPro",
board: "AMLogic",
firmware: "LuxOS",
fw_version: "2024.9.0",
hashrate: 120.0,
expected: 128.0,
power: 3300.0,
temp: 68.0,
fan: 4500.0,
worker: "blueflare.s19kpro",
mining: true,
paused: false,
},
Board {
ip: "10.255.1.149",
make: "Antminer",
model_id: "S21Pro",
board: "CVITek",
firmware: "ePIC",
fw_version: "1.0.3",
hashrate: 60.0,
expected: 200.0,
power: 1500.0,
temp: 55.0,
fan: 3000.0,
worker: "blueflare.s21pro",
mining: true,
paused: false,
}, // slow: 60/200 = 30%
Board {
ip: "10.255.1.126",
make: "Whatsminer",
model_id: "M30SVE40",
board: "H3",
firmware: "Stock",
fw_version: "H3.0.1",
hashrate: 92.0,
expected: 96.0,
power: 3400.0,
temp: 70.0,
fan: 4800.0,
worker: "blueflare.h3",
mining: true,
paused: false,
},
Board {
ip: "10.255.1.131",
make: "Whatsminer",
model_id: "M30SPlusVE40",
board: "H616",
firmware: "Hiveon",
fw_version: "1.05",
hashrate: 100.0,
expected: 100.0,
power: 3450.0,
temp: 71.0,
fan: 4900.0,
worker: "blueflare.h616",
mining: true,
paused: false,
},
Board {
ip: "10.255.1.148",
make: "Whatsminer",
model_id: "M50VH50",
board: "H6",
firmware: "Bixbit",
fw_version: "0.9.9.4",
hashrate: 118.0,
expected: 122.0,
power: 3300.0,
temp: 66.0,
fan: 4600.0,
worker: "blueflare.m50",
mining: true,
paused: false,
},
// Rebucketed from idle/not-hashing to paused so the "paused"
// status/KPI bucket is exercisable in the fake-scan/offline demo.
Board { ip: "10.255.1.115", make: "Antminer", model_id: "S19", board: "BeagleBoneBlack", firmware: "Alkane", fw_version: "0.1",
hashrate: 0.0, expected: 0.0, power: 0.0, temp: 0.0, fan: 0.0,
worker: "", mining: false, paused: true },
Board {
ip: "10.255.1.115",
make: "Antminer",
model_id: "S19",
board: "BeagleBoneBlack",
firmware: "Alkane",
fw_version: "0.1",
hashrate: 0.0,
expected: 0.0,
power: 0.0,
temp: 0.0,
fan: 0.0,
worker: "",
mining: false,
paused: true,
},
];
boards.into_iter().map(Board::into_row).collect()
}
+2 -3
View File
@@ -27,7 +27,7 @@ impl Lang {
pub fn label(self) -> &'static str {
match self {
Lang::En => "English",
Lang::Zh => "\u{4e2d}\u{6587}", // 中文
Lang::Zh => "\u{4e2d}\u{6587}", // 中文
Lang::Ru => "\u{0420}\u{0443}\u{0441}\u{0441}\u{043a}\u{0438}\u{0439}", // Русский
Lang::Fr => "Fran\u{e7}ais",
Lang::Es => "Espa\u{f1}ol",
@@ -71,8 +71,7 @@ static CURRENT: AtomicU8 = AtomicU8::new(0);
const LANG_FILE: &str = "language.txt";
fn config_path() -> PathBuf {
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
PathBuf::from(home).join(".config/alkane-toolkit").join(LANG_FILE)
alkane_core::platform::config_path(LANG_FILE)
}
/// Load the saved language into the global (call once at startup).
+51 -225
View File
@@ -1,58 +1,48 @@
//! Fetch a miner's log over its firmware API and regex-scan it for useful
//! signals (round 12 #12). This is the "logs through API" path the operator
//! asked for: where a firmware exposes its log we can read board/PIC lines and
//! other metrics without SSH.
//! Fetch a miner's log for the "View log (API)" viewer (round 12 #12, reworked
//! round 19 #11-16).
//!
//! Per firmware:
//! - VNish (aftermarket Antminer): POST /api/v1/unlock to get a bearer token,
//! then GET /api/v1/logs/miner -- the full miner log (PSU init, per-chain
//! chip detection, tuning, errors).
//! - Stock Antminer: GET /cgi-bin/log.cgi behind digest auth (older models
//! such as the Z15 do not serve it -> reported as unavailable).
//! - WhatsMiner: the btminer log is not exposed on :4028, but get_error_code
//! (unauthenticated) returns the active fault codes, which we format as the
//! log view.
//! The log is fetched through asic-rs's per-backend `read_logs()` API, which
//! knows each firmware's real transport (Antminer/Z15 + BixBit stock web,
//! Braiins gRPC/journal, VNish and ePIC HTTP, ...). This replaced the GUI's
//! narrow three-way curl fetch, whose stock `/cgi-bin/log.cgi` `else` branch
//! failed on every firmware that does not serve that CGI (Braiins, LuxOS, Z15,
//! BixBit).
//!
//! We shell out to `curl` (already a dependency of the access probe) so the
//! offline/vendored build gains no new crate, and cap the fetched text so a huge
//! log never bloats the viewer.
//! WhatsMiner is the exception: its btminer log is not exposed over the API, and
//! asic-rs has no `read_logs` for it, so the viewer falls back to the active
//! fault codes (get_error_code on :4028, unauthenticated). LuxOS likewise has no
//! asic-rs log API and reports the log as unavailable.
use std::process::Command;
use std::time::Duration;
/// Cap on the log text we keep for display (bytes); the regex summary is still
/// computed over everything fetched.
/// Cap on the log text we keep for display (bytes); a miner's freshest lines are
/// at the tail, so we keep the tail.
const MAX_LOG_BYTES: usize = 256 * 1024;
/// A fetched log plus the signals a regex pass pulled out of it.
/// A fetched log for the viewer.
pub struct LogScan {
/// The (possibly tail-trimmed) log text for the viewer.
/// The (possibly tail-trimmed) log text.
pub text: String,
/// One-line-per-finding summary shown above the log.
pub summary: Vec<String>,
}
/// Fetch and scan one miner's log. `brand` is the make ("Antminer"/"Whatsminer"),
/// `firmware` the family ("VNish"/"Stock"/...). `vnish_pass`/`wm` creds are used
/// where that firmware needs auth. Returns `Err` only when no log could be read.
pub fn scan_log(
ip: &str,
brand: &str,
firmware: &str,
vnish_pass: &str,
antminer_user: &str,
antminer_pass: &str,
) -> Result<LogScan, String> {
let raw = if firmware.eq_ignore_ascii_case("vnish") {
fetch_vnish_log(ip, vnish_pass)?
} else if brand.eq_ignore_ascii_case("whatsminer") {
fetch_whatsminer_errors(ip)?
} else {
// Stock / other Antminer-family web firmware.
fetch_antminer_log(ip, antminer_user, antminer_pass)?
};
let summary = summarize_log(&raw);
Ok(LogScan { text: tail(&raw, MAX_LOG_BYTES), summary })
/// Fetch one miner's log. `brand` is the make ("Antminer"/"Whatsminer"/...);
/// `timeout_secs` is the per-miner identification timeout. Returns `Err` only
/// when no log could be read.
pub fn scan_log(ip: &str, brand: &str, timeout_secs: u64) -> Result<LogScan, String> {
// WhatsMiner's real log is not exposed over its API and asic-rs has no
// read_logs for it, so show the active fault codes instead of failing.
if brand.eq_ignore_ascii_case("whatsminer") {
let resp = crate::access_probe::whatsminer_get_error_code(ip)
.ok_or_else(|| "WhatsMiner did not answer get_error_code on :4028".to_string())?;
return Ok(LogScan {
text: tail(&resp, MAX_LOG_BYTES),
});
}
let text = crate::scan::fetch_log(ip, timeout_secs)?;
if text.trim().is_empty() {
return Err("the miner returned an empty log".to_string());
}
Ok(LogScan {
text: tail(&text, MAX_LOG_BYTES),
})
}
/// Keep the last `max` bytes of `s` (a log's tail is the freshest), on a line
@@ -61,8 +51,14 @@ fn tail(s: &str, max: usize) -> String {
if s.len() <= max {
return s.to_string();
}
let start = s.len() - max;
// advance to the next line boundary so we don't cut a line in half
// Nudge the cut forward to a UTF-8 char boundary first: a raw byte offset can
// land inside a multi-byte character and slicing there would panic (round 18
// #12; miner logs are not guaranteed pure ASCII).
let mut start = s.len() - max;
while start < s.len() && !s.is_char_boundary(start) {
start += 1;
}
// then advance to the next line boundary so we don't cut a line in half
let start = s[start..]
.find('\n')
.map(|i| start + i + 1)
@@ -70,188 +66,18 @@ fn tail(s: &str, max: usize) -> String {
format!("[... earlier log trimmed ...]\n{}", &s[start..])
}
/// Regex-free scan for the high-value signals in a miner log: PIC / hashboard
/// firmware lines, per-chain chip detection, and the most recent errors.
fn summarize_log(log: &str) -> Vec<String> {
let mut out = Vec::new();
let lc_has = |line: &str, needle: &str| line.to_ascii_lowercase().contains(needle);
// PIC / hashboard-controller status from the log. Aftermarket firmwares state
// it explicitly ("no-PIC miner"); stock boot logs print a PIC version. This
// is the log-regex PIC scan the operator asked for (round 12 #12).
let pic_lines: Vec<&str> = log.lines().filter(|l| lc_has(l, "pic")).collect();
if pic_lines.iter().any(|l| lc_has(l, "no-pic") || lc_has(l, "no pic")) {
out.push("PIC: not present (log reports a no-PIC miner)".to_string());
} else if let Some(l) = pic_lines
.iter()
.find(|l| lc_has(l, "version") || lc_has(l, "fw") || lc_has(l, "found"))
{
out.push(format!("PIC: present -- {}", l.trim()));
} else if !pic_lines.is_empty() {
out.push(format!("PIC: {} log line(s) mention PIC", pic_lines.len()));
for l in pic_lines.iter().take(3) {
out.push(format!(" {}", l.trim()));
}
} else {
out.push("PIC: no PIC lines in the log".to_string());
}
// Latest per-chain chip-detection line (the most recent board bring-up).
if let Some(l) = log.lines().rev().find(|l| lc_has(l, "chips detected")) {
out.push(format!("Chains: {}", l.trim()));
}
// Recent errors (log history, beyond asic-rs's current-message snapshot).
// Skip the get_error_code header line (it contains "error" but is not one).
let errors: Vec<&str> = log
.lines()
.rev()
.filter(|l| (lc_has(l, "error") || lc_has(l, "fail")) && !lc_has(l, "get_error_code"))
.take(3)
.collect();
if errors.is_empty() {
out.push("Errors: none in the log".to_string());
} else {
out.push(format!("Errors: {} recent", errors.len()));
for l in errors {
out.push(format!(" {}", l.trim()));
}
}
out
}
/// VNish: unlock -> bearer -> the full miner log.
fn fetch_vnish_log(ip: &str, pass: &str) -> Result<String, String> {
let unlock = curl(&[
"-s",
"--connect-timeout",
"5",
"--max-time",
"9",
"-X",
"POST",
"-H",
"Content-Type: application/json",
"-d",
&format!("{{\"pw\":\"{pass}\"}}"),
&format!("http://{ip}/api/v1/unlock"),
])?;
let token = serde_json::from_str::<serde_json::Value>(&unlock)
.ok()
.and_then(|v| v.get("token").and_then(|t| t.as_str()).map(str::to_string))
.filter(|t| !t.is_empty())
.ok_or_else(|| "VNish unlock rejected (check the VNish password in scan credentials)".to_string())?;
let log = curl(&[
"-s",
"--connect-timeout",
"5",
"--max-time",
"12",
"-H",
&format!("Authorization: Bearer {token}"),
&format!("http://{ip}/api/v1/logs/miner"),
])?;
if log.trim().is_empty() {
return Err("VNish returned an empty log".to_string());
}
Ok(log)
}
/// Stock Antminer web log (digest auth). Absent on older models (404).
fn fetch_antminer_log(ip: &str, user: &str, pass: &str) -> Result<String, String> {
let body = curl(&[
"-s",
"--digest",
"-u",
&format!("{user}:{pass}"),
"--connect-timeout",
"5",
"--max-time",
"12",
&format!("http://{ip}/cgi-bin/log.cgi"),
])?;
if body.contains("404 - Not Found") || body.trim().is_empty() {
return Err("this firmware does not expose a log over its web API".to_string());
}
Ok(body)
}
/// WhatsMiner: format the active error codes (get_error_code, unauthenticated).
fn fetch_whatsminer_errors(ip: &str) -> Result<String, String> {
let resp = crate::access_probe::whatsminer_get_error_code(ip)
.ok_or_else(|| "WhatsMiner did not answer get_error_code on :4028".to_string())?;
Ok(resp)
}
/// Run curl and return stdout, with a hard wall-clock cap. stdout is drained on a
/// separate thread so a large log (hundreds of KB) never deadlocks on a full pipe
/// -- the reason a naive "wait then read" times out on the VNish log.
fn curl(args: &[&str]) -> Result<String, String> {
use std::io::Read;
let mut cmd = Command::new("curl");
cmd.args(args);
cmd.stdout(std::process::Stdio::piped());
cmd.stderr(std::process::Stdio::null());
let mut child = cmd.spawn().map_err(|e| format!("spawn curl: {e}"))?;
let mut stdout = child.stdout.take().ok_or("no curl stdout")?;
let reader = std::thread::spawn(move || {
let mut buf = Vec::new();
let _ = stdout.read_to_end(&mut buf);
buf
});
let timeout = Duration::from_secs(20);
let start = std::time::Instant::now();
let mut timed_out = false;
loop {
match child.try_wait().map_err(|e| e.to_string())? {
Some(_) => break,
None => {
if start.elapsed() >= timeout {
let _ = child.kill();
timed_out = true;
break;
}
std::thread::sleep(Duration::from_millis(50));
}
}
}
let buf = reader.join().unwrap_or_default();
if timed_out && buf.is_empty() {
return Err("log fetch timed out".into());
}
Ok(String::from_utf8_lossy(&buf).into_owned())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn summarize_finds_pic_chains_and_errors() {
let log = "\
[t] INFO: Initializing PSU
[t] INFO: chain#1 - 126 chips detected
[t] INFO: check PIC on chain 1: version 0x03
[t] ERROR: Failed load miner config
[t] INFO: chain#2 - 126 chips detected";
let s = summarize_log(log);
assert!(s.iter().any(|l| l.contains("PIC: present")), "PIC present: {s:?}");
assert!(s.iter().any(|l| l.contains("chips detected")), "chains: {s:?}");
assert!(s.iter().any(|l| l.contains("Errors: 1")), "errors: {s:?}");
}
#[test]
fn summarize_detects_no_pic_miner() {
let log = "[t] ERROR: This is a no-PIC miner, so all connected chains ...\n[t] INFO: mining";
let s = summarize_log(log);
assert!(s.iter().any(|l| l.contains("PIC: not present")), "{s:?}");
}
#[test]
fn summarize_handles_no_pic_lines() {
let log = "[t] INFO: chain#1 - 126 chips detected\n[t] INFO: mining";
let s = summarize_log(log);
assert!(s.iter().any(|l| l.contains("no PIC lines")), "{s:?}");
fn tail_does_not_panic_mid_multibyte_char() {
// A byte-offset cut can land inside a multi-byte character; tail must nudge
// to a char boundary rather than panic (round 18 #12).
let s = "\u{00e9}".repeat(200); // 400 bytes of 2-byte chars, no newlines
let out = tail(&s, 101); // cut at an odd offset -> inside a char
assert!(out.starts_with("[... earlier log trimmed ...]"));
assert!(out.len() < s.len());
}
#[test]
+4 -1
View File
@@ -12,7 +12,10 @@ static LOG: Mutex<Vec<String>> = Mutex::new(Vec::new());
/// Local wall-clock HH:MM:SS for a log line. Uses the system clock offset from
/// UTC via the TZ-less epoch; good enough for an activity log timestamp.
fn stamp() -> String {
let secs = SystemTime::now().duration_since(UNIX_EPOCH).map(|d| d.as_secs()).unwrap_or(0);
let secs = SystemTime::now()
.duration_since(UNIX_EPOCH)
.map(|d| d.as_secs())
.unwrap_or(0);
let t = secs % 86_400;
format!("{:02}:{:02}:{:02}", t / 3600, (t % 3600) / 60, t % 60)
}
+59 -23
View File
@@ -1,13 +1,18 @@
//! alkane-toolkit — primary view (docs/UI-SPEC.md).
//! alkane-toolkit: primary view (docs/UI-SPEC.md).
//! Pure-Rust wxWidgets app on the vendored, patched wx-rs.
// A GUI application on Windows: no console window opens behind it. The
// headless modes below re-attach to the console they were started from.
#![cfg_attr(windows, windows_subsystem = "windows")]
mod access_probe;
mod askpass;
mod credentials;
mod export;
mod fixtures;
mod i18n;
mod logs;
mod log_scan;
mod logs;
mod model;
mod naming;
mod pool_prefs;
@@ -16,9 +21,16 @@ mod restore;
mod scan;
mod ui;
use wx_rs;
fn main() {
// ssh runs this executable as its askpass helper for password logins
// (askpass.rs); answer and exit before anything else starts.
if let Some(code) = askpass::serve_if_askpass() {
std::process::exit(code);
}
if headless_mode() {
attach_parent_console();
}
// Headless workflow self-test: render the bench-fleet fixtures through the
// real widgets and check the table + KPIs against the expected hardware
// output. Run under a virtual display (see scripts/ui-selftest.sh).
@@ -44,27 +56,17 @@ fn main() {
std::process::exit(0);
}
// Headless log-scan check: `ALKANE_LOG_SCAN="<ip> <brand> <firmware>"` fetches
// the miner's log over its firmware API and prints the regex summary (round
// 12 #12), so the VNish/Antminer/WhatsMiner log paths can be verified without
// the GUI.
// Headless log-scan check: `ALKANE_LOG_SCAN="<ip> <brand>"` fetches the miner's
// log through asic-rs's per-backend read_logs() (round 19 #11-16), so the log
// paths can be verified without the GUI. WhatsMiner falls back to fault codes.
if let Some(spec) = std::env::var_os("ALKANE_LOG_SCAN") {
let spec = spec.to_string_lossy();
let mut it = spec.split_whitespace();
let ip = it.next().unwrap_or("");
let brand = it.next().unwrap_or("");
let firmware = it.next().unwrap_or("");
let (au, ap) = credentials::load_credentials().unwrap_or_else(|| ("root".into(), "root".into()));
let vp = credentials::firmware_default_for("VNish").1;
let vp = if vp.is_empty() { "admin".to_string() } else { vp };
match log_scan::scan_log(ip, brand, firmware, &vp, &au, &ap) {
Ok(s) => {
println!("LOGSCAN {ip} ({brand}/{firmware}): {} log bytes", s.text.len());
for line in &s.summary {
println!(" {line}");
}
}
Err(e) => println!("LOGSCAN {ip} ({brand}/{firmware}): ERROR {e}"),
match log_scan::scan_log(ip, brand, scan::load_scan_timeout()) {
Ok(s) => println!("LOGSCAN {ip} ({brand}): {} log bytes", s.text.len()),
Err(e) => println!("LOGSCAN {ip} ({brand}): ERROR {e}"),
}
std::process::exit(0);
}
@@ -72,10 +74,10 @@ fn main() {
// Load the saved UI language before any strings are built (round 15 #13).
i18n::init();
// Bootstrap the wx app + main frame (upstream bridge).
// Bootstrap the wx app + main frame (upstream bridge). This also picks the
// light/dark appearance (system, or ALKANE_APPEARANCE=light|dark) before the
// frame exists, which wxMSW requires.
wx_rs::init_app("alkane-toolkit", 1280, 800);
// Follow the system light/dark appearance.
wx_rs::set_appearance_system();
// Build the UI-SPEC primary view into the frame.
let frame = wx_rs::Widget::main_frame();
@@ -104,3 +106,37 @@ fn run_selftest() -> i32 {
1
}
}
/// True when the process runs one of the headless check modes instead of the GUI.
fn headless_mode() -> bool {
["ALKANE_SELFTEST", "ALKANE_ACCESS_PROBE", "ALKANE_LOG_SCAN"]
.iter()
.any(|v| std::env::var_os(v).is_some())
}
/// A Windows GUI-subsystem process has no console, so output from the headless
/// modes would vanish when they are run from a terminal. Attach to the parent's
/// console in that case. Redirected output (pipes, files, CI) already has valid
/// standard handles and is left alone.
#[cfg(windows)]
fn attach_parent_console() {
type Handle = *mut core::ffi::c_void;
const STD_OUTPUT_HANDLE: u32 = -11i32 as u32;
const ATTACH_PARENT_PROCESS: u32 = u32::MAX;
#[link(name = "kernel32")]
extern "system" {
fn GetStdHandle(which: u32) -> Handle;
fn AttachConsole(process_id: u32) -> i32;
}
// SAFETY: plain Win32 calls with constant arguments; failure (no parent
// console, already attached) is harmless and leaves the process unchanged.
unsafe {
let out = GetStdHandle(STD_OUTPUT_HANDLE);
if out.is_null() || out as isize == -1 {
AttachConsole(ATTACH_PARENT_PROCESS);
}
}
}
#[cfg(not(windows))]
fn attach_parent_console() {}
File diff suppressed because it is too large Load Diff
+183 -22
View File
@@ -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()));
@@ -95,6 +99,44 @@ pub fn clean_model(make: &str, model_id: &str) -> String {
}
}
/// Best-effort ASIC chip model for a miner, used ONLY as a fallback when the
/// firmware did not report a chip type on the wire (round 21 #3). Most firmwares
/// on Antminer hardware (stock Antminer, VNish, LuxOS, Braiins, UMC) never put the
/// chip string in their API, but the chip is a fixed per-model hardware fact, so
/// it can be derived from the detected model. Only high-confidence, widely
/// documented Antminer mappings are returned; everything else (and WhatsMiner,
/// whose chips are not cleanly named) returns None so the column stays blank
/// rather than show a guess. `model_id` is the raw asic-rs model id.
pub fn chip_type_for_model(make: &str, model_id: &str) -> Option<&'static str> {
if !is_antminer(make) {
return None;
}
// Normalize: drop a leading "ANTMINER ", cut any trailing parenthetical
// ("S19 (88)" -> "S19"), uppercase, and strip every non-alphanumeric char.
let base = model_id.trim();
let base = base
.strip_prefix("ANTMINER ")
.or_else(|| base.strip_prefix("Antminer "))
.unwrap_or(base);
let base = base.split('(').next().unwrap_or(base);
let key: String = base
.chars()
.filter(|c| c.is_ascii_alphanumeric())
.map(|c| c.to_ascii_uppercase())
.collect();
// Bitmain chip per model (SHA-256 air/hydro). Sources: Bitmain shop specs +
// repair-guide chip markings. Keep conservative -- omit uncertain variants.
let chip = match key.as_str() {
"S19" | "S19PRO" | "S19A" | "S19APRO" | "T19" => "BM1398",
"S19PROPLUSHYD" | "S19PROPLUSHYDRO" | "S19PROHYD" | "S19PROHYDRO" => "BM1398",
"S19J" | "S19JPRO" | "S19JPROPLUS" | "S19JPRONOPIC" => "BM1362",
"S19XP" | "S19XPHYD" | "S19XPHYDRO" | "S19KPRO" | "S19KPRONOPIC" => "BM1366",
"S21" | "S21PRO" | "S21PLUS" | "S21HYD" | "S21HYDRO" | "T21" => "BM1370",
_ => return None,
};
Some(chip)
}
/// The Submodel column value. WhatsMiner: the version block ("VE40"). Antminer:
/// empty -- the hashboard type is not reported over the network by asic-rs.
pub fn submodel(make: &str, model_id: &str) -> String {
@@ -135,10 +177,13 @@ fn clean_antminer(id: &str) -> String {
// asic-rs "Unknown" models pass the raw vendor string through with the brand
// still in it (e.g. "ANTMINER S19 (88)", a NoPIC S19); drop a redundant
// leading brand word so the Model column never repeats the Brand column.
let id = if id.len() >= 9 && id[..9].eq_ignore_ascii_case("ANTMINER ") {
id[9..].trim_start()
} else {
id
// `get(..9)` returns None (rather than panicking) when byte 9 is not a UTF-8
// char boundary, so a multibyte miner-supplied model string can't crash here
// (round 18 #12). The prefix is 9 ASCII bytes, so a real match implies a
// boundary at 9 and the following `id[9..]` is safe.
let id = match id.get(..9) {
Some(p) if p.eq_ignore_ascii_case("ANTMINER ") => id[9..].trim_start(),
_ => id,
};
let bytes = id.as_bytes();
// Base = leading letters then digits ("S19", "KS5", "L3", "Z15"). Without a
@@ -189,7 +234,10 @@ fn clean_antminer(id: &str) -> String {
/// Normalise a raw control-board name for matching: drop spaces/punctuation and
/// uppercase, so "BeagleBone Black", "BeagleBoneBlack" and "BBB" all collapse.
fn compact_upper(s: &str) -> String {
s.chars().filter(|c| c.is_ascii_alphanumeric()).flat_map(|c| c.to_uppercase()).collect()
s.chars()
.filter(|c| c.is_ascii_alphanumeric())
.flat_map(|c| c.to_uppercase())
.collect()
}
/// The control-board short code for the Control-board column, e.g.
@@ -200,6 +248,7 @@ fn compact_upper(s: &str) -> String {
/// model era/class (best-effort, since the network data can't distinguish them):
/// - Xilinx: S17/T17-era -> C49, otherwise (S19-era) -> C55.
/// - AMLogic: XP-class / S19k (140mm fans) -> CBE, otherwise (120mm) -> C76.
///
/// `clean_model` is the already-cleaned model name (used for the era/class test).
pub fn control_board_code(make: &str, board_name: &str, clean_model: &str) -> String {
let (cpu, code) = control_board_split(make, board_name, clean_model);
@@ -283,14 +332,52 @@ fn is_s17_era(clean_model: &str) -> bool {
/// S19k Pro, and the S21 Pro; everything else AMLogic is the 120mm C76. asic-rs
/// cannot tell these apart, so this is a model-family heuristic, not a read.
fn is_aml_140mm(clean_model: &str) -> bool {
// Per the doc above: XP-class, the S19k Pro, and the S21 Pro -- NOT every S21
// (plain S21 / S21+ / S21e are the 120mm C76 board) (round 18 #12).
let m = clean_model.trim_start();
m.contains("XP") || m.starts_with("S19k") || m.starts_with("S21")
m.contains("XP") || m.starts_with("S19k") || m.contains("S21 Pro")
}
/// Nameplate expected hashrate in Sol/s for an Equihash (Zcash) miner model, when
/// the firmware itself does not report an expected hashrate (round 18 #6). Plain
/// Antminer Z15 firmware omits the cgminer `total_rateideal` field (the Z15j does
/// report it), so its actual-vs-expected column and colour would otherwise be
/// blank. The Z15 nameplate is 420 KSol/s. Returns `None` for models with no known
/// nameplate (the caller then leaves expected unknown).
pub fn equihash_expected_sols(clean_model: &str) -> Option<f64> {
let m = clean_model.to_ascii_lowercase();
// Match the Z15 family (z15, z15j); both share the 420 KSol/s nameplate.
if m.contains("z15") {
Some(420_000.0)
} else {
None
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn chip_type_derivation() {
// Fleet models (round 21 #3): derived from the detected model for Antminer
// hardware where the firmware does not report a chip string on the wire.
assert_eq!(chip_type_for_model("Antminer", "S21Pro"), Some("BM1370"));
assert_eq!(chip_type_for_model("Antminer", "S19jPro"), Some("BM1362"));
assert_eq!(chip_type_for_model("Antminer", "S19KPro"), Some("BM1366"));
assert_eq!(chip_type_for_model("Antminer", "S19"), Some("BM1398"));
assert_eq!(chip_type_for_model("Antminer", "T19"), Some("BM1398"));
// Raw "Unknown" passthrough with brand + parenthetical normalizes to S19.
assert_eq!(
chip_type_for_model("Antminer", "ANTMINER S19 (88)"),
Some("BM1398")
);
// WhatsMiner chips are not cleanly named -> never derived.
assert_eq!(chip_type_for_model("Whatsminer", "M30S+VE40"), None);
// Unknown Antminer model -> None (no guess).
assert_eq!(chip_type_for_model("Antminer", "L7"), None);
}
#[test]
fn brand_normalises_case() {
assert_eq!(brand("Antminer"), "Antminer");
@@ -350,23 +437,56 @@ mod tests {
#[test]
fn control_board_short_codes() {
// Antminer families (board name as asic-rs renders the enum variant).
assert_eq!(control_board_code("Antminer", "BeagleBoneBlack", "S19"), "BBB (C77)");
assert_eq!(
control_board_code("Antminer", "BeagleBoneBlack", "S19"),
"BBB (C77)"
);
// Also accept the spaced form some layers produce.
assert_eq!(control_board_code("Antminer", "BeagleBone Black", "S19"), "BBB (C77)");
assert_eq!(control_board_code("Antminer", "CVITek", "S21 Pro"), "CVI (C88)");
assert_eq!(control_board_code("Antminer", "Xilinx", "S17 Pro"), "XIL (C49)");
assert_eq!(
control_board_code("Antminer", "BeagleBone Black", "S19"),
"BBB (C77)"
);
assert_eq!(
control_board_code("Antminer", "CVITek", "S21 Pro"),
"CVI (C88)"
);
assert_eq!(
control_board_code("Antminer", "Xilinx", "S17 Pro"),
"XIL (C49)"
);
assert_eq!(control_board_code("Antminer", "Xilinx", "T17"), "XIL (C49)");
assert_eq!(control_board_code("Antminer", "Xilinx", "S19 Pro"), "XIL (C55)");
assert_eq!(control_board_code("Antminer", "AMLogic", "S19j Pro"), "AML (C76)");
assert_eq!(control_board_code("Antminer", "AMLogic", "S19k Pro"), "AML (CBE)");
assert_eq!(control_board_code("Antminer", "AMLogic", "S19 XP"), "AML (CBE)");
assert_eq!(
control_board_code("Antminer", "Xilinx", "S19 Pro"),
"XIL (C55)"
);
assert_eq!(
control_board_code("Antminer", "AMLogic", "S19j Pro"),
"AML (C76)"
);
assert_eq!(
control_board_code("Antminer", "AMLogic", "S19k Pro"),
"AML (CBE)"
);
assert_eq!(
control_board_code("Antminer", "AMLogic", "S19 XP"),
"AML (CBE)"
);
// WhatsMiner families.
assert_eq!(control_board_code("Whatsminer", "H3", "M30S"), "H3 (CB2)");
assert_eq!(control_board_code("Whatsminer", "H6", "M50"), "H6 (CB4)");
assert_eq!(control_board_code("Whatsminer", "H6OS", "M50"), "H6os (CB4)");
assert_eq!(control_board_code("Whatsminer", "H616", "M30S+"), "H616 (CB6)");
assert_eq!(
control_board_code("Whatsminer", "H6OS", "M50"),
"H6os (CB4)"
);
assert_eq!(
control_board_code("Whatsminer", "H616", "M30S+"),
"H616 (CB6)"
);
// Unknown / blank pass through.
assert_eq!(control_board_code("Antminer", "Unknown: FOO", "S19"), "Unknown: FOO");
assert_eq!(
control_board_code("Antminer", "Unknown: FOO", "S19"),
"Unknown: FOO"
);
assert_eq!(control_board_code("Antminer", "", "S19"), "");
}
@@ -374,23 +494,35 @@ mod tests {
fn control_board_cpu_and_board_split() {
// CPU column vs board-code column.
assert_eq!(control_board_cpu("Antminer", "AMLogic", "S19j Pro"), "AML");
assert_eq!(control_board_board("Antminer", "AMLogic", "S19j Pro"), "C76");
assert_eq!(
control_board_board("Antminer", "AMLogic", "S19j Pro"),
"C76"
);
assert_eq!(control_board_cpu("Antminer", "CVITek", "S21 Pro"), "CVI");
assert_eq!(control_board_board("Antminer", "CVITek", "S21 Pro"), "C88");
assert_eq!(control_board_cpu("Whatsminer", "H616", "M30S+"), "H616");
assert_eq!(control_board_board("Whatsminer", "H616", "M30S+"), "CB6");
// S21 Pro on an AMLogic board is the 140mm CBE, not C76.
assert_eq!(control_board_board("Antminer", "AMLogic", "S21 Pro"), "CBE");
assert_eq!(control_board_code("Antminer", "AMLogic", "S21 Pro"), "AML (CBE)");
assert_eq!(
control_board_code("Antminer", "AMLogic", "S21 Pro"),
"AML (CBE)"
);
// Unknown -> cpu holds the raw string, no board code.
assert_eq!(control_board_cpu("Antminer", "Unknown: FOO", "S19"), "Unknown: FOO");
assert_eq!(
control_board_cpu("Antminer", "Unknown: FOO", "S19"),
"Unknown: FOO"
);
assert_eq!(control_board_board("Antminer", "Unknown: FOO", "S19"), "");
}
#[test]
fn firmware_family_splits_vendor_prefix() {
// Stock firmware: vendor word moves out of the family word (round 11 #6).
assert_eq!(firmware_family("AntMiner Stock"), ("Stock".to_string(), Some("AntMiner".to_string())));
assert_eq!(
firmware_family("AntMiner Stock"),
("Stock".to_string(), Some("AntMiner".to_string()))
);
assert_eq!(
firmware_family("WhatsMiner Stock"),
("Stock".to_string(), Some("WhatsMiner".to_string()))
@@ -400,6 +532,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]
+77 -38
View File
@@ -1,13 +1,11 @@
//! Dropdown presets + user-saved values for the Configure-pools dialog (round 15
//! #1). Each pool field (address / account / worker / password) has a "+" menu
//! offering built-in presets (pool stratums, worker placeholders) plus values the
//! user has saved, and the user can add the current box value to the saved list.
//! Saved lists persist one-per-line under the config dir.
//! user has saved. "Add new..." opens a manager window that edits the whole saved
//! list at once (round 18 #8b). Saved lists persist one-per-line under the config dir.
use std::path::PathBuf;
const CONFIG_DIR: &str = ".config/alkane-toolkit";
/// Which pool field a "+" menu belongs to.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PoolField {
@@ -36,8 +34,20 @@ impl PoolField {
PoolField::Account => Vec::new(),
// Per-miner worker-name placeholders (see MinerRow::expand_worker_template).
PoolField::Worker => vec![
"{ip1}", "{ip2}", "{ip3}", "{ip4}", "{serial}", "{mac}", "{nameplate-hr}",
"{brand}", "{model}", "{submodel}", "{cpu}", "{cb}", "{firmware}", "{hostname}",
"{ip1}",
"{ip2}",
"{ip3}",
"{ip4}",
"{serial}",
"{mac}",
"{nameplate-hr}",
"{brand}",
"{model}",
"{submodel}",
"{cpu}",
"{cb}",
"{firmware}",
"{hostname}",
],
PoolField::Password => vec!["x"],
}
@@ -60,54 +70,56 @@ pub const POOL_STRATUMS: &[(&str, &str)] = &[
];
fn config_path(file: &str) -> PathBuf {
let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
PathBuf::from(home).join(CONFIG_DIR).join(file)
alkane_core::platform::config_path(file)
}
/// The user's saved values for `field`, in save order (most recent last).
pub fn load_saved(field: PoolField) -> Vec<String> {
std::fs::read_to_string(config_path(field.saved_file()))
.ok()
.map(|s| s.lines().map(str::trim).filter(|l| !l.is_empty()).map(String::from).collect())
.map(|s| {
s.lines()
.map(str::trim)
.filter(|l| !l.is_empty())
.map(String::from)
.collect()
})
.unwrap_or_default()
}
/// Add `value` to `field`'s saved list (deduplicated, no-op if empty/already
/// present or already a preset). Returns true if it was newly added.
pub fn add_saved(field: PoolField, value: &str) -> bool {
let value = value.trim();
if value.is_empty() {
return false;
}
if field.presets().iter().any(|p| *p == value) {
return false;
}
let mut saved = load_saved(field);
if saved.iter().any(|s| s == value) {
return false;
}
saved.push(value.to_string());
/// Replace `field`'s entire saved list with `values` (round 18 #8b: the preset
/// manager edits the whole list at once). Each value is trimmed; empties, exact
/// duplicates, and any value that is already a built-in preset are dropped.
/// Returns the number of values actually written.
pub fn save_all(field: PoolField, values: &[String]) -> std::io::Result<usize> {
let out = dedupe_saved(&field.presets(), values);
let p = config_path(field.saved_file());
if let Some(dir) = p.parent() {
let _ = std::fs::create_dir_all(dir);
}
let _ = std::fs::write(p, saved.join("\n"));
true
// The password list can hold a pool password, so write it owner-only from the
// moment it is created -- never briefly world-readable (round 18 #12).
write_private(&p, out.join("\n").as_bytes())?;
Ok(out.len())
}
/// Remove `value` from `field`'s saved list (round 16 #5). Returns true if it was
/// present and removed. Presets cannot be removed (they are not in the saved file).
pub fn remove_saved(field: PoolField, value: &str) -> bool {
let value = value.trim();
let mut saved = load_saved(field);
let before = saved.len();
saved.retain(|s| s != value);
if saved.len() == before {
return false;
/// Saved pool values can carry worker passwords, so they are written owner-only.
fn write_private(path: &std::path::Path, data: &[u8]) -> std::io::Result<()> {
alkane_core::platform::write_private(path, data)
}
/// Trim every value, then drop empties, values equal to a built-in preset, and
/// later exact duplicates (first occurrence wins). Order is otherwise preserved.
fn dedupe_saved(presets: &[&str], values: &[String]) -> Vec<String> {
let mut out: Vec<String> = Vec::new();
for v in values {
let v = v.trim();
if v.is_empty() || presets.contains(&v) || out.iter().any(|s| s == v) {
continue;
}
out.push(v.to_string());
}
let p = config_path(field.saved_file());
let _ = std::fs::write(p, saved.join("\n"));
true
out
}
/// The full dropdown list for a field: presets first, then the user's saved
@@ -129,3 +141,30 @@ pub fn dropdown_entries(field: PoolField) -> Vec<(String, String)> {
}
out
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn dedupe_saved_trims_drops_empties_presets_and_dupes() {
let presets = ["x", "{ip1}"];
let vals: Vec<String> = [
" ", "myworker", "myworker", "x", " keep ", "{ip1}", "keep",
]
.iter()
.map(|s| s.to_string())
.collect();
// " " (empty), the second "myworker", "x"/"{ip1}" (presets) and the second
// "keep" all drop; " keep " is trimmed and kept.
assert_eq!(
dedupe_saved(&presets, &vals),
vec!["myworker".to_string(), "keep".to_string()]
);
}
#[test]
fn dedupe_saved_empty_input_is_empty() {
assert!(dedupe_saved(&[], &[]).is_empty());
}
}
+20 -5
View File
@@ -43,7 +43,12 @@ impl PresetView {
PresetView {
order: v.order.clone(),
// keep the visible columns in display order for stability
visible: v.order.iter().copied().filter(|c| v.visible.contains(c)).collect(),
visible: v
.order
.iter()
.copied()
.filter(|c| v.visible.contains(c))
.collect(),
sort: v.sort,
filters: v.filters.iter().map(|(k, f)| (*k, f.clone())).collect(),
}
@@ -62,7 +67,12 @@ impl PresetView {
let mut visible: HashSet<Column> = self.visible.iter().copied().collect();
visible.insert(Column::Ip); // IP is always shown
let filters: HashMap<Column, ColFilter> = self.filters.iter().cloned().collect();
ViewState { order, visible, sort: self.sort, filters }
ViewState {
order,
visible,
sort: self.sort,
filters,
}
}
}
@@ -133,10 +143,15 @@ mod tests {
assert!(view.visible.contains(&Column::Locked));
// The Health column (round 13 #3) replaced these in the default profile.
assert!(!view.visible.contains(&Column::Error));
assert!(!view.visible.contains(&Column::Hashboards));
// Columns dropped from the default profile in round 11.
assert!(!view.visible.contains(&Column::BoardCode), "not in the default profile");
assert!(!view.visible.contains(&Column::Cooling), "not in the default profile");
assert!(
!view.visible.contains(&Column::BoardCode),
"not in the default profile"
);
assert!(
!view.visible.contains(&Column::Fan1),
"not in the default profile"
);
// to_view covers every column in `order`.
assert_eq!(view.order.len(), ALL_COLUMNS.len());
// Round-trip a snapshot back out.
+294 -65
View File
@@ -4,7 +4,7 @@
//! (the stock image is retained on-device at install time; no image is uploaded):
//! - VNish: POST /api/v1/unlock -> bearer -> POST /api/v1/firmware/remove
//! - LuxOS: luxminer :4028 {"command":"logon"} -> SessionID ->
//! {"command":"uninstallluxos","parameter":"<SessionID>"}
//! {"command":"uninstallluxos","parameter":"<SessionID>"}
//! - Braiins: SSH `uninstall.sh` (re-flashes the on-NAND stock backup)
//!
//! DESTRUCTIVE: this removes the running aftermarket firmware and reboots the
@@ -16,25 +16,33 @@
use std::io::{Read, Write};
use std::net::{SocketAddr, TcpStream};
use std::process::Command;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{Receiver, channel};
use std::sync::mpsc::{channel, Receiver};
use std::sync::Arc;
use std::time::Duration;
use crate::scan::fake_scan_enabled;
pub enum RestoreMsg {
Started { total: usize },
Result { ip: String, ok: bool, detail: String },
Done { total: usize },
Started,
Result {
ip: String,
ok: bool,
detail: String,
},
Done,
}
pub struct RestoreHandle {
pub rx: Receiver<RestoreMsg>,
// The worker honours cancellation between miners (see `tc` below); a UI stop
// control is not wired yet, so the handle-side trigger is kept for when it is.
#[allow(dead_code)]
cancel: Arc<AtomicBool>,
}
impl RestoreHandle {
#[allow(dead_code)]
pub fn stop(&self) {
self.cancel.store(true, Ordering::Relaxed);
}
@@ -57,11 +65,10 @@ pub fn start_restore(
) -> RestoreHandle {
let (tx, rx) = channel();
let cancel = Arc::new(AtomicBool::new(false));
let total = targets.len();
if fake_scan_enabled() {
// Offline demo: report each target as restored without touching anything.
let _ = tx.send(RestoreMsg::Started { total });
let _ = tx.send(RestoreMsg::Started);
for t in targets {
let _ = tx.send(RestoreMsg::Result {
ip: t.ip,
@@ -69,30 +76,53 @@ pub fn start_restore(
detail: "restored to stock (demo)".into(),
});
}
let _ = tx.send(RestoreMsg::Done { total });
let _ = tx.send(RestoreMsg::Done);
return RestoreHandle { rx, cancel };
}
let tc = cancel.clone();
let _ = std::thread::Builder::new()
let err_tx = tx.clone();
let spawned = std::thread::Builder::new()
.name("restore-stock".into())
.spawn(move || {
let _ = tx.send(RestoreMsg::Started { total });
let _ = tx.send(RestoreMsg::Started);
for t in targets {
if tc.load(Ordering::Relaxed) {
break;
}
let (ok, detail) = restore_one(&t, &vnish_pass, &ssh_user, &ssh_pass);
if tx.send(RestoreMsg::Result { ip: t.ip, ok, detail }).is_err() {
if tx
.send(RestoreMsg::Result {
ip: t.ip,
ok,
detail,
})
.is_err()
{
return;
}
}
let _ = tx.send(RestoreMsg::Done { total });
let _ = tx.send(RestoreMsg::Done);
});
if spawned.is_err() {
// Never leave the restore subsystem wedged (round 18 #12): if the worker
// thread can't start, emit a failure + Done so the drain clears the handle.
let _ = err_tx.send(RestoreMsg::Result {
ip: String::new(),
ok: false,
detail: "could not start the restore worker thread".into(),
});
let _ = err_tx.send(RestoreMsg::Done);
}
RestoreHandle { rx, cancel }
}
fn restore_one(t: &RestoreTarget, vnish_pass: &str, ssh_user: &str, ssh_pass: &str) -> (bool, String) {
fn restore_one(
t: &RestoreTarget,
vnish_pass: &str,
ssh_user: &str,
ssh_pass: &str,
) -> (bool, String) {
let fw = t.firmware.to_ascii_lowercase();
if fw.contains("vnish") || fw.contains("wildrose") || fw.contains("anthill") {
restore_vnish(&t.ip, vnish_pass)
@@ -101,18 +131,36 @@ fn restore_one(t: &RestoreTarget, vnish_pass: &str, ssh_user: &str, ssh_pass: &s
} else if fw.contains("braiins") || fw.contains("bos") {
restore_braiins(&t.ip, ssh_user, ssh_pass)
} else {
(false, format!("no restore-to-stock path for firmware '{}'", t.firmware))
(
false,
format!("no restore-to-stock path for firmware '{}'", t.firmware),
)
}
}
/// VNish: unlock -> bearer -> firmware/remove (self-restores + reboots ~3 s).
fn restore_vnish(ip: &str, pass: &str) -> (bool, String) {
let unlock = match curl(&[
"-s", "--connect-timeout", "5", "--max-time", "9",
"-X", "POST", "-H", "Content-Type: application/json",
"-d", &format!("{{\"pw\":\"{pass}\"}}"),
&format!("http://{ip}/api/v1/unlock"),
]) {
// serde-encode the body so a password with a quote/backslash can't break the
// JSON, and send it via stdin (-d @-) so the password never appears on curl's
// argv / the process list (round 18 #12).
let body = serde_json::json!({ "pw": pass }).to_string();
let unlock = match curl(
&[
"-s",
"--connect-timeout",
"5",
"--max-time",
"9",
"-X",
"POST",
"-H",
"Content-Type: application/json",
"-d",
"@-",
&format!("http://{ip}/api/v1/unlock"),
],
Some(body.as_bytes()),
) {
Ok(s) => s,
Err(e) => return (false, format!("unlock request failed: {e}")),
};
@@ -123,11 +171,21 @@ fn restore_vnish(ip: &str, pass: &str) -> (bool, String) {
let Some(token) = token else {
return (false, "VNish unlock rejected (wrong web password?)".into());
};
match curl(&[
"-s", "--connect-timeout", "5", "--max-time", "12",
"-X", "POST", "-H", &format!("Authorization: Bearer {token}"),
&format!("http://{ip}/api/v1/firmware/remove"),
]) {
match curl(
&[
"-s",
"--connect-timeout",
"5",
"--max-time",
"12",
"-X",
"POST",
"-H",
&format!("Authorization: Bearer {token}"),
&format!("http://{ip}/api/v1/firmware/remove"),
],
None,
) {
// The miner reverts + reboots after ~3 s; the response is {"after":N}.
Ok(resp) if resp.contains("after") => (true, "reverting to stock (~3 s)".into()),
Ok(resp) => (false, format!("firmware/remove returned: {}", resp.trim())),
@@ -150,15 +208,34 @@ fn restore_luxos(ip: &str) -> (bool, String) {
.map(str::to_string)
});
let Some(session) = session.filter(|s| !s.is_empty()) else {
return (false, format!("no SessionID in logon response: {}", logon.trim()));
return (
false,
format!("no SessionID in logon response: {}", logon.trim()),
);
};
let cmd = format!("{{\"command\":\"uninstallluxos\",\"parameter\":\"{session}\"}}");
// serde-encode so the miner-supplied SessionID can't break or inject into the
// JSON-RPC command (round 18 #12).
let cmd = serde_json::json!({ "command": "uninstallluxos", "parameter": session }).to_string();
match lux_rpc(ip, &cmd) {
// Code 350 "Uninstalling LuxOS"; the miner reboots + reverts in background.
Ok(resp) if resp.contains("350") || resp.to_lowercase().contains("uninstall") => {
(true, "uninstalling LuxOS (reboots to stock)".into())
}
// The miner reboots as it reverts, so the reply is often dropped/empty
// after the command is accepted. The logon above already proved the miner
// was reachable, so an empty reply or a dropped connection here is the
// expected reboot, not a failure (round 18 #12).
Ok(resp) if resp.trim().is_empty() => {
(true, "uninstall accepted (miner rebooting to stock)".into())
}
Ok(resp) => (false, format!("uninstallluxos returned: {}", resp.trim())),
Err(e)
if ["closed", "reset", "timed out", "broken pipe", "eof"]
.iter()
.any(|m| e.to_lowercase().contains(m)) =>
{
(true, "RPC dropped (miner rebooting to stock)".into())
}
Err(e) => (false, format!("uninstallluxos failed: {e}")),
}
}
@@ -166,31 +243,43 @@ fn restore_luxos(ip: &str) -> (bool, String) {
/// Braiins: SSH `uninstall.sh` (re-flashes the retained on-NAND stock backup).
fn restore_braiins(ip: &str, user: &str, pass: &str) -> (bool, String) {
if pass.is_empty() {
return (false, "Braiins restore needs an SSH password (set the SSH login)".into());
return (
false,
"Braiins restore needs an SSH password (Credentials > SSH)".into(),
);
}
let target = format!("{user}@{ip}");
// uninstall.sh is on Braiins OS+'s PATH; run it non-interactively.
let mut cmd = Command::new("sshpass");
cmd.arg("-p").arg(pass).arg("ssh");
// The password reaches ssh through the toolkit's own askpass helper (its
// environment, never argv, so it stays out of the process list; round 18
// #12), which works the same with Linux OpenSSH and Windows' ssh.exe. One
// password attempt and no terminal: a bad password fails fast instead of
// hanging out the 60 s cap. Host-key checking is deliberately disabled: these
// are LAN miners whose SSH host key changes on every reflash, so pinning it
// would break the very revert this performs.
let mut cmd = alkane_core::platform::quiet_command("ssh");
if let Err(e) = crate::askpass::ssh_with_password(&mut cmd, pass) {
return (false, e);
}
let known_hosts = format!("UserKnownHostsFile={}", alkane_core::platform::NULL_DEVICE);
cmd.args(crate::askpass::PASSWORD_AUTH_OPTIONS);
cmd.args([
"-o", "StrictHostKeyChecking=no",
"-o", "UserKnownHostsFile=/dev/null",
"-o", "ConnectTimeout=8",
"-o",
"StrictHostKeyChecking=no",
"-o",
&known_hosts,
"-o",
"ConnectTimeout=8",
&target,
"uninstall.sh || /sbin/uninstall.sh",
]);
match run_with_timeout(cmd, Duration::from_secs(60)) {
Ok(out) => {
let s = String::from_utf8_lossy(&out).to_lowercase();
if s.contains("not found") || s.contains("no such") {
(false, "uninstall.sh not found on the miner".into())
} else {
(true, "ran uninstall.sh (reverts to stock + reboots)".into())
}
}
match run_with_timeout(cmd, Duration::from_secs(60), None) {
Ok(out) => classify_braiins(
&String::from_utf8_lossy(&out.stdout),
&String::from_utf8_lossy(&out.stderr),
out.code,
out.timed_out,
),
Err(e) => {
// A reboot mid-command commonly drops the SSH connection; treat a
// connection-closed error after the command as likely success.
if e.contains("closed") || e.contains("reset") || e.contains("timed out") {
(true, "SSH dropped (miner likely rebooting to stock)".into())
} else {
@@ -200,9 +289,58 @@ fn restore_braiins(ip: &str, user: &str, pass: &str) -> (bool, String) {
}
}
/// Decide a Braiins `uninstall.sh` outcome from its captured output. The critical
/// rule (round 18 #12): an SSH auth/connection failure -- which writes its
/// diagnostic to stderr, leaves stdout empty, and exits non-zero -- must be
/// reported as a FAILURE, never a false success. A dropped connection or a
/// timeout after the command started is the expected signature of the reboot.
fn classify_braiins(
stdout: &str,
stderr: &str,
code: Option<i32>,
timed_out: bool,
) -> (bool, String) {
let err = stderr.to_lowercase();
// ssh's own connection/auth failures (exit 255) never reach the remote command.
let conn_fail = [
"permission denied",
"connection refused",
"could not resolve",
"no route to host",
"connection timed out",
"operation timed out",
"host key verification failed",
"before authentication",
]
.iter()
.any(|m| err.contains(m));
if conn_fail {
let why = stderr.lines().map(str::trim).rfind(|l| !l.is_empty());
return (
false,
format!("SSH failed: {}", why.unwrap_or("connection/auth error")),
);
}
let out = stdout.to_lowercase();
if out.contains("not found") || out.contains("no such") || err.contains("not found") {
return (false, "uninstall.sh not found on the miner".into());
}
match code {
Some(0) => (true, "ran uninstall.sh (reverts to stock + reboots)".into()),
None => (true, "SSH dropped (miner likely rebooting to stock)".into()),
_ if timed_out => (
true,
"SSH timed out (miner likely rebooting to stock)".into(),
),
Some(c) => (false, format!("uninstall.sh exited {c}: {}", stderr.trim())),
}
}
/// One luxminer :4028 request/response (line-framed, socket closes after reply).
fn lux_rpc(ip: &str, payload: &str) -> Result<String, String> {
let addr: SocketAddr = format!("{ip}:4028").parse().map_err(|e| format!("bad addr: {e}"))?;
let addr: SocketAddr = format!("{ip}:4028")
.parse()
.map_err(|e| format!("bad addr: {e}"))?;
let t = Duration::from_secs(8);
let mut s = TcpStream::connect_timeout(&addr, t).map_err(|e| e.to_string())?;
s.set_read_timeout(Some(t)).ok();
@@ -222,58 +360,149 @@ fn lux_rpc(ip: &str, payload: &str) -> Result<String, String> {
Err(_) => break,
}
}
Ok(String::from_utf8_lossy(&buf).trim_matches('\u{0}').to_string())
Ok(String::from_utf8_lossy(&buf)
.trim_matches('\u{0}')
.to_string())
}
/// curl with a wall-clock cap (small responses; no pipe-drain thread needed).
fn curl(args: &[&str]) -> Result<String, String> {
let mut cmd = Command::new("curl");
/// The captured result of a timed subprocess run.
struct CmdOutput {
/// The process exit code, or `None` if it was killed / dropped / timed out.
code: Option<i32>,
stdout: Vec<u8>,
stderr: Vec<u8>,
timed_out: bool,
}
/// curl with a wall-clock cap. Errors only when the run produced no output and
/// timed out (a black-holed host); otherwise returns stdout even on a non-zero
/// exit (curl prints useful bodies/status on failures).
fn curl(args: &[&str], stdin_data: Option<&[u8]>) -> Result<String, String> {
let mut cmd = alkane_core::platform::quiet_command("curl");
cmd.args(args);
run_with_timeout(cmd, Duration::from_secs(15)).map(|o| String::from_utf8_lossy(&o).into_owned())
let out = run_with_timeout(cmd, Duration::from_secs(15), stdin_data)?;
if out.timed_out && out.stdout.is_empty() {
return Err("timed out".into());
}
Ok(String::from_utf8_lossy(&out.stdout).into_owned())
}
/// Run a command, capture stdout, with a hard wall-clock timeout.
fn run_with_timeout(mut cmd: Command, timeout: Duration) -> Result<Vec<u8>, String> {
/// Run a command with a hard wall-clock timeout, capturing stdout, stderr, and
/// the exit code. Both pipes are drained on their own threads so a child that
/// writes a lot to stderr can never deadlock against a full pipe (round 18 #12).
/// `stdin_data`, when set, is written to the child's stdin and the pipe closed
/// (used to feed a request body without putting a secret on argv).
fn run_with_timeout(
mut cmd: Command,
timeout: Duration,
stdin_data: Option<&[u8]>,
) -> Result<CmdOutput, String> {
cmd.stdout(std::process::Stdio::piped());
cmd.stderr(std::process::Stdio::piped());
if stdin_data.is_some() {
cmd.stdin(std::process::Stdio::piped());
}
let mut child = cmd.spawn().map_err(|e| format!("spawn: {e}"))?;
if let Some(data) = stdin_data {
if let Some(mut si) = child.stdin.take() {
let _ = si.write_all(data);
} // dropping `si` closes the pipe
}
let mut stdout = child.stdout.take().ok_or("no stdout")?;
let reader = std::thread::spawn(move || {
let mut stderr = child.stderr.take().ok_or("no stderr")?;
let out_reader = std::thread::spawn(move || {
let mut b = Vec::new();
let _ = stdout.read_to_end(&mut b);
b
});
let err_reader = std::thread::spawn(move || {
let mut b = Vec::new();
let _ = stderr.read_to_end(&mut b);
b
});
let start = std::time::Instant::now();
let mut timed_out = false;
loop {
let status = loop {
match child.try_wait().map_err(|e| e.to_string())? {
Some(_) => break,
Some(s) => break Some(s),
None => {
if start.elapsed() >= timeout {
let _ = child.kill();
let _ = child.wait(); // reap so we never leave a zombie
timed_out = true;
break;
break None;
}
std::thread::sleep(Duration::from_millis(50));
}
}
}
let out = reader.join().unwrap_or_default();
if timed_out && out.is_empty() {
return Err("timed out".into());
}
Ok(out)
};
Ok(CmdOutput {
code: status.and_then(|s| s.code()),
stdout: out_reader.join().unwrap_or_default(),
stderr: err_reader.join().unwrap_or_default(),
timed_out,
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn braiins_auth_or_connection_failure_is_not_a_false_success() {
// The critical regression guard (round 18 #12): a wrong password or an
// unreachable miner writes to stderr, leaves stdout empty, and exits
// non-zero -- it must report failure, never "restored".
let (ok, msg) =
classify_braiins("", "Permission denied, please try again.", Some(255), false);
assert!(!ok, "wrong password must not report success");
assert!(msg.to_lowercase().contains("ssh failed"), "{msg}");
let (ok, _) = classify_braiins(
"",
"ssh: connect to host 10.0.0.9 port 22: Connection refused",
Some(255),
false,
);
assert!(!ok, "unreachable miner must not report success");
let (ok, _) = classify_braiins(
"",
"ssh: Could not resolve hostname miner: Name or service not known",
Some(255),
false,
);
assert!(!ok, "unresolvable host must not report success");
// Genuine outcomes.
let (ok, _) = classify_braiins("uninstalling...\n", "", Some(0), false);
assert!(ok, "clean exit 0 is success");
let (ok, _) = classify_braiins(
"",
"Connection to 10.0.0.5 closed by remote host.",
None,
false,
);
assert!(ok, "connection dropped mid-command (reboot) is success");
let (ok, _) = classify_braiins("", "", None, true);
assert!(ok, "timeout after the command started (reboot) is success");
let (ok, _) = classify_braiins(
"bash: uninstall.sh: command not found\n",
"",
Some(127),
false,
);
assert!(!ok, "missing uninstall.sh is a failure");
}
#[test]
fn firmware_selects_the_right_flow() {
// The dispatcher only recognises the three revertible aftermarket
// families; anything else has no restore path.
let mk = |fw: &str| RestoreTarget { ip: "0.0.0.0".into(), firmware: fw.into() };
let mk = |fw: &str| RestoreTarget {
ip: "0.0.0.0".into(),
firmware: fw.into(),
};
// Unknown firmware is rejected cleanly (no network attempt in the branch).
let (ok, detail) = restore_one(&mk("Stock"), "", "", "");
assert!(!ok);
File diff suppressed because it is too large Load Diff
+1850 -507
View File
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!--
Application manifest for alkane-toolkit.exe (embedded by windows/alkane-toolkit.rc).
- Common Controls v6: themed native controls (Windows 10/11 visual styles)
instead of the Windows 95 look.
- Per-monitor DPI awareness v2: crisp at any scale factor; wx rescales
windows when they move between monitors.
- supportedOS Windows 10/11 (the Rust toolchain's own minimum).
- activeCodePage UTF-8: the C runtime and any narrow-string Win32 call speak
the same UTF-8 the Rust side does.
- longPathAware: settings/export paths beyond MAX_PATH work when enabled.
- asInvoker: never asks for elevation.
-->
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
<assemblyIdentity type="win32" name="Blueflare.AlkaneToolkit" version="1.0.0.0"
processorArchitecture="amd64"/>
<description>Alkane Toolkit</description>
<dependency>
<dependentAssembly>
<assemblyIdentity type="win32" name="Microsoft.Windows.Common-Controls"
version="6.0.0.0" processorArchitecture="*"
publicKeyToken="6595b64144ccf1df" language="*"/>
</dependentAssembly>
</dependency>
<compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
<application>
<supportedOS Id="{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}"/>
</application>
</compatibility>
<application xmlns="urn:schemas-microsoft-com:asm.v3">
<windowsSettings>
<dpiAware xmlns="http://schemas.microsoft.com/SMI/2005/WindowsSettings">true/pm</dpiAware>
<dpiAwareness xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">PerMonitorV2, PerMonitor</dpiAwareness>
<longPathAware xmlns="http://schemas.microsoft.com/SMI/2016/WindowsSettings">true</longPathAware>
<activeCodePage xmlns="http://schemas.microsoft.com/SMI/2019/WindowsSettings">UTF-8</activeCodePage>
</windowsSettings>
</application>
<trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
<security>
<requestedPrivileges>
<requestedExecutionLevel level="asInvoker" uiAccess="false"/>
</requestedPrivileges>
</security>
</trustInfo>
</assembly>
Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

@@ -0,0 +1,42 @@
// Windows resources for alkane-toolkit.exe, compiled by crates/alkane-gui/build.rs
// with the windres named by `wx-config --rescomp`. ALKANE_VER_* come from the
// crate version (which CI stamps per release).
// wxMSW's own resources (stock cursors and bitmaps). Its built-in manifest is
// suppressed: the application manifest below replaces it.
#define wxUSE_NO_MANIFEST 1
#include "wx/msw/wx.rc"
// The first icon in the file is the one Explorer and the taskbar show.
aaaa ICON "alkane-toolkit.ico"
CREATEPROCESS_MANIFEST_RESOURCE_ID RT_MANIFEST "alkane-toolkit.exe.manifest"
VS_VERSION_INFO VERSIONINFO
FILEVERSION ALKANE_VER_MAJOR, ALKANE_VER_MINOR, ALKANE_VER_PATCH, 0
PRODUCTVERSION ALKANE_VER_MAJOR, ALKANE_VER_MINOR, ALKANE_VER_PATCH, 0
FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
FILEFLAGS 0
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
FILESUBTYPE VFT2_UNKNOWN
BEGIN
BLOCK "StringFileInfo"
BEGIN
BLOCK "040904B0"
BEGIN
VALUE "CompanyName", "BlueFlare Energy Solutions Inc."
VALUE "FileDescription", "Alkane Toolkit"
VALUE "FileVersion", ALKANE_VER_STR
VALUE "InternalName", "alkane-toolkit"
VALUE "LegalCopyright", "Copyright (c) 2026 BlueFlare Energy Solutions Inc. (MIT License)"
VALUE "OriginalFilename", "alkane-toolkit.exe"
VALUE "ProductName", "Alkane Toolkit"
VALUE "ProductVersion", ALKANE_VER_STR
END
END
BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x0409, 1200
END
END
+21
View File
@@ -0,0 +1,21 @@
#!/bin/sh
# Regenerate alkane-toolkit.ico (the Windows executable/taskbar icon) from the
# in-repo microchip glyph: a white chip on a rounded amber tile, at the sizes
# Windows asks for (16-256 px). Needs rsvg-convert and ImageMagick; the .ico is
# committed, so a normal build never runs this.
set -e
cd "$(dirname "$0")"
GLYPH=../assets/icons/microchip-solid-full.svg
TMP=$(mktemp -d)
trap 'rm -rf "$TMP"' 0
sed 's/currentColor/#ffffff/g; s/<svg /<svg fill="#ffffff" /' "$GLYPH" > "$TMP/glyph.svg"
for s in 16 20 24 32 40 48 64 256; do
r=$((s * 22 / 100)); g=$((s * 64 / 100)); o=$(((s - g) / 2))
rsvg-convert -w "$g" -h "$g" "$TMP/glyph.svg" -o "$TMP/g$s.png"
convert -size "${s}x${s}" xc:none -fill '#d9822b' \
-draw "roundrectangle 0,0 $((s - 1)),$((s - 1)) $r,$r" \
"$TMP/g$s.png" -geometry "+$o+$o" -composite "PNG32:$TMP/i$s.png"
done
convert "$TMP"/i16.png "$TMP"/i20.png "$TMP"/i24.png "$TMP"/i32.png "$TMP"/i40.png \
"$TMP"/i48.png "$TMP"/i64.png "$TMP"/i256.png alkane-toolkit.ico
echo "wrote $(pwd)/alkane-toolkit.ico"
+43
View File
@@ -0,0 +1,43 @@
# cargo-deny configuration (https://embarkstudios.github.io/cargo-deny/).
#
# Run locally with `cargo deny check`. CI's security gate is cargo-audit (lighter,
# already wired); this file documents the dependency policy and lets anyone run a
# fuller license/advisory/source check. The whole dependency set is vendored under
# ./vendor and resolved offline (see .cargo/config.toml).
[advisories]
version = 2
# Accepted, documented advisories (build-time-only reqwest 0.11 subtree of the
# wx-rs build script -- never linked into the runtime binary). Mirrors
# .cargo/audit.toml; re-review when the vendored dependency set is refreshed.
ignore = [
"RUSTSEC-2026-0258", # h2 0.3 DATA-frame DoS (build-time HTTP client only)
"RUSTSEC-2025-0134", # rustls-pemfile 1.0.4 unmaintained (same subtree)
]
[licenses]
version = 2
# The project is MIT; only permissive licenses are allowed in the
# dependency tree.
allow = [
"MIT",
"Apache-2.0",
"Apache-2.0 WITH LLVM-exception",
"BSD-2-Clause",
"BSD-3-Clause",
"ISC",
"Zlib",
"Unicode-3.0",
"Unicode-DFS-2016",
"MPL-2.0",
"CC0-1.0",
]
confidence-threshold = 0.9
[bans]
multiple-versions = "warn"
wildcards = "allow"
[sources]
unknown-registry = "warn"
unknown-git = "warn"
+6 -6
View File
@@ -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 -1
View File
@@ -1,4 +1,4 @@
# ADR 0001: Recipes as data, interpreted by one engine
# ADR 0001: Recipe engine
Status: ACCEPTED
Date: 2026-09-14
+15 -29
View File
@@ -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.
+2 -2
View File
@@ -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.
+48
View File
@@ -0,0 +1,48 @@
# ADR 0004: Windows port
Date: 2026-11-02
## Context
The GUI is wxWidgets through the patched `wx-rs` bridge (ADR 0002), so most
of it is portable, but the patches and the app had only ever run on GTK. The
Windows build has to look and behave like a native Windows 10/11 application,
ship from the same CI as Linux, and stay maintainable for a team that develops
on Linux.
## Decision
- Build on Linux: cross-compile with mingw-w64 (posix threads) against the
vendored wxWidgets built as static wxMSW (`scripts/build-wx-windows.sh`).
The `wx-rs` build script now picks the platform from `CARGO_CFG_TARGET_*`
(a build script's `cfg!()` describes the host) and builds Windows/GNU through
`wx-config` exactly like GTK. The C++ runtime is linked statically; the
`.exe` imports only Windows system DLLs.
- Native look comes from wxMSW plus an application manifest
(`crates/alkane-gui/windows/`): Common Controls v6, per-monitor DPI
awareness v2, UTF-8 code page, Windows 10/11 compatibility, icon and
version resources. Light/dark follows the Windows app mode.
- Platform code is contained: OS differences in Rust live in
`alkane_core::platform` (config directory, owner-only secret files, null
device, console-less child processes); in C++ they are `#ifdef __WXMSW__` /
`__WXGTK__` sections of the bridge, with shared logic (icon hit-testing) in
plain functions both use.
- Sizes cross the Rust/C++ boundary in DIPs, converted per window with
`FromDIP`/`ToDIP`. That is the identity on GTK, so Linux output is unchanged.
- SSH password logins use `SSH_ASKPASS` with the toolkit's own executable as
the helper, on every platform, replacing `sshpass` (absent on Windows).
- CI tests the Windows build under Wine on the existing Linux runners (the
release gate), and again on real Windows 11 through a self-hosted VM runner
(advisory, never blocking).
- The `wx-rs` patch queue must reproduce the patched tree from the pristine
upstream crate; `scripts/wx_rs_patches.py check` enforces it in CI.
## Consequences
- One toolchain and one CI fleet for both platforms; no Windows build machine.
- Wine is a good but not perfect stand-in for Windows; the native VM job
covers the gap without making releases depend on the VM being up.
- Bridge changes need checking on both toolkits: GTK uses the native tree
view, wxMSW the generic data view, which differ in input routing, painting
and selection style (see docs/windows.md).
- macOS remains out of scope (no Mac to build or test on).
+62
View File
@@ -0,0 +1,62 @@
# macOS
The macOS build is one universal app, `Alkane Toolkit.app`, that runs natively
on Apple Silicon and Intel Macs with macOS 11 (Big Sur) or later. It ships as
`alkane-toolkit-vX.Y.Z-macos-universal.zip`, holding the app, `LICENSE` and a
`README.txt`.
## Using it
- Settings live in `~/.config/alkane-toolkit`, the same files as on Linux.
- SSH actions use the system `ssh`; HTTP actions use the system `curl`.
- The app is ad-hoc signed but not notarized, so macOS blocks the first launch.
On macOS 15 or later, try to open it, then choose **Open Anyway** in
System Settings > Privacy & Security. On macOS 11 to 14, Control-click the
app and choose **Open**. Or clear the quarantine flag once:
`xattr -dr com.apple.quarantine "/Applications/Alkane Toolkit.app"`.
- The first scan asks for permission to find devices on the local network
(macOS 15 and later). Scanning needs it.
- Offline demo: `ALKANE_FAKE_SCAN=1 "/Applications/Alkane Toolkit.app/Contents/MacOS/alkane-toolkit"`.
## Building
macOS builds only on a Mac. It needs the Xcode Command Line Tools
(`xcode-select --install`) and rustup with both Apple targets:
```sh
rustup target add aarch64-apple-darwin x86_64-apple-darwin
scripts/build-wx-macos.sh # once: universal static wxOSX 3.3.3 in ~/.cache/wx-3.3.3-macos
scripts/build-gui-macos.sh # both slices, merged with lipo
python3 ci/package-macos.py X.Y.Z target/universal-apple-darwin/release/alkane-toolkit dist
```
`build-wx-macos.sh` builds wxWidgets once for arm64 and x86_64 together, with
wx's bundled image, zlib, regex and expat libraries, so the app links only
against system frameworks. `build-gui-macos.sh` builds each Rust target
against that prefix and merges them. `package-macos.py` writes the bundle
(Info.plist, icon), ad-hoc signs it and zips it with `ditto`.
To test on the Mac:
```sh
ALKANE_SELFTEST=1 target/universal-apple-darwin/release/alkane-toolkit # headless UI self-test
cargo test --release --offline --target aarch64-apple-darwin --workspace --exclude wx-rs
```
The self-test opens a window briefly, so it needs a logged-in desktop
session. Running the x86_64 slice on Apple Silicon needs Rosetta 2.
## Why macOS 11
Current Xcode SDKs ship a libc++ that supports macOS 11 and later only;
building for an older target compiles, but the app could fail at run time on
the older system. macOS 11 is also the first release for Apple Silicon. Older
Intel Macs would need a build with an older SDK.
## Notes for the bridge
wxOSX reports logical (point) sizes, like the GTK and MSW bridges; the
bridge never scales to physical pixels. wxOSX's Objective-C uses
`@available`, so `build.rs` links clang's compiler runtime
(`libclang_rt.osx.a`), which rustc's link does not include by itself. Both
are wx-rs patch `0009`.
+66
View File
@@ -0,0 +1,66 @@
# Getting started
Alkane Toolkit finds the ASIC miners on your network and shows them in one
table: model, firmware, hashrate, power, temperatures, fans and the health of
every hashboard. From the same table you can run the controls each miner's
firmware supports, such as pausing, restarting or changing pools.
## Download
Get the latest release from the
[downloads page](https://gitea.bluefla.re/blueflare/alkane-toolkit/releases).
| Platform | File | Notes |
|---|---|---|
| Windows 10 and 11 (x86_64) | `alkane-toolkit-vX.Y.Z-windows-x86_64.zip` | One signed `alkane-toolkit.exe`; nothing to install |
| Linux (x86_64) | `alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz` | One binary; needs GTK 3 (`sudo apt install libgtk-3-0`) |
| macOS 11 or later (Apple Silicon and Intel) | `alkane-toolkit-vX.Y.Z-macos-universal.zip` | One app; not notarized, so confirm the first launch |
### Windows
1. Download the zip, right-click it, choose **Properties**, tick **Unblock** if
it is shown, then extract it.
2. Run `alkane-toolkit.exe`. Windows shows *BlueFlare Energy Solutions Inc.* as
the verified publisher. To check the signature yourself, right-click the exe,
choose **Properties** and open **Digital Signatures**.
### macOS
1. Download the zip and open it; drag **Alkane Toolkit** to Applications.
2. Open it. The app is not notarized, so macOS blocks the first launch:
- macOS 15 or later: open **System Settings > Privacy & Security** and
choose **Open Anyway** for Alkane Toolkit.
- macOS 11 to 14: Control-click the app, choose **Open**, then **Open**.
3. When asked, allow it to find devices on your local network. Scanning
needs this.
### Linux
```sh
tar xzf alkane-toolkit-vX.Y.Z-linux-x86_64.tar.gz
./alkane-toolkit-vX.Y.Z-linux-x86_64/alkane-toolkit
```
## First run
The toolkit starts a scan as soon as it opens. Set your own ranges first with
**Scan ranges** (see [Scanning](02-scanning.md)); until you do, it scans
192.168.1.0/24, the usual router subnet.
To look around without touching any miner, start it in demo mode. It shows a
built-in sample fleet and simulates every action:
| Platform | Command |
|---|---|
| Windows (Command Prompt) | `set ALKANE_FAKE_SCAN=1 && alkane-toolkit.exe` |
| Linux | `ALKANE_FAKE_SCAN=1 ./alkane-toolkit` |
## Where settings are kept
| Platform | Folder |
|---|---|
| Windows | `%APPDATA%\alkane-toolkit` |
| Linux | `~/.config/alkane-toolkit` |
See [Settings and credentials](06-settings.md) for the files in that folder.
Deleting the folder resets the toolkit to its defaults.
+51
View File
@@ -0,0 +1,51 @@
# Scanning
Discovery is read-only: a scan asks each address what it is and records what
it reports. It never changes a miner.
## Scan ranges
Click **Scan ranges** to edit the addresses to scan. Put one entry per line;
blank lines and lines starting with `#` are ignored.
| Form | Example | Scans |
|---|---|---|
| Single address | `192.168.1.50` | that address |
| CIDR block | `192.168.1.0/24` | the whole block |
| Full range | `192.168.1.10-192.168.2.40` | every address between the two, inclusive |
| Short range | `192.168.1.10-90` | `.10` to `.90` within the same /24 |
| Per-octet ranges | `10.1-4.0-1.1-255` | every combination (10.1.0.1 ... 10.4.1.255) |
Commas or spaces between several entries on one line are not accepted; use one
line each. Duplicates are removed automatically. One line, and all lines
together, may cover at most 1,000,000 addresses.
**Apply** saves the ranges and starts a scan. A mistake keeps the dialog open
and the status bar explains it, for example `invalid range: bad octet range`.
The same dialog has three numbers:
| Field | Meaning | Default |
|---|---|---|
| Rescan (s) | seconds between automatic rescans; `0` turns auto-rescan off | 300 |
| Timeout (s) | how long to wait for one miner (scans, refreshes, actions and log fetches) | 10 |
| Concurrency | how many addresses are probed at once (8 to 256); higher is faster but slow miners may report fewer values | 128 |
When the ranges change, miners outside the new ranges leave the table at the
next scan.
## Running, pausing and stopping
The three buttons next to **Scan ranges** control scanning:
- **Play** (green) turns auto-rescan on and starts a scan now if none is running.
- **Pause** (amber) turns auto-rescan off and lets the current scan finish.
- **Stop** (red) turns auto-rescan off and cancels the current scan.
While a scan runs, a progress bar spans the top of the table and the status bar
shows progress such as `1935/4590 - scanning 192.168.1.86 (92 found)`. Afterwards
it shows the count and the time to the next scan, for example
`245 miners - next scan in 4m 12s`.
Actions that change miners wait for the scan to finish; see
[Actions](05-actions.md).

Some files were not shown because too many files have changed in this diff Show More