ci+quality: structural gates (CI: 3 new; local: 7 new + .clang-tidy)
CI gates (active on every PR via .gitea/workflows/)
───────────────────────────────────────────────────
1. test-count consistency
cpp-tests.yml gains a step after test-cgal that runs
`scripts/check-test-counts.sh` against the just-built ./build dir
(reuse via new BUILD_DIR env var, ~5 s overhead). Drift between
`doc/api/tests.md` and ctest reality now fails the PR.
2. End-to-end smoke
`scripts/try_it.sh` (the documented user quick-start) is now part of
the CGAL job, so README quick-start regressions fail the PR rather
than silently breaking when users land.
3. Internal markdown link checker
New `.gitea/workflows/markdown-links.yml` + `scripts/check-markdown
-links.py`. PRs that touch any *.md file run the check; main pushes
trigger it too; a weekly cron catches external link rot. Pure
Python, no third-party action. Validated against the current tree:
122 internal links across 37 *.md files, 0 broken.
Local quality scripts (`scripts/quality/`, not in CI)
─────────────────────────────────────────────────────
* `license-headers.sh` — `SPDX-License-Identifier: MIT` audit over
code/{include,src,tests}/. Currently
reports 60/66 files missing it — that's
a follow-up; the script captures the
structural gap.
* `sanitizers.sh` — ASan + UBSan over the fast test suite.
* `coverage.sh` — gcov/lcov line + branch coverage of
code/include/, HTML report under
build-coverage/lcov-html/.
* `clang-tidy.sh` — runs the curated `.clang-tidy` policy over
every public header.
* `multi-compiler.sh` — sequential build + test against every
detected g++/clang++ (auto-discovery or
explicit list).
* `cgal-version-matrix.sh`— sequential build + CGAL test suite against
every CGAL tree under `~/cgal/<ver>/` (or
via `CGAL_ROOTS=...` env var).
* `reproducible-build.sh`— two `Release -j1` builds, fail if any test
executable byte-differs.
* `run-all.sh` — driver: `--fast` for the ~5-min subset,
no arg for the ~25–40 min full sweep;
captures per-gate logs to
build-quality-logs/.
+ `.clang-tidy` — curated, deliberately-small policy (only
checks that fire on OUR code, never on
transitive CGAL/Eigen/Boost headers).
+ `scripts/quality/README.md` — explains the structure, lists each
gate's wall-time + prereqs, and codifies
the promotion path: a gate moves into CI
only when it's green on the dev machine
AND has a recovery-instructions paragraph
in `doc/release-policy.md`.
Doc updates
───────────
`doc/architecture/locked-vs-flexible.md` (reviewer-facing) gains 4
"closed" rows in the limitations table — the 3 CI gates above and the
local quality-script suite.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
123
scripts/quality/cgal-version-matrix.sh
Executable file
123
scripts/quality/cgal-version-matrix.sh
Executable file
@@ -0,0 +1,123 @@
|
||||
#!/usr/bin/env bash
|
||||
# scripts/quality/cgal-version-matrix.sh
|
||||
#
|
||||
# Build and test the CGAL test suite against multiple CGAL versions in
|
||||
# sequence. Catches:
|
||||
# * upstream API drift between minor CGAL releases (5.x vs 6.x)
|
||||
# * Surface_mesh / Polyhedron_3 trait-class changes
|
||||
# * deprecated CGAL macros we still rely on
|
||||
#
|
||||
# Local-only. The script expects each CGAL version to live under
|
||||
# `~/cgal/<version>/` (override with CGAL_ROOTS env var as a colon-list).
|
||||
# If the directory tree is missing it prints the expected layout and
|
||||
# exits 2 — it does not download anything (that would belong in a Docker
|
||||
# image, see .gitea/docker/Dockerfile.ci-cpp).
|
||||
#
|
||||
# Usage:
|
||||
# bash scripts/quality/cgal-version-matrix.sh
|
||||
# CGAL_ROOTS=/opt/cgal-5.6:/opt/cgal-6.0 bash scripts/quality/cgal-version-matrix.sh
|
||||
#
|
||||
# Exit codes:
|
||||
# 0 every requested CGAL version builds + tests cleanly
|
||||
# 1 at least one version failed
|
||||
# 2 no CGAL roots found
|
||||
|
||||
set -euo pipefail
|
||||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
cd "$ROOT"
|
||||
|
||||
# ── Discover CGAL installs ──────────────────────────────────────────────────
|
||||
DEFAULT_ROOTS="$HOME/cgal/5.6:$HOME/cgal/6.0:$HOME/cgal/6.1:/opt/cgal-5.6:/opt/cgal-6.0"
|
||||
ROOTS="${CGAL_ROOTS:-$DEFAULT_ROOTS}"
|
||||
|
||||
# Collect existing paths.
|
||||
AVAILABLE=""
|
||||
OLD_IFS="$IFS"
|
||||
IFS=":"
|
||||
for r in $ROOTS; do
|
||||
if [ -f "$r/cmake/modules/UseCGAL.cmake" ] || [ -f "$r/include/CGAL/version.h" ] || [ -f "$r/CMakeLists.txt" ]; then
|
||||
AVAILABLE="${AVAILABLE}${r}
|
||||
"
|
||||
fi
|
||||
done
|
||||
IFS="$OLD_IFS"
|
||||
|
||||
if [ -z "$AVAILABLE" ]; then
|
||||
cat >&2 <<EOF
|
||||
FAIL: no CGAL installs found.
|
||||
|
||||
Searched: $ROOTS
|
||||
|
||||
Expected layout for each version (any one of these is enough):
|
||||
<root>/include/CGAL/version.h
|
||||
<root>/cmake/modules/UseCGAL.cmake
|
||||
<root>/CMakeLists.txt
|
||||
|
||||
Recovery (one-time, on the dev machine):
|
||||
cd ~/cgal && wget https://github.com/CGAL/cgal/archive/refs/tags/v5.6.tar.gz
|
||||
tar xf v5.6.tar.gz && mv cgal-5.6 5.6
|
||||
# repeat for v6.0, v6.1
|
||||
|
||||
Then re-run:
|
||||
bash scripts/quality/cgal-version-matrix.sh
|
||||
|
||||
Or override the lookup path:
|
||||
CGAL_ROOTS=/opt/cgal-5.6:/opt/cgal-6.0 bash scripts/quality/cgal-version-matrix.sh
|
||||
EOF
|
||||
exit 2
|
||||
fi
|
||||
|
||||
echo "========================================"
|
||||
echo " CGAL version matrix"
|
||||
echo " versions tested:"
|
||||
echo "$AVAILABLE" | sed 's/^/ /'
|
||||
echo "========================================"
|
||||
|
||||
overall=0
|
||||
echo "$AVAILABLE" | while IFS= read -r cgal_root; do
|
||||
[ -z "$cgal_root" ] && continue
|
||||
ver="$(basename "$cgal_root")"
|
||||
build="build-cgal-$ver"
|
||||
echo
|
||||
echo "── CGAL $ver ─────────────────────────────"
|
||||
echo " root: $cgal_root"
|
||||
echo " build: $build"
|
||||
|
||||
if ! cmake -S code -B "$build" \
|
||||
-DCGAL_DIR="$cgal_root" \
|
||||
-DWITH_CGAL_TESTS=ON \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-Wno-dev >/dev/null 2>&1; then
|
||||
echo " CONFIGURE FAILED"
|
||||
echo "$ver" >> "$ROOT/.cgal-matrix-failures"
|
||||
continue
|
||||
fi
|
||||
|
||||
if ! nice -n 19 cmake --build "$build" --target conformallab_cgal_tests \
|
||||
-j1 >"$build/build.log" 2>&1; then
|
||||
echo " BUILD FAILED — see $build/build.log"
|
||||
echo "$ver" >> "$ROOT/.cgal-matrix-failures"
|
||||
continue
|
||||
fi
|
||||
|
||||
if ! ( cd "$build" && ctest -R "^cgal\." --output-on-failure >"test.log" 2>&1 ); then
|
||||
echo " TESTS FAILED — see $build/test.log"
|
||||
echo "$ver" >> "$ROOT/.cgal-matrix-failures"
|
||||
continue
|
||||
fi
|
||||
|
||||
pass=$(grep -oE "tests passed.*out of [0-9]+" "$build/test.log" | head -1)
|
||||
echo " OK ($pass)"
|
||||
done
|
||||
|
||||
if [ -f "$ROOT/.cgal-matrix-failures" ]; then
|
||||
echo
|
||||
echo "FAIL: the following CGAL versions did not pass:"
|
||||
sed 's/^/ /' "$ROOT/.cgal-matrix-failures"
|
||||
rm -f "$ROOT/.cgal-matrix-failures"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo
|
||||
echo "OK: every detected CGAL version built + passed the CGAL test suite."
|
||||
exit 0
|
||||
Reference in New Issue
Block a user