Gradle 项目

先决条件

要将 Spring Cloud Contract Verifier 与 WireMock 结合使用，您必须使用 Gradle 或 Maven 插件。

如果您想在项目中使用 Spock，则必须单独添加 spock-core 和 spock-spring 模块。有关更多信息，请参阅 Spock 的文档。

添加带依赖项的 Gradle 插件

要添加带依赖项的 Gradle 插件，您可以使用类似于以下的代码

插件 DSL GA 版本
// build.gradle
plugins {
  id "groovy"
  // this will work only for GA versions of Spring Cloud Contract
  id "org.springframework.cloud.contract" version "$\{GAVerifierVersion}"
}

dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:$\{GAVerifierVersion}"
	}
}

dependencies {
	testImplementation "org.apache.groovy:groovy-all:$\{groovyVersion}"
	// example with adding Spock core and Spock Spring
	testImplementation "org.spockframework:spock-core:$\{spockVersion}"
	testImplementation "org.spockframework:spock-spring:$\{spockVersion}"
	testImplementation 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
}
插件 DSL 非 GA 版本
// settings.gradle
pluginManagement {
	plugins {
		id "org.springframework.cloud.contract" version "$\{verifierVersion}"
	}
    repositories {
        // to pick from local .m2
        mavenLocal()
        // for snapshots
        maven { url "https://repo.spring.io/snapshot" }
        // for milestones
        maven { url "https://repo.spring.io/milestone" }
        // for GA versions
        gradlePluginPortal()
    }
}

// build.gradle
plugins {
  id "groovy"
  id "org.springframework.cloud.contract"
}

dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:$\{verifierVersion}"
	}
}

dependencies {
	testImplementation "org.apache.groovy:groovy-all:$\{groovyVersion}"
	// example with adding Spock core and Spock Spring
	testImplementation "org.spockframework:spock-core:$\{spockVersion}"
	testImplementation "org.spockframework:spock-spring:$\{spockVersion}"
	testImplementation 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
}
旧版插件应用
// build.gradle
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}"
        // here you can also pass additional dependencies such as Kotlin spec e.g.:
        // classpath "org.springframework.cloud:spring-cloud-contract-spec-kotlin:$\{verifier_version}"
	}
}

apply plugin: 'groovy'
apply plugin: 'org.springframework.cloud.contract'

dependencyManagement {
	imports {
		mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:$\{verifier_version}"
	}
}

dependencies {
	testImplementation "org.apache.groovy:groovy-all:$\{groovyVersion}"
	// example with adding Spock core and Spock Spring
	testImplementation "org.spockframework:spock-core:$\{spockVersion}"
	testImplementation "org.spockframework:spock-spring:$\{spockVersion}"
	testImplementation 'org.springframework.cloud:spring-cloud-starter-contract-verifier'
}

Gradle 和 Rest Assured 2.0

默认情况下，Rest Assured 3.x 会添加到类路径中。但是，要使用 Rest Assured 2.x，您可以改用它，如以下清单所示

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}"
	}
}

dependencies {
    // all dependencies
    // you can exclude rest-assured from spring-cloud-contract-verifier
    testCompile "com.jayway.restassured:rest-assured:2.5.0"
    testCompile "com.jayway.restassured:spring-mock-mvc:2.5.0"
}

这样，插件会自动识别类路径中存在 Rest Assured 2.x，并相应地修改导入。

Gradle 的快照版本

您可以将额外的快照仓库添加到 settings.gradle 中，以使用快照版本，这些版本在每次成功构建后都会自动上传。

添加存根

默认情况下，Spring Cloud Contract Verifier 会在 src/contractTest/resources/contracts 目录中查找存根。出于过渡目的，插件还会在 src/test/resources/contracts 中查找合约，但自 Spring Cloud Contract 3.0.0 起，此目录已被弃用。

还应注意，对于此新的 Gradle 源集，您还应该将合同测试中使用的任何基类迁移到 src/contractTest/{language}，其中 {language} 应根据您的需要替换为 Java 或 Groovy。

包含存根定义的目录被视为类名，每个存根定义被视为一个测试。Spring Cloud Contract Verifier 假设它包含至少一个目录级别，这些目录将用作测试类名。如果存在多个级别的嵌套目录，则除最后一个目录外，所有目录都将用作包名。考虑以下结构

src/contractTest/resources/contracts/myservice/shouldCreateUser.groovy
src/contractTest/resources/contracts/myservice/shouldReturnUser.groovy

给定上述结构，Spring Cloud Contract Verifier 创建一个名为 defaultBasePackage.MyService 的测试类，其中包含两个方法

  • shouldCreateUser()

  • shouldReturnUser()

运行插件

该插件在 check 任务之前注册以被调用。如果您希望它成为构建过程的一部分，则无需执行任何操作。如果您只想生成测试，请调用 generateContractTests 任务。

默认设置

默认的 Gradle 插件设置创建以下 Gradle 构建部分（伪代码）

