Test (Gradle API 1.0)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - org.gradle.api.internal.ConventionTask
    - - org.gradle.api.tasks.testing.Test

All Implemented Interfaces:: Comparable<Task>, DynamicObjectAware, IConventionAware, TaskInternal, ExtensionAware, Task, PatternFilterable, VerificationTask, JavaForkOptions, ProcessForkOptions, Configurable<Task>

public class Test
extends ConventionTask
implements JavaForkOptions, PatternFilterable, VerificationTask

Executes tests. Supports JUnit (3.8.x or 4.x) or TestNG tests.

An example with a blend of various settings

 apply plugin: 'java' //so that 'test' task is added

 test {
   //configuring a system property for tests
   systemProperty 'some.prop', 'value'

   //tuning the included/excluded tests
   include 'org/foo/**'
   exclude 'org/boo/**'

   //makes the standard streams (err and out) visible at console when running tests
   testLogging.showStandardStreams = true

   //tweaking memory settings for the forked vm that runs tests
   jvmArgs '-Xms128m', '-Xmx512m', '-XX:MaxPermSize=128m'

   //listening to test execution events
   beforeTest { descriptor ->
      logger.lifecycle("Running test: " + descriptor)
   }
   onOutput { descriptor, event ->
      logger.lifecycle("Test: " + descriptor + " produced standard out/err: " + event.message )
   }
 }

Author:: Hans Dockter

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  Task.Namer

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor and Description

Test()

