Karma Probe for Probe Dock

Karma reporter to publish test results to Probe Dock.

• Requirements
• Installation
• Usage
• Contributing

Requirements

• Node.js 0.10+
• Karma 0.12.*

Installation

Install it as a development dependency:

npm install --save-dev probedock-karma

If you haven't done so already, set up your Probe Dock configuration file(s). This procedure is described here:

• Probe Setup Procedure

Then add the reporter to your Karma configuration (karma.conf.js):

module.exports = function(config){
  config.set({

    files: ['*.test.js'],
    autoWatch: true,
    frameworks: ['jasmine'],
    browsers: ['Chrome', 'Firefox'],

    // add the reporter
    reporters: ['probedock'],

    // customize the configuration
    probedock: {
      config: {
        project: {
          category: 'Karma (Jasmine)'
        }
      }
    },

    plugins: [
      'karma-chrome-launcher',
      'karma-firefox-launcher',
      'karma-jasmine',
      'probedock-karma' // register the plugin
    ]
  });
};

The next time you run your test suite, the Karma probe will send the results to your Probe Dock server.

Usage

To track a test with a Probe Dock test key, add this annotation to the test name:

describe("something", function() {
  it("should work @probedock(abcd)", function() {
    expect(true).toBe(true);
  });
});

You may also define a category, tags and tickets for a test like this:

describe("something", function() {
  it("should work @probedock(key=bcde category=Integration tag=user-registration tag=validation ticket=JIRA-1000 ticket=JIRA-1012)", function() {
    expect(true).not.toBe(false);
  });
});

Contributing

• Fork
• Create a topic branch - git checkout -b feature
• Push to your branch - git push origin feature
• Create a pull request from your branch

Please add a changelog entry with your name for new features and bug fixes.

License

probedock-karma is licensed under the MIT License.