Sonar Clirr Plugin

Name	Sonar Clirr Plugin
Authors	Mike R. Haller (http://www.mhaller.de/)
Homepage	http://docs.codehaus.org/display/SONAR/Sonar+Clirr+Plugin
Jira	http://jira.codehaus.org/browse/SONARPLUGINS/component/13867
Most Recent Version	0.2-SNAPSHOT
Availability
State	Under development
License	LGPL v3
Download sources	http://svn.codehaus.org/sonar-plugins/trunk/clirr/
Download jar	http://jira.codehaus.org/secure/attachment/47894/sonar-clirr-plugin-0.2-SNAPSHOT.jar
Continuous Build	http://bamboo.ci.codehaus.org/browse/SONAR-CLIRR

Compatibility with Sonar

Plugin versions	1.8	1.12	2.0.1
0.1-SNAPSHOT
0.2-SNAPSHOT

Description / Features

Clirr is a tool that checks Java libraries for binary and source compatibility with older releases. In a continuous integration process Clirr can automatically prevent accidental introduction of binary or source compatibility problems.

This Sonar plugin measures the number of API break violations between the current sources and the last known stable version of the library in the Maven repository.

Usage & Installation

Stop Sonar Web server
Place the jar into the /extensions/plugins directory
Restart Sonar Web server
Enable clirr plugin in Project > Settings > Clirr by setting [sonar.clirr.execute property to true
Enable the following three violation rules in your Quality Profile (Configuration > Quality Profiles).
- API Change adds new feature without breaking anything
- API Change breaks the backward binary compatibility
- API Change might change runtime expected behavior
Run mvn sonar:sonar on your Maven project
Go to Sonar Dashboard and look at "API Changes" section

Known limitations

As Clirr does not report line numbers, violations cannot be displayed in the correct location within the source code
Violations of deleted resources/classes are assigned to the project