测试平台系列(56) JSON深层次对比方案

2021年09月16日 阅读数:1
这篇文章主要向大家介绍测试平台系列(56) JSON深层次对比方案,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

你们好,我是米洛,求三连!求关注测试开发坑货!html

回顾

上一节咱们引入了AceEditor帮助咱们在线执行/调试SQL语句,这一届咱们讲点儿断言相关的内容。python

数据比对

接口测试中,咱们经常须要对接口的返回参数进行校验。若是采用数据驱动的方式,涉及到多组入参/出参的比对的状况下,怎么对预期json和实际json进行一个全方位的对比呢?算法

今天,他来了。json

其实这个话题很早之前源自于虫师selenium群大师兄精哥的指点,而我和饭佬,属于偷师成功的典范。数组

不过我在这个基础上也加了一点本身的东西,最终效果是同样的。数据结构

核心点

这个算法的核心点就在于递归,一层一层去递归,最终达到拿到全部差别的过程。app

具体一点

具体一点,假设咱们如今有2个json对象,分别是:测试

# 预期结果
a = """
{
	"name": "lixiaoyao",
	"age": 19,
	"wife": ["linyueru", "zhaolinger"],
	"job": {
		"yuhang": "混混",
		"suzhou": "林家堡姑爷",
		"suoyaota": "仙剑派弟子"
	}
}
"""

# 实际结果
b = """
{
	"name": "lixiaoyao",
	"age": 23,
	"wife": ["anu", "zhaolinger"],
	"job": {
		"yuhang": "混混",
		"suzhou": "林家堡姑爷",
		"suoyaota": "仙剑派子弟"
	}
}
"""

不仔细看还挺难发现这里面的差别,由于json内容不算不多,因此肉眼比较难看出来。优化

那么咱们何不利用代码,去帮咱们智能对比呢?spa

步步为营

确认参数

首先咱们须要知道咱们要比对什么,其实就是2个string,但他们是JSON格式的。

因此咱们能够肯定好2个基本参数: def compare(a: str, b: str)

  • a 预期结果

  • b 实际结果

    可是咱们须要深层次比对,因此咱们须要额外传入一些数据:

  • ans

    用来存放比对的信息,好比 123 != 124

  • path

    这个用来存放当前的路径,好比上述例子的job->suoyaota这个地方的值就不同,一个是仙剑派弟子,另外一个是仙剑派子弟,因此咱们不但要记录值,还要记录他的路径。

思考

在Python中,数据结构较为简单,咱们看看JSON序列化JSONDecoder类
就能大概知道了:

能够看到,基本上json的数据类型可以对应的,咱们能够再简化一下:

能继续深刻对比不能继续深刻对比这2种。

什么意思呢?

好比a和b的name都是lixiaoyao,lixiaoyao是个字符串,当它不为json字符串的时候,是一个不能继续深刻对比的数据。

因此此时咱们的递归到这一层就应该终止,直接比对a和b的name字段,若是不同,根据path,把diff结果添加到ans中。

那什么又是可深刻比较对象呢?我认为有3种:

  1. List

Python的数组里面能够继续遍历,里面还有可能继续有json数据,因此可继续对比。

  1. Dict

这个不用多说了,你们都知道这个是最容易疯狂嵌套的。

  1. JSON字符串

注意他实际上是字符串的一种,只不过他能被反序列化为可继续遍历的对象。

编写转换为Python对象的方法

def _to_json(string):
    try:
        float(string)
        return string
    except:
        try:
            if isinstance(string, str):
                return json.loads(string)
            return string
        except:
            return string

首先咱们拿到的数据是咱们指望它是一个字符串,咱们最早判断它是否是数值类型,若是是,直接返回这个字符串。

为何呢?由于这个字符串若是是数值类型,那么他已经肯定不可继续遍历了,咱们把它原路返回。

但由于他也可能不是字符串而是Python对象好比dict或者其余数据,因此咱们接着判断他是否是字符串,若是能被反序列化又不是数值的话,那说明他就是JSON字符串,若是统统不是,那咱们把数据原路返回。

这一步只是为了筛选出字符串内容为JSON的数据,若是不是则直接返回以前的数据。

编写_compare核心方法

def _compare(self, a, b, ans, path):
    a = self._to_json(a)
    b = self._to_json(b)
    if type(a) != type(b):
        ans.append(f"{self._weight(path)} 类型不一致, 分别为{type(a)} {type(b)}")
        return
    if isinstance(a, dict):
        keys = []
        for key in a.keys():
            pt = path + "/" + key
            if key in b.keys():
                self._compare(a[key], b[key], ans, pt)
                keys.append(key)
            else:
                ans.append(f"{self._weight(pt)} 在后者中不存在")
        for key in b.keys():
            if key not in keys:
                pt = path + "/" + key
                ans.append(f"{self._weight(pt)} 在后者中多出")
    elif isinstance(a, list):
        i = j = 0
        while i < len(a):
            pt = path + "/" + str(i)
            if j >= len(b):
                ans.append(f"{self._weight(pt)} 在后者中不存在")
                i += 1
                j += 1
                continue
            self._compare(a[i], b[j], ans, pt)
            i += 1
            j += 1
        while j < len(b):
            pt = path + "/" + str(j)
            ans.append(f"{self._weight(pt)} 在前者中不存在")
            j += 1
    else:
        if a != b:
            ans.append(
                f"{self._weight(path)} 数据不一致: {JsonService._color(a)} "
                f"!= {self._color(b, 1)}" if path != "" else
                f"数据不一致: {self._color(a)} != {JsonService._color(b, 1)}")

