Fix EOL issues - remove all \r from annotation message

dorny · Jan 14, 2021 · 760c090 · 760c090
1 parent 4197e7a
commit 760c090
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 13 deletions.
diff --git a/__tests__/__snapshots__/dotnet-trx.test.ts.snap b/__tests__/__snapshots__/dotnet-trx.test.ts.snap
@@ -23,9 +23,7 @@ Object {
       "annotation_level": "failure",
       "end_line": 27,
       "message": "Assert.Equal() Failure
-
 Expected: 3
-
 Actual:   2",
       "path": "DotnetTests.XUnitTests/CalculatorTests.cs",
       "start_line": 27,

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/parsers/dart-json/dart-json-parser.ts b/src/parsers/dart-json/dart-json-parser.ts
@@ -2,7 +2,7 @@ import {Annotation, ParseOptions, TestResult} from '../parser-types'
 
 import getReport from '../../report/get-report'
 import {normalizeFilePath} from '../../utils/file-utils'
-import {Icon} from '../../utils/markdown-utils'
+import {Icon, fixEol} from '../../utils/markdown-utils'
 
 import {
   ReportEvent,
@@ -176,7 +176,7 @@ function getAnnotation(
     start_line: src.line,
     end_line: src.line,
     path: src.file,
-    message: `${test.error?.error}\n\n${test.error?.stackTrace}`,
+    message: `${fixEol(test.error?.error)}\n\n${fixEol(test.error?.stackTrace)}`,
     title: `[${testSuite.suite.path}] ${test.testStart.test.name}`
   }
 }

diff --git a/src/parsers/dotnet-trx/dotnet-trx-parser.ts b/src/parsers/dotnet-trx/dotnet-trx-parser.ts
@@ -5,7 +5,7 @@ import {parseStringPromise} from 'xml2js'
 
 import {normalizeFilePath} from '../../utils/file-utils'
 import {parseAttribute} from '../../utils/xml-utils'
-import {Icon} from '../../utils/markdown-utils'
+import {Icon, fixEol} from '../../utils/markdown-utils'
 
 import {
   TestExecutionResult,
@@ -123,7 +123,7 @@ function getAnnotations(testClasses: TestClass[], workDir: string, trackedFiles:
           start_line: src.line,
           end_line: src.line,
           path: src.file,
-          message: t.error.Message[0],
+          message: fixEol(t.error.Message[0]),
           title: `[${tc.name}] ${t.name}`
         })
       }

diff --git a/src/parsers/jest-junit/jest-junit-parser.ts b/src/parsers/jest-junit/jest-junit-parser.ts
@@ -2,7 +2,7 @@ import {Annotation, ParseOptions, TestResult} from '../parser-types'
 import {parseStringPromise} from 'xml2js'
 
 import {JunitReport, TestCase, TestSuite} from './jest-junit-types'
-import {Icon} from '../../utils/markdown-utils'
+import {fixEol, Icon} from '../../utils/markdown-utils'
 import {normalizeFilePath} from '../../utils/file-utils'
 import {parseAttribute} from '../../utils/xml-utils'
 
@@ -91,7 +91,7 @@ function getAnnotations(junit: JunitReport, workDir: string, trackedFiles: strin
           start_line: src.line,
           end_line: src.line,
           path: src.file,
-          message: ex,
+          message: fixEol(ex),
           title: `[${suite.$.name}] ${tc.$.name.trim()}`
         })
       }

diff --git a/src/utils/markdown-utils.ts b/src/utils/markdown-utils.ts
@@ -30,3 +30,7 @@ export function table(headers: ToString[], align: ToString[], ...rows: ToString[
 export function tableEscape(content: ToString): string {
   return content.toString().replace('|', '\\|')
 }
+
+export function fixEol(text?: string): string {
+  return text?.replace(/\r/g, '') ?? ''
+}