Sonar

Findbugs should generate exclude file for Maven

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.10
  • Component/s: Findbugs
  • Labels:
    None
  • Number of attachments :
    2

Description

Exclude sources are filtered by Sonar when updating the DB.
This leads to difference between the plugin reports and Sonar.
It would be better to generate the exclude-file for the maven findbugs plugin.

This issue is similar to SONAR-852

  1. Text File
    FindbugsExclusion2.patch
    02/Jun/09 4:29 AM
    10 kB
    Anthonin Bonnefoy
  2. Text File
    findbugsExclusionPatch.patch
    20/May/09 8:34 AM
    10 kB
    Anthonin Bonnefoy

Issue Links

is related to

Improvement - An improvement or enhancement to an existing feature or task. SONAR-854 Sonar should configure exclude sources for checkstyle plugin

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Improvement - An improvement or enhancement to an existing feature or task. SONAR-852 Pmd takes only one exclusion from Sonar

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Freddy Mallet added a comment -

Take a look to this thread of discussions on the Sonar mailing list. If you can provide a patch, will be happy to integrate it.

Show
Freddy Mallet added a comment - Take a look to this thread of discussions on the Sonar mailing list. If you can provide a patch, will be happy to integrate it.
Freddy Mallet made changes -
Field Original Value New Value
Link This issue relates to SONAR-852 [ SONAR-852 ]
Freddy Mallet made changes -
Fix Version/s 1.10 [ 15233 ]
Freddy Mallet made changes -
Link This issue is related to SONAR-854 [ SONAR-854 ]
Hide
Permalink
Anthonin Bonnefoy added a comment -

Olivier is my coworker and asked me to work on this.
I will soon provide a patch for this issue and for SONAR-854.

Show
Anthonin Bonnefoy added a comment - Olivier is my coworker and asked me to work on this. I will soon provide a patch for this issue and for SONAR-854 .
Hide
Permalink
Anthonin Bonnefoy added a comment -

Here is the patch

Few explications because it is a bit tricky and you might not agree with the choices we made.

Findbugs takes an xml file (excludeFilterFile) for its exclusion. This file has the same pattern as the includeFilterFile

 
<FindBugsFilter>
  <Match>
    <Class name="mypackage.MyClass"/>
  </Match>
  <Match>
    <Class name="~org\.apache\..*"/>
  </Match>  
</FindBugsFilter>

The class name parameter can take a java regexp if it begins with '~'

The problem is that Sonar takes a ant pattern for exclusion

