合约 DSL

Spring Cloud Contract 支持以下语言编写的 DSL：spring-doc.cn

Spring Cloud Contract 支持在单个文件中定义多个 Contract （在 Groovy 中返回一个列表而不是单个 Contract ）。

以下示例显示了 Contract 定义：spring-doc.cn

槽的
org.springframework.cloud.contract.spec.Contract.make {
	request {
		method 'PUT'
		url '/api/12'
		headers {
			header 'Content-Type': 'application/vnd.org.springframework.cloud.contract.verifier.twitter-places-analyzer.v1+json'
		}
		body '''\
	[{
		"created_at": "Sat Jul 26 09:38:57 +0000 2014",
		"id": 492967299297845248,
		"id_str": "492967299297845248",
		"text": "Gonna see you at Warsaw",
		"place":
		{
			"attributes":{},
			"bounding_box":
			{
				"coordinates":
					[[
						[-77.119759,38.791645],
						[-76.909393,38.791645],
						[-76.909393,38.995548],
						[-77.119759,38.995548]
					]],
				"type":"Polygon"
			},
			"country":"United States",
			"country_code":"US",
			"full_name":"Washington, DC",
			"id":"01fbe706f872cb32",
			"name":"Washington",
			"place_type":"city",
			"url": "https://api.twitter.com/1/geo/id/01fbe706f872cb32.json"
		}
	}]
'''
	}
	response {
		status OK()
	}
}
YAML
description: Some description
name: some name
priority: 8
ignored: true
request:
  url: /foo
  queryParameters:
    a: b
    b: c
  method: PUT
  headers:
    foo: bar
    fooReq: baz
  body:
    foo: bar
  matchers:
    body:
      - path: $.foo
        type: by_regex
        value: bar
    headers:
      - key: foo
        regex: bar
response:
  status: 200
  headers:
    foo2: bar
    foo3: foo33
    fooRes: baz
  body:
    foo2: bar
    foo3: baz
    nullValue: null
  matchers:
    body:
      - path: $.foo2
        type: by_regex
        value: bar
      - path: $.foo3
        type: by_command
        value: executeMe($it)
      - path: $.nullValue
        type: by_null
        value: null
    headers:
      - key: foo2
        regex: bar
      - key: foo3
        command: andMeToo($it)
Java
import java.util.Collection;
import java.util.Collections;
import java.util.function.Supplier;

import org.springframework.cloud.contract.spec.Contract;
import org.springframework.cloud.contract.verifier.util.ContractVerifierUtil;

class contract_rest implements Supplier<Collection<Contract>> {

	@Override
	public Collection<Contract> get() {
		return Collections.singletonList(Contract.make(c -> {
			c.description("Some description");
			c.name("some name");
			c.priority(8);
			c.ignored();
			c.request(r -> {
				r.url("/foo", u -> {
					u.queryParameters(q -> {
						q.parameter("a", "b");
						q.parameter("b", "c");
					});
				});
				r.method(r.PUT());
				r.headers(h -> {
					h.header("foo", r.value(r.client(r.regex("bar")), r.server("bar")));
					h.header("fooReq", "baz");
				});
				r.body(ContractVerifierUtil.map().entry("foo", "bar"));
				r.bodyMatchers(m -> {
					m.jsonPath("$.foo", m.byRegex("bar"));
				});
			});
			c.response(r -> {
				r.fixedDelayMilliseconds(1000);
				r.status(r.OK());
				r.headers(h -> {
					h.header("foo2", r.value(r.server(r.regex("bar")), r.client("bar")));
					h.header("foo3", r.value(r.server(r.execute("andMeToo($it)")), r.client("foo33")));
					h.header("fooRes", "baz");
				});
				r.body(ContractVerifierUtil.map().entry("foo2", "bar").entry("foo3", "baz").entry("nullValue", null));
				r.bodyMatchers(m -> {
					m.jsonPath("$.foo2", m.byRegex("bar"));
					m.jsonPath("$.foo3", m.byCommand("executeMe($it)"));
					m.jsonPath("$.nullValue", m.byNull());
				});
			});
		}));
	}

}
Kotlin
import org.springframework.cloud.contract.spec.ContractDsl.Companion.contract
import org.springframework.cloud.contract.spec.withQueryParameters

