README for cardano-node-tests

System and end-to-end (E2E) tests for cardano-node.

Check this documentation for more details.

Running tests using GitHub Actions

The easiest way to run the tests is by using GitHub Actions.

1. Fork this repository.
2. Enable GitHub Actions in your fork ("Settings" / "Actions" / "General" / "Actions permissions", check "Allow all actions and reusable workflows").
3. Go to "Actions", select "01 Regression tests" (or "02 Regression tests with db-sync").
4. Select "Run workflow".

Running tests using Nix

1. Install and configure Nix by following the cardano-node documentation.

2. Clone this repository.

3. Run the tests:

   ./.github/regression.sh

---

NOTE

When using CI_BYRON_CLUSTER, it takes approximately 30 minutes for the local cluster instance to progress from Byron to Conway. If it seems that the tests are stuck, they are likely just waiting for the local cluster instances to fully start.

---

Running individual tests on a local cluster using Nix and custom binaries

In some cases, you may want to run individual tests with custom cardano-cli or cardano-node binaries.

1. Place your custom binaries in the .bin directory.

2. Run the desired test. For example:

   TEST_THREADS=0 CLUSTERS_COUNT=1 PYTEST_ARGS="-k 'test_minting_and_burning_sign[asset_name-build_raw-submit_cli]'" ./.github/regression.sh

To view all executed cardano-cli commands during the test run, add --log-level=debug to the pytest arguments:

TEST_THREADS=0 CLUSTERS_COUNT=1 PYTEST_ARGS="-k 'test_minting_and_burning_sign[asset_name-build_raw-submit_cli]' --log-level=debug" ./.github/regression.sh

1. After the test, make sure to remove the binaries from .bin to avoid conflicts with future tests.

Running individual tests on a persistent local cluster using Nix

Sometimes it is useful to run individual tests and keep the local cluster running between test runs.

1. Run a Nix shell that has all the needed dependencies:

   nix flake update --accept-flake-config --override-input cardano-node "github:IntersectMBO/cardano-node/master"  # change `master` to the revision you want
   nix develop --accept-flake-config

2. Prepare the testing environment:

   source ./prepare_test_env.sh conway

3. Start the cluster instance:

   ./dev_workdir/conway_fast/start-cluster

4. Run some tests:

   pytest -s -k test_minting_one_token cardano_node_tests/tests/tests_plutus
   # or run some tests and see all the executed `cardano-cli` commands
   pytest -s --log-level=debug -k test_minting_one_token cardano_node_tests/tests/tests_plutus

5. Stop the cluster instance:

   ./dev_workdir/conway_fast/stop-cluster

To reuse the existing testing environment in another Nix shell, source the .source file that was generated during setup:

source ./dev_workdir/.source

Variables for configuring test runs

Test execution can be configured using environment variables.

• SCHEDULING_LOG – specifies the path to the file where log messages for tests and the cluster instance scheduler are stored.
• PYTEST_ARGS – specifies additional arguments for pytest (default: unset).
• MARKEXPR – specifies marker expression for pytest (default: unset).
• TEST_THREADS – specifies the number of pytest workers (default: 20).
• CLUSTERS_COUNT – number of cluster instances that will be started (default: 9).
• CLUSTER_ERA – cluster era for Cardano node – used for selecting the correct cluster start script (default: conway).
• COMMAND_ERA – era for cardano-cli commands – can be used for creating Shelley-era (Allegra-era, ...) transactions (default: unset).
• NUM_POOLS – number of stake pools created in each cluster instance (default: 3).
• ENABLE_LEGACY – use legacy networking instead of the default P2P networking (default: unset).
• MIXED_P2P – use a mix of P2P and legacy networking; half of the stake pools using legacy and the other half P2P (default: unset).
• UTXO_BACKEND – 'mem' or 'disk', default is 'mem' (or legacy) backend if unset (default: unset).
• SCRIPTS_DIRNAME – path to a directory with local cluster start/stop scripts and configuration files (default: unset).
• BOOTSTRAP_DIR – path to a bootstrap directory for the given testnet (genesis files, config files, faucet data) (default: unset).
• KEEP_CLUSTERS_RUNNING – don't stop cluster instances after the test run is finished. (WARNING: this implies interactive behavior when running tests using the ./.github/regression.sh script).
• PORTS_BASE – base port number for the range of ports used by cluster instances (default: 23000).

When running tests using the ./.github/regression.sh script, you can also use:

• CI_BYRON_CLUSTER – start local cluster in Byron era, and progress to later eras by HFs (same effect as SCRIPTS_DIRNAME=conway).
• NODE_REV – revision of cardano-node (default: 'master').
• DBSYNC_REV – revision of cardano-db-sync (default: unset; db-sync is not used by default).
• CARDANO_CLI_REV – revision of cardano-cli (default: unset; cardano-cli bundled in cardano-node repo is used by default).
• PLUTUS_APPS_REV – revision of plutus-apps (default: 'main').

For example:

• Running tests on local cluster instances, each with 6 stake pools and a mix of P2P and legacy networking:

  NUM_POOLS=6 MIXED_P2P=1 ./.github/regression.sh

• Running tests on local cluster instances using 15 pytest workers, Conway cluster era, cluster scripts that start a cluster directly in Conway era, and selecting only tests without 'long' marker that also match the given -k pytest argument:

  TEST_THREADS=15 CLUSTER_ERA=conway SCRIPTS_DIRNAME=conway_fast PYTEST_ARGS="-k 'test_stake_pool_low_cost or test_reward_amount'" MARKEXPR="not long" ./.github/regression.sh

