Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nervous-system): Enable Root to upgrade canisters using chunked Wasms #3300

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions rs/nervous_system/integration_tests/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ rust_test_suite_with_extra_srcs(
"tests/deploy_fresh_sns_test.rs",
"tests/sns_release_qualification_legacy.rs",
"tests/sns_upgrade_test_utils_legacy.rs",
"tests/upgrade_sns_controlled_canister_with_large_wasm.rs",
],
),
aliases = ALIASES,
Expand Down Expand Up @@ -279,3 +280,20 @@ rust_test(
],
deps = [":nervous_system_integration_tests"] + DEPENDENCIES_WITH_TEST_FEATURES + DEV_DEPENDENCIES,
)

rust_test(
name = "upgrade_sns_controlled_canister_with_large_wasm",
timeout = "long",
srcs = [
"tests/upgrade_sns_controlled_canister_with_large_wasm.rs",
],
aliases = ALIASES,
data = DEV_DATA,
env = DEV_ENV | {"RUST_TEST_NOCAPTURE": "1"},
flaky = True,
proc_macro_deps = MACRO_DEPENDENCIES + MACRO_DEV_DEPENDENCIES,
tags = [
"cpu:4",
],
deps = [":nervous_system_integration_tests"] + DEPENDENCIES_WITH_TEST_FEATURES + DEV_DEPENDENCIES,
)
27 changes: 27 additions & 0 deletions rs/nervous_system/integration_tests/src/pocket_ic_helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,33 @@ pub async fn install_canister_with_controllers(
);
}

pub async fn install_canister_on_subnet(
pocket_ic: &PocketIc,
subnet_id: Principal,
arg: Vec<u8>,
wasm: Option<Wasm>,
controllers: Vec<PrincipalId>,
) -> CanisterId {
let controllers = controllers.into_iter().map(|c| c.0).collect::<Vec<_>>();
let controller_principal = controllers.first().cloned();
let settings = Some(CanisterSettings {
controllers: Some(controllers),
..Default::default()
});
let canister_id = pocket_ic
.create_canister_on_subnet(None, settings, subnet_id)
.await;
pocket_ic
.add_cycles(canister_id, STARTING_CYCLES_PER_CANISTER)
.await;
if let Some(wasm) = wasm {
pocket_ic
.install_canister(canister_id, wasm.bytes(), arg, controller_principal)
.await;
}
CanisterId::unchecked_from_principal(canister_id.into())
}

