CONTRIBUTING.md

Tests

To be merged, pull requests MUST include tests for any new features or bug fixes.

Structure

The tests are located in the test/ directory. The structure of the directory is as follows:

• api/ - End-to-end tests that require running a local test node.
• unit/ - Unit tests that DO NOT require running a test node.
• common/ - Contains stub objects and utilities for the tests.
• node.js - Package for making requests to the local test node.
• config.json - Configuration file to run a local test node; copy config.default.json
• genesisBlock.json - Genesis block data.
• genesisDelegates.json - Genesis delegate accounts.
• genesisPasses.json - Passphrases for the genesis accounts.

All tests inside api/ and unit/ should mirror (as much as possible) the structure of the project. For example, unit tests for the modules/blocks.js module should be located in the test/unit/modules/blocks.js file.

Commands

Note

API tests require the testnet node to be running in parallel during their execution, whereas unit tests require the testnet to be run at least once:

npm run start:testnet

See Test Environment for reference.

To run a single test file, use the following command:

npm run test:single test/path/to/the/test.js

If you have changed any common files (e.g., files inside test/common/, test/node.js package, etc.), consider running all tests:

# run all unit tests
npm run test:unit

# run only fast unit tests (excluding time-consuming ones)
npm run test:unit:fast

# run all API tests
npm run test:api

# run both unit and API tests
npm run test:all

Convention for tests

Since we use the Chai package for assertions, we have a few rules for consistency:

• Use proper English grammar in assertions

  // ❌
  expect({}).to.be.a('object');
  // ✅
  expect(true).to.be.an('object');

• Use to.be.true instead of to.be.ok

  Boolean values should be strictly asserted:

  // ❌
  expect(true).to.be.ok;
  // ✅
  expect(true).to.be.true;

• Use not.to instead of to.not

  Prefer not.to for convention:

  // ❌
  expect(true).to.not.be.false;
  // ✅
  expect(true).not.to.be.false;

• Use .equal() instead of .eql() for ===

  Use .eql() only for deep assertion.

  // ❌
  expect(true).to.eql(true);
  // ✅
  expect(true).to.be.true;

• Use parentheses for functions and methods in describe names

  // ❌
  describe(`functionName`, () => { /* ... */ })
  // ✅
  describe(`functionName()`, () => { /* ... */ })