Welcome to Q-test

Q-test is a Javascript-based EOS smart-contract testing framework, created by GenerEOS.

Q-test gives you the ability to dockerize an EOSIO node that can run on any system. This allows the ability for the user to host it on their system easily and automated with the ability to test for multiple EOSIO based chains i.e. EOS, WAX, TELOS, UX.

Overview

Installation

Refer to an example project

npm install --save-dev @genereos.io/qtest

Jest

Install jest

npm install --save-dev jest@^28.1.3

Config jest: Create jest.config.js and add following:

module.exports = {
  // transform: { "^.+\\.(ts|tsx)$": "ts-jest" },
  testEnvironment: "node",
  testTimeout: 120 * 1e3,
};

Docker

Refer at here

Run

Update test command in package.json

"test": "jest"

Run

npm run test

Usage

const { Chain } = require("@genereos.io/qtest");
const { expectAction } = require("@genereos.io/qtest");

User documentation

• Introduction to Q-test
• Installing Q-test
• Using Q-test to write contract tests
• Building and Deploying EOS Smart-Contracts in Q-test
• Interacting with Q-test in a smart contract project
• [Inegrating with CI/CD pipeline] ()

Q-test API

Classes

• Asset
• Account
• Chain
• Contract
• Symbol
• Table

Functions

• Assertion
• dockerClient
• serializer
• utils
• Wallet

Support

For issues not covered in the documentation, please jump into our channel and we will do our best to help you out GenerEOS channel on Telegram.

Licence

This code is provided as is, under MIT Licence.