Constructors
Constructor and Description
`Test()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addTestListener(TestListener listener)` Registers a test listener with this task.
`void`	`addTestOutputListener(TestOutputListener listener)` Registers a output listener with this task.
`void`	`afterSuite(Closure closure)` Adds a closure to be notified after a test suite has executed.
`void`	`afterTest(Closure closure)` Adds a closure to be notified after a test has executed.
`void`	`beforeSuite(Closure closure)` Adds a closure to be notified before a test suite is executed.
`void`	`beforeTest(Closure closure)` Adds a closure to be notified before a test is executed.
`Test`	`bootstrapClasspath(Object... classpath)` Adds the given values to the end of the bootstrap classpath for the process.
`Test`	`copyTo(JavaForkOptions target)` Copies these options to the given options.
`Test`	`copyTo(ProcessForkOptions target)` Copies these options to the given target options.
`void`	`disableTestReport()`
`void`	`enableTestReport()`
`Test`	`environment(Map<String,?> environmentVariables)` Adds some environment variables to the environment for this process.
`Test`	`environment(String name, Object value)` Adds an environment variable to the environment for this process.
`Test`	`exclude(Closure excludeSpec)` Adds an exclude spec.
`Test`	`exclude(Iterable<String> excludes)` Adds exclude patterns for the files in the test classes directory (e.g.
`Test`	`exclude(Spec<FileTreeElement> excludeSpec)` Adds an exclude spec.
`Test`	`exclude(String... excludes)` Adds exclude patterns for the files in the test classes directory (e.g.
`Test`	`executable(Object executable)` Sets the name of the executable to use.
`void`	`executeTests()`
`List<String>`	`getAllJvmArgs()` Returns the full set of arguments to use to launch the JVM for the process.
`FileCollection`	`getBootstrapClasspath()` Returns the bootstrap classpath to use for the process.
`FileTree`	`getCandidateClassFiles()` Returns the classes files to scan for test classes.
`FileCollection`	`getClasspath()` Returns the classpath to use to execute the tests.
`boolean`	`getDebug()` Returns true if debugging is enabled for the process.
`String`	`getDefaultCharacterEncoding()` Returns the default character encoding to use.
`boolean`	`getEnableAssertions()` Returns true if assertions are enabled for the process.
`Map<String,Object>`	`getEnvironment()` The environment variables to use for the process.
`Set<String>`	`getExcludes()` Returns the exclude patterns for test execution.
`String`	`getExecutable()` Returns the name of the executable to use.
`long`	`getForkEvery()` Returns the maximum number of test classes to execute in a forked test process.
`boolean`	`getIgnoreFailures()` Specifies whether the build should break when the verifications performed by this task fail.
`Set<String>`	`getIncludes()` Returns the include patterns for test execution.
`List<String>`	`getJvmArgs()` Returns the extra arguments to use to launch the JVM for the process.
`String`	`getMaxHeapSize()` Returns the maximum heap size for the process, if any.
`int`	`getMaxParallelForks()` Returns the maximum number of forked test processes to execute in parallel.
`String`	`getMinHeapSize()` Returns the minimum heap size for the process, if any.
`TestFrameworkOptions`	`getOptions()` Returns the test options options.
`Map<String,Object>`	`getSystemProperties()` Returns the system properties which will be used for the process.
`File`	`getTestClassesDir()` Returns the root folder for the compiled test sources.
`TestFramework`	`getTestFramework()`
`TestLogging`	`getTestLogging()` Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
`File`	`getTestReportDir()` Returns the root folder for the test reports.
`File`	`getTestResultsDir()` Returns the root folder for the test results.
`List<File>`	`getTestSrcDirs()` Returns the directories containing the test source.
`File`	`getWorkingDir()` Returns the working directory for the process.
`Test`	`include(Closure includeSpec)` Adds an include spec.
`Test`	`include(Iterable<String> includes)` Adds include patterns for the files in the test classes directory (e.g.
`Test`	`include(Spec<FileTreeElement> includeSpec)` Adds an include spec.
`Test`	`include(String... includes)` Adds include patterns for the files in the test classes directory (e.g.
`boolean`	`isScanForTestClasses()` Specifies whether test classes should be detected.
`boolean`	`isTestReport()` Specifies whether the test report should be generated.
`Test`	`jvmArgs(Iterable<?> arguments)` Adds some arguments to use to launch the JVM for the process.
`Test`	`jvmArgs(Object... arguments)` Adds some arguments to use to launch the JVM for the process.
`void`	`onOutput(Closure closure)` Adds a closure to be notified when output from the test received.
`TestFrameworkOptions`	`options(Closure testFrameworkConfigure)`
`void`	`removeTestListener(TestListener listener)` Unregisters a test listener with this task.
`void`	`removeTestOutputListener(TestOutputListener listener)` Unregisters a test output listener with this task.
`void`	`setAllJvmArgs(Iterable<?> arguments)` Sets the full set of arguments to use to launch the JVM for the process.
`void`	`setBootstrapClasspath(FileCollection classpath)` Sets the bootstrap classpath to use for the process.
`void`	`setClasspath(FileCollection classpath)`
`void`	`setDebug(boolean enabled)` Enable or disable debugging for the process.
`void`	`setDefaultCharacterEncoding(String defaultCharacterEncoding)` Sets the default character encoding to use.
`void`	`setEnableAssertions(boolean enabled)` Enable or disable assertions for the process.
`void`	`setEnvironment(Map<String,?> environmentVariables)` Sets the environment variable to use for the process.
`Test`	`setExcludes(Iterable<String> excludes)` Sets the exclude patterns for test execution.
`void`	`setExecutable(Object executable)` Sets the name of the executable to use.
`void`	`setForkEvery(Long forkEvery)` Sets the maximum number of test classes to execute in a forked test process.
`void`	`setIgnoreFailures(boolean ignoreFailures)` Specifies whether the build should break when the verifications performed by this task fail.
`Test`	`setIncludes(Iterable<String> includes)` Sets the include patterns for test execution.
`void`	`setJvmArgs(Iterable<?> arguments)` Sets the extra arguments to use to launch the JVM for the process.
`void`	`setMaxHeapSize(String heapSize)` Sets the maximum heap size for the process.
`void`	`setMaxParallelForks(int maxParallelForks)` Sets the maximum number of forked test processes to execute in parallel.
`void`	`setMinHeapSize(String heapSize)` Sets the minimum heap size for the process.
`void`	`setScanForTestClasses(boolean scanForTestClasses)`
`void`	`setSystemProperties(Map<String,?> properties)` Sets the system properties to use for the process.
`void`	`setTestClassesDir(File testClassesDir)` Sets the root folder for the compiled test sources.
`void`	`setTestReport(boolean testReport)`
`void`	`setTestReportDir(File testReportDir)` Sets the root folder for the test reports.
`void`	`setTestResultsDir(File testResultsDir)` Sets the root folder for the test results.
`void`	`setTestSrcDirs(List<File> testSrcDir)`
`void`	`setWorkingDir(Object dir)` Sets the working directory for the process.
`Test`	`systemProperties(Map<String,?> properties)` Adds some system properties to use for the process.
`Test`	`systemProperty(String name, Object value)` Adds a system property to use for the process.
`TestFramework`	`testFramework(Closure testFrameworkConfigure)`
`void`	`testLogging(Closure closure)` Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
`void`	`useJUnit()` Specifies that JUnit should be used to execute the tests.
`void`	`useJUnit(Closure testFrameworkConfigure)` Specifies that JUnit should be used to execute the tests.
`void`	`useTestNG()` Specifies that TestNG should be used to execute the tests.
`void`	`useTestNG(Closure testFrameworkConfigure)` Specifies that TestNG should be used to execute the tests.
`Test`	`workingDir(Object dir)` Sets the working directory for the process.

Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Test
```
public Test()
```
- Method Detail
  - getWorkingDir
```
public File getWorkingDir()
```
    Returns the working directory for the process. Defaults to the project directory.
    
    Specified by:
    
    getWorkingDir in interface ProcessForkOptions
    
    Returns:
    The working directory. Never returns null.
  - setWorkingDir
```
public void setWorkingDir(Object dir)
```
    Sets the working directory for the process. The supplied argument is evaluated as for Project.file(Object).
    
    Specified by:
    
    setWorkingDir in interface ProcessForkOptions
    
    Parameters:
    dir - The working directory. Must not be null.
  - workingDir
```
public Test workingDir(Object dir)
```
    Sets the working directory for the process. The supplied argument is evaluated as for Project.file(Object).
    
    Specified by:
    
    workingDir in interface ProcessForkOptions
    
    Parameters:
    dir - The working directory. Must not be null.
    
    Returns:
    this
  - getExecutable
```
public String getExecutable()
```
    Returns the name of the executable to use.
    
    Specified by:
    
    getExecutable in interface ProcessForkOptions
    
    Returns:
    The executable.
  - executable
```
public Test executable(Object executable)
```
    Sets the name of the executable to use.
    
    Specified by:
    
    executable in interface ProcessForkOptions
    
    Parameters:
    executable - The executable. Must not be null.
    
    Returns:
    this
  - setExecutable
```
public void setExecutable(Object executable)
```
    Sets the name of the executable to use.
    
    Specified by:
    
    setExecutable in interface ProcessForkOptions
    
    Parameters:
    executable - The executable. Must not be null.
  - getSystemProperties
```
public Map<String,Object> getSystemProperties()
```
    Returns the system properties which will be used for the process.
    
    Specified by:
    
    getSystemProperties in interface JavaForkOptions
    
    Returns:
    The system properties. Returns an empty map when there are no system properties.
  - setSystemProperties
```
public void setSystemProperties(Map<String,?> properties)
```
    Sets the system properties to use for the process.
    
    Specified by:
    
    setSystemProperties in interface JavaForkOptions
    
    Parameters:
    properties - The system properties. Must not be null.
  - systemProperties
```
public Test systemProperties(Map<String,?> properties)
```
    Adds some system properties to use for the process.
    
    Specified by:
    
    systemProperties in interface JavaForkOptions
    
    Parameters:
    properties - The system properties. Must not be null.
    
    Returns:
    this
  - systemProperty
```
public Test systemProperty(String name,
                  Object value)
```
    Adds a system property to use for the process.
    
    Specified by:
    
    systemProperty in interface JavaForkOptions
    
    Parameters:
    name - The name of the property
    value - The value for the property. May be null.
    
    Returns:
    this
  - getBootstrapClasspath
```
public FileCollection getBootstrapClasspath()
```
    Returns the bootstrap classpath to use for the process. The default bootstrap classpath for the JVM is used when this classpath is empty.
    
    Specified by:
    
    getBootstrapClasspath in interface JavaForkOptions
    
    Returns:
    The bootstrap classpath. Never returns null.
  - setBootstrapClasspath
```
public void setBootstrapClasspath(FileCollection classpath)
```
    Sets the bootstrap classpath to use for the process. Set to an empty classpath to use the default bootstrap classpath for the specified JVM.
    
    Specified by:
    
    setBootstrapClasspath in interface JavaForkOptions
    
    Parameters:
    classpath - The classpath. Must not be null. Can be empty.
  - bootstrapClasspath
```
public Test bootstrapClasspath(Object... classpath)
```
    Adds the given values to the end of the bootstrap classpath for the process.
    
    Specified by:
    
    bootstrapClasspath in interface JavaForkOptions
    
    Parameters:
    classpath - The classpath.
    
    Returns:
    this
  - getMinHeapSize
```
public String getMinHeapSize()
```
    Returns the minimum heap size for the process, if any.
    
    Specified by:
    
    getMinHeapSize in interface JavaForkOptions
    
    Returns:
    The minimum heap size. Returns null if the default minimum heap size should be used.
  - getDefaultCharacterEncoding
```
public String getDefaultCharacterEncoding()
```
    Returns the default character encoding to use.
    
    Specified by:
    
    getDefaultCharacterEncoding in interface JavaForkOptions
    
    Returns:
    The default character encoding. Returns null if the default character encoding of this JVM should be used.
  - setDefaultCharacterEncoding
```
public void setDefaultCharacterEncoding(String defaultCharacterEncoding)
```
    Sets the default character encoding to use. Note: Many JVM implementations support the setting of this attribute via system property on startup (namely, the file.encoding property). For JVMs where this is the case, setting the file.encoding property via JavaForkOptions.setSystemProperties(java.util.Map) or similar will have no effect as this value will be overridden by the value specified by JavaForkOptions.getDefaultCharacterEncoding().
    
    Specified by:
    
    setDefaultCharacterEncoding in interface JavaForkOptions
    
    Parameters:
    defaultCharacterEncoding - The default character encoding. Use null to use this JVM's default charset
  - setMinHeapSize
```
public void setMinHeapSize(String heapSize)
```
    Sets the minimum heap size for the process.
    
    Specified by:
    
    setMinHeapSize in interface JavaForkOptions
    
    Parameters:
    heapSize - The minimum heap size. Use null for the default minimum heap size.
  - getMaxHeapSize
```
public String getMaxHeapSize()
```
    Returns the maximum heap size for the process, if any.
    
    Specified by:
    
    getMaxHeapSize in interface JavaForkOptions
    
    Returns:
    The maximum heap size. Returns null if the default maximum heap size should be used.
  - setMaxHeapSize
```
public void setMaxHeapSize(String heapSize)
```
    Sets the maximum heap size for the process.
    
    Specified by:
    
    setMaxHeapSize in interface JavaForkOptions
    
    Parameters:
    heapSize - The heap size. Use null for the default maximum heap size.
  - getJvmArgs
```
public List<String> getJvmArgs()
```
    Returns the extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.
    
    Specified by:
    
    getJvmArgs in interface JavaForkOptions
    
    Returns:
    The arguments. Returns an empty list if there are no arguments.
  - setJvmArgs
```
public void setJvmArgs(Iterable<?> arguments)
```
    Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.
    
    Specified by:
    
    setJvmArgs in interface JavaForkOptions
    
    Parameters:
    arguments - The arguments. Must not be null.
  - jvmArgs
```
public Test jvmArgs(Iterable<?> arguments)
```
    Adds some arguments to use to launch the JVM for the process.
    
    Specified by:
    
    jvmArgs in interface JavaForkOptions
    
    Parameters:
    arguments - The arguments. Must not be null.
    
    Returns:
    this
  - jvmArgs
```
public Test jvmArgs(Object... arguments)
```
    Adds some arguments to use to launch the JVM for the process.
    
    Specified by:
    
    jvmArgs in interface JavaForkOptions
    
    Parameters:
    arguments - The arguments.
    
    Returns:
    this
  - getEnableAssertions
```
public boolean getEnableAssertions()
```
    Returns true if assertions are enabled for the process.
    
    Specified by:
    
    getEnableAssertions in interface JavaForkOptions
    
    Returns:
    true if assertions are enabled, false if disabled
  - setEnableAssertions
```
public void setEnableAssertions(boolean enabled)
```
    Enable or disable assertions for the process.
    
    Specified by:
    
    setEnableAssertions in interface JavaForkOptions
    
    Parameters:
    enabled - true to enable assertions, false to disable.
  - getDebug
```
public boolean getDebug()
```
    Returns true if debugging is enabled for the process. When enabled, the process is started suspended and listening on port 5005.
    
    Specified by:
    
    getDebug in interface JavaForkOptions
    
    Returns:
    true when debugging is enabled, false to disable.
  - setDebug
```
public void setDebug(boolean enabled)
```
    Enable or disable debugging for the process. When enabled, the process is started suspended and listening on port 5005.
    
    Specified by:
    
    setDebug in interface JavaForkOptions
    
    Parameters:
    enabled - true to enable debugging, false to disable.
  - getAllJvmArgs
```
public List<String> getAllJvmArgs()
```
    Returns the full set of arguments to use to launch the JVM for the process. This includes arguments to define system properties, the minimum/maximum heap size, and the bootstrap classpath.
    
    Specified by:
    
    getAllJvmArgs in interface JavaForkOptions
    
    Returns:
    The arguments. Returns an empty list if there are no arguments.
  - setAllJvmArgs
```
public void setAllJvmArgs(Iterable<?> arguments)
```
    Sets the full set of arguments to use to launch the JVM for the process. Overwrites any previously set system properties, minimum/maximum heap size, assertions, and bootstrap classpath.
    
    Specified by:
    
    setAllJvmArgs in interface JavaForkOptions
    
    Parameters:
    arguments - The arguments. Must not be null.
  - getEnvironment
```
public Map<String,Object> getEnvironment()
```
    The environment variables to use for the process. Defaults to the environment of this process.
    
    Specified by:
    
    getEnvironment in interface ProcessForkOptions
    
    Returns:
    The environment. Returns an empty map when there are no environment variables.
  - environment
```
public Test environment(Map<String,?> environmentVariables)
```
    Adds some environment variables to the environment for this process.
    
    Specified by:
    
    environment in interface ProcessForkOptions
    
    Parameters:
    environmentVariables - The environment variables. Must not be null.
    
    Returns:
    this
  - environment
```
public Test environment(String name,
               Object value)
```
    Adds an environment variable to the environment for this process.
    
    Specified by:
    
    environment in interface ProcessForkOptions
    
    Parameters:
    name - The name of the variable.
    value - The value for the variable. Must not be null.
    
    Returns:
    this
  - setEnvironment
```
public void setEnvironment(Map<String,?> environmentVariables)
```
    Sets the environment variable to use for the process.
    
    Specified by:
    
    setEnvironment in interface ProcessForkOptions
    
    Parameters:
    environmentVariables - The environment variables. Must not be null.
  - copyTo
```
public Test copyTo(ProcessForkOptions target)
```
    Copies these options to the given target options.
    
    Specified by:
    
    copyTo in interface ProcessForkOptions
    
    Parameters:
    target - The target options
    
    Returns:
    this
  - copyTo
```
public Test copyTo(JavaForkOptions target)
```
    Copies these options to the given options.
    
    Specified by:
    
    copyTo in interface JavaForkOptions
    
    Parameters:
    target - The target options.
    
    Returns:
    this
  - executeTests
```
public void executeTests()
```
  - addTestListener
```
public void addTestListener(TestListener listener)
```
    Registers a test listener with this task. Consider also the following handy methods for quicker hooking into test execution: beforeTest(groovy.lang.Closure), afterTest(groovy.lang.Closure), beforeSuite(groovy.lang.Closure), afterSuite(groovy.lang.Closure)
    This listener will NOT be notified of tests executed by other tasks. To get that behavior, use Gradle.addListener(Object).
    
    Parameters:
    listener - The listener to add.
  - addTestOutputListener
```
public void addTestOutputListener(TestOutputListener listener)
```
    Registers a output listener with this task. Quicker way of hooking into output events is using the onOutput(groovy.lang.Closure) method.
    
    Parameters:
    listener - The listener to add.
  - removeTestListener
```
public void removeTestListener(TestListener listener)
```
    Unregisters a test listener with this task. This method will only remove listeners that were added by calling addTestListener(org.gradle.api.tasks.testing.TestListener) on this task. If the listener was registered with Gradle using Gradle.addListener(Object) this method will not do anything. Instead, use Gradle.removeListener(Object).
    
    Parameters:
    listener - The listener to remove.
  - removeTestOutputListener
```
public void removeTestOutputListener(TestOutputListener listener)
```
    Unregisters a test output listener with this task. This method will only remove listeners that were added by calling addTestOutputListener(org.gradle.api.tasks.testing.TestOutputListener) on this task. If the listener was registered with Gradle using Gradle.addListener(Object) this method will not do anything. Instead, use Gradle.removeListener(Object).
    
    Parameters:
    listener - The listener to remove.
  - beforeSuite
```
public void beforeSuite(Closure closure)
```
    Adds a closure to be notified before a test suite is executed. A TestDescriptor instance is passed to the closure as a parameter.
    
    This method is also called before any test suites are executed. The provided descriptor will have a null parent suite.
    
    Parameters:
    closure - The closure to call.
  - afterSuite
```
public void afterSuite(Closure closure)
```
    Adds a closure to be notified after a test suite has executed. A TestDescriptor and TestResult instance are passed to the closure as a parameter.
    
    This method is also called after all test suites are executed. The provided descriptor will have a null parent suite.
    
    Parameters:
    closure - The closure to call.
  - beforeTest
```
public void beforeTest(Closure closure)
```
    Adds a closure to be notified before a test is executed. A TestDescriptor instance is passed to the closure as a parameter.
    
    Parameters:
    closure - The closure to call.
  - afterTest
```
public void afterTest(Closure closure)
```
    Adds a closure to be notified after a test has executed. A TestDescriptor and TestResult instance are passed to the closure as a parameter.
    
    Parameters:
    closure - The closure to call.
  - onOutput
```
public void onOutput(Closure closure)
```
    Adds a closure to be notified when output from the test received. A TestDescriptor and TestOutputEvent instance are passed to the closure as a parameter.
```
 apply plugin: 'java'

 test {
   onOutput { descriptor, event ->
     if (event.destination == TestOutputEvent.Destination.StdErr) {
       logger.error("Test: " + descriptor + ", error: " + event.message)
     }
   }
 }
 
```
    Parameters:
    closure - The closure to call.
  - include
```
public Test include(String... includes)
```
    Adds include patterns for the files in the test classes directory (e.g. '**F;*Test.class')).
    
    Specified by:
    
    include in interface PatternFilterable
    
    Parameters:
    includes - a vararg list of include patterns
    
    Returns:
    this
    See Also:
    setIncludes(Iterable)
  - include
```
public Test include(Iterable<String> includes)
```
    Adds include patterns for the files in the test classes directory (e.g. '**F;*Test.class')).
    
    Specified by:
    
    include in interface PatternFilterable
    
    Parameters:
    includes - a Iterable providing more include patterns
    
    Returns:
    this
    See Also:
    setIncludes(Iterable)
  - include
```
public Test include(Spec<FileTreeElement> includeSpec)
```
    Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
    
    Specified by:
    
    include in interface PatternFilterable
    
    Parameters:
    includeSpec - the spec to add
    
    Returns:
    this
    See Also:
    Pattern Format
  - include
```
public Test include(Closure includeSpec)
```
    Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
    
    Specified by:
    
    include in interface PatternFilterable
    
    Parameters:
    includeSpec - the spec to add
    
    Returns:
    this
    See Also:
    Pattern Format
  - exclude
```
public Test exclude(String... excludes)
```
    Adds exclude patterns for the files in the test classes directory (e.g. '**F;*Test.class')).
    
    Specified by:
    
    exclude in interface PatternFilterable
    
    Parameters:
    excludes - a vararg list of exclude patterns
    
    Returns:
    this
    See Also:
    setExcludes(Iterable)
  - exclude
```
public Test exclude(Iterable<String> excludes)
```
    Adds exclude patterns for the files in the test classes directory (e.g. '**F;*Test.class')).
    
    Specified by:
    
    exclude in interface PatternFilterable
    
    Parameters:
    excludes - a Iterable providing new exclude patterns
    
    Returns:
    this
    See Also:
    setExcludes(Iterable)
  - exclude
