Skip to content

Commit e2bbe5c

Browse files
tnulltnull
committed
f Make unit tests aware of ChannelReady event
1 parent 20e4599 commit e2bbe5c

File tree

8 files changed

+89
-13
lines changed

8 files changed

+89
-13
lines changed

‎lightning-background-processor/src/lib.rs

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1022,15 +1022,25 @@ mod tests {
10221022
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10231023
let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
10241024
confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
1025-
let event = receiver
1026-
.recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1027-
.expect("SpendableOutputs not handled within deadline");
1028-
match event {
1029-
Event::SpendableOutputs { .. } => {},
1030-
Event::ChannelClosed { .. } => {},
1031-
_ => panic!("Unexpected event: {:?}", event),
1025+
1026+
let mut recvd_spendable_outputs = false;
1027+
let mut recvd_channel_ready = false;
1028+
while !recvd_channel_ready || !recvd_spendable_outputs {
1029+
let event_res = receiver.recv_timeout(Duration::from_secs(EVENT_DEADLINE));
1030+
match event_res {
1031+
Ok(event) =>
1032+
match event {
1033+
Event::ChannelReady{ .. } => recvd_channel_ready = true,
1034+
Event::SpendableOutputs { .. } => recvd_spendable_outputs = true,
1035+
Event::ChannelClosed { .. } => {},
1036+
_ => panic!("Unexpected event: {:?}", event),
1037+
}
1038+
Err(_) => panic!("Events not handled within deadline"),
1039+
}
10321040
}
10331041

1042+
assert!(recvd_channel_ready);
1043+
assert!(recvd_spendable_outputs);
10341044
assert!(bg_processor.stop().is_ok());
10351045
}
10361046

‎lightning-invoice/src/utils.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,9 @@ mod test {
869869
get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
870870
nodes[0].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &as_channel_ready);
871871
get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
872+
873+
expect_channel_ready_event!(nodes[0], nodes[2].node.get_our_node_id());
874+
expect_channel_ready_event!(nodes[2], nodes[0].node.get_our_node_id());
872875

873876
// As `msgs::ChannelUpdate` was never handled for the participating node(s) of the second
874877
// channel, the channel will never be assigned any `counterparty.forwarding_info`.
@@ -1257,6 +1260,8 @@ mod test {
12571260
get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[3].node.get_our_node_id());
12581261
nodes[3].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &as_channel_ready);
12591262
get_event_msg!(nodes[3], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1263+
expect_channel_ready_event!(nodes[1], nodes[3].node.get_our_node_id());
1264+
expect_channel_ready_event!(nodes[3], nodes[1].node.get_our_node_id());
12601265

12611266
// As `msgs::ChannelUpdate` was never handled for the participating node(s) of the third
12621267
// channel, the channel will never be assigned any `counterparty.forwarding_info`.

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1915,6 +1915,8 @@ fn do_during_funding_monitor_fail(confirm_a_first: bool, restore_b_before_conf:
19151915
node.gossip_sync.handle_channel_update(&as_update).unwrap();
19161916
node.gossip_sync.handle_channel_update(&bs_update).unwrap();
19171917
}
1918+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
1919+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
19181920

19191921
send_payment(&nodes[0], &[&nodes[1]], 8000000);
19201922
close_channel(&nodes[0], &nodes[1], &channel_id, funding_tx, true);

‎lightning/src/ln/channelmanager.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7839,6 +7839,9 @@ mod tests {
78397839
let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
78407840
let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
78417841
update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
7842+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
7843+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
7844+
78427845

78437846
nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
78447847
nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));

‎lightning/src/ln/functional_test_utils.rs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,9 +407,26 @@ pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, n
407407
create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
408408
}
409409

410+
#[macro_export]
411+
#[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
412+
macro_rules! expect_channel_ready_event {
413+
($node: expr, $expected_counterparty_node_id: expr) => {
414+
let events = $node.node.get_and_clear_pending_events();
415+
assert_eq!(events.len(), 1);
416+
match events[0] {
417+
$crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
418+
assert_eq!($expected_counterparty_node_id, *counterparty_node_id);
419+
},
420+
_ => panic!("Unexpected event"),
421+
}
422+
}
423+
}
424+
410425
pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
411426
let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
412427
let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
428+
expect_channel_ready_event!(node_a, node_b.node.get_our_node_id());
429+
expect_channel_ready_event!(node_b, node_a.node.get_our_node_id());
413430
(announcement, as_update, bs_update, channel_id, tx)
414431
}
415432

@@ -741,6 +758,9 @@ pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, r
741758
assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
742759
assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
743760

761+
expect_channel_ready_event!(initiator, receiver.node.get_our_node_id());
762+
expect_channel_ready_event!(receiver, initiator.node.get_our_node_id());
763+
744764
(tx, as_channel_ready.channel_id)
745765
}
746766

@@ -870,8 +890,10 @@ pub fn create_unannounced_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(nodes: &
870890
connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
871891
let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
872892
nodes[a].node.handle_channel_ready(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendChannelReady, nodes[a].node.get_our_node_id()));
893+
expect_channel_ready_event!(nodes[a], nodes[b].node.get_our_node_id());
873894
let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
874895
nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
896+
expect_channel_ready_event!(nodes[b], nodes[a].node.get_our_node_id());
875897
let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
876898

877899
nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);

