Pico-Tester is a lightweight test runner for Javascript. It is a fork of kavun by @SengitU.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
wolframkriesing 5d9319c6ce Improving docs a bit. 4 months ago
docs/adr Rename from kavun to pico-tester (pt). 5 months ago
examples Put all how-to-load tests into one package, and have multiple tests for it. 4 months ago
lib A bit more space a the beginning of the line that reports the test result. 4 months ago
test Refactor tests to use the same command, just pass the arg. 4 months ago
.gitignore Add microbundle to create all kinds of builds so it can be used anywhere, I hope ;). 4 months ago
.travis.yml Make travis use the "latest stable Node.js release". 5 months ago
CHANGELOG.md Planning 4 months ago
Dockerfile Make smoke work. 4 months ago
README.md Improving docs a bit. 4 months ago
package-lock.json Microbundle is not needed currently. 4 months ago
package.json Microbundle is not needed currently. 4 months ago
run.sh Remove nix, provide docker. 5 months ago

README.md

Pico Tester

Pico Tester is a small and fast spec runner for Javascript. Mocha, Jest, etc. bring too much burden along, either from history or features. This library is a reset. Using the least needed for a test runner. Also in terms of dependencies pico-tester tries to use the least needed.

See the ADRs and tenets below for understanding what drives and steers this project.

History - The Real Kavun

The project is a fork of @SengitU‘s project Kavun. He started this project during his apprenticeship at HolidayCheck, to build a tiny, lightweight test runner, to figure out what a test runner really just needs.

Installation

npm install pico-tester

Usage Examples

  • Run the tests just for one file do
    pt test-files.spec.js
  • or multiple files
    py 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.)
    pt *.js
  • for all files found in root and up to 2 sub-directories, ending in .js
    pt {,**,**/**}/*.js
  • and mix any of the above
    pt test-files.spec.js {,**,**/**}/*.js

Pico-tester does not contain any file-grep functionality. Use your command line’s grep and/or file finding features. This was done to reduce 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 'pico-tester';

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 'pico-tester';

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 'pico-tester';

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 'pico-tester';

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. Provided is also ./run.sh bash which ony requires docker and an image is provided that sets up the entire environment.

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 the project’s 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).

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