fixup! simln-lib/test: Add unit tests for validate_activity(), validate_node_network()

Author: jirigrill

simln-lib/src/lib.rs

@@ -33,7 +33,6 @@ pub mod lnd;
 mod random_activity;
 pub mod serializers;
 pub mod sim_node;
-#[cfg(test)]
 mod test_utils;
 
 #[derive(Serialize, Debug, Clone)]
@@ -1417,7 +1416,6 @@ async fn track_payment_result(
 
 #[cfg(test)]
 mod tests {
-    // use crate::test_utils::TestNetworkBuilder;
     use crate::{
         get_payment_delay, test_utils, test_utils::LightningTestNodeBuilder, LightningError,
         LightningNode, MutRng, PaymentGenerationError, PaymentGenerator,
@@ -1527,13 +1525,11 @@ mod tests {
         );
     }
 
-    // Tests for validate_activity()
-
     /// Verifies that an empty activity (for random generation) is valid when two nodes with keysend
     /// support are present, expecting an `Ok` result.
     #[tokio::test]
     async fn test_validate_activity_empty_with_sufficient_nodes() {
-        let (_, clients) = LightningTestNodeBuilder::setup_test_nodes(2, &[0, 1, 2]);
+        let (_, clients) = LightningTestNodeBuilder::new(3).build_full();
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_activity().await;
         assert!(result.is_ok());
@@ -1543,7 +1539,7 @@ mod tests {
     /// expecting a `ValidationError` with "At least two nodes required".
     #[tokio::test]
     async fn test_validate_activity_empty_with_insufficient_nodes() {
-        let (_, clients) = LightningTestNodeBuilder::setup_test_nodes(1, &[0]);
+        let (_, clients) = LightningTestNodeBuilder::new(1).build_full();
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_activity().await;
 
@@ -1556,7 +1552,9 @@ mod tests {
     /// expecting a `ValidationError` with "must support keysend".
     #[tokio::test]
     async fn test_validate_activity_empty_with_non_keysend_node() {
-        let (_, clients) = LightningTestNodeBuilder::setup_test_nodes(2, &[0]);
+        let (_, clients) = LightningTestNodeBuilder::new(2)
+            .with_keysend_nodes(vec![0])
+            .build_full();
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_activity().await;
 
@@ -1569,7 +1567,7 @@ mod tests {
     /// expecting a `ValidationError` with "Source node not found".
     #[tokio::test]
     async fn test_validate_activity_with_missing_source_node() {
-        let (nodes, clients) = LightningTestNodeBuilder::setup_test_nodes(1, &[0]);
+        let (nodes, clients) = LightningTestNodeBuilder::new(1).build_full();
         let missing_nodes = test_utils::create_nodes(1, 100_000);
         let missing_node = missing_nodes.first().unwrap().0.clone();
         let dest_node = nodes[0].clone();
@@ -1587,7 +1585,7 @@ mod tests {
     /// expecting a `ValidationError` with "does not support keysend".
     #[tokio::test]
     async fn test_validate_activity_with_non_keysend_destination() {
-        let (nodes, clients) = LightningTestNodeBuilder::setup_test_nodes(1, &[0]);
+        let (nodes, clients) = LightningTestNodeBuilder::new(1).build_full();
         let dest_nodes = test_utils::create_nodes(1, 100_000);
         let dest_node = dest_nodes.first().unwrap().0.clone();
 
@@ -1604,7 +1602,7 @@ mod tests {
     /// passes validation, expecting an `Ok` result.
     #[tokio::test]
     async fn test_validate_activity_valid_payment_flow() {
-        let (nodes, clients) = LightningTestNodeBuilder::setup_test_nodes(1, &[0]);
+        let (nodes, clients) = LightningTestNodeBuilder::new(1).build_full();
         let dest_nodes = test_utils::create_nodes(1, 100_000);
         let mut dest_node = dest_nodes.first().unwrap().0.clone();
         dest_node.features.set_keysend_optional();
@@ -1620,7 +1618,7 @@ mod tests {
     /// expecting a `ValidationError` with "zero values".
     #[tokio::test]
     async fn test_validate_zero_amount_no_valid() {
-        let (nodes, clients) = LightningTestNodeBuilder::setup_test_nodes(2, &[0, 1]);
+        let (nodes, clients) = LightningTestNodeBuilder::new(2).build_full();
 
         let activity = test_utils::create_activity(nodes[0].clone(), nodes[1].clone(), 0);
         let simulation = test_utils::create_simulation(clients, vec![activity]);
@@ -1631,8 +1629,6 @@ mod tests {
             Err(LightningError::ValidationError(msg)) if msg.contains("zero values")));
     }
 
-    // tests for validate_node_network()
-
     /// Verifies that validation fails with no nodes, expecting a `ValidationError` with
     /// "we don't control any nodes".
     #[tokio::test]
@@ -1651,7 +1647,9 @@ mod tests {
     /// with "mainnet is not supported".
     #[tokio::test]
     async fn test_validate_node_network_mainnet_not_supported() {
-        let clients = LightningTestNodeBuilder::setup_network_test_nodes(1, vec![Network::Bitcoin]);
+        let clients = LightningTestNodeBuilder::new(1)
+            .with_networks(vec![Network::Bitcoin])
+            .build_clients_only();
 
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_node_network().await;
@@ -1665,10 +1663,9 @@ mod tests {
     /// `ValidationError` with "nodes are not on the same network".
     #[tokio::test]
     async fn test_validate_node_network_mixed_networks() {
-        let clients = LightningTestNodeBuilder::setup_network_test_nodes(
-            2,
-            vec![Network::Testnet, Network::Regtest],
-        );
+        let clients = LightningTestNodeBuilder::new(2)
+            .with_networks(vec![Network::Testnet, Network::Regtest])
+            .build_clients_only();
 
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_node_network().await;
@@ -1681,10 +1678,9 @@ mod tests {
     /// Verifies that three Testnet nodes pass validation, expecting an `Ok` result.
     #[tokio::test]
     async fn test_validate_node_network_multiple_nodes_same_network() {
-        let clients = LightningTestNodeBuilder::setup_network_test_nodes(
-            3,
-            vec![Network::Testnet, Network::Testnet, Network::Testnet],
-        );
+        let clients = LightningTestNodeBuilder::new(3)
+            .with_networks(vec![Network::Testnet, Network::Testnet, Network::Testnet])
+            .build_clients_only();
 
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_node_network().await;
@@ -1694,7 +1690,9 @@ mod tests {
 
     #[tokio::test]
     async fn test_validate_node_network_single_node_valid_network() {
-        let clients = LightningTestNodeBuilder::setup_network_test_nodes(1, vec![Network::Testnet]);
+        let clients = LightningTestNodeBuilder::new(1)
+            .with_networks(vec![Network::Testnet])
+            .build_clients_only();
 
         let simulation = test_utils::create_simulation(clients, vec![]);
         let result = simulation.validate_node_network().await;

simln-lib/src/test_utils.rs

@@ -1,4 +1,4 @@
-#[cfg(test)]
+#![cfg(test)]
 use async_trait::async_trait;
 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
 use bitcoin::Network;
@@ -91,7 +91,7 @@ mock! {
     }
 }
 
-/// Type alias for the result of setup_test_nodes
+/// Type alias for the result of setup_test_nodes.
 type TestNodesResult = (
     Vec<NodeInfo>,
     HashMap<PublicKey, Arc<Mutex<dyn LightningNode>>>,
@@ -104,71 +104,52 @@ type TestNodesResult = (
 /// node info and clients) and client-only setups for network testing.
 ///
 /// # Examples
-/// Basic setup with keysend on specific nodes:
-/// let (nodes, clients) = TestNetworkBuilder::setup_test_nodes(5, &[0, 2]);
 ///
 /// Using the builder for more control:
-/// let (nodes, clients) = TestNetworkBuilder::new(5)
+/// let (nodes, clients) = LightningTestNodeBuilder::new(5)
 ///     .with_keysend_nodes(vec![0, 2, 4])
 ///     .build_full();
 ///
 /// Building clients with specific networks:
-/// let clients = TestNetworkBuilder::new(3)
+/// let clients = LightningTestNodeBuilder::new(3)
 ///     .with_networks(vec![Network::Bitcoin, Network::Testnet, Network::Regtest])
 ///     .build_clients_only();
 pub struct LightningTestNodeBuilder {
-    node_count: usize,              // Required - must be provided at creation
-    initial_balance: u64,           // Always has a value (default: 100,000)
-    keysend_indices: Vec<usize>,    // Always a vector (default: empty)
-    networks: Option<Vec<Network>>, // Can be None (default) or Some(networks)
+    node_count: usize,              // Required - must be provided at creation.
+    initial_balance: u64,           // Always has a value (default: 100,000).
+    keysend_indices: Vec<usize>,    // Always a vector (default: Vec filled with 0..node_count).
+    networks: Option<Vec<Network>>, // Can be None (default) or Some(networks).
 }
 
 impl LightningTestNodeBuilder {
-    /// Creates test nodes with optional keysend support on specified nodes.
-    /// A convenience method equivalent to `new(node_count).with_keysend_nodes(indices).build_full()`.
-    pub fn setup_test_nodes(node_count: usize, keysend_indices: &[usize]) -> TestNodesResult {
-        Self::new(node_count)
-            .with_keysend_nodes(keysend_indices.to_vec())
-            .build_full()
-    }
-
-    /// Creates test nodes with specified networks.
-    /// A convenience method equivalent to `new(node_count).with_networks(networks).build_clients_only()`.
-    pub fn setup_network_test_nodes(
-        node_count: usize,
-        networks: Vec<Network>,
-    ) -> HashMap<PublicKey, Arc<Mutex<dyn LightningNode>>> {
-        Self::new(node_count)
-            .with_networks(networks)
-            .build_clients_only()
-    }
-
     /// Creates a new builder instance with the specified number of nodes.
     /// The default configuration includes a balance of 100,000 units per node,
-    /// no keysend support, and no specific networks.
+    /// keysend support ON, and Regtest network.
     pub fn new(node_count: usize) -> Self {
         Self {
             node_count,
-            initial_balance: 100_000,    // Default 100k sats
-            keysend_indices: Vec::new(), // No keysend by default
-            networks: None,              // No specific networks by default
+            initial_balance: 100_000,                   // Default 100k sats.
+            keysend_indices: (0..node_count).collect(), // Keysend for all nodes ON by default.
+            networks: Some(vec![Network::Regtest; node_count]), // Regtest network for all nodes by default.
         }
     }
 
-    /// Specifies which nodes should have the keysend feature enabled
+    /// Specifies which nodes should have the keysend feature enabled.
     pub fn with_keysend_nodes(mut self, indices: Vec<usize>) -> Self {
         self.keysend_indices = indices;
         self
     }
 
-    /// Sets specific networks for each node
-    /// Will panic if the number of networks doesn't match node_count
-    /// Returns self for method chaining
+    /// Sets specific networks for each node.
+    /// Checks whether the number of networks matches node_count.
+    /// Returns self for method chaining.
     pub fn with_networks(mut self, networks: Vec<Network>) -> Self {
         // Validate that we have the correct number of networks
-        if networks.len() != self.node_count {
-            panic!("Must specify a network for each node");
-        }
+        assert_eq!(
+            networks.len(),
+            self.node_count,
+            "Must specify a network for each node"
+        );
         self.networks = Some(networks);
         self
     }
@@ -212,6 +193,8 @@ impl LightningTestNodeBuilder {
     }
 }
 
+/// Creates a new simulation with the given clients and activity definitions.
+/// Note: This sets a runtime for the simulation of 0, so run() will exit immediately.
 pub fn create_simulation(
     clients: HashMap<PublicKey, Arc<Mutex<dyn LightningNode>>>,
     activity: Vec<ActivityDefinition>,
@@ -223,7 +206,6 @@ pub fn create_simulation(
         TaskTracker::new(),
     )
 }
-
 pub fn create_activity(
     source: NodeInfo,
     destination: NodeInfo,