Kavun

Kavun is a lightweight spec runner library for Javascript.

The Real Kavun

The project is named after my elder cat Kavun.

Installation

npm install kavun

Usage Examples

Unit

A sync example for unit

const assert = require('assert');
const { unit } = require('kavun');

unit('Example unit', () => {
  const expected = 2;
  const actual = 2;
  assert.equal(actual, expected);
});

An async example with async/await

const assert = require('assert');
const { unit } = require('kavun');

unit('Example async unit with async / await', async () => {
  const actual = () => new Promise(resolve => resolve(true));
  const expected = true;
  const result = await actual();
  
  assert.equal(expected, result);
});

An async example with Promise, don't forget to return the promise

const assert = require('assert');
const { unit } = require('kavun');

unit('Example async unit with async / await', () => {
  const actual = () => new Promise(resolve => resolve(true));
  const expected = true;
  
  return actual().then(result => assert.equal(expected, result));
});

Timeout

Timeout for each spec is 1500 miliseconds by default. To increase this amount, timeout attribute inside of the options object should be provided to the unit, as shown in the example;

unit('Example unit with extended timeout', async () => {
  const actual = () => new Promise(resolve => setTimeout(() => resolve(true), 1700));
  const expected = true;

  const result = await actual();
  assert.equal(expected, result);
}, { timeout: 2000 });

Spec

const assert = require('assert');
const { spec, unit } = require('kavun');

spec('Example Spec', () => {
  unit('unit', () => {
    const expected = 2;
    const actual = 2;
    assert.equal(actual, expected);
  });

  spec('Async', () => {
    unit('with async / await', async () => {
      const actual = () => new Promise(resolve => resolve(true));
      const expected = true;

      const result = await actual();

      assert.equal(expected, result)
    });
  });
});

Contribution

Project requires NodeJS version 9 to be installed

Install NodeJS 9 and then run following command to install dependencies;

npm i

Use following command to run the tests;

npm test

Install/setup, via nix

The project can be built and run locally using nix, to reproduce the environment.

Make sure to have nix installed (see nixos.org/nix) and then
cd <project-dir>
run nix-shell and you should have the environment up and running
install all node modules using npm install
prove that it works, npm test
now you have a shell with a deterministic environment (incl. node version)

pinarkaymaz6/kavun