TestGenerator (gradletest 4.2.1 API)

org.ysb33r.gradle.gradletest.TestGenerator

```
@groovy.transform.CompileStatic
class TestGenerator
extends org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask
```
Generates test files that will be compiled against GradleTestKit and project files for execution.
Both the test task and the compile task are the dependent on this task executing correctly.

Since:
1.0

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	`__$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Provider<File>`	`projectOutputDir`
`Provider<File>`	`sourceOutputDir`
`Provider<File>`	`testRootDirectory`

Constructor Summary

Constructors
Constructor and description
`TestGenerator ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exec()`
	`Provider<File>`	`getProjectOutputDir()` The toplevel directory where the project is generated into.
	`Provider<File>`	`getSourceOutputDir()` The directory where code is generated into.
	`Provider<File>`	`getTestRootDirectory()` The root directory where to find tests for this specific GradleTest grouping The default root directory by convention is `src/gradleTest`.
	`void`	`setCleanCache(Provider<Boolean> cc)` Sets whether the cache should be cleaned before each test run.
	`void`	`setConfigurationCacheMap(Provider<java.util.Map<String, ConfigurationCacheMode>> ccMap)` Sets the configuration cache mapping for Gradle versions.
	`void`	`setCopyOverSymlink(Provider<Boolean> mode)` Whether copies rather than symlinks should be performed when generating the project structure..
	`void`	`setDebug(Provider<Boolean> dbg)` Whether debug should be available on tests.
	`void`	`setDebugWarnings(Provider<Boolean> dbg)` Sets whether warnings about turning debug off on tests are printed.
	`void`	`setDeprecationMessagesMap(Provider<DeprecationMessagesMap> map)` Configures a map that will return the deprecation message patterns on a per Gradle-version basis.
	`void`	`setExpectedFailures(Provider<java.util.List<java.util.regex.Pattern>> patterns)` Sets which test groups are expected to fail.
	`void`	`setGradleArguments(Provider<java.util.List<String>> args)` Sets additional arguments that must be passed to Gradle.
	`void`	`setGradleDistributionURI(Provider<URI> uriProvider)` Set a location from where to get Gradle distributions from.
	`void`	`setManifestFile(Provider<File> manifest)` Custom manifest.
	`void`	`setPackageName(Provider<String> pkg)` Sets the package name.
	`void`	`setProjectOutputDir(Provider<File> out)` Sets the toplevel directory where the project is generated into.
	`void`	`setSourceOutputDir(Provider<File> out)` Sets the toplevel directory where code is to be generated into.
	`void`	`setTaskToRun(Provider<String> taskName)` Sets the task to run inside the project.
	`void`	`setTestKitStrategy(Provider<TestKitLocations> tkl)` Sets the testkit sharing strategy.
	`void`	`setTestMapProvider(Provider<java.util.List<BasicTestDefinition>> testMap)` Provides the map of test definitions.
	`void`	`setTestRootDirectory(Provider<File> srcDir)` Sets the source directory for tests.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#projectTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#providerTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#fsOperations(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#stringTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#execTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#jvmTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#problemReporter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMetaClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getName(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(org.gradle.api.Task), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogger(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getExtensions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#property(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDescription(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setGroup(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAnt(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogging(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDidWork(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDestroyables(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLocalState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDir(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#mustRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMustRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMustRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#finalizedBy([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setFinalizedBy(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getFinalizedBy(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#shouldRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setShouldRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getShouldRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTimeout(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#usesService(org.gradle.api.provider.Provider), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getGroup(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setActions(java.util.List), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDependsOn(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDependsOn(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#dependsOn([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDidWork(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDescription(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setEnabled(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAsDynamicObject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getConvention(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doNotTrackState(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notCompatibleWithConfigurationCache(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getIdentityPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getSharedResources(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getStandardOutputCapture(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#acceptServiceReferences(java.util.Set), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskIdentity(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOnlyIf(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonNotToTrackState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isCompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonTaskIsIncompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getImpliesSubProjects(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setImpliesSubProjects(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDirFactory(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isHasCustomActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getRequiredServices(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long, int), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#equals(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#toString(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hashCode(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notify(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notifyAll(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#invokeMethod(java.lang.String, java.lang.Object)

- Property Detail
  - Provider<File> projectOutputDir
  - Provider<File> sourceOutputDir
  - Provider<File> testRootDirectory
- Constructor Detail
  - @SuppressWarnings(value: AbcMetric) TestGenerator()
