接口测试系列文章6——大厂接口测试都在用的技术Diff

Diff概念介绍

Diff是Unix系统的一个很重要的工具程序。它用来比较两个文本文件的差异,是代码版本管理的基石之一。

接口Diff测试

接口Diff测试,简单来说就是比对相同接口在不同版本不同环境下面的返回内容是否符合预期。对于日常迭代的接口来说,Diff测试是我们接口基本功能测试的有效补充!当测试的接口响应中包括100+的字段需要校验时,对字段逐一校验的传统方式效率差的问题就会突显出来了。这种场景我们可以把某一版本(v1)接口的响应作为基准,然后再对比新版本(v2)的响应,通过工具或者编写代码直接查看响应的异同,进而快速定位接口响应信息。通过工具比对接口在这里就不重点介绍了,有很多方法,包括:linux系统中的diff命令,windows可使用工具notepad++等等。在这里我重点介绍一下如何通过代码实现diff操作,我们以python为例。

Difflib

Difflib作为python的标准库,无需安装,作用是对比文本之间的差异,而且支持输出可读性比较强的HTML文档。

代码写起来也非常简单,实例如下:

import difflib

import sys

#读文件

def read_file(filename):

      try:

           with open(filename, 'r') as f:

           return f.readlines()

      except IOError:

           print("ERROR: 没有找到文件:%s或读取文件失败!"% filename)

           sys.exit(1)

def compare_file(file1, file2, out_file):

    file1_content = read_file(file1)

    file2_content = read_file(file2)

    d = difflib.HtmlDiff() #以html方式比较

    result = d.make_file(file1_content,file2_content) #生成html文本

with open(out_file, 'w') as f: #把html文本写入html文件

        f.writelines(result)

if __name__ == '__main__':

    compare_file(r'D:\logs\log1.log', r'D:\logs\log2.log',r'D:\logs\result.html')

打开html报告,我们可以清楚的看到两个文档中的差别,显示如下:

其中左边是文件log1.log,右边是log2.log

红色表示log1.log的内容被删除了

绿色表示log2.log新增的内容

黄色表示log1.log和log2.log中发生变化的内容

Difflib改进

上面的例子是从两个文件中读取数据,然后进行的比较,代码如下:

file1_content =read_file(file1)

file2_content = read_file(file2)

那么在真实测试时,我们需要的是接口响应的比对,怎么做呢?也很容易,我们只需要把read_file换成,发送接口请求(使用requests模块)并获取响应即可。

response1=requests.get(req)

response2=requests.get(req)

在这里仍然有一个问题,我们做接口测试时,是一个请求一个请求校验的,当多个请求批量校验时,我们是否有必要每做一个请求就生成一个比对错误的html报告呢?显然是不需要的,理想情况是,当两个请求响应出现错误的时候生成错误报告!那么接下来需要思考的是怎么样判断html报告中是否有错误出现呢?在这里我介绍一个比较简单的方法,在diff生成的html报告,我们通过报告中的颜色标识来判断(红色、绿色和红色)diff结果,如下图:

查看一下生成的html文件源码,发现文件底部带颜色的Add、Changed和Deleted 对应的脚本是

在html文件中搜索关键字class="diff_sub",发现:

201<span class="diff_sub">8,对应

可见,发现一处文字删除就会出现一个<span class="diff_sub">,因此我们可以通过如下代码实现

if result.count('<span class="diff_sub">') >0 or result.count('<span class="diff_chg">')>0 or result.count('<span class="diff_add">')>0:

    print ("find diff")

    with open(out_file, 'w', encoding='utf-8') as f:

           f.writelines(result)

else:

      print("not find diff, no html report generate!")

好了,这就是通过difflib进行接口比对操作的实现原理。原创不易,如果文章帮到了你,欢迎点赞转发,让更多的朋友受益!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355

推荐阅读更多精彩内容