Karma is a test runner for JavaScript that runs on Node.js. It is designed to work with any testing framework and has plugins for many popular frameworks. Karma runs tests in real browsers, can watch file changes, and re-run tests during development. It is often used for unit testing and can be integrated with continuous integration tools.
Running tests in real browsers
This code configures Karma to run tests in both Chrome and Firefox browsers using the Jasmine testing framework. The 'files' property specifies the location of the test files.
module.exports = function(config) {
config.set({
browsers: ['Chrome', 'Firefox'],
frameworks: ['jasmine'],
files: ['test/**/*.js']
});
};Watching files and re-running tests
This configuration enables Karma's file watching feature. When set to true, Karma will watch for any file changes and automatically re-run the tests, which is useful during development.
module.exports = function(config) {
config.set({
autoWatch: true,
singleRun: false
});
};Integration with continuous integration tools
This configuration is set up for continuous integration environments. It runs the tests a single time and uses reporters to output test results, such as the JUnit reporter which outputs results in an XML format that can be consumed by CI tools.
module.exports = function(config) {
config.set({
singleRun: true,
reporters: ['progress', 'junit'],
junitReporter: {
outputFile: 'test-results.xml'
}
});
};Mocha is a feature-rich JavaScript test framework running on Node.js, making asynchronous testing simple. It is often compared to Karma, but unlike Karma, Mocha does not run tests in real browsers and does not have a built-in watcher.
Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box for any React project. Jest runs tests in a Node environment instead of real browsers, provides a powerful mocking library, and has a built-in test runner and assertion library.
Jasmine is a behavior-driven development framework for testing JavaScript code. It does not require a DOM, and it has a clean, obvious syntax so that you can easily write tests. Jasmine is often used as a testing framework within Karma, but it can also be used standalone.
A simple tool that allows you to execute JavaScript code in multiple real browsers.
The main purpose of Karma is to make your test-driven development easy, fast, and fun.
The web testing space has evolved significantly in the 10+ years since Karma's creation. The web landscape looks very different today and new patterns and tools have emerged in the ecosystem. New test runners offer more performant alternatives, and Karma no longer provides clear unique value.
Based on the current state of the web testing ecosystem, we have made the hard decision to deprecate Karma.
We know Karma is used particularly commonly in the Angular ecosystem, so Angular is adding Jest and Web Test Runner support to provide a migration path off of Karma. See the Angular blog for more details.
Critical security issues in Karma will still be triaged and fixed as necessary. This will continue until 12 months after Angular CLI's Web Test Runner support is marked stable.
For those outside Angular looking to migrate off Karma, both Web Test Runner and jasmine-browser-runner provide browser-based unit testing solutions which can be used as a direct alternative. Jest and Vitest also provide Node-based alternatives.
It has been incredible to see Karma's impact on the web testing ecosystem and we greatly appreciate the support of everyone who contributed to an awesome community. Keep testing. ✅
For questions and support please use the mailing list or Gitter. The issue tracker is for bug reports and feature discussions only.
Karma is not a testing framework, nor an assertion library. Karma just launches an HTTP server, and generates the test runner HTML file you probably already know from your favourite testing framework. So for testing purposes you can use pretty much anything you like. There are already plugins for most of the common testing frameworks:
If you can't find an adapter for your favourite framework, don't worry and write your own. It's not that hard and we are here to help.
All the major browsers are supported, if you want to know more see the browsers page.
See FAQ.
You don't need to sign anything but here are some resources to help you to get started...
Every serious project has a screencast, so here is ours. Just click here and let the show begin.
See installation.
See configuration.
Please, see contributing.
Throughout the development of AngularJS, we've been using JSTD for testing. I really think that JSTD is a great idea. Unfortunately, we had many problems with JSTD, so we decided to write our own test runner based on the same idea. We wanted a simple tool just for executing JavaScript tests that is both stable and fast. That's why we use the awesome Socket.io library and Node.js.
FAQs
Spectacular Test Runner for JavaScript.
The npm package karma receives a total of 1,401,522 weekly downloads. As such, karma popularity was classified as popular.
We found that karma demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.