Karma

Karma is a tool for testing client-side JavaScript. Karma executes tests against your application running in a real browser, which ensures correctness and trustworthiness of test results. PhpStorm integrates with Karma so you can run, debug, and monitor coverage of your tests from inside the IDE. You can see the test results in a treeview and easily navigate to the test source from there. Test status is shown next to the test in the editor with an option to quickly run it or debug it.

Before you start

Download and install Node.js.
Install and enable the Karma plugin on the Settings/Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

Installing Karma and plugins

In the embedded Terminal (Alt+F12) , type one of the following commands:
- npm install if Karma and all the required plugins are already defined in package.json.
- To install Karma and the required plugins (for example karma-jasmine or jasmine-core) as development dependencies:
  npm install --save-dev karma npm install --save-dev <required_karma_plugin> <another_required_karma_plugin>
Learn more from the Karma official website.

You can also install the karma package on the Node.js and NPM page as described in npm, pnpm, and Yarn.

Generating a Karma configuration file

Karma tests are run according to a karma.conf.js configuration file which is generated in the interactive mode. If you already have karma.conf.js in your project, just skip this step. For more details on Karma configuration, see Karma official website.

To create a Karma configuration file

Open the Terminal and start the karma.conf.js generation wizard by typing one of the following depending on your operating system:
- For macOS and Linux: ./node_modules/karma/bin/karma init
- For Windows:
  npm install -g karma-cli karma init
Answering the questions of the wizard, specify the testing framework to use and the browsers to be captured automatically.
See also Karma Files: Pattern matching.

Running tests

With PhpStorm, you can quickly run a single Karma test right from the editor or create a run/debug configuration to execute some or all of your tests.

To run a single test from the editor

Click or in the left gutter and select Run <test_name> from the list.
You can also see whether a test has passed or failed right in the editor, thanks to the test status icons and in the gutter.

To create a Karma run configuration

Open the Run/Debug Configuration dialog (Run | Edit Configurations on the main menu), click in the left-hand pane, and select Karma from the list. The Run/Debug Configuration: Karma dialog opens.
Alternatively, select a test file in the Project tool window and select Create <filename> from the context menu.
Specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.
Optionally, specify the Node.js-specific option parameters and the environment variables to be passed to Node.js.
Specify the location of the karma package and the path to karma.conf.js.
Specify the working directory of the application. By default, the Working directory field shows the project root folder. To change this predefined setting, specify the path to the desired folder or choose a previously used folder from the list.
Optionally, specify the command-line options that you want to pass to Karma to override the default settings from the karma.conf.js configuration file.
For example, to run or debug tests in Headless Chrome, type --browsers ChromeHeadless in the Karma options field. See Automated testing with Headless Chrome for details.
Alternatively, add 'ChromeHeadless' to the browsers option in karma.conf.js.
To see all the available CLI options, type karma start --help in the Terminal Alt+F12.

To run tests via a run configuration

Select the Karma run/debug configuration from the list on the main toolbar and click to the right of the list.
The Karma test server starts automatically without any steps from your side. View and analyze messages from the test server in the Karma Server tab of the Run tool window.
Monitor test execution and analyze test results in the Test Runner tab of the Run tool window, see Explore test results for details.

To rerun failed tests

In the Test Runner tab, click on the toolbar. PhpStorm will execute all the tests that failed during the previous session.
To rerun a specific failed test, select Run <test name> on its context menu.

See Rerunning tests for details.

Navigation

With PhpStorm, you can jump between a file and the related test file or from a test result in the Test Runner Tab to the test.

To jump between a test and its subject or vice versa, open the file in the editor and select Go to | Test or Go to | Test Subject from the context menu, or just press Ctrl+Shift+T.
To jump from a test result to the test definition, click the test name in the Test Runner tab twice or select Jump to Source from the context menu. The test file opens in the editor with the cursor placed at the test definition.
For failed tests, PhpStorm brings you to the failure line in the test from the stack trace. If the exact line is not in the stack trace, you will be taken to the test definition.

Debugging tests

With PhpStorm, you can quickly start debugging a single Karma test right from the editor or create a run/debug configuration to debug some or all of your tests.

To start debugging a single test from the editor

Click or in the left gutter and choose Debug <test_name> from the list.

To launch test debugging via a run/debug configuration

Create a Karma run/debug configuration as described above.
Select the Karma run/debug configuration from the list on the main toolbar and click to the right of the list.
In the Debug tool window that opens, proceed as usual: step through the tests, pause and resume test execution, examine the test when suspended, run JavaScript code snippets in the Console, and so on.

Monitoring code coverage

With PhpStorm, you can also monitor how much of your code is covered with Karma tests. PhpStorm displays this statistics in a dedicated Coverage tool window and marks covered and uncovered lines visually in the editor and in the Project tool window. To monitor coverage, you need to install the karma-coverage package and update karma.conf.js.

To install karma-coverage

In the embedded Terminal (Alt+F12) , type:
npm install --save-dev karma-coverage

To add karma-coverage definition to the configuration file

Open karma.conf.js in the editor.
Locate the reporters definition and add coverage to the list of values in the format:
reporters: ['progress', 'coverage']
Add a preprocessors definition and specify the coverage scope in the format:
preprocessors: {'**/*.js': ['coverage']}

To launch tests with coverage

Create a Karma run/debug configuration as described above.
Select the Karma run/debug configuration from the list on the main toolbar and click to the right of the list.
Alternatively, use the test icons in the editor to quickly run a specific suite or a test with coverage.
Monitor the code coverage in the Coverage tool window.
Every time Karma tests are run, a coverage report is actually generated on the disk. The format of a coverage report can be configured in the configuration file, for example:
// karma.conf.js module.exports = function(config) { config.set({ ... // optionally, configure the reporter coverageReporter: { type : 'html', dir : 'coverage/' } ... });};
The following type values are acceptable:
- html produces a bunch of HTML files with annotated source code.
- lcovonly produces an lcov.info file.
- lcov produces HTML + .lcov files. This format is applied by default.
- cobertura produces a cobertura-coverage.xml file for easy Hudson integration.
- text-summary produces a compact text summary of coverage, typically to the console.
- text produces a detailed text table with coverage for all files.

Last modified: 13 October 2021