@test-runner/tom

This project and documentation are a work in progress.

Used for defining a test suite for use with a compatible runner. The model describes your test functions, how they are grouped, the order in which they should run, the config for each (timeout, max concurrency etc.)

It is supplied as input to a compatible runner, for example: test-runner or web-runner.

Synopsis

Trivial example creating a TOM containing two tests - one pass and one fail. Create a test by supplying a name and test function to tom.test. If the function throws or rejects the test is considered a fail.

import Tom from '@test-runner/tom'
const tom = new Tom()

tom.test('A successful test', function () {
  return 'This passed'
})

tom.test('A failing test', function () {
  throw new Error('This failed')
})

export default tom

Save the above to file named test.mjs, you can now run this test suite in several ways. For example, you can run it in Node.js by supplying it as input to test-runner.

$ test-runner tmp/synopsis.mjs

Start: 2 tests loaded

✓ synopsis A successful test [This passed]
⨯ synopsis A failing test

   Error: This failed
       at TestContext.<anonymous> (file:///Users/lloyd/Documents/test-runner-js/tom/tmp/synopsis.mjs:10:9)
       ...
       at processTimers (internal/timers.js:475:7)


Completed in 10ms. Pass: 1, fail: 1, skip: 0.

To confirm the test suite and the code under test is isomorphic you can run the same TOM in the browser (Chromium) using web-runner.

$ web-runner tmp/synopsis.mjs

Start: 2 tests loaded

✓ tom A successful test [This passed]
⨯ tom A failing test

   Error: This failed
       at TestContext.<anonymous> (http://localhost:7357/output.mjs:894:9)
       ...
       at http://localhost:7357/output.mjs:2016:21


Completed in 8ms. Pass: 1, fail: 1, skip: 0.

API summary

Supply a name and test function to tom.test. If the function throws or rejects the test is considered a fail.

tom.test('name', function () {
  // test
})

Skip a test.

tom.skip('name', function () {
  // test
})

Skip all but this and any other tests marked as only.

tom.only('name', function () {
  // test
})

Group.

const myGroup = tom.group('My group')

Before and after

tom.before('name', function () {
  // test
})

tom.after('name', function () {
  // test
})

Todo

tom.todo('name', function () {
  // Complete later
})

Reset a completed test, ready to run again.

tom.reset()

Documentation

• API reference

---

© 2018-21 Lloyd Brookes <75pound@gmail.com>.