Integrating CodeScan in GitLab

Overview

Integrating CodeScan into your GitLab pipeline is easy with our SFDX plugin. There are only a few lines to add to your .YML file to run CodeScan when a build is triggered.

Note: The following is based on a docker pipeline with Java and Node installed in the container.

How to do it?

First, we'll need to add your CodeScan token as a variable we can access in our .YML file.

1. Open your project and navigate to Settings > CI/CD then expand the Variables section.

2. Add your token with the name CODESCAN_TOKEN and check the masked variable box. To learn how to generate a token, see HERE.

3. You'll be now be able to access this variable by using $CODESCAN_TOKEN in your .YML file.

4. Add the following into your .YML file:

image: salesforce/salesforcedx:latest-full

CodeScan:
  rules:
- if: $CI_COMMIT_REF_NAME =~ /^[<branch>]/ && $CI_PIPELINE_SOURCE =~ /^[push|schedule]/
  variables:
    CODESCAN_CMD: "sfdx codescan:run --token=$CODESCAN_TOKEN --server=<server_url> --projectkey=<project>--organization=<organization> -Dsonar.branch.name=$CI_COMMIT_REF_NAME"
- if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^[<branch>]/
  variables:
    CODESCAN_CMD: "sfdx codescan:run --token=$CODESCAN_TOKEN --server=<server_url> --projectkey=<project> --organization=<organization> -Dsonar.pullrequest.branch=$CI_COMMIT_REF_NAME -Dsonar.pullrequest.base=$CI_MERGE_REQUEST_TARGET_BRANCH_NAME -Dsonar.pullrequest.key=$CI_MERGE_REQUEST_IID"
  script:
- echo y|sfdx plugins:install sfdx-codescan-plugin
- $CODESCAN_CMD

Parameter	Description
project	Enter your project key
organization	Enter your organization key
token	Enter the CodeScan security token
server	Enter the CodeScan server URL. The default server URL is https://app.codescan.io. For EU regions users, the server URL would be https://app-eu.codescan.io, and for AUS regions, the server URL will be https://app-aus.codescan.io.
branch	Name of your branch.

The pull request details are being set by the following parameters:

• sonar.pullrequest.branch: Name of the branch containing the changes that need to be merged.

• sonar.pullrequest.base: The branch where the pull request will be merged.

• sonar.pullrequest.key: The pull request key or number or id.

Note: The above is a great way to get started scanning with this plugin; however, this script will install the CodeScan plugin with each run. A better implementation would include this installation in the docker image used.

By default, the CodeScan SFDX plugin will fail if the Quality Gate fails. If you would prefer that the build passes despite the quality gate, use the --nofail tag when calling sfdx codescan:run.

You can find a complete list of flags and examples on our npm plugin page.

Scanning Only Pull Request Changes

The script above scans the full branch of the Merge request that triggers the pipeline.

If you want to narrow down results to scanning only files that were changed in this Merge request, there are a couple of additional steps to take.

By adding the following lines to the script, you can generate a comma-separated string of changed files in the Merge request:

git fetch origin ${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-$CI_DEFAULT_BRANCH} --quiet

CHANGED_FILES=$(git diff --name-only origin/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-$CI_DEFAULT_BRANCH} HEAD | tr '\n' ',' | sed 's/,$//')

echo "CHANGED_FILES=$CHANGED_FILES"

Then, the $CHANGED_FILES variable can be passed to the merge request scan command. Like this:

-Dsonar.inclusions=$CHANGED_FILES

Note: The Merge request scan is the one using the sonar.pullrequest parameters.