```
public Test exclude(Spec<FileTreeElement> excludeSpec)
```
    Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
    
    Specified by:
    
    exclude in interface PatternFilterable
    
    Parameters:
    excludeSpec - the spec to add
    
    Returns:
    this
    See Also:
    Pattern Format
  - exclude
```
public Test exclude(Closure excludeSpec)
```
    Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
    
    Specified by:
    
    exclude in interface PatternFilterable
    
    Parameters:
    excludeSpec - the spec to add
    
    Returns:
    this
    See Also:
    Pattern Format
  - getTestClassesDir
```
public File getTestClassesDir()
```
    Returns the root folder for the compiled test sources.
    
    Returns:
    All test class directories to be used.
  - setTestClassesDir
```
public void setTestClassesDir(File testClassesDir)
```
    Sets the root folder for the compiled test sources.
    
    Parameters:
    testClassesDir - The root folder
  - getTestResultsDir
```
public File getTestResultsDir()
```
    Returns the root folder for the test results.
    
    Returns:
    the test result directory, containing the internal test results, mostly in xml form.
  - setTestResultsDir
```
public void setTestResultsDir(File testResultsDir)
```
    Sets the root folder for the test results.
    
    Parameters:
    testResultsDir - The root folder
  - getTestReportDir
```
public File getTestReportDir()
```
    Returns the root folder for the test reports.
    
    Returns:
    the test report directory, containing the test report mostly in HTML form.
  - setTestReportDir
