Skip to content

Commit 1ce922c

Browse files
TheBlueMattTheBlueMatt
committed
Prefer fully-specified paths in test macros
This avoids macros being context-specific use-dependent.
1 parent 63698ec commit 1ce922c

File tree

9 files changed

+39
-46
lines changed

9 files changed

+39
-46
lines changed

‎lightning-persister/src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,7 @@ mod tests {
191191
use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
192192
use lightning::ln::features::InitFeatures;
193193
use lightning::ln::functional_test_utils::*;
194-
use lightning::ln::msgs::ErrorAction;
195-
use lightning::util::events::{ClosureReason, Event, MessageSendEventsProvider, MessageSendEvent};
194+
use lightning::util::events::{ClosureReason, MessageSendEventsProvider};
196195
use lightning::util::test_utils;
197196
use std::fs;
198197
#[cfg(target_os = "windows")]

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,17 @@ use bitcoin::network::constants::Network;
1919
use chain::channelmonitor::ChannelMonitor;
2020
use chain::transaction::OutPoint;
2121
use chain::{ChannelMonitorUpdateErr, Listen, Watch};
22-
use ln::{PaymentPreimage, PaymentHash};
2322
use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
2423
use ln::features::InitFeatures;
2524
use ln::msgs;
26-
use ln::msgs::{ChannelMessageHandler, ErrorAction, RoutingMessageHandler};
25+
use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
2726
use util::config::UserConfig;
2827
use util::enforcing_trait_impls::EnforcingSigner;
2928
use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
3029
use util::errors::APIError;
3130
use util::ser::{ReadableArgs, Writeable};
3231
use util::test_utils::TestBroadcaster;
3332

34-
use bitcoin::hashes::sha256::Hash as Sha256;
35-
use bitcoin::hashes::Hash;
36-
3733
use ln::functional_test_utils::*;
3834

3935
use util::test_utils;

‎lightning/src/ln/functional_test_utils.rs

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ use bitcoin::blockdata::constants::genesis_block;
3333
use bitcoin::blockdata::transaction::{Transaction, TxOut};
3434
use bitcoin::network::constants::Network;
3535

36-
use bitcoin::hashes::sha256::Hash as Sha256;
37-
use bitcoin::hashes::Hash;
3836
use bitcoin::hash_types::BlockHash;
3937

4038
use bitcoin::secp256k1::key::PublicKey;
@@ -337,9 +335,11 @@ pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b,
337335
(announcement, as_update, bs_update, channel_id, tx)
338336
}
339337

