Index (gradletest 4.0.2 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addTestSetModel(org.gradle.testing.base.TestingExtension, org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Adds a test set with default dependencies
apply(org.gradle.api.Project) - Method in GradleTestBasePlugin
apply(org.gradle.api.Project) - Method in GradleTestPlugin
arguments - Property in FullTestDefinition: List of arguments to be passed to the Gradle process
augmentMessageChecksForVersionFromDefault(java.lang.String, Collection<String>) - Method in GradleTestSet: Initialises a set of messages for a version vy copying the current default set and then adding additional set.

B

BadBuildScriptName - Class in org.ysb33r.gradle.gradletest.errors: Thrown when build script naming does not follow convention.
BadBuildScriptName() - Constructor in BadBuildScriptName
baseName(java.lang.String) - Method in TestSet: Get a testset base name
BasicTestDefinition - Class in org.ysb33r.gradle.gradletest: Describes a basic test definition.
BasicTestDefinition() - Constructor in BasicTestDefinition
buildExtPattern - Property in GradleScriptLanguage
buildFilePattern - Property in GradleScriptLanguage
buildMatrixFromJavaLauncher(Provider<Set<String>>, Provider<JavaLauncher>, Provider<File>) - Method in TestDefinitionsMatrix: Builds a test matrix after analysing the data.
buildMatrixFromLanguageVersion(Provider<Set<String>>, Provider<JavaLanguageVersion>, Provider<File>) - Method in TestDefinitionsMatrix: Builds a test matrix after analysing the data.

C

ccMode - Property in VersionExecutionProperties: The configuration cache mode for this version.
classNameComponentBase(java.lang.String) - Method in GenerationUtils: Sanitized the name of a directory into seomthing that can be used to start a Groovy class name.
classNameComponentBuildFile(java.lang.String) - Method in GenerationUtils: Calcaultes a postfix for a class name based upon the build file type.
classNameComponentVersion(java.lang.String) - Method in GenerationUtils: Sanitizes a Gradle version into something that can be used in a class name.
classNameFrom(org.ysb33r.gradle.gradletest.BasicTestDefinition) - Method in GenerationUtils: Builds a class name from a test definition.
classNameFromComponents(java.lang.String, java.lang.String, java.lang.String) - Method in GenerationUtils: Builds a class name from a set of sanitized components.
ClasspathManifest - Class in org.ysb33r.gradle.gradletest: Generates a manifest file that can be re-used by GradleTest tasks to set the correct classpath.
ClasspathManifest() - Constructor in ClasspathManifest
cleanCache - Property in FullTestDefinition: Whether the Gradle local cache should be cleaned before the test starts
configurationCache - Property in FullTestDefinition: Configuration cache setting.
configurationCacheMapping(Function<String, ConfigurationCacheMode>) - Method in GradleTestSet: Sets a mapper that determines which Gradle versions should active which kind of configuration cache checks.
configurationCacheMappingByAlias(Function<String, String>) - Method in GradleTestSet: Like configurationCacheMapping, but returns a case-insensitive string value which can then be converted by the test set.
ConfigurationCacheMode - Enum in org.ysb33r.gradle.gradletest: Configuration cache mode availability for testing.
configureGradleTestSets(org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in Jacoco: Configures Gradle test sets when Jacoco is applied.
configureSourceSet(org.gradle.testing.base.TestingExtension, org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Configures a source set relevant to a test set.
configureWhenApplied(TaskProvider<Test>, org.gradle.api.Project) - Method in Jacoco: Adds the given test task to Jacoco reporting.
copyNotSymlink() - Method in GradleTestSet: By default, project structures are symlinked back to the files in the project source directory.
create(java.lang.String) - Method in GradleTestSetFactory
CURRENT - Field in GradleVersions

D

debug - Property in FullTestDefinition: Whether the test should enable debugging.
DEFAULT_DEPRECATION_WARNINGS - Field in GradleTestSet
DEFAULT_TASK - Field in Names: The name of the default task that will be created by the plugin
DEFAULT_TEST_SET_NAME - Field in Names: Name of the default GradleTest test set.
defaultDeprecationMessageChecks(Collection<String>) - Method in GradleTestSet: Add deprecation message patterns to the default message sets.
defaultTask - Property in FullTestDefinition: The name of the task that needs to be executed
deprecationMessageChecksForVersion(java.lang.String, java.lang.String) - Method in GradleTestSet: Modifies the deprecation messages this for a specific Gradle version.
DeprecationMessagesMap - Class in org.ysb33r.gradle.gradletest: A simple class that helps to work around some limitations in Gradle property ecosystem
DeprecationMessagesMap() - Constructor in DeprecationMessagesMap
deprecationWarnings - Property in FullTestDefinition: List of deprecation warnings to fail on.
deprecationWarningsMap - Property in VersionExecutionProperties: The deprecation warnings for this version that needs to be checked.
dirScanner(Provider<File>) - Method in TestDefinitionsMatrix: Scans the source directory for Gradle project directories
disableCodenarcSourceChecks(org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Disables Codenarc tasks when the Codenarc plugin is applied
disableLicenseSourceChecks(org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Disables license checking if the Hierynomus License plugin is applied.

E

exec() - Method in ClasspathManifest
exec() - Method in TestGenerator
execute(org.gradle.api.artifacts.ComponentMetadataContext) - Method in RemoveSpockGroovyDependency
expectedFailures(java.util.regex.Pattern) - Method in GradleTestSet: Set which tests are expected to fail.

F

FAIL - Field in ConfigurationCacheMode
FullTestDefinition - Class in org.ysb33r.gradle.gradletest: Carries all of the data for a test definition in order to generate data files.
FullTestDefinition(org.ysb33r.gradle.gradletest.BasicTestDefinition) - Constructor in FullTestDefinition

G

generateProject(java.io.File, org.ysb33r.gradle.gradletest.FullTestDefinition, boolean, org.ysb33r.grolifant5.api.core.FileSystemOperations) - Method in GenerationUtils: Generates a project structure.
generateTest(java.io.File, java.io.File, org.ysb33r.grolifant5.api.core.FileSystemOperations, org.ysb33r.gradle.gradletest.FullTestDefinition) - Method in GenerationUtils: Generates a Spock test source file.
generateTraitsFile(java.io.File, java.io.File, org.ysb33r.grolifant5.api.core.FileSystemOperations, java.lang.String) - Method in GenerationUtils: Generates a traits file that is used by all tests.
GenerationUtils - Class in org.ysb33r.gradle.gradletest.internal: Helps with generation of source and data files.
GenerationUtils() - Constructor in GenerationUtils
GENERATOR_TASK_POSTFIX - Field in Names: The string that is added to generator task names by default
getClasspath() - Method in ClasspathManifest: Access to the classpath that will be placed inside the manifest
getCleanCache() - Method in GradleTestSet: Whether the Gradle cache should be cleaned before each test tun..
getCodenarcTaskName(java.lang.String) - Method in TestSet: The name of the task from the Codenarc plugin that can can format a sourceset.
getConfigurationCacheModeMapping() - Method in GradleTestSet: A provider that maps configuration cache setup.
getCopyOverSymlink() - Method in GradleTestSet: Whether copy should be preferred over symlinks.
getCustomTestManifestTaskName() - Method in GradleTestSet: Returns the name of the task that will generate the Gradle manifest for this test set.
getDebug() - Method in GradleTestSet: A provider to indicate debug mode.
getDefaultDeprecationMessageChecks() - Method in GradleTestSet: Returns the list of default deprecation messages.
getDefaultTaskToRun() - Method in GradleTestSet: Name of the task to run inside the Gradle test project.
getDeprecationMessagesAreFailures() - Method in GradleTestSet: Returns a map for every testable version which indicates whether deprecation messages should be checked for that version.
getExpectedFailures() - Method in GradleTestSet: Test groups which are expected to fail.
getGeneratedSourceDir() - Method in GradleTestSet: The top-level directory for sources will be generated into for this source set.
getGeneratorTaskName(java.lang.String) - Method in TestSet: The name of the test generator task.
getGradleArguments() - Method in GradleTestSet: Additional arguments to pass to gradle when running the test.
getGradleDistributionURI() - Method in GradleTestSet: Get an alternative location where to get Gradle distributions from.
getLicenseTaskName(java.lang.String) - Method in TestSet: The name of the task from the License plugin that can can format a sourceset.
getManifestTaskName(java.lang.String) - Method in TestSet: The name of the test manifest generator task.
getMinimumGradleForJavaVersion(java.lang.Integer) - Method in JdkSupport: Mapping on Java version to minimum supported Gradle Version.
getOutputFile() - Method in ClasspathManifest: Returns manifest file location.
getPackage() - Method in GradleTestSet: The package to be used for tests in this set.
getProjectOutputDir() - Method in TestGenerator: The toplevel directory where the project is generated into.
getRelativeSourceDir(java.lang.String) - Method in TestSet: Gets the relative source dir where test code will be generated into.
getSourceDirectory() - Method in GradleTestSet: The root directory where to find tests for this specific GradleTest grouping The default root directory by convention is src/gradleTest.
getSourceOutputDir() - Method in TestGenerator: The directory where code is generated into.
getSpockMode() - Method in TestSet: Returns which version of Spock to use.
getTestKitStrategy() - Method in GradleTestSet: A strategy for storing TestKit related data.
getTestPackage() - Method in GradleTestSetExtension: The package name prefix that are used for compatibility tests.
getTestPackagePath(java.lang.String) - Method in GenerationUtils: Converts a package name to a package path.
getTestRootDirectory() - Method in TestGenerator: The root directory where to find tests for this specific GradleTest grouping The default root directory by convention is src/gradleTest.
getTestSourceGeneratorTaskName() - Method in GradleTestSet: Returns the name of the task that will generate source for this test set.
getTestTaskName() - Method in GradleTestSet: Returns the name of the test task associated with this test set.
getVersions() - Method in GradleTestSet: Returns the set of Gradle versions to tests against.
GRADLE_4_0 - Field in GradleVersions
gradleArguments(List<Object>) - Method in GradleTestSet: Additional Gradle arguments to pass.
gradleBuildFile - Property in BasicTestDefinition: The Gradle build file to use for the test.
gradleDistributionUri - Property in FullTestDefinition: URI to load distributions from.
GradleScriptLanguage - Enum in org.ysb33r.gradle.gradletest.internal: Describes Gradle language DSLs.
GradleTestBasePlugin - Class in org.ysb33r.gradle.gradletest: A base plugin for GradleTest.
GradleTestBasePlugin() - Constructor in GradleTestBasePlugin
GradleTestPlugin - Class in org.ysb33r.gradle.gradletest: Checks the current Gradle version and decides which real plugin to apply.
GradleTestPlugin() - Constructor in GradleTestPlugin
GradleTestSet - Class in org.ysb33r.gradle.gradletest: Defines a GradleTest test set.
GradleTestSet(java.lang.String, org.ysb33r.gradle.gradletest.GradleTestSetExtension, org.gradle.api.Project) - Constructor in GradleTestSet
GradleTestSetExtension - Class in org.ysb33r.gradle.gradletest: Extension to configure GradleTest test sets.
GradleTestSetExtension(org.gradle.api.Project) - Constructor in GradleTestSetExtension
GradleTestSetFactory - Class in org.ysb33r.gradle.gradletest.internal: A factory for GradleTestSet instances.
GradleTestSetFactory(org.gradle.api.Project, org.ysb33r.gradle.gradletest.GradleTestSetExtension) - Constructor in GradleTestSetFactory
gradleVersion - Property in BasicTestDefinition: The Gradle version to use for the test.
GradleVersions - Class in org.ysb33r.gradle.gradletest.internal: Fixed constants and methods for dealing with specific Gradle versions.
GradleVersions() - Constructor in GradleVersions
GROOVY - Field in GradleScriptLanguage

H

I

id - Property in GradleScriptLanguage

J

Jacoco - Class in org.ysb33r.gradle.gradletest.internal: Configures GradleTest tasks for Jacoco.
Jacoco() - Constructor in Jacoco
JdkSupport - Class in org.ysb33r.gradle.gradletest.internal: Gradle JDK version support within the context of GradleTest.
JdkSupport() - Constructor in JdkSupport

K

KOTLIN - Field in GradleScriptLanguage

L

language - Property in GradleScriptLanguage

M

MANIFEST_TASK_POSTFIX - Field in Names: The string that is added to classpath manifest task names by default
manifestFile - Property in FullTestDefinition: Whether a custom manifest file should be used.
ManifestRegistrar(org.gradle.api.Project, org.ysb33r.gradle.gradletest.GradleTestSet) - Constructor in TestSet.ManifestRegistrar
MAX_VALUE - Field in ConfigurationCacheMode
MAX_VALUE - Field in GradleScriptLanguage
MAX_VALUE - Field in TestKitLocations
maybeRegister() - Method in TestSet.ManifestRegistrar
MIN_VALUE - Field in ConfigurationCacheMode
MIN_VALUE - Field in GradleScriptLanguage
MIN_VALUE - Field in TestKitLocations
MINIMUM_SUPPORTED_CONFIGURATION_CACHE_DEBUG - Field in GradleVersions: Minimum version for which debug is turned on in presence of configuration cache.
MINIMUM_SUPPORTED_FOR_CONFIGURATION_CACHE - Field in GradleVersions: Minimum version for which GradleTest will allow configuration cache testing.
MINIMUM_SUPPORTED - Field in GradleVersions: Minimum version supported by GradleTest.
MINIMUM_SUPPORTED_KOTLIN_DEBUG - Field in GradleVersions: Minimum version for Kotlin DSL where debugging can be used.
MINIMUM_SUPPORTED_KOTLIN_DSL - Field in GradleVersions: Minimum version that supports Kotlin DSL.
minimumGradleForCurrentJavaVersion() - Method in JdkSupport: Mapping on Java version to minimum supported Gradle Version.
mode - Property in ConfigurationCacheMode

N

name - Property in GradleTestSet
NAME - Field in GradleTestSetExtension
Names - Class in org.ysb33r.gradle.gradletest.internal: Fixed names for various GradleTest elements.
Names() - Constructor in Names
next() - Method in ConfigurationCacheMode
next() - Method in GradleScriptLanguage
next() - Method in TestKitLocations
NONE - Field in ConfigurationCacheMode

O

P

PACKAGE_PREFIX - Field in GradleTestSetExtension
packageName - Property in FullTestDefinition: Name of the test package
pathAsUriStr(java.io.File) - Method in GenerationUtils: Ensures that files are represented as URIs.
PER_GROUP - Field in TestKitLocations: Keep the Testkit data, but share the directory between the complete testset.
PER_TEST - Field in TestKitLocations: Keep one TestKit directory per test.
previous() - Method in ConfigurationCacheMode
previous() - Method in GradleScriptLanguage
previous() - Method in TestKitLocations
projectDir - Property in FullTestDefinition: Directory where project will be executed from

Q

quoteAndJoin(Iterable<String>) - Method in GenerationUtils

R

registerManifestTask(org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Registers the task that creates the test plugin manifest.
registerTestGenerator(org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Registers the task that creates the test sources.
registerTestTask(org.gradle.testing.base.TestingExtension, org.ysb33r.gradle.gradletest.GradleTestSet, org.gradle.api.Project) - Method in TestSet: Registers the test task for the test set and configures the source set that provides the test classes.
removeOldGeneratedFiles(java.io.File, java.lang.String, List<File>) - Method in GenerationUtils: Remove old generated files.
RemoveSpockGroovyDependency - Class in org.ysb33r.gradle.gradletest.internal: Component corrector to keep Spock from adding Groovy as transitive dependency.
RemoveSpockGroovyDependency() - Constructor in RemoveSpockGroovyDependency
replaceDeprecationMessageChecksForVersion(java.lang.String, Collection<String>) - Method in GradleTestSet: Replaces the current set of messages for a specific version with a new set..

S

scanGradleProjects(Provider<List<File>>) - Method in TestDefinitionsMatrix
setCleanCache(boolean) - Method in GradleTestSet: Whether cache should be clean before each test run.
setCleanCache(Provider<Boolean>) - Method in TestGenerator: Sets whether the cache should be cleaned before each test run.
setConfigurationCacheMap(Provider<Map<String, ConfigurationCacheMode>>) - Method in TestGenerator: Sets the configuration cache mapping for Gradle versions.
setCopyOverSymlink(Provider<Boolean>) - Method in TestGenerator: Whether copies rather than symlinks should be performed when generating the project structure..
setDebug(boolean) - Method in GradleTestSet: Whether debug should be enabled for tests.
setDebug(Provider<Boolean>) - Method in TestGenerator: Whether debug should be available on tests.
setDebugWarnings(Provider<Boolean>) - Method in TestGenerator: Sets whether warnings about turning debug off on tests are printed.
setDefaultDeprecationMessageChecks(Collection<String>) - Method in GradleTestSet: Replace the set of default deprevation messages.
setDefaultTaskToRun(java.lang.String) - Method in GradleTestSet: Overrides the default task to run inside the Gradle test project.
setDeprecationMessagesAreFailures(Predicate<String>) - Method in GradleTestSet: Set whether deprecation message should fail the build.
setDeprecationMessagesAreFailuresForAllVersions(java.lang.Boolean) - Method in GradleTestSet: Turns deprecation checking on or off for all Gradle versions.
setDeprecationMessagesMap(Provider<DeprecationMessagesMap>) - Method in TestGenerator: Configures a map that will return the deprecation message patterns on a per Gradle-version basis.
setExpectedFailures(Provider<List<Pattern>>) - Method in TestGenerator: Sets which test groups are expected to fail.
setGeneratedSourceDir(java.lang.Object) - Method in GradleTestSet: Override the directory where sources are generated into.
setGradleArguments(Provider<List<String>>) - Method in TestGenerator: Sets additional arguments that must be passed to Gradle.
setGradleDistributionURI(java.lang.Object) - Method in GradleTestSet: Sets the location of where to fetch Gradle distributions from.
setGradleDistributionURI(Provider<URI>) - Method in TestGenerator: Set a location from where to get Gradle distributions from.
setManifestFile(Provider<File>) - Method in TestGenerator: Custom manifest.
setOutputDir(Provider<File>) - Method in ClasspathManifest: Sets the output directory.
setPackageName(Provider<String>) - Method in TestGenerator: Sets the package name.
setProjectOutputDir(Provider<File>) - Method in TestGenerator: Sets the toplevel directory where the project is generated into.
setSourceDirectory(java.lang.Object) - Method in GradleTestSet: Overrides the default location of test project sources.
setSourceOutputDir(Provider<File>) - Method in TestGenerator: Sets the toplevel directory where code is to be generated into.
setTaskToRun(Provider<String>) - Method in TestGenerator: Sets the task to run inside the project.
setTestKitStrategy(Provider<TestKitLocations>) - Method in TestGenerator: Sets the testkit sharing strategy.
setTestMapProvider(Provider<List<BasicTestDefinition>>) - Method in TestGenerator: Provides the map of test definitions.
setTestPackage(java.lang.Object) - Method in GradleTestSetExtension: Override the package name prefix for compatibility tests.
setTestRootDirectory(Provider<File>) - Method in TestGenerator: Sets the source directory for tests.
settingsFilePattern - Property in GradleScriptLanguage
setVersions(Collection<Object>) - Method in GradleTestSet: Replace all previously defined versions.
SHARED - Field in TestKitLocations: Share one testkit between all tests.
SPOCK_V2_VERSION - Field in TestSet
SUPPORT_URL - Field in GradleTestBasePlugin

T

targetDir - Property in FullTestDefinition: Directory where source is generated into
TASK_GROUP - Field in Names: Default group for all tasks
TestDefinitionsMatrix - Class in org.ysb33r.gradle.gradletest.internal: Calculates the matrix of tests.
TestDefinitionsMatrix() - Constructor in TestDefinitionsMatrix
testDir - Property in BasicTestDefinition: Directory where a specific GradleTest project is located i.e.
testFiltersFromOutsideVersions(java.lang.String, org.ysb33r.grolifant5.api.core.ProviderTools) - Method in TestSet: Obtains a list of test filters that can be applied based upon outside versions.
TestGenerator - Class in org.ysb33r.gradle.gradletest: Generates test files that will be compiled against GradleTestKit and project files for execution.
TestGenerator() - Constructor in TestGenerator
TESTKIT_PROJECT_LEVEL_SUBDIR - Field in GenerationUtils: Subdirectory below build/gradleTest (or similar) where a shared testkit will be placed.
testKitDir - Property in FullTestDefinition: Directory where test kit data must be written to if it is shared between projects.
testKitDirectoryPerGroup() - Method in GradleTestSet: Keep the Testkit data, but share the directory between the complete testset.
testKitDirectoryPerTest() - Method in GradleTestSet: Keep one TestKit directory per test.
testKitDirectoryShared() - Method in GradleTestSet: Shares the testkit directory between all tests.
TestKitLocations - Enum in org.ysb33r.gradle.gradletest: Strategy for managing the TestKit directory location.
testKitLocationString(org.ysb33r.gradle.gradletest.TestKitLocations) - Method in GenerationUtils: Create a string suitable for sending to the Spock template.
TestSet - Class in org.ysb33r.gradle.gradletest.internal: Internal utility functions to add a new GradleTest test set.
TestSet.ManifestRegistrar - Class in org.ysb33r.gradle.gradletest.internal: A class that is used to register a manifest task if it does not exist.
TestSet() - Constructor in TestSet
testSets - Property in GradleTestSetExtension
testVersionsFromOutside(java.lang.String, org.ysb33r.grolifant5.api.core.ProviderTools) - Method in TestSet: Obtains a list of versions that were supplied outside of configuration i.e. via Gradle property, system property or environment variable.
tripleQuoteAndJoin(Iterable<String>) - Method in GenerationUtils

U

useCustomManifest() - Method in GradleTestSet: Indicate that a custom manifest file must be used.

V

valueOf(java.lang.String) - Method in ConfigurationCacheMode
valueOf(java.lang.String) - Method in GradleScriptLanguage
valueOf(java.lang.String) - Method in TestKitLocations
values() - Method in ConfigurationCacheMode
values() - Method in GradleScriptLanguage
values() - Method in TestKitLocations
VersionExecutionProperties - Class in org.ysb33r.gradle.gradletest.internal: An internal class to hold information about each Gradle that is in a test set.
VersionExecutionProperties() - Constructor in VersionExecutionProperties
versionMap - Property in DeprecationMessagesMap
versions(Iterable<Object>) - Method in GradleTestSet: Add Gradle versions to be tested against.
versionsToUse(Provider<Set<String>>, Provider<JavaLanguageVersion>) - Method in TestDefinitionsMatrix: Creates a filtered collection of versions.