// TODO migrate this to nns::governance
pub async fn add_wasm_via_nns_proposal(
pocket_ic: &PocketIc,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
use canister_test::Wasm;
use ic_base_types::PrincipalId;
use ic_management_canister_types::CanisterInstallMode;
use ic_nervous_system_integration_tests::pocket_ic_helpers::{
await_with_timeout, install_canister_on_subnet, nns, sns,
};
use ic_nervous_system_integration_tests::{
create_service_nervous_system_builder::CreateServiceNervousSystemBuilder,
pocket_ic_helpers::{add_wasms_to_sns_wasm, install_nns_canisters},
};
use ic_nns_constants::ROOT_CANISTER_ID;
use ic_nns_test_utils::common::modify_wasm_bytes;
use ic_sns_swap::pb::v1::Lifecycle;
use ic_test_utilities::universal_canister::UNIVERSAL_CANISTER_WASM;
use pocket_ic::PocketIcBuilder;

use ic_nervous_system_root::change_canister::ChangeCanisterRequest;
use ic_nervous_system_root::change_canister::ChunkedCanisterWasm;

const MIN_INSTALL_CHUNKED_CODE_TIME_SECONDS: u64 = 20;
const MAX_INSTALL_CHUNKED_CODE_TIME_SECONDS: u64 = 5 * 60;

#[tokio::test]
async fn test_store_same_as_target() {
let store_same_as_target = true;
run_test(store_same_as_target).await;
}

#[tokio::test]
async fn test_store_different_from_target() {
let store_same_as_target = false;
run_test(store_same_as_target).await;
}

mod interim_sns_helpers {
use super::*;

use candid::{Decode, Encode};
use pocket_ic::nonblocking::PocketIc;
use pocket_ic::WasmResult;

/// Interim test function for calling Root.change_canister.
///
/// This function is not in src/pocket_ic_helpers.rs because it's going to be replaced with
/// a proposal with the same effect. It should not be used in any other tests.
pub async fn change_canister(
pocket_ic: &PocketIc,
canister_id: PrincipalId,
sender: PrincipalId,
request: ChangeCanisterRequest,
) {
let result = pocket_ic
.update_call(
canister_id.into(),
sender.into(),
"change_canister",
Encode!(&request).unwrap(),
)
.await
.unwrap();
let result = match result {
WasmResult::Reply(result) => result,
WasmResult::Reject(s) => panic!("Call to change_canister failed: {:#?}", s),
};
Decode!(&result, ()).unwrap()
}
}

async fn run_test(store_same_as_target: bool) {
// 1. Prepare the world
let pocket_ic = PocketIcBuilder::new()
.with_nns_subnet()
.with_sns_subnet()
.with_application_subnet()
.build_async()
.await;

// Install the NNS canisters.
{
let with_mainnet_nns_canisters = false;
install_nns_canisters(&pocket_ic, vec![], with_mainnet_nns_canisters, None, vec![]).await;
}

// Publish SNS Wasms to SNS-W.
{
let with_mainnet_sns_canisters = false;
add_wasms_to_sns_wasm(&pocket_ic, with_mainnet_sns_canisters)
.await
.unwrap();
};

// Install a dapp canister.
let original_wasm = Wasm::from_bytes(UNIVERSAL_CANISTER_WASM.to_vec());
let original_wasm_hash = original_wasm.sha256_hash();

let app_subnet = pocket_ic.topology().await.get_app_subnets()[0];

let target_canister_id = install_canister_on_subnet(
&pocket_ic,
app_subnet,
vec![],
Some(original_wasm.clone()),
vec![ROOT_CANISTER_ID.into()],
)
.await;

let sns = {
let create_service_nervous_system = CreateServiceNervousSystemBuilder::default()
.with_dapp_canisters(vec![target_canister_id])
.build();

let swap_parameters = create_service_nervous_system
.swap_parameters
.clone()
.unwrap();

let sns_instance_label = "1";
let (sns, _) = nns::governance::propose_to_deploy_sns_and_wait(
&pocket_ic,
create_service_nervous_system,
sns_instance_label,
)
.await;

sns::swap::await_swap_lifecycle(&pocket_ic, sns.swap.canister_id, Lifecycle::Open)
.await
.unwrap();
sns::swap::smoke_test_participate_and_finalize(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to not have all our tests do this. This was originally created for the sake of final release qualification and is the slowest part of most tests.

PocketIC tests seem to be a bit slower for some reason

&pocket_ic,
sns.swap.canister_id,
swap_parameters,
)
.await;

sns
};

let store_canister_id = if store_same_as_target {
target_canister_id
} else {
install_canister_on_subnet(
&pocket_ic,
app_subnet,
vec![],
None,
vec![sns.root.canister_id],
)
.await
};

// TODO: Make the new WASM bigger than 2 MiB so that it does not fit into an ingress message.
let new_wasm = modify_wasm_bytes(&original_wasm.bytes(), 123);
let new_wasm = Wasm::from_bytes(new_wasm.to_vec());
let new_wasm_hash = new_wasm.sha256_hash();

// Smoke test
assert_ne!(new_wasm_hash, original_wasm_hash);

let chunk_hashes_list = {
pocket_ic
.upload_chunk(
store_canister_id.into(),
// This is a simplification; for now, we assume the Root itself decides to upload
// some WASM chunks, but eventually this should be triggered via proposal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, it doesn't matter how the chunks get there so long as 1) root is a co-controller and 2) the wasm hash is correct (which is part of the proposal and should be verified). I think that means that you don't need root to upload the chunks necessarily.

Some(sns.root.canister_id.into()),
new_wasm.bytes(),
)
.await
.unwrap();
let chunk_hashes_list = pocket_ic
.stored_chunks(store_canister_id.into(), Some(sns.root.canister_id.into()))
.await
.unwrap();
assert_eq!(chunk_hashes_list[0], new_wasm_hash);
chunk_hashes_list
};

// 2. Run code under test.
interim_sns_helpers::change_canister(
&pocket_ic,
sns.root.canister_id,
sns.governance.canister_id,
ChangeCanisterRequest {
stop_before_installing: true,
mode: CanisterInstallMode::Upgrade,
canister_id: target_canister_id,
// This is the old field being generalized.
wasm_module: vec![],
// This is the new field we want to test.
chunked_canister_wasm: Some(ChunkedCanisterWasm {
wasm_module_hash: new_wasm_hash.clone().to_vec(),
store_canister_id,
chunk_hashes_list,
}),
arg: vec![],
compute_allocation: None,
memory_allocation: None,
},
)
.await;

// 3. Inspect the resulting state.
await_with_timeout(
&pocket_ic,
MIN_INSTALL_CHUNKED_CODE_TIME_SECONDS..MAX_INSTALL_CHUNKED_CODE_TIME_SECONDS,
|pocket_ic| async {
let status = pocket_ic
.canister_status(target_canister_id.into(), Some(sns.root.canister_id.into()))
.await;
status
.expect("canister status must be available")
.module_hash
},
&Some(new_wasm_hash.to_vec()),
)
.await
.unwrap();
}
Loading
Loading