Skip to content

Commit 69ca425

Browse files
sheremet-vasheremet-va
authoredMar 31, 2025··
fix(reporter): print test only once in the verbose mode (#7738)
·
v3.1.1
1 parent b166efa commit 69ca425

File tree

14 files changed

+352
-166
lines changed

14 files changed

+352
-166
lines changed
 

‎docs/advanced/api/test-case.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Checks if the test did not fail the suite. If the test is not finished yet or wa
125125
function meta(): TaskMeta
126126
```
127127

128-
Custom metadata that was attached to the test during its execution. The meta can be attached by assigning a property to the `ctx.task.meta` object during a test run:
128+
Custom [metadata](/advanced/metadata) that was attached to the test during its execution. The meta can be attached by assigning a property to the `ctx.task.meta` object during a test run:
129129

130130
```ts {3,6}
131131
import { test } from 'vitest'

‎docs/advanced/api/test-module.md

+32
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,33 @@ function state(): TestModuleState
3232

3333
Works the same way as [`testSuite.state()`](/advanced/api/test-suite#state), but can also return `queued` if module wasn't executed yet.
3434

35+
## meta <Version>3.1.0</Version> {#meta}
36+
37+
```ts
38+
function meta(): TaskMeta
39+
```
40+
41+
Custom [metadata](/advanced/metadata) that was attached to the module during its execution or collection. The meta can be attached by assigning a property to the `task.meta` object during a test run:
42+
43+
```ts {5,10}
44+
import { test } from 'vitest'
45+
46+
describe('the validation works correctly', (task) => {
47+
// assign "decorated" during collection
48+
task.file.meta.decorated = false
49+
50+
test('some test', ({ task }) => {
51+
// assign "decorated" during test run, it will be available
52+
// only in onTestCaseReady hook
53+
task.file.meta.decorated = false
54+
})
55+
})
56+
```
57+
58+
:::tip
59+
If metadata was attached during collection (outside of the `test` function), then it will be available in [`onTestModuleCollected`](./reporters#ontestmodulecollected) hook in the custom reporter.
60+
:::
61+
3562
## diagnostic
3663

3764
```ts
@@ -63,5 +90,10 @@ interface ModuleDiagnostic {
6390
* Accumulated duration of all tests and hooks in the module.
6491
*/
6592
readonly duration: number
93+
/**
94+
* The amount of memory used by the module in bytes.
95+
* This value is only available if the test was executed with `logHeapUsage` flag.
96+
*/
97+
readonly heap: number | undefined
6698
}
6799
```

‎docs/advanced/api/test-suite.md

+27
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,30 @@ describe('collection failed', () => {
190190
::: warning
191191
Note that errors are serialized into simple objects: `instanceof Error` will always return `false`.
192192
:::
193+
194+
## meta <Version>3.1.0</Version> {#meta}
195+
196+
```ts
197+
function meta(): TaskMeta
198+
```
199+
200+
Custom [metadata](/advanced/metadata) that was attached to the suite during its execution or collection. The meta can be attached by assigning a property to the `task.meta` object during a test run:
201+
202+
```ts {5,10}
203+
import { test } from 'vitest'
204+
205+
describe('the validation works correctly', (task) => {
206+
// assign "decorated" during collection
207+
task.meta.decorated = false
208+
209+
test('some test', ({ task }) => {
210+
// assign "decorated" during test run, it will be available
211+
// only in onTestCaseReady hook
212+
task.suite.meta.decorated = false
213+
})
214+
})
215+
```
216+
217+
:::tip
218+
If metadata was attached during collection (outside of the `test` function), then it will be available in [`onTestModuleCollected`](./reporters#ontestmodulecollected) hook in the custom reporter.
219+
:::

‎packages/vitest/src/node/core.ts

+24-19
Original file line numberDiff line numberDiff line change
@@ -502,25 +502,7 @@ export class Vitest {
502502
await this._testRun.start(specifications).catch(noop)
503503

504504
for (const file of files) {
505-
const project = this.getProjectByName(file.projectName || '')
506-
await this._testRun.enqueued(project, file).catch(noop)
507-
await this._testRun.collected(project, [file]).catch(noop)
508-
509-
const logs: UserConsoleLog[] = []
510-
511-
const { packs, events } = convertTasksToEvents(file, (task) => {
512-
if (task.logs) {
513-
logs.push(...task.logs)
514-
}
515-
})
516-
517-
logs.sort((log1, log2) => log1.time - log2.time)
518-
519-
for (const log of logs) {
520-
await this._testRun.log(log).catch(noop)
521-
}
522-
523-
await this._testRun.updated(packs, events).catch(noop)
505+
await this._reportFileTask(file)
524506
}
525507

526508
if (hasFailed(files)) {
@@ -538,6 +520,29 @@ export class Vitest {
538520
}
539521
}
540522

523+
/** @internal */
524+
public async _reportFileTask(file: File): Promise<void> {
525+
const project = this.getProjectByName(file.projectName || '')
526+
await this._testRun.enqueued(project, file).catch(noop)
527+
await this._testRun.collected(project, [file]).catch(noop)
528+
529+
const logs: UserConsoleLog[] = []
530+
531+
const { packs, events } = convertTasksToEvents(file, (task) => {
532+
if (task.logs) {
533+
logs.push(...task.logs)
534+
}
535+
})
536+
537+
logs.sort((log1, log2) => log1.time - log2.time)
538+
539+
for (const log of logs) {
540+
await this._testRun.log(log).catch(noop)
541+
}
542+
543+
await this._testRun.updated(packs, events).catch(noop)
544+
}
545+
541546
async collect(filters?: string[]): Promise<TestRunResult> {
542547
const files = await this.specifications.getRelevantTestSpecifications(filters)
543548

‎packages/vitest/src/node/reporters/base.ts

+125-91
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import type { File, Task, TaskResultPack } from '@vitest/runner'
1+
import type { File, Task } from '@vitest/runner'
22
import type { ErrorWithDiff, UserConsoleLog } from '../../types/general'
33
import type { Vitest } from '../core'
44
import type { Reporter } from '../types/reporter'
5-
import type { TestCase, TestModule, TestResult, TestSuite } from './reported-tasks'
5+
import type { TestCase, TestCollection, TestModule, TestModuleState, TestResult, TestSuite, TestSuiteState } from './reported-tasks'
66
import { performance } from 'node:perf_hooks'
77
import { getFullName, getSuites, getTestName, getTests, hasFailed } from '@vitest/runner/utils'
88
import { toArray } from '@vitest/utils'
@@ -24,7 +24,7 @@ export abstract class BaseReporter implements Reporter {
2424
start = 0
2525
end = 0
2626
watchFilters?: string[]
27-
failedUnwatchedFiles: Task[] = []
27+
failedUnwatchedFiles: TestModule[] = []
2828
isTTY: boolean
2929
ctx: Vitest = undefined!
3030
renderSucceed = false
@@ -83,6 +83,8 @@ export abstract class BaseReporter implements Reporter {
8383
if (testModule.state() === 'failed') {
8484
this.logFailedTask(testModule.task)
8585
}
86+
87+
this.printTestModule(testModule)
8688
}
8789

8890
private logFailedTask(task: Task) {
@@ -93,121 +95,153 @@ export abstract class BaseReporter implements Reporter {
9395
}
9496
}
9597

96-
onTaskUpdate(packs: TaskResultPack[]): void {
97-
for (const pack of packs) {
98-
const task = this.ctx.state.idMap.get(pack[0])
99-
100-
if (task) {
101-
this.printTask(task)
102-
}
103-
}
104-
}
105-
106-
/**
107-
* Callback invoked with a single `Task` from `onTaskUpdate`
108-
*/
109-
protected printTask(task: Task): void {
110-
if (
111-
!('filepath' in task)
112-
|| !task.result?.state
113-
|| task.result?.state === 'run'
114-
|| task.result?.state === 'queued') {
98+
protected printTestModule(testModule: TestModule): void {
99+
const moduleState = testModule.state()
100+
if (moduleState === 'queued' || moduleState === 'pending') {
115101
return
116102
}
117103

118-
const suites = getSuites(task)
119-
const allTests = getTests(task)
120-
const failed = allTests.filter(t => t.result?.state === 'fail')
121-
const skipped = allTests.filter(t => t.mode === 'skip' || t.mode === 'todo')
104+
let testsCount = 0
105+
let failedCount = 0
106+
let skippedCount = 0
122107

123-
let state = c.dim(`${allTests.length} test${allTests.length > 1 ? 's' : ''}`)
108+
// delaying logs to calculate the test stats first
109+
// which minimizes the amount of for loops
110+
const logs: string[] = []
111+
const originalLog = this.log.bind(this)
112+
this.log = (msg: string) => logs.push(msg)
124113

125-
if (failed.length) {
126-
state += c.dim(' | ') + c.red(`${failed.length} failed`)
114+
const visit = (suiteState: TestSuiteState, children: TestCollection) => {
115+
for (const child of children) {
116+
if (child.type === 'suite') {
117+
const suiteState = child.state()
118+
119+
// Skipped suites are hidden when --hideSkippedTests, print otherwise
120+
if (!this.ctx.config.hideSkippedTests || suiteState !== 'skipped') {
121+
this.printTestSuite(child)
122+
}
123+
124+
visit(suiteState, child.children)
125+
}
126+
else {
127+
const testResult = child.result()
128+
129+
testsCount++
130+
if (testResult.state === 'failed') {
131+
failedCount++
132+
}
133+
else if (testResult.state === 'skipped') {
134+
skippedCount++
135+
}
136+
137+
if (this.ctx.config.hideSkippedTests && suiteState === 'skipped') {
138+
// Skipped suites are hidden when --hideSkippedTests
139+
continue
140+
}
141+
142+
this.printTestCase(moduleState, child)
143+
}
144+
}
127145
}
128146

129-
if (skipped.length) {
130-
state += c.dim(' | ') + c.yellow(`${skipped.length} skipped`)
147+
try {
148+
visit(moduleState, testModule.children)
149+
}
150+
finally {
151+
this.log = originalLog
131152
}
132153

133-
let suffix = c.dim('(') + state + c.dim(')') + this.getDurationPrefix(task)
154+
this.log(this.getModuleLog(testModule, {
155+
tests: testsCount,
156+
failed: failedCount,
157+
skipped: skippedCount,
158+
}))
159+
logs.forEach(log => this.log(log))
160+
}
134161

135-
if (this.ctx.config.logHeapUsage && task.result.heap != null) {
136-
suffix += c.magenta(` ${Math.floor(task.result.heap / 1024 / 1024)} MB heap used`)
137-
}
162+
protected printTestCase(moduleState: TestModuleState, test: TestCase): void {
163+
const testResult = test.result()
138164

139-
let title = getStateSymbol(task)
165+
const { duration, retryCount, repeatCount } = test.diagnostic() || {}
166+
const padding = this.getTestIndentation(test.task)
167+
let suffix = this.getDurationPrefix(test.task)
140168

141-
if (task.meta.typecheck) {
142-
title += ` ${c.bgBlue(c.bold(' TS '))}`
169+
if (retryCount != null && retryCount > 0) {
170+
suffix += c.yellow(` (retry x${retryCount})`)
143171
}
144172

145-
if (task.projectName) {
146-
title += ` ${formatProjectName(task.projectName, '')}`
173+
if (repeatCount != null && repeatCount > 0) {
174+
suffix += c.yellow(` (repeat x${repeatCount})`)
147175
}
148176

149-
this.log(` ${title} ${task.name} ${suffix}`)
177+
if (testResult.state === 'failed') {
178+
this.log(c.red(` ${padding}${taskFail} ${this.getTestName(test.task, c.dim(' > '))}`) + suffix)
150179

151-
for (const suite of suites) {
152-
if (this.ctx.config.hideSkippedTests && (suite.mode === 'skip' || suite.result?.state === 'skip')) {
153-
// Skipped suites are hidden when --hideSkippedTests
154-
continue
155-
}
180+
// print short errors, full errors will be at the end in summary
181+
testResult.errors.forEach((error) => {
182+
const message = this.formatShortError(error)
156183

157-
const tests = suite.tasks.filter(task => task.type === 'test')
184+
if (message) {
185+
this.log(c.red(` ${padding}${message}`))
186+
}
187+
})
188+
}
158189

159-
if (!('filepath' in suite)) {
160-
this.printSuite(suite)
161-
}
190+
// also print slow tests
191+
else if (duration && duration > this.ctx.config.slowTestThreshold) {
192+
this.log(` ${padding}${c.yellow(c.dim(F_CHECK))} ${this.getTestName(test.task, c.dim(' > '))} ${suffix}`)
193+
}
162194

163-
for (const test of tests) {
164-
const { duration, retryCount, repeatCount } = test.result || {}
165-
const padding = this.getTestIndentation(test)
166-
let suffix = this.getDurationPrefix(test)
195+
else if (this.ctx.config.hideSkippedTests && (testResult.state === 'skipped')) {
196+
// Skipped tests are hidden when --hideSkippedTests
197+
}
167198

168-
if (retryCount != null && retryCount > 0) {
169-
suffix += c.yellow(` (retry x${retryCount})`)
170-
}
199+
// also print skipped tests that have notes
200+
else if (testResult.state === 'skipped' && testResult.note) {
201+
this.log(` ${padding}${getStateSymbol(test.task)} ${this.getTestName(test.task, c.dim(' > '))}${c.dim(c.gray(` [${testResult.note}]`))}`)
202+
}
171203

172-
if (repeatCount != null && repeatCount > 0) {
173-
suffix += c.yellow(` (repeat x${repeatCount})`)
174-
}
204+
else if (this.renderSucceed || moduleState === 'failed') {
205+
this.log(` ${padding}${getStateSymbol(test.task)} ${this.getTestName(test.task, c.dim(' > '))}${suffix}`)
206+
}
207+
}
175208

176-
if (test.result?.state === 'fail') {
177-
this.log(c.red(` ${padding}${taskFail} ${this.getTestName(test, c.dim(' > '))}`) + suffix)
209+
private getModuleLog(testModule: TestModule, counts: {
210+
tests: number
211+
failed: number
212+
skipped: number
213+
}): string {
214+
let state = c.dim(`${counts.tests} test${counts.tests > 1 ? 's' : ''}`)
178215

179-
// print short errors, full errors will be at the end in summary
180-
test.result?.errors?.forEach((error) => {
181-
const message = this.formatShortError(error)
216+
if (counts.failed) {
217+
state += c.dim(' | ') + c.red(`${counts.failed} failed`)
218+
}
182219

183-
if (message) {
184-
this.log(c.red(` ${padding}${message}`))
185-
}
186-
})
187-
}
220+
if (counts.skipped) {
221+
state += c.dim(' | ') + c.yellow(`${counts.skipped} skipped`)
222+
}
188223

189-
// also print slow tests
190-
else if (duration && duration > this.ctx.config.slowTestThreshold) {
191-
this.log(` ${padding}${c.yellow(c.dim(F_CHECK))} ${this.getTestName(test, c.dim(' > '))} ${suffix}`)
192-
}
224+
let suffix = c.dim('(') + state + c.dim(')') + this.getDurationPrefix(testModule.task)
193225

194-
else if (this.ctx.config.hideSkippedTests && (test.mode === 'skip' || test.result?.state === 'skip')) {
195-
// Skipped tests are hidden when --hideSkippedTests
196-
}
226+
const diagnostic = testModule.diagnostic()
227+
if (diagnostic.heap != null) {
228+
suffix += c.magenta(` ${Math.floor(diagnostic.heap / 1024 / 1024)} MB heap used`)
229+
}
197230

198-
// also print skipped tests that have notes
199-
else if (test.result?.state === 'skip' && test.result.note) {
200-
this.log(` ${padding}${getStateSymbol(test)} ${this.getTestName(test)}${c.dim(c.gray(` [${test.result.note}]`))}`)
201-
}
231+
let title = getStateSymbol(testModule.task)
202232

203-
else if (this.renderSucceed || failed.length > 0) {
204-
this.log(` ${padding}${getStateSymbol(test)} ${this.getTestName(test, c.dim(' > '))}${suffix}`)
205-
}
206-
}
233+
if (testModule.meta().typecheck) {
234+
title += ` ${c.bgBlue(c.bold(' TS '))}`
207235
}
236+
237+
if (testModule.project.name) {
238+
title += ` ${formatProjectName(testModule.project.name, '')}`
239+
}
240+
241+
return ` ${title} ${testModule.task.name} ${suffix}`
208242
}
209243

210-
protected printSuite(_task: Task): void {
244+
protected printTestSuite(_suite: TestSuite): void {
211245
// Suite name is included in getTestName by default
212246
}
213247

@@ -262,8 +296,8 @@ export abstract class BaseReporter implements Reporter {
262296

263297
onWatcherRerun(files: string[], trigger?: string): void {
264298
this.watchFilters = files
265-
this.failedUnwatchedFiles = this.ctx.state.getFiles().filter(file =>
266-
!files.includes(file.filepath) && hasFailed(file),
299+
this.failedUnwatchedFiles = this.ctx.state.getTestModules().filter(testModule =>
300+
!files.includes(testModule.task.filepath) && testModule.state() === 'failed',
267301
)
268302

269303
// Update re-run count for each file
@@ -296,8 +330,8 @@ export abstract class BaseReporter implements Reporter {
296330

297331
this.log('')
298332

299-
for (const task of this.failedUnwatchedFiles) {
300-
this.printTask(task)
333+
for (const testModule of this.failedUnwatchedFiles) {
334+
this.printTestModule(testModule)
301335
}
302336

303337
this._timeStart = formatTimeString(new Date())
@@ -405,7 +439,7 @@ export abstract class BaseReporter implements Reporter {
405439
this.log()
406440

407441
const affectedFiles = [
408-
...this.failedUnwatchedFiles,
442+
...this.failedUnwatchedFiles.map(m => m.task),
409443
...files,
410444
]
411445
const tests = getTests(affectedFiles)

‎packages/vitest/src/node/reporters/benchmark/reporter.ts

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
import type { File, Task, TaskResultPack } from '@vitest/runner'
1+
import type { File, TaskResultPack } from '@vitest/runner'
22
import type { Vitest } from '../../core'
3+
import type { TestModule, TestSuite } from '../reported-tasks'
34
import fs from 'node:fs'
45
import { getFullName } from '@vitest/runner/utils'
56
import * as pathe from 'pathe'
@@ -43,20 +44,28 @@ export class BenchmarkReporter extends DefaultReporter {
4344
})
4445
}
4546
}
47+
}
48+
49+
onTestSuiteResult(testSuite: TestSuite): void {
50+
super.onTestSuiteResult(testSuite)
51+
this.printSuiteTable(testSuite)
52+
}
4653

47-
super.onTaskUpdate(packs)
54+
protected printTestModule(testModule: TestModule): void {
55+
this.printSuiteTable(testModule)
4856
}
4957

50-
printTask(task: Task): void {
51-
if (task?.type !== 'suite' || !task.result?.state || task.result?.state === 'run' || task.result?.state === 'queued') {
58+
private printSuiteTable(testTask: TestModule | TestSuite): void {
59+
const state = testTask.state()
60+
if (state === 'pending' || state === 'queued') {
5261
return
5362
}
5463

55-
const benches = task.tasks.filter(t => t.meta.benchmark)
56-
const duration = task.result.duration
64+
const benches = testTask.task.tasks.filter(t => t.meta.benchmark)
65+
const duration = testTask.task.result?.duration || 0
5766

5867
if (benches.length > 0 && benches.every(t => t.result?.state !== 'run' && t.result?.state !== 'queued')) {
59-
let title = `\n ${getStateSymbol(task)} ${formatProjectName(task.file.projectName)}${getFullName(task, c.dim(' > '))}`
68+
let title = `\n ${getStateSymbol(testTask.task)} ${formatProjectName(testTask.project.name)}${getFullName(testTask.task, c.dim(' > '))}`
6069

6170
if (duration != null && duration > this.ctx.config.slowTestThreshold) {
6271
title += c.yellow(` ${Math.round(duration)}${c.dim('ms')}`)

‎packages/vitest/src/node/reporters/dot.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { File, Task, Test } from '@vitest/runner'
1+
import type { File, Test } from '@vitest/runner'
22
import type { Vitest } from '../core'
33
import type { TestCase, TestModule } from './reported-tasks'
44
import c from 'tinyrainbow'
@@ -30,9 +30,9 @@ export class DotReporter extends BaseReporter {
3030
}
3131
}
3232

33-
printTask(task: Task): void {
33+
printTestModule(testModule: TestModule): void {
3434
if (!this.isTTY) {
35-
super.printTask(task)
35+
super.printTestModule(testModule)
3636
}
3737
}
3838

‎packages/vitest/src/node/reporters/reported-tasks.ts

+24-7
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ class ReportedTaskImplementation {
5252
return !result || result.state !== 'fail'
5353
}
5454

55+
/**
56+
* Custom metadata that was attached to the test during its execution.
57+
*/
58+
public meta(): TaskMeta {
59+
return this.task.meta
60+
}
61+
5562
/**
5663
* Creates a new reported task instance and stores it in the project's state for future use.
5764
* @internal
@@ -170,13 +177,6 @@ export class TestCase extends ReportedTaskImplementation {
170177
} satisfies TestResultFailed
171178
}
172179

173-
/**
174-
* Custom metadata that was attached to the test during its execution.
175-
*/
176-
public meta(): TaskMeta {
177-
return this.task.meta
178-
}
179-
180180
/**
181181
* Useful information about the test like duration, memory usage, etc.
182182
* Diagnostic is only available after the test has finished.
@@ -387,6 +387,11 @@ export class TestSuite extends SuiteImplementation {
387387
*/
388388
declare public ok: () => boolean
389389

390+
/**
391+
* The meta information attached to the suite during its collection or execution.
392+
*/
393+
declare public meta: () => TaskMeta
394+
390395
/**
391396
* Checks the running state of the suite.
392397
*/
@@ -446,6 +451,11 @@ export class TestModule extends SuiteImplementation {
446451
*/
447452
declare public ok: () => boolean
448453

454+
/**
455+
* The meta information attached to the module during its collection or execution.
456+
*/
457+
declare public meta: () => TaskMeta
458+
449459
/**
450460
* Useful information about the module like duration, memory usage, etc.
451461
* If the module was not executed yet, all diagnostic values will return `0`.
@@ -456,12 +466,14 @@ export class TestModule extends SuiteImplementation {
456466
const prepareDuration = this.task.prepareDuration || 0
457467
const environmentSetupDuration = this.task.environmentLoad || 0
458468
const duration = this.task.result?.duration || 0
469+
const heap = this.task.result?.heap
459470
return {
460471
environmentSetupDuration,
461472
prepareDuration,
462473
collectDuration,
463474
setupDuration,
464475
duration,
476+
heap,
465477
}
466478
}
467479
}
@@ -609,6 +621,11 @@ export interface ModuleDiagnostic {
609621
* Accumulated duration of all tests and hooks in the module.
610622
*/
611623
readonly duration: number
624+
/**
625+
* The amount of memory used by the test module in bytes.
626+
* This value is only available if the test was executed with `logHeapUsage` flag.
627+
*/
628+
readonly heap: number | undefined
612629
}
613630

614631
function storeTask(

‎packages/vitest/src/node/reporters/verbose.ts

+39-21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { Task } from '@vitest/runner'
2-
import { getFullName, getTests } from '@vitest/runner/utils'
2+
import type { TestCase, TestModule, TestSuite } from './reported-tasks'
3+
import { getFullName } from '@vitest/runner/utils'
34
import c from 'tinyrainbow'
45
import { DefaultReporter } from './default'
56
import { F_RIGHT } from './renderers/figures'
@@ -9,45 +10,62 @@ export class VerboseReporter extends DefaultReporter {
910
protected verbose = true
1011
renderSucceed = true
1112

12-
printTask(task: Task): void {
13+
printTestModule(module: TestModule): void {
14+
// still print the test module in TTY,
15+
// but don't print it in the CLI because we
16+
// print all the tests when they finish
17+
// instead of printing them when the test file finishes
1318
if (this.isTTY) {
14-
return super.printTask(task)
19+
return super.printTestModule(module)
1520
}
21+
}
22+
23+
onTestCaseResult(test: TestCase): void {
24+
super.onTestCaseResult(test)
25+
26+
// don't print tests in TTY as they go, only print them
27+
// in the CLI when they finish
28+
if (this.isTTY) {
29+
return
30+
}
31+
32+
const testResult = test.result()
1633

17-
if (task.type !== 'test' || !task.result?.state || task.result?.state === 'run' || task.result?.state === 'queued') {
34+
if (this.ctx.config.hideSkippedTests && testResult.state === 'skipped') {
1835
return
1936
}
2037

21-
let title = ` ${getStateSymbol(task)} `
38+
let title = ` ${getStateSymbol(test.task)} `
2239

23-
if (task.file.projectName) {
24-
title += formatProjectName(task.file.projectName)
40+
if (test.project.name) {
41+
title += formatProjectName(test.project.name)
2542
}
2643

27-
title += getFullName(task, c.dim(' > '))
28-
title += super.getDurationPrefix(task)
44+
title += getFullName(test.task, c.dim(' > '))
45+
title += this.getDurationPrefix(test.task)
2946

30-
if (this.ctx.config.logHeapUsage && task.result.heap != null) {
31-
title += c.magenta(` ${Math.floor(task.result.heap / 1024 / 1024)} MB heap used`)
47+
const diagnostic = test.diagnostic()
48+
if (diagnostic?.heap != null) {
49+
title += c.magenta(` ${Math.floor(diagnostic.heap / 1024 / 1024)} MB heap used`)
3250
}
3351

34-
if (task.result?.note) {
35-
title += c.dim(c.gray(` [${task.result.note}]`))
52+
if (testResult.state === 'skipped' && testResult.note) {
53+
title += c.dim(c.gray(` [${testResult.note}]`))
3654
}
3755

38-
this.ctx.logger.log(title)
56+
this.log(title)
3957

40-
if (task.result.state === 'fail') {
41-
task.result.errors?.forEach(error => this.log(c.red(` ${F_RIGHT} ${error?.message}`)))
58+
if (testResult.state === 'failed') {
59+
testResult.errors.forEach(error => this.log(c.red(` ${F_RIGHT} ${error?.message}`)))
4260
}
4361
}
4462

45-
protected printSuite(task: Task): void {
46-
const indentation = ' '.repeat(getIndentation(task))
47-
const tests = getTests(task)
48-
const state = getStateSymbol(task)
63+
protected printTestSuite(testSuite: TestSuite): void {
64+
const indentation = ' '.repeat(getIndentation(testSuite.task))
65+
const tests = Array.from(testSuite.children.allTests())
66+
const state = getStateSymbol(testSuite.task)
4967

50-
this.log(` ${indentation}${state} ${task.name} ${c.dim(`(${tests.length})`)}`)
68+
this.log(` ${indentation}${state} ${testSuite.name} ${c.dim(`(${tests.length})`)}`)
5169
}
5270

5371
protected getTestName(test: Task): string {

‎packages/vitest/src/public/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ export type {
274274
Custom as RunnerCustomCase,
275275
Task as RunnerTask,
276276
TaskBase as RunnerTaskBase,
277+
TaskEventPack as RunnerTaskEventPack,
277278
TaskResult as RunnerTaskResult,
278279
TaskResultPack as RunnerTaskResultPack,
279280
Test as RunnerTestCase,

‎test/cli/fixtures/custom-pool/pool/custom-pool.ts

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
import type { RunnerTestFile, RunnerTestCase } from 'vitest'
1+
import type {
2+
RunnerTestFile,
3+
RunnerTestCase,
4+
RunnerTestSuite,
5+
RunnerTaskResultPack,
6+
RunnerTaskEventPack,
7+
RunnerTask
8+
} from 'vitest'
29
import type { ProcessPool, Vitest } from 'vitest/node'
310
import { createMethodsRPC } from 'vitest/node'
4-
import { getTasks, generateFileHash } from '@vitest/runner/utils'
11+
import { generateFileHash } from '@vitest/runner/utils'
512
import { normalize, relative } from 'pathe'
613

714
export default (vitest: Vitest): ProcessPool => {
@@ -16,7 +23,6 @@ export default (vitest: Vitest): ProcessPool => {
1623
vitest.logger.console.warn('[pool] array option', options.array)
1724
for (const [project, file] of specs) {
1825
vitest.state.clearFiles(project)
19-
const methods = createMethodsRPC(project)
2026
vitest.logger.console.warn('[pool] running tests for', project.name, 'in', normalize(file).toLowerCase().replace(normalize(process.cwd()).toLowerCase(), ''))
2127
const path = relative(project.config.root, file)
2228
const taskFile: RunnerTestFile = {
@@ -49,12 +55,7 @@ export default (vitest: Vitest): ProcessPool => {
4955
},
5056
}
5157
taskFile.tasks.push(taskTest)
52-
await methods.onCollected([taskFile])
53-
await methods.onTaskUpdate(getTasks(taskFile).map(task => [
54-
task.id,
55-
task.result,
56-
task.meta,
57-
]), [])
58+
await vitest._reportFileTask(taskFile)
5859
}
5960
},
6061
close() {

‎test/config/test/bail.test.ts

+10-6
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,21 @@ for (const config of configs) {
8787
if (browser) {
8888
expect(stdout).toMatch(`✓ |chromium| test/first.test.ts > 1 - first.test.ts - this should pass`)
8989
expect(stdout).toMatch(`× |chromium| test/first.test.ts > 2 - first.test.ts - this should fail`)
90+
91+
expect(stdout).not.toMatch('✓ |chromium| test/first.test.ts > 3 - first.test.ts - this should be skipped')
92+
expect(stdout).not.toMatch('✓ |chromium| test/second.test.ts > 1 - second.test.ts - this should be skipped')
93+
expect(stdout).not.toMatch('✓ |chromium| test/second.test.ts > 2 - second.test.ts - this should be skipped')
94+
expect(stdout).not.toMatch('✓ |chromium| test/second.test.ts > 3 - second.test.ts - this should be skipped')
9095
}
9196
else {
9297
expect(stdout).toMatch('✓ test/first.test.ts > 1 - first.test.ts - this should pass')
9398
expect(stdout).toMatch('× test/first.test.ts > 2 - first.test.ts - this should fail')
94-
}
9599

96-
// Cancelled tests should not be run
97-
expect(stdout).not.toMatch('test/first.test.ts > 3 - first.test.ts - this should be skipped')
98-
expect(stdout).not.toMatch('test/second.test.ts > 1 - second.test.ts - this should be skipped')
99-
expect(stdout).not.toMatch('test/second.test.ts > 2 - second.test.ts - this should be skipped')
100-
expect(stdout).not.toMatch('test/second.test.ts > 3 - second.test.ts - this should be skipped')
100+
expect(stdout).not.toMatch('✓ test/first.test.ts > 3 - first.test.ts - this should be skipped')
101+
expect(stdout).not.toMatch('✓ test/second.test.ts > 1 - second.test.ts - this should be skipped')
102+
expect(stdout).not.toMatch('✓ test/second.test.ts > 2 - second.test.ts - this should be skipped')
103+
expect(stdout).not.toMatch('✓ test/second.test.ts > 3 - second.test.ts - this should be skipped')
104+
}
101105
},
102106
)
103107
}

‎test/reporters/tests/default.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ describe('default reporter', async () => {
138138
expect(trimReporterOutput(stdout)).toMatchInlineSnapshot(`
139139
"✓ fixtures/pass-and-skip-test-suites.test.ts (4 tests | 2 skipped) [...]ms
140140
✓ passing test #1 [...]ms
141-
↓ skipped test #1
142141
✓ passing suite > passing test #2 [...]ms
142+
↓ skipped test #1
143143
↓ skipped suite > skipped test #2"
144144
`)
145145
})

‎test/reporters/tests/verbose.test.ts

+39-1
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ test('prints skipped tests by default', async () => {
3535
expect(trimReporterOutput(stdout)).toMatchInlineSnapshot(`
3636
"✓ fixtures/pass-and-skip-test-suites.test.ts (4 tests | 2 skipped) [...]ms
3737
✓ passing test #1 [...]ms
38-
↓ skipped test #1
3938
✓ passing suite (1)
4039
✓ passing test #2 [...]ms
40+
↓ skipped test #1
4141
↓ skipped suite (1)
4242
↓ skipped test #2"
4343
`)
@@ -149,6 +149,44 @@ test('does not render tree when in non-TTY', async () => {
149149
},
150150
})
151151

152+
expect(trimReporterOutput(stdout)).toMatchInlineSnapshot(`
153+
"✓ fixtures/verbose/example-1.test.ts > test pass in root [...]ms
154+
↓ fixtures/verbose/example-1.test.ts > test skip in root
155+
✓ fixtures/verbose/example-1.test.ts > suite in root > test pass in 1. suite #1 [...]ms
156+
✓ fixtures/verbose/example-1.test.ts > suite in root > test pass in 1. suite #2 [...]ms
157+
✓ fixtures/verbose/example-1.test.ts > suite in root > suite in suite > test pass in nested suite #1 [...]ms
158+
✓ fixtures/verbose/example-1.test.ts > suite in root > suite in suite > test pass in nested suite #2 [...]ms
159+
× fixtures/verbose/example-1.test.ts > suite in root > suite in suite > suite in nested suite > test failure in 2x nested suite [...]ms
160+
→ expected 'should fail' to be 'as expected' // Object.is equality
161+
↓ fixtures/verbose/example-1.test.ts > suite skip in root > test 1.3
162+
↓ fixtures/verbose/example-1.test.ts > suite skip in root > suite in suite > test in nested suite
163+
↓ fixtures/verbose/example-1.test.ts > suite skip in root > suite in suite > test failure in nested suite of skipped suite
164+
✓ fixtures/verbose/example-2.test.ts > test 0.1 [...]ms
165+
↓ fixtures/verbose/example-2.test.ts > test 0.2
166+
✓ fixtures/verbose/example-2.test.ts > suite 1.1 > test 1.1 [...]ms"
167+
`)
168+
})
169+
170+
test('hides skipped tests when --hideSkippedTests and in non-TTY', async () => {
171+
const { stdout } = await runVitest({
172+
include: ['fixtures/verbose/*.test.ts'],
173+
reporters: [['verbose', { isTTY: false, summary: false }]],
174+
hideSkippedTests: true,
175+
config: false,
176+
fileParallelism: false,
177+
sequence: {
178+
sequencer: class StableTestFileOrderSorter {
179+
sort(files: TestSpecification[]) {
180+
return files.sort((a, b) => a.moduleId.localeCompare(b.moduleId))
181+
}
182+
183+
shard(files: TestSpecification[]) {
184+
return files
185+
}
186+
},
187+
},
188+
})
189+
152190
expect(trimReporterOutput(stdout)).toMatchInlineSnapshot(`
153191
"✓ fixtures/verbose/example-1.test.ts > test pass in root [...]ms
154192
✓ fixtures/verbose/example-1.test.ts > suite in root > test pass in 1. suite #1 [...]ms

0 commit comments

Comments
 (0)
Please sign in to comment.