Live examples | Installation | Configuration | Code coverage | Examples
Generates Generic Execution reports from vitest tests for SonarQube to analyze.
- Project with Vitest Workspaces | Stackblitz
- Project with
{ type: "module" }| Stackblitz - Project with
{ type: "commonjs" }| Stackblitz
vitest-sonar-reporter should be included in development dependencies. vitest is required as peer dependency.
npm install --save-dev vitest-sonar-reporterAdd new custom reporter and define outputFile in your vite.config.ts:
import { defineConfig } from 'vitest/config';
export default defineConfig({
test: {
reporters: [
'default', // Vitest's default reporter so that terminal output is still visible
['vitest-sonar-reporter', { outputFile: 'sonar-report.xml' }],
],
},
});If you are using Vitest below version ^1.3.0 you can define file in test.outputFile:
test: {
reporters: ['json', 'verbose', 'vitest-sonar-reporter'],
outputFile: {
json: 'my-json-report.json',
'vitest-sonar-reporter': 'sonar-report.xml',
},
},Instruct SonarQube to pick report in your sonar-project.properties:
sonar.testExecutionReportPaths=sonar-report.xml
You can pass additional options to reporter. Note that this requires vitest@^1.3.0.
Silence reporter's verbose logging.
test: {
reporters: [
['vitest-sonar-reporter', { silent: true }]
],
}Rewrite path attribute of <file>. This can be useful when you need to change relative paths of the files.
test: {
reporters: [
['vitest-sonar-reporter', {
onWritePath(path: string) {
// Prefix all paths with root directory
// e.g. '<file path="test/math.ts">' to '<file path="frontend/test/math.ts">'
return `frontend/${path}`;
}
}]
],
}<testExecutions version="1">
- <file path="test/math.ts">
+ <file path="frontend/test/math.ts">
<testCase name="multiply" duration="123" />
</file>
</testExecutions>Location for the report.
test: {
reporters: [
['vitest-sonar-reporter', { outputFile: 'sonar-report.xml' }]
],
}This reporter does not process code coverage - Vitest already supports that out-of-the-box!
Simply configure vitest to output LCOV reports and instruct SonarQube to pick these reports.
test: {
coverage: {
reporters: 'lcov',
},
},sonar.javascript.lcov.reportPaths=./coverage/lcov.info
See examples/example-workspace for example setup using Vitest Workspaces.
import { describe, expect, test } from 'vitest';
describe('animals', () => {
test('dogs say woof', () => {
const dog = { say: () => 'woof' };
expect(dog.say()).toBe('woof');
});
test.todo('figure out what rabbits say', () => {
const rabbit = { say: () => '????' };
expect(rabbit.say()).toBe('?');
});
describe('flying ones', () => {
test('cats can fly', () => {
const cat = { fly: () => false };
expect(cat.fly()).toBe(true);
});
test('birds can fly', () => {
const bird = { fly: () => true };
expect(bird.fly()).toBe(true);
});
});
});<testExecutions version="1">
<file path="test/animals.test.ts">
<testCase name="animals - dogs say woof" duration="2" />
<testCase name="animals - figure out what rabbits say" duration="0">
<skipped message="figure out what rabbits say" />
</testCase>
<testCase name="animals - flying ones - cats can fly" duration="4">
<failure message="expected false to be true // Object.is equality">
<![CDATA[AssertionError: expected false to be true // Object.is equality
at /workspaces/example/test/animals.test.ts:15:47
at /workspaces/example/node_modules/vitest/dist/chunk-runtime-chain.7032872a.js:82:26
at runTest (/workspaces/example/node_modules/vitest/dist/entry.js:771:40)
at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
at async runSuite (/workspaces/example/node_modules/vitest/dist/entry.js:836:13)
at async runFiles (/workspaces/example/node_modules/vitest/dist/entry.js:873:5)
at async startTests (/workspaces/example/node_modules/vitest/dist/entry.js:879:3)
at async /workspaces/example/node_modules/vitest/dist/entry.js:906:7
at async withEnv (/workspaces/example/node_modules/vitest/dist/entry.js:503:5)]]>
</failure>
</testCase>
<testCase name="animals - flying ones - birds can fly" duration="5" />
</file>
</testExecutions>![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent