Merge pull request #4425 from elnosh/remove-macro

Remove test util macros

Author: wpaulino

lightning-persister/src/test_utils.rs

@@ -1,4 +1,3 @@
-use lightning::check_closed_broadcast;
 use lightning::events::ClosureReason;
 use lightning::ln::functional_test_utils::*;
 use lightning::util::persist::{
@@ -188,7 +187,7 @@ pub(crate) fn do_test_store<K: KVStoreSync + Sync>(store_0: &K, store_1: &K) {
 		.unwrap();
 	let reason = ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true), message };
 	check_closed_event(&nodes[0], 1, reason, &[node_b_id], 100000);
-	check_closed_broadcast!(nodes[0], true);
+	check_closed_broadcast(&nodes[0], 1, true);
 	check_added_monitors(&nodes[0], 1);
 
 	let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
@@ -202,7 +201,7 @@ pub(crate) fn do_test_store<K: KVStoreSync + Sync>(store_0: &K, store_1: &K) {
 			vec![node_txn[0].clone(), node_txn[0].clone()],
 		),
 	);
-	check_closed_broadcast!(nodes[1], true);
+	check_closed_broadcast(&nodes[1], 1, true);
 	let reason = ClosureReason::CommitmentTxConfirmed;
 	check_closed_event(&nodes[1], 1, reason, &[nodes[0].node.get_our_node_id()], 100000);
 	check_added_monitors(&nodes[1], 1);

lightning/src/ln/accountable_tests.rs

@@ -26,7 +26,8 @@ fn test_accountable_forwarding_with_override(
 	let _chan_ab = create_announced_chan_between_nodes(&nodes, 0, 1);
 	let _chan_bc = create_announced_chan_between_nodes(&nodes, 1, 2);
 
-	let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
+	let (payment_preimage, payment_hash, payment_secret) =
+		get_payment_preimage_hash(&nodes[2], None, None);
 	let route_params = RouteParameters::from_payment_params_and_value(
 		PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV),
 		100_000,

lightning/src/ln/async_signer_tests.rs

@@ -1308,9 +1308,9 @@ fn do_test_closing_signed(extra_closing_signed: bool, reconnect: bool) {
 	}
 
 	nodes[0].node.signer_unblocked(None);
-	let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+	let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast(&nodes[0], node_b_id);
 	nodes[1].node.handle_closing_signed(node_a_id, &node_0_2nd_closing_signed.unwrap());
-	let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+	let (_, node_1_closing_signed) = get_closing_signed_broadcast(&nodes[1], node_a_id);
 	assert!(node_1_closing_signed.is_none());
 
 	assert!(nodes[0].node.list_channels().is_empty());

lightning/src/ln/chanmon_update_fail_tests.rs

@@ -277,7 +277,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
 	};
 	nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &node_b_id, message).unwrap();
 	check_added_monitors(&nodes[0], 1);
-	check_closed_broadcast!(nodes[0], true);
+	check_closed_broadcast(&nodes[0], 1, true);
 
 	// TODO: Once we hit the chain with the failure transaction we should check that we get a
 	// PaymentPathFailed event
@@ -1382,9 +1382,9 @@ fn raa_no_response_awaiting_raa_state() {
 	let (route, payment_hash_1, payment_preimage_1, payment_secret_1) =
 		get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
 	let (payment_preimage_2, payment_hash_2, payment_secret_2) =
-		get_payment_preimage_hash!(nodes[1]);
+		get_payment_preimage_hash(&nodes[1], None, None);
 	let (payment_preimage_3, payment_hash_3, payment_secret_3) =
-		get_payment_preimage_hash!(nodes[1]);
+		get_payment_preimage_hash(&nodes[1], None, None);
 
 	// Queue up two payments - one will be delivered right away, one immediately goes into the
 	// holding cell as nodes[0] is AwaitingRAA. Ultimately this allows us to deliver an RAA
@@ -1872,7 +1872,7 @@ fn test_monitor_update_fail_claim() {
 	do_commitment_signed_dance(&nodes[1], &nodes[2], &payment_event.commitment_msg, false, true);
 	expect_htlc_failure_conditions(nodes[1].node.get_and_clear_pending_events(), &[]);
 
-	let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[0]);
+	let (_, payment_hash_3, payment_secret_3) = get_payment_preimage_hash(&nodes[0], None, None);
 	let id_3 = PaymentId(payment_hash_3.0);
 	let onion_3 = RecipientOnionFields::secret_only(payment_secret_3);
 	nodes[2].node.send_payment_with_route(route, payment_hash_3, onion_3, id_3).unwrap();
@@ -2509,7 +2509,7 @@ fn test_fail_htlc_on_broadcast_after_claim() {
 	mine_transaction(&nodes[1], &bs_txn[0]);
 	let reason = ClosureReason::CommitmentTxConfirmed;
 	check_closed_event(&nodes[1], 1, reason, &[node_c_id], 100000);
-	check_closed_broadcast!(nodes[1], true);
+	check_closed_broadcast(&nodes[1], 1, true);
 	connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 	check_added_monitors(&nodes[1], 1);
 	expect_and_process_pending_htlcs_and_htlc_handling_failed(
@@ -2663,7 +2663,7 @@ fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
 	let (route, payment_hash_1, payment_preimage_1, payment_secret_1) =
 		get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
 	let (payment_preimage_2, payment_hash_2, payment_secret_2) =
-		get_payment_preimage_hash!(&nodes[1]);
+		get_payment_preimage_hash(&nodes[1], None, None);
 
 	// Do a really complicated dance to get an HTLC into the holding cell, with
 	// MonitorUpdateInProgress set but AwaitingRemoteRevoke unset. When this test was written, any
@@ -3048,11 +3048,11 @@ fn test_temporary_error_during_shutdown() {
 		node_b_id,
 		&get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, node_a_id),
 	);
-	let (_, closing_signed_a) = get_closing_signed_broadcast!(nodes[0].node, node_b_id);
+	let (_, closing_signed_a) = get_closing_signed_broadcast(&nodes[0], node_b_id);
 	let txn_a = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 
 	nodes[1].node.handle_closing_signed(node_a_id, &closing_signed_a.unwrap());
-	let (_, none_b) = get_closing_signed_broadcast!(nodes[1].node, node_a_id);
+	let (_, none_b) = get_closing_signed_broadcast(&nodes[1], node_a_id);
 	assert!(none_b.is_none());
 	let txn_b = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 
@@ -4043,7 +4043,7 @@ fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
 		};
 		nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &node_b_id, msg).unwrap();
 		check_added_monitors(&nodes[0], 1);
