f Refactor expect..and_htlc_handling_failed macro

Author: tnull

lightning-dns-resolver/src/lib.rs

@@ -179,10 +179,7 @@ mod test {
 	use lightning::types::payment::PaymentHash;
 	use lightning::util::logger::Logger;
 
-	use lightning::{
-		commitment_signed_dance, expect_payment_claimed,
-		get_htlc_update_msgs,
-	};
+	use lightning::{commitment_signed_dance, expect_payment_claimed, get_htlc_update_msgs};
 	use lightning_types::string::UntrustedString;
 
 	use std::ops::Deref;

lightning/src/ln/chanmon_update_fail_tests.rs

@@ -975,9 +975,9 @@ fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
 
 	// Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
 	nodes[2].node.fail_htlc_backwards(&payment_hash_1);
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		nodes[2],
-		[HTLCHandlingFailureType::Receive { payment_hash: payment_hash_1 }]
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&nodes[2],
+		&[HTLCHandlingFailureType::Receive { payment_hash: payment_hash_1 }],
 	);
 	check_added_monitors!(nodes[2], 1);
 
@@ -1067,9 +1067,9 @@ fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
 	let (latest_update, _) = get_latest_mon_update_id(&nodes[1], chan_2.2);
 	nodes[1].chain_monitor.chain_monitor.force_channel_monitor_updated(chan_2.2, latest_update);
 	check_added_monitors!(nodes[1], 0);
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		nodes[1],
-		[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_2.2 }]
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&nodes[1],
+		&[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_2.2 }],
 	);
 	check_added_monitors!(nodes[1], 1);
 
@@ -1973,9 +1973,9 @@ fn test_monitor_update_on_pending_forwards() {
 
 	let (_, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
 	nodes[2].node.fail_htlc_backwards(&payment_hash_1);
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		nodes[2],
-		[HTLCHandlingFailureType::Receive { payment_hash: payment_hash_1 }]
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&nodes[2],
+		&[HTLCHandlingFailureType::Receive { payment_hash: payment_hash_1 }],
 	);
 	check_added_monitors!(nodes[2], 1);
 
@@ -1998,9 +1998,9 @@ fn test_monitor_update_on_pending_forwards() {
 	commitment_signed_dance!(nodes[1], nodes[2], payment_event.commitment_msg, false);
 
 	chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		nodes[1],
-		[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_2.2 }]
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&nodes[1],
+		&[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_2.2 }],
 	);
 	check_added_monitors!(nodes[1], 1);
 
@@ -2501,9 +2501,9 @@ fn test_fail_htlc_on_broadcast_after_claim() {
 	check_closed_broadcast!(nodes[1], true);
 	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 	check_added_monitors!(nodes[1], 1);
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		nodes[1],
-		[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_id_2 }]
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&nodes[1],
+		&[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_id_2 }],
 	);
 
 	nodes[0].node.handle_update_fulfill_htlc(node_b_id, &bs_updates.update_fulfill_htlcs[0]);
@@ -2887,9 +2887,9 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 		msgs::UpdateFulfillHTLC { channel_id: chan_id_2, htlc_id: 0, payment_preimage };
 	if second_fails {
 		nodes[2].node.fail_htlc_backwards(&payment_hash);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-			nodes[2],
-			[HTLCHandlingFailureType::Receive { payment_hash }]
+		expect_pending_htlc_processing_and_htlc_handling_failed(
+			&nodes[2],
+			&[HTLCHandlingFailureType::Receive { payment_hash }],
 		);
 		check_added_monitors!(nodes[2], 1);
 		get_htlc_update_msgs!(nodes[2], node_b_id);
@@ -2936,9 +2936,9 @@ fn do_test_reconnect_dup_htlc_claims(htlc_status: HTLCStatusAtDupClaim, second_f
 		let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
 		reconnect_args.pending_htlc_fails.0 = 1;
 		reconnect_nodes(reconnect_args);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-			nodes[1],
-			[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_id_2 }]
+		expect_pending_htlc_processing_and_htlc_handling_failed(
+			&nodes[1],
+			&[HTLCHandlingFailureType::Forward { node_id: Some(node_c_id), channel_id: chan_id_2 }],
 		);
 	} else {
 		let mut reconnect_args = ReconnectArgs::new(&nodes[1], &nodes[2]);

lightning/src/ln/channelmanager.rs

@@ -16915,7 +16915,9 @@ mod tests {
 		check_added_monitors!(nodes[1], 0);
 		commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 		expect_pending_htlc_processing(&nodes[1], true);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCHandlingFailureType::Receive { payment_hash: our_payment_hash }]);
+		let events = nodes[1].node.get_and_clear_pending_events();
+		let fail = HTLCHandlingFailureType::Receive { payment_hash: our_payment_hash };
+		expect_pending_htlcs_forwardable_conditions(events, &[fail]);
 		check_added_monitors!(nodes[1], 1);
 		let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 		assert!(updates.update_add_htlcs.is_empty());
