findbugstask.java

A static analysis tool to find bugs in Java programs

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "Ant" and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package edu.umd.cs.findbugs.anttask;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Java;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;

import edu.umd.cs.findbugs.ExitCodes;


/**
 * FindBugs in Java class files. This task can take the following
 * arguments:
 * <ul>
 * <li>adjustExperimental (boolean default false)
 * <li>auxAnalyzepath     (class, jar, zip files or directories containing classes to analyze)
 * <li>auxClasspath       (classpath or classpathRef)
 * <li>class              (class, jar, zip or directory containing classes to analyze)
 * <li>classpath          (classpath for running FindBugs)
 * <li>conserveSpace      (boolean - default false)</li>
 * <li>debug              (boolean default false) 
 * <li>effort             (enum min|default|max)</li>
 * <li>excludeFilter      (filter filename)
 * <li>failOnError        (boolean - default false)
 * <li>home               (findbugs install dir)
 * <li>includeFilter      (filter filename)
 * <li>jvm                (Set the command used to start the VM)
 * <li>jvmargs            (any additional jvm arguments)
 * <li>omitVisitors       (collection - comma seperated)
 * <li>onlyAnalyze        (restrict analysis to find bugs to given comma-separated list of classes and packages - See the textui argument description for details)
 * <li>output             (enum text|xml|xml:withMessages|html - default xml)
 * <li>outputFile         (name of output file to create)
 * <li>pluginList         (list of plugin Jar files to load)
 * <li>projectFile        (project filename)
 * <li>projectName        (project name, for display in generated HTML)
 * <li>quietErrors        (boolean - default false)
 * <li>relaxed            (boolean - default false)
 * <li>reportLevel        (enum experimental|low|medium|high)
 * <li>sort               (boolean default true)
 * <li>stylesheet         (name of stylesheet to generate HTML: default is "default.xsl")
 * <li>systemProperty     (a system property to set)
 * <li>timestampNow       (boolean - default false)
 * <li>visitors           (collection - comma seperated)
 * <li>workHard           (boolean default false)
 * </ul>
 * Of these arguments, the <b>home</b> is required.
 * <b>projectFile</b> is required if nested &lt;class&gt; or 
 * &lt;auxAnalyzepath&gt elements are not specified. the 
 * &lt;class&gt; tag defines the location of either a 
 * class, jar file, zip file, or directory containing classes.
 * <p>
 *
 * @author Mike Fagan <a href="mailto:[e-mail]">[e-mail]</a>
 * @author Michael Tamm <a href="mailto:[e-mail]">[e-mail]</a>
 * @author Scott Wolk
 * @version $Revision: 1.48 $
 *
 * @since Ant 1.5
 *
 * @ant.task category="utility"
 */

public class FindBugsTask extends Task {

	private static final String FINDBUGS_JAR = "findbugs.jar";
	private static final long DEFAULT_TIMEOUT = 600000; // ten minutes

	private boolean debug = false;
	private String effort;
	private boolean conserveSpace = false;
	private boolean sorted = true;
	private boolean timestampNow = true;
	private boolean quietErrors = false;
	private boolean failOnError = false;
	private String errorProperty = null;
	private String warningsProperty = null;
	private String projectName = null;
	private boolean workHard = false;
	private boolean relaxed = false;
	private boolean adjustExperimental = false;
	private File homeDir = null;
	private File projectFile = null;
	private File excludeFile = null;
	private File includeFile = null;
	private Path auxClasspath = null;
	private Path auxAnalyzepath = null;
	private Path sourcePath = null;
	private String outputFormat = "xml";
	private String reportLevel = null;
	private String jvm = "";
	private String jvmargs = "";
	private String visitors = null;
	private String omitVisitors = null;
	private String outputFileName = null;
	private String stylesheet = null;
	private List<ClassLocation> classLocations = new ArrayList<ClassLocation>();
	private long timeout = DEFAULT_TIMEOUT;
	private Path classpath = null;
	private Path pluginList = null;
		private List<SystemProperty> systemPropertyList = new ArrayList<SystemProperty>();
		private String onlyAnalyze = null;

	private Java findbugsEngine = null;

	//define the inner class to store class locations
	public static class ClassLocation {
		File classLocation = null;

		public void setLocation( File location ) {
			classLocation = location;
		}

		public File getLocation( ) {
			return classLocation;
		}

		@Override
		public String toString( ) {
		   return classLocation!=null?classLocation.toString():"";
		}

	}

	// A System property to set when FindBugs is run
	public static class SystemProperty {
		private String name;
		private String value;

		public SystemProperty() {
		}

		public void setName(String name) { this.name = name; }
		public void setValue(String value) { this.value = value; }

		public String getName() { return name; }
		public String getValue() { return value; }
	}

