Normalize file paths during XML generation (#23)

* Normalize file paths during XML generation
testspace-com · Jul 15, 2024 · d735239 · d735239
1 parent 010b961
commit d735239
Show file tree

Hide file tree

Showing 15 changed files with 62 additions and 55 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cypress-xml-reporter",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A JUnit XML reporter for Cypress that includes screenshots, videos, and logs.",
   "main": "src/reporter.js",
   "scripts": {

diff --git a/src/reporter.js b/src/reporter.js
@@ -127,7 +127,7 @@ function createTestRecord(test, specRelativePath) {
         let imageBasename = testFullName.replaceAll(UNSAFE_REGEX, '').substring(0, 242)+' (failed).png';
         let imageFile = path.join(config.screenshotsFolder, specRelativePath, imageBasename);
         if (fs.existsSync(imageFile)) {
-          record['system-out'] = '[[ATTACHMENT|'+imageFile+']]';
+          record['system-out'] = '[[ATTACHMENT|'+normalizePath(imageFile)+']]';
         }
       }
       break;
@@ -139,6 +139,13 @@ function createTestRecord(test, specRelativePath) {
   return record;
 }
 
+function normalizePath(pathString) {
+  if (path.sep !== '/') {
+    return pathString.replaceAll(path.sep, '/');
+  }
+  return pathString;
+}
+
 function CypressXML(runner, options) {
   Mocha.reporters.Base.call(this, runner, options);
 
@@ -227,7 +234,7 @@ function CypressXML(runner, options) {
         errors: 0,
         time: (Date.now() - s.suite.timestamp) / 1000,
         timestamp: new Date(s.suite.timestamp).toUTCString(),
-        file: s.suite.file
+        file: normalizePath(s.suite.file)
       }
       var testCases = [];
       s.tests.forEach( function(t){
@@ -243,7 +250,7 @@ function CypressXML(runner, options) {
       })
       var logContent = '';
       if (config.logsFolder) {
-        let relative = suiteStats.file.replace(config.logSpecRoot,'');
+        let relative = s.suite.file.replace(config.logSpecRoot,'');
         relative = relative.substring(0, relative.lastIndexOf('.')) + config.logFileExt;
         let logFile = path.join(config.logsFolder, relative);
         if (fs.existsSync(logFile)) {
@@ -253,7 +260,7 @@ function CypressXML(runner, options) {
       }
       if (suiteStats.failures > 0) {
         let videoFile = path.join(config.videosFolder, specRelativePath)+'.mp4';
-        logContent += '[[ATTACHMENT|' + videoFile +']]';
+        logContent += '[[ATTACHMENT|' + normalizePath(videoFile) +']]';
       }
       var suiteRecord = { $: suiteStats, testcase: testCases, 'system-out': logContent };
       testSuites.push(suiteRecord);

diff --git a/tests/test.desc-desc.js b/tests/test.desc-desc.js
@@ -40,7 +40,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -51,11 +51,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -73,7 +73,7 @@ describe(testName, () => {
       });
       it('"case3" Failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile1+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile1.replaceAll(path.sep, '/')+']]');
       })
     });
   });
@@ -85,11 +85,11 @@ describe(testName, () => {
       expect(suites[2].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[2].$.file).to.equal(testFile);
+      expect(suites[2].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[2]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -107,7 +107,7 @@ describe(testName, () => {
       });
       it('"case3" Failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile2+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile2.replaceAll(path.sep, '/')+']]');
       })
     });
   });

diff --git a/tests/test.desc-fixture-hook-failure.js b/tests/test.desc-fixture-hook-failure.js
@@ -54,7 +54,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
 });
diff --git a/tests/test.desc-nest-desc.js b/tests/test.desc-nest-desc.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -66,11 +66,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('6');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -97,7 +97,7 @@ describe(testName, () => {
       });
       it('"NEST -- case3" Failure', () => {
         var systemout = testcases[5]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile.replaceAll(path.sep, '/')+']]');
       })
     });
   });

