Maven 项目

添加 Maven 插件

要添加 Spring Cloud Contract BOM，请在您的 pom.xml 文件中包含以下部分

<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-contract-dependencies</artifactId>
	<version>${spring-cloud-contract.version}</version>
	<type>pom</type>
	<scope>import</scope>
</dependency>

接下来，添加 Spring Cloud Contract Verifier Maven 插件，如下所示

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

有时，无论选择哪个 IDE，您可能会发现 target/generated-test-source 文件夹在 IDE 的类路径中不可见。为确保它始终存在，您可以将以下条目添加到您的 pom.xml 中

<plugin>
	<groupId>org.codehaus.mojo</groupId>
	<artifactId>build-helper-maven-plugin</artifactId>
	<executions>
		<execution>
			<id>add-source</id>
			<phase>generate-test-sources</phase>
			<goals>
				<goal>add-test-source</goal>
			</goals>
			<configuration>
				<sources>
					<source>${project.build.directory}/generated-test-sources/contracts/</source>
				</sources>
			</configuration>
		</execution>
	</executions>
</plugin>

Maven 和 Rest Assured 2.0

默认情况下，Rest Assured 3.x 会添加到类路径中。但是，您可以通过将其添加到插件类路径中来使用 Rest Assured 2.x，如下所示

<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
    <configuration>
        <packageWithBaseClasses>com.example</packageWithBaseClasses>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-contract-verifier</artifactId>
            <version>${spring-cloud-contract.version}</version>
        </dependency>
        <dependency>
           <groupId>com.jayway.restassured</groupId>
           <artifactId>rest-assured</artifactId>
           <version>2.5.0</version>
           <scope>compile</scope>
        </dependency>
        <dependency>
           <groupId>com.jayway.restassured</groupId>
           <artifactId>spring-mock-mvc</artifactId>
           <version>2.5.0</version>
           <scope>compile</scope>
        </dependency>
    </dependencies>
</plugin>

<dependencies>
    <!-- all dependencies -->
    <!-- you can exclude rest-assured from spring-cloud-contract-verifier -->
    <dependency>
       <groupId>com.jayway.restassured</groupId>
       <artifactId>rest-assured</artifactId>
       <version>2.5.0</version>
       <scope>test</scope>
    </dependency>
    <dependency>
       <groupId>com.jayway.restassured</groupId>
       <artifactId>spring-mock-mvc</artifactId>
       <version>2.5.0</version>
       <scope>test</scope>
    </dependency>
</dependencies>

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

使用 Maven 的快照和里程碑版本

要使用快照和里程碑版本，您必须在您的 pom.xml 中添加以下部分

<repositories>
	<repository>
		<id>spring-snapshots</id>
		<name>Spring Snapshots</name>
		<url>https://repo.spring.io/snapshot</url>
		<snapshots>
			<enabled>true</enabled>
		</snapshots>
	</repository>
	<repository>
		<id>spring-milestones</id>
		<name>Spring Milestones</name>
		<url>https://repo.spring.io/milestone</url>
		<snapshots>
			<enabled>false</enabled>
		</snapshots>
	</repository>
</repositories>
<pluginRepositories>
	<pluginRepository>
		<id>spring-snapshots</id>
		<name>Spring Snapshots</name>
		<url>https://repo.spring.io/snapshot</url>
		<snapshots>
			<enabled>true</enabled>
		</snapshots>
	</pluginRepository>
	<pluginRepository>
		<id>spring-milestones</id>
		<name>Spring Milestones</name>
		<url>https://repo.spring.io/milestone</url>
		<snapshots>
			<enabled>false</enabled>
		</snapshots>
	</pluginRepository>
</pluginRepositories>

添加存根

默认情况下，Spring Cloud Contract Verifier 会在 src/test/resources/contracts 目录中查找存根。包含存根定义的目录被视为类名，每个存根定义被视为单个测试。我们假定它包含至少一个目录用作测试类名。如果存在多于一级的嵌套目录，除了最后一级之外的所有目录都将用作包名。考虑以下结构

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

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

  • shouldCreateUser()

  • shouldReturnUser()

运行插件

generateTests 插件目标被分配在 generate-test-sources 阶段调用。如果您希望它成为构建过程的一部分，则无需执行任何操作。如果您只想生成测试，请调用 generateTests 目标。

