apex-code-coverage-visualizer

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #golang #android #machine-learning #docker #cli #kubernetes #security #ios #openai #open-source

apex-code-coverage-visualizer

(★ 8)

Salesforce Apex Test Coverage Visualizer

apex-code-coverage-visualizer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Salesforce APEX Code Coverage Visualizer for Visual Studio Code

## Introduction

This extension shows a summary of the code coverage for all APEX classes in the current project. The extension relies on the official [Salesforce Extensions](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) test runner which creates the necessary files used to show the code coverage.

![Apex Code Coverage](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/code-coverage.gif)

It works with both Dark and Light themes

![Apex Code Coverage](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/code-coverage-dark.gif)

## Documentation

Make sure you have configured the preferences on the Salesforce extension to retrieve code coverage on test execution. To do this, go to Visual Studio Code menu *File->Preferences->Settings* and enter "coverage" in the search box, and then from the search results enable the **Retrieve-test-code-coverage** setting:

![Test Settings](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/salesforce-test-settings.png)

After that, just execute some tests as you normally would from the Test view:

![Test Execution](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/test-execution.png)

Once the test coverage has been downloaded by the Salesforce CLI, you can now see the code coverage for a specific Apex file in the status bar, and also the overall code coverage in a new window:

#### Coverage in Status Bar
![Coverage in Status Bar](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-apex.png)

The indicator in the status bar will only appear if the Apex class has tests coverage downloaded for such class. You can see three indicators, depending on the coverage percentage:

|Coverage|Indicator|
|-|-|
|0% - 65%|![Coverage Poor](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-poor.png)|
|65% - 75%|![Coverage Low](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-low.png)|
|75% - 100%|![Coverage Low](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-good.png)|

#### Coverage Window
![Coverage in Status Bar](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-summary.png)

You can get to this window by either clicking on the coverage indicator on the status bar, or by executing the **SFDX: Show Code Coverage** from the command palette:

![SFDX: Show Code Coverage](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-command.png)

#### Filtering
It is possible to filter down the test results to show only tests that are below the required 75% coverage, to allow the developer to focus on those tests that require inmediate action. Also, it is posible to filter further down on the name of the apex file:

![Filter](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-filter.png)

It is possible that the tests you write might contrigute to the coverage of other classes that are not in your project, by default the coverage viewer shows only classes that are present on the current project, but you can disable this and show all other classes as well.

#### Coverage Side Panel

The coverage side panel shows by default on the Test view, but it is possible to move it to any other place inside the Visual Studio Code layout:

![Coverage Sidebar](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/coverage-sidebar.gif)

The sidebar also allows to filter down the classes by clicking on the commands on the title bar:

![Coverage Sidebar](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/sidebar.png)

#### Test Coverage Contribution

It is possible to know what test classes and methods are contributing to the overall coverage percentage of a class by expanding the chevron icon on the right of the class:

![Coverage Sidebar](https://raw.githubusercontent.com/gmodica/apex-code-coverage-visualizer/master/images/testContribution.png)

## Known Issues

This extension depends on the code coverage information retrieved from SFDX using the standard SFDX extensions for code. This extension cannot show coverage for classes if the coverage for those classes is not retrieved. For big projects, with lots of classes and tests, the SFDX extension sometimes does not retrieve all code coverage for all the classes, so it is possible that you will only see coverage for certain classes while other classes will show no coverage. This is not an issue of this extension, but rather something related with the retrieval of the coverage by the SFDX standard extension.

## Bugs and Feedback

To report issues with Salesforce Extensions for VS Code, open a [bug on GitHub](https://github.com/gmodica/apex-code-coverage-visualizer/issues/new?template=Bug_report.md). If you would like to suggest a feature, create a [feature request on GitHub](https://github.com/gmodica/apex-code-coverage-visualizer/issues/new?template=Feature_request.md).

## Thanks
Thanks to Kevin Poorman ([@codefriar](https://www.twitter.com/codefriar)) for its contribution to the idea of showing the test coverage in a sidebar panel for easier reference. Kevin and I did this enhancement on an episode of Salesforce Developer Code Live, which you can find [here](https://youtu.be/xdL9nY2W8Fw).

## License
This project is licensed under the terms of the [MIT license](LICENSE.md).

apex-code-coverage-visualizer

apex-code-coverage-visualizer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

apex-code-coverage-visualizer

apex-code-coverage-visualizer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README