```
public void setTestReportDir(File testReportDir)
```
    Sets the root folder for the test reports.
    
    Parameters:
    testReportDir - The root folder
  - getIncludes
```
public Set<String> getIncludes()
```
    Returns the include patterns for test execution.
    
    Specified by:
    
    getIncludes in interface PatternFilterable
    
    Returns:
    The include patterns. Returns an empty set when there are no include patterns.
    See Also:
    include(String...)
  - setIncludes
```
public Test setIncludes(Iterable<String> includes)
```
    Sets the include patterns for test execution.
    
    Specified by:
    
    setIncludes in interface PatternFilterable
    
    Parameters:
    includes - The patterns list
    
    Returns:
    this
    See Also:
    include(String...)
  - getExcludes
```
public Set<String> getExcludes()
```
    Returns the exclude patterns for test execution.
    
    Specified by:
    
    getExcludes in interface PatternFilterable
    
    Returns:
    The exclude patterns. Returns an empty set when there are no exclude patterns.
    See Also:
    exclude(String...)
  - setExcludes
```
public Test setExcludes(Iterable<String> excludes)
```
    Sets the exclude patterns for test execution.
    
    Specified by:
    
    setExcludes in interface PatternFilterable
    
    Parameters:
    excludes - The patterns list
    
    Returns:
    this
    See Also:
    exclude(String...)
  - getIgnoreFailures
