开发您的第一个基于 Spring Cloud Contract 的应用程序

本简短导览介绍了如何使用 Spring Cloud Contract。它包含以下主题

您可以在 此处 找到更简短的导览。

在本示例中，Stub Storage 是 Nexus/Artifactory。

以下 UML 图显示了 Spring Cloud Contract 各部分之间的关系

getting-started-three-second

生产者端

要开始使用 Spring Cloud Contract，您可以将 Spring Cloud Contract Verifier 依赖和插件添加到您的构建文件，如下例所示

点击此处查看代码

以下列表显示了如何添加插件，该插件应位于文件的 build/plugins 部分

<plugin>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-contract-maven-plugin</artifactId>
	<version>${spring-cloud-contract.version}</version>
	<extensions>true</extensions>
</plugin>

最简单的入门方法是访问 Spring Initializr 并添加“Web”和“Contract Verifier”作为依赖。这样做会引入前面提到的依赖以及您在 pom.xml 文件（除了设置基础测试类，这部分将在后面介绍）中需要的其他所有内容。下图显示了在 Spring Initializr 中使用的设置

Spring Initializr with Web and Contract Verifier

现在，您可以将使用 Groovy DSL 或 YAML 表达的 REST/ 消息传递契约文件添加到 contracts 目录中，该目录由 contractsDslDir 属性设置。默认情况下，它是 $rootDir/src/test/resources/contracts。请注意，文件名无关紧要。您可以在此目录中按照您喜欢的任何命名方案组织您的契约。

对于 HTTP Stubs，契约定义了对于给定请求应返回什么样的响应（考虑到 HTTP 方法、URL、头部、状态码等）。以下示例展示了 Groovy 和 YAML 格式的 HTTP Stub 契约

groovy
org.springframework.cloud.contract.spec.Contract.make {
	request {
		method 'PUT'
		url '/fraudcheck'
		body([
			   "client.id": $(regex('[0-9]{10}')),
			   loanAmount: 99999
		])
		headers {
			contentType('application/json')
		}
	}
	response {
		status OK()
		body([
			   fraudCheckStatus: "FRAUD",
			   "rejection.reason": "Amount too high"
		])
		headers {
			contentType('application/json')
		}
	}
}
yaml
request:
  method: PUT
  url: /fraudcheck
  body:
    "client.id": 1234567890
    loanAmount: 99999
  headers:
    Content-Type: application/json
  matchers:
    body:
      - path: $.['client.id']
        type: by_regex
        value: "[0-9]{10}"
response:
  status: 200
  body:
    fraudCheckStatus: "FRAUD"
    "rejection.reason": "Amount too high"
  headers:
    Content-Type: application/json;charset=UTF-8

如果您需要使用消息传递，可以定义

  • 输入和输出消息（考虑发送位置、消息体和头部）。

  • 收到消息后应调用的方法。

  • 调用后应触发消息的方法。

以下示例展示了一个 Camel 消息传递契约

groovy
def contractDsl = Contract.make {
	name "foo"
	label 'some_label'
	input {
		triggeredBy('bookReturnedTriggered()')
	}
	outputMessage {
		sentTo('activemq:output')
		body('''{ "bookName" : "foo" }''')
		headers {
			header('BOOK-NAME', 'foo')
			messagingContentType(applicationJson())
		}
	}
}
yaml
label: some_label
input:
  triggeredBy: bookReturnedTriggered
outputMessage:
  sentTo: activemq:output
  body:
    bookName: foo
  headers:
    BOOK-NAME: foo
    contentType: application/json

运行 ./mvnw clean install 会自动生成测试来验证应用是否符合添加的契约。默认情况下，生成的测试位于 org.springframework.cloud.contract.verifier.tests. 包下。

生成的测试可能有所不同，具体取决于您在插件中设置的框架和测试类型。

在下一个列表中，您可以找到

  • 在 MockMvc 中用于 HTTP 契约的默认测试模式

  • 一个使用 JAXRS 测试模式的 JAX-RS 客户端

  • 一个基于 WebTestClient 的测试（在使用响应式、基于 Web-Flux 的应用时特别推荐），设置了 WEBTESTCLIENT 测试模式

您只需要这些测试框架中的一个。MockMvc 是默认的。要使用其他框架之一，请将其库添加到您的类路径中。

以下列表展示了所有框架的示例

