Refactor integration tests into shared scenario-based entry points

- Extract setup_clients() and setup_ldk_node() per implementation
- Replace inline test logic with shared scenario function calls
- Generate 16 combo tests per implementation via interop_combo_tests! macro

Author: febyeji

tests/common/mod.rs

@@ -5,7 +5,7 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
-#![cfg(any(test, cln_test, lnd_test, vss_test))]
+#![cfg(any(test, cln_test, lnd_test, eclair_test, vss_test))]
 #![allow(dead_code)]
 
 pub(crate) mod external_node;

tests/integration_tests_cln.rs

@@ -9,119 +9,234 @@
 
 mod common;
 
-use std::default::Default;
 use std::str::FromStr;
 
-use clightningrpc::lightningrpc::LightningRPC;
-use clightningrpc::responses::NetworkAddress;
+use common::cln::TestClnNode;
+use common::external_node::ExternalNode;
+use common::scenarios::channel::{
+	open_channel_to_external, run_inbound_channel_test, test_cooperative_close_after_fee_change,
+	test_cooperative_close_by_ldk, test_force_close_after_fee_change, test_force_close_by_external,
+	test_force_close_by_ldk,
+};
+use common::scenarios::disconnect::test_disconnect_reconnect_idle;
+use common::scenarios::payment::{
+	run_interop_property_test, test_bidirectional_payments, test_concurrent_payments,
+	test_pay_expired_invoice, test_receive_bolt11_payment,
+};
+use common::scenarios::splice::{test_splice_from_external, test_splice_then_payment};
+use common::scenarios::{setup_interop_test, CloseType, PayType, Phase, Side};
 use electrsd::corepc_client::client_sync::Auth;
 use electrsd::corepc_node::Client as BitcoindClient;
 use electrum_client::Client as ElectrumClient;
-use ldk_node::bitcoin::secp256k1::PublicKey;
-use ldk_node::bitcoin::Amount;
-use ldk_node::lightning::ln::msgs::SocketAddress;
 use ldk_node::{Builder, Event};
-use lightning_invoice::{Bolt11Invoice, Bolt11InvoiceDescription, Description};
-use rand::distr::Alphanumeric;
-use rand::{rng, Rng};
 
