Sazerac

API

Helpers

The sazerac module exports 3 helper functions:

import { test, given, forCases } from 'sazerac'

test(testFn, definerFn)

Defines test cases for a function

test(mySumFunction, () => {
// test cases for mySumFunction defined here...
})

given([…args])

Defines the functional arguments for a test case

test(mySumFunction, () => {
var testCase = given(1, 2, 3)
})

forCases(…testCases)

Groups multiple test case objects into a collection

test(isPrime, () => {
var primeTestCases = [2, 3, 5, 7].map(given)
var testCaseCollection = forCases(primeTestCases)
})

TestCase | TestCaseCollection

The TestCase and TestCaseCollection objects have an identical API:

expect(value, [message])

Defines the expected return value for the test case. Uses chai assert.deepEqual() to assert that the expected return value equals the actual return value.

test(mySumFunction, () => {
given(1, 2, 3).expect(6)
given(4, 5).expect(9, 'should equal 9')
})

describe(message)

Defines a describe message for the test case.

test(mySumFunction, () => {
given(1, 2, 3)
.expect(6)
.describe('sum of 1, 2, and 3')
})

should(message)

Defines a message to describe the test case assertion. This message is passed to the it function when the test is executed.

test(mySumFunction, () => {
given(1, 2, 3)
.expect(6)
.should('should equal 6')
})

assert(message, assertFn)

Defines a custom assertion for the test case

test(mySumFunction, () => {
given(1, 2, 3)
.assert(
'should set the value of the sum property to 6',
(actualReturnValue) => {
// do anything with actualReturnValue here,
// for example:
assert.equal(actualReturnValue.sum, 6)
}
)
})

before(beforeFn)

Adds a function to run before a test case is executed

import sinon from 'sinon'
const myStubFn = sinon.stub()
test(myStubFn, () => {
given()
.before(() => myStubFn.returns(42))
.expect(42)
})

after(afterFn)

Adds a function to run after a test case is executed

import sinon from 'sinon'
const myStubFn = sinon.stub()
test(myStubFn, () => {
given()
.before(() => myStubFn.returns(42))
.after(() => myStubFn.resetBehavior())
.expect(42)
given().expect(undefined)
})