{"id":802,"date":"2014-05-19T12:35:51","date_gmt":"2014-05-19T12:35:51","guid":{"rendered":"https:\/\/www.happiestminds.com\/blogs\/?p=802"},"modified":"2024-04-11T08:41:12","modified_gmt":"2024-04-11T08:41:12","slug":"how-to-set-up-sonar-on-jenkins-for-net-projects","status":"publish","type":"post","link":"https:\/\/www.happiestminds.com\/blogs\/how-to-set-up-sonar-on-jenkins-for-net-projects\/","title":{"rendered":"How to Set up Sonar on Jenkins for .net Projects"},"content":{"rendered":"
<\/div>

Historically, .Net projects have used technologies from within Microsoft stack to achieve their goals and objectives. With the strong emergence of excellent Open Source tools and the phenomenal growth of OpenStack, the trend is changing. Projects that use Microsoft Technologies are now seen building affinity towards open source tools for continuous integration, development and improvement. However, not many sites\/tutorials are available, that helps a project in Microsoft Technology stack to leverage open source tools.<\/p>\n

SonarQube is an open platform to manage code quality. This article guides a user on how to setup SonarQube in Jenkins server and simplify the adoption of the tool.<\/p>\n

Installation of Sonarqube<\/h2>\n

1. Download SonarQube from http:\/\/www.sonarqube.org\/downloads\/<\/a>
\n2. Unzip the SonarQube distribution C:\\sonarqube
\n3. Start the SonarQube server:
\nC:\\sonarqube\\bin\\windows-x86-xx\\StartSonar.bat
\n4. Download SonarQube Runner from http:\/\/www.sonarqube.org\/downloads\/<\/a>
\n5. Unzip the SonarQube Runner
\nC:\\sonar-runner
\n6. Download examples
\n7. Unzip some project samples C:\\sonar-examples
\n8. Analyze Project
\ncd C:\\sonar-examples\\projects\\languages\\java\\sonar-runner\\java-sonar-runner-simple
\nC:\\sonar-runner\\bin\\sonar-runner.bat
\n9. Browse results at http:\/\/localhost:9000
\n10. Default system administrator credentials are admin\/admin<\/p>\n

Install .Net Plugins for Sonar:<\/h2>\n

1. Download c# Ecosystem plugin
\n2. Extract and copy the plugins to C:\\sonarqube\\extensions\\plugins
\n3. Start SonarQube
\n4. Verify that you are able to browse http:\/\/ localhost:9000 and login
\n5. Login to the SonarQube website as an Admin user and
\n6. Click the \u201cSettings\u201d link in the upper right-hand corner,
\n7. Go to Configuration
\n8. Set the appropriate path for Galileo, FxCop, StyleCop and any other plugin that you want to invoke.
\n9. Install Win7 SDK if you are analyzing projects .net framework 2.0 \/4.0; if the target framework is 4.5, install Win 8 SDK.
\n10. Download command-line tool from Resharper at: http:\/\/www.jetbrains.com\/resharper\/features\/command-line.html<\/a>
\n11. Unzip it to a folder C:\\jetbrains-commandline-tools
\n12. Go to update center -> Available plugins
\n13. Choose .Net Resharper
\n14. Restart the SonarQube server
\n15. Login to SonarQube using admin-admin<\/p>\n

Modify Your Project\u2019s Quality Profile<\/h2>\n

1. Activate all 650 Resharper rules
\nGo to Quality Profiles -> C# -> Sonar way
\n2. Run Sonar runner from solution file to ensure Sonar is working correctly.<\/p>\n

Modify the port where Sonar is running<\/h2>\n

1. Change the sonar-properties files to have the port as 9010
\nsonar.web.host: 0.0.0.0
\nsonar.web.port: 9010
\nsonar.web.context: \/<\/p>\n

2. Change the wrapper.conf and add following line
\nwrapper.java.additional.3=-Djava.io.tmpdir=..\/..\/temp\/<\/p>\n

3. Run Sonar as a Windows Service
\n%SONARQUBE_HOME%\/bin\/windows-x86-32\/InstallNTService.bat<\/p>\n

4. Start Sonar service
\n%SONARQUBE_HOME%\/bin\/windows-x86-32\/StartNTService.bat<\/p>\n

5. Change the Sonar runner properties file
\nsonar.host.url=http:\/\/localhost:9010<\/p>\n

Install SonarQube Plugin on Jenkins<\/h2>\n

1. Go to \u2018Jenkins\u2019 \u2013 \u2018Manage Plugins\u2019
\n2. Go to \u2018Available tab\u2019
\n3. Select \u2018Sonar plugin\u2019
\n4. Choose \u2018install without restart\u2019
\n5. Go to ‘Manage Jenkins\u2019 and verify if \u2018Sonar\u2019 is listed in the installed plugin list.
\n6. You can verify your installed list.
\n7. Now go to http:\/\/jenkins IP\/manage<\/a> page
\n8. Go to \u2018Configure System\u2019:
\n9. Go to \u2018Sonar configuration section\u2019 and click on \u2018Add Sonar:\u2019
\n10. Go to \u2018Configure sonar-runner\u2019
\n11. Go to the \u2018Build section\u2019, click on \u2018Add build step\u2019 and choose \u2018Invoke Standalone Sonar Analysis\u2019: http:\/\/<IP>:<port>\/job\/<jobName>\/configure<\/a>
\n12. Add Invoke Standalone Sonar analysis
\n13. Configure the SonarQube analysis. You can either point to an existing sonar-project.properties-1<\/sup> file or set the analysis properties directly in the Project properties field:<\/p>\n

Note : Following is a sample Sonar Properties file:<\/strong><\/p>\n

# Project identification<\/strong>
\nsonar.projectKey=HM:Sonar.TestApplication
\nsonar.projectVersion=1.0
\nsonar.projectName= Sonar.TestApplication<\/p>\n

# C# Specific Properties<\/h2>\n

sonar.sources=.
\nsonar.language=cs
\nsonar.dotnet.key.generation.strategy=safe
\nsonar.sourceEncoding=UTF-8
\nsonar.dotnet.assemblies=\/trunk\/dotnet\/vstudio\/Sonar.TestApplication.Projects\/Sonar.TestApplication.Data \\bin\\Debug\\$(AssemblyName)\\$(OutputType)<\/p>\n

# Plugin Specific Properties<\/h2>\n

sonar.resharper.mode=reuseReport
\nsonar.resharper.report.path=resharper-results.xml
\nsonar.resharper.mode=
\nsonar.resharper.installDirectory=c:\/jetbrains-commandline-tools<\/p>\n

# Gallio \/ Unit Tests
\nsonar.gallio.mode=
\nsonar.gallio.coverage.tool=OpenCover
\nsonar.gallio.runner=Local
\nsonar.dotnet.visualstudio.testProjectPattern=*UnitTest*;Testing*
\nsonar.opencover.installDirectory=C:\/Program Files (x86)\/OpenCover\/<\/p>\n

# FXCop
\nsonar.fxcop.mode=<\/p>\n

# StyleCop
\nsonar.stylecop.mode=<\/p>\n

14. Now the Sonar is setup
\n15. You can trigger Sonar either from Jenkins or from command prompt.<\/p>\n

\n

\n

1<\/sup>Sonar project properties: A Sonar project file is the metadata that helps the sonar-runner to identify projects in the solution and run analysis against the solution. The Sonar runner file should be placed in the same folder that contains the c# solution. The Sonar<\/sup> runner file has three sections:
\n a. Project Properties<\/span>
\n b. C# Specific Properties<\/span>
\n c. Plugin Specific Properties<\/span><\/em><\/p>\n

\r\n
\r\n \r\n <\/i>\r\n <\/a>\r\n 0 <\/span>\r\n<\/div><\/div>","protected":false},"excerpt":{"rendered":"

Historically, .Net projects have used technologies from within Microsoft stack to achieve their goals and objectives. With the strong emergence of excellent Open Source tools and the phenomenal growth of OpenStack, the trend is changing. Projects that use Microsoft Technologies are now seen building affinity towards open source tools for continuous integration, development and improvement. […]<\/p>\n","protected":false},"author":90,"featured_media":986,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[123],"tags":[293,294,295,296,297,298,299,300,301,302],"class_list":["post-802","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-technology","tag-how-to-setup-jenkins","tag-jenkins-c","tag-jenkins-change-language","tag-jenkins-property-management","tag-jenkins-sonar","tag-project-sonar","tag-sonar-jenkins","tag-sonar-jenkins-plugin","tag-sonar-properties","tag-sonar-runner"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t