如果您想从 Maven 运行存根，请调用 run 目标，并将要运行的存根作为 spring.cloud.contract.verifier.stubs 系统属性，如下所示

mvn org.springframework.cloud:spring-cloud-contract-maven-plugin:run \ -Dspring.cloud.contract.verifier.stubs="com.acme:service-name"

配置插件

要更改默认配置，您可以向插件定义或 execution 定义添加一个 configuration 部分，如下所示

<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <executions>
        <execution>
            <goals>
                <goal>convert</goal>
                <goal>generateStubs</goal>
                <goal>generateTests</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <basePackageForTests>org.springframework.cloud.verifier.twitter.place</basePackageForTests>
        <baseClassForTests>org.springframework.cloud.verifier.twitter.place.BaseMockMvcSpec</baseClassForTests>
    </configuration>
</plugin>

配置选项

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

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

  • ruleClassForTests: 指定应添加到生成的测试类中的规则。

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

  • contractsDirectory: 指定包含使用 Groovy DSL 编写的契约的目录。默认目录为 /src/test/resources/contracts。

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

  • generatedTestResourcesDir: 指定生成的测试所使用的资源的测试资源目录。

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

  • packageWithBaseClasses: 定义所有基类所在的包。此设置优先于 baseClassForTests。约定是，如果您在 (例如) src/test/resources/contract/foo/bar/baz/ 下有一个契约，并将 packageWithBaseClasses 属性的值设置为 com.example.base，则 Spring Cloud Contract Verifier 假定 com.example.base 包下存在一个 BarBazBase 类。换句话说，系统会获取包的最后两个部分（如果存在），并形成一个以 Base 为后缀的类。

  • baseClassMappings: 指定基类映射列表，其中包含 contractPackageRegex（针对契约所在包进行检查）和 baseClassFQN（映射到匹配契约的基类的完全限定名）。例如，如果您在 src/test/resources/contract/foo/bar/baz/ 下有一个契约，并将 .* → com.example.base.BaseClass 属性映射，则从这些契约生成的测试类将扩展 com.example.base.BaseClass。此设置优先于 packageWithBaseClasses 和 baseClassForTests。

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

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

  • failOnInProgress: 如果设置为 true，那么，如果发现任何进行中的契约，它们将中断构建。在生产者端，您需要明确表示您有进行中的契约，并考虑到这可能会导致消费者端出现误报测试结果。默认为 true。

  • incrementalContractTests: 启用后，仅当契约自上次构建以来发生更改时才创建测试。默认为 true。

  • incrementalContractStubs: 启用后，仅当契约自上次构建以来发生更改时才创建存根。默认为 true。

  • incrementalContractStubsJar: 启用后，仅当存根自上次构建以来发生更改时才创建存根 jar。默认为 true。*httpPort：用于提供存根的 WireMock 服务器的 HTTP 端口。目前 spring.cloud.contract.verifier.http.port 属性仅在从目录提供存根时有效。否则，在提供存根 ID 时，端口必须包含在 ID 字符串中。*skip：设置为 true 以跳过验证器执行。*skipTestOnly：设置为 true 以跳过验证器测试生成。*stubs：要以下载和运行的存根列表，以冒号分隔的 Ivy 表示法。*minPort：指定存根应启动的最小端口。*maxPort：指定存根应启动的最大端口。*waitForKeyPressed：指定插件在启动存根后是否应等待用户按下键。*stubsClassifier：指定存根工件使用的分类器。

如果您想从 Maven 仓库下载契约定义，可以使用以下选项

  • contractDependency: 包含所有打包契约的契约依赖项。

  • contractsPath: JAR 中打包契约的具体契约路径。默认为 groupid/artifactid，其中 groupid 以斜杠分隔。

  • contractsMode: 选择查找和注册存根的模式。

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

  • contractsRepositoryUrl: 包含契约工件的仓库 URL。如果未提供，则使用当前 Maven 仓库。

  • contractsRepositoryUsername: 连接到包含契约的仓库时使用的用户名。

  • contractsRepositoryPassword: 连接到包含契约的仓库时使用的密码。

  • contractsRepositoryProxyHost: 连接到包含契约的仓库时使用的代理主机。

  • contractsRepositoryProxyPort: 连接到包含契约的仓库时使用的代理端口。

我们只缓存非快照、明确提供的版本（例如 + 或 1.0.0.BUILD-SNAPSHOT 不会被缓存）。默认情况下，此功能已开启。

