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 = ;const suite test mock beforeEach afterEach assertTrue assertFalse assertEqual assertNotEqual assertCall assertThrows} = ; ;
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
object
ttf.mock : mock
Kind: static namespace of ttf
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 = ;const fs = ; ;
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 = ;const fs = ; ;
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 = ;const fs = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ; ;
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 = ;const fs = ; ;
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:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- 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.
- 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.