Package org.gradle.api.tasks.testing

## Class Test

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

- All Implemented Interfaces:
    `Comparable<Task>`, `org.gradle.api.internal.DynamicObjectAware`, `org.gradle.api.internal.IConventionAware`, `org.gradle.api.internal.TaskInternal`, `ExtensionAware`, `Reporting<TestTaskReports>`, `Task`, `PatternFilterable`, `VerificationTask`, `JavaForkOptions`, `ProcessForkOptions`, `org.gradle.util.Configurable<Task>`

      @NonNullApi
      @CacheableTask
      public class Test
      extends AbstractTestTask
      implements JavaForkOptions, PatternFilterable

  Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.

  The sample below shows various configuration options.

       apply plugin: 'java' // adds 'test' task

       test {
         // enable TestNG support (default is JUnit)
         useTestNG()
         // enable JUnit Platform (a.k.a. JUnit 5) support
         useJUnitPlatform()

         // set a system property for the test JVM(s)
         systemProperty 'some.prop', 'value'

         // explicitly include or exclude tests
         include 'org/foo/**'
         exclude 'org/boo/**'

         // show standard out and standard error of the test JVM(s) on the console
         testLogging.showStandardStreams = true

         // set heap size for the test JVM(s)
         minHeapSize = "128m"
         maxHeapSize = "512m"

         // set JVM arguments for the test JVM(s)
         jvmArgs '-XX:MaxPermSize=256m'

         // listen to events in the test execution lifecycle
         beforeTest { descriptor ->
            logger.lifecycle("Running test: " + descriptor)
         }

         // Fail the 'test' task on the first test failure
         failFast = true

         // listen to standard out and standard error of the test JVM(s)
         onOutput { descriptor, event ->
            logger.lifecycle("Test: " + descriptor + " produced standard out/err: " + event.message )
         }
       }

  The test process can be started in debug mode (see `getDebug()`) in an ad-hoc manner by supplying the `--debug-jvm` switch when invoking the build.

       gradle someTestTask --debug-jvm