mockmvc
@Test
public void validate_shouldMarkClientAsFraud() throws Exception {
    // given:
        MockMvcRequestSpecification request = given()
                .header("Content-Type", "application/vnd.fraud.v1+json")
                .body("{\"client.id\":\"1234567890\",\"loanAmount\":99999}");

    // when:
        ResponseOptions response = given().spec(request)
                .put("/fraudcheck");

    // then:
        assertThat(response.statusCode()).isEqualTo(200);
        assertThat(response.header("Content-Type")).matches("application/vnd.fraud.v1.json.*");
    // and:
        DocumentContext parsedJson = JsonPath.parse(response.getBody().asString());
        assertThatJson(parsedJson).field("['fraudCheckStatus']").matches("[A-Z]{5}");
        assertThatJson(parsedJson).field("['rejection.reason']").isEqualTo("Amount too high");
}
jaxrs
public class FooTest {
  WebTarget webTarget;

  @Test
  public void validate_() throws Exception {

    // when:
      Response response = webTarget
              .path("/users")
              .queryParam("limit", "10")
              .queryParam("offset", "20")
              .queryParam("filter", "email")
              .queryParam("sort", "name")
              .queryParam("search", "55")
              .queryParam("age", "99")
              .queryParam("name", "Denis.Stepanov")
              .queryParam("email", "[email protected]")
              .request()
              .build("GET")
              .invoke();
      String responseAsString = response.readEntity(String.class);

    // then:
      assertThat(response.getStatus()).isEqualTo(200);

    // and:
      DocumentContext parsedJson = JsonPath.parse(responseAsString);
      assertThatJson(parsedJson).field("['property1']").isEqualTo("a");
  }

}
webtestclient
@Test
	public void validate_shouldRejectABeerIfTooYoung() throws Exception {
		// given:
			WebTestClientRequestSpecification request = given()
					.header("Content-Type", "application/json")
					.body("{\"age\":10}");

		// when:
			WebTestClientResponse response = given().spec(request)
					.post("/check");

		// then:
			assertThat(response.statusCode()).isEqualTo(200);
			assertThat(response.header("Content-Type")).matches("application/json.*");
		// and:
			DocumentContext parsedJson = JsonPath.parse(response.getBody().asString());
			assertThatJson(parsedJson).field("['status']").isEqualTo("NOT_OK");
	}

由于契约描述的功能尚未实现，测试将会失败。

为了让它们通过，您必须添加处理 HTTP 请求或消息的正确实现。此外，您必须为项目中自动生成的测试添加一个基础测试类。所有自动生成的测试都将继承此基类，并且它应包含运行这些测试所需的所有必要设置信息（例如，RestAssuredMockMvc 控制器设置或消息传递测试设置）。

以下示例，来自 pom.xml 文件，展示了如何指定基础测试类

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-contract-maven-plugin</artifactId>
                <version>2.1.2.RELEASE</version>
                <extensions>true</extensions>
                <configuration>
                    <baseClassForTests>com.example.contractTest.BaseTestClass</baseClassForTests> (1)
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
1 baseClassForTests 元素允许您指定您的基础测试类。它必须是 spring-cloud-contract-maven-plugin 中 configuration 元素的子元素。

以下示例展示了一个最小（但功能齐全）的基础测试类

package com.example.contractTest;

import org.junit.Before;

import io.restassured.module.mockmvc.RestAssuredMockMvc;

public class BaseTestClass {

	@Before
	public void setup() {
		RestAssuredMockMvc.standaloneSetup(new FraudController());
	}
}

这个最小类确实是让您的测试工作所需的一切。它作为一个起点，自动生成的测试将附加到此处。

现在我们可以继续实现。为此，我们首先需要一个数据类，稍后将在我们的控制器中使用它。以下列表展示了该数据类

package com.example.Test;

import com.fasterxml.jackson.annotation.JsonProperty;

public class LoanRequest {

	@JsonProperty("client.id")
	private String clientId;

	private Long loanAmount;

	public String getClientId() {
		return clientId;
	}

	public void setClientId(String clientId) {
		this.clientId = clientId;
	}

	public Long getLoanAmount() {
		return loanAmount;
	}

	public void setLoanRequestAmount(Long loanAmount) {
		this.loanAmount = loanAmount;
	}
}

前面的类提供了一个对象，我们可以在其中存储参数。由于契约中的客户端 ID 被称为 client.id，我们需要使用 @JsonProperty("client.id") 参数将其映射到 clientId 字段。

现在我们可以转到控制器，以下列表展示了它

