基于Cypress的一个API小工具

这个工具你照着操作一遍,应该就能够使用Cypres进行最基本的API测试了;再根据实际情况丰富一下,应该就成为你自己的工具了。

这个工具来源的背景是:

  • 项目上的一个产品购买流程,购买过程中依赖另一个团队登录模块的功能。但是呢,这个团队往往会在你不知情的情况下,把登录模式改了(这里就不纠结是不是因为业务需求而产生的改动了),时不时变成双认证模式(给你的邮箱或者手机发一个6位数字的code)。测试嘛,你知道的,输入的一些邮箱啊,手机号啊,很多时候都是假的,怎么可能查到相应的认证code。
  • 然后呢,slack里各种@对方的人,反复聊“这里又出现双认证了 -> 改动是业务需求的吗 -> 是代码改坏导致的吗 -> 是测试需要,临时改了配置吗 -> 麻烦帮助改好(或者改回去吧)-> 下回有变动能给我们只知会一声不 -> 谢谢啊(不太情愿地)”。
  • 我们的BA经常来找我:“我用我账号,一直出来这个双认证,你能试试你的看有没有吗?”。其实,他只是为了新feature,想去下游flow截张图,但是经常逃不过双认证这一劫……然后就又要返回上述聊天模式聊一遍……

(故事情节写多了,主要怕以后我也忘了为什么要写这个工具……)

不想看上边罗里吧嗦的描述的同学,可以直接移步下边的内容!

我把整个购买流程过程中涉及到的API,调用API的时机,以及他们之间的关系捋了一遍,基本的流程是:

用户是否注册校验 (是否有guid返回) ->
登录(guid有value返回的时候)或注册(guid返回null的时候)->
创建联系人信息(这里需要用到guid,会生成一个CONTACT_ID)->
创建使用人信息(这里需要用到CONTACT_ID,生成CLIENT_ID)->
创建支付信息(这里需要用到CONTACT_IDCLIENT_ID,生成PAYMENTPROFILE_ID)->
创建订单(这里需要用到guidCLIENT_ID,生成PRODUCT_IDORDER_ID

这个过程中所有生成的信息,我都给它保存到一个文本里,因为可以通过任意一个在数据库里查到相关信息。

下边进入正题,结构是什么?一些关键的地方是如何处理的?

结构
  • fixtures文件夹
    无论是request url里需要的params,还是request里要用到的body,都放这里了,格式均为Json。

    fixtures里的json文件名

    Json里的内容,要用啥,就写啥。
    json文件里的内容示例

  • integration文件夹
    测试用例。

    测试用例文件

解读一下用例里边稍微特殊一点的地方(按红色标号顺序)。


测试用例文件里的内容
  1. 这里想自动生成一些自定义部分的value,用了faker来实现;同时,在名字里加上了当前时间,用来表明是什么时间创建的,用了JavaScript日期处理库类(moment.js)来达到目的。
  2. 这里填写的是在fixtures文件夹里定义的.json文件名称。
  3. 这里将/signup的一个返回值定义为变量guid,后续会用到。
  4. 这里使用了之前拿到的guid,使用方法为this.guid
  5. 这里将/contacts的返回值id定义为变量contact_id,后续会用到。
  6. /accounts里使用了之前拿到的contact_id,使用方法为直接调用contact_id
    为什么都是调用响应数据,4this.guid,而6直接用contact_id呢?
    -- 4是使用.as() 别名保存响应数据,可以在共享测试上下文中使用,使用方法为this.xxx
    -- 6是使用关联接口的返回响应数据,直接调用就行。
  • common文件夹
    util.js里写了个保存数据的方法,用来存放用例执行过程中生成的重要信息(主要是想通过这些信息,在相应的系统或者数据库里查找对应数据)。
    执行之后会生成一个名叫message.txt的文件。

    util.js

  • scripts文件夹
    包含一个执行测试的文件。
    整个场景区分老用户新用户,integration文件夹里的测试用例用existingUsernonExistingUser来区分,执行的时候通过传入userType定位到对应的integration文件夹里的测试文件。

    测试用例文件

    run.js

  • cypress.json
    没有太特殊的配置。

    cypress.json

  • package.json
    主要是一些执行命令的定义。

    package.json

  • 执行命令
    npm run new-user-purchase
    npm run existing-user-purchase
    (这里多说一句,如果你想用npm run purchase,你需要在run.js里加个逻辑判断,即process.env.userType为空时,spec的value是什么,否则会报错。)

  • message.txt
    这里边的数据,可以支持在相应的系统或者数据库里查询任何想查的信息。

    message.txt

最后

其实这个工具不难,就是依据API之间的逻辑关系,给它凑到一块儿,同时还发现,直接通过API走这套流程尽然不需要二次认证。(即使需要的话,我想我们可以通过创建一个专门用于自动化的二次认证code,条条大路通罗马,总能想到解决的办法~)

后来想想,这个工具可以有多个用途:

  1. 解决BA的后顾之忧。
  2. 抛开测试其本身功能的话,可以帮助快速创建测试数据,用于测试基于它的其他功能,比通过页面完成整个过程要来的快。
  3. 加一些校验在里边的话,还可以作为接口自动化测试,用作smoke test或者regression test均可。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容