Property Detail

• boolean enabled

  Is the context enabled? In a disabled context, the tests are run with the original classes under test, not the instrumented ones, and no coverage report will produced for the test run. Default is true, meaning that the tests will run with instrumented classes and that a coverage report will be produced.

Constructor Detail

• CoberturaContext(CoberturaExtension pExtension, java.lang.String pName)

  Create a new CoberturaContext.

  Parameters:

  pExtension - The global Cobertura project extension with default values for some of the context's properties.

  pName - The name of this context, used as default name for the work directory.

Method Detail

• static org.gradle.api.file.FileCollection defaultInputClasses(org.gradle.api.Project pProject)

  Get the default collection of classes to analyze for test coverage.

  Parameters:

  pProject - The project to get the default input classes from.

  Returns:

  The project's main source set's output classes.

• static org.gradle.api.file.FileCollection defaultSourceDirs(org.gradle.api.Project pProject)

  Get the default source directories for the classes to analyze for test coverage.

  Parameters:

  pProject - The project to get the default source directories from.

  Returns:

  The project's main source set's sources.

• org.gradle.api.file.FileCollection getAuxClassPath()

  Get the path containing any classes that shouldn't be analyzed but are needed by the instrumentation. Default is no auxiliary classpath.

  Returns:

  The auxiliary class path.

• java.io.File getExecutionDataFile()

  Get the file holding metadata about the test execution of the instrumented classes. This file contains updated information about the instrumented classes from the test runs. It is an updated version of the instrumentation data file, created by the test task and used by the reports task. The default value is a file named "cobertura.execution.ser" in the context's work directory.

  Returns:

  The execution data file.

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

  Get the list of fully qualified names of annotations with which methods that should be excluded from instrumentation are annotated with. Default is the value of the corresponding property in the global Cobertura project extension.

  Returns:

  The list of "ignore method" annotation names.

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

  Get the list of regular expressions specifying methods names to be excluded from the coverage analysis. Note that the classes containing the methods will still be instrumented. Default is is the value of the corresponding property in the global Cobertura project extension.

  Returns:

  The list of "ignore method" names regular expressions.

• boolean getIgnoreTrivial()

  Get the ignore trivial property. If this property is true, constructors/methods that contain one line of code will be excluded from the overage analysis. Examples include constructors only calling a super constructor, and getters/setters. Default is the value of the corresponding property in the global Cobertura project extension.

  Returns:

  True if trivial methods should be ignored, false if not.

• org.gradle.api.file.FileCollection getInputClasses()

  Get the classes to analyze for test coverage. The default value is all files in the output classes directory of the main source set. Used as input by the instrumentation task.

  Returns:

  The classes to analyze for test coverage.

• java.io.File getInstrumentationDataFile()

  Get the file holding metadata about the instrumented classes. This file contains information about the names of the classes, their method names, line numbers, etc. It is created by the instrumentation task. The default value is a file named "cobertura.instrumentation.ser" in the context's work directory.

  Returns:

  The instrumentation data file.

• java.io.File getInstrumentedClassesDir()

  Get the directory containing the instrumented versions of the classes to analyze. Used as output directory by the instrumentation task and as input directory by the test task. The default value is a directory named "instrumented" in the context's work directory.

  Returns:

  The directory with the instrumented classes.

• java.lang.String getName()

  Get this context's name.

  Returns:

  The name.

• org.gradle.api.file.FileCollection getSourceDirs()

  Get the directories containing the sources of the analyzed classes.

  Returns:

  The source file directories.

• java.lang.String getSourceEncoding()

  Get the encoding to use when reading the source files in the sourceDirs. The platform's default encoding will be used if this property is null. Default is the value from the corresponding property in the global Cobertura project extension.

  Returns:

  The source encoding, possibly null.

• java.io.File getWorkDir()

  Get the work directory where by default all temporary files, such as instrumented classes and the data file, are put. The default is a directory with the context's name in the global Cobertura project extension's work directory.

  Returns:

  The work directory.

• void setAuxClassPath(java.lang.Object pClassPath)

  Set the auxiliary classpath. The specified classpath will be resolved relative to the project directory.

  Parameters:

  pClassPath - The auxiliary classpath, possibly null.

• void setExecutionDataFile(java.lang.Object pFile)

  Set the execution data file. The specified file will be resolved relative to the project directory.

  Parameters:

  pFile - The execution data. Passing null will effectively restore the default value.

• void setIgnoreMethodAnnotations(java.util.List<java.lang.String> pIgnoreMethodsAnnotations)

• void setIgnoreMethodNames(java.util.List<java.lang.String> pIgnoreMethodsNames)

• void setIgnoreTrivial(boolean pDoIgnore)

• void setInputClasses(java.lang.Object pClasses)

  Set the input classes. The specified classes will be resolved relative to the project directory.

  Parameters:

  pClasses - The input classes. Passing null will effectively restore the default value.

• void setInstrumentationDataFile(java.lang.Object pFile)

  Set the instrumentation data file. The specified file will be resolved relative to the project directory.

  Parameters:

  pFile - The instrumentation data. Passing null will effectively restore the default value.

• void setInstrumentedClassesDir(java.lang.Object pDirectory)

  Set the instrumented classes directory. The specified directory will be resolved relative to the project directory.

  Parameters:

  pDirectory - The instrumented classes directory. Passing null will effectively restore the default value.

• void setSourceDirs(java.lang.Object pDirs)

  Set the sources directory. The specified directory will be resolved relative to the project directory.

  Parameters:

  pDirectory - The sources directory. Passing null will effectively restore the default value.

• void setSourceEncoding(java.lang.String pEncoding)

  Set the source encoding.

  Parameters:

  pClassPath - The source encoding. Specifying null means that the platform's default encoding should be used..

• void setWorkDir(java.lang.Object pDirectory)

  Set the context's work directory. The specified directory will be resolved relative to the project directory.

  Parameters:

  pDirectory - The work directory. Passing null will effectively restore the default value.