以下列表描述了您可以在插件中打开的实验性功能

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

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

所有测试的单一基类

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

import org.mycompany.ExampleSpringController
import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc
import spock.lang.Specification

class MvcSpec extends Specification {
  def setup() {
   RestAssuredMockMvc.standaloneSetup(new ExampleSpringController())
  }
}

如有必要，您还可以设置整个上下文，如以下示例所示

import io.restassured.module.mockmvc.RestAssuredMockMvc;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.context.WebApplicationContext;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property")
public abstract class BaseTestClass {

	@Autowired
	WebApplicationContext context;

	@Before
	public void setup() {
		RestAssuredMockMvc.webAppContextSetup(this.context);
	}
}

如果您使用 EXPLICIT 模式，您可以使用基类来初始化整个测试应用程序，类似于您在常规集成测试中所做的那样。以下示例显示了如何操作

import io.restassured.RestAssured;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.web.context.WebApplicationContext;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property")
public abstract class BaseTestClass {

	@LocalServerPort
	int port;

	@Before
	public void setup() {
		RestAssured.baseURI = "https://:" + this.port;
	}
}

如果您使用 JAXRSCLIENT 模式，此基类还应包含一个 protected WebTarget webTarget 字段。目前，测试 JAX-RS API 的唯一方法是启动一个 Web 服务器。

为契约使用不同的基类

如果您的契约之间基类不同，您可以告诉 Spring Cloud Contract 插件自动生成的测试应扩展哪个类。您有两个选择

  • 遵循约定，为 packageWithBaseClasses 提供一个值

  • 使用 baseClassMappings 提供显式映射

通过约定

约定是，如果您在 (例如) src/test/resources/contract/foo/bar/baz/ 下有一个契约，并将 packageWithBaseClasses 属性的值设置为 com.example.base，则 Spring Cloud Contract Verifier 假定 com.example.base 包下存在一个 BarBazBase 类。换句话说，系统会获取包的最后两个部分（如果存在），并形成一个以 Base 为后缀的类。此规则优先于 baseClassForTests。以下示例显示了它在 contracts 闭包中如何工作

<plugin>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-contract-maven-plugin</artifactId>
	<configuration>
		<packageWithBaseClasses>hello</packageWithBaseClasses>
	</configuration>
</plugin>

通过映射

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

<plugin>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-contract-maven-plugin</artifactId>
	<configuration>
		<baseClassForTests>com.example.FooBase</baseClassForTests>
		<baseClassMappings>
			<baseClassMapping>
				<contractPackageRegex>.*com.*</contractPackageRegex>
				<baseClassFQN>com.example.TestBase</baseClassFQN>
			</baseClassMapping>
		</baseClassMappings>
	</configuration>
</plugin>

假设您的契约位于以下两个位置

  • src/test/resources/contract/com/

  • src/test/resources/contract/foo/

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

调用生成的测试

Spring Cloud Contract Maven 插件在名为 /generated-test-sources/contractVerifier 的目录中生成验证代码，并将此目录附加到 testCompile 目标。

对于 Groovy Spock 代码，您可以使用以下内容

<plugin>
	<groupId>org.codehaus.gmavenplus</groupId>
	<artifactId>gmavenplus-plugin</artifactId>
	<version>1.5</version>
	<executions>
		<execution>
			<goals>
				<goal>testCompile</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<testSources>
			<testSource>
				<directory>${project.basedir}/src/test/groovy</directory>
				<includes>
					<include>**/*.groovy</include>
				</includes>
			</testSource>
			<testSource>
				<directory>${project.build.directory}/generated-test-sources/contractVerifier</directory>
				<includes>
					<include>**/*.groovy</include>
				</includes>
			</testSource>
		</testSources>
	</configuration>
</plugin>

为确保提供者端符合定义的契约，您需要调用 mvn generateTest test。

将存根推送到 SCM

如果您使用 SCM（源代码控制管理）仓库来保存契约和存根，您可能希望自动化将存根推送到仓库的步骤。为此，您可以添加 pushStubsToScm 目标。以下示例显示了如何操作