-#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
-async fn test_cln() {
-	// Setup bitcoind / electrs clients
-	let bitcoind_client = BitcoindClient::new_with_auth(
+async fn setup_clients() -> (BitcoindClient, ElectrumClient, TestClnNode) {
+	let bitcoind = BitcoindClient::new_with_auth(
 		"http://127.0.0.1:18443",
 		Auth::UserPass("user".to_string(), "pass".to_string()),
 	)
 	.unwrap();
-	let electrs_client = ElectrumClient::new("tcp://127.0.0.1:50001").unwrap();
+	let electrs = ElectrumClient::new("tcp://127.0.0.1:50001").unwrap();
 
-	// Give electrs a kick.
-	common::generate_blocks_and_wait(&bitcoind_client, &electrs_client, 1).await;
+	let cln = TestClnNode::from_env();
+	(bitcoind, electrs, cln)
+}
 
-	// Setup LDK Node
+fn setup_ldk_node() -> ldk_node::Node {
 	let config = common::random_config(true);
 	let mut builder = Builder::from_config(config.node_config);
-	builder.set_chain_source_esplora("http://127.0.0.1:3002".to_string(), None);
-
+	builder.set_chain_source_electrum("tcp://127.0.0.1:50001".to_string(), None);
 	let node = builder.build(config.node_entropy).unwrap();
 	node.start().unwrap();
+	node
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_basic_channel_cycle() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+
+	let (user_channel_id, _ext_channel_id) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	// LDK -> CLN payment
+	let invoice = cln.create_invoice(10_000_000, "cln-test-send").await.unwrap();
+	let parsed = lightning_invoice::Bolt11Invoice::from_str(&invoice).unwrap();
+	node.bolt11_payment().send(&parsed, None).unwrap();
+	common::expect_event!(node, PaymentSuccessful);
+
+	// CLN -> LDK payment
+	test_receive_bolt11_payment(&node, &cln, 10_000_000).await;
+
+	test_cooperative_close_by_ldk(&node, &cln, &bitcoind, &electrs, &user_channel_id).await;
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_disconnect_reconnect() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, _ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_disconnect_reconnect_idle(&node, &cln, &bitcoind, &electrs, &Side::Ldk).await;
+	test_disconnect_reconnect_idle(&node, &cln, &bitcoind, &electrs, &Side::External).await;
+
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_force_close_by_ldk() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (user_ch, _ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_force_close_by_ldk(&node, &cln, &bitcoind, &electrs, &user_ch).await;
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_force_close_by_external() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_force_close_by_external(&node, &cln, &bitcoind, &electrs, &ext_ch).await;
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_splice() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_splice_from_external(&node, &cln, &bitcoind, &electrs, &ext_ch).await;
+
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_splice_then_payment() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_splice_then_payment(&node, &cln, &bitcoind, &electrs, &ext_ch).await;
+
+	node.stop().unwrap();
+}
 
-	// Premine some funds and distribute
-	let address = node.onchain_payment().new_address().unwrap();
-	let premine_amount = Amount::from_sat(5_000_000);
-	common::premine_and_distribute_funds(
-		&bitcoind_client,
-		&electrs_client,
-		vec![address],
-		premine_amount,
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_inbound_channel() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	run_inbound_channel_test(
+		&node,
+		&cln,
+		&bitcoind,
+		&electrs,
+		CloseType::Cooperative,
+		Side::External,
 	)
 	.await;
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_receive_payments() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, _ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_receive_bolt11_payment(&node, &cln, 5_000_000).await;
+	// TODO: CLN v24.08+ includes a `payment_secret` in outbound keysend payments.
+	// LDK treats any inbound HTLC that carries a `payment_secret` as a BOLT 11 payment and
+	// attempts to verify it against a stored invoice; since no invoice exists for a spontaneous
+	// payment, it fails with WIRE_INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS.
+	// This is an LDK-side issue: when a valid `keysend_preimage` TLV is present,
+	// `payment_secret` verification should be skipped.
+	// Tracked upstream: CLN keysend interop issue (CLN includes payment_secret in keysend HTLCs)
+	// test_receive_keysend_payment(&node, &cln, 5_000_000).await;
+
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_bidirectional_payments() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_bidirectional_payments(&node, &cln, &ext_ch, 5_000_000).await;
 
-	// Setup CLN
-	let sock = "/tmp/lightning-rpc";
-	let cln_client = LightningRPC::new(&sock);
-	let cln_info = {
-		loop {
-			let info = cln_client.getinfo().unwrap();
-			// Wait for CLN to sync block height before channel open.
-			// Prevents crash due to unset blockheight (see LDK Node issue #527).
-			if info.blockheight > 0 {
-				break info;
-			}
-			tokio::time::sleep(std::time::Duration::from_millis(250)).await;
-		}
-	};
-	let cln_node_id = PublicKey::from_str(&cln_info.id).unwrap();
-	let cln_address: SocketAddress = match cln_info.binding.first().unwrap() {
-		NetworkAddress::Ipv4 { address, port } => {
-			std::net::SocketAddrV4::new(*address, *port).into()
-		},
-		NetworkAddress::Ipv6 { address, port } => {
-			std::net::SocketAddrV6::new(*address, *port, 0, 0).into()
-		},
-		_ => {
-			panic!()
-		},
-	};
-
-	node.sync_wallets().unwrap();
-
-	// Open the channel
-	let funding_amount_sat = 1_000_000;
-
-	node.open_channel(cln_node_id, cln_address, funding_amount_sat, Some(500_000_000), None)
-		.unwrap();
-
-	let funding_txo = common::expect_channel_pending_event!(node, cln_node_id);
-	common::wait_for_tx(&electrs_client, funding_txo.txid).await;
-	common::generate_blocks_and_wait(&bitcoind_client, &electrs_client, 6).await;
-	node.sync_wallets().unwrap();
-	let user_channel_id = common::expect_channel_ready_event!(node, cln_node_id);
-
-	// Send a payment to CLN
-	let mut rng = rng();
-	let rand_label: String = (0..7).map(|_| rng.sample(Alphanumeric) as char).collect();
-	let cln_invoice =
-		cln_client.invoice(Some(10_000_000), &rand_label, &rand_label, None, None, None).unwrap();
-	let parsed_invoice = Bolt11Invoice::from_str(&cln_invoice.bolt11).unwrap();
-
-	node.bolt11_payment().send(&parsed_invoice, None).unwrap();
-	common::expect_event!(node, PaymentSuccessful);
-	let cln_listed_invoices =
-		cln_client.listinvoices(Some(&rand_label), None, None, None).unwrap().invoices;
-	assert_eq!(cln_listed_invoices.len(), 1);
-	assert_eq!(cln_listed_invoices.first().unwrap().status, "paid");
-
-	// Send a payment to LDK
-	let rand_label: String = (0..7).map(|_| rng.sample(Alphanumeric) as char).collect();
-	let invoice_description =
-		Bolt11InvoiceDescription::Direct(Description::new(rand_label).unwrap());
-	let ldk_invoice =
-		node.bolt11_payment().receive(10_000_000, &invoice_description, 3600).unwrap();
-	cln_client.pay(&ldk_invoice.to_string(), Default::default()).unwrap();
-	common::expect_event!(node, PaymentReceived);
-
-	node.close_channel(&user_channel_id, cln_node_id).unwrap();
-	common::expect_event!(node, ChannelClosed);
 	node.stop().unwrap();
 }
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_pay_expired_invoice() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, _ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_pay_expired_invoice(&node, &cln).await;
+
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_concurrent_payments() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	setup_interop_test(&node, &cln, &bitcoind, &electrs).await;
+	let (_user_ch, _ext_ch) =
+		open_channel_to_external(&node, &cln, &bitcoind, &electrs, 1_000_000, Some(500_000_000))
+			.await;
+
+	test_concurrent_payments(&node, &cln, 5, 1_000_000).await;
+
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_cooperative_close_after_fee_change() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	test_cooperative_close_after_fee_change(&node, &cln, &bitcoind, &electrs).await;
+	node.stop().unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn test_cln_force_close_after_fee_change() {
+	let (bitcoind, electrs, cln) = setup_clients().await;
+	let node = setup_ldk_node();
+	test_force_close_after_fee_change(&node, &cln, &bitcoind, &electrs).await;
+	node.stop().unwrap();
+}
+
+interop_combo_tests!(test_cln, setup_clients, setup_ldk_node);