	/**
	 * Set any specific jvm args
	 */
	public void setJvmargs(String args) {
		this.jvmargs = args;
	}

	/**
	 *  Set the command used to start the VM 
	 */
	public void setJvm(String jvm) {
		this.jvm = jvm;
	}

	/**
	 * Set the workHard flag.
	 * 
	 * @param workHard true if we want findbugs to run with workHard option enabled
	 */
	public void setWorkHard(boolean workHard){
		this.workHard = workHard;   
	}

	/**
	 * Set the relaxed flag.
	 * 
	 * @param relaxed true if we want findbugs to run with relaxed option enabled
	 */
	public void setRelaxed(boolean relaxed) {
		this.relaxed = relaxed;
	}

	/**
	 * Set the adjustExperimental flag
	 * 
	 * @param adjustExperimental true if we want experimental bug patterns to have lower priority
	 */
	public void setAdjustExperimental(boolean adjustExperimental){
		this.adjustExperimental = adjustExperimental;
	}

	/**
	 * Set the specific visitors to use 
	 */
	public void setVisitors(String commaSeperatedString) {
		this.visitors = commaSeperatedString;
	}

	/**
	 * Set the specific visitors to use 
	 */
	public void setOmitVisitors(String commaSeperatedString) {
		this.omitVisitors = commaSeperatedString;
	}

	/**
	 * Set the home directory into which findbugs was installed
	 */
	public void setHome(File homeDir) {
		this.homeDir = homeDir;
	}

	/**
	 * Set the output format
	 */
	public void setOutput(String format) {
		this.outputFormat = format;
	}

	/**
	 * Set the stylesheet filename for HTML generation.
	 */
	public void setStylesheet(String stylesheet) {
		this.stylesheet = stylesheet;
	}

	/**
	 * Set the report level 
	 */
	public void setReportLevel(String level) {
		this.reportLevel = level;
	}

	/**
	 * Set the sorted flag
	 */
	public void setSort(boolean flag) {
		this.sorted = flag;
	}
	/**
	 * Set the timestampNow flag
	 */
	public void setTimestampNow(boolean flag) {
		this.timestampNow = flag;
	}

	/**
	 * Set the quietErrors flag
	 */
	public void setQuietErrors(boolean flag) {
		this.quietErrors = flag;
	}

	/**
	 * Set the failOnError flag
	 */
	public void setFailOnError(boolean flag) {
		this.failOnError = flag;
	}

	/**
	 * Tells this task to set the property with the
	 * given name to "true" when there were errors.
	 */
	public void setErrorProperty(String name) {
		this.errorProperty = name;
	}

	/**
	 * Tells this task to set the property with the
	 * given name to "true" when bugs were found.
	 */
	public void setWarningsProperty(String name) {
		this.warningsProperty = name;
	}    

	/**
	 * Set the debug flag
	 */
	public void setDebug(boolean flag) {
		this.debug = flag;
	}

	/**
	 * Set effort level.
	 * 
	 * @param effort the effort level
	 */
	public void setEffort(String effort) {
		this.effort = effort;
	}

	/**
	 * Set project name
	 * 
	 * @param projectName the project name
	 */
	public void setProjectName(String projectName) {
		this.projectName = projectName;
	}

	/**
	 * Set the conserveSpace flag.
	 */
	public void setConserveSpace(boolean flag) {
		this.conserveSpace = flag;
	}

	/**
	 * Set the exclude filter file 
	 */
	public void setExcludeFilter(File filterFile) {
		this.excludeFile = filterFile;
	}

	/**
	 * Set the exclude filter file 
	 */
	public void setIncludeFilter(File filterFile) {
		this.includeFile = filterFile;
	}

	/**
	 * Set the project file 
	 */
	public void setProjectFile(File projectFile) {
		this.projectFile = projectFile;
	}

	/**
	 * the auxclasspath to use.
	 */
	public void setAuxClasspath(Path src) {
		boolean nonEmpty = false;

		String[] elementList = src.list();
		for (String anElementList : elementList) {
			if (!anElementList.equals("")) {
				nonEmpty = true;
				break;
			}
		}

		if (nonEmpty) {
			if (auxClasspath == null) {
				auxClasspath = src;
			} else {
				auxClasspath.append(src);
			}
		}
	}

	/**
	 * Path to use for auxclasspath.
	 */
	public Path createAuxClasspath() {
		if (auxClasspath == null) {
			auxClasspath = new Path(getProject());
		}
		return auxClasspath.createPath();
	}

	/**
	 * Adds a reference to a sourcepath defined elsewhere.
	 */
	public void setAuxClasspathRef(Reference r) {
		createAuxClasspath().setRefid(r);
	}

	/**
	 * the auxAnalyzepath to use.
	 */
	public void setAuxAnalyzepath(Path src) {
		boolean nonEmpty = false;