ci: use node manager for running local testnets

WIP The node registry from the node manager has been transferred to the `sn_protocol` crate to reduce duplication between `safe_network` and `sn-node-manager`, because they both need access to these data structures. The local network deployment inventory is represented using the node registry.
maidsafe · Jan 12, 2024 · f3db89a · f3db89a
1 parent eee302d
commit f3db89a
Show file tree

Hide file tree

Showing 10 changed files with 160 additions and 48 deletions.
diff --git a/.github/workflows/benchmark-prs.yml b/.github/workflows/benchmark-prs.yml
@@ -47,14 +47,13 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
           node-path: target/release/safenode
           faucet-path: target/release/faucet
           platform: ubuntu-latest
-          build: true
 
       - name: Check SAFE_PEERS was set
         shell: bash

diff --git a/.github/workflows/generate-benchmark-charts.yml b/.github/workflows/generate-benchmark-charts.yml
@@ -50,7 +50,7 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000

diff --git a/.github/workflows/memcheck.yml b/.github/workflows/memcheck.yml
@@ -65,8 +65,8 @@ jobs:
 
       - name: Start a local network
         env:
-          SN_LOG: all
-        uses: maidsafe/sn-local-testnet-action@main
+          SN_LOG: "all"
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
@@ -75,6 +75,8 @@ jobs:
           platform: ubuntu-latest
           set-safe-peers: false
           build: true
+          node-manager-branch: safe-peers-arg
+          node-manager-repo-owner: jacderida
           join: true
 
       # In this case we did *not* want SAFE_PEERS to be set to another value by starting the testnet

diff --git a/.github/workflows/merge.yml b/.github/workflows/merge.yml
@@ -146,14 +146,13 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
           node-path: target/release/safenode
           faucet-path: target/release/faucet
           platform: ${{ matrix.os }}
-          build: true
 
       - name: Check SAFE_PEERS was set
         shell: bash
@@ -274,12 +273,11 @@ jobs:
 
       - name: Stop the local network and upload logs
         if: always()
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: stop
           log_file_prefix: safe_test_logs_e2e
           platform: ${{ matrix.os }}
-          build: true
 
   gossipsub:
     if: "!startsWith(github.event.head_commit.message, 'chore(release):')" 
@@ -304,7 +302,7 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
@@ -319,12 +317,11 @@ jobs:
 
       - name: Stop the local network and upload logs
         if: always()
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: stop
           log_file_prefix: safe_test_logs_gossipsub_e2e
           platform: ${{ matrix.os }}
-          build: true
 
   spend_test:
     if: "!startsWith(github.event.head_commit.message, 'chore(release):')" 
@@ -350,14 +347,13 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
           node-path: target/release/safenode
           faucet-path: target/release/faucet
           platform: ${{ matrix.os }}
-          build: true
 
       - name: Check SAFE_PEERS was set
         shell: bash
@@ -391,12 +387,11 @@ jobs:
 
       - name: Stop the local network and upload logs
         if: always()
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: stop
           log_file_prefix: safe_test_logs_spend
           platform: ${{ matrix.os }}
-          build: true
 
   churn:
     if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
@@ -430,14 +425,13 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
           node-path: target/release/safenode
           faucet-path: target/release/faucet
           platform: ${{ matrix.os }}
-          build: true
 
       - name: Check SAFE_PEERS was set
         shell: bash
@@ -459,12 +453,11 @@ jobs:
 
       - name: Stop the local network and upload logs
         if: always()
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: stop
           log_file_prefix: safe_test_logs_churn
           platform: ${{ matrix.os }}
-          build: true
 
       - name: Verify restart of nodes using rg
         shell: bash
@@ -552,14 +545,13 @@ jobs:
           timeout-minutes: 30
 
         - name: Start a local network
-          uses: maidsafe/sn-local-testnet-action@main
+          uses: jacderida/sn-local-testnet-action@node-manager
           with:
             action: start
             interval: 2000
             node-path: target/release/safenode
             faucet-path: target/release/faucet
             platform: ${{ matrix.os }}
-            build: true
 
         - name: Check SAFE_PEERS was set
           shell: bash
@@ -588,12 +580,11 @@ jobs:
 
         - name: Stop the local network and upload logs
           if: always()
-          uses: maidsafe/sn-local-testnet-action@main
+          uses: jacderida/sn-local-testnet-action@node-manager
           with:
             action: stop
             log_file_prefix: safe_test_logs_data_location
             platform: ${{ matrix.os }}
-            build: true
 
         - name: Verify restart of nodes using rg
           shell: bash
@@ -672,14 +663,13 @@ jobs:
         timeout-minutes: 30
 
       - name: Start a local network
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: start
           interval: 2000
           node-path: target/release/safenode
           faucet-path: target/release/faucet
           platform: ubuntu-latest
