{"id":1223,"date":"2023-09-28T22:34:22","date_gmt":"2023-09-28T17:04:22","guid":{"rendered":"https:\/\/www.openwriteup.com\/?page_id=1223"},"modified":"2025-01-31T09:30:04","modified_gmt":"2025-01-31T04:00:04","slug":"sonarqube-intergration","status":"publish","type":"page","link":"https:\/\/www.openwriteup.com\/?page_id=1223","title":{"rendered":"SonarQube intergration"},"content":{"rendered":"

step 1:<\/p>\n

Signup and SetUp – SonarQube Cloud account using GitHub Objective: In this lab, you will signup SonarQube Cloud account using GitHub Creating a SonarQube Cloud account using GitHub 1.<\/p>\n

Go to SonarQube cloud website<\/p>\n

https:\/\/www.sonarsource.com\/products\/sonarcloud\/<\/p>\n

\"\"<\/a><\/p>\n

Authorize sonalcloud<\/p>\n

 <\/p>\n

\"\"<\/a><\/p>\n

3. go to github.com and fork below project<\/p>\n

https:\/\/github.com\/owtest23\/javaproj.git<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

4. Go to sonar cloud and import the orgnization<\/p>\n

\"\"<\/a><\/p>\n

5. select repo<\/p>\n

\"\"<\/a><\/p>\n

6. install<\/p>\n

\"\"<\/a><\/p>\n

7. Note down the project key<\/p>\n

\"\"<\/a><\/p>\n

8. create organization<\/p>\n

\"\"<\/a><\/p>\n

9.anaylsis<\/p>\n

\"\"<\/a><\/p>\n

. \"\"<\/a><\/p>\n

 <\/p>\n

\"\"<\/a><\/p>\n

10. get token<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

generate the token and note it down<\/p>\n

12. Get the project key [click on my project–>click on sample-java-sonar<\/p>\n

\"\"<\/a><\/p>\n

Left hand side select the icon<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a>‘<\/p>\n

note down the project key<\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

12. Prior to performing a Sonar scan through Jenkins, it is necessary to deactivate the automatic
\nanalysis option in the SonarQube web graphical user interface (GUI). a. Go to SonarQube Web GUI
\nand click on \u201cAdministration\u201d \u2192 \u201cAnalysis Method<\/p>\n

\"\"<\/a><\/p>\n

13. setup quality gate<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

create new quality gate<\/p>\n

\"\"<\/a><\/p>\n

Add condition<\/p>\n

‘\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

set default<\/p>\n

\"\"<\/a><\/p>\n

modify the sudoers file in ubuntu<\/p>\n

vi \/etc\/sudoers\r\n\r\njenkins ALL=(ALL) NOPASSWD: ALL<\/pre>\n
Write the pipeline<\/p>\n
pipeline {\r\nagent any\r\n\r\nstages {\r\nstage('chckout scm') {\r\nsteps {\r\ncheckout scmGit(branches: [[name: '*\/master']], extensions: [], userRemoteConfigs: [[url: 'https:\/\/github.com\/hellokaton\/java11-examples.git']])\r\n}\r\n}\r\nstage('Compiling and Running Test Cases') {\r\nsteps {\r\nsh 'mvn clean'\r\nsh 'mvn compile'\r\nsh 'mvn test'\r\n}\r\n}\r\nstage('Generating a Cucumber Reports') {\r\nsteps {\r\nscript {\r\n\/\/ Run Cucumber tests and generate reports\r\nsh 'mvn verify'\r\n}\r\n}\r\n}\r\nstage('Creating Package') {\r\nsteps {\r\nsh 'mvn package'\r\n}\r\n}\r\nstage('adding genrerate report'){\r\nsteps {\r\nsh 'mvn verify'\r\n}\r\n}\r\nstage('Install sonarqube cli') {\r\nsteps {\r\n\/\/ Step to install SonarQube CLI\r\nsh 'sudo wget -O sonar-scanner.zip https:\/\/binaries.sonarsource.com\/Distribution\/sonar-scanner-cli\/sonar-scanner-cli-5.0.1.3006-linux.zip'\r\nsh 'sudo unzip -o -q sonar-scanner.zip'\r\nsh 'sudo rm -rf \/opt\/sonar-scanner'\r\nsh 'sudo mv --force sonar-scanner-5.0.1.3006-linux \/opt\/sonar-scanner'\r\nsh 'sudo sh -c \\'echo \"#\/bin\/bash \\nexport PATH=\\\\\\\"$PATH:\/opt\/sonar-scanner\/bin\\\\\\\"\" >\/etc\/profile.d\/sonar-scanner.sh\\''\r\nsh 'sudo chmod +x \/opt\/sonar-scanner\/bin\/sonar-scanner'\r\nsh '. \/etc\/profile.d\/sonar-scanner.sh'\r\n}\r\n}\r\n\r\nstage('Analyzing Code Quality') {\r\nsteps {\r\n\/\/ Step to analyze code quality with SonarQube\r\nsh '\/opt\/sonar-scanner\/bin\/sonar-scanner -Dsonar.projectKey=owtest23_sample-java-sonar -Dsonar.organization=owtest23 -Dsonar.qualitygate.wait=true -Dsonar.qualitygate.timeout=300 -Dsonar.sources=src\/main\/java\/ -Dsonar.java.binaries=target\/classes -Dsonar.host.url=https:\/\/sonarcloud.io -Dsonar.login=65558d8b45ebd4758f3e8d49b8f3582f8707306'\r\n}\r\n}\r\n}\r\n}\r\n\r\n<\/pre>\n
In case it is failing remove the stage due to permission issue, remove stage “Install sonarqube cli” and step. Perform all the step manually on ubuntu server<\/strong><\/p>\n
wget -O sonar-scanner.zip https:\/\/binaries.sonarsource.com\/Distribution\/sonar-scanner-cli\/sonar-scanner-cli-5.0.1.3006-linux.zip\r\n\r\nunzip -o -q sonar-scanner.zip\r\n\r\nrm -rf \/opt\/sonar-scanner\r\n\r\nmv --force sonar-scanner-5.0.1.3006-linux \/opt\/sonar-scanner\r\n\r\nexport PATH=\"\/opt\/sonar-scanner\/bin\"\r\n\r\nchmod +x \/opt\/sonar-scanner\/bin\/sonar-scanner<\/pre>\n
 <\/p>\n
 <\/p>\n
Coverted same code in functional mode<\/strong><\/p>\n
 <\/p>\n
pipeline {\r\nagent any\r\nstages {\r\nstage('Checkout SCM') {\r\nsteps {\r\ncheckoutSCM()\r\n}\r\n}\r\n\r\nstage('Compiling and Running Test Cases') {\r\nsteps {\r\ncompileAndRunTests()\r\n}\r\n}\r\n\r\nstage('Generating a Cucumber Reports') {\r\nsteps {\r\ngenerateCucumberReports()\r\n}\r\n}\r\n\r\nstage('Creating Package') {\r\nsteps {\r\ncreatePackage()\r\n}\r\n}\r\n\r\nstage('Adding Generate Report') {\r\nsteps {\r\naddGenerateReport()\r\n}\r\n}\r\n\r\nstage('Install SonarQube CLI') {\r\nsteps {\r\ninstallSonarQubeCLI()\r\n}\r\n}\r\n\r\nstage('Analyzing Code Quality') {\r\nsteps {\r\nanalyzeCodeQuality()\r\n}\r\n}\r\n}\r\n}\r\n\r\ndef checkoutSCM() {\r\ncheckout scm: [$class: 'GitSCM', branches: [[name: '*\/master']], userRemoteConfigs: [[url: 'https:\/\/github.com\/hellokaton\/java11-examples.git']]]\r\n}\r\n\r\ndef compileAndRunTests() {\r\nsh 'mvn clean'\r\nsh 'mvn compile'\r\nsh 'mvn test'\r\n}\r\n\r\ndef generateCucumberReports() {\r\nscript {\r\nsh 'mvn verify'\r\n}\r\n}\r\n\r\ndef createPackage() {\r\nsh 'mvn package'\r\n}\r\n\r\ndef addGenerateReport() {\r\nsh 'mvn verify'\r\n}\r\n\r\ndef installSonarQubeCLI() {\r\nsh '''\r\nwget -O sonar-scanner.zip https:\/\/binaries.sonarsource.com\/Distribution\/sonar-scanner-cli\/sonar-scanner-cli-5.0.1.3006-linux.zip\r\nunzip -o -q sonar-scanner.zip\r\nrm -rf \/opt\/sonar-scanner\r\nsudo mv --force sonar-scanner-5.0.1.3006-linux \/opt\/sonar-scanner\r\nsudo sh -c 'echo \"#\/bin\/bash \\nexport PATH=\\\\\\\"$PATH:\/opt\/sonar-scanner\/bin\\\\\\\"\" >\/etc\/profile.d\/sonar-scanner.sh'\r\nsudo chmod +x \/opt\/sonar-scanner\/bin\/sonar-scanner\r\n. \/etc\/profile.d\/sonar-scanner.sh\r\n'''\r\n}\r\n\r\ndef analyzeCodeQuality() {\r\nsh '''\r\n\/opt\/sonar-scanner\/bin\/sonar-scanner -Dsonar.projectKey=owtest23_sample-java-sonar \\\r\n-Dsonar.organization=owtest23 \\\r\n-Dsonar.qualitygate.wait=true \\\r\n-Dsonar.qualitygate.timeout=300 \\\r\n-Dsonar.sources=src\/main\/java\/ \\\r\n-Dsonar.java.binaries=target\/classes \\\r\n-Dsonar.host.url=https:\/\/sonarcloud.io \\\r\n-Dsonar.login=65558d8b45ebd4758f3e8d49b8f3582f8707306\r\n'''\r\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"
step 1: Signup and SetUp – SonarQube Cloud account using GitHub Objective: In this lab, you will signup SonarQube Cloud account using GitHub Creating a SonarQube Cloud account using GitHub 1. Go to SonarQube cloud website https:\/\/www.sonarsource.com\/products\/sonarcloud\/ Authorize sonalcloud   3. go to github.com and fork below project https:\/\/github.com\/owtest23\/javaproj.git 4. Go to sonar cloud and […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_oct_exclude_from_cache":false,"footnotes":""},"class_list":["post-1223","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/pages\/1223","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1223"}],"version-history":[{"count":6,"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/pages\/1223\/revisions"}],"predecessor-version":[{"id":1481,"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=\/wp\/v2\/pages\/1223\/revisions\/1481"}],"wp:attachment":[{"href":"https:\/\/www.openwriteup.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1223"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}