To fully take advantage of SonarQube in Eclipse
is recommended that
Setting Sonar Servers
Sonar your project is already being analyzed on a regular basis by SonarQube. Indeed, you'll get features such as only displaying new issues that you have introduced.
However, if you want to give SonarQube in Eclipse a quick try, you just have to first declare your project through the SonarQube web interface.
Setting SonarQube Servers
Go to Window > Preferences > SonarQube > Servers.
SonarQube in Eclipse is pre-configured to access a local Sonar SonarQube server listening on http://localhost:9000/. To use another address, you first need to define this server by using the Eclipse global Preferences window:
Linking Projects to Sonar Servers
Once the Sonar server(s) is(are) You can edit this server, delete it or add new ones.
Linking a Project to One Analyzed on a SonarQube Server
Linking for the first time
Once the SonarQube server is defined, the next step is to link your Eclipse projects project with projects a project defined and analyzed on Sonar server(s). This linkage operation can be done by right-clicking on the the project in the "Package explorer", and then by choosing "Configure -> Associate with Sonar...":
In some cases the Eclipse project may not be automatically associated to a Sonar project. If that happens, you need to manually enter the groupId and the artifactId of the Sonar project.
Unlinking a Project from Sonar Server
This operation can be done by right-clicking on the the project in the "Package explorer", and then by choosing "Configure -> Remove Sonar Nature":
Configuring Mylin to deal with Reviews
Creating a Sonar Task Repository
To start using this feature, a new Sonar task repository has to be created (see the Mylyn documentation page for more information):
Validate Settings returns Authentication credentials are valid even if you have not entered correct credentials (Username/Password).
So, make sure to correctly deal with your credentials otherwise you will not be able to retrieve any review.
You new repository should now appear in the Task Repositories view:
Creating a Query
To browse the reviews, you can create as many queries as you wish:
Here's an example of a query that retrieves all the reviews assigned to you on every project:
The reviews should now appear in the Task List view:
on this SonarQube server.
To do so, right-click on the project in the Project Explorer, and then Configure > Associate with SonarQube...:
In the SonarQube project text field, start typing the name of the project and select it in the list box:
Click on Finish. Your project is now associated to one analyzed on your SonarQube server.
|Note that for Maven projects, the association is performed automatically.|
At any time, it is possible to change the project association.
To do so, right-click on the project in the Project Explorer, and then SonarQube > Change Project Association...:
Unlinking a Project
To do so, right-click on the project in the Project Explorer, and then SonarQube > Remove SonarQube Nature:
Additional settings (such as markers for new issues) are available through Window > Preferences > SonarQube:
You are now all set with configuration and you can start using Sonar SonarQube in Eclipse.