PL/SQL Cop for SonarQube
Introduction
PL/SQL Cop for SonarQube is a plugin for SonarQube. The plugin analyses SQL and PL/SQL code and calculates various metrics and checks the code for compliance of the Trivadis PL/SQL & SQL Coding Guidelines Version 3.6. Behind the scenes the plugin calls the PL/SQL Cop command line utility for the static code analysis.
A static code analysis is typically initiated as part of an continuous integration setup, e.g. at the end of a Jenkins or Hudson build job. SonarQube stores the result of the analysis in a relational database. Supported are HSQLDB, PostgreSQL, MySQL, Microsoft SQL Server and Oracle Database, of course.
Since every analysis is stored as a snapshot in the SonarQube repository the improvement or the decrease of the code quality may be monitored very well. Use SonarQube and the PL/SQL Cop plugin if you care about your PL/SQL code quality.
Examples
Setup a build job with a standalone SonarQube analysis at the end of the job. Here’s an example within a Jenkins build job:
Important are the analysis properties. The mandatory ones are sonar.projectKey, sonar.projectName, sonar.projectVersion and sonar.sources. You may defined them as shown above or within a sonar.properties file in the source folder. See the SonarQube documentation for more information.
The build job is typically started after a change in the software configuration system such as GIT, SVN or CVS or other relevant events. You may even trigger the build manually. The log of such a build job looks as follows:
At the bottom of a build log you find a link to the SonarQube project dashboard. Click on it and the following project dashboard is shown:
You see that 2 blocker issues have been found in the guideline project. Click on “2” to drill down to the blocker issues.
Click on the arrow on the right side of an issue to drill down to the source code.
Click on the three dots after the issue text to get more information about the violated guideline.
There are a lot more analysis available in SonarQube. Get your copy of PL/SQL Cop and PL/SQL Cop for SonarQube now.
Installation
Copy the downloaded sonar-plsql-cop-plugin-x.x.x.x.jar file into the extensions/plugins folder of your SonarQube installation and restart the SonarQube server. Login as admin, click on “Settings” in the main menu bar and configure the “Trivadis PL/SQL Cop” section as shown below
Press “Save Trivadis PL/SQL Cop Settings” to the configuration.
The path to the PL/SQL Cop command line utility and the license file must be valid for the machine doing the analysis with SonarQube Scanner. If you are using Jenkins then PL/SQL Cop command line utility must be installed on every Jenkins node.
Releases
It’s important to note, that each version of PL/SQL Cop for SonarQube requires specific versions of SonarQube. Updates are considered only for SonarQube LTS (long term support) versions.
| Plugin Version | Supported SonarQube Version | Required CLI Version |
|---|---|---|
| 4.5.0.1 | 4.5 LTS - 5.1.2 | 2.3.x |
| 5.6.0.2 | 5.6 LTS - 6.6 | 2.3.x |
| 6.7.0.4 | 6.7 LTS - 7.6 | 2.3.x |
| 7.9.0.1 | 7.9 LTS - 8.0 | 2.3.x |
You find all releases and release information here.
Issues
Please file your bug reports, enhancement requests, questions and other support requests within Github's issue tracker.
Frequently Asked Questions
see Frequently Asked Questions.
Further Information
Please find further information about PL/SQL Cop on the Trivadis website.
License
The preview/trial version of PL/SQL Cop for SonarQube is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. You may obtain a copy of the License at https://creativecommons.org/licenses/by-nc-nd/3.0/.
The trial/preview version provides full functionality but is limited in time and volume.
For production use a separate software license agreement is required.