diff --git a/tests/test.desc-nest-nest-desc.js b/tests/test.desc-nest-nest-desc.js
@@ -57,7 +57,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -68,11 +68,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('9');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -90,7 +90,7 @@ describe(testName, () => {
       });
       it('"case3" Failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile1+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile1.replaceAll(path.sep, '/')+']]');
       });
       it('"NEST1 -- case1" name', () => {
         expect(testcases[3].$.name).to.equal('NEST1 -- case1');
@@ -103,7 +103,7 @@ describe(testName, () => {
       });
       it('"NEST1 -- case3" Failure', () => {
         var systemout = testcases[5]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile2+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile2.replaceAll(path.sep, '/')+']]');
       });
       it('"NEST1 -- NEST2 -- case1" name', () => {
         expect(testcases[6].$.name).to.equal('NEST1 -- NEST2 -- case1');
@@ -116,7 +116,7 @@ describe(testName, () => {
       });
       it('"NEST1 -- NEST2 -- case3" Failure', () => {
         var systemout = testcases[8]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile3+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile3.replaceAll(path.sep, '/')+']]');
       });
 
     });

diff --git a/tests/test.desc-nofailures.js b/tests/test.desc-nofailures.js
@@ -53,7 +53,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -64,7 +64,7 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];

diff --git a/tests/test.desc-nofailures.log.js b/tests/test.desc-nofailures.log.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -66,7 +66,7 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];

diff --git a/tests/test.desc-pending.js b/tests/test.desc-pending.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -72,11 +72,11 @@ describe(testName, () => {
       expect(suites[1].$.skipped).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;

diff --git a/tests/test.desc-testname-chars.js b/tests/test.desc-testname-chars.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('"TEST SUITE" with Quotes and Slash', () => {
@@ -66,11 +66,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -88,7 +88,7 @@ describe(testName, () => {
       });
       it('"case3" name with quotes and slash with failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile.replaceAll(path.sep, '/')+']]');
       })
     });
   });

diff --git a/tests/test.desc.js b/tests/test.desc.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -66,11 +66,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -88,7 +88,7 @@ describe(testName, () => {
       });
       it('"case3" Failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile.replaceAll(path.sep, '/')+']]');
       })
     });
   });

diff --git a/tests/test.desc.log.js b/tests/test.desc.log.js
@@ -19,7 +19,7 @@ const screenshotFile = path.join('cypress', 'screenshots', testDataName, 'TEST1
 
 // Remove "spaces" and "newlines" variants
 const logContent = ":TEST1->case1TEST1->case2TEST1->case3cy:command(X):assertexpected**1**toequal**2**Actual:1Expected:2";
-const systemOut = testFile+logContent+"[[ATTACHMENT|"+videoFile+"]]";
+const systemOut = testFile+logContent+"[[ATTACHMENT|"+videoFile.replaceAll(path.sep, '/')+"]]";
 
 /**
  * Globals
@@ -59,7 +59,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -70,7 +70,7 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
@@ -99,7 +99,7 @@ describe(testName, () => {
       });
       it('"case3" Failure System-out', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile.replaceAll(path.sep, '/')+']]');
       });
     });
   });

diff --git a/tests/test.folder-desc.js b/tests/test.folder-desc.js
@@ -55,7 +55,7 @@ describe(testName, () => {
       expect(suites[0].$.tests).to.equal('0');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
   });
   describe('TEST1', () => {
@@ -66,11 +66,11 @@ describe(testName, () => {
       expect(suites[1].$.tests).to.equal('3');
     });
     it('File Name', () => {
-      expect(suites[1].$.file).to.equal(testFile);
+      expect(suites[1].$.file).to.equal(testFile.replaceAll(path.sep, '/'));
     });
     it('System-out', () => {
       var systemout = suites[1]['system-out'][0];
-      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile+']]');
+      expect(systemout).to.equal('[[ATTACHMENT|'+videoFile.replaceAll(path.sep, '/')+']]');
     });
     describe('Testcases', ()=> {
       var testcases;
@@ -88,7 +88,7 @@ describe(testName, () => {
       });
       it('"case3" Failure', () => {
         var systemout = testcases[2]['system-out'][0];
-        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile+']]');
+        expect(systemout).to.equal('[[ATTACHMENT|'+screenshotFile.replaceAll(path.sep, '/')+']]');
       })
     });
   });