基于Pact的契约测试

集成测试痛点

在软件集成测试阶段,两个服务之间相互调用不通的情况时有发生,大多时候甚至是scheme定义不一致,更的时候是因为相互依赖的服务其中一方发生变化或更新,另一方不能及时感知造成,这时便需要一种方式可以同时约束服务双方的变化并让另一方快速知道以便能及时响应变化确保软件正常工作。契约应运而生。

契约由服务的消费方和提供方事先约定而成,并由指定的一方生成给另一方,另一方在开发接口时运行测试以验证开发出来的接口满足契约要求,Pact则是契约测试框架中的一种,下面以此为例介绍如何做契约测试。[选型-Pact与其它工具的对比](https://docs.pact.io/getting_started/comparisons)。

如何用Pact实现契约测试

image

在Pact中,契约由Consumer生成,由Provider去验证,一个基于consumer和provider的契约被称作一个pact,而每个pact是一系列的api交互集合

契约生成

契约由Consumer的单元测试生成

image

- 生成原则:

每个pact是一系列的api交互集合,所以pact的生成原则也就等同于一个api交互的原则

- 包含一个期望的request

- 一个期望的最小单元的response

- 大多数时候接口的调用是基于某一条件或状态的,所以也需要要定义一个provider states
 describe('Pact with Order API', () => {
  describe('given there are orders', () => {
    describe('when a call to the API is made', () => {
      before(() => {
        return provider.addInteraction({
          state: 'there are orders',
          uponReceiving: 'a request for orders',
          withRequest: {
            path: '/orders',
            method: 'GET',
          },
          willRespondWith: {
            body: eachLike({
              id: 1,
              items: eachLike({
                name: 'burger',
                quantity: 2,
                value: 100,
              }),
            }),
            status: 200,
            headers: {
              'Content-Type': 'application/json; charset=utf-8',
            },
          },
        })
      })

      it('will receive the list of current orders', () => {
        return expect(fetchOrders()).to.eventually.have.deep.members([
          new Order(orderProperties.id, [itemProperties]),
        ])
      })
    })
  })
})

- 契约文件存放

Consumer将生成好的契约文件存放在指定地方,以便Provider能取得到。Pact提供了Pact Brokers来解决此问题,后文会讲到

契约验证

契约由Provider的单元测试验证

image
在provider的单元测试中,首先读取当前pact所依赖的状态,比如数据库日期字段需要晚于2022-10-13等,通过mock单元测试调用provider接口,拿单元测试的返回值和pact所描述的定义值进行比对看是否满足契约。

Pact Broker - Pact的管理

在实际应用中,我们可能需要频繁对接口微调以满足新需求,这时候实现契约版本管理尤为重要。Pact broker不但可以用于契约版本的管理,其实也是作为consumer,pact和provider三者的一种关系映射,能够记录当前每一方的版本号,同时在provider方给出对应版本的契约在provider中的运行结果,具体可参考 [pact_broker](https://docs.pact.io/pact_broker)。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容