README
Testly for NodeJS
Testly is an agile and polyglot testing framework. This is the NodeJS implementation.
Usage
Here is a basic example:
module.exports = function (suite) {
var i = 0;
suite.name("Basic");
suite.init(function () {
i++;
});
suite.define("Passing Test", function (test) {
test.assert(i == 1);
});
suite.define("Failing Test", function (test) {
test.shouldFail(function () {
test.fail();
});
});
suite.define("Assertion Test", function (test) {
test.assert(5 == 5);
test.assert("Hello" == "Hello");
test.assert("Go" != "No");
test.assert("LOL".toLowerCase() == "lol");
});
};
Suite
A suite is a set of tests. Each file where tests are is a separate suite.
API
name
: Gets/Sets the name of the suiteinit
: Pass a function to this function and it will be run before any tests are executed.define
: Defines a new test - args:String, Function
Test
The test
object is passed to each test function as a utility belt :)
API
assert
: Asserts that the input istrue
shouldFail
: Assertions or Errors are ignored in functions passed to itfail
: Fails the Testexec
: Executes a process - (uses shelljs'sexec
function)shell
: shelljs shorthandlog
: String passed to this function will be recorded in the test reports
Assert
test.assert
is a function that can be used like normal test assertions.
test.assert
also adds the assert
module's functions onto it, so it can be used like:
test.assert.equal(5, 5);
Bugs
Please file any bugs on the GitHub Issue Tracker.