diff --git a/.gitignore b/.gitignore index 4f3bf2a..639696a 100644 --- a/.gitignore +++ b/.gitignore @@ -99,5 +99,4 @@ __tests__/runner/* lib/**/* # Project specific -__tests__/__outputs__ __tests__/__results__ diff --git a/__tests__/__outputs__/dart-json.md b/__tests__/__outputs__/dart-json.md new file mode 100644 index 0000000..f7e3ec3 --- /dev/null +++ b/__tests__/__outputs__/dart-json.md @@ -0,0 +1,38 @@ +### fixtures\dart-json.json + +**6** tests were completed in **3.760s** with **1** passed, **1** skipped and **4** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | +| :---: | :--- | ---: | ---: | ---: | ---: | ---: | +| ❌ | [test\main_test.dart](#ts-0-test-maintest-dart) | 4 | 74ms | 1 | 0 | 3 | +| ❌ | [test\second_test.dart](#ts-1-test-secondtest-dart) | 2 | 51ms | 0 | 1 | 1 | + +# Test Suites + +## test\main_test.dart ❌ + +### Test 1 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ✔️ | Test 1 Passing test | 36ms | + +### Test 1 Test 1.1 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Test 1 Test 1.1 Failing test | 20ms | +| ❌ | Test 1 Test 1.1 Exception in target unit | 6ms | + +### Test 2 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Test 2 Exception in test | 12ms | + +## test\second_test.dart ❌ + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Timeout test | 37ms | +| ✖️ | Skipped test | 14ms | diff --git a/__tests__/__outputs__/dotnet-trx.md b/__tests__/__outputs__/dotnet-trx.md new file mode 100644 index 0000000..1e7342d --- /dev/null +++ b/__tests__/__outputs__/dotnet-trx.md @@ -0,0 +1,21 @@ +### fixtures\dotnet-trx.trx + +**7** tests were completed in **1.061s** with **3** passed, **1** skipped and **3** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | +| :---: | :--- | ---: | ---: | ---: | ---: | ---: | +| ❌ | [DotnetTests.XUnitTests.CalculatorTests](#ts-0-DotnetTests-XUnitTests-CalculatorTests) | 7 | 109.5761ms | 3 | 1 | 3 | + +# Test Suites + +## DotnetTests.XUnitTests.CalculatorTests ❌ + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Exception_In_TargetTest | 0.4975ms | +| ❌ | Exception_In_Test | 2.2728ms | +| ❌ | Failing_Test | 3.2953ms | +| ✔️ | Passing_Test | 0.1254ms | +| ✔️ | Passing_Test_With_Name | 0.103ms | +| ✖️ | Skipped_Test | 1ms | +| ✔️ | Timeout_Test | 102.2821ms | diff --git a/__tests__/__outputs__/jest-junit.md b/__tests__/__outputs__/jest-junit.md new file mode 100644 index 0000000..d086fc3 --- /dev/null +++ b/__tests__/__outputs__/jest-junit.md @@ -0,0 +1,38 @@ +### fixtures\jest-junit.xml + +**6** tests were completed in **1.360s** with **1** passed, **1** skipped and **4** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | +| :---: | :--- | ---: | ---: | ---: | ---: | ---: | +| ❌ | [__tests__\main.test.js](#ts-0-tests-main-test-js) | 4 | 486ms | 1 | 0 | 3 | +| ❌ | [__tests__\second.test.js](#ts-1-tests-second-test-js) | 2 | 82ms | 0 | 1 | 1 | + +# Test Suites + +## __tests__\main.test.js ❌ + +### Test 1 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ✔️ | Passing test | 1ms | + +### Test 1 › Test 1.1 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Failing test | 2ms | +| ❌ | Exception in target unit | 0ms | + +### Test 2 + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Exception in test | 0ms | + +## __tests__\second.test.js ❌ + +| Result | Test | Time | +| :---: | :--- | ---: | +| ❌ | Timeout test | 4ms | +| ✖️ | Skipped test | 0ms | diff --git a/__tests__/__snapshots__/dart-json.test.ts.snap b/__tests__/__snapshots__/dart-json.test.ts.snap index 194aadd..2460bce 100644 --- a/__tests__/__snapshots__/dart-json.test.ts.snap +++ b/__tests__/__snapshots__/dart-json.test.ts.snap @@ -52,11 +52,15 @@ dart:isolate _RawReceivePortImpl._handleMessage "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 ✖️ | + "summary": "### fixtures\\\\dart-json.json + +**6** tests were completed in **3.760s** with **1** passed, **1** skipped and **4** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | | :---: | :--- | ---: | ---: | ---: | ---: | ---: | -| ❌ | [test\\\\main_test.dart](#ts-0-test-maintest-dart) | 4 | 74ms | 1 | 3 | 0 | +| ❌ | [test\\\\main_test.dart](#ts-0-test-maintest-dart) | 4 | 74ms | 1 | 0 | 3 | | ❌ | [test\\\\second_test.dart](#ts-1-test-secondtest-dart) | 2 | 51ms | 0 | 1 | 1 | + # Test Suites ## test\\\\main_test.dart ❌ diff --git a/__tests__/__snapshots__/dotnet-trx.test.ts.snap b/__tests__/__snapshots__/dotnet-trx.test.ts.snap index 2677a7c..2eb0eea 100644 --- a/__tests__/__snapshots__/dotnet-trx.test.ts.snap +++ b/__tests__/__snapshots__/dotnet-trx.test.ts.snap @@ -30,10 +30,14 @@ Actual: 2", "title": "[DotnetTests.XUnitTests.CalculatorTests] Failing_Test", }, ], - "summary": "**7** tests were completed in **1.061s** with **3** passed, **1** skipped and **3** failed. -| Result | Suite | Tests | Time | Passed ✔️ | Failed ❌ | Skipped ✖️ | + "summary": "### fixtures\\\\dotnet-trx.trx + +**7** tests were completed in **1.061s** with **3** passed, **1** skipped and **3** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | | :---: | :--- | ---: | ---: | ---: | ---: | ---: | -| ❌ | [DotnetTests.XUnitTests.CalculatorTests](#ts-0-DotnetTests-XUnitTests-CalculatorTests) | 7 | 109.5761ms | 3 | 3 | 1 | +| ❌ | [DotnetTests.XUnitTests.CalculatorTests](#ts-0-DotnetTests-XUnitTests-CalculatorTests) | 7 | 109.5761ms | 3 | 1 | 3 | + # Test Suites ## DotnetTests.XUnitTests.CalculatorTests ❌ diff --git a/__tests__/__snapshots__/jest-junit.test.ts.snap b/__tests__/__snapshots__/jest-junit.test.ts.snap index bf8ec9b..9bf8aa2 100644 --- a/__tests__/__snapshots__/jest-junit.test.ts.snap +++ b/__tests__/__snapshots__/jest-junit.test.ts.snap @@ -73,11 +73,15 @@ Received: false "title": "[__tests__\\\\second.test.js] Timeout test", }, ], - "summary": "**6** tests were completed in **1.360s** with **1** passed, **1** skipped and **4** failed. -| Result | Suite | Tests | Time | Passed ✔️ | Failed ❌ | Skipped ✖️ | + "summary": "### fixtures\\\\jest-junit.xml + +**6** tests were completed in **1.360s** with **1** passed, **1** skipped and **4** failed. + +| Result | Suite | Tests | Time | Passed ✔️ | Skipped ✖️ | Failed ❌ | | :---: | :--- | ---: | ---: | ---: | ---: | ---: | -| ❌ | [__tests__\\\\main.test.js](#ts-0-tests-main-test-js) | 4 | 486ms | 1 | 3 | 0 | +| ❌ | [__tests__\\\\main.test.js](#ts-0-tests-main-test-js) | 4 | 486ms | 1 | 0 | 3 | | ❌ | [__tests__\\\\second.test.js](#ts-1-tests-second-test-js) | 2 | 82ms | 0 | 1 | 1 | + # Test Suites ## __tests__\\\\main.test.js ❌ diff --git a/__tests__/dart-json.test.ts b/__tests__/dart-json.test.ts index 6d2cf82..f1d6b4e 100644 --- a/__tests__/dart-json.test.ts +++ b/__tests__/dart-json.test.ts @@ -7,7 +7,7 @@ import {ParseOptions} from '../src/parsers/parser-types' const fixturePath = path.join(__dirname, 'fixtures', 'dart-json.json') const outputPath = path.join(__dirname, '__outputs__', 'dart-json.md') const xmlFixture = { - path: fixturePath, + path: path.relative(__dirname, fixturePath), content: fs.readFileSync(fixturePath, {encoding: 'utf8'}) } diff --git a/__tests__/dotnet-trx.test.ts b/__tests__/dotnet-trx.test.ts index af9760a..3298f3e 100644 --- a/__tests__/dotnet-trx.test.ts +++ b/__tests__/dotnet-trx.test.ts @@ -7,7 +7,7 @@ import {ParseOptions} from '../src/parsers/parser-types' const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-trx.trx') const outputPath = path.join(__dirname, '__outputs__', 'dotnet-trx.md') const xmlFixture = { - path: fixturePath, + path: path.relative(__dirname, fixturePath), content: fs.readFileSync(fixturePath, {encoding: 'utf8'}) } diff --git a/__tests__/jest-junit.test.ts b/__tests__/jest-junit.test.ts index 0c9092f..816184f 100644 --- a/__tests__/jest-junit.test.ts +++ b/__tests__/jest-junit.test.ts @@ -7,7 +7,7 @@ import {ParseOptions} from '../src/parsers/parser-types' const fixturePath = path.join(__dirname, 'fixtures', 'jest-junit.xml') const outputPath = path.join(__dirname, '__outputs__', 'jest-junit.md') const xmlFixture = { - path: fixturePath, + path: path.relative(__dirname, fixturePath), content: fs.readFileSync(fixturePath, {encoding: 'utf8'}) } diff --git a/src/parsers/dart-json/dart-json-parser.ts b/src/parsers/dart-json/dart-json-parser.ts index 7608db0..e6bd861 100644 --- a/src/parsers/dart-json/dart-json-parser.ts +++ b/src/parsers/dart-json/dart-json-parser.ts @@ -28,7 +28,7 @@ import { } from '../../report/test-results' class TestRun { - constructor(readonly suites: TestSuite[], readonly success: boolean, readonly time: number) {} + constructor(readonly path: string, readonly suites: TestSuite[], readonly success: boolean, readonly time: number) {} } class TestSuite { @@ -69,20 +69,22 @@ class TestCase { } export async function parseDartJson(files: FileContent[], options: ParseOptions): Promise { - const testRun = getTestRun(files[0].content) - const icon = testRun.success ? Icon.success : Icon.fail + const testRuns = files.map(f => getTestRun(f.path, f.content)) + const testRunsResults = testRuns.map(getTestRunResult) + const success = testRuns.every(tr => tr.success) + const icon = success ? Icon.success : Icon.fail return { - success: testRun.success, + success, output: { title: `${options.name.trim()} ${icon}`, - summary: getReport(getTestRunResult(testRun)), - annotations: options.annotations ? getAnnotations(testRun, options.workDir, options.trackedFiles) : undefined + summary: getReport(testRunsResults), + annotations: options.annotations ? getAnnotations(testRuns, options.workDir, options.trackedFiles) : undefined } } } -function getTestRun(content: string): TestRun { +function getTestRun(path: string, content: string): TestRun { const lines = content.split(/\n\r?/g).filter(line => line !== '') const events = lines.map(str => JSON.parse(str)) as ReportEvent[] @@ -112,7 +114,7 @@ function getTestRun(content: string): TestRun { } } - return new TestRun(Object.values(suites), success, totalTime) + return new TestRun(path, Object.values(suites), success, totalTime) } function getTestRunResult(tr: TestRun): TestRunResult { @@ -120,7 +122,7 @@ function getTestRunResult(tr: TestRun): TestRunResult { return new TestSuiteResult(s.suite.path, getGroups(s)) }) - return new TestRunResult(suites, tr.time) + return new TestRunResult(tr.path, suites, tr.time) } function getGroups(suite: TestSuite): TestGroupResult[] { @@ -134,15 +136,17 @@ function getGroups(suite: TestSuite): TestGroupResult[] { }) } -function getAnnotations(tr: TestRun, workDir: string, trackedFiles: string[]): Annotation[] { +function getAnnotations(testRuns: 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) + for (const tr of testRuns) { + 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) + } } } } diff --git a/src/parsers/dotnet-trx/dotnet-trx-parser.ts b/src/parsers/dotnet-trx/dotnet-trx-parser.ts index 95792fd..53e533b 100644 --- a/src/parsers/dotnet-trx/dotnet-trx-parser.ts +++ b/src/parsers/dotnet-trx/dotnet-trx-parser.ts @@ -42,26 +42,37 @@ class Test { } export async function parseDotnetTrx(files: FileContent[], options: ParseOptions): Promise { - const trx = (await parseStringPromise(files[0].content, { - attrValueProcessors: [parseAttribute] - })) as TrxReport + const testRuns: TestRunResult[] = [] + const testClasses: TestClass[] = [] + + for (const file of files) { + const trx = await getTrxReport(file.content) + const tc = getTestClasses(trx) + const tr = getTestRunResult(file.path, trx, tc) + testRuns.push(tr) + testClasses.push(...tc) + } - const testClasses = getTestClasses(trx) - const testRun = getTestRunResult(trx, testClasses) - const success = testRun.result === 'success' + const success = testRuns.every(tr => tr.result === 'success') const icon = success ? Icon.success : Icon.fail return { success, output: { title: `${options.name.trim()} ${icon}`, - summary: getReport(testRun), + summary: getReport(testRuns), annotations: options.annotations ? getAnnotations(testClasses, options.workDir, options.trackedFiles) : undefined } } } -function getTestRunResult(trx: TrxReport, testClasses: TestClass[]): TestRunResult { +async function getTrxReport(content: string): Promise { + return (await parseStringPromise(content, { + attrValueProcessors: [parseAttribute] + })) as TrxReport +} + +function getTestRunResult(path: string, trx: TrxReport, testClasses: TestClass[]): TestRunResult { const times = trx.TestRun.Times[0].$ const totalTime = times.finish.getTime() - times.start.getTime() @@ -71,7 +82,7 @@ function getTestRunResult(trx: TrxReport, testClasses: TestClass[]): TestRunResu return new TestSuiteResult(tc.name, [group]) }) - return new TestRunResult(suites, totalTime) + return new TestRunResult(path, suites, totalTime) } function getTestClasses(trx: TrxReport): TestClass[] { diff --git a/src/parsers/jest-junit/jest-junit-parser.ts b/src/parsers/jest-junit/jest-junit-parser.ts index fefa625..e43d30b 100644 --- a/src/parsers/jest-junit/jest-junit-parser.ts +++ b/src/parsers/jest-junit/jest-junit-parser.ts @@ -16,24 +16,36 @@ import { import getReport from '../../report/get-report' export async function parseJestJunit(files: FileContent[], options: ParseOptions): Promise { - const junit = (await parseStringPromise(files[0].content, { - attrValueProcessors: [parseAttribute] - })) as JunitReport - const testsuites = junit.testsuites - const success = !(testsuites.$?.failures > 0 || testsuites.$?.errors > 0) + const junit: JunitReport[] = [] + const testRuns: TestRunResult[] = [] + + for (const file of files) { + const ju = await getJunitReport(file.content) + const tr = getTestRunResult(file.path, ju) + junit.push(ju) + testRuns.push(tr) + } + + const success = testRuns.every(tr => tr.result === 'success') const icon = success ? Icon.success : Icon.fail return { success, output: { title: `${options.name.trim()} ${icon}`, - summary: getSummary(junit), + summary: getReport(testRuns), annotations: options.annotations ? getAnnotations(junit, options.workDir, options.trackedFiles) : undefined } } } -function getSummary(junit: JunitReport): string { +async function getJunitReport(content: string): Promise { + return (await parseStringPromise(content, { + attrValueProcessors: [parseAttribute] + })) as JunitReport +} + +function getTestRunResult(path: string, junit: JunitReport): TestRunResult { const suites = junit.testsuites.testsuite.map(ts => { const name = ts.$.name.trim() const time = ts.$.time * 1000 @@ -42,8 +54,7 @@ function getSummary(junit: JunitReport): string { }) const time = junit.testsuites.$.time * 1000 - const tr = new TestRunResult(suites, time) - return getReport(tr) + return new TestRunResult(path, suites, time) } function getGroups(suite: TestSuite): TestGroupResult[] { @@ -74,26 +85,28 @@ function getTestCaseResult(test: TestCase): TestExecutionResult { return 'success' } -function getAnnotations(junit: JunitReport, workDir: string, trackedFiles: string[]): Annotation[] { +function getAnnotations(junitReports: JunitReport[], workDir: string, trackedFiles: string[]): Annotation[] { const annotations: Annotation[] = [] - for (const suite of junit.testsuites.testsuite) { - for (const tc of suite.testcase) { - if (!tc.failure) { - continue - } - for (const ex of tc.failure) { - const src = exceptionThrowSource(ex, workDir, trackedFiles) - if (src === null) { + for (const junit of junitReports) { + for (const suite of junit.testsuites.testsuite) { + for (const tc of suite.testcase) { + if (!tc.failure) { continue } - annotations.push({ - annotation_level: 'failure', - start_line: src.line, - end_line: src.line, - path: src.file, - message: fixEol(ex), - title: `[${suite.$.name}] ${tc.$.name.trim()}` - }) + for (const ex of tc.failure) { + const src = exceptionThrowSource(ex, workDir, trackedFiles) + if (src === null) { + continue + } + annotations.push({ + annotation_level: 'failure', + start_line: src.line, + end_line: src.line, + path: src.file, + message: fixEol(ex), + title: `[${suite.$.name}] ${tc.$.name.trim()}` + }) + } } } } diff --git a/src/report/get-report.ts b/src/report/get-report.ts index e80f506..cb2a3ee 100644 --- a/src/report/get-report.ts +++ b/src/report/get-report.ts @@ -2,9 +2,21 @@ import {TestExecutionResult, TestRunResult, TestSuiteResult} from './test-result import {Align, Icon, link, table} from '../utils/markdown-utils' import {slug} from '../utils/slugger' -export default function getReport(tr: TestRunResult): string { +export default function getReport(results: TestRunResult[]): string { + const runsSummary = results.map(getRunSummary).join('\n\n') + const suites = results + .flatMap(tr => tr.suites) + .map((ts, i) => getSuiteSummary(ts, i)) + .join('\n') + + const suitesSection = `# Test Suites\n\n${suites}` + return [runsSummary, suitesSection].join('\n\n') +} + +function getRunSummary(tr: TestRunResult): string { const time = `${(tr.time / 1000).toFixed(3)}s` - const headingLine = `**${tr.tests}** tests were completed in **${time}** with **${tr.passed}** passed, **${tr.skipped}** skipped and **${tr.failed}** failed.` + const headingLine1 = `### ${tr.path}` + const headingLine2 = `**${tr.tests}** tests were completed in **${time}** with **${tr.passed}** passed, **${tr.skipped}** skipped and **${tr.failed}** failed.` const suitesSummary = tr.suites.map((s, i) => { const icon = getResultIcon(s.result) @@ -12,19 +24,16 @@ export default function getReport(tr: TestRunResult): string { const tsName = s.name const tsAddr = makeSuiteSlug(i, tsName).link const tsNameLink = link(tsName, tsAddr) - return [icon, tsNameLink, s.tests, tsTime, s.passed, s.failed, s.skipped] + return [icon, tsNameLink, s.tests, tsTime, s.passed, s.skipped, s.failed] }) const summary = table( - ['Result', 'Suite', 'Tests', 'Time', `Passed ${Icon.success}`, `Failed ${Icon.fail}`, `Skipped ${Icon.skip}`], + ['Result', 'Suite', 'Tests', 'Time', `Passed ${Icon.success}`, `Skipped ${Icon.skip}`, `Failed ${Icon.fail}`], [Align.Center, Align.Left, Align.Right, Align.Right, Align.Right, Align.Right, Align.Right], ...suitesSummary ) - const suites = tr.suites.map((ts, i) => getSuiteSummary(ts, i)).join('\n') - const suitesSection = `# Test Suites\n\n${suites}` - - return `${headingLine}\n${summary}\n${suitesSection}` + return [headingLine1, headingLine2, summary].join('\n\n') } function getSuiteSummary(ts: TestSuiteResult, index: number): string { diff --git a/src/report/test-results.ts b/src/report/test-results.ts index ad72894..630f41a 100644 --- a/src/report/test-results.ts +++ b/src/report/test-results.ts @@ -1,5 +1,5 @@ export class TestRunResult { - constructor(readonly suites: TestSuiteResult[], private totalTime?: number) {} + constructor(readonly path: string, readonly suites: TestSuiteResult[], private totalTime?: number) {} get tests(): number { return this.suites.reduce((sum, g) => sum + g.tests, 0)