Installing CodeScan for VS Code

Learning Objectives:

After completing this unit, you'll be able to:

• Install the 'CodeScan for Visual Studio (VS) Code' extension
• Integrate VS Code with CodeScan
• Run VS Code behind a proxy
• Troubleshooting steps if you ran with VS Code issues

Get Started with VS Code

The CodeScan VS Code plugin provides on-the-fly feedback to developers on bugs and quality issues; it is a fully integrated user experience in VS Code.

Prerequisites

Make sure you have the following:

• VS Code version 1.12.0 or above
• A CodeScan cloud account (with valid enterprise or trial license).
• For CodeScan Self Hosted:
  • A working SonarQube™ (7.9+) installation
  • A licensed version of CodeScan (4.3+) plugin to get started (more info).
• Download the CodeScan extension from the marketplace
• Download the Salesforce Extension pack from the marketplace if you are working with Saleforce code, or, at a minimum, the Visualforce plugins.
• JDK version 11 or above
• Confirm the JAVA_HOME variable is set properly by your IT Team. Enter the command echo %JAVA_HOME% . This should output the path to your Java installation folder.
• Latest available Node.js LTS version (v16 as of today)
• Uninstall Apex PMD and SonarLint™ Plugins. The CodeScan and VS Code Plugin will not work alongside the SonarLint™ installation or the Apex PMD Plugin. You must uninstall both SonarLint™ and Apex PMD plugins first.

Installing the 'CodeScan for VS Code' extension

CodeScan extensions for Visual Studio Code are located in the Visual Studio Code Marketplace.

1. Open Visual Studio Code, and to the left most side, is the Activity Bar. The last button on the Activity Bar is the Extensions button.

2. Search for CodeScan and click on Install to install the CodeScan extension.
   

Integrate VS Code with CodeScan extension

Once you're done installing the CodeScan extension from the marketplace,

1. Restart the Visual Studio Code.

2. Press Ctrl + Shift + P and search for Settings and select Open User Settings (JSON)
   

3. On the settings.json tab, inside the curly braces ({ }), copy and paste the following text:

"codescan.servers": [
       {
            "serverId": "**************",
            "organizationKey": "**************",
            "serverUrl": "**************",
            "token": "**************"
        },
    ],

    "codescan.project": {
        "serverId": "**************",
        "projectKey": "**************"
    }
    "codescan.httpclient.version": "***********",

6. Save the settings.json file.

7. Now select Ctrl+Shift+P (Windows/Linux) or Shift+Command+P(Mac) to open the Command Palette.

8. Type in CodeScan to bring up the CodeScan commands and run Update CodeScan binding to SonarQube/CodeScan Cloud.

