Property Detail

• static java.lang.Object ENCODING_UNDEFINED

• java.lang.String androidVariant

  The variant for android projects.

• org.gradle.api.file.FileCollection auxiliaryClasspath

  The classpath when instrumenting. Defaults to project.sourceSets.main.output.classesDir, project.sourceSets.main.compileClasspath,

• java.lang.String coberturaVersion

  Version of cobertura to use for the plugin. Defaults to 2.1.1

• boolean coverageCheckHaltOnFailure

  Should the build fail if the minimum coverage rates are not met?

• java.util.List<java.lang.String> coverageDirs

  Directories under the base directory containing classes to be instrumented. Defaults to [project.sourceSets.main.classesDir.path]

• java.lang.String coverageEncoding

  The character encoding to use when generating coverage reports. If no encoding is specified, the plugin uses the system default.

• java.util.List<java.lang.String> coverageExcludes

  List of exclude patterns

• java.util.Set<java.lang.String> coverageFormats

  Formats of cobertura report. Default is a single report in 'html' format.

• java.util.List<java.lang.String> coverageIgnores

  List of ignore patterns

• java.util.List<java.lang.String> coverageIncludes

  List of include patterns

• java.io.File coverageInputDatafile

  Path to the data file to produce during instrumentation. This file is used to determine if instrumentation is up to date, so it cannot be used during the tests themselves. Defaults to ${project.buildDir.path}/cobertura/coberturaInput.ser

• java.util.List<java.io.File> coverageMergeDatafiles

  A list of data files to merge into a single data file to produce a merged report. If set, each of the datafiles in this list will be merged into a the single datafile, specified by coverageReportDatafile, before generating a coverage report.

• java.io.File coverageOutputDatafile

  Path to the data file to use during tests. The contents of this file are changed by testing, so a new copy is made from the input datafile before each test run. Defaults to ${project.buildDir.path}/cobertura/cobertura.ser

• java.io.File coverageReportDatafile

  Path to the data file to use when generating reports tests. Most users won't need to change this property. Defaults to ${project.buildDir.path}/cobertura/cobertura.ser. The only time this should be changed is when users are merging datafiles and coverageMergeDatafiles contains the default datafile.

• java.io.File coverageReportDir

  Path to report directory for coverage report. Defaults to ${project.reportsDir.path}/cobertura

• java.util.Set<java.io.File> coverageSourceDirs

  Directories of source files to use. The default is to look for and include each of the following, if present: project.sourceSets.main.java.srcDirs, project.sourceSets.main.groovy.srcDirs, and project.sourceSets.main.scala.srcDirs

Constructor Detail

• CoberturaExtension(org.gradle.api.Project project)

  Constructor for the extension. It needs a project handle to set the coverageDirs sensible defaults.

  Parameters:

  project - the Gradle project that owns the extension.

Method Detail

• void coverageClassesTasks(groovy.lang.Closure c)

  Set the closure that will be used to determine what tasks need to be complete before we can instrument classes for coverage. Used to override the default closure, which returns the "classes" task.

  Parameters:

  c - a no-argument closure that returns a TaskCollection.

• void coverageTestTasks(groovy.lang.Closure c)

  Set the closure that will be used to determine what tests should be run when the cobertura task is invoked. Used to override the default closure, which returns all tasks of type Test

  Parameters:

  c - a no-argument closure that returns a TaskCollection.

• java.lang.Integer getCoverageCheckBranchRate()

  Returns:

  The minimum acceptable branch coverage rate needed by each class.

• java.lang.Integer getCoverageCheckLineRate()

  Returns:

  The minimum acceptable line coverage rate needed by each class.

• java.lang.Integer getCoverageCheckPackageBranchRate()

  Returns:

  The minimum acceptable package branch coverage rate needed by each class.

• java.lang.Integer getCoverageCheckPackageLineRate()

  Returns:

  The minimum acceptable package line coverage rate needed by each class.

• java.util.List<java.util.Map> getCoverageCheckRegexes()