<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
    <configuration>
        <!-- Base class mappings etc. -->

        <!-- We want to pick contracts from a Git repository -->
        <contractsRepositoryUrl>git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git</contractsRepositoryUrl>

        <!-- We reuse the contract dependency section to set up the path
        to the folder that contains the contract definitions. In our case the
        path will be /groupId/artifactId/version/contracts -->
        <contractDependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>${project.artifactId}</artifactId>
            <version>${project.version}</version>
        </contractDependency>

        <!-- The contracts mode can't be classpath -->
        <contractsMode>REMOTE</contractsMode>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <!-- By default we will not push the stubs back to SCM,
                you have to explicitly add it as a goal -->
                <goal>pushStubsToScm</goal>
            </goals>
        </execution>
    </executions>
</plugin>

在使用 SCM 存根下载器下，您可以找到所有可能的配置选项，您可以通过 <configuration><contractsProperties> 映射、系统属性或环境变量传递这些选项。例如，您可以指定要检出的具体分支，而不是默认分支

<plugin>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
    <version>${spring-cloud-contract.version}</version>
    <extensions>true</extensions>
    <configuration>
        <!-- Base class mappings etc. -->

        <!-- We want to pick contracts from a Git repository -->
        <contractsRepositoryUrl>git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git</contractsRepositoryUrl>
	<contractsProperties>
            <git.branch>another_branch</git.branch>
        </contractsProperties>

        <!-- We reuse the contract dependency section to set up the path
        to the folder that contains the contract definitions. In our case the
        path will be /groupId/artifactId/version/contracts -->
        <contractDependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>${project.artifactId}</artifactId>
            <version>${project.version}</version>
        </contractDependency>

        <!-- The contracts mode can't be classpath -->
        <contractsMode>REMOTE</contractsMode>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <!-- By default we will not push the stubs back to SCM,
                you have to explicitly add it as a goal -->
                <goal>pushStubsToScm</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Maven 插件和 STS

下图显示了您在使用 STS 时可能会看到的异常

STS Exception

当您点击错误标记时，您应该会看到类似以下内容

 plugin:1.1.0.M1:convert:default-convert:process-test-resources) org.apache.maven.plugin.PluginExecutionException: Execution default-convert of goal org.springframework.cloud:spring-
 cloud-contract-maven-plugin:1.1.0.M1:convert failed. at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:145) at
 org.eclipse.m2e.core.internal.embedder.MavenImpl.execute(MavenImpl.java:331) at org.eclipse.m2e.core.internal.embedder.MavenImpl$11.call(MavenImpl.java:1362) at
...
 org.eclipse.core.internal.jobs.Worker.run(Worker.java:55) Caused by: java.lang.NullPointerException at
 org.eclipse.m2e.core.internal.builder.plexusbuildapi.EclipseIncrementalBuildContext.hasDelta(EclipseIncrementalBuildContext.java:53) at
 org.sonatype.plexus.build.incremental.ThreadBuildContext.hasDelta(ThreadBuildContext.java:59) at

要解决此问题，请在您的 pom.xml 中提供以下部分

<build>
    <pluginManagement>
        <plugins>
            <!--This plugin's configuration is used to store Eclipse m2e settings
                only. It has no influence on the Maven build itself. -->
            <plugin>
                <groupId>org.eclipse.m2e</groupId>
                <artifactId>lifecycle-mapping</artifactId>
                <version>1.0.0</version>
                <configuration>
                    <lifecycleMappingMetadata>
                        <pluginExecutions>
                             <pluginExecution>
                                <pluginExecutionFilter>
                                    <groupId>org.springframework.cloud</groupId>
                                    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
                                    <versionRange>[1.0,)</versionRange>
                                    <goals>
                                        <goal>convert</goal>
                                    </goals>
                                </pluginExecutionFilter>
                                <action>
                                    <execute />
                                </action>
                             </pluginExecution>
                        </pluginExecutions>
                    </lifecycleMappingMetadata>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>

Maven 插件与 Spock 测试

您可以使用 Spock Framework 创建和运行自动生成的契约验证测试，包括 Maven 和 Gradle。然而，虽然使用 Gradle 很简单，但在 Maven 中，您需要一些额外的设置才能使测试正常编译和执行。

首先，您必须使用一个插件，例如 GMavenPlus 插件，将 Groovy 添加到您的项目中。在 GMavenPlus 插件中，您需要明确设置测试源，包括定义您的基础测试类的路径和添加生成的契约测试的路径。以下示例显示了如何操作。

如果您遵循 Spock 将测试类名以 Spec 结尾的约定，您还需要调整您的 Maven Surefire 插件设置，如 以下示例 所示。

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