test(sns): Porting sns-testing to the ICP mono repo, Part III by aterga · Pull Request #4705 · dfinity/ic

aterga · 2025-04-08T07:14:20Z

This is the third PR for implementing the next-gen sns-testing tool.

At the core of this tool lies the PocketIC framework, the testing framework capable of creating a fully deterministic environment for testing complex ICP dapp scenarios.

This PR is authored by Serokell and reviewed by the DFINITY Foundation.

< Previous PR |

rs/nervous_system/integration_tests/src/pocket_ic_helpers.rs

rs/sns/testing/BUILD.bazel

rs/sns/testing/README.md

rs/sns/testing/BUILD.bazel

rs/sns/testing/README.md

…anisters' 'is_canister_stopped' is currently used by PocketIc and ic-agent implementations. However, the 'CallCanisters' trait requires implementing this function. As a result, some trait implementations have dummy implementation for this method which panics in runtime. To avoid runtime panic, this method is extracted into a dedicated 'CallCanistersWithStoppedCanisterError' trait that inherits 'CallCanisters'. This trait is only implemented for PocketIc and ic-agent's. An attempt to use 'is_canister_stopped_error' for other implementation will cause compilation error instead of runtime panic.

Currently the ID of the NNS neuron that is used to submit proposals is hardcoded which is potentially error-prone. To fix this, 'sns-testing-init' and 'sns-testing run-basic scenario' were made to consider neuron ID instead of using the hardcoded ID from a separate crate.

Co-authored-by: Arshavir Ter-Gabrielyan <arshavir.ter.gabrielyan@dfinity.org>

Currently, IC network HTTP endpoint port launched by 'sns-testing-init' is hardcoded to 8080. This commit adds an additional command line option to 'sns-testing-init' binary to make the port configurable.

'run-basic-scenario' subcommand is updated to take the WASM module and Candid argument used for the canister upgrade as arguments instead of hardcoding them. This allows users to run this "basic scenario" on arbitrary canisters.

Currently, README requires running binaries using 'bazel run' which bloats usage instructions. Additionally, in the future, we'd like to distribute all these binaries without 'bazel'. This commit adds a bash script that builds all required binaries using 'bazel', copies them to the local directory and updates PATH. README now implies the usage of this script to populate PATH and explains how to use binaries without 'bazel run' wrapper (for all binaries except 'sns-testing-init').

Currently, 'sns-testing-init' requires specifying the path to the PocketIC directory explicitly. This introduces the necessity to clean up the directory before re-running this binary (if the same value for the option is used). This commit makes '--state-dir' argument optional. If it's not provided, a new temporary directory will be created. This directory will remain even after 'pocket-ic-server' process has finished. This temporary directory will be cleaned up on the next system reboot.

rs/sns/testing/scripts/env.sh

rs/nervous_system/agent/src/helpers/nns.rs

rs/sns/testing/tests/sns_testing_ci.rs

This is a preliminary PR for discussing the changes that will be ported to #4697 Context: Serokell sns-testing milestone III --------- Co-authored-by: Roman Melnikov <roman.melnikov@serokell.io> Co-authored-by: Roman Melnikov <rvembox@gmail.com>

github-actions bot added the test label Apr 8, 2025

aterga marked this pull request as ready for review April 8, 2025 07:14

aterga requested a review from a team as a code owner April 8, 2025 07:14

aterga mentioned this pull request Apr 8, 2025

test(sns): Porting sns-testing to the ICP mono repo, Part III #4697

Closed