[go: up one dir, main page]
Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 3.1 KB

core_testing.md

File metadata and controls

55 lines (34 loc) · 3.1 KB
Raw

Core Testing

This is a small guide for holochain core testing. This should not be used to test your hApp's code, but instead to test holochain's core code. To test hApp code, use tryorama.

Holochain's unit tests for holochain core are located just beside the source code. You can open any rust source code file, and it will have at the end its own tests. Also you can find integration tests in the test folder in each crate. To know where you should place your tests, follow Rust's conventions for testing.

There are tests at different levels of integration, so you can tailor your tests to whatever components or flows you want. For example, there are tests that only call functions for a workflow to validate its procedure, but there are also tests that boot up a conductor and call functions to it simulating a UI.

These tests will be run every time you post a new pull request in CircleCI.

Requirements

  • Having nix-shell installed (instructions).
  • Having rust and cargo installed and in the stable toolchain

Running tests

First of all, from the root folder, run nix-shell.

  • To run all tests in from all the crates, run this from the root folder:
hc-merge-test

You can also use hc-test if you don't want to run cargo fmt and cargo clippy, but both of this will be RUN on CircleCI.

  • To run only one test from your crate, run this command:
cd crates/holochain
cargo test [NAME_OF_THE_TEST_FUNCTION] --lib  --features 'slow_tests build_wasms' -- --nocapture

If the test is located in a crate other than holochain, cd into its folder instead.

Adding a test

The simplest way to add a new test is to locate a similar test, copy and paste it, and modify the necessary instructions to test what you want. Don't forget to change its name. Note that these tests are for testing holochain core, and not the wasms themselves. To unit test a wasm, the test should be added to the wasm.

Adding a custom zome to call from a test

The tests can access and call WASM-compiled zomes that are present in the test_utils folder. To add new custom zomes in that folder:

  1. Add the zome's source code inside the crates/test_utils/wasm/wasm_workspace folder.
  2. In the crates/test_utils/wasm/src/lib.rs file:
  • Add the zome's name in TitleCase in the TestWasm enum.
  • Add a match arm inside the impl From<TestWasm> for ZomeName implementation that points to the folder you have created.
  • Add a new match arm inside the impl From<TestWasm> for DnaWasm implementation with the same path as all other arms but with the zome's name.
  1. In the members property of the crates/test_utils/wasm/wasm_worskpace/Cargo.toml file, add the folder name for your zome.

Examples