Betest

Betest is a small and simple way to write and run JavaScript tests with zero dependencies!

Table of content

• Installation
• Usage
• Examples
• ConstructorParams

Installation

npm install betest --save-dev

For beta see Github

npm install betest@beta --save-dev

Usage

Assuming that you have folder "tests" and file "index.js" inside.

node ./tests/index.js

or add this to your package.json

  "scripts": {
    "test": "node ./tests/index.js"
  },

Example

Create an instance of Betest:

import {Betest} from 'betest';

const betest = new Betest();

You can choose how results will be look in console using parameters object:

betestParams = {
    results: {
        showAs: "Table" // or "Line"(Colorful PASS/FAIL)
    }
}
const betest = new Betest(betestParams);

Add your named group and functions using method "addGroup":

betest.addGroup(
    { 
        name: "Example Group", 
        tests: [
            {   
                expected: {
                    fisrstName: "First Name",
                    secondName: "Second Name"
                },
                test: function checkObject() {
                    return {
                    fisrstName: "First Name",
                    secondName: "Second Name"
                    }
                }
            },
            {   
                expected: 7,
                test: function findHypotenuse() {
                    return Math.round(Math.sqrt(5 ** 2 + 5 ** 2));
                }
            },
            {   
                expected: [
                    [6, -8, 1],
                    [4, 1, 0],
                    [2, 3, 5]
                ],
                test: function checkArrayEquality() {
                    return [
                        [6, -8, 1],
                        [4, 1, 0],
                        [2, 3, 5]
                    ]
                }
            }
        ]
    }
);

You can run all tests in all groups, either one group or only one test in the group:

1. Run all tests in all groups

betest.runAll();

2. Run only one group's tests

betest.runGroup("Example Group");

3. Run only one test in the group

betest.runTest("Example Group", "findHypotenuse");

Or you can run test on the fly

betest.go(
    [ // groups
        { // one group
            tests: {
                expected: 1,
                test: function findSinus() {
                    return Math.sin(90 * 180 / Math.PI);
                }
            }
        }
    ]
);

And see results:

|(index)| (name) | Values | |-------| -------------------| -----------| | 0 | multiplication | true | | 1 | sum | true |

Constructor Params

const betestParams = {
    results: {
        // 1. "Table" for table result.
        // 2. "Line" for colorful PASS/FAIL message
        showAs: string
    }
}