Spring Cloud Contract实践

1.Spring Cloud Contract简介
Spring Cloud Contract是一个总体项目，其中包含帮助用户成功实施消费者驱动合同方法的解决方案。目前，Spring Cloud Contract包含Spring Cloud Contract Verifier项目。
2.什么是契约测试
契约测试，又称之为消费者驱动的契约测试(Consumer-Driven Contracts，简称CDC)，根据消费者驱动契约，我们可以将服务分为消费者端和生产者端，而消费者驱动的契约测试的核心思想在于是从消费者业务实现的角度出发，由消费者自己会定义需要的数据格式以及交互细节，并驱动生成一份契约文件。然后生产者根据契约文件来实现自己的逻辑，并在持续集成环境中持续验证。
3.现有微服务架构下的测试痛点
目前我们服务联调测试是这样的：

这样的情况存在主要问题如下：
1.联调依赖被调用服务逻辑。
2.被联调服务未开发完成，测试无法进行下去。
3.一次测试需要部署所有服务。
4.不能及时给予测试反馈，运行时间长。
4.微服务特点
在了解契约测试前我们先看下微服务特点：

5.契约测试核心原则
1.以消费者提出接口契约，交由服务提供方实现，并以测试用例对契约进行产生约束，所以服务提供方在满足测试用例的情况下可以自行更改接口或架构实现而不影响消费者。
2.是一种针对外部服务的接口进行的测试，它能够验证服务是否满足消费方期待的契约。它的本质是从利益相关者的目标和动机出发，最大限度地满足需求方的业务价值实现。

对于官方及大部分博文以消费者提出接口契约的方式，本图是以提供者编写契约及上传契约。个人认为这样更合理。

6.示例代码
1). 提供端相关代码
1.导入Contract测试相关包：

<dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-contract-verifier</artifactId><scope>test</scope></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-contract-stub-runner</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-contract-maven-plugin</artifactId><version>2.0.2.RELEASE</version><extensions>true</extensions></plugin></plugins></build>

2.编写测试类
在项目的test文件夹下新建resources文件夹，建立我们的契约文件：shouldReturnAllCustomers.groovy

shouldReturnAllCustomers.groovy相关内容如下：

package contractsimport org.springframework.http.HttpHeaders
import org.springframework.http.MediaTypeorg.springframework.cloud.contract.spec.Contract.make {description "return all customers"request {url "/api/customers"method GET()}response {status 200headers {header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_UTF8_VALUE)}body("hello world")}
}

我们看到有三个部分：description、request、response。通过request定义了请求时的url和method，然后通过response约定返回时的headers和body信息。
契约采用groovy的DSL描述，所以一目了然，就是通过项url：/api/customers，发送一个get请求，我们返回hello world。
3.发布契约
执行clean deploy生成我们的契约并上传到nexus库。

2).消费端编写测试类
1.消费端引入相关jar

<dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-contract-stub-runner</artifactId><scope>test</scope></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-contract-wiremock</artifactId><scope>test</scope></dependency>
</dependencies>

application-stub.yml配置如下：

stubrunner:stubs-mode: REMOTErepositoryRoot: http://sit.shk.com.cn:8080/nexus-2.9.1-02/content/repositories/snapshotsids:- com.uaf:nlp-contract-provider:+:stubs:8090

2.消费端编写测试类

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
@AutoConfigureMockMvc
@AutoConfigureJsonTesters
@AutoConfigureStubRunner
@ActiveProfiles("stub")
public class ConsumerContractTest {private MockMvc mockMvc;@Autowiredprivate WebApplicationContext webApplicationContext;@Autowiredprivate CustomerConsumerAction customerConsumerAction;@Beforepublic void setUp() {mockMvc = MockMvcBuilders.standaloneSetup(customerConsumerAction).build();}@Testpublic void testGetCustomers1() throws Exception {mockMvc.perform(MockMvcRequestBuilders.get("/cus")).andExpect(MockMvcResultMatchers.status().isOk()).andDo(MockMvcResultHandlers.print());}
}

执行测试类，通过观察console输出我们看下如下信息，说明我们契约测试成功。

欢迎关注公众号： 编码是个技术活

Spring Cloud Contract实践相关推荐

Spring Cloud Contract 契约测试实践
本文转载公众号:永辉云创技术该号由我参与维护,欢迎大家关注支持!!! 分布式研发模型演进众所周知, 分布式系统是由众多微服务构成,并按照功能模块划分后, 由不同的开发小组进行维护. 研发模型如下图 ...
spring cloud contract的应用实现与概念理解-服务请求者一侧的落地-细节较多避免踩坑卡壳
笔者的经验认为,微服务的出现,是为了应对传统SOA架构在多服务背景下的疲软,本质上是SOA的进一步衍生.是一种治理服务的手段.而微服务之所以能够解决传统SOA.单块大单体程序的问题,原因在于微服务自身 ...
spring cloud contract的应用实现与概念理解-服务提供者一侧的落地
如题,本文是在前一篇"spring cloud contract的应用实现与概念理解-服务请求者一侧的落地"的基础上,续写服务提供者一侧的有关实现与理解. 通过对官网文章的学习和编 ...
Marcin Grzejszczak访谈：Spring Cloud Contract
Marcin Grzejszczak是Pivotal的一名软件工程师.目前,他在从事Spring Cloud Contract的开发,这是一个消费者驱动的.面向Java的契约框架.为了了解该框架的一些 ...
消费者驱动的微服务契约测试套件：Spring Cloud Contract
在微服务架构下,你的服务可能由不同的团队提供和维护,在这种情况下,接口的开发和维护可能会带来一些问题,比如服务端调整架构或接口调整而对消费者不透明,导致接口调用失败. 为解决这些问题,Ian Robi ...
消费者驱动的微服务契约测试套件Spring Cloud Contract
在微服务架构下,你的服务可能由不同的团队提供和维护,在这种情况下,接口的开发和维护可能会带来一些问题,比如服务端调整架构或接口调整而对消费者不透明,导致接口调用失败. 为解决这些问题,Ian Robi ...
消费者驱动的契约测试 Spring Cloud Contract介绍
消费者驱动的契约测试 Spring Cloud Contract介绍什么是契约测试测试是软件流程中非常重要,不可或缺的一个环节.一般的测试分为单元测试,集成测试,端到端的手工测试,这也是构成测试金 ...
契约测试之Spring Cloud Contract
在微服务架构下,服务间会通过某种形式的消息传递或API调用进行耦合,这让服务的集成以及测试变成了非常具有挑战的一件事.早在微服务流行之前,就有人提出了消费者驱动契约(Consumer-driven c ...
Spring Cloud Contract 初识之一：简介
1.简介 Spring Cloud Contract 是一个包含解决方案的综合项目,帮助用户成功地向 Consumer Driven Contracts 进行处理.目前,Spring Cloud Co ...

Spring Cloud Contract实践

Spring Cloud Contract实践相关推荐

最新文章

热门文章