{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Include Code Quality for Bitbucket ","type":"text"},{"text":"never triggers a SonarQube™ analysis","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]},{"type":"paragraph","content":[{"text":"The most common scenario is an integration of the SonarQube™ analysis into your build pipeline. ","type":"text"}]},{"type":"paragraph","content":[{"text":"A recommended flow with Include Code Quality for Bitbucket looks like:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"New code changes pushed to Bitbucket (or new pull request is created)","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Bitbucket triggers your build pipeline for code changes","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Your build pipeline must trigger the Sonar™ analysis","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"and executes the ","type":"text"},{"text":"Sonar™Scanner","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/"}}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"or one of its build system-dependent ","type":"text"},{"text":"alternatives","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://docs.sonarqube.org/latest/analysis/overview/"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"see below for required parameters","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SonarQube™ informs Include Code Quality for Bitbucket over a ","type":"text"},{"text":"Webhook","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SONAR4STASH/pages/2315911173"}}]},{"text":" about a new analysis report. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Include Code Quality for Bitbucket annotates existing pull requests with the issues found in the analysis.","type":"text"}]}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Analysis Parameter Matrix","type":"text"}]},{"type":"paragraph","content":[{"text":"The table shows the minimally necessary parameters to get Include Code Quality for Bitbucket to work with ","type":"text"},{"text":"Sonar™Scanner","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/"}}]},{"text":". ","type":"text","marks":[{"type":"strong"}]},{"text":"Look at the ","type":"text"},{"text":"SonarQube™ documentation","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://docs.sonarqube.org/latest/analysis/overview/"}}]},{"text":" for additional parameters or different scanning methods.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"663a6c41-a0d7-4926-a0c2-2a0a37fa7a15"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[80.0]},"content":[{"type":"paragraph"}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[229.0]},"content":[{"type":"paragraph","content":[{"text":"Developer Edition or higher","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[247.0]},"content":[{"type":"paragraph","content":[{"text":"Community Edition","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"SonarCloud™ ","type":"text","marks":[{"type":"strong"}]},{"text":"https://docs.sonarcloud.io/advanced-setup/ci-based-analysis/overview/","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.sonarcloud.io/advanced-setup/ci-based-analysis/overview/"}}]},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[80.0]},"content":[{"type":"paragraph","content":[{"text":"Common Parameters","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[229.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sonar-scanner \\\n -Dsonar.projectKey= \\ \n -Dsonar.host.url=","type":"text"}]},{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[247.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sonar-scanner \\\n -Dsonar.projectKey= \\\n -Dsonar.host.url=","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"SonarQube™ versions 7.9.x and 8+ only allow certain characters ","type":"text"},{"text":"[0-9a-zA-Z:-_.]","type":"text","marks":[{"type":"code"}]},{"text":" in their project keys. Branch names typically contain ","type":"text"},{"text":"/","type":"text","marks":[{"type":"code"}]},{"text":" and cannot be used.","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the same character as configured in the SonarQube™ server configuration under ","type":"text"},{"text":"‘Branch renaming for Sonar™ Project Keys’.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"To replace illegal characters with the replacement character, the following sed expression can be used in your CI/CD configuration:","type":"text"}]},{"type":"paragraph","content":[{"text":"sed s/[^0-9a-zA-Z:_.\\-]/''/g","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"sonar-scanner \\\n -Dsonar.projectKey= \\\n -Dsonar.host.url=https://sonarcloud.io \\\n -Dsonar.organization=","type":"text"}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[80.0]},"content":[{"type":"paragraph","content":[{"text":"Branch Analysis","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[229.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" -Dsonar.branch.name= ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[247.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter not supported, branch included in Sonar™ project key as","type":"text"},{"text":"BRANCH_NAME","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"See Developer Edition or higher ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[80.0]},"content":[{"type":"paragraph","content":[{"text":"Pull Request Analysis","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[229.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" -Dsonar.pullrequest.key=\n -Dsonar.pullrequest.branch=\n -Dsonar.pullrequest.base=","type":"text"}]},{"type":"paragraph","content":[{"text":"See: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.sonarqube.org/latest/analysis/pull-request/"}},{"text":" ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[247.0]},"content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Take the source branch name of pull requests for ","type":"text"},{"text":"BRANCH_NAME","type":"text","marks":[{"type":"code"}]},{"text":" in Sonar™ project key","type":"text"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"See Developer Edition or higher ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#fffae6","rowspan":1,"colwidth":[80.0]},"content":[{"type":"paragraph","content":[{"text":"Only SonarQube™ 7.7","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[229.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" -Dsonar.analysis.scmRevision=COMMIT_ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[247.0]},"content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":" -Dsonar.analysis.scmRevision=COMMIT_ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[204.0]},"content":[{"type":"paragraph","content":[{"text":"Not needed ","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Build Systems","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Bamboo","type":"text"}]},{"type":"paragraph","content":[{"text":"We provide a first class integration for Bamboo with our ","type":"text"},{"text":"Include Code Quality for Bamboo","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"https://marketplace.atlassian.com/apps/1212756/sonar-for-bamboo?hosting=datacenter&tab=overview"}}]},{"text":" plugin. See our dedicated ","type":"text"},{"text":"wiki page","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/SONARBAMBOO/pages/5537801"}}]},{"text":" for more information.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Jenkins","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://plugins.jenkins.io/atlassian-bitbucket-server-integration/"}},{"text":" to connect Jenkins to Bitbucket.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install the the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://plugins.jenkins.io/sonar/"}},{"text":" Jenkins plugin, follow the instructions on the ","type":"text"},{"text":"Sonar™ Scanner for Jenkins Wiki","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-jenkins/"}}]},{"text":" to configure your analysis.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"[Community Edition] Install the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://plugins.jenkins.io/envinject/"}},{"text":" plugin.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Community Edition: Freestyle Job","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"New 'Freestyle Job'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select 'Bitbucket Server' for source code management","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select repository: enter ","type":"text"},{"text":"*/","type":"text","marks":[{"type":"code"}]},{"text":" as 'Branch specifier' in 'Branches to build'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select \"Bitbucket webhook trigger\" and enable the pull request events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add build steps","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Write out the sanitized SONAR_BRANCH to a file by adding a 'Execute Shell' task with content:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"echo SONAR_BRANCH=$(printf '%s' $GIT_BRANCH | cut -d'/' -f 2- | sed s/[^0-9a-zA-Z:_.\\-]/'-'/g) > sonar-branch","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Inject this variable with an 'Inject environment variable' step: select `sonar-branch` as 'Properties filepath'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add 'Execute SonarQube Scanner' step: override project key and project name in the 'Analysis Properties' field like:","type":"text"}]},{"type":"codeBlock","content":[{"text":"sonar.projectKey=my.plugin.key:${SONAR_BRANCH}\nsonar.projectName=\"Sonar Test Project - ${SONAR_BRANCH}\"","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Save configuration","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Trigger analysis with 'Build Now', it should successfully analyze your main branch","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change the 'Branch specifier' to ","type":"text"},{"text":"**","type":"text","marks":[{"type":"code"}]},{"text":" to listen to all branches","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a Pull Request in Bitbucket and verify an analysis is triggered","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Community Edition: Multibranch Pipeline","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a 'Multibranch Pipeline'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select 'Bitbucket Server' for 'Branch Sources' and add a Repository","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add 'Bitbucket webhook trigger' to 'Scan Multibranch Pipeline Triggers' → enable push/pull-request events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Save ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Add a ","type":"text"},{"text":"Jenkinsfile","type":"text","marks":[{"type":"code"}]},{"text":" to the repository. It needs needs to calculate the ","type":"text"},{"text":"sonar.projectKey","type":"text","marks":[{"type":"code"}]},{"text":" for the current branch (See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://mibexsoftware.atlassian.net/wiki/spaces/MSS/pages/3071082501/Sonar+Analysis+Configuration#Analysis-Parameter-Matrix"}},{"text":")","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is an example of such a pipeline:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"pipeline {\n agent any\n environment {\n scannerHome = tool name: 'scanner', type: 'hudson.plugins.sonar.SonarRunnerInstallation' \n SONAR_BRANCH = sh(returnStdout: true, script: \"printf '%s' $GIT_BRANCH | sed 's/[^0-9a-zA-Z:_.\\\\-]/-/g'\")\n }\n stages {\n stage('Analysis') { \n steps {\n withSonarQubeEnv('sonar') {\n sh \"${scannerHome}/bin/sonar-scanner -Dsonar.projectKey=test.pipeline.proj:$SONAR_BRANCH -Dsonar.projectName=\\\"Awesome Pipeline - $SONAR_BRANCH\\\"\" \n }\n }\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Developer Edition or higher: Multibranch Pipeline","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a 'Multibranch Pipeline'","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select 'Bitbucket Server' for 'Branch Sources' and add a Repository","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add 'Bitbucket webhook trigger' to 'Scan Multibranch Pipeline Triggers' → enable push/pull-request events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Save ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Use this ","type":"text"},{"text":"Jenkinsfile","type":"text","marks":[{"type":"code"}]},{"text":" for inspiration:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"pipeline {\n agent any\n environment {\n scannerHome = tool name: 'scanner', type: 'hudson.plugins.sonar.SonarRunnerInstallation' \n }\n stages {\n stage('branch analysis') {\n when { \n not {\n changeRequest()\n } \n }\n steps {\n withSonarQubeEnv('sonar-cloud') {\n sh \"${scannerHome}/bin/sonar-scanner -Dsonar.branch.name=${env.BRANCH_NAME}\"\n }\n }\n }\n \n \n stage('PR analysis') {\n when {\n changeRequest()\n }\n steps {\n withSonarQubeEnv('sonar-cloud') {\n sh \"${scannerHome}/bin/sonar-scanner \\\n -Dsonar.pullrequest.key=${env.CHANGE_ID} \\\n -Dsonar.pullrequest.base=${env.CHANGE_TARGET} \\\n -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}\"\n }\n }\n }\n }\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Problems During Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"We at ","type":"text"},{"text":"Mibex Software","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.com/"}}]},{"text":" are happy to help you in our ","type":"text"},{"text":"support desk","type":"text","marks":[{"type":"link","attrs":{"href":"https://mibexsoftware.atlassian.net/servicedesk/customer/portal/1/group/1/create/3?customfield_10400=10120"}}]},{"text":" or at ","type":"text"},{"text":"support@mibexsoftware.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@mibexsoftware.com"}}]}]},{"type":"paragraph"}],"version":1}