-          build: true
 
       - name: Check SAFE_PEERS was set
         shell: bash
@@ -717,9 +707,8 @@ jobs:
 
       - name: Stop the local network and upload logs
         if: always()
-        uses: maidsafe/sn-local-testnet-action@main
+        uses: jacderida/sn-local-testnet-action@node-manager
         with:
           action: stop
           log_file_prefix: safe_test_logs_heavy_replicate_bench
           platform: ubuntu-latest
-          build: true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -38,9 +38,6 @@ jobs:
             target: aarch64-unknown-linux-musl
     steps:
       - uses: actions/checkout@v4
-
-
-
       - uses: dtolnay/rust-toolchain@stable
       # It's quite slow to install just by building it, but here we need a cross-platform solution.
       - shell: bash
@@ -75,8 +72,6 @@ jobs:
       GH_TOKEN: ${{ secrets.VERSION_BUMP_COMMIT_PAT }}
 
     steps:
-
-
       - uses: actions/checkout@v4
         with:
           fetch-depth: "0"

diff --git a/sn_node/tests/common/client.rs b/sn_node/tests/common/client.rs
@@ -10,6 +10,7 @@ use eyre::{bail, Result};
 use lazy_static::lazy_static;
 use sn_client::{send, Client};
 use sn_peers_acquisition::parse_peer_addr;
+use sn_protocol::node_registry::{get_local_node_registry_path, NodeRegistry};
 use sn_protocol::test_utils::DeploymentInventory;
 use sn_transfers::{create_faucet_wallet, LocalWallet, NanoTokens, Transfer};
 use std::{
@@ -53,18 +54,13 @@ pub fn get_all_rpc_addresses() -> Result<Vec<SocketAddr>> {
     match DeploymentInventory::load() {
         Ok(inventory) => Ok(inventory.rpc_endpoints),
         Err(_) => {
-            let starting_port = match std::env::var("CHURN_TEST_START_PORT") {
-                Ok(val) => val.parse()?,
-                Err(_) => 12000,
-            };
-            let mut addresses = Vec::new();
-            for i in 1..LOCAL_NODE_COUNT + 1 {
-                let addr = SocketAddr::new(
-                    IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)),
-                    starting_port + i as u16,
-                );
-                addresses.push(addr);
-            }
+            let local_node_reg_path = &get_local_node_registry_path()?;
+            let local_node_registry = NodeRegistry::load(local_node_reg_path)?;
+            let addresses = local_node_registry
+                .nodes
+                .iter()
+                .map(|n| SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), n.rpc_port))
+                .collect::<Vec<SocketAddr>>();
             Ok(addresses)
         }
     }

diff --git a/sn_protocol/Cargo.toml b/sn_protocol/Cargo.toml
@@ -10,20 +10,20 @@ repository = "https://github.com/maidsafe/safe_network"
 version = "0.10.6"
 
 [features]
-test-utils=["dirs-next", "serde_json"]
+test-utils=[]
 
 [dependencies]
 bls = { package = "blsttc", version = "8.0.1" }
 bytes = { version = "1.0.1", features = ["serde"] }
 color-eyre = "0.6.2"
 crdts = { version = "7.3", default-features = false, features = ["merkle"] }
 custom_debug = "~0.5.0"
-dirs-next = { version = "~2.0.0", optional = true }
+dirs-next = "~2.0.0"
 hex = "~0.4.3"
 libp2p = { version="0.53", features = ["identify", "kad"] }
 rmp-serde = "1.1.1"
 serde = { version = "1.0.133", features = [ "derive", "rc" ]}
-serde_json = {version = "1.0", optional = true }
+serde_json = "1.0"
 sha2 = "0.10.7"
 sn_transfers = { path = "../sn_transfers", version = "0.14.36" }
 sn_registers = { path = "../sn_registers", version = "0.3.7" }

diff --git a/sn_protocol/src/error.rs b/sn_protocol/src/error.rs
@@ -17,6 +17,10 @@ pub type Result<T> = std::result::Result<T, Error>;
 #[derive(Error, Clone, PartialEq, Eq, Serialize, Deserialize, custom_debug::Debug)]
 #[non_exhaustive]
 pub enum Error {
+    // ---------- Misc errors
+    #[error("Could not obtain user's data directory")]
+    UserDataDirectoryNotObtainable,
+
     // ---------- Chunk Proof errors
     #[error("Chunk does not exist {0:?}")]
     ChunkDoesNotExist(NetworkAddress),

diff --git a/sn_protocol/src/lib.rs b/sn_protocol/src/lib.rs
@@ -13,6 +13,8 @@ extern crate tracing;
 pub mod error;
 /// Messages types
 pub mod messages;
+/// Data structures for node management.
+pub mod node_registry;
 /// RPC commands to node
 pub mod node_rpc;
 /// Storage types for spends, chunks and registers.