simulators/portal: refactor sims into 1 sim multi suite format

Author: KolbyML

simulators/portal/beacon/rpc-compat/Dockerfile renamed to simulators/portal/beacon/Dockerfile

@@ -1,8 +1,8 @@
-FROM rust:1.71.1 AS builder
+FROM rust:1.75.0 AS builder
 
 # create a new empty shell project
-RUN USER=root cargo new --bin rpc-compat
-WORKDIR /rpc-compat
+RUN USER=root cargo new --bin beacon
+WORKDIR /beacon
 
 RUN apt-get update && apt-get install clang -y
 
@@ -19,8 +19,8 @@ FROM ubuntu:22.04
 RUN apt update && apt install wget -y
 
 # copy build artifacts from build stage
-COPY --from=builder /rpc-compat/target/release/rpc-compat .
+COPY --from=builder /beacon/target/release/beacon .
 
 ENV RUST_LOG=debug
 
-ENTRYPOINT ["./rpc-compat"]
+ENTRYPOINT ["./beacon"]

simulators/portal/beacon/rpc-compat/Cargo.toml

@@ -0,0 +1,43 @@
+mod suites;
+
+use hivesim::{Simulation, Suite, TestSpec};
+use suites::rpc_compat::run_rpc_compat_test_suite;
+
+#[tokio::main]
+async fn main() {
+    tracing_subscriber::fmt::init();
+    let mut beacon_rpc_compat = Suite {
+        name: "beacon-rpc-compat".to_string(),
+        description: "The RPC-compatibility test suite runs a set of RPC related tests against a
+        running node. It tests client implementations of the JSON-RPC API for
+        conformance with the portal network API specification."
+            .to_string(),
+        tests: vec![],
+    };
+
+    beacon_rpc_compat.add(TestSpec {
+        name: "client launch".to_string(),
+        description: "This test launches the client and collects its logs.".to_string(),
+        always_run: false,
+        run: run_rpc_compat_test_suite,
+        client: None,
+    });
+
+    let sim = Simulation::new();
+    run_suite(sim, vec![beacon_rpc_compat]).await;
+}
+
+async fn run_suite(host: Simulation, suites: Vec<Suite>) {
+    for suite in suites {
+        let name = suite.clone().name;
+        let description = suite.clone().description;
+
+        let suite_id = host.start_suite(name, description, "".to_string()).await;
+
+        for test in &suite.tests {
+            test.run_test(host.clone(), suite_id, suite.clone()).await;
+        }
+
+        host.end_suite(suite_id).await;
+    }
+}

simulators/portal/beacon/src/main.rs

@@ -1,2 +1,5 @@
 pub const HIVE_PORTAL_NETWORKS_SELECTED: &str = "HIVE_PORTAL_NETWORKS_SELECTED";
 pub const BEACON_STRING: &str = "beacon";
+
+// trin-bridge constants
+pub const TRIN_BRIDGE_CLIENT_TYPE: &str = "trin-bridge";

simulators/portal/beacon/rpc-compat/src/constants.rs renamed to simulators/portal/beacon/src/suites/constants.rs

@@ -0,0 +1,2 @@
+pub mod constants;
+pub mod rpc_compat;

simulators/portal/beacon/src/suites/mod.rs

@@ -1,8 +1,8 @@
-FROM rust:1.71.1 AS builder
+FROM rust:1.75.0 AS builder
 
 # create a new empty shell project
-RUN USER=root cargo new --bin portal-interop
-WORKDIR /portal-interop
+RUN USER=root cargo new --bin history
+WORKDIR /history
 
 # copy over manifests and source to build image
 COPY Cargo.toml ./Cargo.toml
@@ -17,9 +17,9 @@ FROM ubuntu:22.04
 RUN apt update && apt install wget -y
 
 # copy build artifacts from build stage
-COPY --from=builder /portal-interop/target/release/portal-interop .
+COPY --from=builder /history/target/release/history .
 ADD https://raw.githubusercontent.com/ethereum/portal-spec-tests/master/tests/mainnet/history/hive/test_data_collection_of_forks_blocks.yaml ./test-data/test_data_collection_of_forks_blocks.yaml
 
 ENV RUST_LOG=debug
 
-ENTRYPOINT ["./portal-interop"]
+ENTRYPOINT ["./history"]

simulators/portal/beacon/rpc-compat/src/main.rs renamed to simulators/portal/beacon/src/suites/rpc_compat.rs

