-
testFramework
org.gradle.api.provider.Property<T> testFramework
For which unit test library tests should be generated
-
testMode
org.gradle.api.provider.Property<T> testMode
Which mechanism should be used to invoke REST calls during tests
-
basePackageForTests
org.gradle.api.provider.Property<T> basePackageForTests
Base package for generated tests
-
baseClassForTests
org.gradle.api.provider.Property<T> baseClassForTests
Class which all generated tests should extend
-
nameSuffixForTests
org.gradle.api.provider.Property<T> nameSuffixForTests
Suffix for generated test classes, like Spec or Test
-
excludedFiles
org.gradle.api.provider.ListProperty<T> excludedFiles
Patterns that should not be taken into account for processing
-
includedFiles
org.gradle.api.provider.ListProperty<T> includedFiles
Patterns that should be taken into account for processing
-
ignoredFiles
org.gradle.api.provider.ListProperty<T> ignoredFiles
Patterns for which generated tests should be @Ignored
-
imports
org.gradle.api.provider.ListProperty<T> imports
Imports that should be added to generated tests
-
staticImports
org.gradle.api.provider.ListProperty<T> staticImports
Static imports that should be added to generated tests
-
contractsDslDir
org.gradle.api.file.DirectoryProperty contractsDslDir
Directory containing contracts written using the GroovyDSL
-
generatedTestSourcesDir
org.gradle.api.file.DirectoryProperty generatedTestSourcesDir
Deprecated.
Test source directory where tests generated from Groovy DSL should be placed
-
generatedTestJavaSourcesDir
org.gradle.api.file.DirectoryProperty generatedTestJavaSourcesDir
Java test source directory where tests generated from Contract DSL should be placed
-
generatedTestGroovySourcesDir
org.gradle.api.file.DirectoryProperty generatedTestGroovySourcesDir
Groovy test source directory where tests generated from Contract DSL should be
placed
-
generatedTestResourcesDir
org.gradle.api.file.DirectoryProperty generatedTestResourcesDir
Test resource directory where tests generated from Groovy DSL should be referenced
-
stubsOutputDir
org.gradle.api.file.DirectoryProperty stubsOutputDir
Dir where the generated stubs from Groovy DSL should be placed. You can then
mention them in your packaging task to create jar with stubs
-
stubsSuffix
org.gradle.api.provider.Property<T> stubsSuffix
Suffix for the generated Stubs Jar task
-
assertJsonSize
org.gradle.api.provider.Property<T> assertJsonSize
Incubating feature. You can check the size of JSON arrays. If not turned on
explicitly will be disabled.
-
failOnNoContracts
org.gradle.api.provider.Property<T> failOnNoContracts
When enabled, this flag will tell stub runner to throw an exception when no stubs /
contracts were found.
-
failOnInProgress
org.gradle.api.provider.Property<T> failOnInProgress
If set to true then if any contracts that are in progress are found, will break the
build. On the producer side you need to be explicit about the fact that you have
contracts in progress and take into consideration that you might be causing false
positive test execution results on the consumer side.
-
contractRepository
ContractVerifierExtension.ContractRepository contractRepository
-
publishStubsToScm
ContractVerifierExtension.PublishStubsToScm publishStubsToScm
-
contractDependency
ContractVerifierExtension.Dependency contractDependency
Dependency that contains packaged contracts
-
contractsPath
org.gradle.api.provider.Property<T> contractsPath
The path in the JAR with all the contracts where contracts for this particular
service lay. If not provided will be resolved to groupid/artifactid
.
Example: If groupid
is com.example
and artifactid
is
service
then the resolved path will be /com/example/artifactid
-
contractsMode
org.gradle.api.provider.Property<T> contractsMode
Picks the mode in which stubs will be found and registered
-
packageWithBaseClasses
org.gradle.api.provider.Property<T> packageWithBaseClasses
A package that contains all the base clases for generated tests. If your contract
resides in a location src/test/resources/contracts/com/example/v1/
and you
provide the packageWithBaseClasses
value to
com.example.contracts.base
then we will search for a test source file that
will have the package com.example.contracts.base
and name
ExampleV1Base
. As you can see it will take the two last folders to and
attach Base
to its name.
-
baseClassMappings
ContractVerifierExtension.BaseClassMapping baseClassMappings
A way to override any base class mappings. The keys are regular expressions on the
package name and the values FQN to a base class for that given expression. Example
of a mapping [.*.com.example.v1..*] to [com.example.SomeBaseClass] When a
contract's package matches the provided regular expression then extending class
will be the one provided in the map - in this case
com.example.SomeBaseClass
-
excludeBuildFolders
org.gradle.api.provider.Property<T> excludeBuildFolders
If set to true then the target
or build
folders are getting
excluded from any operations. This is used out of the box when working with common
repo with contracts.
-
deleteStubsAfterTest
org.gradle.api.provider.Property<T> deleteStubsAfterTest
If set to false
will NOT delete stubs from a temporary folder after running
tests
-
convertToYaml
org.gradle.api.provider.Property<T> convertToYaml
If true
then will convert contracts to a YAML representation
-
contractsProperties
org.gradle.api.provider.MapProperty<K,V> contractsProperties
Map of properties that can be passed to custom
StubDownloaderBuilder
-
disableStubPublication
org.gradle.api.provider.Property<T> disableStubPublication
Deprecated.
Is set to true will not provide the default publication task
-
sourceSet
org.gradle.api.provider.Property<T> sourceSet
Source set where the contracts are stored. If not provided will assume
test
.