9. Go to View > Output to view the logs details. If a problem does occur, you are able to trace it via logs.
   

   Select Terminal > New Terminal or press Ctrl+Shift +`, if you are not able to view the Output section at the bottom of the screen.

10. An All CodeScan bindings successfully updated notification appears if the binding is successfully completed.

11. If any changes are made on the SonarQube™ server, then repeat this step.
    

12. Open a file, and you should see the issues in your code underlined.
    

Visual Studio Code behind a proxy

VS Code extensions can be difficult to use behind a proxy. To point CodeScan at the correct proxy, all it takes is a single environment variable for your system.

The environment variable is: JAVA_TOOL_OPTIONS

Follow the steps to set environment variables using the Windows GUI:

1. Press Windows + R to open the Windows Run prompt.

2. Type in sysdm.cpl and click OK.

3. Open the Advanced tab and click on the Environment Variables button in the System Properties window.

4. The Environment Variables window is divided into two sections. Click the New… button on the top section.

5. In the New User Variable prompt, enter the Variable Name as JAVA_TOOL_OPTIONS, enter the following Variable Value, and click OK.

   Variable Value:

   -Dhttp.proxyHost=[YOUR_PROXY_HOST] 
   -Dhttp.proxyPort=[YOUR_PROXY_PORT]
   
   -Dhttps.proxyHost=[YOUR_PROXY_HOST] 
   -Dhttps.proxyPort=[YOUR_PROXY_PORT]
   
   -Dhttp.nonProxyHosts="localhost|127.0.0.1"
   

   If the proxy has a username and password, you can add/update the following parameters and add them at the end of the variable value field.

   -Dhttps.proxyUser=your_username
   -Dhttps.proxyPassword=your_password
   

Self Signed Certificates

If you are connecting to a server with a self-signed certificates, you will need to specify them for your Java and Node installations.

For your Java installation, you can find the documentation here.

For Node installation, add the environment variable NODEEXTRACA_CERTS with the path to your certificate file as a value, e.g., /usr/local/share/ca-certificates/YOUR_CERT.crt.

VS Code Troubleshooting

PKIX Certificate error

Error Code:

javax.net.ssl.SSLHandshakeException: 
sun.security.validator.ValidatorException: 
PKIX path building failed: 
sun.security.provider.certpath.SunCertPathBuilderException: 
unable to find valid certification path to requested target.

Reason:
This error occurs when the Java environment does not trust the certificate of the server running your SonarQube instance.

Solution:
Install the server certificate to the Java key.

Steps:

1. In your browser, to the left of the URL, there is a lock icon ().

2. Click on this icon and a window will pop up. From the window, select Connection is secure.
   

3. Select the second option, i.e., Certificate is valid.
   

4. Go to the Details tab and click on Export.
   

5. Rename the certificate (e.g., codescan-certificate), then choose a location and save the certificate.
   

6. The next process is to install the certificate in the cacerts file of the jdk installed in the system using the command line.

   Command:

   keytool -import -alias {alias-name for the certificate} -keystore “{path for the cacerts file}” -file {path where we have save the certificate}

   
   Example:

   keytool -import -alias codescan-certificate -keystore "C:\Program Files\Java\jdk-11.0.9\lib\security\cacerts" -file c:/tmp/codescan-certificate.crt

When adding the certificate, password is required. The password is changeit.

CodeScan Update Binding Failed

If the CodeScan update binding is getting failed, try disabling the VPN and antivirus, then try updating the binding again.

If the binding successfully updates, the error occurred due to antivirus blocking CodeScan. Add CodeScan to the list of allowed sites for the antivirus in use.

If the binding still fails, raise a Support Ticket, including the analyzer logs and verbose logs in the attachment.

Issue when ApexPMD plugin installed along with the CodeScan plugin

If Apex PMD plugin is installed alongside the Codescan plugin, one or more of the following issues may occur:

• Codescan is not listed in the dropdown in Output Tab of VS Code terminal.
• Inconsistency in the number of issues for a file on saving the file.
• Problems for a specific file are displayed even when the file is closed.

All these issues can be resolved by uninstalling Apex PMD plugin and restarting IDE, then updating the Binding to Codescan Cloud.

CodeScan and Java Runtime Environment (JRE) sync issue

CodeScan should automatically find the JRE installed on your computer. If you have trouble, then you can specify the JRE path on your VS Code's Settings page.

Navigation: VS Code Settings > Settings > Extensions > CodeScan.

Under Codescan > Ls: Java Home (Not synced), enter the JRE path.

How do I see warnings and errors in VS Code?

You can click on the summary or press Ctrl+Shift+M to display the PROBLEMS panel with a list of all current errors. If you open a file that has errors or warnings, they will be rendered inline with the text and in the overview ruler.

Other useful debugging information

• Some useful debugging information is available under the Output window under the ‘CodeScan’ tab.
• Also, you can check for any serious errors by going to Help > Toggle Developer Tools to bring up the console.

Raising a support ticket

Before raising a support ticket, perform the following checks in VS Code:

• Are Sonarlint or ApexPmd plugin installed alongside CodeScan?- If so, uninstall it.
• Is the Salesforce extension pack installed in VS Code ?- If not, install as this is mandatory.
• What version of Java is installed?- Java 11 version is required
• Is the Java path passed to CodeScan (codescan.ls.javaHome)?- Verify by going to VS Code Settings > Settings > Extensions > CodeScan and under Codescan › Ls: Java Home (Not synced), you should see the JAVA_HOME path mentioned. If not present, please enter the JAVA_HOME path.
  You can also add the JAVA_HOME path in the settings.json file inside codescan.ls.javaHome property.
  

Perform the CodeScan Update Binding and check if the issue is resolved.

What's Next?
If you're still having issue with VS Code, raise a support ticket on the CodeScan Support Page and share with us the following informations:

• In settings.json file, please add the below properties inside the curly braces ({ }) to get debug level logs:

  "codescan.output.showVerboseLogs": true, 
  "codescan.output.showAnalyzerLogs": true,
  

• Update the CodeScan binding and share the logs with us.

Feel free to ask questions, report issues, and offer suggestions.