contracts {
    testFramework ='JUNIT'
    testMode = 'MockMvc'
    generatedTestJavaSourcesDir = project.file("$\{project.buildDir}/generated-test-sources/contractTest/java")
    generatedTestGroovySourcesDir = project.file("$\{project.buildDir}/generated-test-sources/contractTest/groovy")
    generatedTestResourcesDir = project.file("$\{project.buildDir}/generated-test-resources/contracts")
    contractsDslDir = project.file("$\{project.projectDir}/src/contractTest/resources/contracts")
    basePackageForTests = 'org.springframework.cloud.verifier.tests'
    stubsOutputDir = project.file("$\{project.buildDir}/stubs")
    sourceSet = null
}

def verifierStubsJar = tasks.register(type: Jar, name: 'verifierStubsJar', dependsOn: 'generateClientStubs') {
    baseName = project.name
    classifier = contracts.stubsSuffix
    from contractVerifier.stubsOutputDir
}

def copyContracts = tasks.register(type: Copy, name: 'copyContracts') {
    from contracts.contractsDslDir
    into contracts.stubsOutputDir
}

verifierStubsJar.dependsOn copyContracts

配置插件

要更改默认配置，您可以向 Gradle 配置添加一个 contracts 片段，如以下清单所示

contracts {
	testMode = 'MockMvc'
	baseClassForTests = 'org.mycompany.tests'
	generatedTestJavaSourcesDir = project.file('src/generatedContract')
}

要从远程源下载合约，您可以根据需要使用以下片段

contracts {
    // If your contracts exist in a JAR archive published to a Maven repository
    contractDependency {
        stringNotation = ''
        // OR
        groupId = ''
        artifactId = ''
        version = ''
        classifier = ''
    }

    // If your contracts exist in a Git SCM repository
    contractRepository {
        repositoryUrl = ''
        // username = ''
        // password = ''
    }

    // controls the nested location to find the contracts in either the JAR or Git SCM source
    contractsPath = ''
}

由于我们正在使用 Gradle 的 Jar 打包任务，因此您可能希望利用多种选项和功能来进一步扩展 verifierStubsJar 创建的内容。为此，您将使用 Gradle 直接提供的原生机制来定制现有任务，如下所示

为了举例说明，我们希望将 git.properties 文件添加到 verifierStubsJar 中。 
verifierStubsJar {
    from("$\{buildDir}/resources/main/") {
        include("git.properties")
    }
}

还需要注意的是，自 3.0.0 版本起，默认发布已被禁用。这意味着，您能够创建任何命名的 jar，并像您通常通过 Gradle 配置选项所做的那样发布它。这意味着您可以构建一个按照您想要的方式自定义的 jar 文件，并发布该文件，以完全控制 jar 的布局和内容。

配置选项

  • testMode：定义验收测试模式。默认情况下，模式为 MockMvc，它基于 Spring 的 MockMvc。也可以更改为 WebTestClient、JaxRsClient 或 Explicit（用于实际 HTTP 调用）。

  • imports：创建一个数组，其中包含应包含在生成测试中的导入（例如，['org.myorg.Matchers']）。默认情况下，它创建一个空数组。

  • staticImports：创建一个数组，其中包含应包含在生成测试中的静态导入（例如，['org.myorg.Matchers.*']）。默认情况下，它创建一个空数组。

  • basePackageForTests：指定所有生成测试的基包。如果未设置，则从 baseClassForTests 和 packageWithBaseClasses 的包中获取值。如果这些值都未设置，则该值设置为 org.springframework.cloud.contract.verifier.tests。

  • baseClassForTests：为所有生成测试创建一个基类。默认情况下，如果您使用 Spock 类，则该类为 spock.lang.Specification。

  • packageWithBaseClasses：定义所有基类所在的包。此设置优先于 baseClassForTests。

  • baseClassMappings：将契约包显式映射到基类的完全限定名。此设置优先于 packageWithBaseClasses 和 baseClassForTests。

  • ignoredFiles：使用 Antmatcher 允许定义应跳过处理的存根文件。默认情况下，它是一个空数组。

  • contractsDslDir：指定包含使用 GroovyDSL 编写的契约的目录。默认情况下，其值为 $projectDir/src/contractTest/resources/contracts。

  • generatedTestSourcesDir：指定应放置从 Groovy DSL 生成的测试的测试源目录。（已弃用）

  • generatedTestJavaSourcesDir：指定应放置从 Groovy DSL 生成的 Java/JUnit 测试的测试源目录。默认情况下，其值为 $buildDir/generated-tes-sources/contractTest/java。

  • generatedTestGroovySourcesDir：指定应放置从 Groovy DSL 生成的 Groovy/Spock 测试的测试源目录。默认情况下，其值为 $buildDir/generated-test-sources/contractTest/groovy。

  • generatedTestResourcesDir：指定应放置从 Groovy DSL 生成的测试所使用的资源的测试资源目录。默认情况下，其值为 $buildDir/generated-test-resources/contractTest。

  • stubsOutputDir：指定应放置从 Groovy DSL 生成的 WireMock 存根的目录。

  • testFramework：指定要使用的目标测试框架。目前支持 Spock、JUnit 4 (TestFramework.JUNIT) 和 JUnit 5，其中 JUnit 4 是默认框架。

  • contractsProperties：包含要传递给 Spring Cloud Contract 组件的属性的映射。这些属性可能由（例如）内置或自定义存根下载器使用。

  • sourceSet：存储契约的源集。如果未提供，则假定为 contractTest（例如，JUnit 的 project.sourceSets.contractTest.java 或 Spock 的 project.sourceSets.contractTest.groovy）。

