Test small things, with a small thing
Go to file
Geoff Doty 6f3b2aca3b inversed if to remove extra else clauses 2018-06-06 08:02:31 -04:00
dist inversed if to remove extra else clauses 2018-06-06 08:02:31 -04:00
src reworked assertions to use an expect BDD-like 2018-04-07 04:07:58 -04:00
test renaming 2018-06-06 07:59:42 -04:00
.gitignore add .gitignore 2018-04-02 04:24:53 -04:00
.jshintrc added package.json and .jshintrc for linting 2018-04-02 05:20:43 -04:00
CONTRIBUTING.md added CONTRIBUTING doc 2018-04-02 06:24:55 -04:00
LICENSE add license 2018-04-02 04:24:39 -04:00
README.md reworked assertions to use an expect BDD-like 2018-04-07 04:07:58 -04:00
gulpfile.js added build process (gulp) 2018-04-07 04:03:46 -04:00
package-lock.json added build process (gulp) 2018-04-07 04:03:46 -04:00
package.json added build process (gulp) 2018-04-07 04:03:46 -04:00

README.md

Test.it

A minimalistic testing library

Test.it is a small testing library for people that want to live in code, not in tests. No over engineering here. Inspired by the simplicity of libraries like Tape,but the implementation ideas of things like Expect and TinyTest

This is probally not a cure-all testing solution, if you want something more robust checkout Jasmine, Tape or Mocha -- this is to...

Test small things, with small things

Features

  • Works in the Browser
  • Works with CommonJS (aka NodeJS)
  • Barely over a 100 lines
  • Single File
  • No Dependicies
  • 2kb footprint (before gzip)
  • Extend with custom reporters
  • Has an Expect-like style BDD assertions

No Bloat Here!

Usage

By default, you can run your tests like

test.it({
    'my passing test': function() {
        test.expects().to.pass();
    },
    'my failing test': function() {
        test.expects().to.fail('just wanted to fail fast');
    }
}).run();

NOTE: run() can be called elsewhere, see tests/

test.it will return true if the tests pass or false otherwise. Typical console output:

+ my passing test
- my failing test
- - Error: just wanted to fail fast 
    ...error stack...
# tests 1 pass 1 fail 0

A + will proceed test lines that pass and a - for those that fail, the trace back file:line is included after the failing test proceeded by - -

NOTE: API still in flux, and may change to closer match TAP

Optional Next

test.it .run() method provides an optional next function parameter that passes the results as an object for you to process however you like. such as a custom runner

For Example...

For Fans of TinyTest

test.it({
    'my passing test': function() {
        test.pass();
    }
}, function(results) {
    if (window.document && document.body) {
        document.body.style.backgroundColor = (
            results.fail.length ? '#ff9999' : '#99ff99'
        );
    }
});

Sample Results Object

{
    "pass": ["list of passed tests", "..."],
    "fail": ["list of errored tests", "..."],
}

From this object you can easily find the number of tests ran pass.length, number of failed tests fail.length or the total test count by adding the two. Simple.

Methods

To stay minimal, test.it only has 3 core functions:

  • it to capture your tests
  • run to execute yours tests
  • and expects to write your test assertions

While you can use your own assertion library, the included expects provides the following methods for writing your tests:

Methods Description
.expects(tests).to.exist() truthy evalution if value exists
.expects().to.pass() pass test
.expects().to.fail(message) fails test with message
.expects(this).to.equal(that) strictly equal evaluation using ===
.expects(this).to.be.like(that) loose evaluation using ==
.expects(123).to.be.a('number') check typeof value (.a() or .an())

NOTE: wish eval was not so evil, assert(expression, message) would be ideal

if you want to shorten test typing try

let expect = test.expects;

putting that above your tests will allow you to write like

test.it({
    "my test should work": function() {
        expect().to.pass();
    }
});

Support

Please open an issue for support.

Contributing

Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines, there minimalistic;)

License

MIT