Fix occasional port bind error happening in mock mining by checking if in feature == testing and reserving test observer port

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jferrant

stackslib/src/net/poll.rs

@@ -89,7 +89,7 @@ impl NetworkState {
     }
 
     fn bind_address(addr: &SocketAddr) -> Result<mio_net::TcpListener, net_error> {
-        if !cfg!(test) {
+        if !cfg!(test) && !cfg!(feature = "testing") {
             mio_net::TcpListener::bind(addr).map_err(|e| {
                 error!("Failed to bind to {:?}: {:?}", addr, e);
                 net_error::BindError

testnet/stacks-node/src/tests/mod.rs

@@ -23,6 +23,7 @@ use clarity::vm::events::STXEventType;
 use clarity::vm::types::PrincipalData;
 use clarity::vm::{ClarityName, ClarityVersion, ContractName, Value};
 use lazy_static::lazy_static;
+use neon_integrations::test_observer::EVENT_OBSERVER_PORT;
 use rand::Rng;
 use stacks::chainstate::burn::ConsensusHash;
 use stacks::chainstate::stacks::db::StacksChainState;
@@ -109,11 +110,15 @@ pub fn gen_random_port() -> u16 {
     let mut rng = rand::thread_rng();
     let range_len = (1024..u16::MAX).len();
     loop {
+        // Note it needs to be +1 because we reserve one port for the event observer
         assert!(
-            USED_PORTS.lock().unwrap().len() < range_len,
+            USED_PORTS.lock().unwrap().len() + 1 < range_len,
             "No more available ports"
         );
         let port = rng.gen_range(1024..u16::MAX); // use a non-privileged port between 1024 and 65534
+        if port == EVENT_OBSERVER_PORT {
+            continue;
+        }
         if insert_new_port(port) {
             return port;
         }

testnet/stacks-node/src/tests/nakamoto_integrations.rs

@@ -8132,16 +8132,16 @@ fn mock_mining() {
     let send_amt = 100;
     let send_fee = 180;
 
-    let node_1_rpc = 51024;
-    let node_1_p2p = 51023;
-    let node_2_rpc = 51026;
-    let node_2_p2p = 51025;
+    let node_1_rpc = gen_random_port();
+    let node_1_p2p = gen_random_port();
+    let node_2_rpc = gen_random_port();
+    let node_2_p2p = gen_random_port();
 
     let localhost = "127.0.0.1";
-    naka_conf.node.rpc_bind = format!("{}:{}", localhost, node_1_rpc);
-    naka_conf.node.p2p_bind = format!("{}:{}", localhost, node_1_p2p);
-    naka_conf.node.data_url = format!("http://{}:{}", localhost, node_1_rpc);
-    naka_conf.node.p2p_address = format!("{}:{}", localhost, node_1_p2p);
+    naka_conf.node.rpc_bind = format!("{localhost}:{node_1_rpc}");
+    naka_conf.node.p2p_bind = format!("{localhost}:{node_1_p2p}");
+    naka_conf.node.data_url = format!("http://{localhost}:{node_1_rpc}");
+    naka_conf.node.p2p_address = format!("{localhost}:{node_1_p2p}");
     let http_origin = format!("http://{}", &naka_conf.node.rpc_bind);
 
     naka_conf.add_initial_balance(
@@ -8221,10 +8221,10 @@ fn mock_mining() {
     follower_conf.node.seed = vec![0x01; 32];
     follower_conf.node.local_peer_seed = vec![0x02; 32];
 
-    follower_conf.node.rpc_bind = format!("{}:{}", localhost, node_2_rpc);
-    follower_conf.node.p2p_bind = format!("{}:{}", localhost, node_2_p2p);
-    follower_conf.node.data_url = format!("http://{}:{}", localhost, node_2_rpc);
-    follower_conf.node.p2p_address = format!("{}:{}", localhost, node_2_p2p);
+    follower_conf.node.rpc_bind = format!("{localhost}:{node_2_rpc}");
+    follower_conf.node.p2p_bind = format!("{localhost}:{node_2_p2p}");
+    follower_conf.node.data_url = format!("http://{localhost}:{node_2_rpc}");
+    follower_conf.node.p2p_address = format!("{localhost}:{node_2_p2p}");
 
     let node_info = get_chain_info(&naka_conf);
     follower_conf.node.add_bootstrap_node(