Merge branch 'mraszyk/sns-testing' into 'master'

add dynamic testnet for SNS testing

 

See merge request dfinity-lab/public/ic!12521

Author: mraszyk

WORKSPACE.bazel

@@ -584,18 +584,17 @@ http_file(
 http_file(
     name = "nns_dapp_canister",
     downloaded_file_path = "nns_dapp_canister.wasm",
-    sha256 = "8bcf768429631db5f6db372d090c58eedc9308ef623d98e0381121f598215de6",
-    url = "https://github.com/dfinity/nns-dapp/releases/download/proposal-119296/nns-dapp.wasm",
+    sha256 = "6af3470ef980b01eb427bdecde7d7c2c440a8c444f6c1fd6e7a39b251eceaf7a",
+    url = "https://github.com/dfinity/nns-dapp/releases/download/proposal-122512/nns-dapp.wasm",
 )
 
-# SNS aggregator canister (https://github.com/dfinity/nns-dapp/releases/tag/tip)
+# SNS aggregator canister
 
 http_file(
     name = "sns_aggregator",
-    downloaded_file_path = "sns_aggregator.wasm",
-    sha256 = "428b21acccfa442101096d95f74ab8368724d0e87e14d08f21d9a3bed77b69f3",
-    # Keep this dependency while the aggregator release process is WIP (IDX-2661)
-    url = "https://github.com/dfinity/nns-dapp/releases/download/ci-pin/sns_aggregator2.wasm",
+    downloaded_file_path = "sns_aggregator_dev.wasm",
+    sha256 = "fb50fbd91ca28373a1dd9207dee7cab22b5d73fde66fe1cc8a9dac63b9549da1",
+    url = "https://github.com/dfinity/nns-dapp/releases/download/proposal-122512/sns_aggregator_dev.wasm",
 )
 
 # Import Python rules

rs/tests/Cargo.toml

@@ -559,6 +559,10 @@ path = "testing_verification/testnets/small.rs"
 name = "ic-systest-small-nns"
 path = "testing_verification/testnets/small_nns.rs"
 
+[[bin]]
+name = "ic-systest-sns-testing"
+path = "testing_verification/testnets/sns_testing.rs"
+
 [[bin]]
 name = "ic-systest-medium"
 path = "testing_verification/testnets/medium.rs"

rs/tests/gix/nns_dapp_test.rs

@@ -113,7 +113,8 @@ fn get_html(env: &TestEnv, farm_url: &str, canister_id: Principal, dapp_anchor:
 }
 
 pub fn test(env: TestEnv) {
-    let (ii_canister_id, nns_dapp_canister_id) = install_ii_and_nns_dapp(&env, BOUNDARY_NODE_NAME);
+    let (ii_canister_id, nns_dapp_canister_id) =
+        install_ii_and_nns_dapp(&env, BOUNDARY_NODE_NAME, None);
     let boundary_node = env
         .get_deployed_boundary_node(BOUNDARY_NODE_NAME)
         .unwrap()

rs/tests/src/nns_dapp.rs

@@ -2,13 +2,16 @@ use crate::driver::{
     boundary_node::BoundaryNodeVm,
     test_env::TestEnv,
     test_env_api::{
-        HasPublicApiUrl, HasTopologySnapshot, HasWasm, IcNodeContainer, NnsCustomizations,
+        HasPublicApiUrl, HasTopologySnapshot, HasWasm, IcNodeContainer, IcNodeSnapshot,
+        NnsCustomizations,
     },
 };
 use crate::nns::set_authorized_subnetwork_list;
+use crate::sns_client::add_subnet_to_sns_deploy_whitelist;
 use crate::util::{block_on, create_canister, install_canister, runtime_from_url};
 use candid::Principal;
 use candid::{CandidType, Encode};
+use ic_base_types::SubnetId;
 use ic_ledger_core::Tokens;
 use ic_registry_subnet_type::SubnetType;
 use icp_ledger::AccountIdentifier;
@@ -19,6 +22,7 @@ use std::collections::HashMap;
 pub const INTERNET_IDENTITY_WASM: &str =
     "external/ii_test_canister/file/internet_identity_test.wasm";
 pub const NNS_DAPP_WASM: &str = "external/nns_dapp_canister/file/nns_dapp_canister.wasm";
+pub const SNS_AGGREGATOR_WASM: &str = "external/sns_aggregator/file/sns_aggregator_dev.wasm";
 
 /// Init and post_upgrade arguments for NNS frontend dapp.
 #[derive(Debug, Default, Eq, PartialEq, CandidType, Serialize, Deserialize)]
@@ -48,7 +52,44 @@ pub fn nns_dapp_customizations() -> NnsCustomizations {
     }
 }
 
-pub fn install_ii_and_nns_dapp(env: &TestEnv, boundary_node_name: &str) -> (Principal, Principal) {
+pub fn install_sns_aggregator(
+    env: &TestEnv,
+    boundary_node_name: &str,
+    sns_node: IcNodeSnapshot,
+) -> Principal {
+    let boundary_node = env
+        .get_deployed_boundary_node(boundary_node_name)
+        .unwrap()
+        .get_snapshot()
+        .unwrap();
+    let farm_url = boundary_node.get_playnet().unwrap();
+
+    let sns_agent = sns_node.build_default_agent();
+    let sns_aggregator_wasm = env.load_wasm(SNS_AGGREGATOR_WASM);
+    let logger = env.logger();
+    block_on(async move {
+        let sns_aggregator_canister_id =
+            create_canister(&sns_agent, sns_node.effective_canister_id()).await;
+        install_canister(
+            &sns_agent,
+            sns_aggregator_canister_id,
+            sns_aggregator_wasm.as_slice(),
+            Encode!(&()).unwrap(),
+        )
+        .await;
+        info!(
+            logger,
+            "SNS aggregator: https://{}.{}", sns_aggregator_canister_id, farm_url
+        );
+        sns_aggregator_canister_id
+    })
+}
+
+pub fn install_ii_and_nns_dapp(
+    env: &TestEnv,
+    boundary_node_name: &str,
+    sns_aggregator_canister_id: Option<Principal>,
+) -> (Principal, Principal) {
     let boundary_node = env
         .get_deployed_boundary_node(boundary_node_name)
         .unwrap()
@@ -83,7 +124,7 @@ pub fn install_ii_and_nns_dapp(env: &TestEnv, boundary_node_name: &str) -> (Prin
             ("OWN_CANISTER_ID".to_string(), nns_dapp_canister_id.to_string()),
             ("OWN_CANISTER_URL".to_string(), format!("https://{}.{}", nns_dapp_canister_id, farm_url)),
             ("ROBOTS".to_string(), "<meta name=\"robots\" content=\"noindex, nofollow\" />".to_string()),
-            ("SNS_AGGREGATOR_URL".to_string(), "".to_string()),
+            ("SNS_AGGREGATOR_URL".to_string(), sns_aggregator_canister_id.map(|s| format!("https://{}.{}", s, farm_url)).unwrap_or_else(|| "".to_string())),
             ("STATIC_HOST".to_string(), https_farm_url),
             ("WASM_CANISTER_ID".to_string(), "qaa6y-5yaaa-aaaaa-aaafa-cai".to_string())
         ];
@@ -124,3 +165,13 @@ pub fn set_authorized_subnets(env: &TestEnv) {
             .unwrap();
     });
 }
+
+pub fn set_sns_subnet(env: &TestEnv, subnet_id: SubnetId) {
+    let topology = env.topology_snapshot();
+    let nns_node = topology.root_subnet().nodes().next().unwrap();
+    let nns_runtime = runtime_from_url(nns_node.get_public_url(), nns_node.effective_canister_id());
+
+    block_on(async move {
+        add_subnet_to_sns_deploy_whitelist(&nns_runtime, subnet_id).await;
+    });
+}

rs/tests/src/nns_tests/sns_aggregator.rs

@@ -302,7 +302,7 @@ impl AggregatorClient {
                 "Validating aggregator canister's installation via public endpoint {}",
                 app_node.get_public_url().as_str(),
             );
-            let p = env.get_dependency_path("external/sns_aggregator/file/sns_aggregator.wasm");
+            let p = env.get_dependency_path("external/sns_aggregator/file/sns_aggregator_dev.wasm");
             let p = std::fs::canonicalize(p.clone())
                 .unwrap_or_else(|e| panic!("cannot obtain canonical path from {p:?}: {e:?}"));
             let canister_bytes = env.load_wasm(p);
@@ -401,7 +401,7 @@ pub fn validate_aggregator_data(env: TestEnv) {
             let swap_params = AggregatorClient::first_swap_params(
                 &log,
                 &http_canister,
-                Duration::from_secs(2 * 60),
+                Duration::from_secs(5 * 60),
             )
             .await
             .result()

rs/tests/src/sns_client.rs

@@ -233,7 +233,7 @@ pub fn oc_sns_init_payload() -> SnsInitPayload {
 }
 
 /// Send and execute 6 proposals to add all SNS canister WASMs to the SNS WASM canister
-fn add_all_wasms_to_sns_wasm(env: &TestEnv, canister_wasm_strategy: NnsCanisterWasmStrategy) {
+pub fn add_all_wasms_to_sns_wasm(env: &TestEnv, canister_wasm_strategy: NnsCanisterWasmStrategy) {
     let logger = env.logger();
     let nns_node = env.get_first_healthy_nns_node_snapshot();
     let runtime = runtime_from_url(nns_node.get_public_url(), nns_node.effective_canister_id());
@@ -322,7 +322,7 @@ async fn add_principal_to_sns_deploy_whitelist(nns_api: &'_ Runtime, principal_i
 }
 
 /// Send and execute a proposal to add the given subnet ID to the SNS subnet list
-async fn add_subnet_to_sns_deploy_whitelist(nns_api: &'_ Runtime, subnet_id: SubnetId) {
+pub async fn add_subnet_to_sns_deploy_whitelist(nns_api: &'_ Runtime, subnet_id: SubnetId) {
     let governance_canister = get_governance_canister(nns_api);
     let proposal_payload = UpdateSnsSubnetListRequest {
         sns_subnet_ids_to_add: vec![subnet_id.get()],

rs/tests/testing_verification/testnets/BUILD.bazel

@@ -1,5 +1,5 @@
 load("//rs/tests:system_tests.bzl", "system_test")
-load("//rs/tests:common.bzl", "BOUNDARY_NODE_GUESTOS_RUNTIME_DEPS", "DEPENDENCIES", "GRAFANA_RUNTIME_DEPS", "GUESTOS_RUNTIME_DEPS", "MACRO_DEPENDENCIES", "NNS_CANISTER_RUNTIME_DEPS")
+load("//rs/tests:common.bzl", "BOUNDARY_NODE_GUESTOS_RUNTIME_DEPS", "DEPENDENCIES", "GRAFANA_RUNTIME_DEPS", "GUESTOS_RUNTIME_DEPS", "MACRO_DEPENDENCIES", "NNS_CANISTER_RUNTIME_DEPS", "SNS_CANISTER_RUNTIME_DEPS")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -60,6 +60,23 @@ system_test(
     deps = DEPENDENCIES + ["//rs/tests"],
 )
 
+system_test(
+    name = "sns_testing",
+    flaky = False,
+    proc_macro_deps = MACRO_DEPENDENCIES,
+    tags = [
+        "dynamic_testnet",
+        "manual",
+    ],
+    target_compatible_with = ["@platforms//os:linux"],  # requires libssh that does not build on Mac OS
+    runtime_deps = GUESTOS_RUNTIME_DEPS + NNS_CANISTER_RUNTIME_DEPS + SNS_CANISTER_RUNTIME_DEPS + BOUNDARY_NODE_GUESTOS_RUNTIME_DEPS + GRAFANA_RUNTIME_DEPS + [
+        "@ii_test_canister//file",
+        "@nns_dapp_canister//file",
+        "@sns_aggregator//file",
+    ],
+    deps = DEPENDENCIES + ["//rs/tests"],
+)
+
 system_test(
     name = "medium",
     flaky = False,

rs/tests/testing_verification/testnets/small_nns.rs

@@ -89,7 +89,7 @@ pub fn setup(env: TestEnv) {
         .use_real_certs_and_dns()
         .start(&env)
         .expect("failed to setup BoundaryNode VM");
-    install_ii_and_nns_dapp(&env, BOUNDARY_NODE_NAME);
+    install_ii_and_nns_dapp(&env, BOUNDARY_NODE_NAME, None);
     set_authorized_subnets(&env);
     env.sync_prometheus_config_with_topology();
     await_boundary_node_healthy(&env, BOUNDARY_NODE_NAME);

rs/tests/testing_verification/testnets/sns_testing.rs

@@ -0,0 +1,121 @@
+// Set up a testnet for SNS testing:
+// single 1-node System and two 1-node Application subnets, single unassigned node, single boundary node and a p8s (with grafana) VM.
+// All nodes use the following resources: 4 vCPUs, 24GiB of RAM and 50 GiB disk.
+//
+// In addition to these subnets, this testnet additionally installs the NNS canisters,
+// the NNS and II frontend canisters (on the NNS subnet),
+// and SNS aggregator canister (on the SNS subnet).
+//
+// You can setup this testnet by executing the following commands:
+//
+//   $ gitlab-ci/container/container-run.sh
+//   $ ict testnet sns_testing -- --test_tmpdir=./sns_testing
+//
+// The --test_tmpdir=./sns_testing will store the test output in the specified directory.
+// This is useful to have access to in case you need to SSH into an IC node for example like:
+//
+//   $ ssh -i sns_testing/_tmp/*/setup/ssh/authorized_priv_keys/admin admin@$ipv6
+//
+// Note that you can get the $ipv6 address of the IC node by looking for a log line like:
+//
+//   Apr 11 15:34:10.175 INFO[rs/tests/src/driver/farm.rs:94:0]
+//     VM(h2tf2-odxlp-fx5uw-kvn43-bam4h-i4xmw-th7l2-xxwvv-dxxpz-bs3so-iqe)
+//     Host: ln1-dll10.ln1.dfinity.network
+//     IPv6: 2a0b:21c0:4003:2:5051:85ff:feec:6864
+//     vCPUs: 4
+//     Memory: 25165824 KiB
+//
+// To get access to P8s and Grafana look for the following log lines:
+//
+//   Apr 11 15:33:58.903 INFO[rs/tests/src/driver/prometheus_vm.rs:168:0]
+//     Prometheus Web UI at http://prometheus.sns_testing--1681227226065.testnet.farm.dfinity.systems
+//   Apr 11 15:33:58.903 INFO[rs/tests/src/driver/prometheus_vm.rs:169:0]
+//     Grafana at http://grafana.sns_testing--1681227226065.testnet.farm.dfinity.systems
+//   Apr 11 15:33:58.903 INFO[rs/tests/src/driver/prometheus_vm.rs:170:0]
+//     IC Progress Clock at http://grafana.sns_testing--1681227226065.testnet.farm.dfinity.systems/d/ic-progress-clock/ic-progress-clock?refresh=10s&from=now-5m&to=now
+//
+// To access the NNS or II dapps look for the following log lines:
+//
+//   2023-05-03 11:06:27.948 INFO[setup:rs/tests/src/nns_dapp.rs:99:0]
+//     Internet Identity: https://qhbym-qaaaa-aaaaa-aaafq-cai.ic0.farm.dfinity.systems
+//   2023-05-03 11:06:27.948 INFO[setup:rs/tests/src/nns_dapp.rs:103:0]
+//     NNS frontend dapp: https://qsgjb-riaaa-aaaaa-aaaga-cai.ic0.farm.dfinity.systems
+//
+// Happy testing!
+
+use anyhow::Result;
+
+use ic_registry_subnet_type::SubnetType;
+use ic_tests::driver::{
+    boundary_node::BoundaryNode,
+    group::SystemTestGroup,
+    ic::{InternetComputer, Subnet},
+    prometheus_vm::{HasPrometheus, PrometheusVm},
+    test_env::TestEnv,
+    test_env_api::{
+        await_boundary_node_healthy, HasTopologySnapshot, IcNodeContainer, NnsCanisterWasmStrategy,
+    },
+};
+use ic_tests::nns_dapp::{
+    install_ii_and_nns_dapp, install_sns_aggregator, nns_dapp_customizations,
+    set_authorized_subnets, set_sns_subnet,
+};
+use ic_tests::orchestrator::utils::rw_message::install_nns_with_customizations_and_check_progress;
+use ic_tests::sns_client::add_all_wasms_to_sns_wasm;
+use slog::info;
+
+const BOUNDARY_NODE_NAME: &str = "boundary-node-1";
+
+fn main() -> Result<()> {
+    SystemTestGroup::new()
+        .with_setup(setup)
+        .execute_from_args()?;
+    Ok(())
+}
+
+pub fn setup(env: TestEnv) {
+    PrometheusVm::default()
+        .start(&env)
+        .expect("Failed to start prometheus VM");
+    InternetComputer::new()
+        .add_subnet(Subnet::new(SubnetType::System).add_nodes(1))
+        .add_subnet(Subnet::new(SubnetType::Application).add_nodes(1))
+        .add_subnet(Subnet::new(SubnetType::Application).add_nodes(1))
+        .with_unassigned_nodes(1)
+        .setup_and_start(&env)
+        .expect("Failed to setup IC under test");
+    install_nns_with_customizations_and_check_progress(
+        env.topology_snapshot(),
+        NnsCanisterWasmStrategy::TakeBuiltFromSources,
+        nns_dapp_customizations(),
+    );
+    BoundaryNode::new(String::from(BOUNDARY_NODE_NAME))
+        .allocate_vm(&env)
+        .expect("Allocation of BoundaryNode failed.")
+        .for_ic(&env, "")
+        .use_real_certs_and_dns()
+        .start(&env)
+        .expect("failed to setup BoundaryNode VM");
+    env.sync_prometheus_config_with_topology();
+
+    let topology = env.topology_snapshot();
+    let mut app_subnets = topology
+        .subnets()
+        .filter(|s| s.subnet_type() == SubnetType::Application);
+    let sns_subnet = app_subnets.next().unwrap();
+    let sns_node = sns_subnet.nodes().next().unwrap();
+    let app_subnet = app_subnets.next().unwrap();
+    let app_node = app_subnet.nodes().next().unwrap();
+
+    let app_effective_canister_id = app_node.effective_canister_id();
+    let logger = env.logger();
+    info!(logger, "Use {} as effective canister ID when creating canisters for your dapp, e.g., using --provisional-create-canister-effective-canister-id {} with DFX", app_effective_canister_id, app_effective_canister_id);
+
+    let sns_aggregator_canister_id = install_sns_aggregator(&env, BOUNDARY_NODE_NAME, sns_node);
+    install_ii_and_nns_dapp(&env, BOUNDARY_NODE_NAME, Some(sns_aggregator_canister_id));
+    set_authorized_subnets(&env);
+    set_sns_subnet(&env, sns_subnet.subnet_id);
+    add_all_wasms_to_sns_wasm(&env, NnsCanisterWasmStrategy::TakeBuiltFromSources);
+
+    await_boundary_node_healthy(&env, BOUNDARY_NODE_NAME);
+}