```
public boolean getIgnoreFailures()
```
    Specifies whether the build should break when the verifications performed by this task fail.
    
    Specified by:
    
    getIgnoreFailures in interface VerificationTask
    
    Returns:
    false, when the build should break on failure, true when the failures should be ignored.
  - setIgnoreFailures
```
public void setIgnoreFailures(boolean ignoreFailures)
```
    Specifies whether the build should break when the verifications performed by this task fail.
    
    Specified by:
    
    setIgnoreFailures in interface VerificationTask
    
    Parameters:
    ignoreFailures - false to break the build on failure, true to ignore the failures. The default is false.
  - getTestFramework
```
public TestFramework getTestFramework()
```
  - testFramework
```
public TestFramework testFramework(Closure testFrameworkConfigure)
```
  - getOptions
```
public TestFrameworkOptions getOptions()
```
    Returns the test options options.
    
    Be sure to call the appropriate useJUnit() or useTestNG() method before using this method.
    
    Returns:
    The testframework options.
  - options
```
public TestFrameworkOptions options(Closure testFrameworkConfigure)
```
  - useJUnit
```
public void useJUnit()
```
    Specifies that JUnit should be used to execute the tests.
  - useJUnit
```
public void useJUnit(Closure testFrameworkConfigure)
```
    Specifies that JUnit should be used to execute the tests.
    
    Parameters:
    testFrameworkConfigure - A closure used to configure the JUnit options. This closure is passed an instance of type JUnitOptions.
  - useTestNG