-		check_closed_broadcast!(nodes[0], true);
+		check_closed_broadcast(&nodes[0], 1, true);
 		check_closed_event(&nodes[0], 1, reason, &[node_b_id], 100_000);
 		let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 		mine_transaction_without_consistency_checks(&nodes[1], &as_closing_tx[0]);
@@ -4494,13 +4494,13 @@ fn test_claim_to_closed_channel_blocks_forwarded_preimage_removal() {
 	check_added_monitors(&nodes[0], 1);
 	let a_reason = ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true), message };
 	check_closed_event(&nodes[0], 1, a_reason, &[node_b_id], 1000000);
-	check_closed_broadcast!(nodes[0], true);
+	check_closed_broadcast(&nodes[0], 1, true);
 
 	let as_commit_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 	assert_eq!(as_commit_tx.len(), 1);
 
 	mine_transaction(&nodes[1], &as_commit_tx[0]);
-	check_closed_broadcast!(nodes[1], true);
+	check_closed_broadcast(&nodes[1], 1, true);
 	check_added_monitors(&nodes[1], 1);
 	let b_reason = ClosureReason::CommitmentTxConfirmed;
 	check_closed_event(&nodes[1], 1, b_reason, &[node_a_id], 1000000);
@@ -4572,13 +4572,13 @@ fn test_claim_to_closed_channel_blocks_claimed_event() {
 	check_added_monitors(&nodes[0], 1);
 	let a_reason = ClosureReason::HolderForceClosed { broadcasted_latest_txn: Some(true), message };
 	check_closed_event(&nodes[0], 1, a_reason, &[node_b_id], 1000000);
-	check_closed_broadcast!(nodes[0], true);
+	check_closed_broadcast(&nodes[0], 1, true);
 
 	let as_commit_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 	assert_eq!(as_commit_tx.len(), 1);
 
 	mine_transaction(&nodes[1], &as_commit_tx[0]);
-	check_closed_broadcast!(nodes[1], true);
+	check_closed_broadcast(&nodes[1], 1, true);
 	check_added_monitors(&nodes[1], 1);
 	let b_reason = ClosureReason::CommitmentTxConfirmed;
 	check_closed_event(&nodes[1], 1, b_reason, &[node_a_id], 1000000);
@@ -5099,7 +5099,8 @@ fn test_mpp_claim_to_holding_cell() {
 	send_along_route_with_secret(&nodes[0], route, paths, 500_000, paymnt_hash_1, payment_secret);
 
 	// Put the C <-> D channel into AwaitingRaa
-	let (preimage_2, paymnt_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[3]);
+	let (preimage_2, paymnt_hash_2, payment_secret_2) =
+		get_payment_preimage_hash(&nodes[3], None, None);
 	let onion = RecipientOnionFields::secret_only(payment_secret_2);
 	let id = PaymentId([42; 32]);
 	let pay_params = PaymentParameters::from_node_id(node_d_id, TEST_FINAL_CLTV);

lightning/src/ln/channelmanager.rs

@@ -20529,7 +20529,7 @@ mod tests {
 		let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 		let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 
-		let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
+		let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[0], None, None);
 		let payment_data = msgs::FinalOnionHopData {
 			payment_secret,
 			total_msat: 100_000,

lightning/src/ln/functional_test_utils.rs

@@ -2210,31 +2210,31 @@ macro_rules! check_spends {
 	}
 }
 
-macro_rules! get_closing_signed_broadcast {
-	($node: expr, $dest_pubkey: expr) => {{
-		let events = $node.get_and_clear_pending_msg_events();
-		assert!(events.len() == 1 || events.len() == 2);
-		(
-			match events[events.len() - 1] {
-				MessageSendEvent::BroadcastChannelUpdate { ref msg, .. } => {
-					assert_eq!(msg.contents.channel_flags & 2, 2);
-					msg.clone()
+pub fn get_closing_signed_broadcast(
+	node: &Node, dest_pubkey: PublicKey,
+) -> (msgs::ChannelUpdate, Option<msgs::ClosingSigned>) {
+	let events = node.node.get_and_clear_pending_msg_events();
+	assert!(events.len() == 1 || events.len() == 2);
+	(
+		match events[events.len() - 1] {
+			MessageSendEvent::BroadcastChannelUpdate { ref msg, .. } => {
+				assert_eq!(msg.contents.channel_flags & 2, 2);
+				msg.clone()
+			},
+			_ => panic!("Unexpected event"),
+		},
+		if events.len() == 2 {
+			match events[0] {
+				MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
+					assert_eq!(*node_id, dest_pubkey);
+					Some(msg.clone())
 				},
 				_ => panic!("Unexpected event"),
-			},
-			if events.len() == 2 {
-				match events[0] {
-					MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
-						assert_eq!(*node_id, $dest_pubkey);
-						Some(msg.clone())
-					},
-					_ => panic!("Unexpected event"),
-				}
-			} else {
-				None
-			},
-		)
-	}};
+			}
+		} else {
+			None
+		},
+	)
 }
 
 #[cfg(test)]
@@ -2313,17 +2313,6 @@ pub fn check_closed_broadcast(
 		.collect()
 }
 
-/// Check that a channel's closing channel update has been broadcasted, and optionally
-/// check whether an error message event has occurred.
-///
-/// Don't use this, use the identically-named function instead.
-#[macro_export]
-macro_rules! check_closed_broadcast {
-	($node: expr, $with_error_msg: expr) => {
-		$crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
-	};
-}
-
 #[derive(Default)]
 pub struct ExpectedCloseEvent {
 	pub channel_capacity_sats: Option<u64>,
@@ -2530,10 +2519,10 @@ pub fn close_channel<'a, 'b, 'c>(
 		assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 		tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 		let (bs_update, closing_signed_b) =
-			get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
+			get_closing_signed_broadcast(struct_b, node_a.get_our_node_id());
 
 		node_a.handle_closing_signed(node_b.get_our_node_id(), &closing_signed_b.unwrap());
-		let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
+		let (as_update, none_a) = get_closing_signed_broadcast(struct_a, node_b.get_our_node_id());
 		assert!(none_a.is_none());
 		assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 		tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
@@ -2550,10 +2539,10 @@ pub fn close_channel<'a, 'b, 'c>(
 		assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 		tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 		let (as_update, closing_signed_a) =
-			get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
+			get_closing_signed_broadcast(struct_a, node_b.get_our_node_id());
 
 		node_b.handle_closing_signed(node_a.get_our_node_id(), &closing_signed_a.unwrap());
-		let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
+		let (bs_update, none_b) = get_closing_signed_broadcast(struct_b, node_a.get_our_node_id());
 		assert!(none_b.is_none());
 		assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 		tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
@@ -2829,26 +2818,6 @@ pub fn get_payment_preimage_hash(
 	(payment_preimage, payment_hash, payment_secret)
 }
 
-/// Get a payment preimage and hash.
-///
-/// Don't use this, use the identically-named function instead.
-#[macro_export]
-macro_rules! get_payment_preimage_hash {
-	($dest_node: expr) => {
-		get_payment_preimage_hash!($dest_node, None)
-	};
-	($dest_node: expr, $min_value_msat: expr) => {
-		$crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
-	};
-	($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
-		$crate::ln::functional_test_utils::get_payment_preimage_hash(
-			&$dest_node,
-			$min_value_msat,
-			$min_final_cltv_expiry_delta,
-		)
-	};
-}
-
 /// Gets a route from the given sender to the node described in `payment_params`.
 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, &'static str> {
 	let scorer = TestScorer::new();
@@ -3820,7 +3789,7 @@ pub fn send_along_route<'a, 'b, 'c>(
 	recv_value: u64,
 ) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
 	let (our_payment_preimage, our_payment_hash, our_payment_secret) =
-		get_payment_preimage_hash!(expected_route.last().unwrap());
+		get_payment_preimage_hash(expected_route.last().unwrap(), None, None);
 	let payment_id = send_along_route_with_secret(
 		origin_node,
 		route,