Skip to content

docs(deploy_gate): correct the rule-5 companion-test count - #411

Merged
argszero merged 1 commit into
mainfrom
docs/deploy-gate-rule-5-test-count
Oct 16, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/deploy-gate-rule-5-test-count

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Rule 5 of the deploy gate (the quick-start must hand the master key to compose) has four companion tests in src/deploy_gate.rs, but the rule's module note says three. This corrects the count and names the fourth role.

Rule 4 genuinely has three, and its note carries the same sentence word for word — so this line was copied from there and the count never moved with it. The count was wrong when it was written: 8cb559a8 (#338) added all four tests and this sentence in the same commit.

The fourth test is the arming guard (the_quickstart_rule_is_armed_on_the_live_compose). It asserts that compose still marks ATP_MASTER_KEY as required, which is what keeps the axis test from passing vacuously on a rule whose trigger has been switched off.

Related Issue

(none — found by this repository's own comment-claim review)

Changes

  • src/deploy_gate.rs: the rule-5 note now reads "four tests (axis + positive control + rule tooth + arming guard)", and the line is re-wrapped to stay inside the file's comment width
  • no configuration or data-structure change

Tests

  • cargo test — 562 passed, 0 failed
  • cargo fmt --check — clean
  • cargo clippy --all-targets -- -D warnings — clean
  • new tests: not applicable — the change is a comment inside a #[cfg(test)]-only module (src/main.rs:48-49), so no behaviour is touched

Checklist

  • branch name follows the convention (docs/…)
  • commit message uses Conventional Commits
  • single responsibility, minimal change (1 file, +2/−1)

Rule 5 (the quick-start must hand the master key to compose) has four
companion tests in this file, not three: the axis test, the positive
control, the rule tooth, and the arming guard. The module note claimed
"three (axis + positive control + rule tooth)".

Rule 4 does have exactly three, and its note carries the same sentence
word for word, so this line was copied from there and the count never
moved with it.

The count was wrong when it was written: 8cb559a (#338) added all four
tests and this sentence in the same commit.

The arming guard is the fourth test. It asserts that compose still marks
ATP_MASTER_KEY as required, so the axis test cannot pass vacuously on a
rule whose trigger has been switched off.
@argszero
argszero merged commit 8e336c2 into main Oct 16, 2026
2 checks passed
@argszero
argszero deleted the docs/deploy-gate-rule-5-test-count branch October 16, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant