Skip to content
Closed
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
5 changes: 3 additions & 2 deletions docs/snippets/cli/test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,12 @@ bun test <patterns>
</ParamField>

<ParamField path="--coverage-reporter" type="string" default="text">
Report coverage in <code>text</code> and/or <code>lcov</code>. Defaults to <code>text</code>
Report coverage in <code>text</code> and/or <code>lcov</code>. Defaults to <code>text</code>. Implies{" "}
<code>--coverage</code>
</ParamField>

<ParamField path="--coverage-dir" type="string" default="coverage">
Directory for coverage files. Defaults to <code>coverage</code>
Directory for coverage files. Defaults to <code>coverage</code>. Implies <code>--coverage</code>
</ParamField>

### Snapshots
Expand Down
6 changes: 4 additions & 2 deletions src/runtime/cli/Arguments.rs
Original file line number Diff line number Diff line change
Expand Up @@ -556,10 +556,10 @@ pub(crate) const TEST_ONLY_PARAMS: &[ParamType] = &[
parse_param!("--seed <INT> Set the random seed for test randomization"),
parse_param!("--coverage Generate a coverage profile"),
parse_param!(
"--coverage-reporter <STR>... Report coverage in 'text' and/or 'lcov'. Defaults to 'text'."
"--coverage-reporter <STR>... Report coverage in 'text' and/or 'lcov'. Defaults to 'text'. Implies --coverage."
),
parse_param!(
"--coverage-dir <STR> Directory for coverage files. Defaults to 'coverage'."
"--coverage-dir <STR> Directory for coverage files. Defaults to 'coverage'. Implies --coverage."
),
parse_param!(
"--bail <NUMBER>? Exit the test suite after <NUMBER> failures. If you do not specify a number, it defaults to 1."
Expand Down Expand Up @@ -1563,6 +1563,7 @@ fn parse_test_command_options(args: &clap::Args<clap::Help>, ctx: Context<'_>) {
}

if !args.options(b"--coverage-reporter").is_empty() {
ctx.test_options.coverage.enabled = true;
Comment thread
claude[bot] marked this conversation as resolved.
ctx.test_options.coverage.reporters = CoverageReporters {
text: false,
lcov: false,
Expand Down Expand Up @@ -1618,6 +1619,7 @@ fn parse_test_command_options(args: &clap::Args<clap::Help>, ctx: Context<'_>) {
}

if let Some(dir) = args.option(b"--coverage-dir") {
ctx.test_options.coverage.enabled = true;
ctx.test_options.coverage.reports_directory = Box::<[u8]>::from(dir);
}

Expand Down
70 changes: 69 additions & 1 deletion test/cli/test/coverage.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { expect, test } from "bun:test";
import { bunEnv, bunExe, normalizeBunSnapshot, tempDirWithFiles } from "harness";
import { readFileSync } from "node:fs";
import { existsSync, readFileSync } from "node:fs";
import path from "path";

test("coverage crash", () => {
Expand Down Expand Up @@ -57,6 +57,74 @@ export class Y {
);
});

// https://github.com/oven-sh/bun/issues/17502
test.each([["--coverage-reporter=lcov"], ["--coverage-reporter", "lcov"]])("%s implies --coverage", (...flags) => {
const dir = tempDirWithFiles("cov", {
"add.ts": `export function add(a: number, b: number) { return a + b; }`,
"add.test.ts": `
import { test, expect } from "bun:test";
import { add } from "./add";
test("add", () => { expect(add(1, 2)).toBe(3); });
`,
});
const result = Bun.spawnSync([bunExe(), "test", ...flags], {
cwd: dir,
env: bunEnv,
stdio: [null, "pipe", "pipe"],
});
const lcovPath = path.join(dir, "coverage", "lcov.info");
expect({
"coverage/lcov.info exists": existsSync(lcovPath),
exitCode: result.exitCode,
}).toEqual({
"coverage/lcov.info exists": true,
exitCode: 0,
});
expect(readFileSync(lcovPath, "utf-8")).toContain("SF:add.ts");
});

test("--coverage-reporter=text implies --coverage", () => {
const dir = tempDirWithFiles("cov", {
"add.ts": `export function add(a: number, b: number) { return a + b; }`,
"add.test.ts": `
import { test, expect } from "bun:test";
import { add } from "./add";
test("add", () => { expect(add(1, 2)).toBe(3); });
`,
});
const result = Bun.spawnSync([bunExe(), "test", "--coverage-reporter=text"], {
cwd: dir,
env: bunEnv,
stdio: [null, "pipe", "pipe"],
});
const stderr = result.stderr.toString("utf-8");
expect(stderr).toContain("% Funcs");
expect(stderr).toContain("% Lines");
expect(stderr).toContain("add.ts");
expect(result.exitCode).toBe(0);
});

test("--coverage-dir implies --coverage", () => {
const dir = tempDirWithFiles("cov", {
"add.ts": `export function add(a: number, b: number) { return a + b; }`,
"add.test.ts": `
import { test, expect } from "bun:test";
import { add } from "./add";
test("add", () => { expect(add(1, 2)).toBe(3); });
`,
});
const result = Bun.spawnSync([bunExe(), "test", "--coverage-dir=out"], {
cwd: dir,
env: bunEnv,
stdio: [null, "pipe", "pipe"],
});
const stderr = result.stderr.toString("utf-8");
expect(stderr).toContain("% Funcs");
expect(stderr).toContain("% Lines");
expect(stderr).toContain("add.ts");
expect(result.exitCode).toBe(0);
});

test("coverage excludes node_modules directory", () => {
const dir = tempDirWithFiles("cov", {
"node_modules/pi/index.js": `
Expand Down
Loading