Merge pull request #571 from Shamus03/feature/golang-json-parser

Add Golang test parser
dorny · May 17, 2025 · a8c55a3 · a8c55a3
2 parents d33ca72 + a0398fb
commit a8c55a3
Show file tree

Hide file tree

Showing 13 changed files with 613 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ This [Github Action](https://github.com/features/actions) displays test results
 - .NET / [dotnet test](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples) ( [xUnit](https://xunit.net/) / [NUnit](https://nunit.org/) / [MSTest](https://github.com/Microsoft/testfx-docs) )
 - Dart / [test](https://pub.dev/packages/test)
 - Flutter / [test](https://pub.dev/packages/test)
+- Go / [go test](https://pkg.go.dev/testing)
 - Java / [JUnit](https://junit.org/)
 - JavaScript / [JEST](https://jestjs.io/) / [Mocha](https://mochajs.org/)
 - Swift / xUnit
@@ -140,6 +141,7 @@ jobs:
     #   dotnet-nunit
     #   dotnet-trx
     #   flutter-json
+    #   golang-json
     #   java-junit
     #   jest-junit
     #   mocha-json
@@ -278,6 +280,13 @@ For more information see:
 
 </details>
 
+<details>
+  <summary>golang-json</summary>
+
+You must use the `-json` flag and output the results to a file (ex: `go test -json > testresults.json`)
+
+</details>
+
 <details>
   <summary>java-junit (Experimental)</summary>
 

diff --git a/__tests__/__outputs__/golang-json.md b/__tests__/__outputs__/golang-json.md
@@ -0,0 +1,38 @@
+![Tests failed](https://img.shields.io/badge/tests-5%20passed%2C%206%20failed%2C%201%20skipped-critical)
+|Report|Passed|Failed|Skipped|Time|
+|:---|---:|---:|---:|---:|
+|fixtures/golang-json.json|5 ✅|6 ❌|1 ⚪|6s|
+## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/golang-json.json</a>
+**12** tests were completed in **6s** with **5** passed, **6** failed and **1** skipped.
+|Test suite|Passed|Failed|Skipped|Time|
+|:---|---:|---:|---:|---:|
+|[_/home/james_t/git/test-reporter/reports/go](#user-content-r0s0)|5 ✅|6 ❌|1 ⚪|6s|
+### ❌ <a id="user-content-r0s0" href="#user-content-r0s0">_/home/james_t/git/test-reporter/reports/go</a>
+```
+✅ TestPassing
+❌ TestFailing
+	calculator_test.go:19: expected 1+1 = 3, got 2
+	
+❌ TestPanicInsideFunction
+	calculator_test.go:76: caught panic: runtime error: integer divide by zero
+	
+❌ TestPanicInsideTest
+	calculator_test.go:76: caught panic: bad stuff
+	
+⚪ TestSkipped
+	calculator_test.go:45: skipping test
+	
+❌ TestCases
+	
+TestCases
+  ✅ 1_+_2_=_3
+  ✅ 4_+_7_=_11
+  ❌ 2_+_3_=_4
+	calculator_test.go:67: expected 2 + 3 = 4, got 5
+	
+  ❌ 1_/_2_=_1
+	calculator_test.go:67: expected 1 / 2 = 1, got 0
+	
+  ✅ 9_/_3_=_3
+  ✅ 14_/_7_=_2
+```
diff --git a/__tests__/__snapshots__/golang-json.test.ts.snap b/__tests__/__snapshots__/golang-json.test.ts.snap
@@ -0,0 +1,131 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`golang-json tests report from ./reports/dotnet test results matches snapshot 1`] = `
+TestRunResult {
+  "path": "fixtures/golang-json.json",
+  "suites": [
+    TestSuiteResult {
+      "groups": [
+        TestGroupResult {
+          "name": null,
+          "tests": [
+            TestCaseResult {
+              "error": undefined,
+              "name": "TestPassing",
+              "result": "success",
+              "time": 60,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:19: expected 1+1 = 3, got 2
+",
+                "message": "calculator_test.go:19: expected 1+1 = 3, got 2
+",
+              },
+              "name": "TestFailing",
+              "result": "failed",
+              "time": 890,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:76: caught panic: runtime error: integer divide by zero
+",
+                "message": "calculator_test.go:76: caught panic: runtime error: integer divide by zero
+",
+              },
+              "name": "TestPanicInsideFunction",
+              "result": "failed",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:76: caught panic: bad stuff
+",
+                "message": "calculator_test.go:76: caught panic: bad stuff
+",
+              },
+              "name": "TestPanicInsideTest",
+              "result": "failed",
+              "time": 0,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:45: skipping test
+",
+                "message": "calculator_test.go:45: skipping test
+",
+              },
+              "name": "TestSkipped",
+              "result": "skipped",
+              "time": 940,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "",
+                "message": "",
+              },
+              "name": "TestCases",
+              "result": "failed",
+              "time": 2250,
+            },
+          ],
+        },
+        TestGroupResult {
+          "name": "TestCases",
+          "tests": [
+            TestCaseResult {
+              "error": undefined,
+              "name": "1_+_2_=_3",
+              "result": "success",
+              "time": 400,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "4_+_7_=_11",
+              "result": "success",
+              "time": 460,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:67: expected 2 + 3 = 4, got 5
+",
+                "message": "calculator_test.go:67: expected 2 + 3 = 4, got 5
+",
+              },
+              "name": "2_+_3_=_4",
+              "result": "failed",
+              "time": 90,
+            },
+            TestCaseResult {
+              "error": {
+                "details": "calculator_test.go:67: expected 1 / 2 = 1, got 0
+",
+                "message": "calculator_test.go:67: expected 1 / 2 = 1, got 0
+",
+              },
+              "name": "1_/_2_=_1",
+              "result": "failed",
+              "time": 920,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "9_/_3_=_3",
+              "result": "success",
+              "time": 340,
+            },
+            TestCaseResult {
+              "error": undefined,
+              "name": "14_/_7_=_2",
+              "result": "success",
+              "time": 40,
+            },
+          ],
+        },
+      ],
+      "name": "_/home/james_t/git/test-reporter/reports/go",
+      "totalTime": undefined,
+    },
+  ],
+  "totalTime": undefined,
+}
+`;
diff --git a/__tests__/fixtures/golang-json.json b/__tests__/fixtures/golang-json.json
@@ -0,0 +1,59 @@
+{"Time":"2025-04-22T08:59:55.364618802-05:00","Action":"start","Package":"_/home/james_t/git/test-reporter/reports/go"}
+{"Time":"2025-04-22T08:59:55.371779289-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPassing"}
+{"Time":"2025-04-22T08:59:55.371805677-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPassing","Output":"=== RUN   TestPassing\n"}
+{"Time":"2025-04-22T08:59:55.428201983-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPassing","Output":"    calculator_test.go:11: pass!\n"}
+{"Time":"2025-04-22T08:59:55.428265529-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPassing","Output":"--- PASS: TestPassing (0.06s)\n"}
+{"Time":"2025-04-22T08:59:55.428285649-05:00","Action":"pass","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPassing","Elapsed":0.06}
+{"Time":"2025-04-22T08:59:55.428299886-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestFailing"}
+{"Time":"2025-04-22T08:59:55.428309029-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestFailing","Output":"=== RUN   TestFailing\n"}
+{"Time":"2025-04-22T08:59:56.317425091-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestFailing","Output":"    calculator_test.go:19: expected 1+1 = 3, got 2\n"}
+{"Time":"2025-04-22T08:59:56.31748077-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestFailing","Output":"--- FAIL: TestFailing (0.89s)\n"}
+{"Time":"2025-04-22T08:59:56.317493452-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestFailing","Elapsed":0.89}
+{"Time":"2025-04-22T08:59:56.317506107-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideFunction"}
+{"Time":"2025-04-22T08:59:56.317514487-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideFunction","Output":"=== RUN   TestPanicInsideFunction\n"}
+{"Time":"2025-04-22T08:59:56.317530448-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideFunction","Output":"    calculator_test.go:76: caught panic: runtime error: integer divide by zero\n"}
+{"Time":"2025-04-22T08:59:56.317541866-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideFunction","Output":"--- FAIL: TestPanicInsideFunction (0.00s)\n"}
+{"Time":"2025-04-22T08:59:56.317552981-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideFunction","Elapsed":0}
+{"Time":"2025-04-22T08:59:56.317561057-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideTest"}
+{"Time":"2025-04-22T08:59:56.317568742-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideTest","Output":"=== RUN   TestPanicInsideTest\n"}
+{"Time":"2025-04-22T08:59:56.317584113-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideTest","Output":"    calculator_test.go:76: caught panic: bad stuff\n"}
+{"Time":"2025-04-22T08:59:56.317598524-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideTest","Output":"--- FAIL: TestPanicInsideTest (0.00s)\n"}
+{"Time":"2025-04-22T08:59:56.317608268-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestPanicInsideTest","Elapsed":0}
+{"Time":"2025-04-22T08:59:56.317615472-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestSkipped"}
+{"Time":"2025-04-22T08:59:56.317623959-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestSkipped","Output":"=== RUN   TestSkipped\n"}
+{"Time":"2025-04-22T08:59:57.256475698-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestSkipped","Output":"    calculator_test.go:45: skipping test\n"}
+{"Time":"2025-04-22T08:59:57.256536372-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestSkipped","Output":"--- SKIP: TestSkipped (0.94s)\n"}
+{"Time":"2025-04-22T08:59:57.256549142-05:00","Action":"skip","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestSkipped","Elapsed":0.94}
+{"Time":"2025-04-22T08:59:57.256562053-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases"}
+{"Time":"2025-04-22T08:59:57.256569388-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases","Output":"=== RUN   TestCases\n"}
+{"Time":"2025-04-22T08:59:57.256580104-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_+_2_=_3"}
+{"Time":"2025-04-22T08:59:57.256587408-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_+_2_=_3","Output":"=== RUN   TestCases/1_+_2_=_3\n"}
+{"Time":"2025-04-22T08:59:57.653005399-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/4_+_7_=_11"}
+{"Time":"2025-04-22T08:59:57.653036336-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/4_+_7_=_11","Output":"=== RUN   TestCases/4_+_7_=_11\n"}
+{"Time":"2025-04-22T08:59:58.112825221-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/2_+_3_=_4"}
+{"Time":"2025-04-22T08:59:58.112858016-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/2_+_3_=_4","Output":"=== RUN   TestCases/2_+_3_=_4\n"}
+{"Time":"2025-04-22T08:59:58.201204209-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/2_+_3_=_4","Output":"    calculator_test.go:67: expected 2 + 3 = 4, got 5\n"}
+{"Time":"2025-04-22T08:59:58.201245827-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_/_2_=_1"}
+{"Time":"2025-04-22T08:59:58.201255566-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_/_2_=_1","Output":"=== RUN   TestCases/1_/_2_=_1\n"}
+{"Time":"2025-04-22T08:59:59.119852965-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_/_2_=_1","Output":"    calculator_test.go:67: expected 1 / 2 = 1, got 0\n"}
+{"Time":"2025-04-22T08:59:59.119877603-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/9_/_3_=_3"}
+{"Time":"2025-04-22T08:59:59.119879955-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/9_/_3_=_3","Output":"=== RUN   TestCases/9_/_3_=_3\n"}
+{"Time":"2025-04-22T08:59:59.460576385-05:00","Action":"run","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/14_/_7_=_2"}
+{"Time":"2025-04-22T08:59:59.460607599-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/14_/_7_=_2","Output":"=== RUN   TestCases/14_/_7_=_2\n"}
+{"Time":"2025-04-22T08:59:59.504952672-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases","Output":"--- FAIL: TestCases (2.25s)\n"}
+{"Time":"2025-04-22T08:59:59.504995938-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_+_2_=_3","Output":"    --- PASS: TestCases/1_+_2_=_3 (0.40s)\n"}
+{"Time":"2025-04-22T08:59:59.505006062-05:00","Action":"pass","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_+_2_=_3","Elapsed":0.4}
+{"Time":"2025-04-22T08:59:59.505017551-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/4_+_7_=_11","Output":"    --- PASS: TestCases/4_+_7_=_11 (0.46s)\n"}
+{"Time":"2025-04-22T08:59:59.505026099-05:00","Action":"pass","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/4_+_7_=_11","Elapsed":0.46}
+{"Time":"2025-04-22T08:59:59.505033963-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/2_+_3_=_4","Output":"    --- FAIL: TestCases/2_+_3_=_4 (0.09s)\n"}
+{"Time":"2025-04-22T08:59:59.505042238-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/2_+_3_=_4","Elapsed":0.09}
+{"Time":"2025-04-22T08:59:59.505050917-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_/_2_=_1","Output":"    --- FAIL: TestCases/1_/_2_=_1 (0.92s)\n"}
+{"Time":"2025-04-22T08:59:59.505059901-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/1_/_2_=_1","Elapsed":0.92}
+{"Time":"2025-04-22T08:59:59.505068125-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/9_/_3_=_3","Output":"    --- PASS: TestCases/9_/_3_=_3 (0.34s)\n"}
+{"Time":"2025-04-22T08:59:59.505076976-05:00","Action":"pass","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/9_/_3_=_3","Elapsed":0.34}
+{"Time":"2025-04-22T08:59:59.5050845-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/14_/_7_=_2","Output":"    --- PASS: TestCases/14_/_7_=_2 (0.04s)\n"}
+{"Time":"2025-04-22T08:59:59.505091554-05:00","Action":"pass","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases/14_/_7_=_2","Elapsed":0.04}
+{"Time":"2025-04-22T08:59:59.505098998-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Test":"TestCases","Elapsed":2.25}
+{"Time":"2025-04-22T08:59:59.505107502-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Output":"FAIL\n"}
+{"Time":"2025-04-22T08:59:59.505552861-05:00","Action":"output","Package":"_/home/james_t/git/test-reporter/reports/go","Output":"FAIL\t_/home/james_t/git/test-reporter/reports/go\t4.141s\n"}
+{"Time":"2025-04-22T08:59:59.505584529-05:00","Action":"fail","Package":"_/home/james_t/git/test-reporter/reports/go","Elapsed":4.141}
diff --git a/__tests__/golang-json.test.ts b/__tests__/golang-json.test.ts
@@ -0,0 +1,29 @@
+import * as fs from 'fs'
+import * as path from 'path'
+
+import {GolangJsonParser} from '../src/parsers/golang-json/golang-json-parser'
+import {ParseOptions} from '../src/test-parser'
+import {getReport} from '../src/report/get-report'
+import {normalizeFilePath} from '../src/utils/path-utils'
+
+describe('golang-json tests', () => {
+  it('report from ./reports/dotnet test results matches snapshot', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'golang-json.json')
+    const outputPath = path.join(__dirname, '__outputs__', 'golang-json.md')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: ['calculator.go', 'calculator_test.go']
+    }
+
+    const parser = new GolangJsonParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    expect(result).toMatchSnapshot()
+
+    const report = getReport([result])
+    fs.mkdirSync(path.dirname(outputPath), {recursive: true})
+    fs.writeFileSync(outputPath, report)
+  })
+})