• Running tests on Shelley-qa testnet with '8.0.0' release of cardano-node:

  NODE_REV=8.0.0 BOOTSTRAP_DIR=~/tmp/shelley_qa_config/ ./.github/regression.sh

Local usage for test development (useful only for test developers)

Install and configure Nix by following the cardano-node documentation. Install and configure Poetry by following the Poetry documentation.

Preparing Python virtual environment

Create a Python virtual environment and install this package together with development requirements:

make install

Running development cluster

When running tests, the testing framework starts and stops cluster instances as needed. That is not ideal for test development, as starting a cluster instance can take up to several epochs (to get from Byron to Conway). To keep the Cardano cluster running between test runs, start it in 'development mode':

1. Change directory to 'cardano-node' repository:

   cd ../cardano-node

2. Update and checkout the desired commit/tag:

   git checkout master
   git pull origin master
   git fetch --all --tags
   git checkout tags/<tag>

3. Launch the devops shell:

   nix develop .#devops

4. Run a fresh login shell on top of the current Nix shell (to get the correct environment variables):

   /bin/bash --login

5. Change directory back to 'cardano-node-tests' repository:

   cd ../cardano-node-tests

6. Activate the virtual environment:

   source "$(poetry env info --path)"/bin/activate

7. Add the virtual environment to PYTHONPATH:

   export PYTHONPATH="$(echo $VIRTUAL_ENV/lib/python3*/site-packages)":$PYTHONPATH

8. Set environment variables:

   export CARDANO_NODE_SOCKET_PATH="$PWD/dev_workdir/state-cluster0/bft1.socket" DEV_CLUSTER_RUNNING=1
   mkdir -p "${CARDANO_NODE_SOCKET_PATH%/*}"

9. Prepare cluster scripts for starting the local cluster directly in Conway era:

   prepare-cluster-scripts -c -d dev_workdir/conway_fast -s cardano_node_tests/cluster_scripts/conway_fast/

10. Start the cluster instance in development mode:

    ./dev_workdir/conway_fast/start-cluster

After the cluster starts, keys and configuration files are available in the ./dev_workdir/state-cluster0 directory. The pool-related files and keys are located in the nodes subdirectory, genesis keys in the shelley and byron subdirectories, and payment address with initial funds and related keys in the byron subdirectory. The local faucet address and related key files are stored in the addrs_data subdirectory.

Restarting development cluster

To restart the running cluster (e.g., after upgrading cardano-node and cardano-cli binaries), run:

./scripts/restart_dev_cluster.sh

---

NOTE

Restarting the running development cluster is useful mainly when using the "conway" start scripts (not the "conway_fast" version). It takes approximately 30 minutes for the local cluster instance to progress from Byron to Conway. Starting the local cluster using the "conway_fast" version takes less than 1 minute.

---

Checking the development environment

To check that the development environment was correctly set up, run the make check_dev_env script.

$ make check_dev_env
'cardano-node' available: ✔
'cardano-cli' available: ✔
'python' available: ✔
'pytest' available: ✔
'nix-shell' available: ✔
'jq' available: ✔
'supervisord' available: ✔
'supervisorctl' available: ✔
'bech32' available: ✔
inside nix shell: ✔
in repo root: ✔
DEV cluster: ✔
python works: ✔
in python venv: ✔
venv in PYTHONPATH: ✔
cardano-node-tests installed: ✔
pytest works: ✔
same version of node and cli: ✔
socket path set: ✔
socket path correct: ✔
socket path exists: ✔
cluster era: default
command era: latest
using dbsync (optional): ✔
dbsync available: ✔
'psql' available: ✔
P2P network (optional): -

Running individual tests

Example:

pytest -k "test_name1 or test_name2" cardano_node_tests
pytest -m "not long" cardano_node_tests
pytest -m smoke cardano_node_tests/tests/test_governance.py

Running linters

It is sufficient to activate the Python virtual environment before running linters; a development cluster is not needed:

1. Activate the virtual environment:

   source "$(poetry env info --path)"/bin/activate

2. Run linters:

   make lint

Installing cardano-clusterlib in development mode

Sometimes it is useful to test local changes made to cardano-clusterlib. To install cardano-clusterlib in development mode:

1. Activate the virtual environment:

   source "$(poetry env info --path)"/bin/activate

2. Update the virtual environment (answer 'y' to the question "Install into the current virtual env? [y/N]"):

   make install

3. Uninstall cardano-clusterlib installed by Poetry:

   pip uninstall cardano-clusterlib

4. Change directory to 'cardano-clusterlib-py' repository:

   cd ../cardano-clusterlib-py

5. Install cardano-clusterlib in development mode:

   pip install -e . --config-settings editable_mode=compat

6. Change directory back to 'cardano-node-tests' repository:

   cd -

7. Check that you are really using cardano-clusterlib files from your local repository:

   python -c 'from cardano_clusterlib import clusterlib_klass; print(clusterlib_klass.__file__)'

Note that after you run poetry install (e.g., through running make install), Poetry will reinstall cardano-clusterlib. If you want to keep using cardano-clusterlib in development mode, you'll need to repeat the steps above.

Updating dependencies using Poetry

Edit pyproject.toml and run:

./poetry_update_deps.sh

Building documentation

Build and deploy documentation:

make doc

Contributing

Install this package and its dependencies as described above.

Run pre-commit install to set up the Git hook scripts that will check your changes before every commit. Alternatively, run make lint manually before pushing your changes.

Follow the Google Python Style Guide, with the exception that formatting is handled automatically by Ruff (through the pre-commit command).

See the CONTRIBUTING document for more details.