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 :

`js
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])](#module_ttf.assertThrows)
* .assertCall(module, fn, expected)

$3

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


$3

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

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


$3

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

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


$3

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

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

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

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


$3

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

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

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

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


$3

Example
`js
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);
});
});
`


$3

Example
`js
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);
});
});
`


$3

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

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


$3

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

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


$3

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

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


$3

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

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


$3

Example
`js
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',
);
});
});
`


$3

Example
`js
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.
1. 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.
1. 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.