grunt-wendy

grunt-wendy

CasperJS test runner built for GruntJS

This was originally a fork of ronaldlokers/grunt-casperjs but with more features:

• custom casper test runners
• no grunt output (silent flag of grunt-casperjs is always on)
• customizable output parsing
• aggregated results across all casper tasks run
• custom grunt exit status (warns on skips/dubious instead of failing)

Screenshot

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install --save-dev grunt-wendy

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wendy');

The "wendy" task

Overview

In your project's Gruntfile, add a section named wendy to the data object passed into grunt.initConfig().

Usage Examples

Default Options

grunt.initConfig({
  wendy: {
    options: {
      async: 'eachSeries',
      clean: true,
      cli: [],
      runner: 'test',
      formatter: formatter, // function in tasks/lib/formatter.js
      fail: ['failed'],
      warn: ['dubious', 'skipped']
    },
    files: ['tests/e2e/**/*.js']
  },
})

Async

Tasks are run in series by default (one after the other). To change how tests are run, set the async option to a node async compatible value such as:

• each - run in parallel
• eachSeries - run in series

wendy: {
  options: {
    async: 'each'
  },
  inparallel: ['tests/e2e/a/*.js'],
  inparallel2: ['tests/e2e/b/*.js']
}

Clean

This task tries to clean up the casper output a bit and outputs aggregated test results when multiple suites (multiple files) are run in a single task.

You can set the option to false to disable it. The default formatter uses this option.

wendy: {
  options: {
    clean: false
  },
  tests: ['tests/e2e/**/*.js']
}

CLI Options

CasperJS CLI options (including user defined ones) can be passed in using 'cli' in the options object

wendy: {
  options: {
    cli: ['--foo=bar', '--no-colors']
  },
  files: ['tests/e2e/**/*.js']
}

Runner

The task uses casper's included test runner by default. If you'd like to use a custom runner, casper allows this. Specify a new test runner JS file to the runner option and wendy will hook it up.

wendy: {
  options: {
    runner: 'tests/e2e-runner.js'
  },
  files: ['tests/e2e/**/*.js']
}

Formatter

This task captures all casper output and allows formatting of that output. The formatter can be customized by passing in a function like so:

wendy: {
  options: {
    formatter: function (grunt, options, data) {
      grunt.log.write(data);
    }
  },
  files: ['tests/e2e/**/*.js']
}

The data argument is always a string, a line from casper's stdout or stderr.

The default formatter uses the clean option as well. See its source here for an example: formatter.js

Grunt exit status

Instead of failing on dubious tests or passing when tests are skipped, this task only fails when a test actually fails. You can go back to default grunt behavior, or customize your own using the fail and warn options. The options take an array with values passed, failed, dubious, and skipped.

wendy: {
  options: {
    fail: ['failed'], // fail the task if any tests failed
    warn: ['dubious'] // grunt warning when tests dubious
  },
  files: ['tests/e2e/**/*.js']
}

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Follow the standards of the included eslint and markdownlint.

CHANGELOG

• 0.0.6
  • Add fail and warn options
• 0.0.5
  • Add formatter option
• 0.0.4
  • Use grunt.util.linefeed for better Windows output
• 0.0.3
  • Add test for dubious output
  • Fix aggregated output (skipped and dubious showing same result)
• 0.0.2
  • Split into modules in lib/
• 0.0.1
  • Forked from ronaldlokers/grunt-casperjs
  • Refactor into single grunt task module
  • Rename task from casperjs to wendy
  • Changed casperjsOptions option key to cli
  • Add support for custom runner
  • Always use silent option from unpublished release of casperjs
  • Expose node async settings
  • parse casper output and show aggregated results for a set of files if clean option is true (default)

---