davidmiani / karma-growl-reporter

A Karma plugin. Report results with growl.

karma-growl-reporter

Report test results using Growl.

Installation

At first, make sure you have Growl for Mac / Windows / Linux. This plugin uses growly, which uses the Growl Network Transport Protocol (GNTP), which was implemented in Growl since version 1.3, so you must have an appropriate version of Growl installed for this plugin to work.

The easiest way is to keep karma-growl-reporter as a devDependency in your package.json.

{
  "devDependencies": {
    "karma": "~0.10",
    "karma-growl-reporter": "~0.1"
  }
}

You can simple do it by:

npm install karma-growl-reporter --save-dev

Configuration

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['progress', 'growl'],
  });
};

You can pass list of reporters as a CLI argument too:

karma start --reporters growl,dots

Message labels

The notifications are given different growl labels, which can be used to configure how each are shown in the growl client:

• New Success: The test run succeeded for the first time after startup or test failure
• Success: All other successful test runs
• Failed: The test run failed
• Aborted: For some reason the test run did not work

For example, you may make the "Success" and "New Success" green, Failure red, and Aborted orange. Or you may wish to hide the Success notifications, so you only see test success notification after they have fixed a test failure.

Message Prefix (Optional)

Adds a prefix to the growl message to help differentiate which tests have passed or failed. This is especially usefull if you are running multiple auto-watch instances of karma in parallel.

karma-unit.conf

module.exports = function(config){
    config.set({
        reporters: ['progress','growl'],
        growlReporter:{
            prefix:'UNIT TESTS-'
        }
   });
};

karma-production.conf

module.exports = function(config){
    config.set({
        reporters: ['progress','growl'],
        growlReporter:{
            prefix:'PRODUCTION TESTS-'
        }
   });
};

---

For more information on Karma see the homepage.