• Stars
    star
    468
  • Rank 93,767 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 11 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Grunt plugin for Karma.

grunt-karma

js-standard-style npm version npm downloads

Build Status Dependency Status devDependency Status

Grunt plugin for Karma

This current version uses karma@^3.0.0. For using older versions see the old releases of grunt-karma.

Getting Started

From the same directory as your project's Gruntfile and package.json, install karma and grunt-karma with the following commands:

$ npm install karma --save-dev
$ npm install grunt-karma --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-karma');

Config

Inside your Gruntfile.js file, add a section named karma, containing any number of configurations for running karma. You can either put your config in a [karma config file] or leave it all in your Gruntfile (recommended).

Here's an example that points to the config file:

karma: {
  unit: {
    configFile: 'karma.conf.js'
  }
}

Here's an example that puts the config in the Gruntfile:

karma: {
  unit: {
    options: {
      files: ['test/**/*.js']
    }
  }
}

You can override any of the config file's settings by putting them directly in the Gruntfile:

karma: {
  unit: {
    configFile: 'karma.conf.js',
    port: 9999,
    singleRun: true,
    browsers: ['PhantomJS'],
    logLevel: 'ERROR'
  }
}

To change the logLevel in the grunt config file instead of the karma config, use one of the following strings: OFF, ERROR, WARN, INFO, DEBUG

The files option can be extended "per-target" in the typical way Grunt handles files:

karma: {
  options: {
    files: ['lib/**/*.js']
  },
  unit: {
    files: [
      { src: ['test/**/*.js'] }
    ]
  }
}

When using the "Grunt way" of specifying files, you can also extend the file objects with the options supported by karma:

karma: {
  unit: {
    files: [
      { src: ['test/**/*.js'], served: true },
      { src: ['lib/**/*.js'], served: true, included: false }
    ]
  }
}

Config with Grunt Template Strings in files

When using template strings in the files option, the results will flattened. Therefore, if you include a variable that includes an array, the array will be flattened before being passed to Karma.

Example:

meta: {
  jsFiles: ['jquery.js','angular.js']
},
karma: {
  options: {
    files: ['<%= meta.jsFiles %>','angular-mocks.js','**/*-spec.js']
  }
}

Sharing Configs

If you have multiple targets, it may be helpful to share common configuration settings between them. Grunt-karma supports this by using the options property:

karma: {
  options: {
    configFile: 'karma.conf.js',
    port: 9999,
    browsers: ['Chrome', 'Firefox']
  },
  continuous: {
    singleRun: true,
    browsers: ['PhantomJS']
  },
  dev: {
    reporters: 'dots'
  }
}

In this example the continuous and dev targets will both use the configFile and port specified in the options. But the continuous target will override the browser setting to use PhantomJS, and also run as a singleRun. The dev target will simply change the reporter to dots.

Running tests

There are three ways to run your tests with karma:

Karma Server with Auto Runs on File Change

Setting the autoWatch option to true will instruct karma to start a server and watch for changes to files, running tests automatically:

karma: {
  unit: {
    configFile: 'karma.conf.js',
    autoWatch: true
  }
}

Now run $ grunt karma

Karma Server with Grunt Watch

Many Grunt projects watch several types of files using grunt-contrib-watch. Config karma like usual (without the autoWatch option), and add background:true:

karma: {
  unit: {
    configFile: 'karma.conf.js',
    background: true,
    singleRun: false
  }
}

The background option will tell grunt to run karma in a child process so it doesn't block subsequent grunt tasks.

The singleRun: false option will tell grunt to keep the karma server up after a test run.

Config your watch task to run the karma task with the :run flag. For example:

watch: {
  //run unit tests with karma (server needs to be already running)
  karma: {
    files: ['app/js/**/*.js', 'test/browser/**/*.js'],
    tasks: ['karma:unit:run'] //NOTE the :run flag
  }
},

In your terminal window run $ grunt karma:unit:start watch, which starts the karma server and the watch task. Now when grunt watch detects a change to one of your watched files, it will run the tests specified in the unit target using the already running karma server. This is the preferred method for development.

Single Run

Keeping a browser window & karma server running during development is productive, but not a good solution for build processes. For that reason karma provides a "continuous integration" mode, which will launch the specified browser(s), run the tests, and close the browser(s). It also supports running tests in PhantomJS, a headless webkit browser which is great for running tests as part of a build. To run tests in continous integration mode just add the singleRun option:

karma: {
  unit: {
    configFile: 'config/karma.conf.js',
  },
  //continuous integration mode: run tests once in PhantomJS browser.
  continuous: {
    configFile: 'config/karma.conf.js',
    singleRun: true,
    browsers: ['PhantomJS']
  },
}

