[LUCENE-3973] Incorporate PMD / FindBugs

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Won't Fix
• Component/s: general/build
• Labels: newdev
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Chris Male
• Created: 12/Apr/12 02:36
• Updated: 28/Aug/22 13:14
• Resolved: 14/Jun/21 18:46

Description

This has been touched on a few times over the years. Having static analysis as part of our build seems like a big win. For example, we could use PMD to look at System.out.println statements like discussed in LUCENE-3877 and we could possibly incorporate the nocommit / @author checks as well.

There are a few things to work out as part of this:

• Should we use both PMD and FindBugs or just one of them? They look at code from different perspectives (bytecode vs source code) and target different issues. At the moment I'm in favour of trying both but that might be too heavy handed for our needs.
• What checks should we use? There's no point having the analysis if it's going to raise too many false-positives or problems we don't deem problematic.
• How should the analysis be integrated in our build? Need to work out when the analysis should run, how it should be incorporated in Ant and/or Maven, what impact errors should have.

Issue Links

• relates to: LUCENE-7631 Enforce javac warnings
• relates to: LUCENE-9143 Add more static analysis and clean up resulting warnings/errors
• relates to: SOLR-143 Support for PMD and Clover