Skip to main content
Jump to: navigation, search

Difference between revisions of "SonarQube"

(Setting up SonarQube for Eclipse.org projects)
Line 24: Line 24:
 
[https://www.sonarqube.org/ SonarQube] (formerly known as Sonar) is an open-source product which is used to gather several metrics about code quality, put them all in a single dashboard, and provide some tips to help you making your code better, more sustainable, more reliable, less bugged.
 
[https://www.sonarqube.org/ SonarQube] (formerly known as Sonar) is an open-source product which is used to gather several metrics about code quality, put them all in a single dashboard, and provide some tips to help you making your code better, more sustainable, more reliable, less bugged.
  
Enable Jenkins SonarQube plugin on your job or running <tt>mvn sonar:sonar</tt> on your Maven build will result in the following flow of actions:
+
[https://www.sonarcloud.io SonarCloud.io] is the "cloud"-version of SonarQube hosted by SonarSource.
# SonarQube will locally analyze code and generate reports from many analyzers
+
# SonarQube will push those reports to the SonarQube dashboard
+
  
== Setting up SonarQube for Eclipse.org projects ==
+
== Setting up SonarQube/SonarCloud for Eclipse.org projects ==
  
{{important|SonarQube has been shutdown in early September 2020 | Due to relatively low demand and to reduce our maintenance overhead, we retired the Eclipse SonarQube server (https://sonar.eclipse.org/) in early September 2020. We will support projects to migrate to https://sonarcloud.io.<br> Please open a Bugzilla issue (Product: Community, Component: Sonar) for this. }}
+
{{important|Eclipse SonarQube server has been shutdown in early September 2020 | Due to relatively low demand and to reduce our maintenance overhead, we retired the Eclipse SonarQube server (https://sonar.eclipse.org/) in early September 2020. We will support projects to migrate to https://sonarcloud.io.<br> Please open a Bugzilla issue (Product: Community, Component: Sonar) for this. }}
 +
 
 +
If your project wants to use [https://www.sonarcloud.io SonarCloud.io], please open a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=Sonar Bugzilla issue] to request it. Please specify for which exact project this should be setup.
  
 
=== Usage ===
 
=== Usage ===
  
SonarQube can be found on https://sonar.eclipse.org . [https://sonar.eclipse.org/all_projects Several projects] already have quality reports enabled. You can drill-down on code to see SonarQube annotations on each class, or navigate through the different widgets on the dashboard to focus on specific issues.
+
The project must either have a [[Jenkins|Jenkins instance]] or use [https://travis-ci.com Travis CI]. See [[Jenkins#Requesting_a_JIPP_instance|how to get a dedicated JIPP]]. You should first setup a normal build to make sure the project compiles correctly.  
  
The project must have a [[Jenkins|Jenkins instance]]. See [[Jenkins#Requesting_a_JIPP_instance|how to get a dedicated JIPP]]. You should first setup a normal build to make sure the project compiles correctly.
+
In Jenkins your build job needs to be modified as follows:
 +
*Job config
 +
**“Use secret text(s) or file(s)
 +
***Add -> Secret text
 +
****Select “SonarCloud token”
 +
****Variable: SONARCLOUD_TOKEN
  
Optional: it may be a good thing to add a SonarQube goal in your pom.xml, so you can run the SonarQube analyser whenever you want, independently of the Jenkins build.
+
*"Prepare SonarQube Scanner environment" option needs to be enabled
  
There are two ways to setup SonarQube on Jenkins for your project, depending on the build tool used: Tycho builds can use the SonarQube/Maven integration, while other tools (e.g. Buckminster) have to setup a SonarQube Runner build step.
+
*In Maven build step, Goals:
 +
<source lang="bash" style="border:1px solid;padding: 5px; margin: 5px;">
 +
clean verify -B sonar:sonar
 +
-Dsonar.projectKey=org.eclipse.cbi.examples:cbi-example-parent
 +
-Dsonar.organization=eclipse-cbi
 +
-Dsonar.host.url=${SONAR_HOST_URL}
 +
-Dsonar.login=${SONARCLOUD_TOKEN}
 +
</source>
 +
<code>sonar.projectKey</code> and <code>sonar.organization</code> will need to be adapted individually.
  
You can check the SonarQube documentation for the plugin here:
+
Running <tt>mvn sonar:sonar</tt> in your Maven build will result in the following flow of actions:
* https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins
+
# The Maven SonarQube plugin will locally analyze code and generate reports from many analyzers
 +
# The Maven SonarQube plugin will push those reports to SonarCloud
  
=== Enable SonarQube for your project with Tycho ===
 
  
The only prerequisite for this method is to use [https://eclipse.org/tycho/ Tycho] as a building tool, which allows to automatically retrieve all information about the build and its dependencies.
+
[https://sonarcloud.io/organizations/eclipse Several Eclipse projects] already have quality reports enabled. You can drill-down on code to see annotations on each class, or navigate through the different widgets on the dashboard to focus on specific issues.
 
+
A dedicated job has to be defined for the quality analysis -- because you don't want to execute SonarQube every time the project is built. In the update center, install the Sonar plugin and restart the Jenkins instance. In the job configuration, check the SonarQube post-build action, click on advanced and fulfill the fields according to your project configuration. The following example screenshot shows the [https://ci.eclipse.org/emfcompare/job/master-quality/configure configuration used by the emf-compare project].
+
 
+
[[File:Hudson_sonar_emfcompare.png|SonarQube post-build action in Jenkins]]
+
 
+
Then [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community post a new bug entry in the community bugzilla] to ask an administrator to add the Eclipse SonarQube instance parameters to the Sonar plugin.
+
  
 
=== Permissions ===
 
=== Permissions ===
  
SonarQube is currently (and will remain) public to all and by default only Eclipse Webmaster can administrate the analysis projects. If you need admin permissions on some analysis projects, drop a bug on [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=Sonar bugzilla], specifying which analysis projects you want to administrate. The name of the analysis must be close enough to the project's name. If you are not the project lead your project, don't forget to ask him to +1 your request. The admin permissions will be granted for all committers on the project.
+
By default only Eclipse Webmaster can administrate the analysis projects on [https://www.sonarcloud.io SonarCloud.io]. If you need admin permissions on some analysis projects, please open a bug on [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=Sonar Bugzilla], specifying which analysis projects you want to administrate. The name of the analysis must be close enough to the project's name. If you are not the project lead, don't forget to ask him/her for a +1.
  
 
=== Note ===
 
=== Note ===
  
 
The initial documentation referenced Mickael Istria's blog entry at http://mickaelistria.wordpress.com/2012/10/08/sonar-at-eclipse-org/ . The information in it regarding the Eclipse process is outdated, but the article is still a good reading to understand how SonarQube works and what it can bring to you.
 
The initial documentation referenced Mickael Istria's blog entry at http://mickaelistria.wordpress.com/2012/10/08/sonar-at-eclipse-org/ . The information in it regarding the Eclipse process is outdated, but the article is still a good reading to understand how SonarQube works and what it can bring to you.
 
== Infrastructure and maintenance ==
 
 
SonarQube is installed on a VM accessible from inside Eclipse infrastructure. The database is made accessible from Eclipse.org servers and has a user for SonarQube, and another user for Jenkins. When running the Jenkins Sonar plugin, the plugin uses this user to push to the SonarQube database the metrics about your project.
 
  
 
=== Bugzilla ===
 
=== Bugzilla ===
Line 71: Line 74:
 
* Open issues: https://bugs.eclipse.org/bugs/buglist.cgi?list_id=6604883&classification=Eclipse%20Foundation&query_format=advanced&component=Sonar&product=Community  
 
* Open issues: https://bugs.eclipse.org/bugs/buglist.cgi?list_id=6604883&classification=Eclipse%20Foundation&query_format=advanced&component=Sonar&product=Community  
 
* User to follow to get notified of new bugs on Sonar component: sonar-inbox@eclipse.org
 
* User to follow to get notified of new bugs on Sonar component: sonar-inbox@eclipse.org
 
=== Maintenance notes ===
 
 
* Database requires to be tweak to add some "GRANT" permissions to the sonar user. Sonar could start otherwise.
 
* March 2013: https://bugs.eclipse.org/bugs/show_bug.cgi?id=407658 . Removed big log file and restarted Sonar,
 
* July 2013: Got an OutOfMemory on Sonar side while running Platform-Sonar job. Increased max memory in conf/wrapper.conf and restarted Sonar.
 
* July 2013: No space left on device. A lot of big memory dumps files in bin/linux-x86-64 consumed half of disk space. Removed them
 
* October 2013: Migration to SonarQube 3.7.1 to provide compatibility with Maven
 
** https://bugs.eclipse.org/bugs/show_bug.cgi?id=417978 basic migration
 
** https://bugs.eclipse.org/bugs/show_bug.cgi?id=418502 Issue with HTTPS
 
** <tt>org.postgresql.util.PSQLException: ERROR: permission denied for relation permission_templates</tt> => Give permissions to hudson user with psql <tt>GRANT SELECT ON ALL TABLES IN SCHEMA public TO user; GRANT SELECT ON ALL SEQUENCES IN SCHEMA public TO user;</tt>
 
* Reboot: <tt>INFO  | jvm 1    | 2014/01/24 06:06:27 | java.lang.OutOfMemoryError</tt>
 

Revision as of 07:49, 8 September 2020

Sonarqube.png

About code quality analysis

Why?

Code quality analysis helps you to make your code:

  • less error-prone
  • more sustainable
  • more reliable
  • more readable
  • more welcoming to new contributors

It is also a mandatory step for projects willing to enter the PolarSys Maturity Assessment, as the analysis process relies on code metrics extracted by SonarQube.

How?

Code quality analysis mainly relies on a set of tools that look at your code and give you hints. The most famous tools are Findbugs, PMD, Checkstyle; but also code coverage tools such as JaCoCo. JDT itself provides very powerful quality checks, but there are not enabled by default. You should go to Error/Warnings in preferences and replace all "ignore" by "Warning". You can (and should) enable such tools in IDE.

Code quality can also be analyzed out of the IDE, running those tools and using their reports to find out the "hot spots" in your code.

About SonarQube

SonarQube (formerly known as Sonar) is an open-source product which is used to gather several metrics about code quality, put them all in a single dashboard, and provide some tips to help you making your code better, more sustainable, more reliable, less bugged.

SonarCloud.io is the "cloud"-version of SonarQube hosted by SonarSource.

Setting up SonarQube/SonarCloud for Eclipse.org projects

Important.png
Eclipse SonarQube server has been shutdown in early September 2020
Due to relatively low demand and to reduce our maintenance overhead, we retired the Eclipse SonarQube server (https://sonar.eclipse.org/) in early September 2020. We will support projects to migrate to https://sonarcloud.io.
Please open a Bugzilla issue (Product: Community, Component: Sonar) for this.


If your project wants to use SonarCloud.io, please open a Bugzilla issue to request it. Please specify for which exact project this should be setup.

Usage

The project must either have a Jenkins instance or use Travis CI. See how to get a dedicated JIPP. You should first setup a normal build to make sure the project compiles correctly.

In Jenkins your build job needs to be modified as follows:

  • Job config
    • “Use secret text(s) or file(s)
      • Add -> Secret text
        • Select “SonarCloud token”
        • Variable: SONARCLOUD_TOKEN
  • "Prepare SonarQube Scanner environment" option needs to be enabled
  • In Maven build step, Goals:
clean verify -B sonar:sonar
-Dsonar.projectKey=org.eclipse.cbi.examples:cbi-example-parent
-Dsonar.organization=eclipse-cbi
-Dsonar.host.url=${SONAR_HOST_URL}
-Dsonar.login=${SONARCLOUD_TOKEN}

sonar.projectKey and sonar.organization will need to be adapted individually.

Running mvn sonar:sonar in your Maven build will result in the following flow of actions:

  1. The Maven SonarQube plugin will locally analyze code and generate reports from many analyzers
  2. The Maven SonarQube plugin will push those reports to SonarCloud


Several Eclipse projects already have quality reports enabled. You can drill-down on code to see annotations on each class, or navigate through the different widgets on the dashboard to focus on specific issues.

Permissions

By default only Eclipse Webmaster can administrate the analysis projects on SonarCloud.io. If you need admin permissions on some analysis projects, please open a bug on Bugzilla, specifying which analysis projects you want to administrate. The name of the analysis must be close enough to the project's name. If you are not the project lead, don't forget to ask him/her for a +1.

Note

The initial documentation referenced Mickael Istria's blog entry at http://mickaelistria.wordpress.com/2012/10/08/sonar-at-eclipse-org/ . The information in it regarding the Eclipse process is outdated, but the article is still a good reading to understand how SonarQube works and what it can bring to you.

Bugzilla

Back to the top