Karma

1. Download and install Node.js.

2. Install and enable the Karma repository plugin on the Plugins page as described in Managing 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 on the Karma official website.

To create a Karma configuration file

1. 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

2. 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.

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 in the left gutter.

To create a Karma run configuration

1. 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.

2. 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.

3. Specify the location of the karma package and the path to karma.conf.js.

4. 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.

5. 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.

   To see all the available CLI options, type karma start --help in the Terminal (Alt+F12).

To run tests via a run configuration

1. Select the Karma run/debug configuration from the list on the main toolbar and click  to the right of the list.

   

2. 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.

3. Monitor test execution in the Test Runner tab of the Run tool window.

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.

• 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, select the test name in the Test Runner tab and choose 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.

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

1. Create a Karma run/debug configuration as described above.

2. Select the Karma run/debug configuration from the list on the main toolbar and click  to the right of the list.

   

3. In the Debug Tool Window that opens, proceed as usual: step through the tests, stop and resume test execution, examine the test when suspended, and so on.

To install karma-coverage

In the embedded Terminal (Alt+F12), type:

To add karma-coverage definition to the configuration file

1. Open karma.conf.js in the editor.

2. Locate the reporters definition and add coverage to the list of values in the format:

   reporters: ['progress', 'coverage']

3. Add a preprocessors definition and specify the coverage scope in the format:

   preprocessors: {'**/*.js': ['coverage']}

To launch tests with coverage

1. Create a Karma run/debug configuration as described above.

2. 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.

   

3. 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.