SonarCloud

Setting up GitHub, Travis-ci and SonarCloud

Getting automatic analysis on SonarCloud is done via Travis-ci. Automatic analysis is coming but at the moment it is up to you to launch the analysis inside your existing Travis-CI scripts.

Before being able to do an automatic analysis on Pull Requests via Travis, you must do a one off manual project analysis.

Integrate GitHub and SonarCloud

• Log into SonarCloud with your GitHub account
• Create a new organization for your team under Account -> Organisations. The key of the organization will be used in the travis.yml and initial analysis.
• Install SonarCloud GitHub Application on your GitHub Organization.
• Give SonarCloud access to the repos you want analysed.

Initial project analysis

• Create a new project under Administration -> Projects Management. The key of the project will be used in the repo's travis.yml and initial analysis.
• Create an access token for the project under Account -> Security.
• Run the maven script below with the required project details.

FYI - The SonarCloud dashboard provides an initial config option that helps create the script below and access-token.

mvn sonar:sonar
 -Dsonar.projectKey=YOUR_PROJECT_KEY
 -Dsonar.organization=YOUR_ORGANIZATION_KEY
 -Dsonar.host.url=https://sonarcloud.io
 -Dsonar.login=YOUR_ACCESS_TOKEN

Integrate GitHub and Travis-ci

• It is very easy to integrate GitHub and Travis-ci by installing the Travis-ci GitHub Application. Follow the instructions at Travis-ci Tutorial.

Integrate SonarCloud and Travis-ci

• Log into Travis-CI and goto the settings of your project.
• Create the SONAR_TOKEN environment variable with your SonarCloud access token.
• Update your travis.yml to include the sonarcloud addon in the repo's travis.yml and add the mvn sonar:sonar command.

dist: trusty
addons:
  sonarcloud:
    organization: "YOUR_ORGANIZATION_KEY"
    token:
      secure: $SONAR_TOKEN
script:
  # The following command line builds the project, runs the tests with coverage and then execute the SonarCloud analysis
  - mvn package sonar:sonar

Appendix - How to Encrypt SonarCloud access token

• Create SonarCloud access token for the project under Account -> Security.
• Encrypt access token via Travis CLI (sample commands below). Travis encrypts the token for a specific repo. This is done by running the encryption command in the repo's project directory.
• Copy encrypted text into travis.yml

gem install travis
## As using travis-ci.com we need to login first
travis login --pro
## Change into your project repo directory
cd project
## Encrypt the access token you generated
travis encrypt --com <access-token>

References

• https://docs.travis-ci.com/user/sonarcloud/
• https://sonarcloud.io/documentation/integrations/github/
• https://docs.travis-ci.com/user/encryption-keys/#usage
• https://docs.travis-ci.com/user/tutorial/