接口返回值校验

最新推荐文章于 2024-01-11 01:39:40 发布

chenchen_nini

最新推荐文章于 2024-01-11 01:39:40 发布

阅读量3.4k

点赞数

分类专栏： python小知识文章标签： python

本文链接：https://blog.csdn.net/chenchen_nini/article/details/117685596

版权

python小知识专栏收录该内容

13 篇文章 0 订阅

订阅专栏

4、key不存在匹配key_missable

5、多类型匹配extra_types

四、自动生成 json 契约

一、背景

接口返回的字段需要对返回结构校验、每个字段值类型、每个字段值校验

返回结果如果是json嵌套的情况且数组包含这样结果有伸缩性的，校验代码会很长，考虑返回的异常场景也多

例如：

data里面的结构体校验，似乎for循环也能解决，但是是不是需要”造轮子“，我想讲的是一个已经有的轮子--pip install pactverify

官网：https://pypi.org/project/pactverify/

{
    "msg": "success",
    "code": 0,
    "data": [{
            "type_id": 249,
            "name": "王者荣耀",
            "order_index": 1,
            "status": 1,
            "subtitle": " ",
            "game_name": "王者荣耀"
        }, {
            "type_id": 250,
            "name": "绝地求生",
            "order_index": 2,
            "status": 1,
            "subtitle": " ",
            "game_name": "绝地求生"
        }, {
            "type_id": 251,
            "name": "刺激战场",
            "order_index": 3,
            "status": 1,
            "subtitle": " ",
            "game_name": "刺激战场"
        }
    ]
}

二、基础匹配规则

1、值校验

（1）完全匹配校验-Matcher

学习点：from pactverify.matchers import Matcher, PactVerify, PactJsonVerify

Matcher声明的结构体需要完全匹配

python类契约---PactVerify类初始化

json类契约---PactJsonVerify类初始化

verify匹配后verify_result是匹配结果，verify_info是具体的错误信息

hard_mode=True, 默认为true,hard_mode = True时,实际返回key必须严格等于预期key;hard_mode = False时,实际返回key包含预期key即可

separator='$' 可自定义指定json关键字标识符，默认为$

注意：一旦匹配失败后，verify正确结构体也会是失败（应该是verify_info信息写入后重新verify没有重置造成的）

##############################################################################
# 校验值=11
# 1、python类契约格式
expect_format_1 = Matcher(11)
# 2、json契约格式
expect_format_json_1 = {
    "$Matcher": 11
}

# 校验值=1.0
# 1、python类契约格式
expect_format_2 = Matcher(1.0)
# 2、json契约格式
expect_format_json_2 = {
    '$Matcher': 1.0
}

# 校验值='1'
# 1、python类契约格式
expect_format_3 = Matcher('11')
# 2、json契约格式
expect_format_json_3 = {
    '$Matcher': '11'
}

################################################################################
# 校验值={'k1': 'v1'}
# 1、python类契约格式
expect_format_4 = Matcher({'k1': 'v1'})
# 2、json契约格式
expect_format_json_4 = {
    '$Matcher': {'k1': 'v1'}
}

# 使用实例---pactVerify初始化之后只能使用一次
>>> from pactverify.matchers import Matcher, PactVerify, PactJsonVerify
>>> p1_1 = PactVerify(expect_format_1,hard_mode=True)
>>> p1_1.verify(11)
>>> p1_1.verify_result
True
>>> p1_1.verify(12)
>>> p1_1.verify_result # 这里12是不匹配的，返回False
False
>>> p1_1.verify(11)
>>> p1_1.verify_result #接着使用p1_1，就不能正确匹配了，下面那样初始化下
False
>>> p1_1 = PactVerify(expect_format_1,hard_mode=True)
>>> p1_1.verify(11)
>>> p1_1.verify_result
True

>>> p1_2 = PactJsonVerify(expect_format_json_1,hard_mode=True, separator='$')
>>> p1_2.verify(11)
>>> p1_2.verify_result
True

# separate自定义
>>> expect_format_json_2 = {
...     '&Matcher': 1.0
... }
>>> pp= PactJsonVerify(expect_format_json_2,separator='&')
>>> pp.verify(1.0)
>>> pp.verify_result
True

#  hard_mode=False,实际多出来的k2没有校验
>>> p4_1 = PactVerify(expect_format_4,hard_mode=False)
>>> p4_1.verify({"k1":"v1","k2":"v2"})
>>> p4_1.verify_result

True

>>> p4_1 = PactVerify(expect_format_4,hard_mode=True)
>>> p4_1.verify({"k1":"v1"})
>>> p4_1.verify_result
True
>>> p4_1.verify({"k1":"v2"})
>>> p4_1.verify_result
False
>>> p4_1.verify_info
{'value_not_match_error': [{'actual_key': 'root.k1', 'actual_value': 'v2', 'expect_value': 'v1'}]}