毕业项目
先决条件
为了在WireMock中使用Spring Cloud Contract验证器，您必须使用Gradle或Maven插件。
警告如果您想在项目中使用Spock，则必须单独添加spock-core和spock-spring模块。检查Spock文档以获取更多信息
添加具有依赖关系的渐变插件
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}"
classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}"
}
}
apply plugin: 'groovy'
apply plugin: 'spring-cloud-contract'
dependencyManagement {
imports {
mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifier_version}"
}
}
dependencies {
testCompile 'org.codehaus.groovy:groovy-all:2.4.6'
// example with adding Spock core and Spock Spring
testCompile 'org.spockframework:spock-core:1.0-groovy-2.4'
testCompile 'org.spockframework:spock-spring:1.0-groovy-2.4'
testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
}
Gradle的快照版本
将其他快照存储库添加到您的build.gradle以使用快照版本，每次成功构建后都会自动上传：
buildscript {
repositories {
mavenCentral()
mavenLocal()
maven { url "http://repo.spring.io/snapshot" }
maven { url "http://repo.spring.io/milestone" }
maven { url "http://repo.spring.io/release" }
}
}
添加存根
默认情况下Spring Cloud Contract验证器正在src/test/resources/contracts目录中查找存根。
包含存根定义的目录被视为一个类名称，每个存根定义被视为单个测试。我们假设它至少包含一个用作测试类名称的目录。如果有多个级别的嵌套目录，除了最后一个级别将被用作包名称。所以具有以下结构
src/test/resources/contracts/myservice/shouldCreateUser.groovy
src/test/resources/contracts/myservice/shouldReturnUser.groovy
Spring Cloud Contract验证程序将使用两种方法创建测试类defaultBasePackage.MyService
shouldCreateUser()
shouldReturnUser()
运行插件
插件注册自己在check任务之前被调用。只要您希望它成为构建过程的一部分，您就无所事事。如果您只想生成测试，请调用generateContractTests任务。
默认设置
默认的Gradle插件设置创建了以下Gradle部分的构建（它是一个伪代码）
contracts {
targetFramework = 'JUNIT'
testMode = 'MockMvc'
generatedTestSourcesDir = project.file("${project.buildDir}/generated-test-sources/contracts")
contractsDslDir = "${project.rootDir}/src/test/resources/contracts"
basePackageForTests = 'org.springframework.cloud.verifier.tests'
stubsOutputDir = project.file("${project.buildDir}/stubs")
// the following properties are used when you want to provide where the JAR with contract lays
contractDependency {
stringNotation = ''
}
contractsPath = ''
contractsWorkOffline = false
}
tasks.create(type: Jar, name: 'verifierStubsJar', dependsOn: 'generateClientStubs') {
baseName = project.name
classifier = contracts.stubsSuffix
from contractVerifier.stubsOutputDir
}
project.artifacts {
archives task
}
tasks.create(type: Copy, name: 'copyContracts') {
from contracts.contractsDslDir
into contracts.stubsOutputDir
}
verifierStubsJar.dependsOn 'copyContracts'
publishing {
publications {
stubs(MavenPublication) {
artifactId project.name
artifact verifierStubsJar
}
}
}
配置插件
要更改默认配置，只需在您的Gradle配置中添加contracts代码段即可
contracts {
testMode = 'MockMvc'
baseClassForTests = 'org.mycompany.tests'
generatedTestSourcesDir = project.file('src/generatedContract')
}
配置选项
testMode - 定义接受测试的模式。默认的基于Spring的MockMvc的MockMvc。也可以将其更改为JaxRsClient或显式为真实的HTTP调用。
导入 - 应包含在生成的测试中的导入的数组（例如['org.myorg.Matchers']）。默认为空数组[]
staticImports - 应该包含在生成的测试中的静态导入的数组（例如['org.myorg.Matchers。*']）。默认为空数组[]
basePackageForTests - 为所有生成的测试指定基础包。默认设置为org.springframework.cloud.verifier.tests
baseClassForTests - 所有生成的测试的基类。如果使用Spock测试，默认为spock.lang.Specification。
packageWithBaseClasses - 而不是为基类提供固定值，您可以提供一个所有基类放置的包。优先于baseClassForTests。
baseClassMappings - 明确地将合约包映射到基类的FQN。优先于packageWithBaseClasses和baseClassForTests。
ruleClassForTests - 指定应该添加到生成的测试类的规则。
ignoredFiles - Ant匹配器，允许定义要跳过哪些处理的存根文件。默认为空数组[]
contractsDslDir - 包含使用GroovyDSL编写的合同的目录。默认$rootDir/src/test/resources/contracts
generatedTestSourcesDir - 应该放置从Groovy DSL 生成测试的测试源目录。默认$buildDir/generated-test-sources/contractVerifier
stubsOutputDir - 应该放置从Groovy DSL生成的WireMock存根的目录
targetFramework - 要使用的目标测试框架; JUnit作为默认框架，目前支持Spock和JUnit
当您希望提供合同所在JAR的位置时，将使用以下属性
contractDependency- 提供groupid:artifactid:version:classifier坐标的依赖关系。您可以使用contractDependency关闭来设置它
contractPath- 如果下载合同部分将默认为groupid/artifactid，其中groupid将被分隔。否则将扫描提供的目录下的合同
contractsWorkOffline - 为了不下载依赖关系，每次下载一次，然后离线工作（重用本地Maven repo）
所有测试的单一基类
在默认的MockMvc中使用Spring Cloud Contract验证器时，您需要为所有生成的验收测试创建一个基本规范。在这个类中，您需要指向应验证的端点。
abstract class BaseMockMvcSpec extends Specification {
def setup() {
RestAssuredMockMvc.standaloneSetup(new PairIdController())
}
void isProperCorrelationId(Integer correlationId) {
assert correlationId == 123456
}
void isEmpty(String value) {
assert value == null
}
}
在使用Explicit模式的情况下，您可以像普通集成测试一样使用基类来初始化整个测试的应用程序。在JAXRSCLIENT模式的情况下，这个基类也应该包含protected WebTarget webTarget字段，现在测试JAX-RS API的唯一选项是启动Web服务器。
不同的基础类别的合同
如果您的基类在合同之间不同，您可以告诉Spring Cloud Contract插件哪个类应该由自动生成测试扩展。你有两个选择：
遵循约定，提供packageWithBaseClasses
通过baseClassMappings提供显式映射
惯例
约定是这样的，如果你有合同，例如src/test/resources/contract/foo/bar/baz/，并将packageWithBaseClasses属性的值提供给com.example.base，那么我们将假设com.example.base下有一个BarBazBase类包。换句话说，如果它们存在并且形成具有Base后缀的类，那么我们将使用最后两个包的部分。优先于baseClassForTests。contracts关闭中的使用示例：
packageWithBaseClasses = 'com.example.base'
制图
您可以手动将合同包的正则表达式映射为匹配合同的基类的完全限定名称。我们来看看下面的例子：
baseClassForTests = "com.example.FooBase"
baseClassMappings {
baseClassMapping('.*/com/.*', 'com.example.ComBase')
baseClassMapping('.*/bar/.*':'com.example.BarBase')
}
我们假设你有合同 -src/test/resources/contract/com/-src/test/resources/contract/foo/
通过提供baseClassForTests，我们有一个后备案例，如果映射没有成功（您也可以提供packageWithBaseClasses作为备用）。这样，从src/test/resources/contract/com/合同产生的测试将扩展com.example.ComBase，而其余的测试将扩展com.example.FooBase。
调用生成的测试
为确保提供方对定义的合同进行投诉，您需要调用：
./gradlew generateContractTests test
Spring Cloud Contract消费者验证者
在消费者服务中，您需要以与提供商相同的方式配置Spring Cloud Contract验证器插件。如果您不想使用Stub Runner，则需要复制存储在src/test/resources/contracts中的合同，并使用以下命令生成WireMock json存根：
./gradlew generateClientStubs
请注意，必须为存根生成设置stubsOutputDir选项才能正常工作。
当存在时，json存根可用于消费者自动测试。
@ContextConfiguration(loader == SpringApplicationContextLoader, classes == Application)
class LoanApplicationServiceSpec extends Specification {
@ClassRule
@Shared
WireMockClassRule wireMockRule == new WireMockClassRule()
@Autowired
LoanApplicationService sut
def 'should successfully apply for loan'() {
given:
LoanApplication application =
new LoanApplication(client: new Client(clientPesel: '12345678901'), amount: 123.123)
when:
LoanApplicationResult loanApplication == sut.loanApplication(application)
then:
loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED
loanApplication.rejectionReason == null
}
}
在LoanApplication下面调用FraudDetection服务。此请求由使用由Spring Cloud Contract验证器生成的存根配置的WireMock服务器处理。
