grunt-blitz
Load Testing From The Cloud
And now from grunt tasks too!
Run blitz.io sprints and rushes from grunt
Getting Started
This plugin requires Grunt ~0.4.1
. You'll also need an account with blitz.io.
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-blitz --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "blitz" task
Overview
In your project's Gruntfile, add a section named blitz
to the data object passed into grunt.initConfig()
.
grunt
Options
options.blitzid
Type: String
Default value: null
This should be the email address associated with your blitz.io account.
e.g. your@email.co.uk
options.blitzkey
Type: String
Default value: null
This is your blitz.io api key.
e.g. hedheshi-815the42-15645344-12345678
N.B. After registering for a blitz.io account, you should be able to find your api details here
options.logPath
Type: String
Default value: null
Optional path to a log file.
options.blitz
Type: String
Default value: null
The blitz.io test you wish to run. For details, look here
e.g. -r ireland http://www.bbc.co.uk
Usage Examples
In this example, we're setting two blitz tests. The first is a simple sprint that checks that www.somepage.co.uk is available from Ireland. The second test is a rush that scales from 1 to 10 concurrent users hitting the site over 100 seconds.
grunt
You can then run either blitz test with:
grunt blitz:sprint
or
grunt blitz:rush
Warning: Don't run grunt blitz
when you have defined multiple tests without specifiying a specific target task as this may result in spamming the blitz.io api and earn you a slap on the wrist.
Authenticating with Blitz.io
It's probably not a great idea to store your api credentials in the Gruntfile. as an alternative you can omit them from the Gruntfile and pass them in at the command line instead:
grunt blitz:sprint --blitzid your@email.co.uk --blitzkey blah-blah-blah-blah
Contributing
Develop in coffee script. Run grunt
to start the compile and test watch processes for convenient TDD. Run grunt build
to test and compile the source before packaging.
Oh yeah, use Git Flow - you know it makes sense :)
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.
Release History
1.0.0 - First release. Whoop!
1.1.0 - AppDex support