@@ -17135,7 +17137,9 @@ mod tests {
 		// We have to forward pending HTLCs twice - once tries to forward the payment forward (and
 		// fails), the second will process the resulting failure and fail the HTLC backward
 		expect_pending_htlc_processing(&nodes[1], true);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCHandlingFailureType::Receive { payment_hash }]);
+		let events = nodes[1].node.get_and_clear_pending_events();
+		let fail = HTLCHandlingFailureType::Receive { payment_hash };
+		expect_pending_htlcs_forwardable_conditions(events, &[fail]);
 		nodes[1].node.get_and_clear_pending_events();
 		check_added_monitors!(nodes[1], 1);
 		let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
@@ -17181,7 +17185,9 @@ mod tests {
 		check_added_monitors!(nodes[1], 0);
 		commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 		expect_pending_htlc_processing(&nodes[1], true);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCHandlingFailureType::Receive { payment_hash }]);
+		let events = nodes[1].node.get_and_clear_pending_events();
+		let fail = HTLCHandlingFailureType::Receive { payment_hash };
+		expect_pending_htlcs_forwardable_conditions(events, &[fail]);
 		check_added_monitors!(nodes[1], 1);
 		let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 		assert!(updates.update_add_htlcs.is_empty());
@@ -17228,7 +17234,9 @@ mod tests {
 		check_added_monitors!(nodes[1], 0);
 		commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
 		expect_pending_htlc_processing(&nodes[1], true);
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCHandlingFailureType::Receive { payment_hash }]);
+		let events = nodes[1].node.get_and_clear_pending_events();
+		let fail = HTLCHandlingFailureType::Receive { payment_hash };
+		expect_pending_htlcs_forwardable_conditions(events, &[fail]);
 		check_added_monitors!(nodes[1], 1);
 		let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 		assert!(updates.update_add_htlcs.is_empty());

lightning/src/ln/functional_test_utils.rs

@@ -2385,23 +2385,16 @@ pub fn expect_pending_htlcs_forwardable_conditions(
 	}
 }
 
-#[macro_export]
-/// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
-macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
-	($node: expr, $expected_failures: expr) => {{
-		$crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions(
-			$node.node.get_and_clear_pending_events(),
-			&$expected_failures,
-		);
-		$node.node.process_pending_htlc_forwards();
-
-		// Ensure process_pending_htlc_forwards is idempotent.
-		$node.node.process_pending_htlc_forwards();
-	}};
+pub fn expect_pending_htlc_processing_and_htlc_handling_failed(
+	node: &Node<'_, '_, '_>, expected_failures: &[HTLCHandlingFailureType],
+) {
+	let events = node.node.get_and_clear_pending_events();
+	expect_pending_htlcs_forwardable_conditions(events, expected_failures);
+	expect_pending_htlc_processing(node, false);
+	assert!(node.node.get_and_clear_pending_events().is_empty());
 }
 
-pub fn expect_pending_htlc_processing(node: &Node<'_, '_, '_>, process_twice: bool)
-{
+pub fn expect_pending_htlc_processing(node: &Node<'_, '_, '_>, process_twice: bool) {
 	assert!(node.node.is_pending_htlc_processing());
 	node.node.process_pending_htlc_forwards();
 	if process_twice {
@@ -2413,7 +2406,6 @@ pub fn expect_pending_htlc_processing(node: &Node<'_, '_, '_>, process_twice: bo
 	assert!(!node.node.is_pending_htlc_processing());
 }
 
-
 #[macro_export]
 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
 /// commitment update.
@@ -2561,12 +2553,12 @@ pub fn do_commitment_signed_dance(
 	}
 
 	if fail_backwards {
-		expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-			node_a,
-			[crate::events::HTLCHandlingFailureType::Forward {
+		expect_pending_htlc_processing_and_htlc_handling_failed(
+			&node_a,
+			&[crate::events::HTLCHandlingFailureType::Forward {
 				node_id: Some(node_b_id),
-				channel_id
-			}]
+				channel_id,
+			}],
 		);
 		check_added_monitors!(node_a, 1);
 
@@ -3924,9 +3916,9 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(
 		repeat(HTLCHandlingFailureType::Receive { payment_hash: our_payment_hash })
 			.take(expected_paths.len())
 			.collect();
-	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-		expected_paths[0].last().unwrap(),
-		expected_destinations
+	expect_pending_htlc_processing_and_htlc_handling_failed(
+		&expected_paths[0].last().unwrap(),
+		&expected_destinations,
 	);
 
 	pass_failed_payment_back(
@@ -4006,12 +3998,12 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(
 					update_next_node
 				);
 				if !update_next_node {
-					expect_pending_htlcs_forwardable_and_htlc_handling_failed!(
-						node,
-						[HTLCHandlingFailureType::Forward {
+					expect_pending_htlc_processing_and_htlc_handling_failed(
+						&node,
+						&[HTLCHandlingFailureType::Forward {
 							node_id: Some(prev_node.node.get_our_node_id()),
-							channel_id: next_msgs.as_ref().unwrap().0.channel_id
-						}]
+							channel_id: next_msgs.as_ref().unwrap().0.channel_id,
+						}],
 					);
 				}
 			}