Add file path to json output

cconstable commented 4 years ago

What

Adds the file path when generating json reports (via --json_report).

Old output

"files": [
  { 
    "name": "MyFile.swift",
    "coverage": 0,
    ...

New output

"files": [
  { 
    "name": "MyFile.swift",
    "path":"/Users/me/project/MyFile.swift",
    "coverage": 0,
    ...

Why

To assist automated tooling, it's helpful to know the path of the files. In larger projects, it's not uncommon to have duplicate file names across targets. Reconciling the coverage name with the actual file requires either a) parsing the Xcode coverage reports ourselves or b) keeping track of the corresponding target and parsing Xcode project files. Both options seem pretty unfortunate.

Open questions

Should this be gated behind a flag?
- Opinion: Adding this field will increase the size of the generated json reports but I don't think the amount will be significant (esp after compression). Since this is an additive change, it is unlikely to break existing tooling.
Should this be added to any other reports?
- Opinion: I'm assuming HTML reports are used mostly for humans and JSON reports are used mostly for tooling. If nobody is asking for it I don't see a reason to add it to the HTML reports.

cconstable commented 4 years ago

Hey @joshdholtz, hope you are staying safe! Do you have any thoughts on this? If you feel additional changes are needed I would be happy to make them.

joshdholtz commented 4 years ago

@cconstable Ah, sorry I missed this! I appreciate the ping 😊 This looks good! I'll merge and get a new version out 💪

joshdholtz commented 4 years ago

@cconstable 1.7.4 is release!

fastlane-community / xcov