gruu v0.2.1

gruu

Modern, small and powerful testing with TAP output and support for async/await, promises, callbacks, streams and observables, built on always-done.

Install

Install with npm

$ npm i gruu --save

Usage

For more use-cases see the tests

const assert = require('assert')
const test = require('gruu')({ serial: true }) // same as test({ serial: true })

// custom reporter
test
  .on('start', (test) => {})
  .on('beforeEach', (test) => {})
  .on('test', (test) => {})
  .on('todo', (test) => {})
  .on('skip', (test) => {})
  .on('pass', (test) => {})
  .on('fail', (test) => {})
  .on('error', (test) => {})
  .on('afterEach', (test) => {})
  .on('done', (test) => {})

// can use it to pass options object
// better place is after the require
test({ showStack: true })

// normal test
test('foo bar', function () {})

// chaining
test('third test', () => {
  return 123
})(function fourthTestHere () => {
  // name of the function is
  // the name of the test :)
  return 33
})('fifth and', () => {
  assert.equal(1, 1)
})('so so on...', () => {})

// async/await
test('asynchronous title test', async function () {
  return await Promise.resolve(123)
})

// passing callback test
test('callback style test', function (done) {
  done()
})

// failing callback test
test('failing callback', (done) => {
  done(null, new Error('foo bar'))
})

// failing callback test
test('some failing test', (done) => {
  assert.strictEqual(111, 222)
  done()
})

// promise returning
test(() => {
  return Promise.resolve('foo bar baz')
})

// rejected promise
test(() => {
  return Promise.reject(new Error('foo err'))
})

// synchronous passing test
test('some synchronous title', function () {
  assert.ok(true)
})

// failing synchronous
test('some title', function () {
  assert.strictEqual(111, 222)
})

API

test

Single and simple test as seen in ava and tape testing. The fn is passed to always-done, so it can support async/await, promises, streams, observables and synchronous functions.

Params

• [title] {String|Function|Object}: name of the test, fn or options object
• <fn> {Function}: test function to be called, passed to always-done
• returns {Function}: returns same function, which is also instance of Gruu and so it is eventemitter, so has .on, .emit and etc methods

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent