vitest-sonar-reporter

Installation | Configuration | Examples | Troubleshooting

---

SonarQube reporter for Vitest

Generates Generic Execution reports from vitest tests for SonarQube to analyze.

Installation

vitest-sonar-reporter should be included in development dependencies. vitest is required as peer dependency.

1npm install --save-dev vitest-sonar-reporter

Configuration

Add new custom reporter and define outputFile in your vite.config.ts:

1import { defineConfig } from 'vitest/config';
2
3export default defineConfig({
4    test: {
5        reporters: 'vitest-sonar-reporter',
6        outputFile: 'sonar-report.xml',
7    },
8});

If you have multiple outputFile's defined, add one for vitest-sonar-reporter:

1test: {
2    reporters: ['json', 'verbose', 'vitest-sonar-reporter'],
3    outputFile: {
4        json: 'my-json-report.json',
5        'vitest-sonar-reporter': 'sonar-report.xml',
6    },
7},

Instruct SonarQube to pick report in your sonar-project.properties:

sonar.testExecutionReportPaths=sonar-report.xml

Examples

1import { describe, expect, test } from 'vitest';
2
3describe('animals', () => {
4    test('dogs say woof', () => {
5        const dog = { say: () => 'woof' };
6        expect(dog.say()).toBe('woof');
7    });
8
9    test.todo('figure out what rabbits say', () => {
10        const rabbit = { say: () => '????' };
11        expect(rabbit.say()).toBe('?');
12    });
13
14    describe('flying ones', () => {
15        test('cats can fly', () => {
16            const cat = { fly: () => false };
17            expect(cat.fly()).toBe(true);
18        });
19
20        test('birds can fly', () => {
21            const bird = { fly: () => true };
22            expect(bird.fly()).toBe(true);
23        });
24    });
25});

1<testExecutions version="1">
2  <file path="test/animals.test.ts">
3    <testCase name="animals - dogs say woof" duration="2" />
4    <testCase name="animals - figure out what rabbits say" duration="0">
5      <skipped message="figure out what rabbits say" />
6    </testCase>
7    <testCase name="animals - flying ones - cats can fly" duration="4">
8      <failure message="expected false to be true // Object.is equality">
9        <![CDATA[AssertionError: expected false to be true // Object.is equality
10    at /workspaces/example/test/animals.test.ts:15:47
11    at /workspaces/example/node_modules/vitest/dist/chunk-runtime-chain.7032872a.js:82:26
12    at runTest (/workspaces/example/node_modules/vitest/dist/entry.js:771:40)
13    at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
14    at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
15    at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
16    at async runFiles (/workspaces/example/node_modules/vitest/dist/entry.js:873:5)
17    at async startTests (/workspaces/example/node_modules/vitest/dist/entry.js:879:3)
18    at async /workspaces/example/node_modules/vitest/dist/entry.js:906:7
19    at async withEnv (/workspaces/example/node_modules/vitest/dist/entry.js:503:5)]]>
20      </failure>
21    </testCase>
22    <testCase name="animals - flying ones - birds can fly" duration="5" />
23  </file>
24</testExecutions>

Troubleshooting

1. I'm seeing Error [ERR_REQUIRE_ESM]: require() of ES Module when importing the module. I cannot add "type": "module" to my package.json.

This package is published as pure ESM package. It can still be used in commonjs projects by using dynamic import. See Vite | Async Config for Vite's configuration options.

1// vite.config.ts
2export default defineConfig(async function () {
3    const { default: SonarReporter } = await import('vitest-sonar-reporter');
4
5    return {
6        test: {
7            reporters: new SonarReporter(),
8            outputFile: 'sonar-report.xml',
9        },
10    };
11});