grunt-plugin-buster v2.0.0
grunt-plugin-buster
Run BusterJS tests
Getting Started
If you haven't used grunt before, be sure to check out the Getting Started guide.
From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:
npm install grunt-plugin-buster --save-dev
Once that's done, add this line to your project's Gruntfile:
grunt.loadNpmTasks('grunt-plugin-buster');
If the plugin has been installed correctly, running grunt --help
at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency
, which ensures that it will be installed whenever the npm install
command is run.
Buster task
Run this task with the grunt buster
command.
This task starts a BusterJS server and a PhantomJS instance, runs all specified tests, and the shuts down the PhantomJS instance and BusterJS server.
Options
config
Type: string
Default: test/buster.js
or spec/buster.js
This option sets the BusterJS configuration file to use when running tests. This is the equivalent to using the -c/--config
option with the buster-test
cli.
groups
Type: array
Default: all
This option sets the BusterJS test configuration groups to load when running tests. This is the equivalent to using the -g/--config-group
option with the buster-test
cli.
port
Type: number
Default: 1111
This option sets the BusterJS server port to use when running browser tests. This is the equivalent to using the --port
option with the buster-server
cli and the -s/--server
option with the buster-test
cli.
reporter
Type: string
Default: dots
This option sets the BusterJS test output reporter to use when running tests. This is the equivalent to using the -r/--reporter
option with the buster-test
cli.
Usage Examples
For most usage, no configuration is required at all. However, if the project being tested is non-standard, configuration would look like the following:
buster: {
options: {
config: 'test/another.buster.js',
groups: ['alpha-group', 'bravo-group'],
port: 2222,
reporter: 'specification'
}
}