medikooTAD - JavaScript test suite
Goal of this framework is to allow writing tests with minimal hassle. TAD will locate your test file, and provide tested module for your test functions.
Example console output:
Installation
$ npm install tadUsage
File management
Keep your tests in test folder. For each file in in main folder have corresponding test file in test folder.
Test files
Tests should be written as set of functions, it can be just one function:
module.exports = function (t, a, d) {
// tests
};or many thematically grouped functions:
exports["Test this"] = function (t, a, d) {
// tests
};
exports["Test that"] = function (t, a, d) {
// tests
};Test functions
Arguments passed to test functions are:
- t - Tested module
- a - Assert object
- d - Done function, it's for tests that need to be run asynchronously. You may pass additional block of tests to this function and they'll be run right after. d argument makes no sense for synchrounous tests, declare such tests without it.
All arguments are optional, and by the way function is declared suite detect which arguments should be passed to test function. Examples:
- Asynchronous test:
exports["Some tests"] = funtcion (t, a, d) {
// tests
setTimeout(function () {
// tests
d();
}, 100);
};- Synchronous test:
exports["Some tests"] = function (t, a) {
// tests
};Tests can be nested, and declared various ways (synchronous/asynchronous)
module.exports["Test all"] = function (t, a) {
// Preparation code
// ... tests ...
return {
"Test this": function () {
// We already have module and assert object
// ... tests ...
},
"Test that async way": function (d) {
// This one is asynchronous
// ... tests ....
seTimeout(function () {
// ... tests ...
d({
"Some extra tests": function () {
// ... tests ...
}
});
}, 100);
}
};
};Assertions
TAD uses assert object from UncommonJS tests runner, It's API is nearly same as of assert that can be found in Node. Full spec is available at https://github.com/kriskowal/uncommonjs/blob/master/tests/specification.md .
TAD adds some extra sugar to UncommonJS Assert object:
a === a.strictEqual, so you can write your assertions as:
a(shouldBeTrue, true, "It's true");
// it has same effect as:
a.strictEqual(shouldBeTrue, true, "It's true");a.notis an alias fora.notStrictEquala.deepis an alias fora.deepEquala.notDeepis an alias fora.notDeepEqualassert.neverwith that you can check function paths that should never be called.
Running tests
Test your file with provided binary:
$ bin/tad lib/test-fileor test all files in path:
$ bin/tad libTODO
- Full custom context support
- Code coverage
- TAP support
- jslint, jshint as side validation option
- Port tests to browsers