muggle-test

Muggle

Muggle is a testing library without magic.

It outputs TAP version 13, and supports any assertion library that throws an AssertionError

Goals

• Predictable and simple behavior
• Simple and readable source code
• Intuitive and small API
• Encourage writing robust and readable tests
• Fully tested

Install

$ npm install muggle-test muggle-assert

Usage

A test passes if its callback finishes execution without throwing an error.

const test = require('muggle-test')

// passing test
test('3 + 2 should equal 5', () => {
  if (3 + 2 !== 5) {
    throw new Error('3 + 2 !== 5')
  }
})

// failing test
test('3 + 10 should equal 5', () => {
  if (3 + 10 !== 5) {
    throw new Error('3 + 10 !== 5')
  }
})

Async functions work exactly the same way! await is used internally to catch both exceptions and rejections.

const test = require('muggle-test')

test('asyncAdd() should add correctly', async () => {
  const sum = await asyncAdd(3, 2)

  if (sum !== 5) {
    throw new Error('asyncAdd(3, 2) should resolve with 5')
  }
})

Use an assertion library like muggle-assert to keep tests simple and readable. See its readme for details on its API.

const test = require('muggle-test')
const assert = require('muggle-assert')

test('numbers should add up to 5', async () => {
  const num1 = 3
  const num2 = 2

  // muggle-assert will throw an error if an assertion fails
  assert(typeof num1 === 'number', 'num1 should be a number')
  assert(typeof num2 === 'number', 'num2 should be a number')

  const sum = await asyncAdd(num1, num2)

  assert.equal(sum, 5)
})

Parallel

Tests are run in parallel, so make sure tests don't interfere with each other by changing the same global state.

This makes tests complete faster, but it's also much more predictable to keep tests seperate.

Running tests

To run tests simply execute the file

$ node test.js

and pipe to your favorite tap reporter

$ node test.js | tap-spec

To run in browser use tape-run

$ browserify test.js | tape-run

Assertions

Muggle is compatible with any assertion library that throws an error, but muggle-assert is recommended.

The name, message, and stack properties of errors thrown in a test callback will be printed to the TAP output if they are defined.

The actual, expected, and operator properties from an AssertionError will also be included if defined.

TAP directives

There is also a third parameter opts for the TAP todo and skip directives

skip

If opts.skip is truthy, then the test is marked as skipped in the TAP output, and the callback won't be run. If opts.skip is a string, then it will be output as the explanation.

const test = require('muggle-test')

test('3 + 2 should equal 5', () => {
  // won't run unless window is defined
}, { skip: window ? false : 'browser only test' })

TODO

If opts.todo is truthy, then the test is marked as incomplete in the TAP output. If opts.todo is a string, then it will be output as the explanation. The test will run normally and output a failing test on errors, but TAP reporters won't count it as a test failure.

const test = require('muggle-test')

test('sum(3, 2) should equal 5', () => {
  // incomplete function
  function sum () {}

  if (sum(3, 2) !== 5) {
    throw new Error('sum(3, 2) !== 5')
  }
}, { todo: 'implement sum()' })