先用_to_json转为Python对象,得到ab。接着判断他们的类型是否一致,若是不一致则不必继续比较了,好比一个是list,另外一个是dict,根本没有比较的意义,直接ans.append错误信息便可,记得带上path参数。

self._weight是为了在html日志中更好地展现效果,加了一些style样式,能够先忽略。

若是类型也一致了,咱们继续来看a是什么类型。

  • 若是是字典

    咱们的比较是以a(预期结果)为单位的,因此一切以a为标准。

    那么咱们遍历a和b的keys,分别找出a字典里面有,b字典没有的key,和b字典里面有,而a字典里面没有的key。

    注意,这里代码能够简化,字典的keys是支持集合操做的,交由你们思考优化。

    中间去遍历了a和b都有key,而后继续调用了self._compare方法,并把path改成了path+"/"+key,这样的话路径就为字典的深一层的路径了,继续递归调用。

  • 若是是list

    与dict其实相似,定义了2个指针,依次走完2个数组,当a数组已经走完了,b里面还有值,就把b里面剩下的值(属于多出的信息)都添加到错误信息之中。

    其中也获取了新的path,只不过数组是用的索引,而dict用的是key做为路径。

    接着递归。。。

  • 若是不是这2种

    注意这里是递归结束的条件,那咱们直接比较。数据不一致,则把不一致的数据写到ans数组中。


大致思路就是这样,给你们看看color和weight。

测验刚才的结果

为了方便显示diff,我取消了文字高亮

能够看到age不同,老婆不同,锁妖塔的职业也不同。因此,你学费了吗?

提升点

优化字典之间的key

最终源码+测试代码

import json


class JsonCompare:

    def compare(self, exp, act):
        ans = []
        self._compare(exp, act, ans, '')
        return ans

    def _compare(self, a, b, ans, path):
        a = self._to_json(a)
        b = self._to_json(b)
        if type(a) != type(b):
            ans.append(f"{path} 类型不一致, 分别为{type(a)} {type(b)}")
            return
        if isinstance(a, dict):
            keys = []
            for key in a.keys():
                pt = path + "/" + key
                if key in b.keys():
                    self._compare(a[key], b[key], ans, pt)
                    keys.append(key)
                else:
                    ans.append(f"{pt} 在后者中不存在")
            for key in b.keys():
                if key not in keys:
                    pt = path + "/" + key
                    ans.append(f"{pt} 在后者中多出")
        elif isinstance(a, list):
            i = j = 0
            while i < len(a):
                pt = path + "/" + str(i)
                if j >= len(b):
                    ans.append(f"{pt} 在后者中不存在")
                    i += 1
                    j += 1
                    continue
                self._compare(a[i], b[j], ans, pt)
                i += 1
                j += 1
            while j < len(b):
                pt = path + "/" + str(j)
                ans.append(f"{pt} 在前者中不存在")
                j += 1
        else:
            if a != b:
                ans.append(
                    f"{path} 数据不一致: {a} "
                    f"!= {b}" if path != "" else
                    f"数据不一致: {a} != {b}")

    def _color(self, text, _type=0):
        if _type == 0:
            # 说明是绿色
            return """<span style="color: #13CE66">{}</span>""".format(text)
        return """<span style="color: #FF4949">{}</span>""".format(text)

    def _weight(self, text):
        return """<span style="font-weight: 700">{}</span>""".format(text)

    def _to_json(self, string):
        try:
            float(string)
            return string
        except:
            try:
                if isinstance(string, str):
                    return json.loads(string)
                return string
            except:
                return string


if __name__ == "__main__":
    # 预期结果
    a = """
    {
    	"name": "lixiaoyao",
    	"age": 19,
    	"wife": ["linyueru", "zhaolinger"],
    	"job": {
    		"yuhang": "混混",
    		"suzhou": "林家堡姑爷",
    		"suoyaota": "仙剑派弟子"
    	}
    }
    """

    # 实际结果
    b = """
    {
    	"name": "lixiaoyao",
    	"age": 23,
    	"wife": ["anu", "zhaolinger"],
    	"job": {
    		"yuhang": "混混",
    		"suzhou": "林家堡姑爷",
    		"suoyaota": "仙剑派子弟"
    	}
    }
    """
    obj = JsonCompare()
    ans = obj.compare(a, b)
    print(ans)