ttf - Tiny Test Framework (for NodeJS)

Getting start

$ npm install git+https://github.com/g-corp/ttf.git --save-dev
$ 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 the 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
  • .mock : object
    • .new(module)
    • .unload(module)
    • .expect(module, fname, fn)
  • .suite(description, fn)
  • .test(description, fn)
  • .beforeEach(fn)
  • .afterEach(fn)
  • .beforeAll(fn)
  • .afterAll(fn)
  • .assertTrue(value)
  • .assertFalse(value)
  • .assertEqual(actual, expected)
  • .assertNotEqual(actual, expected)
  • .assertThrows(fn, [error], [message])
  • .assertCall(module, fn, expected)

ttf.mock : object

mock

Kind: static namespace of ttf

• .mock : object
  • .new(module)
  • .unload(module)
  • .expect(module, fname, fn)

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 with fn.

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 function. |

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]);
  });
});

ttf.suite(description, fn)

Create a new test suite.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | description | string | Suite description. | | fn | function | Function to run. |

Example

const { suite, test, assertTrue } = require('ttf');

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

ttf.test(description, fn)

Create a new test.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | description | string | Test description. | | fn | function | Function to run. |

Example

const { suite, test, assertTrue } = require('ttf');

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

ttf.beforeEach(fn)

Declare fn to run before each tests in the block.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | fn | function | Function to run. |

Example

const { suite, test, beforeEach, assertEqual } = require('ttf');

suite('Simple suite', () => {
  let a;

  beforeEach(() => {
    a = 3;
  });

  test('sould be 3', () => {
    assertEqual(a, 3);
  });
});

ttf.afterEach(fn)

Declare fn to run after each tests in the block.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | fn | function | Function to run. |

Example

const { suite, test, afterEach, assertEqual } = require('ttf');

suite('Simple suite', () => {
  let a;

  afterEach(() => {
    a = undefined;
  });

  test('sould be 3', () => {
    a = 3;
    assertNotEqual(a, 3);
  });
});

ttf.beforeAll(fn)

Declare fn to run before all tests in the block.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | fn | function | Function to run. |

Example

const { suite, test, beforeEach, assertEqual } = require('ttf');

suite('Simple suite', () => {
  let a;

  beforeAll(() => {
    a = 3;
  });

  test('sould be 3', () => {
    assertEqual(a, 3);
  });

  test('sould be 3 as well', () => {
    assertEqual(a, 3);
  });
});

ttf.afterAll(fn)

Declare fn to run after all tests in the block.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | fn | function | Function to run. |

Example

const { suite, test, afterEach, assertEqual } = require('ttf');

suite('Simple suite', () => {
  let a;

  afterAll(() => {
    a = undefined;
  });

  test('sould be 3', () => {
    a = 3;
    assertNotEqual(a, 3);
  });

  test('sould be 3 as well', () => {
    assertEqual(a, 3);
  });
});

ttf.assertTrue(value)

Tests if value is truthy.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | value | any | Value to test. |

Example

const { suite, test, assertTrue } = require('ttf');

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

ttf.assertFalse(value)

Tests if value is falsy.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | value | any | Value to test. |

Example

const { suite, test, assertFalse } = require('ttf');

suite('Simple suite', () => {
  test('sould be false', () => {
    assertFalse(false);
  });
});

ttf.assertEqual(actual, expected)

Tests for deep equality between the actual and expected parameters.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | actual | any | Value to test. | | expected | any | Expected value. |

Example

const { suite, test, assertEqual } = require('ttf');

suite('Simple suite', () => {
  test('sould be equal', () => {
    assertEqual({a: 1}, {a: 1});
  });
});

ttf.assertNotEqual(actual, expected)

Tests for deep inequality between the actual and expected parameters.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | actual | any | Value to test. | | expected | any | Expected value. |

Example

const { suite, test, assertNotEqual } = require('ttf');

suite('Simple suite', () => {
  test('sould be equal', () => {
    assertEqual({a: 1}, {b: 2});
  });
});

ttf.assertThrows(fn, [error], [message])

Expects the function fn to throw an error.

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | fn | function | Function to test. | | [error] | RegExp | function | Object | Error | Expected error. | | [message] | string | Expected error message. |

Example

const { suite, test, assertThrows } = require('ttf');

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

ttf.assertCall(module, fn, expected)

Expects mock call

Kind: static method of ttf

| Param | Type | Description | | --- | --- | --- | | module | module | Module of the function. | | fn | string | Function name. | | expected | integer | Array | Number of call expected or array of parameters. |

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]);
  });
});

Licence

Copyright (c) 2018, Grégoire Lejeune All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.