fader_master/scripts/test-ci.sh

244 lines
10 KiB
Bash
Executable File

#!/bin/sh
set -eu
repository=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
workspace=$(mktemp -d "${TMPDIR:-/tmp}/fader-master-ci-tests.XXXXXX")
trap 'rm -rf "$workspace"' EXIT HUP INT TERM
fail() {
echo "FAIL: $*" >&2
exit 1
}
assert_contains() {
file=$1
expected=$2
grep -F "$expected" "$file" >/dev/null || fail "$file does not contain: $expected"
}
assert_fails() {
if "$@" >/dev/null 2>&1; then
fail "command unexpectedly succeeded: $*"
fi
}
file_mode() {
if stat -c '%a' "$1" >/dev/null 2>&1; then
stat -c '%a' "$1"
else
stat -f '%Lp' "$1"
fi
}
assert_contains "$repository/Jenkinsfile" "name: 'ENABLE_NATIVE_BACKENDS'"
assert_contains "$repository/Jenkinsfile" 'defaultValue: false'
assert_contains "$repository/Jenkinsfile" 'ENABLE_NATIVE_BACKENDS = "${params.ENABLE_NATIVE_BACKENDS ?: false}"'
assert_contains "$repository/Jenkinsfile" "stage('Portable Rust Gates')"
assert_contains "$repository/Jenkinsfile" '!params.ENABLE_NATIVE_BACKENDS'
assert_contains "$repository/Jenkinsfile" 'params.ENABLE_NATIVE_BACKENDS'
assert_contains "$repository/Jenkinsfile" 'cargo test -p fader-core -p fader-config -p midi -p volume_lib -p tui'
svg_count() {
directory=$1
count=0
for candidate in "$directory"/*.svg; do
if [ -e "$candidate" ] || [ -L "$candidate" ]; then
count=$((count + 1))
fi
done
printf '%s\n' "$count"
}
renderer="$repository/scripts/ci-coverage-badges.sh"
render_dir="$workspace/render"
mkdir "$render_dir"
"$renderer" version --value 0.1.0 --output "$render_dir/version.svg"
"$renderer" version --value 1234567890.1234567890-long-version --output "$render_dir/long-version.svg"
"$renderer" version --text 'release & build' --value '0.1.0 <rc>' --size 12 --height 24 \
--label-width 120 --value-width 100 --color '#8a2be2' --output "$render_dir/custom.svg"
"$renderer" test --value passing --output "$render_dir/passing.svg"
"$renderer" test --value failing --output "$render_dir/failing.svg"
"$renderer" test --value custom --output "$render_dir/custom-test.svg"
"$renderer" coverage --value 0 --output "$render_dir/red.svg"
"$renderer" coverage --value 70 --output "$render_dir/yellow.svg"
"$renderer" coverage --value 90 --output "$render_dir/green.svg"
"$renderer" coverage --value - --output "$render_dir/neutral.svg"
assert_contains "$render_dir/custom.svg" 'release &amp; build'
assert_contains "$render_dir/custom.svg" '0.1.0 &lt;rc&gt;'
assert_contains "$render_dir/passing.svg" '#4c1'
assert_contains "$render_dir/failing.svg" '#e05d44'
assert_contains "$render_dir/custom-test.svg" '#9f9f9f'
assert_contains "$render_dir/red.svg" '#e05d44'
assert_contains "$render_dir/yellow.svg" '#dfb317'
assert_contains "$render_dir/green.svg" '#4c1'
assert_contains "$render_dir/neutral.svg" '#9f9f9f'
python3 - "$render_dir" <<'PY'
import pathlib
import sys
import xml.etree.ElementTree as ET
for badge in pathlib.Path(sys.argv[1]).glob("*.svg"):
ET.parse(badge)
PY
printf 'keep\n' >"$render_dir/protected.svg"
assert_fails "$renderer" invalid --output "$render_dir/protected.svg"
assert_fails "$renderer" coverage --value 101 --output "$render_dir/protected.svg"
assert_fails "$renderer" version --value ok --size 5 --output "$render_dir/protected.svg"
assert_fails "$renderer" version --value ok --height 65 --output "$render_dir/protected.svg"
assert_fails "$renderer" version --value ok --label-width 19 --output "$render_dir/protected.svg"
assert_fails "$renderer" version --value ok --color red --output "$render_dir/protected.svg"
assert_fails "$renderer" version --value ok --unknown value --output "$render_dir/protected.svg"
[ "$(cat "$render_dir/protected.svg")" = keep ] || fail 'invalid rendering replaced an existing output'
fake_bin="$workspace/fake-bin"
mkdir "$fake_bin"
cat >"$fake_bin/cargo" <<'EOF'
#!/bin/sh
set -eu
output=
while [ "$#" -gt 0 ]; do
if [ "$1" = --output-path ]; then
output=$2
shift 2
else
shift
fi
done
if [ "${FAKE_REPORT:-valid}" = missing ]; then
exit "${FAKE_EXIT:-0}"
fi
if [ "${FAKE_REPORT:-valid}" = invalid ]; then
printf '%s\n' '{not-json' >"$output"
else
printf '{"data":[{"totals":{"lines":{"percent":%s}}}]}\n' "${FAKE_PERCENT:-80}" >"$output"
fi
exit "${FAKE_EXIT:-0}"
EOF
chmod +x "$fake_bin/cargo"
run_coverage_case() {
case_name=$1
percent=$2
tool_exit=$3
report_kind=$4
expected_exit=$5
case_dir="$workspace/coverage-$case_name"
mkdir "$case_dir"
if (
cd "$case_dir"
PATH="$fake_bin:$PATH" FAKE_PERCENT="$percent" FAKE_EXIT="$tool_exit" FAKE_REPORT="$report_kind" \
"$repository/scripts/ci-run-coverage.sh" 80 summary.json ready status.txt >output.txt 2>&1
); then
actual_exit=0
else
actual_exit=$?
fi
[ "$actual_exit" -eq "$expected_exit" ] || fail "$case_name returned $actual_exit, expected $expected_exit"
}
run_coverage_case above 80.01 0 valid 0
run_coverage_case exact 80 0 valid 0
run_coverage_case below 79.99 0 valid 1
run_coverage_case tool-failure 82 7 valid 7
run_coverage_case invalid 0 0 invalid 2
run_coverage_case missing 0 0 missing 1
for case_name in above exact below tool-failure; do
[ -f "$workspace/coverage-$case_name/ready" ] || fail "$case_name did not create its ready marker"
[ -s "$workspace/coverage-$case_name/coverage/coverage.svg" ] || fail "$case_name did not render coverage"
measurement_line=$(grep -n '^Line coverage:' "$workspace/coverage-$case_name/output.txt" | cut -d: -f1)
gate_line=$(grep -n '^Coverage gate:' "$workspace/coverage-$case_name/output.txt" | cut -d: -f1)
[ "$measurement_line" -lt "$gate_line" ] || fail "$case_name printed its decision before its measurement"
done
for case_name in invalid missing; do
[ ! -e "$workspace/coverage-$case_name/ready" ] || fail "$case_name created a ready marker"
assert_contains "$workspace/coverage-$case_name/status.txt" 'Line coverage: unavailable'
done
assert_contains "$workspace/coverage-below/output.txt" 'Coverage gate: FAIL (below required minimum)'
assert_contains "$workspace/coverage-tool-failure/output.txt" 'Coverage gate: FAIL (cargo llvm-cov exited 7)'
finalize_work="$workspace/finalize-work"
mkdir -p "$finalize_work/coverage"
cat >"$finalize_work/Cargo.toml" <<'EOF'
[workspace]
members = []
[workspace.package]
version = "1.2.3"
EOF
printf '<svg>stale</svg>\n' >"$finalize_work/coverage/coverage.svg"
: >"$finalize_work/coverage/.tests-passed-local"
(
cd "$finalize_work"
"$repository/scripts/ci-finalize-badges.sh" local
)
assert_contains "$finalize_work/coverage/coverage.svg" '#9f9f9f'
assert_contains "$finalize_work/coverage/test.svg" 'passing'
assert_contains "$finalize_work/coverage/version.svg" '1.2.3'
[ ! -e "$finalize_work/coverage/.tests-passed-local" ] || fail 'test marker survived finalization'
[ "$(svg_count "$finalize_work/coverage")" -eq 3 ] \
|| fail 'finalization did not leave exactly three SVG files'
printf '<svg>fresh measurement</svg>\n' >"$finalize_work/coverage/coverage.svg"
: >"$finalize_work/coverage/.coverage-ready-next"
(
cd "$finalize_work"
"$repository/scripts/ci-finalize-badges.sh" next
)
assert_contains "$finalize_work/coverage/coverage.svg" 'fresh measurement'
assert_contains "$finalize_work/coverage/test.svg" 'failing'
publish_work="$workspace/publish-work"
publish_root="$workspace/publish-root"
mkdir -p "$publish_work/coverage" "$publish_root"
for badge_name in coverage test version; do
printf '<svg>%s</svg>\n' "$badge_name" >"$publish_work/coverage/$badge_name.svg"
done
(
cd "$publish_work"
umask 077
"$repository/scripts/ci-publish-badges.sh" "$publish_root" MadGobblins fader_master main coverage test version
"$repository/scripts/ci-publish-badges.sh" "$publish_root" MadGobblins fader_master main coverage test version
)
destination="$publish_root/MadGobblins/fader_master/main"
[ "$(file_mode "$publish_root/MadGobblins")" = 755 ] || fail 'owner mode is not 0755'
[ "$(file_mode "$publish_root/MadGobblins/fader_master")" = 755 ] || fail 'project mode is not 0755'
[ "$(file_mode "$destination")" = 755 ] || fail 'branch mode is not 0755'
for badge_name in coverage test version; do
[ "$(file_mode "$destination/$badge_name.svg")" = 644 ] || fail "$badge_name mode is not 0644"
done
assert_fails sh -c "cd '$publish_work' && '$repository/scripts/ci-publish-badges.sh' '$publish_root' MadGobblins fader_master main coverage coverage"
assert_fails sh -c "cd '$publish_work' && '$repository/scripts/ci-publish-badges.sh' relative MadGobblins fader_master main coverage"
assert_fails sh -c "cd '$publish_work' && '$repository/scripts/ci-publish-badges.sh' '$publish_root' MadGobblins fader_master main unknown"
ln -s "$workspace/outside" "$publish_work/coverage/test.svg.link"
mv "$publish_work/coverage/test.svg" "$publish_work/coverage/test.svg.real"
ln -s test.svg.real "$publish_work/coverage/test.svg"
assert_fails sh -c "cd '$publish_work' && '$repository/scripts/ci-publish-badges.sh' '$publish_root' MadGobblins fader_master main test"
unlink "$publish_work/coverage/test.svg"
mv "$publish_work/coverage/test.svg.real" "$publish_work/coverage/test.svg"
symlink_root="$workspace/symlink-root"
mkdir "$symlink_root"
ln -s "$workspace/outside-owner" "$symlink_root/MadGobblins"
assert_fails sh -c "cd '$publish_work' && '$repository/scripts/ci-publish-badges.sh' '$symlink_root' MadGobblins fader_master main coverage"
migration_root="$workspace/migration-root"
old_target="$workspace/old-badges"
mkdir -p "$migration_root/MadGobblins/fader_master" "$old_target"
printf 'preserve\n' >"$old_target/sentinel"
ln -s "$old_target" "$migration_root/MadGobblins/fader_master/main"
(
cd "$publish_work"
"$repository/scripts/ci-publish-badges.sh" "$migration_root" MadGobblins fader_master main coverage test version
)
[ -f "$old_target/sentinel" ] || fail 'old symlink target was modified during migration'
[ -d "$migration_root/MadGobblins/fader_master/main" ] && [ ! -L "$migration_root/MadGobblins/fader_master/main" ] \
|| fail 'old default-branch symlink was not migrated safely'
echo 'CI script tests passed.'