‎lightning/src/ln/functional_tests.rs

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,8 @@ fn do_test_counterparty_no_reserve(send_from_initiator: bool) {
184184
let funding_tx = sign_funding_transaction(&nodes[0], &nodes[1], 100_000, temp_channel_id);
185185
let funding_msgs = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &funding_tx);
186186
create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_msgs.0);
187+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
188+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
187189

188190
// nodes[0] should now be able to send the full balance to nodes[1], violating nodes[1]'s
189191
// security model if it ever tries to send funds back to nodes[0] (but that's not our problem).
@@ -558,6 +560,7 @@ fn do_test_sanity_on_in_flight_opens(steps: u8) {
558560
confirm_transaction_at(&nodes[0], &tx, 2);
559561
connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
560562
create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
563+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
561564
}
562565

563566
#[test]
@@ -3711,11 +3714,24 @@ fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken
37113714
}
37123715

37133716
let events_1 = nodes[1].node.get_and_clear_pending_events();
3714-
assert_eq!(events_1.len(), 1);
3715-
match events_1[0] {
3716-
Event::PendingHTLCsForwardable { .. } => { },
3717-
_ => panic!("Unexpected event"),
3718-
};
3717+
if messages_delivered == 0 {
3718+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
3719+
assert_eq!(events_1.len(), 2);
3720+
match events_1[0] {
3721+
Event::ChannelReady { .. } => { },
3722+
_ => panic!("Unexpected event"),
3723+
};
3724+
match events_1[1] {
3725+
Event::PendingHTLCsForwardable { .. } => { },
3726+
_ => panic!("Unexpected event"),
3727+
};
3728+
} else {
3729+
assert_eq!(events_1.len(), 1);
3730+
match events_1[0] {
3731+
Event::PendingHTLCsForwardable { .. } => { },
3732+
_ => panic!("Unexpected event"),
3733+
};
3734+
}
37193735

37203736
nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
37213737
nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
@@ -3952,6 +3968,8 @@ fn test_funding_peer_disconnect() {
39523968
},
39533969
_ => panic!("Unexpected event {:?}", events_6[0]),
39543970
};
3971+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
3972+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
39553973

39563974
// When we deliver nodes[1]'s announcement_signatures to nodes[0], nodes[0] should immediately
39573975
// broadcast the channel announcement globally, as well as re-send its (now-public)
@@ -4414,6 +4432,8 @@ fn test_no_txn_manager_serialize_deserialize() {
44144432
node.gossip_sync.handle_channel_update(&as_update).unwrap();
44154433
node.gossip_sync.handle_channel_update(&bs_update).unwrap();
44164434
}
4435+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
4436+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
44174437

44184438
send_payment(&nodes[0], &[&nodes[1]], 1000000);
44194439
}
@@ -4535,6 +4555,8 @@ fn test_manager_serialize_deserialize_events() {
45354555
node.gossip_sync.handle_channel_update(&as_update).unwrap();
45364556
node.gossip_sync.handle_channel_update(&bs_update).unwrap();
45374557
}
4558+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
4559+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
45384560

45394561
send_payment(&nodes[0], &[&nodes[1]], 1000000);
45404562
}
@@ -9429,6 +9451,9 @@ fn test_duplicate_chan_id() {
94299451
let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
94309452
let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
94319453
update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9454+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
9455+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
9456+
94329457
send_payment(&nodes[0], &[&nodes[1]], 8000000);
94339458
}
94349459

@@ -10356,6 +10381,8 @@ fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, exposure_breach_e
1035610381
let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
1035710382
let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
1035810383
update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
10384+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
10385+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
1035910386

1036010387
let dust_buffer_feerate = {
1036110388
let chan_lock = nodes[0].node.channel_state.lock().unwrap();

‎lightning/src/ln/payment_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
483483
nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
484484
check_added_monitors!(nodes[1], 1);
485485
commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
486+
expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, false, false);
486487

487488
if confirm_before_reload {
488489
let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
@@ -499,7 +500,6 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
499500
let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
500501
assert_eq!(bs_htlc_claim_txn.len(), 1);
501502
check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
502-
expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, false, false);
503503

504504
if !confirm_before_reload {
505505
mine_transaction(&nodes[0], &as_commitment_tx);

‎lightning/src/ln/priv_short_conf_tests.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,8 @@ fn do_test_1_conf_open(connect_style: ConnectStyle) {
202202
} else { panic!("Unexpected event"); }
203203

204204
nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
205+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
206+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
205207
let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
206208
assert_eq!(bs_msg_events.len(), 1);
207209
if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = bs_msg_events[0] {
@@ -407,8 +409,10 @@ fn test_inbound_scid_privacy() {
407409
connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
408410
let bs_channel_ready = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[2].node.get_our_node_id());
409411
nodes[1].node.handle_channel_ready(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id()));
412+
expect_channel_ready_event!(nodes[1], nodes[2].node.get_our_node_id());
410413
let bs_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
411414
nodes[2].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &bs_channel_ready);
415+
expect_channel_ready_event!(nodes[2], nodes[1].node.get_our_node_id());
412416
let cs_update = get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
413417

414418
nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &cs_update);
@@ -672,6 +676,9 @@ fn test_0conf_channel_with_async_monitor() {
672676
}
673677
_ => panic!("Unexpected event"),
674678
}
679+
expect_channel_ready_event!(nodes[0], nodes[1].node.get_our_node_id());
680+
expect_channel_ready_event!(nodes[1], nodes[0].node.get_our_node_id());
681+
675682
let bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
676683

677684
let as_channel_update = match &as_locked_update[1] {

0 commit comments

Comments
 (0)