Kavun

Kavun is a lightweight spec runner library for Javascript. See the ADRs and tenets below for understanding what drives and steers this project.

The Real Kavun

The project is named after my elder cat Kavun.

Installation

npm install kavun

Usage Examples

• Run the tests just for one file do
  kavun test-files.spec.js
• or multiple files
  kavun test1.spec.js 2.spec.js test/3.spec.js
• or for all .js files (use you command line's file grep features, e.g. * or ** etc.)
  kavun *.js
• for all files found in root and up to 2 sub-directories, ending in .js
kavun {,**,**/**}/*.js
• and mix any of the above
  kavun test-files.spec.js {,**,**/**}/*.js

Kavun does not contain any file-grep functionality. Use your command line's grep and/or file finding features. This was done to remove kavun's complexity.

Parameters

The command line takes:

1. any number of files (no directories!) to run as parameters
2. --reporter which might be console or minimal

Unit

A sync example for unit

import assert from 'assert';
import { it } from 'kavun';

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

An async example with async/await

import assert from 'assert';
import { it } from 'kavun';

it('Example async `it` 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

import assert from 'assert';
import { it } from 'kavun';

it('Example async `it` 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;

it('Example `it` 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

import assert from 'assert';
import { describe, it } from 'kavun';

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

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

      const result = await actual();

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

Tenets

1. In doubt solve it without a new dependency.
2. In doubt don't add a new feature, rather remove one.
3. Prefer speed.
4. Be compatible to mocha-style test libs, allowing well written tests overrules.

Development

The following describes how to (help) develop this code.

Setup and run

Project requires NodeJS to be installed.

• cd <here>
• (if you want a reproducable env using nix) run nix-shell
• npm i to install
• npm test to run all the tests
• develop ...

Install/setup, via nix

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

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

Releasing

You want to know if you are ready to release a new version. Run npm run releasable --silent, this starts a script that checks the CHANGELOG.md, which is your to-do list! What, to-do list? Yes. See below how and why?

To release a new version run npm run release (not npm version!), this will include the checks described and do the release and versioning (read more below).

Recommended Development Process

This project uses the to-do-list-checker. The development process is also described there and will be followed in this project too.