feat: add location to json reporter (#1656)

* feat: add location to json reporter * fix: null check * fix: remove unsupported method * ci * ci
vitest-dev · Jul 19, 2022 · d507334 · d507334
1 parent b653409
commit d507334
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 6 deletions.
diff --git a/packages/vitest/src/node/reporters/json.ts b/packages/vitest/src/node/reporters/json.ts
@@ -1,16 +1,18 @@
 import { existsSync, promises as fs } from 'fs'
 import { dirname, resolve } from 'pathe'
 import type { Vitest } from '../../node'
-import type { File, Reporter, Suite, TaskState } from '../../types'
+import type { File, Reporter, Suite, TaskState, Test } from '../../types'
 import { getSuites, getTests } from '../../utils'
 import { getOutputFile } from '../../utils/config-helpers'
+import { parseStacktrace } from '../../utils/source-map'
 
 // for compatibility reasons, the reporter produces a JSON similar to the one produced by the Jest JSON reporter
 // the following types are extracted from the Jest repository (and simplified)
 // the commented-out fields are the missing ones
 
 type Status = 'passed' | 'failed' | 'skipped' | 'pending' | 'todo' | 'disabled'
 type Milliseconds = number
+interface Callsite { line: number; column: number }
 const StatusMap: Record<TaskState, Status> = {
   fail: 'failed',
   only: 'pending',
@@ -27,7 +29,7 @@ interface FormattedAssertionResult {
   title: string
   duration?: Milliseconds | null
   failureMessages: Array<string>
-  // location?: Callsite | null
+  location?: Callsite | null
 }
 
 interface FormattedTestResult {
@@ -108,6 +110,7 @@ export class JsonReporter implements Reporter {
           title: t.name,
           duration: t.result?.duration,
           failureMessages: t.result?.error?.message == null ? [] : [t.result.error.message],
+          location: this.getFailureLocation(t),
         } as FormattedAssertionResult
       })
 
@@ -176,4 +179,18 @@ export class JsonReporter implements Reporter {
       this.ctx.logger.log(report)
     }
   }
+
+  protected getFailureLocation(test: Test): Callsite | undefined {
+    const error = test.result?.error
+    if (!error)
+      return
+
+    const stack = parseStacktrace(error)
+    const frame = stack[stack.length - 1]
+    if (!frame)
+      return
+
+    const pos = frame.sourcePos || frame
+    return { line: pos.line, column: pos.column }
+  }
 }
diff --git a/test/reporters/tests/__snapshots__/reporters.spec.ts.snap b/test/reporters/tests/__snapshots__/reporters.spec.ts.snap
@@ -262,6 +262,10 @@ exports[`json reporter (no outputFile entry) 1`] = `
             "expected 2.23606797749979 to equal 2",
           ],
           "fullName": "suite inner suite Math.sqrt()",
+          "location": {
+            "column": 32,
+            "line": 8,
+          },
           "status": "failed",
           "title": "Math.sqrt()",
         },
@@ -380,6 +384,10 @@ exports[`json reporter 1`] = `
             "expected 2.23606797749979 to equal 2",
           ],
           "fullName": "suite inner suite Math.sqrt()",
+          "location": {
+            "column": 32,
+            "line": 8,
+          },
           "status": "failed",
           "title": "Math.sqrt()",
         },
@@ -504,7 +512,11 @@ exports[`json reporter with outputFile 2`] = `
           \\"duration\\": 1.4422860145568848,
           \\"failureMessages\\": [
             \\"expected 2.23606797749979 to equal 2\\"
-          ]
+          ],
+          \\"location\\": {
+            \\"line\\": 8,
+            \\"column\\": 32
+          }
         },
         {
           \\"ancestorTitles\\": [
@@ -627,7 +639,11 @@ exports[`json reporter with outputFile in non-existing directory 2`] = `
           \\"duration\\": 1.4422860145568848,
           \\"failureMessages\\": [
             \\"expected 2.23606797749979 to equal 2\\"
-          ]
+          ],
+          \\"location\\": {
+            \\"line\\": 8,
+            \\"column\\": 32
+          }
         },
         {
           \\"ancestorTitles\\": [
@@ -750,7 +766,11 @@ exports[`json reporter with outputFile object 2`] = `
           \\"duration\\": 1.4422860145568848,
           \\"failureMessages\\": [
             \\"expected 2.23606797749979 to equal 2\\"
-          ]
+          ],
+          \\"location\\": {
+            \\"line\\": 8,
+            \\"column\\": 32
+          }
         },
         {
           \\"ancestorTitles\\": [
@@ -873,7 +893,11 @@ exports[`json reporter with outputFile object in non-existing directory 2`] = `
           \\"duration\\": 1.4422860145568848,
           \\"failureMessages\\": [
             \\"expected 2.23606797749979 to equal 2\\"
-          ]
+          ],
+          \\"location\\": {
+            \\"line\\": 8,
+            \\"column\\": 32
+          }
         },
         {
           \\"ancestorTitles\\": [