Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
grunt-contrib-qunit
Advanced tools
Run QUnit unit tests in a headless PhantomJS instance.
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 grunt-contrib-qunit --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-contrib-qunit');
Run this task with the grunt qunit
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
When installed by npm, this plugin will automatically download and install PhantomJS locally via the grunt-lib-phantomjs library.
Also note that running grunt with the --debug
flag will output a lot of PhantomJS-specific debugging information. This can be very helpful in seeing what actual URIs are being requested and received by PhantomJS.
Type: Number
Default: 5000
The amount of time (in milliseconds) that grunt will wait for a QUnit start()
call before failing the task with an error.
Type: String
Default: (built-in)
Path to an alternate QUnit-PhantomJS bridge file to be injected. See the built-in bridge for more information.
Type: Array
Default: []
Absolute http://
or https://
urls to be passed to PhantomJS. Specified URLs will be merged with any specified src
files first. Note that urls must be served by a web server, and since this task doesn't contain a web server, one will need to be configured separately. The grunt-contrib-connect plugin provides a basic web server.
Type: String
Default: (none)
Additional --
style arguments that need to be passed in to PhantomJS may be specified as options, like {'--option': 'value'}
. This may be useful for specifying a cookies file, local storage file, or a proxy. See the PhantomJS API Reference for a list of --
options that PhantomJS supports.
In this example, grunt qunit:all
(or grunt qunit
because qunit
is a [multi task][]) will test all .html
files in the test directory and all subdirectories. First, the wildcard is expanded to match each individual file. Then, each matched filename is passed to PhantomJS (one at a time).
// Project configuration.
grunt.initConfig({
qunit: {
all: ['test/**/*.html']
}
});
In circumstances where running unit tests from local files is inadequate, you can specify http://
or https://
URLs via the urls
option. Each URL is passed to PhantomJS (one at a time).
In this example, grunt qunit
will test two files, served from the server running at localhost:8000
.
// Project configuration.
grunt.initConfig({
qunit: {
all: {
options: {
urls: [
'http://localhost:8000/test/foo.html',
'http://localhost:8000/test/bar.html'
]
}
}
}
});
Wildcards and URLs may be combined by specifying both.
It's important to note that grunt does not automatically start a localhost
web server. That being said, the grunt-contrib-connect plugin connect
task can be run before the qunit
task to serve files via a simple connect web server.
In the following example, if a web server isn't running at localhost:8000
, running grunt qunit
with the following configuration will fail because the qunit
task won't be able to load the specified URLs. However, running grunt connect qunit
will first start a static connect web server at localhost:8000
with its base path set to the Gruntfile's directory. Then, the qunit
task will be run, requesting the specified URLs.
// Project configuration.
grunt.initConfig({
qunit: {
all: ['http://localhost:8000/test/foo.html', 'http://localhost:8000/test/bar.html']
},
connect: {
server: {
options: {
port: 8000,
base: '.'
}
}
}
});
// This plugin provides the "connect" task.
grunt.loadNpmTasks('grunt-contrib-connect');
// A convenient task alias.
grunt.registerTask('test', ['connect', 'qunit']);
In the following example, the default timeout value of 5000
is overridden with the value 10000
(timeout values are in milliseconds). Additionally, PhantomJS will read stored cookies from the specified file. See the PhantomJS API Reference for a list of --
options that PhantomJS supports.
// Project configuration.
grunt.initConfig({
qunit: {
options: {
timeout: 10000,
'--cookies-file': 'misc/cookies.txt'
},
all: ['test/**/*.html']
}
});
QUnit callback methods and arguments are also emitted through grunt's event system so that you may build custom reporting tools. Please refer to to the QUnit documentation for more information.
The events (with arguments) are as follows:
qunit.begin
qunit.moduleStart
: namequnit.testStart
: namequnit.log
: result, actual, expected, message, sourcequnit.testDone
: name, failed, passed, totalqunit.moduleDone
: name, failed, passed, totalqunit.done
: failed, passed, total, runtimeIn addition to QUnit callback-named events, the following event is emitted when PhantomJS is spawned for a test:
qunit.spawn
: urlYou may listen for these events like so:
grunt.event.on('qunit.spawn', function (url) {
grunt.log.ok("Running test: " + url);
});
Task submitted by "Cowboy" Ben Alman
This file was generated on Thu Feb 28 2013 11:58:59.
FAQs
Run QUnit unit tests in a headless Chrome instance
The npm package grunt-contrib-qunit receives a total of 18,056 weekly downloads. As such, grunt-contrib-qunit popularity was classified as popular.
We found that grunt-contrib-qunit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.