@@ -0,0 +1,92 @@
+pub mod suites;
+
+use hivesim::{Simulation, Suite, TestSpec};
+use suites::interop::test_portal_interop;
+use suites::mesh::test_portal_scenarios;
+use suites::rpc_compat::run_rpc_compat_test_suite;
+use suites::trin_bridge::test_portal_bridge;
+
+#[tokio::main]
+async fn main() {
+    tracing_subscriber::fmt::init();
+    let mut rpc_compat = Suite {
+        name: "history-rpc-compat".to_string(),
+        description: "The RPC-compatibility test suite runs a set of RPC related tests against a
+        running node. It tests client implementations of the JSON-RPC API for
+        conformance with the portal network API specification."
+            .to_string(),
+        tests: vec![],
+    };
+
+    rpc_compat.add(TestSpec {
+        name: "client launch".to_string(),
+        description: "This test launches the client and collects its logs.".to_string(),
+        always_run: false,
+        run: run_rpc_compat_test_suite,
+        client: None,
+    });
+
+    let mut interop = Suite {
+        name: "history-interop".to_string(),
+        description:
+            "The interop test suite runs a set of scenarios to test interoperability between
+        portal network clients"
+                .to_string(),
+        tests: vec![],
+    };
+
+    interop.add(TestSpec {
+        name: "client launch".to_string(),
+        description: "This test launches the client and collects its logs.".to_string(),
+        always_run: false,
+        run: test_portal_interop,
+        client: None,
+    });
+
+    let mut mesh = Suite {
+        name: "history-mesh".to_string(),
+        description: "The portal mesh test suite runs a set of scenarios to test 3 clients"
+            .to_string(),
+        tests: vec![],
+    };
+
+    mesh.add(TestSpec {
+        name: "client launch".to_string(),
+        description: "This test launches the client and collects its logs.".to_string(),
+        always_run: false,
+        run: test_portal_scenarios,
+        client: None,
+    });
+
+    let mut trin_bridge = Suite {
+        name: "history-trin-bridge".to_string(),
+        description: "The portal bridge test suite".to_string(),
+        tests: vec![],
+    };
+
+    trin_bridge.add(TestSpec {
+        name: "client launch".to_string(),
+        description: "This test launches the client and collects its logs.".to_string(),
+        always_run: false,
+        run: test_portal_bridge,
+        client: None,
+    });
+
+    let sim = Simulation::new();
+    run_suite(sim, vec![rpc_compat, interop, mesh, trin_bridge]).await;
+}
+
+async fn run_suite(host: Simulation, suites: Vec<Suite>) {
+    for suite in suites {
+        let name = suite.clone().name;
+        let description = suite.clone().description;
+
+        let suite_id = host.start_suite(name, description, "".to_string()).await;
+
+        for test in &suite.tests {
+            test.run_test(host.clone(), suite_id, suite.clone()).await;
+        }
+
+        host.end_suite(suite_id).await;
+    }
+}

simulators/portal/history/portal-interop/Dockerfile renamed to simulators/portal/history/Dockerfile

@@ -1,4 +1,6 @@
+pub const TEST_DATA_FILE_PATH: &str = "./test-data/test_data_collection_of_forks_blocks.yaml";
+
+// trin-bridge constants
 pub const TRIN_BRIDGE_CLIENT_TYPE: &str = "trin-bridge";
 pub const BOOTNODES_ENVIRONMENT_VARIABLE: &str = "HIVE_BOOTNODES";
 pub const HIVE_CHECK_LIVE_PORT: &str = "HIVE_CHECK_LIVE_PORT";
-pub const TEST_DATA_FILE_PATH: &str = "./test-data/test_data_collection_of_forks_blocks.yaml";

simulators/portal/history/portal-interop/Cargo.toml

@@ -1,13 +1,12 @@
-mod constants;
-
-use crate::constants::TEST_DATA_FILE_PATH;
+use crate::suites::constants::{TEST_DATA_FILE_PATH, TRIN_BRIDGE_CLIENT_TYPE};
 use ethportal_api::types::portal::ContentInfo;
 use ethportal_api::utils::bytes::hex_encode;
 use ethportal_api::{
     ContentValue, Discv5ApiClient, HistoryContentKey, HistoryContentValue, HistoryNetworkApiClient,
     OverlayContentKey, PossibleHistoryContentValue,
 };
-use hivesim::{dyn_async, Client, NClientTestSpec, Simulation, Suite, Test, TestSpec};
+use hivesim::types::ClientDefinition;
+use hivesim::{dyn_async, Client, NClientTestSpec, Test};
 use itertools::Itertools;
 use portal_spec_test_utils_rs::get_flair;
 use serde_json::json;
@@ -21,44 +20,6 @@ const MAX_PORTAL_CONTENT_PAYLOAD_SIZE: usize = 1165;
 const HEADER_WITH_PROOF_KEY: &str =
     "0x00720704f3aa11c53cf344ea069db95cecb81ad7453c8f276b2a1062979611f09c";
 
-#[tokio::main]
-async fn main() {
-    tracing_subscriber::fmt::init();
-
-    let mut suite = Suite {
-        name: "portal-interop".to_string(),
-        description:
-            "The portal interop test suite runs a set of scenarios to test interoperability between
-        portal network clients"
-                .to_string(),
-        tests: vec![],
-    };
-
-    suite.add(TestSpec {
-        name: "Portal Network interop".to_string(),
-        description: "".to_string(),
-        always_run: false,
-        run: test_portal_interop,
-        client: None,
-    });
-
-    let sim = Simulation::new();
-    run_suite(sim, suite).await;
-}
-
-async fn run_suite(host: Simulation, suite: Suite) {
-    let name = suite.clone().name;
-    let description = suite.clone().description;
-
-    let suite_id = host.start_suite(name, description, "".to_string()).await;
-
-    for test in &suite.tests {
-        test.run_test(host.clone(), suite_id, suite.clone()).await;
-    }
-
-    host.end_suite(suite_id).await;
-}
-
 fn content_pair_to_string_pair(
     content_pair: (HistoryContentKey, HistoryContentValue),
 ) -> (String, String) {
@@ -126,9 +87,11 @@ fn process_content(
 }
 
 dyn_async! {
-   async fn test_portal_interop<'a> (test: &'a mut Test, _client: Option<Client>) {
+   pub async fn test_portal_interop<'a> (test: &'a mut Test, _client: Option<Client>) {
         // Get all available portal clients
         let clients = test.sim.client_types().await;
+        // todo: remove this once we implement role in hivesim-rs
+        let clients: Vec<ClientDefinition> = clients.into_iter().filter(|client| client.name != *TRIN_BRIDGE_CLIENT_TYPE).collect();
 
         let values = std::fs::read_to_string(TEST_DATA_FILE_PATH)
             .expect("cannot find test asset");