Testing canisters overview
Testing your canister's code during the development process is an important step to verify that the code operates as expected and does not produce bugs, errors, or result in the canister trapping. Before deploying and using the code in a production environment, it should undergo testing.
Types of testing
There are three types of testing:
Unit testing: Test each individual unit of the code separately, such as a function or calculation.
Integration testing: Test how multiple functions or portions of the code integrate and operate together.
End-to-end testing: Test the application's complete workflow, including the frontend user interface.
Unit testing
Unit testing refers to testing a single function or component of a piece of code by itself, thus testing a single unit of the code. Unit testing does not take into consideration how the single unit functions with other components of the application. The scope of unit testing is more narrow compared to other types of testing and is designed to catch bugs or errors that may occur for each individual unit of the application's code.
In Motoko, the base library contains files that can be used for unit testing. Most testing files utilize the Motoko Matchers test library to provide testing functionality. Motoko Matchers also includes a package for executing unit tests within canisters.
For tests that use large datasets or have long-running test batches, Motoko also provides the BigTest library.
For Rust unit testing, refer to the guide on effective Rust containers and guidelines on Rust canister testing.
Integration testing
Integration testing refers to testing multiple components of a code or application together to ensure that they operate correctly. Integration testing often includes testing how several functions within a canister interact with one another, how different canisters may send and receive information from each other, or how a canister may obtain and digest external information from HTTPS outcalls. One common form of integration testing is continuous integration (CI) testing. CI testing uses an automated workflow to continuously test several components of an application.
GitHub CI testing is a common workflow used by developers that can be configured to run tests whenever new code is pushed to a repository. Learn more about CI tests.
End-to-end testing
End-to-end testing refers to testing the entire functionality of an application, including the frontend user interface. This includes testing buttons, input forms, authentication methods, and the overall user journey within the app. End-to-end tests can be simple, such as testing that a frontend canister successfully communicates with a backend canister.
For more information on end-to-end tests, check out the developer journey module on testing.
Tools for testing canisters
There are several tools available for testing ICP canisters. Motoko-specific libraries can be found in the section above, unit testing. Details about more comprehensive testing suites can be found below.
PocketIC
PocketIC is a comprehensive testing suite that can be used for testing canisters with custom environments, allowing you to test applications against real-world scenarios that your application may encounter once deployed on the mainnet. PocketIC tests can be written in several languages, including:
Light Replica
Light Replica is a community-contributed tool designed to replicate the local testing environment that the Ethereum tools Hardhat or Truffle provide. Light Replica replicates the behavior of a real ICP node by running a local instance of a node, then providing additional logging and functionality to enable canister testing. Light Replica can be used to test any Wasm file as if it were a canister deployed on the mainnet.
Learn more about Light Replica.
Manual staging environments
As an alternative to using the environments provided by PocketIC or Light Replica, you can also manually make a staging environment with dfx that you can test your code against. Learn more about creating a staging environment with dfx.