Code coverage

Linter	Code coverage tool	Supported report formats
Qodana for JVM	IntelliJ IDEA Code Coverage Agent is the recommended tool	`ic` is the preferable format. `XML` is also supported.
Qodana for JVM	JaCoCo	`xml`
Qodana for JS	Jest	`lcov`
Qodana for PHP	PhpUnit	`xml`
Qodana for .NET	coverlet.msbuild	`lcov`
Qodana for Python	Coverage.py	`xml`
Qodana for Go	`go test`	`out`

How it works

Code coverage employs several inspections that are already included in the qodana.recommended and qodana.starter default inspection profiles, so you do not need to enable them:

Linter	Employed inspection
Qodana for JVM	`JvmCoverageInspection`
Qodana for JS	`JsCoverageInspection`
Qodana for PHP	`PhpCoverageInspection`
Qodana for Python	`PyCoverageInspection`
Qodana for Go	`GoCoverageInspection`
Qodana for .NET	`NetCoverageInspection`

Code coverage calculation

function divide(a, b) { // Not analyzed by the code coverage
  return a / b; // Analyzed by the code coverage
}
module.exports = divide; // Analyzed by the code coverage

Run the code coverage

Map the directory containing code coverage reports to the /data/coverage directory and the project token using the QODANA_TOKEN variable. Here are the Docker and Qodana CLI command samples:

Docker

Qodana CLI

$
docker run \
    -v $(pwd):/data/project/ \
    -v /directory/with/coverage/report/:/data/coverage \
    -e QODANA_TOKEN="<qodana-cloud-token>" \
    jetbrains/qodana-<linter>

Create the pipeline that will store all code coverage output files in the <project-root-dir>/.qodana/code-coverage directory. You can find various examples of the GitHub Actions configurations on the GitHub website.

Below is the pipeline configuration example for the Qodana for JS linter:

name: JavaScript - Jest Test

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main
      - 'releases/*'

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout Code
      uses: actions/checkout@v3
      with:
        ref: ${{ github.event.pull_request.head.sha }}
        fetch-depth: 0

    - name: Use Node.js 18.x
      uses: actions/setup-node@v2
      with:
        node-version: 18.x

    - name: Install dependencies
      run: npm ci
      working-directory: JS/jest

    - name: Run tests
      run: npm test
      working-directory: JS/jest

    - name: Archive coverage data # Archive data for using by Qodana
      uses: actions/upload-artifact@v2
      with:
        name: jest-coverage-data
        path: JS/jest/.qodana/code-coverage

    - name: Qodana Scan # Run Qodana
      uses: JetBrains/qodana-action@main
      env:
        QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_JS }}
      with:
        args: "-i,JS/jest,--linter,jetbrains/qodana-js:2024.1"
        pr-mode: false

Create a GitLab CI/CD pipeline that will store all code coverage output files in the <project-root-dir>/coverage directory:

qodana:
   image:
      name: jetbrains/qodana-<linter>
      entrypoint: [""]
   cache:
      - key: qodana-2024.1-$CI_DEFAULT_BRANCH-$CI_COMMIT_REF_SLUG
        fallback_keys:
           - qodana-2024.1-$CI_DEFAULT_BRANCH-
           - qodana-2024.1-
        paths:
           - .qodana/cache
   variables:
      QODANA_TOKEN: $qodana_token           -
   script:
      - qodana --save-report
      --results-dir=$CI_PROJECT_DIR/.qodana/results
      --coverage-dir=$CI_PROJECT_DIR/coverage
   artifacts:
      paths:
         - .qodana/results/report
      expose_as: 'Qodana report'

This uses the QODANA_TOKEN variable to contain the project token. The --coverage-dir=$CI_PROJECT_DIR/coverage in the script block runs Qodana with the code coverage directory.

Qodana for .NET

dotnet:
  solution: <your-solution-file>

bootstrap: dotnet build; cd <path-to-dir-with-test-project-file> && \\
  dotnet add package coverlet.msbuild && \\
  ((dotnet test /p:CollectCoverage=true /p:CoverletOutput=<your-project-folder>/.qodana/code-coverage /p:CoverletOutputFormat=lcov))

Here, the dotnet option configures the solution file.

Command step	Description
`dotnet build`	Build a project or a solution
`cd <path-to-dir-with-test-project-file>`	Navigate to the directory containing the project test file
`dotnet add package coverlet.msbuild`	Add the `coverlet.msbuild` package to the project. This command needs to be repeated for each
`dotnet test ...`	Execute tests in the project, and:
`/p:CollectCoverage=true`	Enable code coverage
`/p:CoverletOutput=<your-project-folder>/.qodana/code-coverage`	Collect code coverage results to a specific directory
`/p:CoverletOutputFormat=lcov`	Specify the code coverage output format

Fresh code

name: Code coverage fresh code

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main
      - 'releases/*'

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0

      - name: Use Node.js 18.x
        uses: actions/setup-node@v2
        with:
          node-version: 18.x

      - name: Install dependencies
        run: npm ci

      - name: Run tests
        run: npm test

      - name: Archive coverage data
        uses: actions/upload-artifact@v2
        with:
          name: jest-coverage-data
          path: .qodana/code-coverage

      - name: Qodana Scan
        uses: JetBrains/qodana-action@main
        env:
          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_JS }}
        with:
          pr-mode: true # Enable the pull-request mode