contract {
	name = "some name"
	description = "Some description"
	priority = 8
	ignored = true
	request {
		url = url("/foo") withQueryParameters  {
			parameter("a", "b")
			parameter("b", "c")
		}
		method = PUT
		headers {
			header("foo", value(client(regex("bar")), server("bar")))
			header("fooReq", "baz")
		}
		body = body(mapOf("foo" to "bar"))
		bodyMatchers {
			jsonPath("$.foo", byRegex("bar"))
		}
	}
	response {
		delay = fixedMilliseconds(1000)
		status = OK
		headers {
			header("foo2", value(server(regex("bar")), client("bar")))
			header("foo3", value(server(execute("andMeToo(\$it)")), client("foo33")))
			header("fooRes", "baz")
		}
		body = body(mapOf(
				"foo" to "bar",
				"foo3" to "baz",
				"nullValue" to null
		))
		bodyMatchers {
			jsonPath("$.foo2", byRegex("bar"))
			jsonPath("$.foo3", byCommand("executeMe(\$it)"))
			jsonPath("$.nullValue", byNull)
		}
	}
}

您可以使用以下独立的 Maven 命令将合同编译为存根映射：spring-doc.cn

mvn org.springframework.cloud:spring-cloud-contract-maven-plugin:convert

Groovy 中的 Contract DSL

如果您不熟悉 Groovy，请不要担心。您可以在 Groovy DSL 文件。spring-doc.cn

如果您决定用 Groovy 编写合约，如果您还没有使用 Groovy，请不要惊慌 以前。实际上并不需要了解该语言，因为 Contract DSL 只使用 它的一小部分（仅 Literals、Method Calls 和 Closure）。此外，DSL 是静态的 typed，使其无需任何 DSL 本身知识即可程序员可读。spring-doc.cn

请记住，在 Groovy 合约文件中，您必须提供完整的 限定名称添加到类和静态导入中，例如 .您还可以将导入 类 （），然后调用 .Contractmakeorg.springframework.cloud.spec.Contract.make { …​ }Contractimport org.springframework.cloud.spec.ContractContract.make { …​ }

Java 中的合约 DSL

要在 Java 中编写合同定义，您需要创建一个类，该类实现接口（对于单个合同）或（对于多个合同）。Supplier<Contract>Supplier<Collection<Contract>>spring-doc.cn

您还可以在 （例如） 下编写 Contract 定义，这样就不必修改项目的 Classpath 。在这种情况下，您必须为 Spring Cloud Contract 插件提供 Contract 定义的新位置。src/test/javasrc/test/java/contractsspring-doc.cn

以下示例（在 Maven 和 Gradle 中）在 Contract definitions 下 ：src/test/javaspring-doc.cn

Maven 系列
<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
    <configuration>
        <contractsDirectory>src/test/java/contracts</contractsDirectory>
    </configuration>
</plugin>
Gradle
contracts {
	contractsDslDir = new File(project.rootDir, "src/test/java/contracts")
}

Kotlin 中的合约 DSL

要开始使用 Kotlin 编写合约，您需要从（新创建的）Kotlin 脚本文件 （） 开始。 与 Java DSL 一样，您可以将 Contract 放在您选择的任何目录中。 默认情况下，Maven 插件将查看目录，而 Gradle 插件将 看看目录。.ktssrc/test/resources/contractssrc/contractTest/resources/contractsspring-doc.cn

从 3.0.0 开始，Gradle 插件也将查看遗留的 目录进行迁移。在此目录中找到 Contract 时，会显示一条警告 将在您的构建过程中记录。src/test/resources/contracts

您需要将依赖项显式传递给您的项目插件设置。 以下示例（在 Maven 和 Gradle 中）展示了如何做到这一点：spring-cloud-contract-spec-kotlinspring-doc.cn

Maven 系列
<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
    <configuration>
        <!-- some config -->
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-contract-spec-kotlin</artifactId>
            <version>${spring-cloud-contract.version}</version>
        </dependency>
    </dependencies>
</plugin>

<dependencies>
        <!-- Remember to add this for the DSL support in the IDE and on the consumer side -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-contract-spec-kotlin</artifactId>
            <scope>test</scope>
        </dependency>
</dependencies>
Gradle
buildscript {
    repositories {
        // ...
    }
	dependencies {
		classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:$\{scContractVersion}"
	}
}

dependencies {
    // ...

    // Remember to add this for the DSL support in the IDE and on the consumer side
    testImplementation "org.springframework.cloud:spring-cloud-contract-spec-kotlin"
    // Kotlin versions are very particular down to the patch version. The <kotlin_version> needs to be the same as you have imported for your project.
    testImplementation "org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable:<kotlin_version>"
}
请记住，在 Kotlin 脚本文件中，您必须为类提供完全限定名称。 通常，您将按如下方式使用其 Contract 函数：。 您还可以提供对函数 （） 的导入，然后调用 .ContractDSLorg.springframework.cloud.contract.spec.ContractDsl.contract { …​ }contractimport org.springframework.cloud.contract.spec.ContractDsl.Companion.contractcontract { …​ }

YAML 中的合约 DSL

要查看 YAML 协定的架构，请访问 YML 架构页面。spring-doc.cn

局限性

