ci: add new test to CI, comment for test

Author: kantai

.github/workflows/bitcoin-tests.yml

@@ -93,6 +93,7 @@ jobs:
           - tests::signer::v0::bitcoind_forking_test
           - tests::signer::v0::multiple_miners
           - tests::signer::v0::mock_sign_epoch_25
+          - tests::signer::v0::miner_forking
           - tests::nakamoto_integrations::stack_stx_burn_op_integration_test
           - tests::nakamoto_integrations::check_block_heights
           - tests::nakamoto_integrations::clarity_burn_state

testnet/stacks-node/src/tests/signer/v0.rs

@@ -1372,6 +1372,16 @@ fn get_nakamoto_headers(config: &Config) -> Vec<StacksHeaderInfo> {
 
 #[test]
 #[ignore]
+// Test two nakamoto miners, with the signer set split between them.
+//  One of the miners (run-loop-2) is prevented from submitting "good" block commits
+//  using the "commit stall" test flag in combination with "block broadcast stalls".
+//  (Because RL2 isn't able to RBF their initial commits after the tip is broadcasted).
+// This test works by tracking two different scenarios:
+//   1. RL2 must win a sortition that this block commit behavior would lead to a fork in.
+//   2. After such a sortition, RL1 must win another block.
+// The test asserts that every nakamoto sortition either has a successful tenure, or if
+//  RL2 wins and they would be expected to fork, no blocks are produced. The test asserts
+//  that every block produced increments the chain length.
 fn miner_forking() {
     if env::var("BITCOIND_TEST") != Ok("1".into()) {
         return;