ttf - Tiny Test Framework (for NodeJS)

Getting start

$ npm install ttf

or

$ npm install git+https://github.com/g-corp/ttf.git --save-dev

then

$ mkdir test
$ $EDITOR test/test_suite.js

All test suites file name must start with test and have a .js extension.

In your editor :

const fs = require('fs');
const { 
  suite,
  test,
  mock,
  beforeEach,
  afterEach,
  assertTrue,
  assertFalse,
  assertEqual,
  assertNotEqual,
  assertCall,
  assertThrows
} = require('ttf');

suite('Simple suite one', () => {
  beforeEach(() => {
    mock.new(fs);
  });

  afterEach(() => {
    mock.unload(fs);
  });

  test('should mock fs.statSync', () => {
    mock.expect(fs, 'statSync', file => {
      return {mock: 'ok', file};
    });

    const r = fs.statSync(__filename);

    assertEqual(r, {mock: 'ok', file: __filename});
    assertCall(fs, 'statSync', 1);
    assertCall(fs, 'statSync', [__filename]);
  });

  test('sould be true', () => {
    assertTrue(true);
  });

  test('should be false', () => {
    assertFalse(false);
  });

  test('should return 4', () => {
    assertEqual(2 + 2, 4);
  });

  test('should not return 4', () => {
    assertNotEqual(2 + 3, 4);
  });

  test('should throw an exception', () => {
    assertThrows(
      () => {
        call_undefined_function();
      },
      ReferenceError,
      'call_undefined_function is not defined',
    );
  });
});

Then, to run all test suites :

$ npx ttf test

To run on specific test suite :

$ npx ttf test/test_suite.js

or

$ node test/test_suite.js

API Reference

ttf

ttf.mock : `object`

mock

Kind: static namespace of ttf

.mock : object

mock.passthrough

Passthrough value for moxk.

Kind: static property of mock

mock.new(module)

Declare a new mock for the module.

Kind: static method of mock

Param	Type	Description
module	`module`	Module to mock.

Example

const {
  suite,
  test,
  assertEqual,
  mock,
  assertCall,
  beforeEach,
  afterEach,
} = require('ttf');
const fs = require('fs');

suite('mock a nodejs module', () => {
  beforeEach(() => {
    mock.new(fs);
  });

  afterEach(() => {
    mock.unload(fs);
  });

  test('mock fs.stats', () => {
    mock.expect(fs, 'statSync', file => {
      return {mock: 'ok', file};
    });

    const r = fs.statSync(__filename);

    assertEqual(r, {mock: 'ok', file: __filename});
    assertCall(fs, 'statSync', 1);
    assertCall(fs, 'statSync', [__filename]);
  });
});

mock.unload(module)

Unload mock for the module.

Kind: static method of mock

Param	Type	Description
module	`module`	Module to mock.

Example

const {
  suite,
  test,
  assertEqual,
  mock,
  assertCall,
  beforeEach,
  afterEach,
} = require('ttf');
const fs = require('fs');

suite('mock a nodejs module', () => {
  beforeEach(() => {
    mock.new(fs);
  });

  afterEach(() => {
    mock.unload(fs);
  });

  test('mock fs.stats', () => {
    mock.expect(fs, 'statSync', file => {
      return {mock: 'ok', file};
    });

    const r = fs.statSync(__filename);

    assertEqual(r, {mock: 'ok', file: __filename});
    assertCall(fs, 'statSync', 1);
    assertCall(fs, 'statSync', [__filename]);
  });
});

mock.expect(module, fname, [fn])

Mock the function fname in module.

Kind: static method of mock

Param	Type	Description
module	`module`	Module to mock.
fname	`string`	Name of the function to mock in the module.
[fn]	`function` \| `mock.passthrough` \| `any`	Mock result.

Example

const {
  suite,
  test,
  assertEqual,
  mock,
  assertCall,
  beforeEach,
  afterEach,
} = require('ttf');
const fs = require('fs');

suite('mock a nodejs module', () => {
  beforeEach(() => {
    mock.new(fs);
  });

  afterEach(() => {
    mock.unload(fs);
  });

  test('mock fs.stats', () => {
    mock.expect(fs, 'statSync', file => {
      return {mock: 'ok', file};
    });

    const r = fs.statSync(__filename);

    assertEqual(r, {mock: 'ok', file: __filename});
    assertCall(fs, 'statSync', 1);
    assertCall(fs, 'statSync', [__filename]);
  });
});