Skip to content

Commit

Permalink
Add annotations support to dart-json parser
Browse files Browse the repository at this point in the history
  • Loading branch information
Michal Dorner committed Jan 10, 2021
1 parent 41e4292 commit aed3b29
Show file tree
Hide file tree
Showing 3 changed files with 135 additions and 4 deletions.
51 changes: 50 additions & 1 deletion __tests__/__snapshots__/dart-json.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,56 @@

exports[`dart-json tests matches report snapshot 1`] = `
Object {
"annotations": Array [],
"annotations": Array [
Object {
"annotation_level": "failure",
"end_line": 13,
"message": "Expected: <2>
Actual: <1>
package:test_api expect
test\\\\main_test.dart 13:9 main.<fn>.<fn>.<fn>
",
"path": "test/main_test.dart",
"start_line": 13,
"title": "[test\\\\main_test.dart] Test 1 Test 1.1 Failing test",
},
Object {
"annotation_level": "failure",
"end_line": 2,
"message": "Exception: Some error
package:darttest/main.dart 2:3 throwError
test\\\\main_test.dart 17:9 main.<fn>.<fn>.<fn>
",
"path": "lib/main.dart",
"start_line": 2,
"title": "[test\\\\main_test.dart] Test 1 Test 1.1 Exception in target unit",
},
Object {
"annotation_level": "failure",
"end_line": 24,
"message": "Exception: Some error
test\\\\main_test.dart 24:7 main.<fn>.<fn>
",
"path": "test/main_test.dart",
"start_line": 24,
"title": "[test\\\\main_test.dart] Test 2 Exception in test",
},
Object {
"annotation_level": "failure",
"end_line": 5,
"message": "TimeoutException after 0:00:00.000001: Test timed out after 0 seconds.
dart:isolate _RawReceivePortImpl._handleMessage
",
"path": "test/second_test.dart",
"start_line": 5,
"title": "[test\\\\second_test.dart] Timeout test",
},
],
"summary": "**6** tests were completed in **3.760s** with **1** passed, **1** skipped and **4** failed.
| Result | Suite | Tests | Time | Passed ✔️ | Failed ❌ | Skipped ✖️ |
| :---: | :--- | ---: | ---: | ---: | ---: | ---: |
Expand Down
2 changes: 1 addition & 1 deletion __tests__/dart-json.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('dart-json tests', () => {
const opts: ParseOptions = {
name: 'Dart tests',
annotations: true,
trackedFiles: ['test/main_test.dart', 'test/second_test.dart'],
trackedFiles: ['lib/main.dart', 'test/main_test.dart', 'test/second_test.dart'],
workDir: 'C:/Users/Michal/Workspace/dorny/test-check/reports/dart/'
}

Expand Down
86 changes: 84 additions & 2 deletions src/parsers/dart-json/dart-json-parser.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import {ParseOptions, TestResult} from '../test-parser'
import {Annotation, ParseOptions, TestResult} from '../test-parser'

import {normalizeFilePath} from '../../utils/file-utils'
import {Align, Icon, link, table} from '../../utils/markdown-utils'
import {slug} from '../../utils/slugger'

Expand Down Expand Up @@ -103,7 +105,7 @@ export async function parseDartJson(content: string, options: ParseOptions): Pro
output: {
title: `${options.name.trim()} ${icon}`,
summary: getSummary(testRun),
annotations: options.annotations ? [] : undefined
annotations: options.annotations ? getAnnotations(testRun, options.workDir, options.trackedFiles) : undefined
}
}
}
Expand Down Expand Up @@ -208,3 +210,83 @@ function getTestCaseIcon(test: TestCase): string {
if (test.isSkipped) return Icon.skip
return Icon.success
}

function getAnnotations(tr: TestRun, workDir: string, trackedFiles: string[]): Annotation[] {
const annotations: Annotation[] = []
for (const suite of tr.suites) {
for (const group of Object.values(suite.groups)) {
for (const test of group.tests) {
if (test.error) {
const err = getAnnotation(test, suite, workDir, trackedFiles)
if (err !== null) {
annotations.push(err)
}
}
}
}
}

return annotations
}

function getAnnotation(
test: TestCase,
testSuite: TestSuite,
workDir: string,
trackedFiles: string[]
): Annotation | null {
const stack = test.error?.stackTrace ?? ''
let src = exceptionThrowSource(stack, trackedFiles)
if (src === null) {
const file = getRelativePathFromUrl(test.testStart.test.url ?? '', workDir)
if (!trackedFiles.includes(file)) {
return null
}
src = {
file,
line: test.testStart.test.line ?? 0
}
}

return {
annotation_level: 'failure',
start_line: src.line,
end_line: src.line,
path: src.file,
message: `${test.error?.error}\n\n${test.error?.stackTrace}`,
title: `[${testSuite.suite.path}] ${test.testStart.test.name}`
}
}

function exceptionThrowSource(ex: string, trackedFiles: string[]): {file: string; line: number} | null {
// imports from package which is tested are listed in stack traces as 'package:xyz/' which maps to relative path 'lib/'
const packageRe = /^package:[a-zA-z0-9_$]+\//
const lines = ex.split(/\r?\n/).map(str => str.replace(packageRe, 'lib/'))

// regexp to extract file path and line number from stack trace
const re = /^(.*)\s+(\d+):\d+\s+/
for (const str of lines) {
const match = str.match(re)
if (match !== null) {
const [_, fileStr, lineStr] = match
const file = normalizeFilePath(fileStr)
if (trackedFiles.includes(file)) {
const line = parseInt(lineStr)
return {file, line}
}
}
}

return null
}

function getRelativePathFromUrl(file: string, workdir: string): string {
const prefix = 'file:///'
if (file.startsWith(prefix)) {
file = file.substr(prefix.length)
}
if (file.startsWith(workdir)) {
file = file.substr(workdir.length)
}
return file
}

0 comments on commit aed3b29

Please sign in to comment.