**/generated/**
org/apache/**

I created a converter from ant pattern to java regexp, it's a bit dirty but it does the trick.
Basically, it iterates over each character of the pattern and replace :

  • ? with .
  • * with [^\\^\s]* (every character except spaces and \ )
  • ** with .*
  • \ with . (since findbugs takes classes and not path)

Moreover, if the pattern begin with *\ or **\, it is made optional. Thus :

 
*\ at the begining of a pattern is replaced by ([^\\^\s]*\.)?
**\ at the begining of a pattern is replaced by (.*\.)?

This exception is for patterns like 

**/org/apache/**

The users except that all packages like org.apache.* to be filtered.
Without this exception, the regexp would be

.*\.org\.apache\..*

And thus, all packages like org.apache.* would be ignored, since it doesn't start with '.'

I think it is a bit borderline but this exception has reasons.
IMHO, it is more correct to enter something like org/apache/** but since it is used for Pmd or Checkstyle and use path file and not classes, it is simpler to adapt the interpretation for findbugs.

Show
Anthonin Bonnefoy added a comment - Here is the patch Few explications because it is a bit tricky and you might not agree with the choices we made. Findbugs takes an xml file (excludeFilterFile) for its exclusion. This file has the same pattern as the includeFilterFile <FindBugsFilter> <Match> <Class name= "mypackage.MyClass" /> </Match> <Match> <Class name= "~org\.apache\..*" /> </Match> </FindBugsFilter> The class name parameter can take a java regexp if it begins with '~' The problem is that Sonar takes a ant pattern for exclusion **/generated/** org/apache/** I created a converter from ant pattern to java regexp, it's a bit dirty but it does the trick. Basically, it iterates over each character of the pattern and replace : ? with . * with [^\\^\s] * (every character except spaces and \ ) ** with .* \ with . (since findbugs takes classes and not path) Moreover, if the pattern begin with *\ or **\, it is made optional. Thus : *\ at the begining of a pattern is replaced by ([^\\^\s]*\.)? **\ at the begining of a pattern is replaced by (.*\.)? This exception is for patterns like **/org/apache/** The users except that all packages like org.apache.* to be filtered. Without this exception, the regexp would be .*\.org\.apache\..* And thus, all packages like org.apache.* would be ignored, since it doesn't start with '.' I think it is a bit borderline but this exception has reasons. IMHO, it is more correct to enter something like org/apache/** but since it is used for Pmd or Checkstyle and use path file and not classes, it is simpler to adapt the interpretation for findbugs.
Anthonin Bonnefoy made changes -
Attachment findbugsExclusionPatch.patch [ 42082 ]
Hide
Permalink
Anthonin Bonnefoy added a comment -

Erratum : I mistook some \ with /
[The replacement of] \ with . should be read / with .
*\ and **\ should be read */ and **/

Show
Anthonin Bonnefoy added a comment - Erratum : I mistook some \ with / [The replacement of] \ with . should be read / with . *\ and **\ should be read */ and **/
Freddy Mallet made changes -
Assignee Freddy Mallet [ freddy.mallet ]
Hide
Permalink
Freddy Mallet added a comment -

Simon, according to what you've done on the exclusion mechanism could you give your feedback to Anthonin ?
Thanks
Freddy

Show
Freddy Mallet added a comment - Simon, according to what you've done on the exclusion mechanism could you give your feedback to Anthonin ? Thanks Freddy
Freddy Mallet made changes -
Assignee Freddy Mallet [ freddy.mallet ] Simon Brandhof [ simon.brandhof ]
Freddy Mallet made changes -
Assignee Simon Brandhof [ simon.brandhof ] Cédric Munger [ cedric.munger ]
Hide
Permalink
Anthonin Bonnefoy added a comment -

This patch takes account of the case where the user define the suffixe.

  • In Sonar, you have to define file exclusions (java files).
  • In Findbugs, you define java classes (org.codehaus.MyClass).

You have to delete the suffixe for findbugs.
So, in findbugs, the equivalent to 

**/*Test.java

is

~(.*\\.)?[^\\\\^\\s]*Test
Show
Anthonin Bonnefoy added a comment - This patch takes account of the case where the user define the suffixe. In Sonar, you have to define file exclusions (java files). In Findbugs, you define java classes (org.codehaus.MyClass). You have to delete the suffixe for findbugs. So, in findbugs, the equivalent to **/*Test.java is ~(.*\\.)?[^\\\\^\\s]*Test
Anthonin Bonnefoy made changes -
Attachment FindbugsExclusion2.patch [ 42349 ]
Cédric Munger made changes -
Status Open [ 1 ] In Progress [ 3 ]
Hide
Permalink
Cédric Munger added a comment -

Thanks a lot for the patch

Show
Cédric Munger added a comment - Thanks a lot for the patch
Cédric Munger made changes -
Status In Progress [ 3 ] Resolved [ 5 ]
Resolution Fixed [ 1 ]
Simon Brandhof made changes -
Fix Version/s 1.10 [ 15567 ]
Fix Version/s 1.10RC1 [ 15233 ]
Olivier Gaudin made changes -
Status Resolved [ 5 ] Closed [ 6 ]

People

  • Assignee:
    Cédric Munger
    Reporter:
    Anthonin Bonnefoy
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: