本文会讲到在微服务中,测试如何在基于其意义的基础上如何配合微服务的特点被完成,不会涉及到类似测试技巧、测试性能等实现细节,但看完你会明白的是要写什么、为什么在微服务中这样写。

与单体应用测试不同的是,微服务架构中服务之间的通信非常频繁,不同服务之间的接口变更亦是如此,所以契约测试会占更重要的地位,也是本文的重点。

单元测试如何写

首先一定要明白单元测试测的是什么。

最小可测试单元进行检查和验证,也就是单个函数内功能逻辑是否正确

那么这句话意味着只测单元内部的东西,不会依赖实际的外部系统,所以需要Mock出外部系统,清楚了这点下面的东西就好理解了。

一个常见并且非常老的软件后台开发分层模式是数据持久层(DAO)、服务层(Service)、业务逻辑层(Controller),下面会具体分析我们应该如何写这三块的测试。对于DDD分层模型本文不予讲解,期待日后总结。

DAO

DAO层:分两种情况。

  • 不写。因为通常来说DAO层不应该包含复杂逻辑,逻辑在上两层已经留够空间去处理,应当仅是包含SQL语句的执行或者调用数据库对应的Template工具类,所以没有什么东西可以测。所以DAO层单元测试也不应该依赖外部系统,应该放到集成测试里写。这里有篇比较极端的文章支持此观点。
  • 写。与不写的观点持反对意见的例外是,有一些复杂的查询调用或者复杂的SQL语句,在自己不能确保绝对正确的情况下,写DAO层的测试也是有必要的。

Service

Service层:

  • 一定要写。服务层一般拥有比较复杂的业务逻辑,可能调用到的其他服务请Mock出来。

其他(如Controller、Utils、Domain)

  • 如果有比较复杂的逻辑则需要写。如果是测Controller中的业务逻辑会调用Service,那么请Mock Service。

集成测试如何写

集成测试是将多个功能模块组合在一起进行的测试。有两种层级的集成测试:

  • 服务之间的集成测试。好处是能发现单元测试无法发现的问题,比如连接数据库端口问题、层级之间调用问题;缺点是测试经过的代码太多,难以追踪BUG所在并且花费的时间比单元测试长很多。
  • 单个服务内部的集成测试。与单元测试相同之处在于关注的是某个层级内部的实现单元测试关注的层级是方法级别,集成测试关注的级别是应用级别,换句话说就是系统内部的各个层级之间是否能正常协同工作。

当集成测试遇上微服务

微服务架构将一个应用程序划分成多个有自己业务或功能职责的小服务,服务之间相互协作、互相配合调用为整个应用提供服务支持,服务之间通常采用REST API通信,然而在微服务中,集成测试的"特点"被放大了很多倍:

  • 测试成本高。验证多个服务协作的功能时,每个服务的搭建与配置,每次测试时都需要保证多个服务的测试数据与服务状态是正常的。
  • 结果不稳定,调试困难。跨服务调用的网络延迟可能导致的超时。测试花费的时间太长导致调试困难。

这些理由足够让你在微服务架构中少用集成测试而把注意力转向契约测试。

所以我们Team现在采用的集成测试是:单个服务依赖的其他服务Mock出来,比如对于依赖的外部服务则需要Mock出来,数据库则使用类似的H2内存数据库代替MySQL进行测试,所以我们要写的测试就的是发送请求到本地服务器及内存数据库,在内存数据库增删改查。

契约测试如何写

微服务中的契约测试

然而在关于微服务架构的测试中,契约测试有着至关重要的地位。契约测试的出现,将服务之间的集成测试模式一定程度上转换成服务内部的集成测试

在单体应用中,大部分功能层级之间的调用是函数方法的调用,属于在本地内存中通过Java虚拟机的实现方式的调用,如果与其他服务集成不多,那么契约测试将无用武之地。在微服务架构中,情况平衡了一些,一个服务会经常调用另外的一个服务获取或同步数据,业务一旦复杂起来,服务之间也会拥有较为复杂调用的关系,虽然BFF(Backend For Frontend)减缓了这个情况,但加强了BFF与服务之间的联系。

契约测试是什么

契约测试是验证Provider是否按照期望的方式与Consumer进行交互,简单的说是Consumer与Provider两两之间的集成,简单来说,测试的是双方是否通过相同的API格式进行交互

在一般的契约测试中,有三个模型需要被建立:

  • Provider:服务的提供者,接收Consumer的请求。
  • Consumer: 服务的消费者,是向Provider发起请求。
  • Contract: 合同、契约,Provider与Consumer的交互方式。

划重点!由于双方是根据生成的契约进行测试,从而可以达到独立测试的好处,不需要双方之间发生网络交互。

消费者驱动契约模式在2006年老马引用的这篇文章中提出,在这篇文章中解释的更接地气,是一种测试驱动开发的契约测试模式,携带着敏捷与TDD的好处,更重要的是将提供者开发API的局面扭转成消费者驱动开发,由于提供者开发时不清楚消费者具体需要什么,所以在集成的时候会非常难做。将文档化的API转换为契约测试依赖的数据。

如何开发

下图是CDC的开发模式,简单讲是消费者撰写契约和对应的契约测试让自己与提供者去分别跑契约测试,从而验证双方契约匹配。下面会根据具体开发流程讲到两个符合这种模式的工具来规范化我们的契约测试的开发,因为一些便捷的功能以及人们的约定总是不够优雅并且会被打破滴所以不得不借助工具。

Pact

Pact就是这样的测试工具,在技术雷达中提到过多次,作为CDC的实践,Pact名列前茅。Pact支持很多语言,如Pact-JVM, Pact Ruby, Pact .NET, Pact Go, Pact.js, Pact Swift。参见官网获取样例。本文主要以SCC为例讲解。

Spring Cloud Contract

简介

该项目于2015年开始创建核心代码,GitHub上Star虽然不多,但是功能比较强大,这里有一篇关于作者的访谈文章,对于理解这个项目比较有帮助。

官方开发流程

官方开发流程在这里。下面是简化版本。

Consumer端:

  1. 在Consumer中使用TDD开发,编写好契约测试/集成测试的代码
  2. 实现Consumer
  3. 在Provider的代码库中定义并生成Contract
  4. 把生成的契约文件交给Consumer当做WireMock服务器的契约规范来跑第一步中的测试验证Contract是否匹配

Provider端:

  1. SCC会根据Consumer写的契约自动生成测试代码作为契约测试/集成测试,此时跑Provider的契约测试肯定是挂的
  2. 实现Provider
  3. 在跑测试之前在数据库中提供契约中匹配的数据
  4. 运行SCC生成的测试

流程优化

官方开发流程中,作为Consumer端,契约测试是需要自己手写的,但如果某个服务属于前端的Provider又属于后端的Consumer时,SCC帮我们生成的Provider端的测试可以当做作为测Consumer的测试。所以在我们项目中开发流程是这样的:

  1. 前端开发与后端开发确定契约,并写到BFF代码库中
  2. 作为前端开发,使用此契约做为mock server的数据来源,开发调试前端
  3. 作为后端开发,先实现Service层级的代码和契约供BFF的契约测试使用,然后再实现BFF中的代码与契约。

例子

官方有两个实现的例子,在这里,忍不住吐槽一下,这个项目都两年了才100多个星星,跟着Spring和Cloud两大标签走竟然还能这么少的星星,是后端技术人员的保守跟前端那种几个月上万颗星星的浮夸相反吗?还有要注意的是除了官方文档几乎没有任何资料可以查询,给的例子用的又是很多处于BUILD版本的库,这是使用它最大的难点。

消费者驱动?

你可能会误认为SCC使用的是提供者驱动契约模式,因为契约是写在Provider中,但其实并不是,向SCC的作者Grzejszczak确认了这一点,因为CDC的思想是消费者有需求的时候然后根据这个需求去开发提供者的API,注意第一步当我在Consumer开发的时候已经意识到需要什么API了,然后进行我作为Consumer跑到Provider的代码库中去写一个契约。原话是

It’s the consumer that writes its expectations. The contracts are stored on the producer side cause from those contracts stubs are generated. That means that the source of truth in terms of contract validity is the provider side but what drives the change of the contract is the consumer

其他语言怎么办?

SCC没有提供其他语言的测试框架,那么如何完成作为消费者的前端的契约测试呢?向作者讨要之后作者给了一个例子,具体做法README中有。

优势:

  1. 根据契约可以自动生成提供者端的单个API的内部集成测试代码,即覆盖到了提供者端的内部集成测试部分,也覆盖到了提供者端的契约测试部分
  2. Groovy DSL来定义契约,天生适合开发契约的语言

劣势:

  1. 支持语言太少,资料太少
  2. 没有Pact的强制消费者驱动方式,如果我直接在SCC上开发提供者然后去写消费者是没问题的

E2E测试是什么

有请Cucumber、Capybara、QA登场

未完待续

以上是本人总结,难免偏颇,不过本人会根据本人持续变化的理解持续更新。

参考资料:


1
2
3
4
5
6
V1.0:2017.07.07 发表
V1.1:2017.07.08 更新DAO层理解与SCC作者解释
V1.2:2017.07.10 更新集成测试的理解
V1.3:2017.07.14 更新SCC优势
V1.4:2017.08.16 补充所有测试说明
V1.5:2017.09.13 修改优势中表述不清之处,多谢楚欣妹子

Comments