Feature Request: Support for Additional Coverage Report Formats

[grasmarcussanti129]

Feature Request: Support for Additional Coverage Report Formats

I love the functionality of the apex-code-coverage-transformer, and I appreciate how it transforms Salesforce Apex code coverage reports into formats compatible with various tools.

Problem

Currently, the plugin only supports the JSON coverage format from the Salesforce CLI. However, many organizations use other CI/CD tools and might benefit from additional coverage report formats.

Suggested Formats

Here are a few coverage formats that could be valuable to implement:

1. Cobertura - Widely used and supported by many tools.
2. LCOV - Popular format for generating HTML reports and integrating with many CI systems.
3. Codecov - Direct integration with Codecov for coverage reports.

By adding support for these formats, users who rely on different CI/CD solutions can leverage the capabilities of apex-code-coverage-transformer more effectively.

Additional Notes

Please let me know if there are specific formats that the community feels would be the most beneficial so we can prioritize their implementation! Thank you for your ongoing work on this project!

[mcarvin8]

Hi @grasmarcussanti129! Thanks for raising this issue. Sorry for getting back a few months late. I haven't had the time for open-source in a bit.

In regards to this issue, I guess I wanted to confirm the exact ask here. Are you asking for me to support more "input" formats from the Salesforce CLI to convert?

The goal of this plugin is to take 1 input format supported by both Salesforce CLI deploy and test commands (since coverage report formats vary between both commands - plus the "json" format follow different structures in both deploy and test commands) and then output multiple formats. You called out Cobertura and LCOV which are already supported "output" formats by my plugin.

I would assume other CI/CD solutions that make Salesforce calls can set the coverage format to Salesforce's "json" coverage format as it's available in both commands but correct me if I'm wrong.

I'm a little hesitant to support transforming more than 1 input format from the CLI since the deploy and test commands have different code bases so that adds to the complexity of transformation here.

Let me know what you're looking for here.

[mcarvin8]

Following up on this too, "Codecov" should accept at least jacoco and cobertura reports out-of-the-box. Both of these formats are already valid "output" formats supported by this plugin.

So if you're using "Codecov" to track code coverage, you should be able to use either output format via my plugin.

Workflow steps:

1. Run Salesforce CLI deploy or test command with coverage formatter flag set to "json"
2. Run this plugin's command afterwards (or automatically after sf cli commands using the hook file) to transform json into cobertura or jacoco format or both
3. Import coberutra/jacoco report into Codecov

[mcarvin8]

Any updates here @grasmarcussanti129 ?

[mcarvin8]

Closing for now , but feel free to re-open if needed.

Goal of this plugin is to transform 1 input format available in both CLI commands (json) into multiple output formats like the ones you've suggested above.

The latest version of this plugin:

1 input (json) ---> 10 valid output formats