feather-test-browser

Lightweight test coverage for browser-ready code

Runs on the easy-to-use feather-test library

Install

$ npm install feather-test-browser --save-dev

Write Some Tests

myProject/test/specs/one.spec.js

describe('gizmo is a mogwai', function () {

    describe('when you feed him after midnight', function () {

        describe('he becomes a gremlin', function (expect) {
            expect(skin).not.toBe('furry');
            expect(temperament).toContain('angry');
            expect(explosions).toBeGreaterThan(99, 'explosions caused by gremlins');
        });

    });

});

myProject/test/specs/two.spec.js

// example of an asynchronous test
describe('teddy ruxpin is the creepiest bear ever', function () {

    describe('he blinks twice every 3 seconds', function (expect, done) {
        activateTeddy();
        setTimeout(function () {
            expect(timesBlinked).toBe(4);
            done();
        }, 6000);
    });

});

myProject/package.json

{
  "scripts": {
    "test": "node ./test/run"    
  }
}

myProject/
  |--test/
  |  |--specs/
  |  |  |--one.spec.js
  |  |  |--two.spec.js
  |  |--run.js
  |--src/
  |  |--etc.
  |--package.json

Run Your Tests

myProject/test/run.js

var FeatherTestBrowser = require('feather-test-browser');

// create a new test suite with your spec files
var myTests = new FeatherTestBrowser({
    helpers: './helpers',
    specs: './specs'
});

// run your tests and get a link to run them again in any browser
// (optional callback)
myTests.run(callback);

$ cd myProject
$ npm test

// You will be given a URL that you can open in any browser on your machine

Notes

Your browser-ready tests will also be run in NodeJS with a simulated browser environment (node-as-browser)
NOTE: the optional callback executes when run in NodeJS but cannot be passed into a real browser

Configuration and Options

See feather-test for full documentation on assertions, matchers, and other options that are available in feather-test-browser.

ES6 with Babel

If you need to run modern code in older browsers you can pass options into the bundler. See bundl-pack for more options.

var FeatherTestBrowser = require('feather-test-browser');
var babelProcessor = require('bundl-pack-babel');

var myTests = new FeatherTestBrowser({
    specs: './specs',
    bundlPack: {
        js: babelProcessor({
            presets: ['es2015-ie'],
        })
    }
});

Additional Spec Methods

external.loadScript

Load external scripts into your spec environment at runtime.

requires an absolute path reference to a script file (uses file:// protocol)
scripts will be loaded asynchronously, but sequentially
FeatherTestBrowser should be initialized so that nodeAsBrowser uses the file:// protocol

var testSuite = new FeatherTestBrowser({
    nodeAsBrowser: {
        url: 'file://' + __dirname,
    }
});

describe('try loading a script', function (expect, done) {
    // ext files each execute `window.foo++`

    window.foo = 0;

    external.loadScript('/Users/me/Projects/feather-test-browser/ext1.js', function () {
        expect(window.foo).toBe(1);
    });

    external.loadScript('/Users/me/Projects/feather-test-browser/ext2.js', function () {
        expect(window.foo).toBe(2);
        done();
    });
});

raymondborkowski/feather-test-browser