Repository navigation
docs(deploy_gate): correct the rule-5 companion-test count - #411
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 marksATP_MASTER_KEYas 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 widthTests
cargo test— 562 passed, 0 failedcargo fmt --check— cleancargo clippy --all-targets -- -D warnings— clean#[cfg(test)]-only module (src/main.rs:48-49), so no behaviour is touchedChecklist
docs/…)