Sonar™ Analysis Configuration
Include Code Quality for Bitbucket never triggers a SonarQube™ analysis.
The most common scenario is an integration of the SonarQube™ analysis into your build pipeline.
A recommended flow with Include Code Quality for Bitbucket looks like:
New code changes pushed to Bitbucket (or new pull request is created)
Bitbucket triggers your build pipeline for code changes
Your build pipeline must trigger the Sonar™ analysis
and executes the Sonar™Scanner or one of its build system-dependent alternatives.
see below for required parameters
SonarQube™ informs Include Code Quality for Bitbucket over a Webhook about a new analysis report.
Include Code Quality for Bitbucket annotates existing pull requests with the issues found in the analysis.
Whichever external system you use to execute the Sonar™ scan, you need to run it with the correct parameters for your SonarQube™ application. Use the analysis parameter matrix below to find yours.
Analysis Parameter Matrix
The table shows the minimally necessary parameters to get Include Code Quality for Bitbucket to work with Sonar™Scanner. Look at the SonarQube™ documentation for additional parameters or different scanning methods.
| Developer Edition or higher | Community Edition | |
---|---|---|---|
Common Parameters | sonar-scanner \
-Dsonar.projectKey=<SONAR_PROJECT_KEY> \
-Dsonar.host.url=<SONAR_SERVER_URL>
| sonar-scanner \
-Dsonar.projectKey=<SONAR_PROJECT_KEY_PREFIX:BRANCH_NAME> \
-Dsonar.host.url=<SONAR_SERVER_URL> SonarQube™ versions 7.9.x and 8+ only allow certain characters Use the same character as configured in the SonarQube™ server configuration under ‘Branch renaming for Sonar™ Project Keys’. To replace illegal characters with the replacement character, the following sed expression can be used in your CI/CD configuration:
| sonar-scanner \
-Dsonar.projectKey=<SONAR_PROJECT_KEY> \
-Dsonar.host.url=https://sonarcloud.io \
-Dsonar.organization=<SONAR_CLOUD_ORGANIZATION>
|
Branch Analysis | Parameter not supported, branch included in Sonar™ project key as | See Developer Edition or higher | |
Pull Request Analysis | See: https://docs.sonarqube.org/latest/analysis/pull-request/ | Take the source branch name of pull requests for | See Developer Edition or higher |
Only SonarQube™ 7.7 | Not needed |
Build Systems
Bamboo
We provide a first class integration for Bamboo with our Include Code Quality for Bamboo plugin. See our dedicated wiki page for more information.
Jenkins
Use https://plugins.jenkins.io/atlassian-bitbucket-server-integration/ to connect Jenkins to Bitbucket.
Install the the https://plugins.jenkins.io/sonar/ Jenkins plugin, follow the instructions on the Sonar™ Scanner for Jenkins Wiki to configure your analysis.
[Community Edition] Install the https://plugins.jenkins.io/envinject/ plugin.
Community Edition: Freestyle Job
New 'Freestyle Job'
Select 'Bitbucket Server' for source code management
Select repository: enter
*/<yourMainBranch>
as 'Branch specifier' in 'Branches to build'Select "Bitbucket webhook trigger" and enable the pull request events
Add build steps
Write out the sanitized SONAR_BRANCH to a file by adding a 'Execute Shell' task with content:
Inject this variable with an 'Inject environment variable' step: select `sonar-branch` as 'Properties filepath'
Add 'Execute SonarQube Scanner' step: override project key and project name in the 'Analysis Properties' field like:
Save configuration
Trigger analysis with 'Build Now', it should successfully analyze your main branch
Change the 'Branch specifier' to
**
to listen to all branchesCreate a Pull Request in Bitbucket and verify an analysis is triggered
Community Edition: Multibranch Pipeline
Add a 'Multibranch Pipeline'
Select 'Bitbucket Server' for 'Branch Sources' and add a Repository
Add 'Bitbucket webhook trigger' to 'Scan Multibranch Pipeline Triggers' → enable push/pull-request events
Save
Add a Jenkinsfile
to the repository. It needs needs to calculate the sonar.projectKey
for the current branch (See Sonar™ Analysis Configuration | Analysis Parameter Matrix)
Below is an example of such a pipeline:
Developer Edition or higher: Multibranch Pipeline
Add a 'Multibranch Pipeline'
Select 'Bitbucket Server' for 'Branch Sources' and add a Repository
Add 'Bitbucket webhook trigger' to 'Scan Multibranch Pipeline Triggers' → enable push/pull-request events
Save
Use this Jenkinsfile
for inspiration:
Problems During Setup
We at Mibex Software are happy to help you in our support desk or at support@mibexsoftware.com
SONAR™, SONARQUBE™ and SONARCLOUD™ are independent and trademarked products and services of SonarSource SA: see sonarsource.com, sonarqube.org, sonarcloud.io.