Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions e2e/projects/coverage.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { dirname, join } from 'node:path';
import { fileURLToPath } from 'node:url';
import { describe, expect, it } from '@rstest/core';
import fs from 'fs-extra';
import { runRstestCli } from '../scripts';

const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);

describe('test projects coverage', () => {
it('should run projects correctly with coverage', async () => {
const { cli, expectExecSuccess } = await runRstestCli({
command: 'rstest',
args: ['run', '--globals', '-c', 'rstest.coverage.config.ts'],
options: {
nodeOptions: {
cwd: join(__dirname, 'fixtures'),
},
},
});

await expectExecSuccess();
const logs = cli.stdout.split('\n').filter(Boolean);

expect(
logs.find(
(log) =>
log.includes('All files') &&
log.replaceAll(' ', '').includes('100|100|100|100'),
),
).toBeTruthy();

expect(
logs.find(
(log) =>
log.includes('client/test') &&
log.replaceAll(' ', '').includes('100|100|100|100'),
),
).toBeTruthy();

expect(
logs.find(
(log) =>
log.includes('node') &&
log.replaceAll(' ', '').includes('100|100|100|100'),
),
).toBeTruthy();

expect(
fs.existsSync(join(__dirname, 'fixtures/coverage/index.html')),
).toBeTruthy();
});
});
10 changes: 10 additions & 0 deletions e2e/projects/fixtures/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"private": true,
"name": "@rstest/tests-projects",
"sideEffects": true,
"version": "1.0.0",
"devDependencies": {
"@rstest/core": "workspace:*",
"@rstest/coverage-istanbul": "workspace:*"
}
}
10 changes: 10 additions & 0 deletions e2e/projects/fixtures/rstest.coverage.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { defineConfig } from '@rstest/core';

export default defineConfig({
projects: ['packages/*'],
globals: true,
coverage: {
enabled: true,
},
setupFiles: ['./setup.ts'],
});
9 changes: 9 additions & 0 deletions e2e/test-coverage/fixtures/rstest.reportsDirectory.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { defineConfig } from '@rstest/core';

export default defineConfig({
coverage: {
enabled: true,
provider: 'istanbul',
reportsDirectory: 'test-temp-coverage',
},
});
22 changes: 22 additions & 0 deletions e2e/test-coverage/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,25 @@ it('coverage-istanbul with custom options', async () => {
fs.existsSync(join(__dirname, 'fixtures/coverage/index.html')),
).toBeTruthy();
});

it('coverage-istanbul with custom reportsDirectory', async () => {
const { expectExecSuccess, expectLog, cli } = await runRstestCli({
command: 'rstest',
args: ['run', '-c', 'rstest.reportsDirectory.config.ts'],
options: {
nodeOptions: {
cwd: join(__dirname, 'fixtures'),
},
},
});

await expectExecSuccess();

const logs = cli.stdout.split('\n').filter(Boolean);

expectLog('Coverage enabled with istanbul', logs);

expect(
fs.existsSync(join(__dirname, 'fixtures/test-temp-coverage/index.html')),
).toBeTruthy();
});
1 change: 1 addition & 0 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"@sinonjs/fake-timers": "^14.0.0",
"@types/babel__code-frame": "^7.0.6",
"@types/istanbul-reports": "^3.0.4",
"@types/istanbul-lib-coverage": "^2.0.6",
"@types/jsdom": "^21.1.7",
"@types/sinonjs__fake-timers": "^8.1.5",
"@types/source-map-support": "^0.5.10",
Expand Down
8 changes: 7 additions & 1 deletion packages/core/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
loadConfig as loadRsbuildConfig,
mergeRsbuildConfig,
} from '@rsbuild/core';
import { dirname, isAbsolute, join } from 'pathe';
import { dirname, isAbsolute, join, resolve } from 'pathe';
import type { NormalizedConfig, RstestConfig } from './types';
import {
color,
Expand Down Expand Up @@ -115,6 +115,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
enabled: false,
provider: 'istanbul',
reporters: ['text', 'html', 'clover', 'json'],
reportsDirectory: './coverage',
},
});

Expand All @@ -131,6 +132,11 @@ export const withDefaultConfig = (config: RstestConfig): NormalizedConfig => {
merged.coverage ??= {};
merged.coverage.reporters =
config.coverage?.reporters ?? merged.coverage?.reporters;
const reportsDirectory = merged.coverage.reportsDirectory!;
merged.coverage.reportsDirectory = isAbsolute(reportsDirectory)
? reportsDirectory
: resolve(merged.root!, reportsDirectory);

merged.pool =
typeof config.pool === 'string'
? {
Expand Down
13 changes: 7 additions & 6 deletions packages/core/src/types/coverage.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { CoverageMap } from 'istanbul-lib-coverage';
import type { ReportOptions } from 'istanbul-reports';

type ReportWithOptions<Name extends keyof ReportOptions = keyof ReportOptions> =
Expand All @@ -24,17 +25,17 @@ export type CoverageOptions = {
*/
reporters?: (keyof ReportOptions | ReportWithOptions)[];

/**
* The directory to store coverage reports.
* @default './coverage'
*/
reportsDirectory?: string;

// TODO: support clean
};

export type NormalizedCoverageOptions = Required<CoverageOptions>;

interface CoverageMap {
files(): string[];
merge(other: any): void;
toJSON(): any;
}

export declare class CoverageProvider {
constructor(options: CoverageOptions);
/**
Expand Down
9 changes: 2 additions & 7 deletions packages/coverage-istanbul/src/provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@ import type {
NormalizedCoverageOptions,
CoverageProvider as RstestCoverageProvider,
} from '@rstest/core';
import type { CoverageMap } from 'istanbul-lib-coverage';
import istanbulLibCoverage from 'istanbul-lib-coverage';
import { createContext } from 'istanbul-lib-report';
import reports from 'istanbul-reports';

const { createCoverageMap } = istanbulLibCoverage;

interface CoverageMap {
files(): string[];
merge(other: any): void;
toJSON(): any;
}

// Global type declaration for coverage
declare global {
var __coverage__: any;
Expand Down Expand Up @@ -63,7 +58,7 @@ export class CoverageProvider implements RstestCoverageProvider {

try {
const context = createContext({
dir: 'coverage',
dir: this.options.reportsDirectory,
defaultSummarizer: 'nested',
coverageMap: createCoverageMap(coverageMap.toJSON()),
});
Expand Down
12 changes: 12 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading