大厂接口测试都在用的技术——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进行接口比对操作的实现原理。原创不易，如果文章帮到了你，欢迎点赞转发，让更多的朋友受益！