thunk-test

ThunkTest

Modular testing for JavaScript. Set up tests as thunks, then execute them with a call.

const assert = require('assert')
const identity = require('./identity')
const ThunkTest = require('thunk-test')

describe('identity', () => {
  it('returns whatever was passed to it', ThunkTest('identity', identity)
    .case(1, 1)
    .case('hey', 'hey')
    .case(NaN, result => assert(isNaN(result)))
  )
})
//   identity
// -- identity
//  ✓ identity(1) -> 1
//  ✓ identity('hey') -> 'hey'
//  ✓ identity(NaN) |> result => assert(isNaN(result))
//     ✓ returns whatever was passed to it

ThunkTests are composed of a string descriptor, a function to test, and test cases denoted by .case and .throws.

ThunkTest(
  'pipe: awesome username generator',
  pipe([
    string => string.toUpperCase(),
    string => `x${string}x`,
    string => `X${string}X`,
    string => `x${string}x`,
    string => `_${string}_`,
  ]))
  .case('deimos', '_xXxDEIMOSxXx_') // objects deep equal, otherwise strict equal
  .case('|', result => assert.equal(result, '_xXx|xXx_')) // can supply a callback
  .case('?', async result => assert.equal(result, '_xXx?xXx_')) // async ok
  .throws(1, new TypeError('string.toUpperCase is not a function'))
  .throws(null, (err, arg0) => {
    assert.strictEqual(arg0, null)
    assert.strictEqual(err.name, 'TypeError')
    assert.strictEqual(err.message, 'Cannot read property \'toUpperCase\' of null')
  })()
// -- pipe: awesome username generator
//  ✓ pipeline('deimos') -> '_xXxDEIMOSxXx_'
//  ✓ pipeline('|') -> result => assert.equal(result, '_xXx|xXx_')
//  ✓ pipeline(1) throws TypeError: string.toUpperCase is not a function
//  ✓ pipeline(null) throws; (err, arg0) => {
//       assert.strictEqual(arg0, null)
//       assert.strictEqual(err.name, 'TypeError')
//       assert.strictEqual(err.message, 'Cannot read property \'toUpperCase\' of null')
//     }
//  ✓ pipeline('?') -> async result => assert.equal(result, '_xXx?xXx_')
//  ✓ pipeline(NaN) throws; async (err, arg0) => {
//       assert.strictEqual(arg0, NaN)
//       assert.strictEqual(err.name, 'TypeError')
//       assert.strictEqual(err.message, 'string.toUpperCase is not a function')
//     }

Syntax

ThunkTest(story string, func function) -> thunkTest ()=>() {
  case: (...args, expectedResult)=>this,
  throws: (...args, expectedError)=>this,
}

Installation

with npm

npm i thunk-test

browser script, global ThunkTest

<script src="https://unpkg.com/thunk-test"></script>

browser module

import ThunkTest from 'https://unpkg.com/thunk-test/es.js'