add resilience to expect_probe_successful_events

Author: alexanderwiederin

lightning/src/ln/functional_test_utils.rs

@@ -2098,20 +2098,24 @@ pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, ex
 }
 
 #[cfg(any(test, feature = "_test_utils"))]
-pub fn expect_probe_successful_events(node: &Node, probe_results: Vec<(PaymentHash, PaymentId)>) {
+pub fn expect_probe_successful_events(node: &Node, probe_results: &Vec<(PaymentHash, PaymentId)>) {
 	let mut events = node.node.get_and_clear_pending_events();
+	let mut probe_results = probe_results.clone();
 
-	assert_eq!(events.len(), probe_results.len());
-	for (idx, event) in events.drain(..).enumerate() {
-		let (payment_hash, payment_id) = probe_results[idx];
+	for event in events.drain(..) {
 		match event {
-			Event::ProbeSuccessful { payment_id: ev_pid, payment_hash: ev_ph, ..} => {
-				assert_eq!(payment_id, ev_pid);
-				assert_eq!(payment_hash, ev_ph);
+			Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
+				let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
+				assert!(result_idx.is_some());
+
+				probe_results.remove(result_idx.unwrap());
 			},
 			_ => panic!(),
 		}
 	};
+
+	// Ensure that we received a ProbeSuccessful event for each probe result.
+	assert!(probe_results.is_empty());
 }
 
 pub struct PaymentFailedConditions<'a> {

lightning/src/ln/payment_tests.rs

@@ -1286,7 +1286,7 @@ fn successful_probe_yields_event() {
 
 	pass_probe_along_route(&nodes[0], expected_route);
 
-	expect_probe_successful_events(&nodes[0], vec![res]);
+	expect_probe_successful_events(&nodes[0], &vec![res]);
 
 	assert!(!nodes[0].node.has_pending_payments());
 }
@@ -1429,7 +1429,7 @@ fn preflight_probes_yield_event_skip_private_hop() {
 
 	pass_probe_along_route(&nodes[0], expected_route);
 
-	expect_probe_successful_events(&nodes[0], res);
+	expect_probe_successful_events(&nodes[0], &res);
 
 	assert!(!nodes[0].node.has_pending_payments());
 }
@@ -1475,7 +1475,7 @@ fn preflight_probes_yield_event() {
 
 	pass_probe_along_route(&nodes[0], expected_route);
 
-	expect_probe_successful_events(&nodes[0], res);
+	expect_probe_successful_events(&nodes[0], &res);
 
 	assert!(!nodes[0].node.has_pending_payments());
 }
@@ -1523,7 +1523,7 @@ fn preflight_probes_yield_event_and_skip() {
 
 	pass_probe_along_route(&nodes[0], expected_route);
 
-	expect_probe_successful_events(&nodes[0], res);
+	expect_probe_successful_events(&nodes[0], &res);
 
 	assert!(!nodes[0].node.has_pending_payments());
 }