Add more robust functional test of Listen::blocks_disconnected

Now that the `Listen` interface allows blocks to be disconnected in
batches rather than one at a time, we should test this. Here we add
a new `ConnectStyle` for the functional test framework which tests
doing so.

Author: TheBlueMatt

lightning/src/ln/functional_test_utils.rs

@@ -197,6 +197,9 @@ pub enum ConnectStyle {
 	/// Provides the full block via the `chain::Listen` interface. In the current code this is
 	/// equivalent to `TransactionsFirst` with some additional assertions.
 	FullBlockViaListen,
+	/// Provides the full block via the `chain::Listen` interface, condensing multiple block
+	/// disconnections into a single `blocks_disconnected` call.
+	FullBlockDisconnectionsSkippingViaListen,
 }
 
 impl ConnectStyle {
@@ -211,6 +214,7 @@ impl ConnectStyle {
 			ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
 			ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
 			ConnectStyle::FullBlockViaListen => false,
+			ConnectStyle::FullBlockDisconnectionsSkippingViaListen => false,
 		}
 	}
 
@@ -225,14 +229,15 @@ impl ConnectStyle {
 			ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
 			ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
 			ConnectStyle::FullBlockViaListen => false,
+			ConnectStyle::FullBlockDisconnectionsSkippingViaListen => false,
 		}
 	}
 
 	fn random_style() -> ConnectStyle {
 		use core::hash::{BuildHasher, Hasher};
 		// Get a random value using the only std API to do so - the DefaultHasher
 		let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
-		let res = match rand_val % 9 {
+		let res = match rand_val % 10 {
 			0 => ConnectStyle::BestBlockFirst,
 			1 => ConnectStyle::BestBlockFirstSkippingBlocks,
 			2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
@@ -242,6 +247,7 @@ impl ConnectStyle {
 			6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
 			7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
 			8 => ConnectStyle::FullBlockViaListen,
+			9 => ConnectStyle::FullBlockDisconnectionsSkippingViaListen,
 			_ => unreachable!(),
 		};
 		eprintln!("Using Block Connection Style: {:?}", res);
@@ -372,7 +378,8 @@ fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(
 				node.node.transactions_confirmed(&block.header, &txdata, height);
 				node.node.best_block_updated(&block.header, height);
 			},
-			ConnectStyle::FullBlockViaListen => {
+			ConnectStyle::FullBlockViaListen
+			| ConnectStyle::FullBlockDisconnectionsSkippingViaListen => {
 				node.chain_monitor.chain_monitor.block_connected(&block, height);
 				node.node.block_connected(&block, height);
 			},
@@ -433,6 +440,13 @@ pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32)
 				node.chain_monitor.chain_monitor.blocks_disconnected(best_block);
 				Listen::blocks_disconnected(node.node, best_block);
 			},
+			ConnectStyle::FullBlockDisconnectionsSkippingViaListen => {
+				if i == count - 1 {
+					let best_block = BestBlock::new(orig.0.header.prev_blockhash, orig.1 - 1);
+					node.chain_monitor.chain_monitor.blocks_disconnected(best_block);
+					Listen::blocks_disconnected(node.node, best_block);
+				}
+			},
 			ConnectStyle::BestBlockFirstSkippingBlocks
 			| ConnectStyle::TransactionsFirstSkippingBlocks
 			| ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks

lightning/src/ln/functional_tests.rs

@@ -2721,11 +2721,15 @@ pub fn test_htlc_ignore_latest_remote_commitment() {
 	let node_a_id = nodes[0].node.get_our_node_id();
 	let node_b_id = nodes[1].node.get_our_node_id();
 
-	if *nodes[1].connect_style.borrow() == ConnectStyle::FullBlockViaListen {
-		// We rely on the ability to connect a block redundantly, which isn't allowed via
-		// `chain::Listen`, so we never run the test if we randomly get assigned that
-		// connect_style.
-		return;
+	match *nodes[1].connect_style.borrow() {
+		ConnectStyle::FullBlockViaListen
+		| ConnectStyle::FullBlockDisconnectionsSkippingViaListen => {
+			// We rely on the ability to connect a block redundantly, which isn't allowed via
+			// `chain::Listen`, so we never run the test if we randomly get assigned that
+			// connect_style.
+			return;
+		},
+		_ => {},
 	}
 	let funding_tx = create_announced_chan_between_nodes(&nodes, 0, 1).3;
 	let message = "Channel force-closed".to_owned();