fix: unescape html characters (#37)

test-results-reporter · Nov 11, 2023 · a44248f · a44248f
1 parent e3c18be
commit a44248f
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 19 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
   "dependencies": {
     "fast-xml-parser": "^4.3.2",
     "globrex": "^0.1.2",
+    "html-escaper": "^3.0.3",
     "totalist": "^3.0.0"
   },
   "devDependencies": {

diff --git a/src/models/TestCase.d.ts b/src/models/TestCase.d.ts
@@ -13,7 +13,10 @@ declare class TestCase {
   stack_trace: string;
   steps: TestStep[];
   meta_data: Map<string,string>;
+
+  setFailure: SetFailureFunction
 }
+export type SetFailureFunction = (value: string) => string;
 
 declare namespace TestCase { }
 

diff --git a/src/models/TestCase.js b/src/models/TestCase.js
@@ -1,3 +1,5 @@
+const { unescape } = require('html-escaper');
+
 class TestCase {
 
     constructor() {
@@ -15,6 +17,10 @@ class TestCase {
       this.steps = [];
       this.meta_data = new Map();
     }
+
+    setFailure(value) {
+      this.failure = value ? unescape(value) : value;
+    }
 
   }
 

diff --git a/src/parsers/cucumber.js b/src/parsers/cucumber.js
@@ -1,6 +1,3 @@
-/*
-*  Parser for both Mocha Json report and Mochawesome json
-*/
 const { resolveFilePath } = require('../helpers/helper');
 
 const TestResult = require('../models/TestResult');
@@ -28,7 +25,7 @@ function getTestCase(rawCase) {
   }
   if (rawCase.state && rawCase.state === "failed") {
     test_case.status = 'FAIL';
-    test_case.failure = rawCase.errorStack;
+    test_case.setFailure(rawCase.errorStack);
   }
   else {
     test_case.status = 'PASS';

diff --git a/src/parsers/junit.js b/src/parsers/junit.js
@@ -19,7 +19,7 @@ function getTestCase(rawCase, suiteProperties) {
   }
   if (rawCase.failure && rawCase.failure.length > 0) {
     test_case.status = 'FAIL';
-    test_case.failure = rawCase.failure[0]["@_message"];
+    test_case.setFailure(rawCase.failure[0]["@_message"]);
   } else {
     test_case.status = 'PASS';
   }

diff --git a/src/parsers/mocha.js b/src/parsers/mocha.js
@@ -32,7 +32,7 @@ function getTestCase(rawCase) {
   }
   else if (rawCase.state && rawCase.state === "failed") {
     test_case.status = 'FAIL';
-    test_case.failure = rawCase.err["message"];
+    test_case.setFailure(rawCase.err["message"]);
   }
   else {
     test_case.status = 'PASS';

diff --git a/src/parsers/testng.js b/src/parsers/testng.js
@@ -45,7 +45,7 @@ function getTestCase(rawCase, testCaseToGroupMap) {
     })
   }
   if (rawCase.exception) {
-    test_case.failure = rawCase.exception[0].message;
+    test_case.setFailure(rawCase.exception[0].message);
   }
   if (rawCase['@_retried'] === true) {
     test_case.status = 'RETRY';

diff --git a/src/parsers/xunit.js b/src/parsers/xunit.js
@@ -14,7 +14,7 @@ function getTestCase(rawCase) {
   }
   else if (rawCase.failure && rawCase.failure.length > 0) {
     test_case.status = 'FAIL';
-    test_case.failure = rawCase.failure[0]["message"];
+    test_case.setFailure(rawCase.failure[0]["message"]);
   }   
   else {
     test_case.status = 'PASS';

diff --git a/tests/data/testng/single-suite-multiple-tests.xml b/tests/data/testng/single-suite-multiple-tests.xml
@@ -131,7 +131,7 @@
 					</params>
 					<exception class="org.openqa.selenium.TimeoutException">
 						<message>
-							<![CDATA[Expected condition failed: : 95ddbda01ea4b3dbcb049e681a6...}]]>
+							<![CDATA[Expected condition failed: : &lt;95ddbda01ea4b3dbcb049e681a6&gt;]]>
 						</message>
 						<full-stacktrace>
 							<![CDATA[org.openqa.seleniumn(RemoteTestNGStarter.java:109)]]>

diff --git a/tests/parser.testng.spec.js b/tests/parser.testng.spec.js
@@ -175,7 +175,7 @@ describe('Parser - TestNG', () => {
               "skipped": 0,
               "duration": 57111,
               "status": "FAIL",
-              "failure": "Expected condition failed: : 95ddbda01ea4b3dbcb049e681a6...}",
+              "failure": "Expected condition failed: : <95ddbda01ea4b3dbcb049e681a6>",
               "stack_trace": "",
               "meta_data": new Map(),
               "steps": []
@@ -788,7 +788,7 @@ describe('Parser - TestNG', () => {
               "skipped": 0,
               "duration": 57111,
               "status": "FAIL",
-              "failure": "Expected condition failed: : 95ddbda01ea4b3dbcb049e681a6...}",
+              "failure": "Expected condition failed: : <95ddbda01ea4b3dbcb049e681a6>",
               "stack_trace": "",
               "meta_data": new Map(),
               "steps": []