A cobertura reporter for `node:test`
npm install cobertura
!tests
A Cobertura reporter for node:test. Primarily was created in order to support GitLab's Test coverage visualization.
Also you can see the reporter in action in this GitLab repo.
``bash`
npm install --save-dev cobertura
or
`bash`
yarn add --dev cobertura
Define your test script:
`bash`
node --test \
--experimental-test-coverage \
--test-reporter=cobertura --test-reporter-destination=cobertura.xml \
--test-reporter=spec --test-reporter-destination=stdout
Your .gitlab-ci.yml can look something like this:
`yml
stages:
- test
test:
stage: test
image: node:22-alpine
artifacts:
when: always
reports:
coverage_report:
coverage_format: cobertura
path: ./cobertura.xml
script:
- node -v
- npm run test
coverage: '/all files[^|]\|[^|]\s+([\d\.]+)/'
`
The reporter can be used with node v20 and later, detailed explanation is here
This test reporter is heavily inspired by test reporters of this GitHub repo and some code parts might be directly copied from there.
Source file:
`js
export function fooOne(x) {
if (x === 1) {
return x + 1;
}
if (x === 2) {
return x + 1;
}
const result = x + 1;
return result + 1;
}
`
Test file:
`js
import { describe, it } from 'node:test';
import assert from 'node:assert';
import { fooOne } from './foo.js';
describe('fooTest', () => {
it('returns result', () => {
const result = fooOne(12);
assert.strictEqual(result, 14);
});
it('handles when x equals to 2', () => {
const result = fooOne(2);
assert.strictEqual(result, 3);
});
});
`
Output:
`xml
/Users/bacebu4/dev/cobertura-test
``