当您想指定包含契约的 JAR 的位置时，可以使用以下属性

  • contractDependency：指定提供 groupid:artifactid:version:classifier 坐标的依赖项。您可以使用 contractDependency 闭包进行设置。

  • contractsPath：指定 jar 的路径。如果下载了契约依赖项，则路径默认为 groupid/artifactid，其中 groupid 以斜杠分隔。否则，它会在提供的目录下扫描契约。

  • contractsMode：指定下载契约的模式（JAR 是否可离线、远程等）。

  • deleteStubsAfterTest：如果设置为 false，则不会从临时目录中删除任何下载的契约。

  • failOnNoContracts：启用后，如果未找到任何契约，则会抛出异常。默认为 true。

  • failOnInProgress：如果设置为 true，则如果发现任何正在进行的契约，它们将中断构建。在生产者端，您需要明确表示您有正在进行的契约，并考虑您可能会在消费者端导致假阳性测试结果。默认为 true。

还有一个 contractRepository { …​ } 闭包，其中包含以下属性

  • repositoryUrl：包含契约定义的仓库的 URL

  • username：仓库用户名

  • password：仓库密码

  • proxyPort：代理端口

  • proxyHost：代理主机

  • cacheDownloadedContracts：如果设置为 true，则缓存非快照契约工件下载的文件夹。默认为 true。

您还可以在插件中启用以下实验性功能

  • convertToYaml：将所有 DSL 转换为声明性 YAML 格式。当您在 Groovy DSL 中使用外部库时，这会非常有用。通过启用此功能（将其设置为 true），您无需在消费者端添加库依赖项。

  • assertJsonSize：您可以检查生成测试中 JSON 数组的大小。此功能默认禁用。

所有测试的单一基类

在 MockMvc（默认）中使用 Spring Cloud Contract Verifier 时，您需要为所有生成的验收测试创建一个基本规范。在此类中，您需要指向应验证的端点。以下示例显示了如何执行此操作

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/contractTest/resources/contract/foo/bar/baz/ 中，并将 packageWithBaseClasses 属性的值设置为 com.example.base，则 Spring Cloud Contract Verifier 假定在 com.example.base 包下有一个 BarBazBase 类。换句话说，系统会取包的最后两个部分（如果存在），并形成一个带有 Base 后缀的类。此规则优先于 baseClassForTests。

通过映射

您可以手动将契约包的正则表达式映射到匹配契约的基类的完全限定名。您必须提供一个名为 baseClassMappings 的列表，该列表由 baseClassMapping 对象组成，这些对象接受 contractPackageRegex 到 baseClassFQN 的映射。

假设您在以下目录中有契约

  • src/contractTest/resources/contract/com/

  • src/contractTest/resources/contract/foo/

通过提供 baseClassForTests，我们在映射失败时有一个备用方案。（您也可以提供 packageWithBaseClasses 作为备用方案。）这样，从 src/contractTest/resources/contract/com/ 契约生成的测试将扩展 com.example.ComBase，而其余测试将扩展 com.example.FooBase。

调用生成的测试

为确保提供方与您定义的契约兼容，您需要运行以下命令

./gradlew contractTest

发布存根到制品仓库

如果您使用二进制制品仓库来保存存根，则需要配置 Gradle 的发布部分以包含 verifierStubsJar。为此，您可以使用下面的示例配置

apply plugin: 'maven-publish'

publishing {
    publications {
        maven(MavenPublication) {
            // other configuration

            artifact verifierStubsJar
        }
    }
}

自 3.0.0 起，内部存根发布已被弃用并默认禁用。建议将 verifierStubsJar 包含在您自己的发布之一中。

将存根推送到 SCM

如果您使用 SCM 仓库来保存契约和存根，您可能希望自动化将存根推送到仓库的步骤。为此，您可以通过运行以下命令调用 pushStubsToScm 任务

$ ./gradlew pushStubsToScm

在使用 SCM 存根下载器下，您可以找到所有可能的配置选项，这些选项可以通过 contractsProperties 字段（例如，contracts { contractsProperties = [foo:"bar"] }）、通过 contractsProperties 方法（例如，contracts { contractsProperties([foo:"bar"]) }）或通过系统属性或环境变量传递。

消费者端的 Spring Cloud Contract Verifier

在消费服务中，您需要以与提供者端完全相同的方式配置 Spring Cloud Contract Verifier 插件。如果您不想使用 Stub Runner，则需要复制存储在 src/contractTest/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 Verifier 生成的存根配置的 WireMock 服务器处理。

© . This site is unofficial and not affiliated with VMware.