Skip to content

fix(qa): enforce semver gate post-1.0 + count unwraps after inline cfg(test) (#2002) #2012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heyong4725 merged 2 commits into from
Jun 3, 2026
Merged

fix(qa): enforce semver gate post-1.0 + count unwraps after inline cfg(test) (#2002) #2012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68aa99a
fix(qa): enforce semver gate post-1.0 + count unwraps after inline cf…
heyong4725 Jun 3, 2026
70275a9
fix(qa): handle one-line #[cfg(test)] items in unwrap-budget parser
heyong4725 Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions scripts/qa/semver.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,20 @@ done

if [[ "$FAILED" == "1" ]]; then
echo
echo "SemVer check found breaking changes."
echo "During 0.x this is a warning. After 1.0 this will be a hard fail."
# Soft warning during 0.x — exit 0 even on breaks
exit 0
# Soft warning during 0.x; hard gate once the workspace hits 1.0 (API
# stability is the 1.0 promise). Read the workspace version from the root
# Cargo.toml ([workspace.package] version).
WORKSPACE_VERSION=$(awk -F'"' '/^version = /{print $2; exit}' Cargo.toml)
echo "SemVer check found breaking changes (workspace version: ${WORKSPACE_VERSION:-unknown})."
case "$WORKSPACE_VERSION" in
0.*|"")
echo "During 0.x this is a soft warning (exit 0)."
exit 0
;;
*)
echo "Post-1.0: breaking changes are a hard failure. Bump the major"
echo "version or revert the breaking change."
exit 1
;;
esac
fi
51 changes: 40 additions & 11 deletions scripts/qa/unwrap-budget.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@
# `#[cfg(test)] mod tests;` from a sibling source file — the file
# content does not carry the cfg(test) attribute but the whole
# file is test-only)
# 3. Content after the first `#[cfg(test)]` line in any remaining
# source file (inline `mod tests {}` blocks at the bottom of a
# source file — dora's convention)
# 3. Each `#[cfg(test)]`-attributed item (the brace-balanced `mod`/`fn`/
# `impl` block that follows the attribute) — inline test modules and
# test helpers anywhere in a source file, not just at EOF.
#
# Rule 3 uses simple line-based truncation, which works because dora
# consistently places `#[cfg(test)]` only at the top of a test module
# and only at the end of source files. Verified 2026-04-08 by grep —
# if this convention changes, this script must be updated.
# Rule 3 brace-balances each `#[cfg(test)]` block instead of truncating to
# EOF, so production code that follows an interspersed test block (e.g. a
# `#[cfg(test)]` helper fn before more production fns, as in
# binaries/cli/src/output.rs) is still counted. All `#[cfg(test)]` items in
# the counted source are brace blocks (mod/fn/impl); brace-less attributed
# items (`#[cfg(test)] use ...;`) do not occur and are not handled.

set -euo pipefail

Expand All @@ -36,8 +38,8 @@ fi
# Count unwrap/expect in non-test source code. Three steps:
# 1. Enumerate candidate .rs files (excluding tests/, examples/, build.rs)
# 2. Drop files named tests.rs (submodule test files)
# 3. For each remaining file, strip content from the first #[cfg(test)]
# line to EOF, then count .unwrap() / .expect( occurrences.
# 3. For each remaining file, skip each #[cfg(test)] brace-balanced block
# (mod/fn/impl) and count .unwrap() / .expect( in the rest.
count_unwraps() {
local total=0
local file
Expand All @@ -46,10 +48,37 @@ count_unwraps() {
case "$file" in
*/tests.rs) continue ;;
esac
# Rule 3: truncate at first #[cfg(test)] line, count unwraps in head
# Rule 3: skip each #[cfg(test)] block, count unwrap/expect in the rest.
# A MULTI-LINE block opener ends with `{` (rustfmt puts the opening brace
# last); its matching close is the only `}` DEDENTED back to the attribute
# indent. We key off dedent + the trailing-`{`, not raw brace counting,
# because counting `{`/`}` miscounts braces inside string literals and
# `format!("{}")` macros that pepper test code. A SELF-CONTAINED one-line
# item (`#[cfg(test)] fn helper() {}` or a `mod tests;` decl) is fully on
# one line and is skipped without entering block mode, so production code
# after it is still counted.
local n
n=$(awk '
/^[[:space:]]*#\[cfg\(test\)\]/ { exit }
# Inside a multi-line test block: ends at a `}` dedented to its indent.
in_test {
if ($0 ~ ("^" ind "[}]")) in_test = 0
next
}
# Saw #[cfg(test)] with the item on later line(s): skip signature lines
# until the opener ends with `{` (enter block), or the item resolves on a
# single line (one-line `{...}` body, or a `;`-terminated decl).
awaiting {
if ($0 ~ /\{[[:space:]]*$/) { awaiting = 0; in_test = 1 }
else if ($0 ~ /[{};]/) awaiting = 0
next
}
/^[[:space:]]*#\[cfg\(test\)\]/ {
ind = $0; sub(/[^ \t].*/, "", ind) # leading whitespace = indent
if ($0 ~ /\{[[:space:]]*$/) in_test = 1 # multi-line block opener
else if ($0 !~ /[{]/) awaiting = 1 # brace is on a later line
# else: self-contained one-line `{...}` item -> skip just this line
next
}
{
n = gsub(/\.unwrap\(\)|\.expect\(/, "&")
if (n > 0) count += n
Expand Down