PR Checklist

• Addresses an existing open issue: fixes 🚀 Feature: allow using test file's relative path in xunit reporter output #5289
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR adds a new reporter option showRelativePaths. If this option is set the selected reporter will show relative paths to test files instead of absolute paths (which is the default behavior).

The paths are shown relative to the directory where mocha command is executed from.

For example, if this option is passed to the json reporter (using config file or CLI mocha --reporter=json --reporter-option showRelativePaths=true), the output should be similar to:

{
  "stats": {
    "suites": 1,
    "duration": 2
  },
  "tests": [
    {
      ...// other test properties
      "file": "test/dummy-test.spec.js",
    }
  ],
  "pending": [],
  "failures": [],
  "passes": [
    {
      ...// other test properties
      "file": "test/dummy-test.spec.js",
    }
  ]
}

In contrast, the output without showRelativePaths option set looks like this:

{
  "stats": {
    "suites": 1,
    "duration": 2
  },
  "tests": [
    {
       ...// other test properties
      "file": "/home/dinika/code/personal/mocha-examples/packages/relative-file-path/test/dummy-test.spec.js",
    }
  ],
  "pending": [],
  "failures": [],
  "passes": [
    {
      ... // other test properties
      "file": "/home/dinika/code/personal/mocha-examples/packages/relative-file-path/test/dummy-test.spec.js",
    }
  ]
}

Design

There were a number of different places where the computation for relative path could be done. In the end, I chose the strategy that:

• Only affects mocha reporters, not the rest of the library (for this reason I didn't want to change the value of file property of the Test object or add another property like relativeFile on the Test object)
• Allows any reporter (even custom ones) to show relative paths - For this reason I've added the logic in the Base reporter.

I've updated the code for xunit, json, and json-stream reporters (i.e. reporters that show test paths) to handle this option, however I've only added the tests for xunit. Please lemme know if more tests should be added or a different strategy is better suited for this feature.

Based on the discussions in this thread the logic of computing relative paths is moved to lib/reporters/xunit.js file since only the xunit reporter is going to support the showRelativePaths option for now.

How have I tested this PR

In addition to testing with the integration tests, I also used the mocha-examples repo to add a new package and try different reporters.