tape-run

A tape test runner that runs your tests in a (headless) browser and returns 0/1 as exit code, so you can use it as your npm test script.

Usage

First write a test utilizing tape and save it to test/test.js:

var test = require('tape');

test('a test', function (t) {
  t.ok(true);
  t.end();
});

Then run this command using tape-run and browserify and watch the magic happen as the TAP results stream in from a browser (default: electron):

$ browserify test/*.js | tape-run
TAP version 13
# one
ok 1 true

1..1
# tests 1
# pass  1

# ok

$ echo $?
0

API

You can use tape-run from JavaScript too:

var run = require('tape-run');
var browserify = require('browserify');

browserify(__dirname + '/test/test.js')
  .bundle()
  .pipe(run())
  .on('results', console.log)
  .pipe(process.stdout);

And run it:

$ node example/api.js
TAP version 13
# one
ok 1 true

1..1
# tests 1
# pass  1

# ok
{ ok: true,
  asserts: [ { ok: true, number: 1, name: 'true' } ],
  pass: [ { ok: true, number: 1, name: 'true' } ],
  fail: [],
  errors: [],
  plan: { start: 1, end: 1 } }

run([opts])

opts can be:

• wait (Number) [Default: 1000]: Make tap-finished wait longer for results. Increase this value if tests finish without all tests being run.
• port (Number): If you specify a port it will wait for you to open a browser on http://localhost:<port> and tests will be run there.
• browser (String): Browser to use. Defaults to electron. Available if installed:
  • chrome
  • firefox
  • ie
  • phantom
  • safari

The CLI takes the same arguments, plus --render (see blow):

$ tape-run --help
Pipe a browserify stream into this.
browserify [opts] [files] | tape-run [opts]

Options:
  --wait     Timeout for tap-finished                                                                                
  --port     Wait to be opened by a browser on that port                                                             
  --browser  Browser to use. Always available: electron. Available if installed: chrome, firefox, ie, phantom, safari  [default: "electron"]
  --render   Command to pipe tap output to for custom rendering
  --help     Print usage instructions                                                                                

Custom Rendering

In order to apply custom transformations to tap output without sacrificing the proper exit code, pass --render with a command like tap-spec:

$ browserify test.js | tape-run --render="tap-spec"

  one

    ✔ true

Headless testing

To use the default electron browser on travis, add this to your travis.yml:

addons:
  apt:
    packages:
      - xvfb
install:
  - export DISPLAY=':99.0'
  - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
  - npm install

Source.

For gnu/linux installations without a graphical environment:

$ sudo apt-get install xvfb # or equivalent
$ export DISPLAY=':99.0'
$ Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
$ browser-run ...

There is also an example docker machine here.

Installation

With npm do

$ npm install tape-run -g # for cli
$ npm install tape-run    # for api

License

(MIT)

Copyright (c) 2013 Julian Gruber <julian@juliangruber.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.