对验证 JSON 数组大小的支持是实验性的。如果需要帮助， 要打开它，请将以下 System Property 的值设置为 ： 。默认情况下，此功能设置为 。 您还可以在插件配置中设置该属性。truespring.cloud.contract.verifier.assert.sizefalseassertJsonSize
由于 JSON 结构可以具有任何形式，因此可能无法对其进行解析 在使用 Groovy DSL 和 中的表示法时正确。那 是您应该使用 Groovy Map 表示法的原因。value(consumer(…​), producer(…​))GString

一个文件中的多个合同

您可以在一个文件中定义多个合同。这样的合约可能类似于 以下示例：spring-doc.cn

槽的
import org.springframework.cloud.contract.spec.Contract

[
	Contract.make {
		name("should post a user")
		request {
			method 'POST'
			url('/users/1')
		}
		response {
			status OK()
		}
	},
	Contract.make {
		request {
			method 'POST'
			url('/users/2')
		}
		response {
			status OK()
		}
	}
]
YAML
---
name: should post a user
request:
  method: POST
  url: /users/1
response:
  status: 200
---
request:
  method: POST
  url: /users/2
response:
  status: 200
---
request:
  method: POST
  url: /users/3
response:
  status: 200
Java
class contract implements Supplier<Collection<Contract>> {

	@Override
	public Collection<Contract> get() {
		return Arrays.asList(
            Contract.make(c -> {
            	c.name("should post a user");
                // ...
            }), Contract.make(c -> {
                // ...
            }), Contract.make(c -> {
                // ...
            })
		);
	}

}
Kotlin
import org.springframework.cloud.contract.spec.ContractDsl.Companion.contract

arrayOf(
    contract {
        name("should post a user")
        // ...
    },
    contract {
        // ...
    },
    contract {
        // ...
    }
}

在前面的示例中，一个 Contract 具有字段，而另一个 Contract 没有。这 导致生成两个测试，如下所示：namespring-doc.cn

import com.example.TestBase;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import com.jayway.restassured.module.mockmvc.specification.MockMvcRequestSpecification;
import com.jayway.restassured.response.ResponseOptions;
import org.junit.Test;

import static com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*;
import static com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson;
import static org.assertj.core.api.Assertions.assertThat;

public class V1Test extends TestBase {

	@Test
	public void validate_should_post_a_user() throws Exception {
		// given:
			MockMvcRequestSpecification request = given();

		// when:
			ResponseOptions response = given().spec(request)
					.post("/users/1");

		// then:
			assertThat(response.statusCode()).isEqualTo(200);
	}

	@Test
	public void validate_withList_1() throws Exception {
		// given:
			MockMvcRequestSpecification request = given();

		// when:
			ResponseOptions response = given().spec(request)
					.post("/users/2");

		// then:
			assertThat(response.statusCode()).isEqualTo(200);
	}

}

请注意，对于具有字段的 Contract，生成的测试方法名为 。没有该字段的名为 。它对应于文件名和 列表中合约的索引。namevalidate_should_post_a_usernamevalidate_withList_1WithList.groovyspring-doc.cn

生成的存根如以下示例所示：spring-doc.cn

should post a user.json
1_WithList.json

第一个文件从合约中获取参数。第二个 获取了以索引为前缀的合约文件 （） 的名称（在此 的情况下，合约在文件的合约列表中有一个索引 ）。nameWithList.groovy1spring-doc.cn

为您的合约命名要好得多，因为这样做会使 您的测试更有意义。

有状态合约

有状态合同（也称为场景）是应该读取的合同定义 挨次。这在以下情况下可能很有用：spring-doc.cn

  • 您希望以精确定义的顺序调用合约，因为您使用 Spring Cloud Contract 来测试您的有状态应用程序。spring-doc.cn

我们真的不鼓励你这样做，因为 Contract 测试应该是无状态的。

  • 您希望同一终端节点为同一请求返回不同的结果。spring-doc.cn

要创建有状态合约（或场景），您需要 在创建合同时使用正确的命名约定。约定 要求包含订单号，后跟下划线。这无论如何都有效 了解您是使用 YAML 还是 Groovy。下面的清单显示了一个示例：spring-doc.cn

my_contracts_dir\
  scenario1\
    1_login.groovy
    2_showCart.groovy
    3_logout.groovy

这样的树会导致 Spring Cloud Contract Verifier 生成 WireMock 的场景，其中包含 name of 和以下三个步骤：scenario1spring-doc.cn

  1. login，标记为指向...Startedspring-doc.cn

  2. showCart，标记为指向...Step1spring-doc.cn

  3. logout，标记为 （这将关闭方案）。Step2spring-doc.cn

您可以在 https://wiremock.org/docs/stateful-behaviour/ 中找到有关 WireMock 方案的更多详细信息。spring-doc.cn