• java.lang.Integer getCoverageCheckTotalBranchRate()

  Returns:

  The minimum acceptable total branch coverage rate needed by each class.

• java.lang.Integer getCoverageCheckTotalLineRate()

  Returns:

  The minimum acceptable total line coverage rate needed by each class.

• org.gradle.api.tasks.TaskCollection getCoverageClassesTasks()

  Returns:

  the tasks that produce the classes that need to be instrumented for coverage reports, as returned by the coverageClassTasks closure

• java.util.List<java.lang.String> getCoverageIgnoreMethodAnnotations()

  Returns:

  the names of annotations used to flag methods to be ignored.

• boolean getCoverageIgnoreTrivial()

  Returns:

  whether or not we should ignore trivial methods.

• org.gradle.api.tasks.TaskCollection getCoverageTestTasks()

  Returns:

  the test tasks that should run, as returned by the coverageTestTask closure

• static org.gradle.api.file.FileCollection getExtractedJars(org.gradle.api.Project project)

  Used to fetch the extracted jars from android AARs during compilation.

• void setCoverageCheckBranchRate(java.lang.Integer coverageCheckBranchRate)

  Set the minimum acceptable branch coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckBranchRate - the rate to set

• void setCoverageCheckLineRate(java.lang.Integer coverageCheckLineRate)

  Set the minimum acceptable line coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckLineRate - the rate to set

• void setCoverageCheckPackageBranchRate(java.lang.Integer coverageCheckPackageBranchRate)

  Set the minimum acceptable package branch coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckPackageBranchRate - the rate to set

• void setCoverageCheckPackageLineRate(java.lang.Integer coverageCheckPackageLineRate)

  Set the minimum acceptable package line coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckPackageLineRate - the rate to set

• void setCoverageCheckRegexes(java.util.List<java.util.Map> coverageCheckRegexes)

  For finer grained control, you can optionally specify minimum branch and line coverage rates for individual classes using any number of regular expressions. Each expression is a map with 3 keys:

  • regex - a regular expression identifying classes classes that need special rates
  • branchRate - the branch rate for the selected classes
  • lineRate - the line rate for the selected classes
  The branch and line rates need to be numbers from 0 to 100. Example:

  	   coverageCheckRegexes = [
  	     [ regex: 'com.example.reallyimportant.*', branchRate: 80, lineRate: 90 ],
  	     [ regex: 'com.example.boringcode.*', branchRate: 40, lineRate: 30 ]
  	   ]
   

  throws:

  IllegalArgumentException if any of the regular expressions or coverage rates are missing, or if the rates are outside the valid range.

  Parameters:

  coverageCheckRegexes - the expressions to use.

• void setCoverageCheckTotalBranchRate(java.lang.Integer coverageCheckTotalBranchRate)

  Set the minimum acceptable total branch coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckTotalBranchRate - the rate to set

• void setCoverageCheckTotalLineRate(java.lang.Integer coverageCheckTotalLineRate)

  Set the minimum acceptable total line coverage rate needed by each class. This needs to be an integer value between 0 and 100.

  throws:

  IllegalArgumentException if the rate is not between 0 and 100.

  Parameters:

  coverageCheckTotalLineRate - the rate to set

• void setCoverageIgnoreMethodAnnotations(java.util.List<java.lang.String> ignoreMethodAnnotations)

  List of fully qualified annotation names that, if present on a method, will cause it to be ignored by Cobertura for coverage purposes. Available in Cobertura 2.0.0 and later. Attempting to set this property when using Cobertura 1.x will result in an error.

  Parameters:

  ignoreMethodAnnotations - the names of annotations used to flag methods to be ignored

• void setCoverageIgnoreTrivial(boolean ignoreTrivial)

  Whether or not to ignore trivial methods like simple getters and setters. Available in in Cobertura 2.0.0 and later. Attempting to set this property when using Cobertura 1.x will result in an error.

  Parameters:

  ignoreTrivial - whether or not we should ignore trivial methods.

• static java.lang.String[] splitCamelCase(java.lang.String input)