- - ### 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_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `Test()` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `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.
    `protected org.gradle.api.internal.tasks.testing.TestExecuter<org.gradle.api.internal.tasks.testing.JvmTestExecutionSpec>` | `createTestExecuter()` | Creates test executer.
    `protected org.gradle.api.internal.tasks.testing.JvmTestExecutionSpec` | `createTestExecutionSpec()` | Creates test execution specification.
    `void` | `debugOptions​(Action<JavaDebugOptions> action)` | Configures Java Debug Wire Protocol properties for the process.
    `Test` | `environment​(String name, Object value)` | Adds an environment variable to the environment for this process.
    `Test` | `environment​(Map<String,​?> environmentVariables)` | Adds some environment variables 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​(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` | `executable​(Object executable)` | Sets the name of the executable to use.
    `void` | `executeTests()` |
    `void` | `filter​(Action<TestFilter> action)` | Executes the action against the `AbstractTestTask.getFilter()`.
    `protected org.gradle.internal.actor.ActorFactory` | `getActorFactory()` |
    `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.
    `protected org.gradle.api.internal.initialization.loadercache.ClassLoaderCache` | `getClassLoaderCache()` |
    `FileCollection` | `getClasspath()` | Returns the classpath to use to execute the tests.
    `boolean` | `getDebug()` | Determines whether debugging is enabled for the test process.
    `JavaDebugOptions` | `getDebugOptions()` | Returns the Java Debug Wire Protocol properties 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.
    `boolean` | `getFailFast()` | Indicates if this task will fail on the first failed test
    `long` | `getForkEvery()` | Returns the maximum number of test classes to execute in a forked test process.
    `protected org.gradle.process.internal.JavaForkOptionsFactory` | `getForkOptionsFactory()` |
    `Set<String>` | `getIncludes()` | Returns the include patterns for test execution.
    `protected org.gradle.internal.jvm.JavaModuleDetector` | `getJavaModuleDetector()` |
    `JavaVersion` | `getJavaVersion()` | Returns the version of Java used to run the tests based on the executable specified by `getExecutable()`.
    `List<String>` | `getJvmArgs()` | Returns the extra arguments to use to launch the JVM for the process.
    `List<CommandLineArgumentProvider>` | `getJvmArgumentProviders()` | Command line argument providers for the java process to fork.
    `String` | `getMaxHeapSize()` | Returns the maximum heap size for the process, if any.
    `int` | `getMaxParallelForks()` | Returns the maximum number of test processes to start in parallel.
    `String` | `getMinHeapSize()` | Returns the minimum heap size for the process, if any.
    `ModularitySpec` | `getModularity()` | Returns the module path handling of this test task.
    `protected org.gradle.api.internal.classpath.ModuleRegistry` | `getModuleRegistry()` |
    `protected List<String>` | `getNoMatchingTestErrorReasons()` | Returns the reasons for no matching test error.
    `protected ObjectFactory` | `getObjectFactory()` |
    `TestFrameworkOptions` | `getOptions()` | Returns test framework specific options.
    `protected org.gradle.internal.Factory<PatternSet>` | `getPatternSetFactory()` |
    `protected org.gradle.process.internal.worker.WorkerProcessFactory` | `getProcessBuilderFactory()` |
    `Map<String,​Object>` | `getSystemProperties()` | Returns the system properties which will be used for the process.
    `FileCollection` | `getTestClassesDirs()` | Returns the directories for the compiled test sources.
    `org.gradle.api.internal.tasks.testing.TestFramework` | `getTestFramework()` |
    `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​(String... includes)` | Adds include patterns for the files in the test classes directory (e.g.
    `Test` | `include​(Spec<FileTreeElement> includeSpec)` | Adds an include spec.
    `boolean` | `isScanForTestClasses()` | Specifies whether test classes should be detected.
    `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.
    `TestFrameworkOptions` | `options​(Closure testFrameworkConfigure)` | Configures test framework specific options.
    `TestFrameworkOptions` | `options​(Action<? super TestFrameworkOptions> testFrameworkConfigure)` | Configures test framework specific options.
    `void` | `setAllJvmArgs​(Iterable<?> arguments)` | Sets the full set of arguments to use to launch the JVM for the process.
    `void` | `setAllJvmArgs​(List<String> 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` | `setExecutable​(String executable)` | Sets the name of the executable to use.
    `void` | `setFailFast​(boolean failFast)` | Enables fail fast behavior causing the task to fail on the first failed test.
    `void` | `setForkEvery​(Long forkEvery)` | Sets the maximum number of test classes to execute in a forked test process.
    `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` | `setJvmArgs​(List<String> 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 test processes to start 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` | `setTestClassesDirs​(FileCollection testClassesDirs)` | Sets the directories to scan for compiled test sources.
    `Test` | `setTestNameIncludePatterns​(List<String> testNamePattern)` | Sets the test name patterns to be included in execution.
    `void` | `setWorkingDir​(File dir)` | Sets the working directory for the process.
    `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.
    `org.gradle.api.internal.tasks.testing.TestFramework` | `testFramework​(Closure testFrameworkConfigure)` |
    `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, configuring JUnit specific options.
    `void` | `useJUnit​(Action<? super JUnitOptions> testFrameworkConfigure)` | Specifies that JUnit should be used to execute the tests, configuring JUnit specific options.
    `void` | `useJUnitPlatform()` | Specifies that JUnit Platform (a.k.a.
    `void` | `useJUnitPlatform​(Action<? super JUnitPlatformOptions> testFrameworkConfigure)` | Specifies that JUnit Platform (a.k.a.
    `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, configuring TestNG specific options.
    `void` | `useTestNG​(Action<? super TestNGOptions> testFrameworkConfigure)` | Specifies that TestNG should be used to execute the tests, configuring TestNG specific options.
    `Test` | `workingDir​(Object dir)` | Sets the working directory for the process.

    - ### Methods inherited from class org.gradle.api.tasks.testing.AbstractTestTask

      `addTestListener, addTestOutputListener, afterSuite, afterTest, beforeSuite, beforeTest, getBinaryResultsDirectory, getBinResultsDir, getBuildOperationExecutor, getFileSystemOperations, getFilter, getHostnameLookup, getIgnoreFailures, getInstantiator, getListenerManager, getProgressLoggerFactory, getReports, getTestLogging, getTextOutputFactory, onOutput, removeTestListener, removeTestOutputListener, reports, reports, setBinResultsDir, setIgnoreFailures, testLogging, testLogging`

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

      `conventionMapping, conventionMapping, getConventionMapping`

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

      `appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Test

          public Test()

  - ### Method Detail

    - #### getObjectFactory

          @Inject
          protected ObjectFactory getObjectFactory()

    - #### getActorFactory

          @Inject
          protected org.gradle.internal.actor.ActorFactory getActorFactory()

    - #### getClassLoaderCache

          @Inject
          protected org.gradle.api.internal.initialization.loadercache.ClassLoaderCache getClassLoaderCache()

    - #### getProcessBuilderFactory

          @Inject
          protected org.gradle.process.internal.worker.WorkerProcessFactory getProcessBuilderFactory()

    - #### getPatternSetFactory

          @Inject
          protected org.gradle.internal.Factory<PatternSet> getPatternSetFactory()

    - #### getForkOptionsFactory

          @Inject
          protected org.gradle.process.internal.JavaForkOptionsFactory getForkOptionsFactory()

    - #### getModuleRegistry

          @Inject
          protected org.gradle.api.internal.classpath.ModuleRegistry getModuleRegistry()

    - #### getJavaModuleDetector

          @Inject
          protected org.gradle.internal.jvm.JavaModuleDetector getJavaModuleDetector()

    - #### getWorkingDir

          @Internal
          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​(File dir)

      Sets the working directory for the process.
      Specified by:
        `setWorkingDir` in interface `ProcessForkOptions`
      Parameters:
        `dir` - The working directory. Must not be null.

    - #### setWorkingDir

          public void setWorkingDir​(Object dir)

      Sets the working directory for the process. The supplied argument is evaluated as per `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 per `Project.file(Object)`.
      Specified by:
        `workingDir` in interface `ProcessForkOptions`
      Parameters:
        `dir` - The working directory. Must not be null.
      Returns:
        this

    - #### getJavaVersion

          @Input
          public JavaVersion getJavaVersion()

      Returns the version of Java used to run the tests based on the executable specified by `getExecutable()`.
      Since:
        3.3

    - #### getExecutable

          @Internal
          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​(String executable)

      Sets the name of the executable to use.
      Specified by:
        `setExecutable` in interface `ProcessForkOptions`
      Parameters:
        `executable` - The executable. Must not be null.

    - #### 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.

    - #### getJvmArgumentProviders

          public List<CommandLineArgumentProvider> getJvmArgumentProviders()

      Command line argument providers for the java process to fork.
      Specified by:
        `getJvmArgumentProviders` in interface `JavaForkOptions`

    - #### setJvmArgs

          public void setJvmArgs​(List<String> 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.

    - #### 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()

      Determines whether debugging is enabled for the test process. When enabled — `debug = true` — the process is started in a suspended state, listening on port 5005. You should disable parallel test execution when debugging and you will need to reattach the debugger occasionally if you use a non-zero value for `getForkEvery()`.

      Since Gradle 5.6, you can configure the port and other Java debug properties via `JavaForkOptions.debugOptions(Action)`.

      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.

      The debug properties (e.g. the port number) can be configured in `JavaForkOptions.debugOptions(Action)`.

      Specified by:
        `setDebug` in interface `JavaForkOptions`
      Parameters:
        `enabled` - true to enable debugging, false to disable.

    - #### getDebugOptions

          public JavaDebugOptions getDebugOptions()

      Returns the Java Debug Wire Protocol properties for the process. If enabled then the `-agentlib:jdwp=...` will be appended to the JVM arguments with the configuration from the parameter.
      Specified by:
        `getDebugOptions` in interface `JavaForkOptions`

    - #### debugOptions

          public void debugOptions​(Action<JavaDebugOptions> action)

      Configures Java Debug Wire Protocol properties for the process. If `JavaForkOptions.setDebug(boolean)` is enabled then the `-agentlib:jdwp=...` will be appended to the JVM arguments with the configuration from the parameter.
      Specified by:
        `debugOptions` in interface `JavaForkOptions`
      Parameters:
        `action` - the Java debug configuration

    - #### setFailFast

          public void setFailFast​(boolean failFast)

      Enables fail fast behavior causing the task to fail on the first failed test.

    - #### getFailFast

          public boolean getFailFast()

      Indicates if this task will fail on the first failed test
      Returns:
        whether this task will fail on the first failed test

    - #### 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​(List<String> 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.

    - #### 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

          @Internal
          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

    - #### getModularity

          @Incubating
          public ModularitySpec getModularity()

      Returns the module path handling of this test task.
      Since:
        6.4

    - #### createTestExecutionSpec

          protected org.gradle.api.internal.tasks.testing.JvmTestExecutionSpec createTestExecutionSpec()

      Creates test execution specification. For internal use only.
      Specified by:
        `createTestExecutionSpec` in class `AbstractTestTask`
      Since:
        4.4

    - #### executeTests

          public void executeTests()

      Overrides:
        `executeTests` in class `AbstractTestTask`

    - #### createTestExecuter

          protected org.gradle.api.internal.tasks.testing.TestExecuter<org.gradle.api.internal.tasks.testing.JvmTestExecutionSpec> createTestExecuter()

      Description copied from class: `AbstractTestTask`
      Creates test executer. For internal use only.
      Specified by:
        `createTestExecuter` in class `AbstractTestTask`

    - #### getNoMatchingTestErrorReasons

          protected List<String> getNoMatchingTestErrorReasons()

      Description copied from class: `AbstractTestTask`
      Returns the reasons for no matching test error.
      Overrides:
        `getNoMatchingTestErrorReasons` in class `AbstractTestTask`

    - #### include

          public Test include​(String... includes)

      Adds include patterns for the files in the test classes directory (e.g. '**/*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. '**/*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. '**/*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. '**/*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. The closure should return true or false. Example:

           copySpec {
             from 'source'
             into 'destination'
             //an example of excluding files from certain configuration:
             exclude { it.file in configurations.someConf.files }
           }

      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:
        `FileTreeElement`

    - #### setTestNameIncludePatterns

          public Test setTestNameIncludePatterns​(List<String> testNamePattern)

      Sets the test name patterns to be included in execution. Classes or method names are supported, wildcard '*' is supported. For more information see the user guide chapter on testing. For more information on supported patterns see `TestFilter`
      Overrides:
        `setTestNameIncludePatterns` in class `AbstractTestTask`

    - #### getTestClassesDirs

          @Internal
          public FileCollection getTestClassesDirs()

      Returns the directories for the compiled test sources.
      Returns:
        All test class directories to be used.
      Since:
        4.0

    - #### setTestClassesDirs

          public void setTestClassesDirs​(FileCollection testClassesDirs)

      Sets the directories to scan for compiled test sources. Typically, this would be configured to use the output of a source set:

           apply plugin: 'java'

           sourceSets {
              integrationTest {
                 compileClasspath += main.output
                 runtimeClasspath += main.output
              }
           }

           task integrationTest(type: Test) {
               // Runs tests from src/integrationTest
               testClassesDirs = sourceSets.integrationTest.output.classesDirs
               classpath = sourceSets.integrationTest.runtimeClasspath
           }

      Parameters:
        `testClassesDirs` - All test class directories to be used.
      Since:
        4.0

    - #### getIncludes

          @Internal
          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

          @Internal
          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...)`

    - #### getTestFramework

          @Internal
          public org.gradle.api.internal.tasks.testing.TestFramework getTestFramework()

    - #### testFramework

          public org.gradle.api.internal.tasks.testing.TestFramework testFramework​(@Nullable
                                                                                   Closure testFrameworkConfigure)

    - #### getOptions

          public TestFrameworkOptions getOptions()

      Returns test framework specific options. Make sure to call `useJUnit()`, `useJUnitPlatform()` or `useTestNG()` before using this method.
      Returns:
        The test framework options.

    - #### options

          public TestFrameworkOptions options​(Closure testFrameworkConfigure)

      Configures test framework specific options. Make sure to call `useJUnit()`, `useJUnitPlatform()` or `useTestNG()` before using this method.
      Returns:
        The test framework options.

    - #### options

          public TestFrameworkOptions options​(Action<? super TestFrameworkOptions> testFrameworkConfigure)

      Configures test framework specific options. Make sure to call `useJUnit()`, `useJUnitPlatform()` or `useTestNG()` before using this method.
      Returns:
        The test framework options.
      Since:
        3.5

    - #### useJUnit

          public void useJUnit()

      Specifies that JUnit should be used to execute the tests.

      To configure JUnit specific options, see `useJUnit(groovy.lang.Closure)`.

    - #### useJUnit

          public void useJUnit​(@Nullable
                               Closure testFrameworkConfigure)

      Specifies that JUnit should be used to execute the tests, configuring JUnit specific options.

      The supplied closure configures an instance of `JUnitOptions`, which can be used to configure how JUnit runs.

      Parameters:
        `testFrameworkConfigure` - A closure used to configure the JUnit options.

    - #### useJUnit

          public void useJUnit​(Action<? super JUnitOptions> testFrameworkConfigure)

      Specifies that JUnit should be used to execute the tests, configuring JUnit specific options.

      The supplied action configures an instance of `JUnitOptions`, which can be used to configure how JUnit runs.

      Parameters:
        `testFrameworkConfigure` - An action used to configure the JUnit options.
      Since:
        3.5

    - #### useJUnitPlatform

          public void useJUnitPlatform()

      Specifies that JUnit Platform (a.k.a. JUnit 5) should be used to execute the tests.

      To configure JUnit platform specific options, see `useJUnitPlatform(Action)`.

      Since:
        4.6

    - #### useJUnitPlatform

          public void useJUnitPlatform​(Action<? super JUnitPlatformOptions> testFrameworkConfigure)

      Specifies that JUnit Platform (a.k.a. JUnit 5) should be used to execute the tests, configuring JUnit platform specific options.

      The supplied action configures an instance of `JUnitPlatformOptions`, which can be used to configure how JUnit platform runs.

      Parameters:
        `testFrameworkConfigure` - An action used to configure the JUnit platform options.
      Since:
        4.6

    - #### useTestNG

          public void useTestNG()

      Specifies that TestNG should be used to execute the tests.

      To configure TestNG specific options, see `useTestNG(Closure)`.

    - #### useTestNG

          public void useTestNG​(Closure testFrameworkConfigure)

      Specifies that TestNG should be used to execute the tests, configuring TestNG specific options.

      The supplied closure configures an instance of `TestNGOptions`, which can be used to configure how TestNG runs.

      Parameters:
        `testFrameworkConfigure` - A closure used to configure the TestNG options.

    - #### useTestNG

          public void useTestNG​(Action<? super TestNGOptions> testFrameworkConfigure)

      Specifies that TestNG should be used to execute the tests, configuring TestNG specific options.

      The supplied action configures an instance of `TestNGOptions`, which can be used to configure how TestNG runs.

      Parameters:
        `testFrameworkConfigure` - An action used to configure the TestNG options.
      Since:
        3.5

    - #### getClasspath

          @Classpath
          public FileCollection getClasspath()

      Returns the classpath to use to execute the tests.

    - #### setClasspath

          public void setClasspath​(FileCollection classpath)

    - #### isScanForTestClasses

          @Input
          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

          @Internal
          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.

      By default, Gradle automatically uses a separate JVM when executing tests.

      - A value of `0` (no limit) means to reuse the test process for all test classes. This is the default.
      - A value of `1` means that a new test process is started for every test class. This is very expensive.
      - A value of `N` means that a new test process is started after `N` test classes.
      This property can have a large impact on performance due to the cost of stopping and starting each test process. It is unusual for this property to be changed from the default.
      Returns:
        The maximum number of test classes to execute in a test process. Returns 0 when there is no maximum.

    - #### setForkEvery

          public void setForkEvery​(@Nullable
                                   Long forkEvery)

      Sets the maximum number of test classes to execute in a forked test process.

      By default, Gradle automatically uses a separate JVM when executing tests, so changing this property is usually not necessary.

      Parameters:
        `forkEvery` - The maximum number of test classes. Use null or 0 to specify no maximum.

    - #### getMaxParallelForks

          @Internal
          public int getMaxParallelForks()

      Returns the maximum number of test processes to start in parallel.

      By default, Gradle executes a single test class at a time.

      - A value of `1` means to only execute a single test class in a single test process at a time. This is the default.
      - A value of `N` means that up to `N` test processes will be started to execute test classes. This can improve test execution time by running multiple test classes in parallel.
      This property cannot exceed the value of max-workers for the current build. Gradle will also limit the number of started test processes across all `Test` tasks.
      Returns:
        The maximum number of forked test processes.

    - #### setMaxParallelForks

          public void setMaxParallelForks​(int maxParallelForks)

      Sets the maximum number of test processes to start in parallel.

      By default, Gradle executes a single test class at a time but allows multiple `Test` tasks to run in parallel.

      Parameters:
        `maxParallelForks` - The maximum number of forked test processes. Use 1 to disable parallel test execution for this task.

    - #### getCandidateClassFiles

          @PathSensitive(RELATIVE)
          @InputFiles
          @SkipWhenEmpty
          public FileTree getCandidateClassFiles()

      Returns the classes files to scan for test classes.
      Returns:
        The candidate class files.

    - #### filter

          public void filter​(Action<TestFilter> action)

      Executes the action against the `AbstractTestTask.getFilter()`.
      Parameters:
        `action` - configuration of the test filter
      Since:
        1.10