```
public void useTestNG()
```
    Specifies that TestNG should be used to execute the tests.
  - useTestNG
```
public void useTestNG(Closure testFrameworkConfigure)
```
    Specifies that TestNG should be used to execute the tests.
    
    Parameters:
    testFrameworkConfigure - A closure used to configure the TestNG options. This closure is passed an instance of type TestNGOptions.
  - getClasspath
```
public FileCollection getClasspath()
```
    Returns the classpath to use to execute the tests.
  - setClasspath
```
public void setClasspath(FileCollection classpath)
```
  - isTestReport
```
public boolean isTestReport()
```
    Specifies whether the test report should be generated.
  - setTestReport
```
public void setTestReport(boolean testReport)
```
  - enableTestReport
```
public void enableTestReport()
```
  - disableTestReport
```
public void disableTestReport()
```
  - getTestSrcDirs
```
public List<File> getTestSrcDirs()
```
    Returns the directories containing the test source.
  - setTestSrcDirs
```
public void setTestSrcDirs(List<File> testSrcDir)
```
  - isScanForTestClasses
```
public boolean isScanForTestClasses()
```
    Specifies whether test classes should be detected. When true the classes which match the include and exclude patterns are scanned for test classes, and any found are executed. When false the classes which match the include and exclude patterns are executed.
  - setScanForTestClasses