- Method Detail
  - @TaskAction void exec()
  - @OutputDirectory Provider<File> getProjectOutputDir()
    
    The toplevel directory where the project is generated into.
    Returns:
    Output directory.
    Since:
    4.0
  - @OutputDirectory Provider<File> getSourceOutputDir()
    
    The directory where code is generated into.
    Returns:
    Output directory.
    Since:
    4.0
  - @InputDirectory @Optional @IgnoreEmptyDirectories @SkipWhenEmpty Provider<File> getTestRootDirectory()
    
    The root directory where to find tests for this specific GradleTest grouping The default root directory by convention is src/gradleTest. The patterns for the directory is src/ + gradleTestSetName.
    Returns:
    The directory as a file object resolved as per project.file ( ).
  - void setCleanCache(Provider<Boolean> cc)
    
    Sets whether the cache should be cleaned before each test run.
    Parameters:
    cc - Check provider.
    Since:
    4.0
  - void setConfigurationCacheMap(Provider<java.util.Map<String, ConfigurationCacheMode>> ccMap)
    
    Sets the configuration cache mapping for Gradle versions.
    For older versions of Gradle, configuration cache will not be used.
    
    Parameters:
    ccMap - mapping
    Since:
    4.0
  - void setCopyOverSymlink(Provider<Boolean> mode)
    
    Whether copies rather than symlinks should be performed when generating the project structure..
    Parameters:
    dbg - Preference provider. true means copies will be made.
    Since:
    4.0
  - void setDebug(Provider<Boolean> dbg)
    
    Whether debug should be available on tests.
    Parameters:
    dbg - Debug mode
    Since:
    4.0
  - void setDebugWarnings(Provider<Boolean> dbg)
    
    Sets whether warnings about turning debug off on tests are printed.
    When warnings are turned off, they are sent to the debug logger instead.
    
    Parameters:
    dbg - Debug warnings mode.
    Since:
    4.0
  - void setDeprecationMessagesMap(Provider<DeprecationMessagesMap> map)
    
    Configures a map that will return the deprecation message patterns on a per Gradle-version basis.
    Parameters:
    map - Maps Gradle versions to deprecation message checks.
    Since:
    4.0
  - void setExpectedFailures(Provider<java.util.List<java.util.regex.Pattern>> patterns)
    
    Sets which test groups are expected to fail.
    Parameters:
    patterns - Failure patterns.
  - void setGradleArguments(Provider<java.util.List<String>> args)
    
    Sets additional arguments that must be passed to Gradle.
    Parameters:
    args - Provider of arguments.
    Since:
    4.0
  - void setGradleDistributionURI(Provider<URI> uriProvider)
    
    Set a location from where to get Gradle distributions from.
    Parameters:
    uriProvider - Location provider.
  - void setManifestFile(Provider<File> manifest)
    
    Custom manifest.
    Parameters:
    manifest - Sets a provider for a manifest file.
    Since:
    4.0
  - void setPackageName(Provider<String> pkg)
    
    Sets the package name.
    Parameters:
    pkg - Name of package.
    Since:
    4.0
  - void setProjectOutputDir(Provider<File> out)
    
    Sets the toplevel directory where the project is generated into.
    Parameters:
    out - Output directory provider.
    Since:
    4.0
  - void setSourceOutputDir(Provider<File> out)
    
    Sets the toplevel directory where code is to be generated into.
    Parameters:
    out - Output directory provider.
    Since:
    4.0
  - void setTaskToRun(Provider<String> taskName)
    
    Sets the task to run inside the project.
    Parameters:
    taskName - Task name.
    Since:
    4.0
  - void setTestKitStrategy(Provider<TestKitLocations> tkl)
    
    Sets the testkit sharing strategy.
    Parameters:
    tkl
  - void setTestMapProvider(Provider<java.util.List<BasicTestDefinition>> testMap)
    
    Provides the map of test definitions.
    Parameters:
    testMap - Test definitions map.
    Since:
    4.0
  - void setTestRootDirectory(Provider<File> srcDir)
    
    Sets the source directory for tests.
    Parameters:
    srcDir - Source directory
    Since:
    4.0

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TestGenerator

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Provider<File> projectOutputDir

Provider<File> sourceOutputDir

Provider<File> testRootDirectory

Constructor Detail

@SuppressWarnings(value: AbcMetric) TestGenerator()

Method Detail

@TaskAction void exec()

@OutputDirectory Provider<File> getProjectOutputDir()

@OutputDirectory Provider<File> getSourceOutputDir()

@InputDirectory @Optional @IgnoreEmptyDirectories @SkipWhenEmpty Provider<File> getTestRootDirectory()

void setCleanCache(Provider<Boolean> cc)

void setConfigurationCacheMap(Provider<java.util.Map<String, ConfigurationCacheMode>> ccMap)

void setCopyOverSymlink(Provider<Boolean> mode)

void setDebug(Provider<Boolean> dbg)

void setDebugWarnings(Provider<Boolean> dbg)

void setDeprecationMessagesMap(Provider<DeprecationMessagesMap> map)

void setExpectedFailures(Provider<java.util.List<java.util.regex.Pattern>> patterns)

void setGradleArguments(Provider<java.util.List<String>> args)

void setGradleDistributionURI(Provider<URI> uriProvider)

void setManifestFile(Provider<File> manifest)

void setPackageName(Provider<String> pkg)

void setProjectOutputDir(Provider<File> out)

void setSourceOutputDir(Provider<File> out)

void setTaskToRun(Provider<String> taskName)

void setTestKitStrategy(Provider<TestKitLocations> tkl)

void setTestMapProvider(Provider<java.util.List<BasicTestDefinition>> testMap)

void setTestRootDirectory(Provider<File> srcDir)