Skip to content

Commit be8f24a

Browse files
committed
docs(qbft): fix test documentation placement
- Move doc comments above #[test] attributes for proper documentation - Convert // comments to /// doc comments for test functions - Ensure consistent documentation style across all tests
1 parent 9997054 commit be8f24a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

anchor/common/qbft/src/tests.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ impl<D: QbftData<Hash = Hash256>, S: FnMut(UnsignedWrappedQbftMessage)> TestQBFT
188188
}
189189
}
190190

191+
/// Construct and run a test committee
191192
#[test]
192-
// Construct and run a test committee
193193
fn test_basic_committee() {
194194
let test_instance = TestQBFTCommitteeBuilder::default().run(TestData(21));
195195

@@ -198,8 +198,8 @@ fn test_basic_committee() {
198198
assert!(num_consensus == 5);
199199
}
200200

201+
/// Test consensus recovery with F faulty operators
201202
#[test]
202-
// Test consensus recovery with F faulty operators
203203
fn test_consensus_with_f_faulty_operators() {
204204
let mut test_instance = TestQBFTCommitteeBuilder::default().run(TestData(21));
205205

@@ -224,13 +224,13 @@ fn test_node_recovery() {
224224
assert_eq!(num_consensus, 5); // Should reach full consensus after recovery
225225
}
226226

227-
#[test]
228227
/// Test that FAILS if round change validation doesn't require prepare justifications for
229228
/// data_round=1
230229
///
231230
/// This test creates a proposal with round change messages claiming preparation in round 1
232231
/// (data_round=1) but provides NO prepare justifications.
233232
/// The test FAILS if the validation doesn't reject the proposal as it should.
233+
#[test]
234234
fn test_round_change_validation_skips_round_one_prepared_values() {
235235
if ENABLE_TEST_LOGGING {
236236
let env_filter = EnvFilter::new("debug");
@@ -357,7 +357,6 @@ fn test_round_change_validation_skips_round_one_prepared_values() {
357357
);
358358
}
359359

360-
#[test]
361360
/// Test that verifies QBFT rejects round change messages with invalid justification patterns
362361
///
363362
/// This test verifies the fix for a critical consensus vulnerability where malicious nodes
@@ -369,6 +368,7 @@ fn test_round_change_validation_skips_round_one_prepared_values() {
369368
///
370369
/// This prevents malicious nodes from injecting unvalidated prepare messages that bypass
371370
/// consensus safety checks by claiming no preparation while including justifications.
371+
#[test]
372372
fn test_round_change_justification_validation_vulnerability_fix() {
373373
if ENABLE_TEST_LOGGING {
374374
let env_filter = EnvFilter::new("debug");

0 commit comments

Comments
 (0)