node-tdd

node-tdd

Drop in replacement for mocha to abstract commonly used test setups

Install

Install with npm:

$ npm install --save node-tdd

Usage

Drop-in replacement for mocha by simply importing describe as below.

const expect = require('chai').expect;
const { describe } = require('node-tdd');

describe('Testing some stuff', /* { ...options }, */ () => {
  it('Testing a thing', () => {
    expect(3 * 7).to.equal(21);
  });
});

Please see tests for further usage examples.

Function Kwargs

dir

Type: string

The tmp directory for this test. Only available when useTmpDir is set.

getConsoleOutput

Type: function

Can be called to access the currently captured logs. Returns array of logs. Can access different types of logs by accessing the properties log, info, error, warn. Only available when recordConsole is set.

capture

Type: function

Utility function that takes a function as an argument, calls it and expects it to raise an error. The raised error is returned. If not error is raised an assertion error is thrown instead.

Options

useTmpDir

Type: boolean
Default: false

When set to true, a fresh temporary directory is set up for each test. The directory is cleaned up after the test run has completed.

useNock

Type: boolean
Default: false

When set to true, all requests are automatically nocked. The recording files are automatically created relative to the current test file.

envVars

Type: object
Default: -

Used to declare environment variables per describe. Environment variables are also picked up from shadow files as e.g. test.spec.js.env.yml.

To allow overwriting of environment variables prefix the name of the environment variable with ^.

timestamp

Type: number
Default: -

Set unix timestamp to freeze time to. Will modify the result of e.g. new Date().

recordConsole

Type: boolean
Default: false

When set to true, console logging calls are recorded and can be accessed by calling getConsoleOutput() from within the test.

cryptoSeed

Type: string
Default: -

When set, randomization is overwritten and consistent per test using the provided seed.

timeout

Type: number
Default: -

Set the timeout for all tests in the suite.