npm:zebra-tests

README

Zebra-Tests

zebra-tests is a tool to test Solidity smart contracts. It works underneath Tron IDE plugin "Solidity Unit Testing" which is used to write and run test cases for a contract. Tests are written in Solidity itself. zebra-tests can be used as CLI and a library too.

Installation

As a dev dependency:

npm install --save-dev zebra-tests

As a global NPM module to use as CLI:

npm -g install zebra-tests

Test structure

zebra-tests provides and injects a built-in assert library for testing purpose.

Assert library

Available functions	Supported types
`Assert.ok()`	`bool`
`Assert.equal()`	`uint`, `int`, `bool`, `address`, `bytes32`, `string`
`Assert.notEqual()`	`uint`, `int`, `bool`, `address`, `bytes32`, `string`
`Assert.greaterThan()`	`uint`, `int`
`Assert.lesserThan()`	`uint`, `int`

Available special functions:

Apart from above, library provides some special functions as:

beforeEach() - runs before each test
beforeAll() - runs before all tests
afterEach() - runs after each test
afterAll() - runs after all tests

How to use

As command line interface

To run all files inside examples directory

$ zebra-tests examples/

To run single test file named simple_storage_test.sol inside examples directory

$ zebra-tests examples/simple_storage_test.sol

NOTE: zebra-tests will assume that name of tests file ends with "_test.sol". e.g simple_storage_test.sol

Example: Consider for a simple storage contract named simple_storage.sol:

pragma solidity >=0.4.22 <0.7.0;

contract SimpleStorage {
  uint public storedData;

  constructor() public {
    storedData = 100;
  }

  function set(uint x) public {
    storedData = x;
  }

  function get() public view returns (uint retVal) {
    return storedData;
  }
}

test file simple_storage_test.sol can be as:

pragma solidity >=0.4.22 <0.7.0;
import "zebra_tests.sol"; // injected by zebra-tests
import "./simple_storage.sol";

contract MyTest {
  SimpleStorage foo;

  function beforeEach() public {
    foo = new SimpleStorage();
  }

  function initialValueShouldBe100() public returns (bool) {
    return Assert.equal(foo.get(), 100, "initial value is not correct");
  }

  function valueIsSet200() public returns (bool) {
    foo.set(200);
    return Assert.equal(foo.get(), 200, "value is not 200");
  }

  function valueIsNotSet200() public returns (bool) {
    return Assert.notEqual(foo.get(), 200, "value is 200");
  }
}

Running simple_storage_test.sol file will output as:

    ◼  MyTest
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
    ✓  Initial value should be100
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
    ✓  Value is set200
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
[19:15:02] payload method is  eth_gasPrice
[19:15:02] payload method is  eth_sendTransaction
[19:15:02] payload method is  eth_getTransactionReceipt
    ✓  Value is not set200

:point_right: zebra-test can also be used for continuous integration testing. See example Su Squares contract and Travis build

As a Library for development

Import library:

const ZebraTests = require('zebra-tests');

Run a single test object:

ZebraTests.runTest (testName: string, testObject: any, contractDetails: CompiledContract, fileAST: AstNode, opts: Options, testCallback: TestCbInterface, resultsCallback: ResultCbInterface)

Params:-

testName - Name of the test
testObject - Web3 1.0 contract instance of the test
contractDetails - Contract details
fileAST - AST of test file
opts - Custom options
testCallback(object) - Called each time there is a test event. 3 possible type of objects:

{ type: 'contract', value: '<TestName>', filename: '<test_filename.sol>' }
{ type: 'testPass', value: '<name of testing function>', time: <time taken>, context: '<TestName>'}
{ type: 'testFailure', value: '<name of testing function>', time: <time taken>, context: '<TestName>', errMsg: '<message in the Assert>' }

resultsCallback(object) - Callback with test results

passingNum - number of passing tests
failureNum - number of failing tests
timePassed - time it took for all the tests to run (in seconds)

Running a set of tests given the sourcecode:

ZebraTests.runTestSources(contractSources: SrcIfc, versionUrl: string, usingWorker: boolean, testCallback: Function, resultCallback: Function, finalCallback: any, importFileCb: Function, opts: Options);