```
public void setScanForTestClasses(boolean scanForTestClasses)
```
  - getForkEvery
```
public long getForkEvery()
```
    Returns the maximum number of test classes to execute in a forked test process. The forked test process will be restarted when this limit is reached. The default value is 0 (no maximum).
    
    Returns:
    The maximum number of test classes. Returns 0 when there is no maximum.
  - setForkEvery
```
public void setForkEvery(Long forkEvery)
```
    Sets the maximum number of test classes to execute in a forked test process. Use null or 0 to use no maximum.
    
    Parameters:
    forkEvery - The maximum number of test classes. Use null or 0 to specify no maximum.
  - getMaxParallelForks
```
public int getMaxParallelForks()
```
    Returns the maximum number of forked test processes to execute in parallel. The default value is 1 (no parallel test execution).
    
    Returns:
    The maximum number of forked test processes.
  - setMaxParallelForks
```
public void setMaxParallelForks(int maxParallelForks)
```
    Sets the maximum number of forked test processes to execute in parallel. Set to 1 to disable parallel test execution.
    
    Parameters:
    maxParallelForks - The maximum number of forked test processes.
  - getCandidateClassFiles
```
public FileTree getCandidateClassFiles()
```
    Returns the classes files to scan for test classes.
    
    Returns:
    The candidate class files.
  - getTestLogging
