index.js

/*!
 * mukla <https://github.com/tunnckoCore/mukla>
 *
 * Copyright (c) 2016 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)
 * Released under the MIT license.
 */

'use strict'

var exit = process.exit
var utils = require('./utils')

/**
 * > Runs `fn` test and outputs the `name` of the test.
 * If only function is given and it is anonymous, the
 * name of the test is `anonymous`, otherwise the name
 * of the `fn` function.
 *
 * **Example**
 *
 * ```js
 * var test = require('mukla')
 *
 * // failing regular callbacks test
 * test('title of test', function (done) {
 *   test.strictEqual(1, 2)
 *   done()
 * })
 *
 * // passing test with anonymous title
 * test(function (done) {
 *   test.strictEqual(222, 222)
 *   done()
 * })
 * ```
 *
 * @param  {String|Function} `name` the title of the test or `fn`
 * @param  {Function} `[fn]` test function, wrapped in [always-done][]
 * @param  {Boolean} `showStack` if boolean `true`, will print stack when has error
 * @api public
 */

var mukla = module.exports = function mukla (name, fn, showStack) {
  if (typeof name === 'function') {
    fn = name
    name = null
  }
  if (typeof fn !== 'function') {
    throw new TypeError('mukla: expect at least `fn` be function')
  }
  name = name || utils.getFnName(fn) || 'anonymous'
  mukla.emit = (mukla.reporter && mukla.reporter.emit) || null
  mukla.emit = typeof mukla.emit === 'function' ? mukla.emit : null

  utils.alwaysDone(fn, {
    context: this
  }, function (err, res) {
    if (err) return mukla.onFailure(name, fn)(err, showStack)
    mukla.onSuccess(name, fn)()
  })
}

/**
 * Extending `mukla` with `core-assert` methods.
 *
 * @api private
 */

utils.extendShallow(mukla, utils.coreAssert)

/**
 * > When test is successful.
 *
 * @param  {String}   `name`
 * @param  {Function} `fn`
 * @return {Function}
 * @api private
 */

mukla.onSuccess = function onSuccess (name, fn) {
  return function pass () {
    if (mukla.emit) {
      mukla.emit('pass', name, fn)
      return
    }
    console.log('', utils.successSymbol, name)
  }
}

/**
 * > When test is failure.
 *
 * @param  {String}   `name`
 * @param  {Function} `fn`
 * @return {Function}
 * @api private
 */

mukla.onFailure = function onFailure (name, fn) {
  /* istanbul ignore next */
  return function fail (err, showStack) {
    if (mukla.emit) {
      mukla.emit('fail', err, name, fn)
      return
    }

    console.error('', utils.errorSymbol, name)
    console.error(utils.diag(err, showStack))
    exit(1)
  }
}