intestify

# intestify

Framework for client side unit tests and code coverage combining Babel, Jasmine, Istanbul and Phantom with support for fixtures, ajax mock, ES6, Gulp and Grunt

• Jasmine v2.3.4 for unit tests and Istanbul for code coverage
• Tests run on Phantom 1.9.8 (included) or 2.0.0 (tested)
• Babel (ES6) support for source and spec files
• Easy Gulp integration. Also works as a Grunt plugin
• Includes Jasmine ajax mock and fixtures auto load
• Istanbul outputs summary to console and full reports to file
• Jasmine reports to console and to JUnit XML for CI
• Spec runner can also run in a full browser

With focus on performance, everything runs on file://. No server start/stop and no net socket communication between Jasmine, Phantom or Node. It uses stdio.

Install

npm install --save-dev intestify

Usage

var intestify = require('intestify');
 
intestify([options]);

Example:

intestify({
  src: 'src/**/*.js',
  lib: ['lib/jquery/*.min.js', 'lib/**/*.js'],
  spec: 'test/spec/*.js',
  fixture: 'test/fixture/*'
});

See example project

Gulp example

See a gulpfile.js that runs only changed specs

Grunt example

This module also works as a Grunt 0.4 plugin. See a gruntfile.js

Options

[options] is an object with the following properties and default values:

• base (path): It's the base path for test files. Will be the parent directory of spec, tmp, fixture and report folders when using defaults. Otherwise one must set all paths individually.
  Defaults try to find ./test or ./tests directory and use it as base path
• src (glob): JavaScript source files. The ones that will be instrumented and tested.
  Defaults to ['src/**/*.js','app/**/*.js']
• lib (glob): Other JavaScript files. Will not be tested nor instrumented. Usually this property should be overridden to ensure libs loading order.
  Defaults to ['lib/**/*.js', 'vendor?(s)/**/*.js']
• tmp (path): Path to write instrumented source code, fixtures file and final generated spec runner.
  Defaults to [base]/tmp
• spec (glob): Jasmine spec files. The ones that will test the src files.
  Defaults to [base]/spec?(s)/**/*.js
• runner (file): Jasmine spec runner template. Will be used to generate the final HTML spec runner with calls to src, lib and spec files.
  Defaults to intestify/lib/jasmine/SpecRunner.html
• fixture (glob): Files to be available as fixtures inside spec files. Access fixtures with getFixture([filename]).
  Defaults to [base]/fixture/*
• callback (function): Callback function is called when all tests end and reports are written.
  Defaults to null
• jasmine
  • report (path): Path to write Jasmine JUnit XML reports.
    Defaults to [base]/report/unit
• istanbul
  • report (path): Path to write Istanbul file reports.
    Defaults to [base]/report/coverage
  • reporters (array): List of Istanbul reporters.
    Defaults to ['text-summary', 'lcov', 'clover']
• phantom
  • bin (file): Phantom binary file location.
    Defaults uses the included npm phantom
  • verbose (boolean): Show resource errors e.g. file not found.
    Defaults to false
  • params (object): Phantom additional runtime parameters. See some useful parameters
    Defaults to {}.

Example project structure

Works with this module's default options

project/
├── lib/
│   ├── jquery
│   │   └── jquery-2.1.4.min.js
│   └── etc...
├── src/
│   ├── app.js
│   ├── util.js
│   └── etc...
└── test/
    ├── fixture/ (optional)
    │   └── all fixture files... (auto-loaded)
    ├── report/ (auto-created)
    │   ├── coverage
    │   │   └── Istanbul reports...
    │   └── unit
    │       └── Jasmine reports...
    ├── spec/ (required)
    │   └── all spec files...
    └── tmp/ (auto-created)
        ├── isrc.js (generated instrumented src)
        ├── fixture.js (generated fixtures file)
        ├── spec.js (generated combined spec file)
        └── SpecRunner.html (generated spec runner)

Using fixtures

All files from the fixtures glob are loaded and made available as an object to the spec files. Properties are filenames and values are strings. See FixtureSpec example

// on any spec file, get the song.json fixture as a JSON
var song = JSON.parse(getFixture('song.json'))

// show object with all fixtures
console.log(getFixture());

Run Jasmine tests in a browser

After running some tests, open the generated spec runner [base]/[tmp]/SpecRunner.html in a browser with GUI (not Phantom). It is useful for test development and debug of Jasmine specs

Istanbul coverage reports

Console shows only a summary report. Open [base]/[report]/coverage/lcov-report/index.html in a browser for full coverage report

Editing the spec runner

Copy the original spec runner's template from intestify/lib/jasmine/SpecRunner.html to another path and run with option {runner:'path/to/new/runner.html'}. Edit the new runner as needed but keep the Jasmine and fixture script/style includes

Jasmine ajax tests

XHR tests use the included Jasmine Mock ajax.

Example at /example/test/spec/AjaxSpec.js

Remember to run jasmine.Ajax.install() before any ajax request and don't bother to turn it off. Usually it's turned on and off because fixtures are fetched using ajax. This module preload fixtures and do not use ajax to load them.

Phantom 2.0

This module comes with npm phantom v1.9.8 (as of may 2015). To run with Phantom 2.x, install it and use the option below.

intestify({
  phantom: {
    bin : '/path/to/phantom2',
  }
})

Phantom dependency causes installation to fail

Read the phantomjs module troubleshooting

Useful Phantom parameters

intestify({
  phantom: {
    params: {
      // forbids cross-domain XHR (default is true)
      'web-security': true|false
      // ignores SSL errors such as expired or self-signed (default is false)
      'ignore-ssl-errors': true|false
      // load all inlined images (default is true)
      'load-images': true|false
      // allows local content to access remote URL (default is false)
      'local-to-remote-url-access': true|false
    }
  }
})