org.codehaus.mojo.findbugs.FindbugsViolationCheckMojo.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of findbugs-maven-plugin Show documentation
Show all versions of findbugs-maven-plugin Show documentation
This Plug-In generates reports based on the FindBugs Library
package org.codehaus.mojo.findbugs
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.artifact.repository.ArtifactRepository
import org.apache.maven.artifact.resolver.ArtifactResolver
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.doxia.tools.SiteTool
import org.apache.maven.plugin.AbstractMojo
import org.apache.maven.plugin.MojoExecutionException
import org.apache.maven.plugins.annotations.Component
import org.apache.maven.plugins.annotations.Execute
import org.apache.maven.plugins.annotations.LifecyclePhase
import org.apache.maven.plugins.annotations.Mojo
import org.apache.maven.plugins.annotations.Parameter
import org.apache.maven.plugins.annotations.ResolutionScope
import org.apache.maven.project.MavenProject
import org.codehaus.plexus.resource.ResourceManager
import org.codehaus.plexus.util.FileUtils
/**
* Fail the build if there were any FindBugs violations in the source code.
* An XML report is put out by default in the target directory with the errors.
* To see more documentation about FindBugs' options, please see the FindBugs
Manual..
*
* @since 2.0
*
* @author Garvin LeClaire
* @version $Id: FindbugsViolationCheckMojo.groovy gleclaire $
*/
@Mojo( name = "check", defaultPhase = LifecyclePhase.VERIFY, requiresDependencyResolution = ResolutionScope.TEST, requiresProject = true, threadSafe = true )
@Execute( goal = "findbugs")
class FindbugsViolationCheckMojo extends AbstractMojo {
/**
* Location where generated html will be created.
*
*/
@Parameter( defaultValue = '${project.reporting.outputDirectory}', required = true )
File outputDirectory
/**
* Turn on and off xml output of the Findbugs report.
*
* @since 1.0.0
*/
@Parameter( defaultValue = "false", property="findbugs.xmlOutput", required = true )
boolean xmlOutput
/**
* Specifies the directory where the xml output will be generated.
*
* @since 1.0.0
*/
@Parameter( defaultValue = '${project.build.directory}', required = true )
File xmlOutputDirectory
/**
* Location where generated html will be created.
*
*/
/**
* This has been deprecated and is on by default.
*
* @since 1.2.0
*
*/
@Deprecated
@Parameter( defaultValue = "true" )
boolean findbugsXmlOutput
/**
* Specifies the directory where the findbugs native xml output will be generated.
*
* @since 1.2.0
*/
@Parameter( defaultValue = '${project.build.directory}', required = true )
File findbugsXmlOutputDirectory
/**
* Doxia Site Renderer.
*
* @component
*
*/
@Component( role = Renderer.class)
Renderer siteRenderer
/**
* Directory containing the class files for FindBugs to analyze.
*
* @required
*/
@Parameter( defaultValue = '${project.build.outputDirectory}', required = true )
File classFilesDirectory
/**
* Directory containing the test class files for FindBugs to analyze.
*
*/
@Parameter( defaultValue = '${project.build.testOutputDirectory}', required = true )
File testClassFilesDirectory
/**
* Location of the Xrefs to link to.
*
*/
@Parameter( defaultValue = '${project.reporting.outputDirectory}/xref' )
File xrefLocation
/**
* Location of the Test Xrefs to link to.
*
*/
@Parameter( defaultValue = '${project.reporting.outputDirectory}/xref-test' )
File xrefTestLocation
/**
* The directories containing the sources to be compiled.
*
*/
@Parameter( defaultValue = '${project.compileSourceRoots}', required = true, readonly = true )
List compileSourceRoots
/**
* The directories containing the test-sources to be compiled.
*
* @since 2.0
*/
@Parameter( defaultValue = '${project.testCompileSourceRoots}', required = true, readonly = true )
List testSourceRoots
/**
* Run Findbugs on the tests.
*
* @since 2.0
*/
@Parameter( defaultValue = "false", property="findbugs.includeTests" )
boolean includeTests
/**
* List of artifacts this plugin depends on. Used for resolving the Findbugs coreplugin.
*
*/
@Parameter( property="plugin.artifacts", required = true, readonly = true )
ArrayList pluginArtifacts
/**
* The local repository, needed to download the coreplugin jar.
*
*/
@Parameter( property="localRepository", required = true, readonly = true )
ArtifactRepository localRepository
/**
* Remote repositories which will be searched for the coreplugin jar.
*
*/
@Parameter( property="project.remoteArtifactRepositories", required = true, readonly = true )
List remoteArtifactRepositories
/**
* Maven Project
*
*/
@Parameter( property="project", required = true, readonly = true )
MavenProject project
/**
* Encoding used for xml files. Default value is UTF-8.
*
*/
@Parameter( defaultValue = "UTF-8", readonly = true )
String xmlEncoding
/**
* The file encoding to use when reading the source files. If the property project.build.sourceEncoding
* is not set, the platform default encoding is used.
*
* @since 2.2
*/
@Parameter( defaultValue = '${project.build.sourceEncoding}', property="encoding" )
String sourceEncoding
/**
* The file encoding to use when creating the HTML reports. If the property project.reporting.outputEncoding
* is not set, the platform default encoding is used.
*
* @since 2.2
*/
@Parameter( defaultValue = '${project.reporting.outputEncoding}', property="outputEncoding" )
String outputEncoding
/**
* Threshold of minimum bug severity to report. Valid values are High, Default, Low, Ignore, and Exp (for experimental).
*
*/
@Parameter( defaultValue = "Default", property="findbugs.threshold" )
String threshold
/**
* Artifact resolver, needed to download the coreplugin jar.
*
* @component role="org.apache.maven.artifact.resolver.ArtifactResolver"
* @required
* @readonly
*/
@Component( role = org.apache.maven.artifact.resolver.ArtifactResolver.class )
ArtifactResolver artifactResolver
/**
*
* File name of the include filter. Only bugs in matching the filters are reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* @since 1.0-beta-1
*/
@Parameter( property="findbugs.includeFilterFile" )
String includeFilterFile
/**
*
* File name of the exclude filter. Bugs matching the filters are not reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* @since 1.0-beta-1
*/
@Parameter( property="findbugs.excludeFilterFile" )
String excludeFilterFile
/**
*
* File names of the baseline files. Bugs found in the baseline files won't be reported.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a filter file.
*
*
* This is a comma-delimited list.
*
* @since 2.4.1
*/
@Parameter( property="findbugs.excludeBugsFile" )
String excludeBugsFile
/**
* Effort of the bug finders. Valid values are Min, Default and Max.
*
* @since 1.0-beta-1
*/
@Parameter( defaultValue = "Default", property="findbugs.effort" )
String effort
/**
* turn on Findbugs debugging
*
*/
@Parameter( defaultValue = "false", property="findbugs.debug" )
Boolean debug
/**
* Relaxed reporting mode. For many detectors, this option suppresses the heuristics used to avoid reporting false
* positives.
*
* @since 1.1
*/
@Parameter( defaultValue = "false", property="findbugs.relaxed" )
Boolean relaxed
/**
* The visitor list to run. This is a comma-delimited list.
*
* @since 1.0-beta-1
*/
@Parameter( property="findbugs.visitors" )
String visitors
/**
* The visitor list to omit. This is a comma-delimited list.
*
* @since 1.0-beta-1
*/
@Parameter( property="findbugs.omitVisitors" )
String omitVisitors
/**
*
* The plugin list to include in the report. This is a comma-delimited list.
*
*
*
* Potential values are a filesystem path, a URL, or a classpath resource.
*
*
*
* This parameter is resolved as resource, URL, then file. If successfully
* resolved, the contents of the configuration is copied into the
* ${project.build.directory}
* directory before being passed to Findbugs as a plugin file.
*
*
* @since 1.0-beta-1
*/
@Parameter( property="findbugs.pluginList" )
String pluginList
/**
* Restrict analysis to the given comma-separated list of classes and packages.
*
* @since 1.1
*/
@Parameter( property="findbugs.onlyAnalyze" )
String onlyAnalyze
/**
* This option enables or disables scanning of nested jar and zip files found
* in the list of files and directories to be analyzed.
*
* @since 2.3.2
*/
@Parameter( property="findbugs.nested", defaultValue = "false" )
Boolean nested
/**
* Prints a trace of detectors run and classes analyzed to standard output.
* Useful for troubleshooting unexpected analysis failures.
*
* @since 2.3.2
*/
@Parameter( property="findbugs.trace", defaultValue = "false" )
Boolean trace
/**
* Maximum bug ranking to record.
*
* @since 2.4.1
*/
@Parameter( property="findbugs.maxRank" )
int maxRank
/**
* Skip entire check.
*
* @since 1.1
*/
@Parameter( property="findbugs.skip", defaultValue = "false" )
boolean skip
/**
* @component
* @required
* @readonly
* @since 2.0
*/
@Component( role = ResourceManager.class)
ResourceManager resourceManager
/**
* SiteTool.
*
* @since 2.1-SNAPSHOT
* @component role="org.apache.maven.doxia.tools.SiteTool"
* @required
* @readonly
*/
@Component( role = org.apache.maven.doxia.tools.SiteTool.class)
SiteTool siteTool
/**
* Fail the build on an error.
*
* @since 2.0
*/
@Parameter( property="findbugs.failOnError", defaultValue = "true" )
boolean failOnError
/**
* Fork a VM for FindBugs analysis. This will allow you to set timeouts and heap size
*
* @since 2.3.2
*/
@Parameter( property="findbugs.fork", defaultValue = "true" )
boolean fork
/**
* Maximum Java heap size in megabytes (default=512).
* This only works if the fork parameter is set true.
*
* @since 2.2
*/
@Parameter( property="findbugs.maxHeap", defaultValue = "512" )
int maxHeap
/**
* Specifies the amount of time, in milliseconds, that FindBugs may run before
* it is assumed to be hung and is terminated.
* The default is 600,000 milliseconds, which is ten minutes.
* This only works if the fork parameter is set true.
*
* @since 2.2
*/
@Parameter( property="findbugs.timeout", defaultValue = "600000" )
int timeout
/**
*
* the arguments to pass to the forked VM (ignored if fork is disabled).
*
*
* @since 2.4.1
*/
@Parameter( property="findbugs.jvmArgs" )
String jvmArgs
int bugCount
int errorCount
void execute() {
Locale locale = Locale.getDefault()
List sourceFiles
log.debug("Executing findbugs:check")
if ( this.classFilesDirectory.exists() && this.classFilesDirectory.isDirectory() ) {
sourceFiles = FileUtils.getFiles(classFilesDirectory, FindBugsInfo.JAVA_REGEX_PATTERN, null)
}
if ( !skip && sourceFiles ) {
// this goes
log.debug("Here goes...............Executing findbugs:check")
if (!findbugsXmlOutputDirectory.exists()) {
if ( !findbugsXmlOutputDirectory.mkdirs() ) {
throw new MojoExecutionException("Cannot create xml output directory")
}
}
File outputFile = new File("${findbugsXmlOutputDirectory}/findbugsXml.xml")
if (outputFile.exists()) {
def path = new XmlSlurper().parse(outputFile)
def allNodes = path.depthFirst().collect { it }
bugCount = allNodes.findAll {it.name() == 'BugInstance'}.size()
log.info("BugInstance size is ${bugCount}")
errorCount = allNodes.findAll {it.name() == 'Error'}.size()
log.info("Error size is ${errorCount}")
def xml = new XmlParser().parse(outputFile)
def bugs = xml.BugInstance
def total = bugs.size()
if (total <= 0) {
log.info('No errors/warnings found')
return
}
log.info('Total bugs: ' + total)
for (i in 0..total-1) {
def bug = bugs[i]
// log.info( bug.LongMessage.text() + FindBugsInfo.BLANK + bug.Class.'@classname' + FindBugsInfo.BLANK + bug.Class.SourceLine.Message.text() )
log.info( bug.LongMessage.text() + FindBugsInfo.BLANK + bug.SourceLine.'@classname' + FindBugsInfo.BLANK + bug.SourceLine.Message.text() )
}
log.info('\n\n\nTo see bug detail using the Findbugs GUI, use the following command "mvn findbugs:gui"\n\n\n')
if ( (bugCount || errorCount) && failOnError ) {
throw new MojoExecutionException("failed with ${bugCount} bugs and ${errorCount} errors ")
}
}
}
else {
log.debug("Nothing for FindBugs to do here.")
}
}
}