Installing CodeScan Self-Hosted

Overview

This section describes installing the CodeScan self-hosted server and allow you to get a fully functional evaluation version of the enterprise CodeScan running on your server.

Prerequisite

You must have a SonarQube™ server currently running in your environment. If you do not, please visit SonarQube.org to get set up.

Download and Install CodeScan from the ZIP file

1. First check the requirements. Then download the latest compatible CodeScan 22.8 version from here.

2. You will need to enter your License Key (to be provided by our Support Team) or Subscription Code. For more information on Subscription Code, see HERE.

3. Accept our Terms of Service and click on Request Download button.

4. Extract the ZIP file. It contains the SonarQube™ plugin and an ant-based tool enabling you to run an analysis.

Download links for previously supported CodeScan versions

Plugin installation

1. Delete any existing Salesforce plugins from your installation.

2. Ensure your SonarJS plugin is compatible with the current CodeScan for Lightning version. Currently the supported release requires v 6.2+ of the SonarJS plugin. See here for alternatives.

3. Copy sonar-salesforce-plugin-XXX.jar and sonar-codescanlang-plugin-XXX.jar into your SonarQube™ installation at /extensions/plugins/

Standard setup:

1. When you receive your license, enter it by logging into SonarQube™ with the credentials User: admin, Password: admin

2. Go to Administrator > General Settings.

3. Click on CodeScan on the list of Categories.

4. Enter your license in the text box labeled CodeScan license (key is "sf.license.secured")

5. Click Save.

Setting up Your Quality Profiles

1. Click on the Quality Profiles menu.

2. Make sure you have selected the Salesforce Lightning profile as the default for both the JavaScript and Visualforce and Lightning languages. This can be done with the settings cog to the right of the profile name.

Running a Scan

There are a few ways to run your scan. The first is using our SFDX plugin (this requires that the Salesforce CLI and the SFDX CodeScan Plugin be installed).

1. Generate a token from the My Account > Security menu in SonarQube™.

2. Open the command prompt and navigate to:

   /runner/my-project
   

3. Run the following command:

   sfdx codescan:run --token <token> --projectkey my-project-key --organization default-organization --server https://your.server.url
   

The Organization Key above will work for the Community edition of SonarQube™ but may need to be edited depending on your setup using a paid edition.

You can also use Ant (this requires Ant version 1.9+).

Running SFDX plugin behind proxy

To run the SFDX plugin behind a proxy, you will need to pass all the related information in the parameters of the analysis command.

Example:

sfdx codescan:run --server {instanceurl} --token {TKN} --projectkey {PRJ} --organization {ORG} -J-Dhttp.proxyHost=## -J-Dhttp.proxyPort=## -J-Dhttp.proxyUser=## -J-Dhttp.proxyPassword=## -J-Dhttps.proxyHost=## -J-Dhttps.proxyPort=## -J-Dhttps.proxyUser=## -J-Dhttps.proxyPassword=##

where,

SonarQube™ ant plugin

For more instructions on setting up the SonarQube™ ant plugin, see https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-ant/. You should verify that the ant script's steps are appropriate for your requirements.

1. Create a copy of the sonar-project-template folder in the runner directory of this folder and put it in the same project. Call it /runner/my-project. Add the following to the sonar-project.properties file in the my-project folder.

2. Set sonar.login= to a token available from the My Account > Security menu in SonarQube™.

3. Set sonar.projectKey=myproject

4. Set sonar.projectName=My Project

5. Set salesforce.username, salesforce.password and salesforce.url to your Salesforce username/password. Your Salesforce token must also be appended to the end of your salesforce.password parameter.
   For example: salesforce.password=passwordtoken.
   
   

   Setting your Salesforce username, password, and URL is unnecessary if you want to analyze static content. Please use a system administrator user profile for this otherwise you may experience strange errors when downloading the code or executing tests.

6. Open a command prompt and navigate into /runner/my-project

7. Run the following command:

   ant -f ../antbuild.xml analyse
   

Proxies

• If your network has a proxy, you must pass some more parameters to avoid license errors.

• A guide for this is available HERE.

Having trouble?

• Read the tutorials
• Check the troubleshooting section
• Contact Support