Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.71 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.71 KB
Raw

Overview

This document describes the current state of the organization of integration tests, along with info on how to run them.

Running integration tests

There are commands provided in the Makefile to make running them easier. To run the current integration test, you should run:

# This will ensure we start from a clean node and client
make clean-node
# This command will clone the node's repo and generate the accounts and genesis files
make node
# This command will run the node
make start-node

And on a second terminal do:

# This will run the integration test 
make integration-test-full

Note that in order to run this as part of a CI/CD workflow (at least on github), you'll need to use make start-node & instead so the process keeps running on background.

Integration Test Flow

The integration test goes through a series of supported flows such as minting and transferring assets which runs against a running node.

Setup

Before running the tests though, there is a setup we need to perform to have a node up and running. This is accomplished with the node command from the Makefile and what it does is:

  • Clone the node repo if it doesn't exist.
  • Delete previously existing data.
  • Generate genesis and account data with cargo run --release --bin miden-node --features testing -- make-genesis --inputs-path node/genesis.toml.

Also, you need to install the tests dependencies with make test-deps.

After that we can start the node, again done in the start-node command from the Makefile. Killing the node process after running the test is also the user's responsibilty.

Test Run

To run the integration test you just need to run make integration-test. It'll run the integration tests as a cargo test using the integration feature which is used to separate regular tests from integration tests.

Ignored Tests

Currently, we have one ignored test because it requires having the genesis data from the node it is running against which might not always be possible. You can run it manually by doing:

cargo nextest run --release --test=integration --features integration --run-ignored ignored-only -- test_import_genesis_accounts_can_be_used_for_transactions

Or run make integration-test-full to run all integration tests with that included. On the other hand, if you want to run integration tests without that one you can just instead do:

make integration-test

Running tests against a remote node

You can run the integration tests against a remote node by overwriting the rpc section of the configuration file at ./config/miden-client-rpc.toml.

CI integration

There is a step for the CI at ../.github/workflows/ci.yml used to run the integration tests.