The build would then run grunt karma:continuous to start PhantomJS, run tests, and close PhantomJS.

Using additional client.args

You can pass arbitrary client.args through the commandline like this:

$ grunt karma:dev watch --grep=mypattern

License

MIT License

More Repositories

1

karma

Spectacular Test Runner for JavaScript
JavaScript
11,952
star
2

karma-coverage

A Karma plugin. Generate code coverage.
JavaScript
768
star
3

karma-jasmine

A Karma plugin - adapter for Jasmine testing framework.
JavaScript
542
star
4

karma-chrome-launcher

A Karma plugin. Launcher for Chrome and Chrome Canary.
JavaScript
467
star
5

karma-mocha

A Karma plugin. Adapter for Mocha testing framework.
JavaScript
379
star
6

gulp-karma

Example of using Karma with Gulp.
JavaScript
310
star
7

karma-phantomjs-launcher

A Karma plugin. Launcher for PhantomJS.
JavaScript
281
star
8

karma-ng-html2js-preprocessor

A Karma plugin. Compile AngularJS 1.x and 2.x templates to JavaScript on the fly.
CoffeeScript
266
star
9

karma-sauce-launcher

A Karma plugin. Launch any browser on SauceLabs!
TypeScript
199
star
10

karma-junit-reporter

A Karma plugin. Report results in junit xml format.
JavaScript
176
star
11

karma-browserstack-launcher

A Karma plugin. Launch any browser on BrowserStack!
JavaScript
150
star
12

karma-firefox-launcher

A Karma plugin. Launcher for Firefox.
JavaScript
104
star
13

karma-html2js-preprocessor

A Karma plugin. Convert HTML files into JS strings to serve them in a script tag.
CoffeeScript
74
star
14

karma-commonjs

A Karma plugin. Test CommonJS modules.
JavaScript
73
star
15

karma-webdriver-launcher

A plugin for Karma. Launch any browser with WebDriver.
JavaScript
66
star
16

karma-ie-launcher

A Karma plugin. Launcher for Internet Explorer.
JavaScript
59
star
17

karma-coffee-preprocessor

A Karma plugin. Compile coffee script on the fly.
JavaScript
53
star
18

karma-cli

The Karma command line interface.
JavaScript
52
star
19

karma-qunit

A Karma plugin. Adapter for QUnit testing framework.
JavaScript
51
star
20

maven-karma-plugin

Maven plugin for running tests using Karma.
Java
45
star
21

karma-requirejs

A Karma plugin. Adapter for RequireJS framework.
JavaScript
39
star
22

karma-teamcity-reporter

A Karma plugin. Report results for Teamcity CI.
JavaScript
34
star
23

karma-intellij

Reporter for IntelliJ / WebStorm.
JavaScript
34
star
24

karma-growl-reporter

A Karma plugin. Report results with growl.
JavaScript
27
star
25

karma-ng-scenario

A Karma plugin. Adapter for Angular's Scenario Runner.
JavaScript
25
star
26

karma-runner.github.com

Homepage of Karma - The Spectacular JavaScript Test Runner.
HTML
24
star
27

karma-edge-launcher

A Karma plugin. Launcher for Microsoft Edge.
JavaScript
21
star
28

karma-safari-launcher

A Karma plugin. Launcher for Safari.
JavaScript
19
star
29

karma-closure

A Karma plugin. Resolve Google Closure dependencies on the fly.
JavaScript
18
star
30

karma-dart

DEPRECATED. A plugin for Dart language.
JavaScript
16
star
31

karma-slimerjs-launcher

A Karma launcher for SlimerJS
JavaScript
13
star
32

karma-traceur-preprocessor

A Karma plugin. Compile ES6 script on the fly using traceur-compiler.
JavaScript
13
star
33

karma-nodeunit

A Karma plugin - adapter for Node unit testing framework.
JavaScript
12
star
34

karma-script-launcher

A Karma plugin. Launcher for custom scripts.
JavaScript
9
star
35

integration-tests

JavaScript
8
star
36

karma-dojo

A Karma plugin. Adapter for Dojo Toolkit.
JavaScript
7
star
37

karma-opera-launcher

A Karma plugin. Launcher for Opera.
JavaScript
7
star
38

test-device-manager

Keep-alive test browsers and redirect them to a test server on command.
JavaScript
6
star
39

karma-ember-preprocessor

A Karma plugin. Preprocessor for Ember.js templates (handlebars).
JavaScript
6
star
40

karma-googmodule-preprocessor

A Karma preprocessor to handle Closure's goog.module() system
JavaScript
5
star
41

shared-karma-files

Shared configs for all the Karma repos.
CoffeeScript
2
star