```
public TestLogging getTestLogging()
```
    Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
```
 apply plugin: 'java'

 //makes the standard streams (err and out) visible at console when running tests
 test.testLogging.showStandardStreams = true
 
```
    Returns:
    test logging configuration
  - testLogging
```
public void testLogging(Closure closure)
```
    Allows configuring the logging of the test execution, for example log eagerly the standard output, etc.
```
 apply plugin: 'java'

 //makes the standard streams (err and out) visible at console when running tests
 test.testLogging {
   showStandardStreams = true
 }
 
```
    Parameters:
    closure - configure closure

Class Test

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.internal.ConventionTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Constructor Detail

Test

Method Detail

getWorkingDir

setWorkingDir

workingDir

getExecutable

executable

setExecutable

getSystemProperties

setSystemProperties

systemProperties

systemProperty

getBootstrapClasspath

setBootstrapClasspath

bootstrapClasspath

getMinHeapSize

getDefaultCharacterEncoding

setDefaultCharacterEncoding

setMinHeapSize

getMaxHeapSize

setMaxHeapSize

getJvmArgs

setJvmArgs

jvmArgs

jvmArgs

getEnableAssertions

setEnableAssertions

getDebug

setDebug

getAllJvmArgs

setAllJvmArgs

getEnvironment

environment

environment

setEnvironment

copyTo

copyTo

executeTests

addTestListener

addTestOutputListener

removeTestListener

removeTestOutputListener

beforeSuite

afterSuite

beforeTest

afterTest

onOutput

include

include

include

include

exclude

exclude

exclude

exclude

getTestClassesDir

setTestClassesDir

getTestResultsDir

setTestResultsDir

getTestReportDir

setTestReportDir

getIncludes

setIncludes

getExcludes

setExcludes

getIgnoreFailures

setIgnoreFailures

getTestFramework

testFramework