Introduction
FindBugs is a static analysis tool to find bugs in Java programs.
Step 1 - Add FindBugs to your build
For information on adding FindBugs to your Ant build, please refer to the FindBugs website.
Be sure to use an output directory which can later be merged into the CruiseControl log. If you will run FindBugs against multiple targets within the same build script, be certain to use a unique name for each run. For example, "<project-name>-fb.xml".
Also ensure you use the extended XML output, as follows:
<findbugs home="${findbugs.home}"
output="xml:withMessages"
outputFile="findbugs/${projectname}-fb.xml">
.
.
.
</findbugs>
Step 2 - Merge the results into your CC log
Add a merge child element to your project(s)' log element. If you wish, you can filter based on the extension you used above.
<log dir="${logdir}">
<merge dir="${builddir}/findbugs" pattern="*-fb.xml"/>
</log>
Step 3 - Add formatting info to cruisecontrol.css
This CSS code is based on stylesheet information supplied with the FindBugs XSL scripts:
.findbugs-oddrow { background-color:#CCCCCC }
.findbugs-data { font-family:arial,helvetica,sans-serif; font-size:8pt; color:#000000; }
.findbugs-sectionheader { background-color:#000066; font-family:arial,helvetica,sans-serif; font-size:10pt; color:#FFFFFF; }
.findbugs-tablerow0 { font-family:arial,helvetica,sans-serif; font-size:8pt; color:#000000; background-color: #FFFFFF; }
.findbugs-tablerow1 { font-family:arial,helvetica,sans-serif; font-size:8pt; color:#000000; background-color:#CCCCCC; }
.findbugs-detailrow0 { font-family:arial,helvetica,sans-serif; font-size:8pt; color:#000000; background-color: #FFFFFF; }
.findbugs-detailrow1 { font-family:arial,helvetica,sans-serif; font-size:8pt; color:#000000; background-color:#CCCCCC; }
.findbugs-tableheader { font-family:arial,helvetica,sans-serif; font-size:9pt; font-weight: bold; color:#000080; background-color:#CCDDDD; }
.findbugs-warningtable tr.findbugs-tablerow0:hover, .findbugs-warningtable tr.findbugs-tablerow1:hover { background-color: #aaffaa; }
.findbugs-priority-1 { color: red; font-weight: bold; }
.findbugs-priority-2 { color: orange; font-weight: bold; }
.findbugs-priority-3 { color: green; font-weight: bold; }
.findbugs-priority-4 { color: blue; font-weight: bold; }
Step 4 - Add a new tab in main.jsp
The next three steps add a new tab to CruiseControl, which gives a detailed report of the FindBugs results.
.
.
.
<cruisecontrol:tabsheet>
<tr>
<td bgcolor="white" >
<cruisecontrol:tab name="buildResults" label="Build Results" >
<%@ include file="buildresults.jsp" %>
</cruisecontrol:tab>
<cruisecontrol:tab name="findbugs" label="FindBugs" >
<%@ include file="findbugs.jsp" %>
</cruisecontrol:tab>
.
.
.
Step 5 - Create findbugs.jsp
<%@ taglib uri="/WEB-INF/cruisecontrol-jsp11.tld" prefix="cruisecontrol"%>
<cruisecontrol:xsl xslFile="/xsl/findbugs-details.xsl"/>
Step 6 - Create findbugs-details.xsl in the xsl directory
The following script is based on the default.xsl file supplied with FindBugs:
<?xml version="1.0" encoding="UTF-8"?>
<!--
FindBugs - Find bugs in Java programs
Copyright (C) 2004,2005 University of Maryland
Copyright (C) 2005, Chris Nappin
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<!--
A simple XSLT stylesheet to transform FindBugs XML results
annotated with messages into HTML.
If you want to experiment with modifying this stylesheet,
or write your own, you need to generate XML output from FindBugs
using a special option which lets it know to include
human-readable messages in the XML. Invoke the findbugs script
as follows:
findbugs -textui -xml:withMessages -project myProject.fb > results.xml
Then you can use your favorite XSLT implementation to transform
the XML output into HTML. (But don't use xsltproc. It generates well-nigh
unreadable output, and generates incorrect output for the
<script> element.)
Authors:
David Hovemeyer
Chris Nappin (summary table)
Nicholas Cull (adapted for CruiseControl)
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="html" />
<xsl:template match="/">
<xsl:apply-templates select="." mode="findbugs"/>
</xsl:template>
<xsl:template match="/" mode="findbugs">
<xsl:variable name="unique-catkey" select="/cruisecontrol/BugCollection/BugCategory/@category"/>
<script type="text/javascript">
function toggleRow(elid) {
if (document.getElementById) {
element = document.getElementById(elid);
if (element) {
if (element.style.display == 'none') {
element.style.display = 'block';
//window.status = 'Toggle on!';
} else {
element.style.display = 'none';
//window.status = 'Toggle off!';
}
}
}
}
</script>
<xsl:if test="count(cruisecontrol/BugCollection) = 0">
FindBugs was not run against this project.
</xsl:if>
<xsl:if test="count(cruisecontrol/BugCollection) > 0">
<table class="header" align="center" border="0" cellpadding="8" cellspacing="0" width="98%">
<tr>
<th class="big">FindBugs Report</th>
</tr>
</table>
<table align="center" cellpadding="8" cellspacing="0" border="0" width="98%">
<tr>
<td class="findbugs-sectionheader">Metrics</td>
</tr>
<xsl:apply-templates select="/cruisecontrol/BugCollection/FindBugsSummary" mode="findbugs"/>
<tr>
<td> </td>
</tr>
<tr>
<td class="findbugs-sectionheader">Summary</td>
</tr>
<tr>
<td>
<table width="500" cellpadding="5" cellspacing="2">
<tr class="findbugs-tableheader">
<th align="left">Warning Type</th>
<th align="right">Number</th>
</tr>
<xsl:for-each select="$unique-catkey">
<xsl:sort select="." order="ascending"/>
<xsl:variable name="catkey" select="."/>
<xsl:variable name="catdesc" select="/cruisecontrol/BugCollection/BugCategory[@category=$catkey]/Description"/>
<xsl:variable name="styleclass">
<xsl:choose>
<xsl:when test="position() mod 2 = 1">findbugs-tablerow0</xsl:when>
<xsl:otherwise>findbugs-tablerow1</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<tr class="{$styleclass}">
<td><xsl:value-of select="$catdesc"/> Warnings</td>
<td align="right"><xsl:value-of select="count(/cruisecontrol/BugCollection/BugInstance[@category=$catkey])"/></td>
</tr>
</xsl:for-each>
<xsl:variable name="styleclass">
<xsl:choose>
<xsl:when test="count($unique-catkey) mod 2 = 0">findbugs-tablerow0</xsl:when>
<xsl:otherwise>findbugs-tablerow1</xsl:otherwise>
</xsl:choose>
</xsl:variable>
<tr class="{$styleclass}">
<td><b>Total</b></td>
<td align="right"><b><xsl:value-of select="count(/cruisecontrol/BugCollection/BugInstance)"/></b></td>
</tr>
</table>
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td class="findbugs-sectionheader">Warnings</td>
</tr>
<tr class="findbugs-tablerow0">
<td>Click on a warning row to see full context information.</td>
</tr>
<tr>
<td>
<table align="center" cellpadding="8" cellspacing="0" border="0" width="98%">
<xsl:for-each select="$unique-catkey">
<xsl:sort select="." order="ascending"/>
<xsl:variable name="catkey" select="."/>
<xsl:variable name="catdesc" select="/cruisecontrol/BugCollection/BugCategory[@category=$catkey]/Description"/>
<xsl:call-template name="generateWarningTable">
<xsl:with-param name="warningSet" select="/cruisecontrol/BugCollection/BugInstance[@category=$catkey]"/>
<xsl:with-param name="sectionTitle"><xsl:value-of select="$catdesc"/> Warnings</xsl:with-param>
<xsl:with-param name="sectionId">Warnings_<xsl:value-of select="$catkey"/></xsl:with-param>
</xsl:call-template>
</xsl:for-each>
</table>
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<td class="findbugs-sectionheader"><a name="Details">Details</a></td>
</tr>
<xsl:apply-templates select="/cruisecontrol/BugCollection/BugPattern" mode="findbugs">
<xsl:sort select="@abbrev"/>
<xsl:sort select="ShortDescription"/>
</xsl:apply-templates>
<tr>
<td> </td>
</tr>
</table>
</xsl:if>
</xsl:template>
<xsl:template match="BugInstance" mode="findbugs">
<xsl:variable name="warningId"><xsl:value-of select="generate-id()"/></xsl:variable>
<tr class="findbugs-tablerow{position() mod 2}" onclick="toggleRow('{$warningId}');">
<td>
<span>
<xsl:attribute name="class">findbugs-priority-<xsl:value-of select="@priority"/></xsl:attribute>
<xsl:value-of select="@abbrev"/>
</span>
</td>
<td>
<xsl:value-of select="LongMessage"/>
</td>
</tr>
<tr class="findbugs-detailrow{position() mod 2}">
<td/>
<td>
<p id="{$warningId}" style="display: none;">
Bug type <xsl:value-of select="@type"/>
<xsl:for-each select="./*/Message">
<br/><xsl:value-of select="text()" disable-output-escaping="no"/>
</xsl:for-each>
</p>
</td>
</tr>
</xsl:template>
<xsl:template match="BugPattern" mode="findbugs">
<tr>
<td>
<table width="100%" cellspacing="0">
<tr class="findbugs-tableheader">
<td><a name="{@type}"><xsl:value-of select="@type"/>: <xsl:value-of select="ShortDescription"/></a></td>
</tr>
<tr>
<td class="findbugs-tablerow0">
<xsl:value-of select="Details" disable-output-escaping="yes"/>
</td>
</tr>
</table>
</td>
</tr>
</xsl:template>
<xsl:template name="generateWarningTable">
<xsl:param name="warningSet"/>
<xsl:param name="sectionTitle"/>
<xsl:param name="sectionId"/>
<tr>
<td class="findbugs-sectionheader">
<a name="{$sectionId}"><xsl:value-of select="$sectionTitle"/></a>
</td>
</tr>
<tr>
<td>
<table class="findbugs-warningtable" width="100%" cellspacing="0">
<tr class="findbugs-tableheader">
<th align="left">Code </th>
<th align="left">Warning</th>
</tr>
<xsl:apply-templates select="$warningSet" mode="findbugs">
<xsl:sort select="@abbrev"/>
<xsl:sort select="Class/@classname"/>
</xsl:apply-templates>
</table>
</td>
</tr>
</xsl:template>
<xsl:template match="FindBugsSummary" mode="findbugs">
<xsl:variable name="kloc" select="@total_size div 1000.0"/>
<xsl:variable name="format" select="'#######0.00'"/>
<tr class="findbugs-tablerow0">
<td>
<xsl:value-of select="@total_size"/> lines of code analysed,
in <xsl:value-of select="@total_classes"/> classes,
in <xsl:value-of select="@num_packages"/> packages.
</td>
</tr>
<tr>
<td>
<table width="500" cellpadding="5" cellspacing="2">
<tr class="findbugs-tableheader">
<th align="left">Metric</th>
<th align="right">Total</th>
<th align="right">Density*</th>
</tr>
<tr class="findbugs-tablerow0">
<td>High Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_1"/></td>
<td align="right"><xsl:value-of select="format-number(@priority_1 div $kloc, $format)"/></td>
</tr>
<tr class="findbugs-tablerow1">
<td>Medium Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_2"/></td>
<td align="right"><xsl:value-of select="format-number(@priority_2 div $kloc, $format)"/></td>
</tr>
<xsl:if test="@priority_3">
<tr class="findbugs-tablerow0">
<td>Low Priority Warnings</td>
<td align="right"><xsl:value-of select="@priority_3"/></td>
<td align="right"><xsl:value-of select="format-number(@priority_3 div $kloc, $format)"/></td>
</tr>
</xsl:if>
<xsl:variable name="totalClass">
<xsl:choose>
<xsl:when test="@priority_3"><xsl:text>findbugs-tablerow1</xsl:text></xsl:when>
<xsl:otherwise><xsl:text>findbugs-tablerow0</xsl:text></xsl:otherwise>
</xsl:choose>
</xsl:variable>
<tr class="{$totalClass}">
<td><b>Total Warnings</b></td>
<td align="right"><b><xsl:value-of select="@total_bugs"/></b></td>
<td align="right"><b><xsl:value-of select="format-number(@total_bugs div $kloc, $format)"/></b></td>
</tr>
</table>
</td>
</tr>
<tr class="findbugs-tablerow0">
<td><i>(* Defects per Thousand lines of non-commenting source statements)</i></td>
</tr>
</xsl:template>
</xsl:stylesheet>
Step 7 - Add a new section in buildresults.xsl
The next two steps add a FindBugs summary report to the build results tab.
.
.
.
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="maven.xsl"/>
<xsl:import href="nant.xsl"/>
<xsl:import href="checkstyle.xsl"/>
<xsl:import href="pmd.xsl"/>
<xsl:import href="findbugs.xsl"/>
.
.
.
<xsl:template match="/">
<p><xsl:apply-templates select="$cruisecontrol.list" mode="maven"/></p>
<p><xsl:apply-templates select="$cruisecontrol.list" mode="nant"/></p>
<p><xsl:apply-templates select="$cruisecontrol.list" mode="checkstyle"/></p>
<p><xsl:apply-templates select="$cruisecontrol.list" mode="pmd"/></p>
<p><xsl:apply-templates select="$cruisecontrol.list" mode="findbugs"/></p>
.
.
.
Step 8 - Create findbugs.xsl in the xsl directory
Again, there are many possibilities here. This is a simple example:
<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="html"/>
<!-- Any FindBugs error with a priority below this threshold are considered
warnings and not errors
-->
<xsl:param name="findbugs.warning.threshold" select="3"/>
<xsl:template match="/" mode="findbugs">
<xsl:apply-templates select="/cruisecontrol/BugCollection" mode="findbugs"/>
</xsl:template>
<xsl:template match="BugCollection" mode="findbugs">
<xsl:variable name="total.error.count" select="count(BugInstance[@priority < $findbugs.warning.threshold])" />
<xsl:variable name="total.warning.count" select="count(BugInstance)" />
<table align="center" cellpadding="2" cellspacing="0" border="0" width="98%">
<colgroup>
<col width="45%"></col>
<col width="5%"></col>
<col width="50%"></col>
</colgroup>
<tr>
<td class="findbugs-sectionheader" colspan="3">
FindBugs errors/warnings (<xsl:value-of select="$total.error.count"/>
/ <xsl:value-of select="$total.warning.count"/>)
</td>
</tr>
<xsl:for-each select="BugInstance">
<tr>
<xsl:if test="position() mod 2 = 1">
<xsl:attribute name="class">findbugs-oddrow</xsl:attribute>
</xsl:if>
<td class="findbugs-data"><xsl:value-of select="Class/@classname" /></td>
<td class="findbugs-data" align="right"><xsl:value-of select="SourceLine[1]/@start" /></td>
<td class="findbugs-data"><xsl:value-of select="ShortMessage/text()" /></td>
</tr>
</xsl:for-each>
</table>
</xsl:template>
<xsl:template match="*" mode="findbugs"/>
<xsl:template match="/">
<xsl:apply-templates select="." mode="findbugs"/>
</xsl:template>
</xsl:stylesheet>
Step 9 - Add a warning count to metrics.jsp
Edit the metric.jsp page to add the FindBugs bug count to the coding violations chart:
.
.
.
<jsp:useBean id="xpathData" class="net.sourceforge.cruisecontrol.chart.XPathChartData" />
<%
xpathData.add("CheckStyle", "count(/cruisecontrol/checkstyle/file/error)");
xpathData.add("FindBugs", "count(/cruisecontrol/BugCollection/BugInstance)");
xpathData.add("PMD", "count(/cruisecontrol/pmd/file/violation)");
xpathData.add("Javadoc", "count(/cruisecontrol/build);
%>
.
.
.
Screenshots
The FindBugs tab added to CruiseControl.
FindBugs added to the coding metrics of CruiseControl.
Thank you, this is very good.
Also thanks, very good instructions. I've added a script, modified from the "details" script, to support separate projects in build. Only modification to above instructions is that it requires "findbugs-projectheader" added to the cruisecontrol.css.