feat(runner): Add full names to tasks (#9087)

Author: macarie

packages/runner/src/collect.ts

@@ -42,7 +42,7 @@ export async function collectTests(
 
         runner.onCollectStart?.(file)
 
-        clearCollectorContext(filepath, runner)
+        clearCollectorContext(file, runner)
 
         try {
           const setupFiles = toArray(config.setupFiles)

packages/runner/src/suite.ts

@@ -38,6 +38,7 @@ import { getHooks, setFn, setHooks, setTestFixture } from './map'
 import { getCurrentTest } from './test-state'
 import { findTestFileStackTrace } from './utils'
 import { createChainable } from './utils/chain'
+import { createTaskName } from './utils/tasks'
 
 /**
  * Creates a suite of tests, allowing for grouping and hierarchical organization of tests.
@@ -213,14 +214,15 @@ function createDefaultSuite(runner: VitestRunner) {
 }
 
 export function clearCollectorContext(
-  filepath: string,
+  file: File,
   currentRunner: VitestRunner,
 ): void {
   if (!defaultSuite) {
     defaultSuite = createDefaultSuite(currentRunner)
   }
+  defaultSuite.file = file
   runner = currentRunner
-  currentTestFilepath = filepath
+  currentTestFilepath = file.filepath
   collectorContext.tasks.length = 0
   defaultSuite.clear()
   collectorContext.currentSuite = defaultSuite
@@ -297,10 +299,16 @@ function createSuiteCollector(
 
   const task = function (name = '', options: TaskCustomOptions = {}) {
     const timeout = options?.timeout ?? runner.config.testTimeout
+    const currentSuite = collectorContext.currentSuite?.suite
     const task: Test = {
       id: '',
       name,
-      suite: collectorContext.currentSuite?.suite,
+      fullName: createTaskName([
+        currentSuite?.fullName ?? collectorContext.currentSuite?.file?.fullName,
+        name,
+      ]),
+      fullTestName: createTaskName([currentSuite?.fullTestName, name]),
+      suite: currentSuite,
       each: options.each,
       fails: options.fails,
       context: undefined!,
@@ -439,11 +447,18 @@ function createSuiteCollector(
       suiteOptions = { timeout: suiteOptions }
     }
 
+    const currentSuite = collectorContext.currentSuite?.suite
+
     suite = {
       id: '',
       type: 'suite',
       name,
-      suite: collectorContext.currentSuite?.suite,
+      fullName: createTaskName([
+        currentSuite?.fullName ?? collectorContext.currentSuite?.file?.fullName,
+        name,
+      ]),
+      fullTestName: createTaskName([currentSuite?.fullTestName, name]),
+      suite: currentSuite,
       mode,
       each,
       file: undefined!,

packages/runner/src/types/tasks.ts

@@ -18,6 +18,40 @@ export interface TaskBase {
    * Task name provided by the user. If no name was provided, it will be an empty string.
    */
   name: string
+  /**
+   * Full name including the file path, any parent suites, and this task's name.
+   *
+   * Uses ` > ` as the separator between levels.
+   *
+   * @example
+   * // file
+   * 'test/task-names.test.ts'
+   * @example
+   * // suite
+   * 'test/task-names.test.ts > meal planning'
+   * 'test/task-names.test.ts > meal planning > grocery lists'
+   * @example
+   * // test
+   * 'test/task-names.test.ts > meal planning > grocery lists > calculates ingredients'
+   */
+  fullName: string
+  /**
+   * Full name excluding the file path, including any parent suites and this task's name. `undefined` for file tasks.
+   *
+   * Uses ` > ` as the separator between levels.
+   *
+   * @example
+   * // file
+   * undefined
+   * @example
+   * // suite
+   * 'meal planning'
+   * 'meal planning > grocery lists'
+   * @example
+   * // test
+   * 'meal planning > grocery lists > calculates ingredients'
+   */
+  fullTestName?: string
   /**
    * Task mode.
    * - **skip**: task is skipped
@@ -291,6 +325,7 @@ export interface Test<ExtraContext = object> extends TaskPopulated {
    * @experimental
    */
   artifacts: TestArtifact[]
+  fullTestName: string
 }
 
 export type Task = Test | Suite | File
@@ -630,6 +665,7 @@ export interface SuiteCollector<ExtraContext = object> {
   )[]
   scoped: (fixtures: Fixtures<any, ExtraContext>) => void
   fixtures: () => FixtureItem[] | undefined
+  file?: File
   suite?: Suite
   task: (name: string, options?: TaskCustomOptions) => Test<ExtraContext>
   collect: (file: File) => Promise<Suite>

packages/runner/src/utils/collect.ts

@@ -187,6 +187,7 @@ export function createFileTask(
   const file: File = {
     id: generateFileHash(path, projectName),
     name: path,
+    fullName: path,
     type: 'suite',
     mode: 'queued',
     filepath,

packages/runner/src/utils/index.ts

@@ -11,6 +11,7 @@ export {
 export { limitConcurrency } from './limit-concurrency'
 export { partitionSuiteChildren } from './suite'
 export {
+  createTaskName,
   getFullName,
   getNames,
   getSuites,

packages/runner/src/utils/tasks.ts

@@ -80,3 +80,7 @@ export function getFullName(task: Task, separator = ' > '): string {
 export function getTestName(task: Task, separator = ' > '): string {
   return getNames(task).slice(1).join(separator)
 }
+
+export function createTaskName(names: readonly (string | undefined)[], separator = ' > '): string {
+  return names.filter(name => name !== undefined).join(separator)
+}

packages/ui/client/components/views/ViewReport.spec.ts

@@ -48,6 +48,7 @@ const fileWithTextStacks: RunnerTestFile = {
   type: 'suite',
   mode: 'run',
   filepath: 'test/plain-stack-trace.ts',
+  fullName: 'test/plain-stack-trace.ts',
   meta: {},
   result: {
     state: 'fail',
@@ -98,6 +99,7 @@ describe('ViewReport', () => {
       type: 'suite',
       mode: 'run',
       filepath: 'test/plain-stack-trace.ts',
+      fullName: 'test/plain-stack-trace.ts',
       meta: {},
       result: {
         state: 'fail',
@@ -157,6 +159,7 @@ describe('ViewReport', () => {
       type: 'suite',
       mode: 'run',
       filepath: 'test/plain-stack-trace.ts',
+      fullName: 'test/plain-stack-trace.ts',
       meta: {},
       result: {
         state: 'fail',

packages/ui/client/components/views/ViewReport.vue

@@ -46,6 +46,7 @@ const failed = computed(() => {
       id: file!.id,
       file: file!,
       name: file!.name,
+      fullName: file!.name,
       level: 0,
       type: 'suite',
       mode: 'run',

packages/vitest/src/node/ast-collect.ts

@@ -4,6 +4,7 @@ import type { TestProject } from './project'
 import { originalPositionFor, TraceMap } from '@jridgewell/trace-mapping'
 import {
   calculateSuiteHash,
+  createTaskName,
   generateHash,
   interpretTaskModes,
   someTasksAreOnly,
@@ -193,6 +194,7 @@ export function createFailedFileTask(project: TestProject, filepath: string, err
     type: 'suite',
     id: /* @__PURE__ */ generateHash(`${testFilepath}${project.config.name || ''}`),
     name: testFilepath,
+    fullName: testFilepath,
     mode: 'run',
     tasks: [],
     start: 0,
@@ -252,6 +254,7 @@ function createFileTask(
     type: 'suite',
     id: /* @__PURE__ */ generateHash(`${testFilepath}${options.name || ''}`),
     name: testFilepath,
+    fullName: testFilepath,
     mode: 'run',
     tasks: [],
     start: ast.start,
@@ -324,6 +327,8 @@ function createFileTask(
           tasks: [],
           mode,
           name: definition.name,
+          fullName: createTaskName([latestSuite.fullName, definition.name]),
+          fullTestName: createTaskName([latestSuite.fullTestName, definition.name]),
           end: definition.end,
           start: definition.start,
           location,
@@ -343,6 +348,8 @@ function createFileTask(
         mode,
         context: {} as any, // not used on the server
         name: definition.name,
+        fullName: createTaskName([latestSuite.fullName, definition.name]),
+        fullTestName: createTaskName([latestSuite.fullTestName, definition.name]),
         end: definition.end,
         start: definition.start,
         location,

packages/vitest/src/node/reporters/junit.ts

@@ -327,6 +327,8 @@ export class JUnitReporter implements Reporter {
           id: file.id,
           type: 'test',
           name: file.name,
+          fullName: file.name,
+          fullTestName: file.name,
           mode: 'run',
           result: file.result,
           meta: {},