Serialized Form

  • Package org.springframework.cloud.contract.verifier.plugin

    • Class org.springframework.cloud.contract.verifier.plugin.ContractVerifierExtension

      class ContractVerifierExtension extends Object implements Serializable
      • Serialized Fields

        • assertJsonSize
          org.gradle.api.provider.Property<Boolean> assertJsonSize
          Incubating feature. You can check the size of JSON arrays. If not turned on explicitly will be disabled.
        • baseClassForTests
          org.gradle.api.provider.Property<String> baseClassForTests
          Class which all generated tests should extend
        • 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
        • basePackageForTests
          org.gradle.api.provider.Property<String> basePackageForTests
          Base package for generated tests
        • contractDependency
          ContractVerifierExtension.Dependency contractDependency
          Dependency that contains packaged contracts
        • contractRepository
          ContractVerifierExtension.ContractRepository contractRepository
        • contractsDslDir
          org.gradle.api.file.DirectoryProperty contractsDslDir
          Directory containing contracts written using the GroovyDSL
        • contractsMode
          org.gradle.api.provider.Property<org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties.StubsMode> contractsMode
          Picks the mode in which stubs will be found and registered
        • contractsPath
          org.gradle.api.provider.Property<String> 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
        • contractsProperties
          org.gradle.api.provider.MapProperty<String,String> contractsProperties
          Map of properties that can be passed to custom StubDownloaderBuilder
        • convertToYaml
          org.gradle.api.provider.Property<Boolean> convertToYaml
          If true then will convert contracts to a YAML representation
        • deleteStubsAfterTest
          org.gradle.api.provider.Property<Boolean> deleteStubsAfterTest
          If set to false will NOT delete stubs from a temporary folder after running tests
        • excludeBuildFolders
          org.gradle.api.provider.Property<Boolean> 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.
        • excludedFiles
          org.gradle.api.provider.ListProperty<String> excludedFiles
          Patterns that should not be taken into account for processing
        • failOnInProgress
          org.gradle.api.provider.Property<Boolean> 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.
        • failOnNoContracts
          org.gradle.api.provider.Property<Boolean> failOnNoContracts
          When enabled, this flag will tell stub runner to throw an exception when no stubs / contracts were found.
        • generatedTestGroovySourcesDir
          org.gradle.api.file.DirectoryProperty generatedTestGroovySourcesDir
          Groovy test source directory where tests generated from Contract DSL should be placed
        • generatedTestJavaSourcesDir
          org.gradle.api.file.DirectoryProperty generatedTestJavaSourcesDir
          Java 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
        • ignoredFiles
          org.gradle.api.provider.ListProperty<String> ignoredFiles
          Patterns for which generated tests should be @Ignored
        • imports
          org.gradle.api.provider.ListProperty<String> imports
          Imports that should be added to generated tests
        • includedFiles
          org.gradle.api.provider.ListProperty<String> includedFiles
          Patterns that should be taken into account for processing
        • nameSuffixForTests
          org.gradle.api.provider.Property<String> nameSuffixForTests
          Suffix for generated test classes, like Spec or Test
        • packageWithBaseClasses
          org.gradle.api.provider.Property<String> packageWithBaseClasses
          A package that contains all the base clases for generated tests. If your contract resides in a location src/contractTest/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.
        • publishStubsToScm
          ContractVerifierExtension.PublishStubsToScm publishStubsToScm
        • sourceSet
          org.gradle.api.provider.Property<String> sourceSet
          Source set where the contracts are stored. If not provided will assume test.
        • staticImports
          org.gradle.api.provider.ListProperty<String> staticImports
          Static imports that should be added to generated tests
        • 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<String> stubsSuffix
          Suffix for the generated Stubs Jar task
        • testFramework
          org.gradle.api.provider.Property<org.springframework.cloud.contract.verifier.config.TestFramework> testFramework
          For which unit test library tests should be generated
        • testMode
          org.gradle.api.provider.Property<org.springframework.cloud.contract.verifier.config.TestMode> testMode
          Which mechanism should be used to invoke REST calls during tests
    • Class org.springframework.cloud.contract.verifier.plugin.ContractVerifierExtension.BaseClassMapping

      class BaseClassMapping extends Object implements Serializable
      • Serialized Fields

        • baseClassMappings
          org.gradle.api.provider.MapProperty<String,String> baseClassMappings
    • Class org.springframework.cloud.contract.verifier.plugin.ContractVerifierExtension.ContractRepository

      class ContractRepository extends Object implements Serializable
      • Serialized Fields

        • password
          org.gradle.api.provider.Property<String> password
        • proxyHost
          org.gradle.api.provider.Property<String> proxyHost
        • proxyPort
          org.gradle.api.provider.Property<Integer> proxyPort
        • repositoryUrl
          org.gradle.api.provider.Property<String> repositoryUrl
        • username
          org.gradle.api.provider.Property<String> username
    • Class org.springframework.cloud.contract.verifier.plugin.ContractVerifierExtension.Dependency

      class Dependency extends Object implements Serializable
      • Serialized Fields

        • artifactId
          org.gradle.api.provider.Property<String> artifactId
        • classifier
          org.gradle.api.provider.Property<String> classifier
        • groupId
          org.gradle.api.provider.Property<String> groupId
        • stringNotation
          org.gradle.api.provider.Property<String> stringNotation
        • version
          org.gradle.api.provider.Property<String> version
    • Class org.springframework.cloud.contract.verifier.plugin.ContractVerifierExtension.PublishStubsToScm

      class PublishStubsToScm extends Object implements Serializable