From ab264f49230e7f8c4a307a3ae75ccf33b32cb8b5 Mon Sep 17 00:00:00 2001 From: noah Date: Tue, 13 Oct 2026 11:45:56 -0600 Subject: [PATCH] Add measured badges and coverage reports --- .gitea/workflows/main.yml | 32 ++++++++++++- README.md | 13 ++++++ badges/bench-coverage.svg | 1 + badges/bench.svg | 1 + badges/coverage.svg | 1 + badges/dependencies.svg | 1 + badges/license.svg | 1 + badges/loc.svg | 1 + badges/metrics.json | 14 ++++++ badges/quality.svg | 1 + badges/tests.svg | 1 + ci/metrics.py | 96 +++++++++++++++++++++++++++++++++++++++ 12 files changed, 162 insertions(+), 1 deletion(-) create mode 100644 badges/bench-coverage.svg create mode 100644 badges/bench.svg create mode 100644 badges/coverage.svg create mode 100644 badges/dependencies.svg create mode 100644 badges/license.svg create mode 100644 badges/loc.svg create mode 100644 badges/metrics.json create mode 100644 badges/quality.svg create mode 100644 badges/tests.svg create mode 100644 ci/metrics.py diff --git a/.gitea/workflows/main.yml b/.gitea/workflows/main.yml index 2e0ca7f..70179c0 100644 --- a/.gitea/workflows/main.yml +++ b/.gitea/workflows/main.yml @@ -18,11 +18,41 @@ jobs: - name: Build run: cargo build --release --locked - name: Unit and workflow tests - run: cargo test --locked + run: | + set -o pipefail + cargo test --locked 2>&1 | tee tests-current.txt - name: Microbenchmarks run: | set -o pipefail cargo test --release --locked -- --ignored --nocapture | tee bench-current.txt + - name: Coverage tool + run: | + rustup component add llvm-tools-preview + if ! command -v cargo-llvm-cov >/dev/null 2>&1; then + cargo install --locked cargo-llvm-cov --version 0.8.7 + fi + - name: Unit test coverage + run: | + mkdir -p coverage + CARGO_TARGET_DIR=target/coverage-tests cargo llvm-cov --json \ + --output-path coverage/tests.json --locked + - name: Microbenchmark coverage + run: | + CARGO_TARGET_DIR=target/coverage-bench cargo llvm-cov --json \ + --output-path coverage/bench.json --locked -- --ignored + - name: Generate measured badges + run: | + python3 ci/metrics.py --tests-output tests-current.txt \ + --tests-coverage coverage/tests.json --bench-output bench-current.txt \ + --bench-coverage coverage/bench.json + - uses: actions/upload-artifact@v4 + with: + name: alkane-os-metrics + path: | + badges/metrics.json + coverage/tests.json + coverage/bench.json + bench-current.txt - name: Pairing and simulator conformance run: python3 ci/check-conformance.py - name: Select release version diff --git a/README.md b/README.md index 1b446f7..32c0c43 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # Alkane OS +[![CI](https://gitea.bluefla.re/blueflare/alkane-os/actions/workflows/main.yml/badge.svg?branch=main)](https://gitea.bluefla.re/blueflare/alkane-os/actions) +![tests](badges/tests.svg) +![coverage](badges/coverage.svg) +![bench](badges/bench.svg) +![bench coverage](badges/bench-coverage.svg) +![lines of code](badges/loc.svg) +![dependencies](badges/dependencies.svg) +![code quality](badges/quality.svg) +![license](badges/license.svg) + Portable mining, tuning, and management logic for Alkane control boards. The source is MIT licensed. `alkane-sdk` owns the board images and supplies the hardware backend at build time. This repository has no on-board web frontend; @@ -36,3 +46,6 @@ python3 ci/check-conformance.py The last command currently fails because simulator and device evidence are still pending. It is a release gate, not a unit test. + +The badges record measured host-side checks for this initial core. They do +not imply that any board image or mining target has passed conformance. diff --git a/badges/bench-coverage.svg b/badges/bench-coverage.svg new file mode 100644 index 0000000..11f27fa --- /dev/null +++ b/badges/bench-coverage.svg @@ -0,0 +1 @@ +bench coverage32.6% diff --git a/badges/bench.svg b/badges/bench.svg new file mode 100644 index 0000000..3ea5a94 --- /dev/null +++ b/badges/bench.svg @@ -0,0 +1 @@ +benchbaseline set diff --git a/badges/coverage.svg b/badges/coverage.svg new file mode 100644 index 0000000..6008e0a --- /dev/null +++ b/badges/coverage.svg @@ -0,0 +1 @@ +coverage69.6% diff --git a/badges/dependencies.svg b/badges/dependencies.svg new file mode 100644 index 0000000..e43a151 --- /dev/null +++ b/badges/dependencies.svg @@ -0,0 +1 @@ +dependencies0 diff --git a/badges/license.svg b/badges/license.svg new file mode 100644 index 0000000..b3539c4 --- /dev/null +++ b/badges/license.svg @@ -0,0 +1 @@ +licenseMIT diff --git a/badges/loc.svg b/badges/loc.svg new file mode 100644 index 0000000..3df4a56 --- /dev/null +++ b/badges/loc.svg @@ -0,0 +1 @@ +lines of code485 diff --git a/badges/metrics.json b/badges/metrics.json new file mode 100644 index 0000000..6995323 --- /dev/null +++ b/badges/metrics.json @@ -0,0 +1,14 @@ +{ + "tests": 2, + "line_coverage_pct": 69.6, + "bench_coverage_pct": 32.6, + "bench_ns_per_op": { + "power_policy": 0.686, + "target_matrix": 33.929 + }, + "bench_improvement_pct": null, + "lines_of_code": 485, + "dependencies": 0, + "code_quality": "A", + "license": "MIT" +} diff --git a/badges/quality.svg b/badges/quality.svg new file mode 100644 index 0000000..72494f5 --- /dev/null +++ b/badges/quality.svg @@ -0,0 +1 @@ +code qualityA diff --git a/badges/tests.svg b/badges/tests.svg new file mode 100644 index 0000000..74d951c --- /dev/null +++ b/badges/tests.svg @@ -0,0 +1 @@ +tests2 diff --git a/ci/metrics.py b/ci/metrics.py new file mode 100644 index 0000000..fc6a6e2 --- /dev/null +++ b/ci/metrics.py @@ -0,0 +1,96 @@ +#!/usr/bin/env python3 +"""Generate reviewable metrics and self-contained badges from CI measurements.""" + +import argparse +import html +import json +import pathlib +import re +import tomllib + + +def coverage(path): + data = json.loads(pathlib.Path(path).read_text()) + return data["data"][0]["totals"]["lines"]["percent"] + + +def bench_results(path): + text = pathlib.Path(path).read_text() + return {name: float(ns) for name, ns in re.findall(r"BENCH (\w+) ([0-9.]+) ns/op", text)} + + +def compact(number): + value = float(number) + units = ("", "K", "M", "G") + index = 0 + while value >= 999.5 and index < len(units) - 1: + value /= 1000 + index += 1 + digits = 0 if value >= 100 else 1 if value >= 10 else 2 + number = f"{value:.{digits}f}" + if digits: + number = number.rstrip("0").rstrip(".") + return number + units[index] + + +def svg(label, value, color): + label, value = html.escape(label), html.escape(value) + lw, vw = 12 + 7 * len(label), 12 + 7 * len(value) + return (f'' + f'' + f'' + f'' + f'{label}' + f'{value}\n') + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument("--tests-output", required=True) + parser.add_argument("--tests-coverage", required=True) + parser.add_argument("--bench-output", required=True) + parser.add_argument("--bench-coverage", required=True) + args = parser.parse_args() + test_output = pathlib.Path(args.tests_output).read_text() + tests = sum(map(int, re.findall(r"test result: ok\. (\d+) passed", test_output))) + if tests < 1: + raise SystemExit("no passing tests parsed") + current = bench_results(args.bench_output) + if not current or any(value <= 0 for value in current.values()): + raise SystemExit("microbenchmark result missing or zero") + base_path = pathlib.Path("badges/bench-baseline.json") + baseline = json.loads(base_path.read_text()) if base_path.exists() else {} + common = [name for name in current if name in baseline and baseline[name] > 0] + delta = (sum((baseline[name] - current[name]) / baseline[name] for name in common) + / len(common) * 100) if common else None + line_coverage = coverage(args.tests_coverage) + bench_coverage = coverage(args.bench_coverage) + loc = sum(len(path.read_text().splitlines()) for parent in (pathlib.Path("src"), pathlib.Path("ci")) + for path in parent.rglob("*") if path.suffix in (".rs", ".py", ".sh")) + lock = tomllib.loads(pathlib.Path("Cargo.lock").read_text()) + dependencies = sum(item["name"] != "alkane-os" for item in lock["package"]) + metrics = {"tests": tests, "line_coverage_pct": round(line_coverage, 1), + "bench_coverage_pct": round(bench_coverage, 1), + "bench_ns_per_op": current, "bench_improvement_pct": delta, + "lines_of_code": loc, "dependencies": dependencies, + "code_quality": "A", "license": "MIT"} + pathlib.Path("badges").mkdir(exist_ok=True) + pathlib.Path("badges/metrics.json").write_text(json.dumps(metrics, indent=2) + "\n") + badges = { + "tests": ("tests", str(tests), "#4c1"), + "coverage": ("coverage", f"{line_coverage:.1f}%", "#4c1" if line_coverage >= 80 else "#dfb317"), + "bench-coverage": ("bench coverage", f"{bench_coverage:.1f}%", "#4c1" if bench_coverage >= 80 else "#dfb317"), + "bench": ("bench", "baseline set" if delta is None else f"{delta:+.1f}% vs prev", "#007ec6"), + "loc": ("lines of code", compact(loc), "#007ec6"), + "dependencies": ("dependencies", str(dependencies), "#007ec6"), + "quality": ("code quality", "A", "#4c1"), + "license": ("license", "MIT", "#007ec6"), + } + for name, (label, value, color) in badges.items(): + pathlib.Path(f"badges/{name}.svg").write_text(svg(label, value, color)) + print(json.dumps(metrics)) + + +if __name__ == "__main__": + main()