diff --git a/lightning/src/ln/functional_test_utils.rs b/lightning/src/ln/functional_test_utils.rs index fe78395e2f9..dbb3b2f0538 100644 --- a/lightning/src/ln/functional_test_utils.rs +++ b/lightning/src/ln/functional_test_utils.rs @@ -24,7 +24,7 @@ use util::enforcing_trait_impls::EnforcingSigner; use util::scid_utils; use util::test_utils; use util::test_utils::{panicking, TestChainMonitor}; -use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose}; +use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose}; use util::errors::APIError; use util::config::UserConfig; use util::ser::{ReadableArgs, Writeable}; @@ -1254,24 +1254,101 @@ macro_rules! get_route_and_payment_hash { }} } +pub struct HTLCHandlingFailedConditions { + pub expected_pending_htlcs_forwardable: bool, + pub expected_htlc_processing_failed: Option, + pub expected_destinations: Vec, +} + +impl HTLCHandlingFailedConditions { + pub fn new() -> Self { + Self { + expected_pending_htlcs_forwardable: false, + expected_htlc_processing_failed: None, + expected_destinations: vec![], + } + } + + pub fn with_reason(mut self, reason: HTLCDestination) -> Self { + self.expected_htlc_processing_failed = Some(1); + self.expected_destinations = vec![reason]; + self + } + + pub fn with_reasons(mut self, reasons: Vec) -> Self { + self.expected_htlc_processing_failed = Some(reasons.len()); + self.expected_destinations = reasons; + self + } +} + #[macro_export] -/// Clears (and ignores) a PendingHTLCsForwardable event -macro_rules! expect_pending_htlcs_forwardable_ignore { - ($node: expr) => {{ +macro_rules! expect_pending_htlcs_forwardable_conditions { + ($node: expr, $conditions: expr) => {{ + let conditions = $conditions; let events = $node.node.get_and_clear_pending_events(); - assert_eq!(events.len(), 1); match events[0] { $crate::util::events::Event::PendingHTLCsForwardable { .. } => { }, _ => panic!("Unexpected event"), }; + + let count = conditions.expected_htlc_processing_failed.unwrap_or(0) + 1; + assert_eq!(events.len(), count); + + if conditions.expected_destinations.len() > 0 { + expect_htlc_handling_failed_destinations!(events, conditions.expected_destinations) + } + }} +} + +#[macro_export] +macro_rules! expect_htlc_handling_failed_destinations { + ($events: expr, $destinations: expr) => {{ + for event in $events { + match event { + $crate::util::events::Event::PendingHTLCsForwardable { .. } => { }, + $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => { + assert!($destinations.contains(&failed_next_destination)) + }, + _ => panic!("Unexpected destination"), + } + } }} } +#[macro_export] +/// Clears (and ignores) a PendingHTLCsForwardable event +macro_rules! expect_pending_htlcs_forwardable_ignore { + ($node: expr) => {{ + expect_pending_htlcs_forwardable_conditions!($node, $crate::ln::functional_test_utils::HTLCHandlingFailedConditions::new()); + }}; +} + +#[macro_export] +/// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events +macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore { + ($node: expr, $conditions: expr) => {{ + expect_pending_htlcs_forwardable_conditions!($node, $conditions); + }}; +} + #[macro_export] /// Handles a PendingHTLCsForwardable event macro_rules! expect_pending_htlcs_forwardable { ($node: expr) => {{ - $crate::expect_pending_htlcs_forwardable_ignore!($node); + expect_pending_htlcs_forwardable_ignore!($node); + $node.node.process_pending_htlc_forwards(); + + // Ensure process_pending_htlc_forwards is idempotent. + $node.node.process_pending_htlc_forwards(); + }}; +} + +#[macro_export] +/// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event +macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed { + ($node: expr, $conditions: expr) => {{ + expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $conditions); $node.node.process_pending_htlc_forwards(); // Ensure process_pending_htlc_forwards is idempotent.