fix(reporters): show retry and repeats counts (#7004)

AriPerkkio · hi-ogawa · web-flow · commit 3496a01547f9 · 2024-12-03T10:01:47.000+09:00
Co-authored-by: Hiroshi Ogawa &lt;hi.ogawa.zz@gmail.com&gt;
diff --git a/packages/vitest/src/node/reporters/base.ts b/packages/vitest/src/node/reporters/base.ts
@@ -114,11 +114,19 @@ export abstract class BaseReporter implements Reporter {
     const anyFailed = tests.some(test => test.result?.state === 'fail')
 
     for (const test of tests) {
-      const duration = test.result?.duration
+      const { duration, retryCount, repeatCount } = test.result || {}
+      let suffix = ''
+
+      if (retryCount != null && retryCount > 0) {
+        suffix += c.yellow(` (retry x${retryCount})`)
+      }
+
+      if (repeatCount != null && repeatCount > 0) {
+        suffix += c.yellow(` (repeat x${repeatCount})`)
+      }
 
       if (test.result?.state === 'fail') {
-        const suffix = this.getDurationPrefix(test)
-        this.log(c.red(`   ${taskFail} ${getTestName(test, c.dim(' > '))}${suffix}`))
+        this.log(c.red(`   ${taskFail} ${getTestName(test, c.dim(' > '))}${this.getDurationPrefix(test)}`) + suffix)
 
         test.result?.errors?.forEach((e) => {
           // print short errors, full errors will be at the end in summary
@@ -130,7 +138,7 @@ export abstract class BaseReporter implements Reporter {
       else if (duration && duration > this.ctx.config.slowTestThreshold) {
         this.log(
           `   ${c.yellow(c.dim(F_CHECK))} ${getTestName(test, c.dim(' > '))}`
-          + ` ${c.yellow(Math.round(duration) + c.dim('ms'))}`,
+          + ` ${c.yellow(Math.round(duration) + c.dim('ms'))}${suffix}`,
         )
       }
 
@@ -144,7 +152,7 @@ export abstract class BaseReporter implements Reporter {
       }
 
       else if (this.renderSucceed || anyFailed) {
-        this.log(`   ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}`)
+        this.log(`   ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}${suffix}`)
       }
     }
   }
diff --git a/test/reporters/fixtures/repeats.test.ts b/test/reporters/fixtures/repeats.test.ts
@@ -0,0 +1,5 @@
+import { expect, test } from 'vitest'
+
+test('repeat couple of times',{ repeats: 3 },  () => {
+  expect(true).toBe(true)
+})
diff --git a/test/reporters/fixtures/retry.test.ts b/test/reporters/fixtures/retry.test.ts
@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+let number = 0
+
+test('pass after retries', () => {
+  expect(number++).toBe(3)
+})
diff --git a/test/reporters/tests/default.test.ts b/test/reporters/tests/default.test.ts
@@ -94,4 +94,27 @@ describe('default reporter', async () => {
     expect(stdout).toContain('✓ 2 + 3 = 5')
     expect(stdout).not.toContain('↓ 3 + 3 = 6')
   })
+
+  test('prints retry count', async () => {
+    const { stdout } = await runVitest({
+      include: ['fixtures/retry.test.ts'],
+      reporters: [['default', { isTTY: true, summary: false }]],
+      retry: 3,
+      config: false,
+    })
+
+    expect(stdout).toContain('1 passed')
+    expect(stdout).toContain('✓ pass after retries (retry x3)')
+  })
+
+  test('prints repeat count', async () => {
+    const { stdout } = await runVitest({
+      include: ['fixtures/repeats.test.ts'],
+      reporters: [['default', { isTTY: true, summary: false }]],
+      config: false,
+    })
+
+    expect(stdout).toContain('1 passed')
+    expect(stdout).toContain('✓ repeat couple of times (repeat x3)')
+  })
 }, 120000)
diff --git a/test/reporters/tests/verbose.test.ts b/test/reporters/tests/verbose.test.ts
@@ -8,7 +8,7 @@ test('duration', async () => {
     env: { CI: '1' },
   })
 
-  const output = result.stdout.replaceAll(/\d+ms/g, '[...]ms')
+  const output = result.stdout.replace(/\d+ms/g, '[...]ms')
   expect(output).toContain(`
  ✓ basic.test.ts > fast
  ✓ basic.test.ts > slow [...]ms
@@ -49,3 +49,26 @@ test('hides skipped tests when --hideSkippedTests', async () => {
   expect(stdout).toContain('✓ 2 + 3 = 5')
   expect(stdout).not.toContain('↓ 3 + 3 = 6')
 })
+
+test('prints retry count', async () => {
+  const { stdout } = await runVitest({
+    include: ['fixtures/retry.test.ts'],
+    reporters: [['verbose', { isTTY: true, summary: false }]],
+    retry: 3,
+    config: false,
+  })
+
+  expect(stdout).toContain('1 passed')
+  expect(stdout).toContain('✓ pass after retries (retry x3)')
+})
+
+test('prints repeat count', async () => {
+  const { stdout } = await runVitest({
+    include: ['fixtures/repeats.test.ts'],
+    reporters: [['verbose', { isTTY: true, summary: false }]],
+    config: false,
+  })
+
+  expect(stdout).toContain('1 passed')
+  expect(stdout).toContain('✓ repeat couple of times (repeat x3)')
+})

Original file line number	Diff line number	Diff line change
`@@ -114,11 +114,19 @@ export abstract class BaseReporter implements Reporter {`
`114`	`114`	`const anyFailed = tests.some(test => test.result?.state === 'fail')`
`115`	`115`
`116`	`116`	`for (const test of tests) {`
`117`		`- const duration = test.result?.duration`
	`117`	`+ const { duration, retryCount, repeatCount } = test.result \|\| {}`
	`118`	`+ let suffix = ''`
	`119`	`+`
	`120`	`+ if (retryCount != null && retryCount > 0) {`
	`121`	+ suffix += c.yellow(` (retry x${retryCount})`)
	`122`	`+ }`
	`123`	`+`
	`124`	`+ if (repeatCount != null && repeatCount > 0) {`
	`125`	+ suffix += c.yellow(` (repeat x${repeatCount})`)
	`126`	`+ }`
`118`	`127`
`119`	`128`	`if (test.result?.state === 'fail') {`
`120`		`- const suffix = this.getDurationPrefix(test)`
`121`		- this.log(c.red(` ${taskFail} ${getTestName(test, c.dim(' > '))}${suffix}`))
	`129`	+ this.log(c.red(` ${taskFail} ${getTestName(test, c.dim(' > '))}${this.getDurationPrefix(test)}`) + suffix)
`122`	`130`
`123`	`131`	`test.result?.errors?.forEach((e) => {`
`124`	`132`	`// print short errors, full errors will be at the end in summary`
`@@ -130,7 +138,7 @@ export abstract class BaseReporter implements Reporter {`
`130`	`138`	`else if (duration && duration > this.ctx.config.slowTestThreshold) {`
`131`	`139`	`this.log(`
`132`	`140`	` ${c.yellow(c.dim(F_CHECK))} ${getTestName(test, c.dim(' > '))}`
`133`		- + ` ${c.yellow(Math.round(duration) + c.dim('ms'))}`,
	`141`	+ + ` ${c.yellow(Math.round(duration) + c.dim('ms'))}${suffix}`,
`134`	`142`	`)`
`135`	`143`	`}`
`136`	`144`
`@@ -144,7 +152,7 @@ export abstract class BaseReporter implements Reporter {`
`144`	`152`	`}`
`145`	`153`
`146`	`154`	`else if (this.renderSucceed \|\| anyFailed) {`
`147`		- this.log(` ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}`)
	`155`	+ this.log(` ${c.dim(getStateSymbol(test))} ${getTestName(test, c.dim(' > '))}${suffix}`)
`148`	`156`	`}`
`149`	`157`	`}`
`150`	`158`	`}`