Run with coverage

Last modified: 30 June 2021

Required plugin: Coverage (bundled)

Set coverage in run configurations

In IntelliJ IDEA, you can create multiple run/debug configurations and specify coverage options for each of them depending on your needs.

note

Run configurations are currently being redesigned: some configurations are updated and some are still in the old design. Use the procedure that corresponds to the appearance of the required configuration.

  1. From the main menu, select Run | Edit Configurations and click the necessary configuration on the left panel.

    If you haven't created the required configuration yet, refer to the Create a run/debug configuration from a template procedure that will guide you through the process.

    Code Coverage tab in the Run/debug Configuration dialog

  2. Open the Code Coverage tab and select a code coverage runner from the Choose coverage runner list: IntelliJ IDEA, EMMA, or JaCoCo.

  3. (For the IntelliJ IDEA runner) select the mode that you want to use: Sampling or Tracing.

    • The Sampling mode enables collecting line coverage with negligible slowdown.

    • The Tracing mode enables the accurate collection of the branch coverage with the ability to track tests, view coverage statistics, and get additional information on each covered line.

      note

      Path coverage is not supported.

    • The Track per test coverage option allows tracking individual code coverage produced by each test case. Enable this option if you want to know exactly what lines of code have been covered by specific tests. This will let see which tests are the most relevant for each piece of the code.

  4. The Packages and classes to include in coverage data and Packages and classes to exclude from coverage data areas allow you to narrow down the code coverage scope.

    Click Icons general add, then click the Class icon Add Class or the Add Package button Add Package, and select the necessary items.

  5. To collect code coverage statistics for tests, select the Enable coverage in test folders checkbox.

Run a configuration with coverage

note

Code coverage is supported only for the classes and sources that belong to your current project.

  1. Make sure that you have created the necessary run/debug configuration.

    You can also use a temporary run configuration that you can later modify, save, and rerun.

  2. Select the configuration from the list on the toolbar and click the Run with Coverage button or select Run | Run ... with Coverage from the main menu.

    Running a test with coverage

  3. (If the Show options before applying coverage to the editor option is enabled) The IDE prompts you to select whether you want to replace the active coverage suites, add the collected data to the active suites, or skip applying coverage data.

    Select whether you want to append the results of multiple runs and click OK.

See also

Procedures