❤
npm
Sign UpSign In

tape-worm

0.0.3 • Public • Published

tapeworm

Tapeworm allows you to the DOM as a reporter when testing in the browser using tape.

Tapeworm adds three features to tape.

  1. Spits the test results into the DOM.
  2. Colors the background and favicon; green for passing, red for failing, yellow for pending.
  3. Adds an t.html method, where you can inject any arbitrary html into the DOM.

Screenshots

Passing

passing-test-screenshot

Failing

passing-test-screenshot

t.html

This is the main reason that tapeworm exists. By allowing you to add your own html you gain a really powerful test reporter.

Take these two images for example:

two-worms one-worm

We can write a simple test using Resemble.js to diff the images.

test('the worm images should look the same', function (t) {
 
  t.plan(1);
 
  resemble('two-worms.jpg').compareTo('one-worm.jpg')
    .onComplete(function (imgDiffResult) {
 
      var pass = imgDiffResult.rawMisMatchPercentage === 0;
 
      if (!pass) {
        var base64DiffData = imgDiffResult.getImageDataUrl();
        t.html('<img src="' + base64DiffData + '">');
      }
 
      t.equal(pass, true);
    });
});

And now we have image diffs in our output, whoop!

diff-worms

Installation and Usage

npm install tape-worm

Tapeworm is designed to run with tape and all it's variants (blue-tape, redtape, etc). All you need to do is import it into your test file and then infect tape.

// test.js
var test = require('tape');
var tapeworm = require('tape-worm');
 
tapeworm.infect(test);

Use browserify to bundle up the code for browser

browserify test.js > test-bundle.js

Create a simple html wrapper (you need the head section for the favicon injection)

<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <title>tests</title>
  </head>
  <body>
    <script src="test-bundle.js"></script> 
  </body>
</html>

Now load this into the browser and you're done.

If you want it to reload on save you might end up with something like this:

watchify test.js -o test-bundle.js -vd & live-server --watch=test-bundle.js

Warning

Calling tapeworm.infect(test) is monkey patching and you should be aware of the potential pitfalls.

Dependencies (0)

    Dev Dependencies (5)

    Package Sidebar

    Install

    npm i tape-worm

    Repository

    github.com/supercrabtree/tape-worm

    Homepage

    github.com/supercrabtree/tape-worm

    Weekly Downloads

    1

    Version

    0.0.3

    License

    MIT

    Last publish

    Collaborators

    • supercrabtree
    Try on RunKit
    Report malware