• page

Grunt funcunit.grunt


Grunt is a task-based command line build tool for JavaScript projects. FuncUnit tests can be run as a grunt build step. When tests fail, the build also fails.

Grunt provides a plugin system to standardize and easily group common tasks like building, linting, and deployment.

The advantage of using FuncUnit with Grunt is once you configure your project, you can simply run grunt test to run all your project tests via phantom on the commandline. You can even configure your build process to fail when a test is failing.

If you haven't yet, first read up on Phantom in NodeJS Mode. Setting that up is a prerequisite to setting up FuncUnit in Grunt (Grunt is a NodeJS project).


  1. Follow the installation instructions to set up Phantom in NodeJS Mode.
  2. Install grunt: npm install grunt -g
  3. Set up a package.json file for your project if you haven't already. Add grunt-funcunit as an npm dependency in this file.
    "name": "onesearch",
    "version": "0.0.1",
    "dependencies": {
        "grunt-funcunit": "0.1.0"
    "engines": {
        "node": ">=0.8"
  1. Run npm install, which will install grunt-funcunit in the node_modules folder.
  2. Create a grunt.js file if you haven't already and configure funcunit by pointing it to the URL of your main test file:
module.exports = function (grunt) {

    // Project configuration.
        funcunit: {
            urls: ['http://localhost/myapp/funcunit.html']


    // Default task.
    grunt.registerTask('default', 'test');
    grunt.registerTask('test', 'funcunit');



Once you set this all up, running tests is as simple as grunt test. You'll see commandline output like this:

Brians-MacBook-Pro:myapp brianmoschel$ grunt test
Running "funcunit" task

  Select and remove item from DOM and searchParams
    [x] searchParams.Locations is ready and empty
    [x] Made selection
    [x] searchParams.Locations has one item added
32 passed, 0 failed

Done, without errors.