GradleTestSet (gradletest 4.0.2 API)

org.ysb33r.gradle.gradletest.GradleTestSet

All Implemented Interfaces and Traits:: Named

@groovy.transform.CompileStatic
@SuppressWarnings(value: MethodCount)
class GradleTestSet
extends Object
implements Named

Defines a GradleTest test set.

Authors:: Schalk W. Cronjé

Since:: 4.0

Field Summary

Fields
Modifiers	Name	Description
`static java.util.List<String>`	`DEFAULT_DEPRECATION_WARNINGS`

Properties Summary

Properties
Type	Name and description
`java.util.List<String>`	`defaultDeprecationMessageChecks`
`Provider<String>`	`defaultTaskToRun`
`Provider<DeprecationMessagesMap>`	`deprecationMessagesAreFailures`
`Provider<File>`	`generatedSourceDir`
`Provider<URI>`	`gradleDistributionURI`
`String`	`name`
`Provider<File>`	`sourceDirectory`
`Provider<java.util.Set<String>>`	`versions`

Constructor Summary

Constructors
Constructor and description
`GradleTestSet (String name, GradleTestSetExtension parent, Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`augmentMessageChecksForVersionFromDefault(String version, String[] msgPatterns)` Initialises a set of messages for a version vy copying the current default set and then adding additional set.
	`void`	`augmentMessageChecksForVersionFromDefault(String version, java.util.Collection<String> msgPatterns)` Initialises a set of messages for a version vy copying the current default set and then adding additional set.
	`void`	`configurationCacheMapping(java.util.function.Function<String, ConfigurationCacheMode> mapper)` Sets a mapper that determines which Gradle versions should active which kind of configuration cache checks.
	`void`	`configurationCacheMappingByAlias(java.util.function.Function<String, String> mapper)` Like configurationCacheMapping, but returns a case-insensitive string value which can then be converted by the test set.
	`void`	`copyNotSymlink()` By default, project structures are symlinked back to the files in the project source directory.
	`void`	`defaultDeprecationMessageChecks(String[] msgPatterns)` Add deprecation message patterns to the default message sets.
	`void`	`defaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)` Add deprecation message patterns to the default message sets.
	`void`	`deprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)` Modifies the deprecation messages this for a specific Gradle version.
	`void`	`deprecationMessageChecksForVersion(String version, String[] msgPatterns)` Modifies the deprecation messages this for a specific Gradle version.
	`void`	`expectedFailures(String[] patterns)` Set which tests are expected to fail.
	`void`	`expectedFailures(java.util.regex.Pattern[] patterns)` Set which tests are expected to fail.
	`Provider<Boolean>`	`getCleanCache()` Whether the Gradle cache should be cleaned before each test tun..
	`Provider<java.util.Map<String, ConfigurationCacheMode>>`	`getConfigurationCacheModeMapping()` A provider that maps configuration cache setup.
	`Provider<Boolean>`	`getCopyOverSymlink()` Whether copy should be preferred over symlinks.
	`String`	`getCustomTestManifestTaskName()` Returns the name of the task that will generate the Gradle manifest for this test set.
	`Provider<Boolean>`	`getDebug()` A provider to indicate debug mode.
	`java.util.List<String>`	`getDefaultDeprecationMessageChecks()` Returns the list of default deprecation messages.
	`Provider<String>`	`getDefaultTaskToRun()` Name of the task to run inside the Gradle test project.
	`Provider<DeprecationMessagesMap>`	`getDeprecationMessagesAreFailures()` Returns a map for every testable version which indicates whether deprecation messages should be checked for that version.
	`Provider<java.util.List<java.util.regex.Pattern>>`	`getExpectedFailures()` Test groups which are expected to fail.
	`Provider<File>`	`getGeneratedSourceDir()` The top-level directory for sources will be generated into for this source set.
	`Provider<java.util.List<String>>`	`getGradleArguments()` Additional arguments to pass to gradle when running the test.
	`Provider<URI>`	`getGradleDistributionURI()` Get an alternative location where to get Gradle distributions from.
	`Provider<String>`	`getPackage()` The package to be used for tests in this set.
	`Provider<File>`	`getSourceDirectory()` The root directory where to find tests for this specific GradleTest grouping The default root directory by convention is `src/gradleTest`.
	`Provider<TestKitLocations>`	`getTestKitStrategy()` A strategy for storing TestKit related data.
	`String`	`getTestSourceGeneratorTaskName()` Returns the name of the task that will generate source for this test set.
	`String`	`getTestTaskName()` Returns the name of the test task associated with this test set.
	`Provider<java.util.Set<String>>`	`getVersions()` Returns the set of Gradle versions to tests against.
	`void`	`gradleArguments(Object[] args)` Additional Gradle arguments to pass.
	`void`	`gradleArguments(java.util.List<Object> args)` Additional Gradle arguments to pass.
	`void`	`replaceDeprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)` Replaces the current set of messages for a specific version with a new set..
	`void`	`setCleanCache(boolean flag)` Whether cache should be clean before each test run.
	`void`	`setDebug(boolean flag)` Whether debug should be enabled for tests.
	`void`	`setDefaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)` Replace the set of default deprevation messages.
	`void`	`setDefaultTaskToRun(String taskName)` Overrides the default task to run inside the Gradle test project.
	`void`	`setDeprecationMessagesAreFailures(java.util.function.Predicate<String> forVersions)` Set whether deprecation message should fail the build.
	`void`	`setDeprecationMessagesAreFailuresForAllVersions(Boolean flag)` Turns deprecation checking on or off for all Gradle versions.
	`void`	`setGeneratedSourceDir(Object out)` Override the directory where sources are generated into.
	`void`	`setGradleDistributionURI(Object uri)` Sets the location of where to fetch Gradle distributions from.
	`void`	`setSourceDirectory(Object src)` Overrides the default location of test project sources.
	`void`	`setVersions(java.util.Collection<Object> ver)` Replace all previously defined versions.
	`void`	`testKitDirectoryPerGroup()` Keep the Testkit data, but share the directory between the complete testset.
	`void`	`testKitDirectoryPerTest()` Keep one TestKit directory per test.
	`void`	`testKitDirectoryShared()` Shares the testkit directory between all tests.
	`void`	`useCustomManifest()` Indicate that a custom manifest file must be used.
	`void`	`versions(Object[] ver)` Add Gradle versions to be tested against.
	`void`	`versions(Iterable<Object> ver)` Add Gradle versions to be tested against.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final java.util.List<String> DEFAULT_DEPRECATION_WARNINGS
- Property Detail
  - java.util.List<String> defaultDeprecationMessageChecks
  - Provider<String> defaultTaskToRun
  - Provider<DeprecationMessagesMap> deprecationMessagesAreFailures
  - Provider<File> generatedSourceDir
  - Provider<URI> gradleDistributionURI
  - final String name
  - Provider<File> sourceDirectory
  - Provider<java.util.Set<String>> versions
- Constructor Detail
  - @javax.inject.Inject @SuppressWarnings(value: AbcMetric) GradleTestSet(String name, GradleTestSetExtension parent, Project project)
- Method Detail
  - void augmentMessageChecksForVersionFromDefault(String version, String[] msgPatterns)
    
    Initialises a set of messages for a version vy copying the current default set and then adding additional set.
    Once this method is called, even if no mods are made, the specific Gradle version will no longer use the default set.
    
    Parameters:
    version - Gradle version to customise
    Returns:
    List of messages that can be modified.
  - void augmentMessageChecksForVersionFromDefault(String version, java.util.Collection<String> msgPatterns)
    
    Initialises a set of messages for a version vy copying the current default set and then adding additional set.
    Once this method is called, even if no mods are made, the specific Gradle version will no longer use the default set.
    
    Parameters:
    version - Gradle version to customise
    Returns:
    List of messages that can be modified.
  - void configurationCacheMapping(java.util.function.Function<String, ConfigurationCacheMode> mapper)
    
    Sets a mapper that determines which Gradle versions should active which kind of configuration cache checks.
    Parameters:
    mapper - Gradle version in, cache-mode out.
  - void configurationCacheMappingByAlias(java.util.function.Function<String, String> mapper)
    
    Like configurationCacheMapping, but returns a case-insensitive string value which can then be converted by the test set.
    This makes it easier to use in a DSL.
    
    Parameters:
    mapper - Gradle version in, cache-mode string value out.
  - void copyNotSymlink()
    
    By default, project structures are symlinked back to the files in the project source directory. This saves a lot of disk space and speeds things up. This can cause issues if the test writes anything back into directory that was symlinked. This behaviour can be turned off, so that everything is copied.
    When turned off, directories are copied, but single files at the toplevel of the project are still symlinked.
  - void defaultDeprecationMessageChecks(String[] msgPatterns)
    
    Add deprecation message patterns to the default message sets.
    Parameters:
    msgPatterns - Additional set of patterns
  - void defaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)
    
    Add deprecation message patterns to the default message sets.
    Parameters:
    msgPatterns - Additional set of patterns
  - void deprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)
    
    Modifies the deprecation messages this for a specific Gradle version.
    Once this method is called, even if no mods are made, the specific Gradle version will no longer use the default set.
    
    Parameters:
    version - Gradle version to customise
    Returns:
    List of messages that can be modified.
  - void deprecationMessageChecksForVersion(String version, String[] msgPatterns)
    
    Modifies the deprecation messages this for a specific Gradle version.
    Once this method is called, even if no mods are made, the specific Gradle version will no longer use the default set.
    
    Parameters:
    version - Gradle version to customise
    Returns:
    List of messages that can be modified.
  - void expectedFailures(String[] patterns)
    
    Set which tests are expected to fail.
    Parameters:
    patterns - Regex patterns. These should match the name of the GradleTest folder i.e. for src/gradleTest/myTest, then it should try to match on myTest.
  - void expectedFailures(java.util.regex.Pattern[] patterns)
    
    Set which tests are expected to fail.
    Parameters:
    patterns - Regex patterns. These should match the name of the GradleTest folder i.e. for src/gradleTest/myTest, then it should try to match on myTest.
  - Provider<Boolean> getCleanCache()
    
    Whether the Gradle cache should be cleaned before each test tun..
    The default is to clean the cache. Not cleaning the cache results in slightly faster runs, but can have hard-to-diagnose issues.
    @return
  - Provider<java.util.Map<String, ConfigurationCacheMode>> getConfigurationCacheModeMapping()
    
    A provider that maps configuration cache setup.
    Returns:
    A mapping for each Gradle version.
  - Provider<Boolean> getCopyOverSymlink()
    
    Whether copy should be preferred over symlinks.
    The default is to use symlinks.
    
    Returns:
    Provider that indicates the preference.
  - String getCustomTestManifestTaskName()
    
    Returns the name of the task that will generate the Gradle manifest for this test set.
    This will return a name, but this does no guarantee that it will be used. In order for it to be used, useCustomManifest has to be called.
    
    Returns:
    Task name
  - Provider<Boolean> getDebug()
    
    A provider to indicate debug mode. @return
  - java.util.List<String> getDefaultDeprecationMessageChecks()
    
    Returns the list of default deprecation messages.
    This list can be modified and messages added or removed.
    
    Returns:
    Message list
  - Provider<String> getDefaultTaskToRun()
    
    Name of the task to run inside the Gradle test project.
    The default is runGradleTest.
    
    Returns:
    Task name
  - Provider<DeprecationMessagesMap> getDeprecationMessagesAreFailures()
    
    Returns a map for every testable version which indicates whether deprecation messages should be checked for that version.
    If deprecation warnings should not be checked the list of test patterns will be empty, otherwise it will contain a list of regex patterns.
    
    Returns:
    Deprecation messages check.
  - Provider<java.util.List<java.util.regex.Pattern>> getExpectedFailures()
    
    Test groups which are expected to fail.
    Returns:
    List of patterns to match against test names.
  - Provider<File> getGeneratedSourceDir()
    
    The top-level directory for sources will be generated into for this source set.
    Returns:
    Output directory
  - Provider<java.util.List<String>> getGradleArguments()
    
    Additional arguments to pass to gradle when running the test.
    Returns:
    Provider to additional arguments
  - Provider<URI> getGradleDistributionURI()
    
    Get an alternative location where to get Gradle distributions from.
    The location is expected to store Gradle packages in the standard format.
    
    Returns:
    Location of Gradle distributions. Can be empty.
  - Provider<String> getPackage()
    
    The package to be used for tests in this set.
    Returns:
    Package name
  - Provider<File> getSourceDirectory()
    
    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 ( ).
  - Provider<TestKitLocations> getTestKitStrategy()
    
    A strategy for storing TestKit related data. The default is to discard testkit data after tests.
  - String getTestSourceGeneratorTaskName()
    
    Returns the name of the task that will generate source for this test set.
    Returns:
    Task name
  - String getTestTaskName()
    
    Returns the name of the test task associated with this test set.
    Returns:
    Task name
  - Provider<java.util.Set<String>> getVersions()
    
    Returns the set of Gradle versions to tests against.
    If a Gradle or system property similar to gradleTest.versions or an environment variable similar to GRADLETEST_VERSIONS is specified, it will return the versions parsed from that instead.
    
    Returns:
    Set of unique versions.
  - void gradleArguments(Object[] args)
    
    Additional Gradle arguments to pass.
    Parameters:
    args - Command-line arguments.
  - void gradleArguments(java.util.List<Object> args)
    
    Additional Gradle arguments to pass.
    Parameters:
    args - Command-line arguments.
  - void replaceDeprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)
    
    Replaces the current set of messages for a specific version with a new set..
    Once this method is called, even if no mods are made, the specific Gradle version will no longer use the default set.
    
    Parameters:
    version - Gradle version to customise
    Returns:
    List of messages that can be modified.
  - void setCleanCache(boolean flag)
    
    Whether cache should be clean before each test run.
    Parameters:
    flag - false turns cache cleaning off..
  - void setDebug(boolean flag)
    
    Whether debug should be enabled for tests.
    Even if debug is et, for certain tests, it might remain disabled, especially for older version of Gradle with Kotlin DSL, or for configuration cache.
    
    Parameters:
    flag - true turns debug on.
  - void setDefaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)
    
    Replace the set of default deprevation messages.
    Parameters:
    msgPatterns - New set of patterns.
  - void setDefaultTaskToRun(String taskName)
    
    Overrides the default task to run inside the Gradle test project.
    Parameters:
    taskName - New task name
  - void setDeprecationMessagesAreFailures(java.util.function.Predicate<String> forVersions)
    
    Set whether deprecation message should fail the build.
    Overrides previous calls to setDeprecationMessagesAreFailuresForAllVersions.
    
    Parameters:
    forVersions - Indicates for which Gradle test versions, deprecation versions should be checked.
  - void setDeprecationMessagesAreFailuresForAllVersions(Boolean flag)
    
    Turns deprecation checking on or off for all Gradle versions.
    Overrides previous calls to setDeprecationMessagesAreFailures.
    
    Parameters:
    flag - true turns on warnings check for all versions.
  - void setGeneratedSourceDir(Object out)
    
    Override the directory where sources are generated into.
    Parameters:
    out - Target directory
  - void setGradleDistributionURI(Object uri)
    
    Sets the location of where to fetch Gradle distributions from.
    Parameters:
    uri - Location URI. Can be a string or a File, or anything that can be converted to a URI.
  - void setSourceDirectory(Object src)
    
    Overrides the default location of test project sources.
    Parameters:
    src - The location of the gradle test project sources.
  - void setVersions(java.util.Collection<Object> ver)
    
    Replace all previously defined versions.
    Parameters:
    ver - List of versions. The values are evaluated immediately.
  - void testKitDirectoryPerGroup()
    
    Keep the Testkit data, but share the directory between the complete testset.
  - void testKitDirectoryPerTest()
    
    Keep one TestKit directory per test. This options uses the most space, but allows detailed analysis per test.
  - void testKitDirectoryShared()
    
    Shares the testkit directory between all tests. Tests run slightly faster, but problems can be harder to diagnose.
  - void useCustomManifest()
    
    Indicate that a custom manifest file must be used.
    This will use a custom manifest, even if the java-gradle-plugin has been applied. It will use the runtime classpath for the source set of this test set. Additional dependencies can be added to the runtimeOnly configuration of the source set associated with this testset. This will be gradleTestRuntimeOnly for the main testset or something like myExtraGradleTestRuntimeOnly for a test set called myExtra.
    
    This also adds a task called gradleTestClasspathManifest. For a test set called myExtra, it will be called myExtraGradleTestClasspathManifest.
  - void versions(Object[] ver)
    
    Add Gradle versions to be tested against.
    Parameters:
    ver - List of versions
  - void versions(Iterable<Object> ver)
    
    Add Gradle versions to be tested against.
    Parameters:
    ver - List of versions The values are evaluated immediately.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GradleTestSet

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.util.List<String> DEFAULT_DEPRECATION_WARNINGS

Property Detail

java.util.List<String> defaultDeprecationMessageChecks

Provider<String> defaultTaskToRun

Provider<DeprecationMessagesMap> deprecationMessagesAreFailures

Provider<File> generatedSourceDir

Provider<URI> gradleDistributionURI

final String name

Provider<File> sourceDirectory

Provider<java.util.Set<String>> versions

Constructor Detail

@javax.inject.Inject @SuppressWarnings(value: AbcMetric) GradleTestSet(String name, GradleTestSetExtension parent, Project project)

Method Detail

void augmentMessageChecksForVersionFromDefault(String version, String[] msgPatterns)

void augmentMessageChecksForVersionFromDefault(String version, java.util.Collection<String> msgPatterns)

void configurationCacheMapping(java.util.function.Function<String, ConfigurationCacheMode> mapper)

void configurationCacheMappingByAlias(java.util.function.Function<String, String> mapper)

void copyNotSymlink()

void defaultDeprecationMessageChecks(String[] msgPatterns)

void defaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)

void deprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)

void deprecationMessageChecksForVersion(String version, String[] msgPatterns)

void expectedFailures(String[] patterns)

void expectedFailures(java.util.regex.Pattern[] patterns)

Provider<Boolean> getCleanCache()

Provider<java.util.Map<String, ConfigurationCacheMode>> getConfigurationCacheModeMapping()

Provider<Boolean> getCopyOverSymlink()

String getCustomTestManifestTaskName()

Provider<Boolean> getDebug()

java.util.List<String> getDefaultDeprecationMessageChecks()

Provider<String> getDefaultTaskToRun()

Provider<DeprecationMessagesMap> getDeprecationMessagesAreFailures()

Provider<java.util.List<java.util.regex.Pattern>> getExpectedFailures()

Provider<File> getGeneratedSourceDir()

Provider<java.util.List<String>> getGradleArguments()

Provider<URI> getGradleDistributionURI()

Provider<String> getPackage()

Provider<File> getSourceDirectory()

Provider<TestKitLocations> getTestKitStrategy()

String getTestSourceGeneratorTaskName()

String getTestTaskName()

Provider<java.util.Set<String>> getVersions()

void gradleArguments(Object[] args)

void gradleArguments(java.util.List<Object> args)

void replaceDeprecationMessageChecksForVersion(String version, java.util.Collection<String> msgPatterns)

void setCleanCache(boolean flag)

void setDebug(boolean flag)

void setDefaultDeprecationMessageChecks(java.util.Collection<String> msgPatterns)

void setDefaultTaskToRun(String taskName)

void setDeprecationMessagesAreFailures(java.util.function.Predicate<String> forVersions)

void setDeprecationMessagesAreFailuresForAllVersions(Boolean flag)

void setGeneratedSourceDir(Object out)

void setGradleDistributionURI(Object uri)

void setSourceDirectory(Object src)

void setVersions(java.util.Collection<Object> ver)

void testKitDirectoryPerGroup()

void testKitDirectoryPerTest()

void testKitDirectoryShared()

void useCustomManifest()

void versions(Object[] ver)

void versions(Iterable<Object> ver)