PhpStorm 8.0.2 Web Help

Preparing to Use Karma Test Runner

The Karma test runner supports executing unit tests against the Node.js server. The tests themselves can use Jasmine, QUnit, or Mocha libraries in Karma-specific edition.

Besides running unit tests, with Karma you can measure how much of your code is covered with tests. For more details, see Monitoring Code Coverage for JavaScript. To run tests with coverage, you need an additional Karma-related package.

On this page:

Preparing to Install the Karma Test Runner

  1. Download and install Node.js. The framework is required for two reasons:
    • The Karma test runner is started through Node.js.
    • NPM, which is a part of the framework, is also the easiest way to download the Karma test runner.

  2. If you are going to use the command line mode, make sure the following paths are added to the PATH variable:
    1. The path to the parent folder of the Node.js executable file.
    2. The path to the npm folder.

    This enables you to launch the Karma test runner and npm from any folder.

  3. Install and enable the NodeJS repository plugin.

    The plugin is not bundled with PhpStorm, but it is available from the PhpStorm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PhpStorm projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

  4. Install and enable the Karma repository plugin.

    The plugin is not bundled with PhpStorm, but it is available from the PhpStorm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PhpStorm projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

Installing the Karma Test Runner

The easiest way to install the Karma test runner is to use the Node Package Manager (npm), which is a part of Node.js.

Depending on the desired location of the Karma test runner executable file, choose one of the following methods:

  • Install the test runner globally at the PhpStorm level so it can be used in any PhpStorm project.
  • Install the test runner in a specific project and thus restrict its use to this project.
  • Install the test runner in a project as a development dependency.

In either installation mode, make sure that the parent folder of the Karma test runner is added to the PATH variable. This enables you to launch the test runner from any folder.

PhpStorm provides user interface both for global and project installation as well as supports installation through the command line.

Installing Karma Globally

  1. Run the installation from the command line in the global mode:
    1. Launch the embedded Terminal by hovering your mouse pointer over show_tool_window_bars in the lower left corner of PhpStorm and choosing Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Switch to the directory where NPM is stored or define a PATH variable for it so it is available from any folder, see Installing NodeJs.
    3. Type the following command at the command line prompt:
      npm install -g karma

      For more details on the NPM operation modes, see npm documentation. For more information about installing the Karma test runner, see https://npmjs.org/package/karma.

  2. Run NPM from PhpStorm using the Node.js and NPM page of the Settings dialog box.
    1. Open the Settings dialog box by choosing File | Settings or pressing Ctrl+Alt+S and click Node.js and NPM under Languages&Frameworks.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the required package to install.
    4. Select the Options check box and type -g in the text box next to it.
    5. Optionally specify the product version and click Install Package to start installation.

Installing Karma in a project

  • Run the installation from the command line:
    1. Launch the embedded Terminal by hovering your mouse pointer over show_tool_window_bars in the lower left corner of PhpStorm and choosing Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Switch to the project root folder and type the following command at the command line prompt:
      npm install karma
  • Run NPM from PhpStorm using the Node.js and NPM page of the Settings dialog box.
    1. Open the project settings by choosing File | Settings or pressing Ctrl+Alt+S, see Accessing Settings for details. Then click Node.js and NPM under the Languages & Frameworks node.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the required package.
    4. Optionally specify the product version and click Install Package to start installation.

Configuring Testing Frameworks in a Project

  1. Download the Jasmine, QUnit, or Mocha framework. The easiest way is to use the Node.js Package Manager:
    1. Choose File | Settings and in the Settings dialog box that opens, click Node.js and NPM.
    2. On the Node.js page that opens, click Install in the Packages area.
    3. In the Available Packages dialog box that opens, select karma-jasmine, karma-qunit, or karma-mocha package and click Install Package. Close the dialog box when ready. PhpStorm returns to the Node.js page, where the selected package is added to the Packages list. Click OK.
  2. To enable PhpStorm to resolve references to the downloaded framework and provide code completion and other types of coding assistance, configure the framework as a PhpStorm JavaScript library.

See Also

Last modified: 10 December 2014