feat: enable reporters to show relative paths of tests (#5292)

* DRAFT // Get test file path relative to config

Signed-off-by: Dinika Saxena <dinika@greyllama.cc>

* Use cwd for finding relative path of test fil

* Use relative path options in json and json-stream reporters

* Add integration test for relative paths in xunit reporter

Signed-off-by: Dinika Saxena <dinika@greyllama.cc>

* Make test more complete by checking for non existence

* Keep showing absolute paths in json reporters

* Add doc for showRelativePath xunit reporter option

Signed-off-by: Dinika Saxena <dinika@greyllama.cc>

* Move relative path calculation to the only reporter (xunit) that needs it

* Fix typo in xunit doc for showRelativePaths option

Signed-off-by: Dinika Saxena <dinika@greyllama.cc>

* Clarify why testing for absence of relative paths need quotes

* Copied new docs .md contents to docs-next .mdx

---------

Signed-off-by: Dinika Saxena <dinika@greyllama.cc>
Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

Author: Dinika

docs-next/src/content/docs/reporters/xunit.mdx

@@ -12,3 +12,6 @@ By default, it will output to the console.
 To write directly to a file, use `--reporter-option output=filename.xml`.
 
 To specify custom report title, use `--reporter-option suiteName="Custom name"`.
+
+The reporter shows absolute file paths by default.
+To show relative paths instead, use `--reporter-option showRelativePaths`.

docs/index.md

@@ -2075,6 +2075,8 @@ By default, it will output to the console. To write directly to a file, use `--r
 
 To specify custom report title, use `--reporter-option suiteName="Custom name"`.
 
+The reporter shows absolute file paths by default. To show relative paths instead, use `--reporter-option showRelativePaths`.
+
 ### Third-Party Reporters
 
 Mocha allows you to define custom reporters. For more information see the [wiki][mocha-wiki-more-reporters].

lib/reporters/xunit.js

@@ -104,7 +104,7 @@ function XUnit(runner, options) {
     );
 
     tests.forEach(function (t) {
-      self.test(t);
+      self.test(t, options);
     });
 
     self.write('</testsuite>');
@@ -152,13 +152,13 @@ XUnit.prototype.write = function (line) {
  *
  * @param {Test} test
  */
-XUnit.prototype.test = function (test) {
+XUnit.prototype.test = function (test, options) {
   Base.useColors = false;
 
   var attrs = {
     classname: test.parent.fullTitle(),
     name: test.title,
-    file: test.file,
+    file: testFilePath(test.file, options),
     time: test.duration / 1000 || 0
   };
 
@@ -215,4 +215,12 @@ function tag(name, attrs, close, content) {
   return tag;
 }
 
+function testFilePath(filepath, options) {
+  if (options && options.reporterOptions && options.reporterOptions.showRelativePaths) {
+    return path.relative(process.cwd(), filepath);
+  }
+
+  return filepath;
+}
+
 XUnit.description = 'XUnit-compatible XML output';

test/reporters/xunit.spec.js

@@ -592,4 +592,69 @@ describe('XUnit reporter', function () {
       expect(lines[0], 'to contain', defaultSuiteName);
     });
   });
+
+  describe('showRelativePaths reporter option', function () {
+    const projectPath = path.join('home', 'username', 'demo-project');
+    const relativeTestPath = path.join('tests', 'demo-test.spec.js');
+    const absoluteTestPath = path.join(projectPath, relativeTestPath);
+
+    var expectedWrite = '';
+    const fakeThis = {
+      write: function (str) {
+        expectedWrite = expectedWrite + str;
+      }
+    };
+
+    const failingTest = {
+      state: STATE_FAILED,
+      title: expectedTitle,
+      file: absoluteTestPath,
+      parent: {
+        fullTitle: function () {
+          return expectedClassName;
+        }
+      },
+      duration: 1000,
+      err: {
+        actual: 'foo',
+        expected: 'bar',
+        message: expectedMessage,
+        stack: expectedStack
+      }
+    };
+
+    beforeEach(function () {
+      sinon.stub(process, 'cwd').returns(projectPath);
+    });
+
+    afterEach(function () {
+      sinon.restore();
+      expectedWrite = '';
+    });
+
+    it('shows relative paths for tests if showRelativePaths reporter option is set', function () {
+      const options = {
+        reporterOptions: {
+          showRelativePaths: true
+        }
+      };
+      const xunit = new XUnit(runner, options);
+
+      xunit.test.call(fakeThis, failingTest, options);
+
+      expect(expectedWrite, 'not to contain', absoluteTestPath);
+      expect(expectedWrite, 'to contain', relativeTestPath);
+    });
+
+    it('shows absolute paths for tests by default', function () {
+      const options = {};
+      const xunit = new XUnit(runner);
+
+      xunit.test.call(fakeThis, failingTest, options);
+
+      expect(expectedWrite, 'to contain', absoluteTestPath);
+      // Double quote included to ensure printed paths don't start with relative path. Example printed line: <testcase classname="suite" name="test" file="some/tesfile.js" time="0"/>
+      expect(expectedWrite, 'not to contain', `"${relativeTestPath}`);
+    });
+  });
 });