Unit Testing

To Share and +4 nLEARNs

import {CodeTabs, Language, Github} from "@site/components/codetabs"

Unit tests allow you to test the contract methods individually. They are suitable to check the storage is updated correctly, and that methods return their expected values. They are written in the contract’s language and execute locally.

If you used one of our examples as template, then you simply need to navigate to the contract’s folder, and use yarn test. In case you didn’t, then we recommend you copy the necessary node files (e.g. package.json) from one of our templates.

You can run yarn test from the root folder of each project to run both unit and integration tests.

Snippet I: Testing a Counter

The tests in the Counter Example rely on basic functions to check that the increment, decrement, and reset methods work properly.

Snippet II: Modifying the Context

While doing unit testing you can modify the Environment variables through the VMContextBuilder. This will enable you to, for example, simulate calls from different users, with specific attached deposit and GAS. Here we present a snippet on how we test the donate method from our Donation Example by manipulating the predecessor and attached_deposit.

⚠️ Limitations

Unit tests are useful to check for code integrity, and detect basic errors on isolated methods. However, since unit tests do not run on a blockchain, there are many things which they cannot detect. Unit tests are not suitable for:

For all these cases it is necessary to complement unit tests with integration tests.

Scroll to Top