338+
#[macro_export]
340339
macro_rules! get_revoke_commit_msgs {
341340
($node: expr, $node_id: expr) => {
342341
{
342+
use util::events::MessageSendEvent;
343343
let events = $node.node.get_and_clear_pending_msg_events();
344344
assert_eq!(events.len(), 2);
345345
(match events[0] {
@@ -401,13 +401,14 @@ macro_rules! get_event {
401401
}
402402

403403
#[cfg(test)]
404+
#[macro_export]
404405
macro_rules! get_htlc_update_msgs {
405406
($node: expr, $node_id: expr) => {
406407
{
407408
let events = $node.node.get_and_clear_pending_msg_events();
408409
assert_eq!(events.len(), 1);
409410
match events[0] {
410-
MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
411+
$crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
411412
assert_eq!(*node_id, $node_id);
412413
(*updates).clone()
413414
},
@@ -704,6 +705,7 @@ pub fn update_nodes_with_chan_announce<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, '
704705
}
705706
}
706707

708+
#[macro_export]
707709
macro_rules! check_spends {
708710
($tx: expr, $($spends_txn: expr),*) => {
709711
{
@@ -768,6 +770,9 @@ macro_rules! get_closing_signed_broadcast {
768770
#[macro_export]
769771
macro_rules! check_closed_broadcast {
770772
($node: expr, $with_error_msg: expr) => {{
773+
use $crate::util::events::MessageSendEvent;
774+
use $crate::ln::msgs::ErrorAction;
775+
771776
let msg_events = $node.node.get_and_clear_pending_msg_events();
772777
assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
773778
match msg_events[0] {
@@ -795,6 +800,8 @@ macro_rules! check_closed_event {
795800
check_closed_event!($node, $events, $reason, false);
796801
};
797802
($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
803+
use $crate::util::events::Event;
804+
798805
let events = $node.node.get_and_clear_pending_events();
799806
assert_eq!(events.len(), $events);
800807
let expected_reason = $reason;
@@ -1003,28 +1010,31 @@ macro_rules! get_payment_preimage_hash {
10031010
};
10041011
($dest_node: expr, $min_value_msat: expr) => {
10051012
{
1013+
use bitcoin::hashes::Hash as _;
10061014
let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1007-
let payment_preimage = PaymentPreimage([*payment_count; 32]);
1015+
let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
10081016
*payment_count += 1;
1009-
let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1017+
let payment_hash = $crate::ln::PaymentHash(
1018+
bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
10101019
let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
10111020
(payment_preimage, payment_hash, payment_secret)
10121021
}
10131022
}
10141023
}
10151024

10161025
#[cfg(test)]
1026+
#[macro_export]
10171027
macro_rules! get_route_and_payment_hash {
10181028
($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1019-
get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1029+
$crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
10201030
}};
10211031
($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1022-
let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
1032+
let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
10231033
let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
10241034
.with_features($crate::ln::features::InvoiceFeatures::known())
10251035
.with_route_hints($last_hops);
1026-
let scorer = ::util::test_utils::TestScorer::with_fixed_penalty(0);
1027-
let route = ::routing::router::get_route(
1036+
let scorer = $crate::util::test_utils::TestScorer::with_fixed_penalty(0);
1037+
let route = $crate::routing::router::get_route(
10281038
&$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
10291039
Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
10301040
$recv_value, $cltv, $send_node.logger, &scorer
@@ -1088,6 +1098,7 @@ macro_rules! expect_payment_received {
10881098
}
10891099

10901100
#[cfg(test)]
1101+
#[macro_export]
10911102
macro_rules! expect_payment_sent_without_paths {
10921103
($node: expr, $expected_payment_preimage: expr) => {
10931104
expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
@@ -1097,23 +1108,26 @@ macro_rules! expect_payment_sent_without_paths {
10971108
}
10981109
}
10991110

1111+
#[macro_export]
11001112
macro_rules! expect_payment_sent {
11011113
($node: expr, $expected_payment_preimage: expr) => {
1102-
expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1114+
$crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
11031115
};
11041116
($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1105-
expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1117+
$crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
11061118
};
1107-
($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1119+
($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1120+
use bitcoin::hashes::Hash as _;
11081121
let events = $node.node.get_and_clear_pending_events();
1109-
let expected_payment_hash = PaymentHash(Sha256::hash(&$expected_payment_preimage.0).into_inner());
1122+
let expected_payment_hash = $crate::ln::PaymentHash(
1123+
bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
11101124
if $expect_paths {
11111125
assert!(events.len() > 1);
11121126
} else {
11131127
assert_eq!(events.len(), 1);
11141128
}
11151129
let expected_payment_id = match events[0] {
1116-
Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1130+
$crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
11171131
assert_eq!($expected_payment_preimage, *payment_preimage);
11181132
assert_eq!(expected_payment_hash, *payment_hash);
11191133
assert!(fee_paid_msat.is_some());
@@ -1127,24 +1141,25 @@ macro_rules! expect_payment_sent {
11271141
if $expect_paths {
11281142
for i in 1..events.len() {
11291143
match events[i] {
1130-
Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1144+
$crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
11311145
assert_eq!(payment_id, expected_payment_id);
11321146
assert_eq!(payment_hash, Some(expected_payment_hash));
11331147
},
11341148
_ => panic!("Unexpected event"),
11351149
}
11361150
}
11371151
}
1138-
}
1152+
} }
11391153
}
11401154

11411155
#[cfg(test)]
1156+
#[macro_export]
11421157
macro_rules! expect_payment_path_successful {
11431158
($node: expr) => {
11441159
let events = $node.node.get_and_clear_pending_events();
11451160
assert_eq!(events.len(), 1);
11461161
match events[0] {
1147-
Event::PaymentPathSuccessful { .. } => {},
1162+
$crate::util::events::Event::PaymentPathSuccessful { .. } => {},
11481163
_ => panic!("Unexpected event"),
11491164
}
11501165
}

‎lightning/src/ln/functional_tests.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ use bitcoin::blockdata::opcodes;
4242
use bitcoin::blockdata::constants::genesis_block;
4343
use bitcoin::network::constants::Network;
4444

45-
use bitcoin::hashes::sha256::Hash as Sha256;
46-
use bitcoin::hashes::Hash;
47-
4845
use bitcoin::secp256k1::Secp256k1;
4946
use bitcoin::secp256k1::key::{PublicKey,SecretKey};
5047

‎lightning/src/ln/monitor_tests.rs

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,13 @@
1111
1212
use chain::channelmonitor::{ANTI_REORG_DELAY, Balance};
1313
use chain::transaction::OutPoint;
14-
use ln::{channel, PaymentPreimage, PaymentHash};
14+
use ln::channel;
1515
use ln::channelmanager::BREAKDOWN_TIMEOUT;
1616
use ln::features::InitFeatures;
17-
use ln::msgs::{ChannelMessageHandler, ErrorAction};
17+
use ln::msgs::ChannelMessageHandler;
1818
use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
1919
use routing::network_graph::NetworkUpdate;
2020

21-
use bitcoin::hashes::sha256::Hash as Sha256;
22-
use bitcoin::hashes::Hash;
23-
2421
use bitcoin::blockdata::script::Builder;
2522
use bitcoin::blockdata::opcodes;
2623
use bitcoin::secp256k1::Secp256k1;

‎lightning/src/ln/onion_route_tests.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
//! returned errors decode to the correct thing.
1313
1414
use chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
15-
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
15+
use ln::{PaymentHash, PaymentSecret};
1616
use ln::channelmanager::{HTLCForwardInfo, CLTV_FAR_FAR_AWAY};
1717
use ln::onion_utils;
1818
use routing::network_graph::NetworkUpdate;
@@ -26,7 +26,6 @@ use util::config::UserConfig;
2626

2727
use bitcoin::hash_types::BlockHash;
2828

29-
use bitcoin::hashes::sha256::Hash as Sha256;
3029
use bitcoin::hashes::Hash;
3130

3231
use bitcoin::secp256k1;

‎lightning/src/ln/payment_tests.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,17 @@
1414
use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
1515
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
1616
use chain::transaction::OutPoint;
17-
use ln::{PaymentPreimage, PaymentHash};
1817
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
1918
use ln::features::InitFeatures;
2019
use ln::msgs;
21-
use ln::msgs::{ChannelMessageHandler, ErrorAction};
20+
use ln::msgs::ChannelMessageHandler;
2221
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
2322
use util::test_utils;
2423
use util::errors::APIError;
2524
use util::enforcing_trait_impls::EnforcingSigner;
2625
use util::ser::{ReadableArgs, Writeable};
2726
use io;
2827

29-
use bitcoin::hashes::sha256::Hash as Sha256;
30-
use bitcoin::hashes::Hash;
3128
use bitcoin::{Block, BlockHeader, BlockHash};
3229

3330
use prelude::*;

‎lightning/src/ln/reorg_tests.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
1313
use chain::transaction::OutPoint;
1414
use chain::{Confirm, Watch};
15-
use ln::PaymentHash;
1615
use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
1716
use ln::features::InitFeatures;
18-
use ln::msgs::{ChannelMessageHandler, ErrorAction};
17+
use ln::msgs::ChannelMessageHandler;
1918
use routing::network_graph::NetworkUpdate;
2019
use util::enforcing_trait_impls::EnforcingSigner;
2120
use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
@@ -25,8 +24,6 @@ use util::ser::{ReadableArgs, Writeable};
2524
use bitcoin::blockdata::block::{Block, BlockHeader};
2625
use bitcoin::blockdata::script::Builder;
2726
use bitcoin::blockdata::opcodes;
28-
use bitcoin::hashes::sha256::Hash as Sha256;
29-
use bitcoin::hashes::Hash;
3027
use bitcoin::hash_types::BlockHash;
3128
use bitcoin::secp256k1::Secp256k1;
3229

‎lightning/src/ln/shutdown_tests.rs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
1212
use chain::keysinterface::KeysInterface;
1313
use chain::transaction::OutPoint;
14-
use ln::{PaymentPreimage, PaymentHash};
1514
use ln::channelmanager::PaymentSendFailure;
1615
use routing::router::{Payee, get_route};
1716
use routing::network_graph::NetworkUpdate;
@@ -28,9 +27,6 @@ use util::config::UserConfig;
2827
use bitcoin::blockdata::script::Builder;
2928
use bitcoin::blockdata::opcodes;
3029

31-
use bitcoin::hashes::sha256::Hash as Sha256;
32-
use bitcoin::hashes::Hash;
33-
3430
use regex;
3531

3632
use core::default::Default;

0 commit comments

Comments
 (0)