Viewing Code Coverage in SonarQube

To view your project’s code coverage in SonarQube, your Salesforce credentials need to be passed with your build.

This applies when you’re pulling your code from your Salesforce Org OR a Git repository.

SonarQube Settings

In SonarQube’s general settings under CodeScan, you will find a setting called Unit Test Run Mode. To run the tests and view up to date code coverage, this needs to be set to “async” (default). To use historical test data, this can be set to “history” (if no data is available, tests will not be run). Finally, to disable running tests completely, you can set this to “disable”.

If you find that your coverage seems low, exclude the aura folder from counting towards your total by setting the Test Coverage Exclusions in Administration > General Settings > Analysis Scope.  This can be done with the pattern **/aura/**.

Jenkins with Git

• This assumes you have a Jenkins project set up for use with a Git repository. There is a tutorial on setting up Jenkins with CodeScan here and a guide to using Git with Jenkins here
• In order for the code coverage to sync with the code from your repository, the two sources (Salesforce org or Sandbox where tests are being run and the repository) have to contain the exact same code.  If there are discrepancies they will appear as Line Pointer Errors in your log.

To view you code coverage when using Jenkins as a build manager and pulling from Git, the build will need a few more string parameters and a password parameter added.

Add the string parameter salesforce.username : Make the default value your Saleforce username eg. will@salesforce.com

Add the string parameter salesforce.url : Make the default value https://login.salesforce.com to pull from your production instance or https://test.salesforce.com to pull from your sandbox instance.

Add the password parameter salesforce.password : Make the default value your Salesforce password + your Salesforce token eg. passwordtoken

These parameters will run the tests on the Force.com platform and allow the coverage results to be displayed in SonarQube.