package com.example.docTest;

import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FraudController {

	@PutMapping(value = "/fraudcheck", consumes="application/json", produces="application/json")
	public String check(@RequestBody LoanRequest loanRequest) { (1)

		if (loanRequest.getLoanAmount() > 10000) { (2)
			return "{fraudCheckStatus: FRAUD, rejection.reason: Amount too high}"; (3)
		} else {
			return "{fraudCheckStatus: OK, acceptance.reason: Amount OK}"; (4)
		}
	}
}
1 我们将传入的参数映射到 LoanRequest 对象。
2 我们检查请求的贷款金额是否过多。
3 如果金额过多，我们将返回测试预期的 JSON（此处使用简单字符串创建）。
4 如果我们有一个测试来捕获金额允许的情况，我们可以将其与此输出匹配。

FraudController 非常简单。您可以做更多事情，包括日志记录、验证客户端 ID 等等。

一旦实现和基础测试类到位，测试将通过，并且应用程序和 Stub Artifact 都将在本地 Maven 仓库中构建和安装。将 stubs jar 安装到本地仓库的信息会出现在日志中，如下例所示

[INFO] --- spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateStubs (default-generateStubs) @ http-server ---
[INFO] Building jar: /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar
[INFO]
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ http-server ---
[INFO] Building jar: /some/path/http-server/target/http-server-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:1.5.5.BUILD-SNAPSHOT:repackage (default) @ http-server ---
[INFO]
[INFO] --- maven-install-plugin:2.5.2:install (default-install) @ http-server ---
[INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.jar
[INFO] Installing /some/path/http-server/pom.xml to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.pom
[INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar

您现在可以合并更改并将应用程序和 Stub Artifact 发布到在线仓库。

消费方端

您可以在集成测试中使用 Spring Cloud Contract Stub Runner 来获取运行中的 WireMock 实例或模拟实际服务的消息传递路由。

要开始使用，请添加 Spring Cloud Contract Stub Runner 依赖，如下所示

点击此处查看代码

您可以通过以下两种方式之一将生产者端的 Stubs 安装到您的 Maven 仓库

  • 通过检出生产者端仓库并添加契约，然后运行以下命令生成 Stubs

    $ cd local-http-server-repo
$ ./mvnw clean install -DskipTests
    测试被跳过，因为生产者端的契约实现尚未到位，因此自动生成的契约测试会失败。

  • 从远程仓库获取现有的生产者服务 Stubs。为此，将 Stub Artifact ID 和 Artifact 仓库 URL 作为 Spring Cloud Contract Stub Runner 属性传递，如下例所示

    点击此处查看代码

现在您可以使用 @AutoConfigureStubRunner 注解您的测试类。在注解中，提供 group-id 和 artifact-id，以便让 Spring Cloud Contract Stub Runner 为您运行协作者的 Stubs，如下例所示

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.NONE)
@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:6565"},
		stubsMode = StubRunnerProperties.StubsMode.LOCAL)
public class LoanApplicationServiceTests {
	. . .
}
从在线仓库下载 Stubs 时使用 REMOTE stubsMode，离线工作时使用 LOCAL。

在您的集成测试中，您可以接收协作者服务预期会发出的 HTTP 响应或消息的 Stub 版本。您可以在构建日志中看到类似于以下的条目

2016-07-19 14:22:25.403  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Desired version is + - will try to resolve the latest version
2016-07-19 14:22:25.438  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Resolved version is 0.0.1-SNAPSHOT
2016-07-19 14:22:25.439  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Resolving artifact com.example:http-server:jar:stubs:0.0.1-SNAPSHOT using remote repositories []
2016-07-19 14:22:25.451  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Resolved artifact com.example:http-server:jar:stubs:0.0.1-SNAPSHOT to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar
2016-07-19 14:22:25.465  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Unpacking stub from JAR [URI: file:/path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar]
2016-07-19 14:22:25.475  INFO 41050 --- [           main] o.s.c.c.stubrunner.AetherStubDownloader  : Unpacked file to [/var/folders/0p/xwq47sq106x1_g3dtv6qfm940000gq/T/contracts100276532569594265]
2016-07-19 14:22:27.737  INFO 41050 --- [           main] o.s.c.c.stubrunner.StubRunnerExecutor    : All stubs are now running RunningStubs [namesAndPorts={com.example:http-server:0.0.1-SNAPSHOT:stubs=8080}]