Publish Findbugs Report

Version 9 by Robin Shen
on Aug 06, 2009 18:21.

<< Changes from 8 to 9
compared with
Current by Robin Shen
on Aug 06, 2009 18:29.

 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 2 changes. View first change.

 To add [Findbugs|http://findbugs.sourceforge.net/index.html] report, you only need two steps:
  To publish [Findbugs|http://findbugs.sourceforge.net/index.html] report, you only need two steps:
 # Generate Findbugs *XML* report from [Ant|http://ant.apache.org] or [Maven|http://maven.apache.org] or any other build tool.
 # Publish Findbugs report in the [configuration|Working with Configurations].
  # Add Findbugs report publish step by choosing menu item _Publish -> Findbugs Reports_ from the step menu.
  
 h2. Generate Findbugs Report
  
 QuickBuild will NOT generate [Findbugs|http://findbugs.sourceforge.net/index.html] report automatically, so first make sure the [Findbugs|http://findbugs.sourceforge.net/index.html] report is produced by [ANT|http://ant.apache.org] or by any other build tool. The following example shows how to generate Findbugs test results with [Ant Findbugs task|http://findbugs.sourceforge.net/manual/anttask.html]:
 {code:xml|title=Findbugs report target in build.xml}
  <taskdef name="findbugs" classname="edu.umd.cs.findbugs.anttask.FindBugsTask"
  classpath="${findbugs.utils.dir}/findbugs-ant.jar"/>
  
  <target name="findbugs" depends="dist,findbugs-xml,findbugs-html"/>
  <target name="findbugs-xml">
  <mkdir dir="${findbugs.reports}"/>
  <findbugs home="${findbugs.home}"
  output="xml:withMessages"
  outputFile="${findbugs.reports}/findbugs.xml" jvmargs="-Xmx512m">
  <auxClasspath path="${lib.dir}" />
  <sourcePath path="${src.dir}" />
  <class location="${dist.dir}/${exe.name}.jar" />
  </findbugs>
  </target>
 {code}
 The code snippet will generate the XML reports for each test case, and the reports will be captured to '$\{findbugs.reports\}' directory. *Note. The _output_ format should be set to 'xml:withMessages'.*
  
 h2. Publish Findbugs Report
  
 Just like all other [build reports|Publish Build Reports], you add Findbugs report by [adding a publish step|Working With Step] in a [configuration|Working with Configurations]. When you add publish Findbugs Report step, the following screen will be displayed:
  
 !Screenshots^report_publish_step.png!
  
 In Report Files/Pattern field, QuickBuild uses Ant style file patterns to collect the reports, and the directory you specified is *relative* to the [workspace|Workspace Directory] directory.