在接口自动化测试中，如何利用Pytest + JSON Schema 进行接口响应断言

最新推荐文章于 2024-08-24 07:34:33 发布
最新推荐文章于 2024-08-24 07:34:33 发布
阅读量3.4k 收藏 19
点赞数 1
分类专栏： pytest单元测试框架 文章标签： pytest jsonschema 接口断言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liuchunming033/article/details/106185604
版权

蔚来汽车数字座舱，通过服务端TSP系统集成了很多供应商的系统，比如天气、音乐、视频等娱乐系统。数字座舱调用TSP封装的供应商接口实现对天气的查询，音乐和视频的播放。TSP与供应商之间要共同遵守一个契约，保证提供给数字座舱的数据结构的稳定。

TSP对供应商系统的Response透传给数字座舱，因此在进行TSP系统接口测试的过程中，一个重要的检查点，就是保证提供给数字座舱的数据结构的稳定性，例如返回字段要完整、字段数据类型要符合约定，避免因供应商的改动，返回不符合约定的Response给数字座舱导致数字座舱异常。从而保证当供应商接口的响应发生了变更，通过接口测试能够第一时间发现，哪怕供应商没有及时通知到TSP。

因为数字座舱、TSP以及供应商之间，都是采取JSON作为数据交换的格式，因此，TSP接口测试中，保证Response字段的完整性、数据类型的合法性，就是检查JSON格式的完整性和合法性。

JSON Schema 是描述JSON数据结构的一种格式，通过JSON Schema可以描述JSON的字段以及字段数据类型等信息。因此，校验JSON Schema就可以校验Response是否符合约定。这种测试也常被叫做契约测试。

本文将介绍，如何通过JSON Schema对TSP接口的Response进行契约测试。

01 — 什么是JSON Schema

JSON Schema是一种用来描述JSON数据的一种JSON数据结构，它本身也是一个JSON格式。JSON Schema也有版本，最新版的版本是 Draft 7，此前还有Draft 6，Draft 4 和Draft 3。

一个JSON格式的数据，通常是由以下一种或多种数据类型组成的：

  1. string
  2. Numeric（integer、number）
  3. object
  4. array
  5. boolean
  6. null

JSON Schema中对上面的6种数据类型，都有相应的属性对其进行描述。下面是一个JSON数据，它是由object类型的data，Numeric类型的cur_num，string类型的keyword，boolean类型的vip，array类型的list组成，list中的数据是object类型：

{
    "data": {
        "cur_num": 10,
        "keyword": "朴树",
        "vip": true,
        "list": [
            {
                "album_id": 2032482,
                "publish": "2018-11-13T20:20:39+00:00"
            },
            {
                "album_id": 7986,
                "publish": "2018-11-13T20:20:39+00:00"
            }
        ]
    }
}

下面的JSON Schema可以描述上面JSON格式数据：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "cur_num": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10,
          "exclusiveMaximum": false
        },
        "keyword": {
          "type": "string",
          "minLength": 1,
          "maxLength": 10
        },
        "vip": {
          "type": "boolean"
        },
        "list": {
          "type": "array",
          "minItems": 1,
          "maxItems": 10,
          "items": {
            "type": "object",
            "properties": {
              "album_id": {
                "type": "integer"
              },
              "publish": {
                "type": "string",
                "format":"date-time"
              }
            },
            "required": [
              "album_id",
              "publish"
            ]
          }
        }
      },
      "required": [
        "cur_num",
        "keyword",
        "vip",
        "list"
      ]
    }
  },
  "required": [
    "data"
  ]
}

JSON Schema还是很容易看懂的，现在我们简单来介绍一下：

  1. "$schema"表示这个JSON Schema是使用的draft-04版本的规范；
  2. data的type是object类型；
  3. data包含的properties有cur_num、keyword、vip和list，这四个属性都是required，也就是必须包含的；
  4. cur_num的type是个integer（整型），它的取值范围最小值是1（“minimum”: 1,），最大值是10（“maximum”: 10,），包含10（“exclusiveMaximum”: false）；
  5. keyword的类型是string（字符串），最小长度是1（“minLength”: 1），最大长度是10（“maxLength”: 10）；
  6. vip的类型是布尔型；
  7. list的类型是数组array，至少包含1个元素（“minItems”: 1），最多包含10个元素（“maxItems”: 10）每一个元素都是object类型，包含album_id和publish两个必须属性
  8. publish是个string类型，格式是个日期时间格式（“format”:“date-time”）。

比如对于string类型的数据，JSON Schema可以通过format对常见的字符串进行描述，比如描述时间和日期的"date-time"，描述电子邮件的"email"，描述主机的"hostname"，描述IP地址的"ipv4"和"ipv6"，描述URI的"uri"。如果不属于常见的字符串格式，还可以通过pattern正则表达式来描述，比如"pattern": "^(\([0-9]{3}\))?[0-9]{3}-[0-9]{4}$“可以用来描述”(888)555-1212"这样的字符串。

通过上面的讲解，我想大家应该可以用JSON Schema来描述一个JSON字符串了吧。更全面的JSON Schema的语法可以参考http://json-schema.org/understanding-json-schema/。

上面的JSON Schema能否描述前面的JSON字符串呢？可以通过在线的一个Validator进行验证一下，我们将上面的JSON Schema和JSON复制粘贴到这个网站https://www.jsonschemavalidator.net/上，如果网页下方出现No errors found. JSON validates against the schema，则表示JSON字符串符合JSON Schema的描述。

02 — 自动化测试中如何断言

在自动化测试中，如何通过代码方式对JSON格式的Response进行JSON Schema断言呢？因为我平时都是用Python进行自动化测试的，今天就来介绍一下python语言中JSON Schema断言的方式。

需要安装一个jsonschema软件包：

pip install jsonschema

假设respose_data是通过某一个接口的response，我们对其进行JSON Schema校验，使用的JSON Schema是schema，自动化测试代码可以写成如下所示：

# content of test_json_schema.py
from jsonschema import validators
​
​
def test_json_schema_validator():
    schema = {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "type": "object",
        "properties": {
            "data": {
                "type": "object",
                "properties": {
                    "cur_num": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 10,
                        "exclusiveMaximum": False
                    },
                    "keyword": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 1
                    },
                    "vip": {
                        "type": "boolean"
                    },
                    "list": {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 10,
                        "items": {
                            "type": "object",
                            "properties": {
                                "album_id": {
                                    "type": "integer"
                                },
                                "publish": {
                                    "type": "string",
                                    "format": "date-time"
                                }
                            },
                            "required": [
                                "album_id",
                                "publish"
                            ]
                        }
                    }
                },
                "required": [
                    "cur_num",
                    "keyword",
                    "vip",
                    "list"
                ]
            }
        },
        "required": [
            "data"
        ]
    }
    respose_data = {
        "data": {
            "cur_num": 10,
            "keyword": "朴树",
            "vip": True,
            "list": [
                {
                    "album_id": 2032482,
                    "publish": "2018-11-13T20:20:39+00:00"
                },
                {
                    "album_id": 7986,
                    "publish": "2018-11-13T20:20:39+00:00"
                }
            ]
        }
    }
    va = validators.Draft4Validator(schema)
    va.validate(respose_data)

注意，在Python语言中boolen值是False和True，首字母大写。

执行上面的代码将看到如下输出：

tests/test_json_schema.py::test_json_schema_validator PASSED             [100%]

如果我们将respose_data修改一下，来模拟接口的response发生了变化，比如"cur_num": 10,改成"cur_num": 20，再次执行上面的代码，则会看到测试不通过，并输出如下信息：

tests/test_json_schema.py:78: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
​
self = <jsonschema.validators.create.<locals>.Validator object at 0x106307710>
args = ({'data': {'cur_num': 20, 'keyword': '朴树', 'list': [{'album_id': 2032482, 'publish': '2018-11-13T20:20:39+00:00'}, {'album_id': 7986, 'publish': '2018-11-13T20:20:39+00:00'}], 'vip': True}},)
kwargs = {}, error = <ValidationError: '20 is greater than the maximum of 10'>
​
    def validate(self, *args, **kwargs):
        for error in self.iter_errors(*args, **kwargs):
>           raise error
E           jsonschema.exceptions.ValidationError: 20 is greater than the maximum of 10
E           
E           Failed validating 'maximum' in schema['properties']['data']['properties']['cur_num']:
E               {'exclusiveMaximum': False,
E                'maximum': 10,
E                'minimum': 1,
E                'type': 'integer'}
E           
E           On instance['data']['cur_num']:
E               20

从输出的错误信息可以看出，instance[‘data’][‘cur_num’]的数值是20，不满JSON Schema中对其描述的最大值不能超过10的规范。因此断言失败。

03 — 总结

文本先介绍了JSON Schema如何描述JSON格式的数据，接着对Python语言中，如何使用jsonschema对接口的Response进行JSON Schema断言。在日常测试工作中，如果被测服务是对上游或者第三方供应商的Response进行透传，那么在测试这个被测服务时，一般就是对Response进行JSON Schema断言，来保证Response的数据结构稳定和合乎契约。

参考资料

https://juejin.im/entry/5c66975de51d4574b5550f1f
https://www.jianshu.com/p/1711f2f24dcf
https://www.jianshu.com/p/8d4ae03d92fb
https://json-schema.org/understanding-json-schema/index.html#
https://www.liquid-technologies.com/online-json-to-schema-converter
https://www.jsonschemavalidator.net/

liuchunming033
关注
专栏目录
技术分享 | 接口自动化测试如何搞定 json 响应断言？
ceshiren456的博客
08-03 202
在之前的的章节已经简单介绍了如何断言接口的响应值，在实际工作过程中，json 的响应内容往往十分复杂，面对复杂的 json 响应体，主要通过 JSONPath 解决。JSONPath 提供了强大的 JSON 解析功能，使用它自带的类似 XPath 的语法，可以更便捷灵活的用来获取对应的 JSON 内容。...
1、pytest使用JMESPath断言json返回值
u010093504的博客
03-03 877
1、pytest使用JMESPath断言json返回值运行环境快速开始其他的获取值的情况 运行环境 pytest框架 测试用例保存在excel excel的一行表示需要执行一条测试用例 附上JMESPath表达式官方教程，感兴趣的可以选择食用：https://jmespath.org/tutorial.html 快速开始 使用JMESPath获取返回值中想要的值： 返回值为 { "org_name": "哈哈哈", "channel_code": ["千淘-QT001", "美团-YL001
如何使用 `pytest-json-report` 开源项目
最新发布
gitblog_01197的博客
08-24 243
如何使用 pytest-json-report 开源项目 pytest-json-report????️ A pytest plugin to report test results as JSON项目地址:https://gitcode.com/gh_mirrors/py/pytest-json-report 一、项目目录结构及介绍 pytest-json-report ├── LICENSE.md...
python接口测试非json的断言_荐在接口自动化测试中，如何利用Pytest + JSONPath 进行接口响应断言...
weixin_39973271的博客
12-09 179
之前有一篇文章，介绍了如何使用JSONSchema对接口响应进行断言，主要的适用场景是对响应的数据结构进行校验，保证客户端收到的数据结构稳定和合法。今天，介绍使用JSONPath对接口响应的值进行断言方法。上一篇文章《在接口自动化测试中，如何利用Pytest + JSON Schema 进行接口响应断言》中，介绍了JSON Schema校验接口响应的数据结构的方法。在实际的测试工作中，很多时候是需...
在接口自动化测试中，如何利用Pytest + JSONPath 进行接口响应断言
刘春明的博客
05-22 6143
之前有一篇文章，介绍了如何使用JSONSchema对接口响应进行断言，主要的适用场景是对响应的数据结构进行校验，保证客户端收到的数据结构稳定和合法。今天，介绍使用JSONPath对接口响应的值进行断言方法。 上一篇文章《在接口自动化测试中，如何利用Pytest + JSON Schema 进行接口响应断言》中，介绍了JSON Schema校验接口响应的数据结构的方法。在实际的测试工作中，很多时候是需要对接口的响应数值进行校验的。这时候就不能利用JSON Schema进行校验了，需要借助JSONPath表.
python之利用Pytest + JSONPath 进行接口响应断言
shuyaoyao的博客
08-30 1052
https://blog.csdn.net/liuchunming033/article/details/106272542
python接口自动化-断言神器Jsonschema实战演示
梦马韶华
03-28 504
python接口自动化测试之Jsonschema实战演示
基于 HTTP 请求的快速数据驱动 pytest 接口自动化测试框架
07-10
多元化断言，json 断言，sql 断言，json-schema 断言，正则断言，原生 python assert 断言。兼容 yaml / json 两种文件格式编写测试数据。测试用例自动生成，可以根据测试数据文件自动生成测试用例。自动测试报告，...
利用 Pytest 和 Schema 断言测试 JSON 数据格式
weixin_68789096的博客
10-17 310
笔者测试过程中，接到这样一个测试任务，接口进行重构之后，需要测试同学来验证数据的结构和类型，以防因某个字段被删除或者类型被更改，造成隐藏问题出现的概率增加。那该如何验证数据结构和类型呢？带着这个问题，我们一起探索。前言中提到的问题，就需要使用来解决。那到底什么是,又该如何使用呢？JSON Schema 是一种用于验证和描述 JSON 数据结构的语言。它提供了一种标准化的规范方法，可以定义 JSON 数据的结构、数据类型以及相关约束条件。genson虽然可以帮助我们快速生成Scheam。
python：接口自动化项目测试框架
热门推荐
一名小测试
11-17 1万+
最近文章一直都是python的第三方库使用及爬虫的知识，针对自动化测试的优化版本也没有及时发布出来，今天主要抽时间整理了一下，罗列了运行流程及项目工程目录。 所提供的框架仅供参考，中间还有很多不足之处，也希望大家踊跃提出疑义和建议。 下面进入代码的世界…… 工程目录 apiTest ├─apiInterface ├─cases ├─common ├─config ├─dynamicData ├─logs ├─reports │├─allure │└─html ├─runMain ├─tes...
接口测试响应断言
gchh_spring的博客
05-31 1283
当请求一个接口，返回数据后，返回的数据由xml格式、json格式，那么怎么根据返回的结构化数据进行断言，判断返回信息是否正确，接口响应是否正确？ json断言：
python接口测试断言返回值json格式和数据类型
qq_44846758的博客
03-17 3596
def isJson(jsonstr): try: json.loads(jsonstr.text) return True except Exception as e: return False def checktype(responsejson): """ 传入json并返回json数据类型 :para...
Python自动化测试用例：如何优雅的完成Json格式数据断言
GDYY3721的博客
08-08 933
优化 后来在写用例生成过程中，发现重复的断言描述信息较多，大多数数据返回其实都是标准的json，所以将整个返回的json放到断言数据中：
全网最牛自动化测试框架系列之pytest(5)-断言
m0_60054525的博客
08-28 1087
断言是完整的测试用例中不可或缺的因素，用例只有加入断言，将实际结果与预期结果进行比对，才能判断它的通过与否。unittest 框架提供了其特有的断言方式，如：assertEqual、assertTrue、assertIn等，pytest 同样有自己的断言方式，即使用assert进行断言。pytest 还能对执行过程中产生的 Exception 及 Warnning 进行断言，但这些情况在我们的测试中很少会用到，所以不做过多阐述。...
接口自动化测试如何搞定 json 响应断言？
软件自动化测试技术交流、资源分享
09-05 93
在之前的的章节已经简单介绍了如何断言接口的响应值，在实际工作过程中，json 的响应内容往往十分复杂，面对复杂的 json 响应体，主要通过 JSONPath 解决。JSONPath 提供了强大的 JSON 解析功能，使用它自带的类似 XPath 的语法，可以更便捷灵活的用来获取对应的 JSON 内容。
python接口自动化-json数据处理
aozhao4974的博客
03-28 245
前言 有些post的请求参数是json格式的，需要导入json模块进行处理，json是一种数据交换格式，独立于编程语言 一般常见的接口返回数据也是json格式的，我们在做判断的时候，往往只需要提取其中几个关键的参数就行，这时候就需要json来解析返回的数据了 一、json模块简介 1. json简介：json，全名 JavaScript Object Notation，是一...
JSON Schema
qq_42105144的博客
05-13 431
目录 1 JSON 数据类型 2JSON Schema 3 python jsonschema 1 JSON 数据类型 对应的Python内置的数据类型 JSON类型 Python类型 object dict array list string str number int、float boolean（true/false） bool（True/False） null None 2JSON Schema JSON...
http responce 断言验证 JSONschema #python 以及资料
weixin_43186648的博客
02-16 3579
JSONschema 一般在使用 比较复杂的数据交互时,使用. 如 游戏中, 小怪攻击力.等等. 与 xml, yaml ,csv 等并列为全平台通用数据格式; Python 中 ijson 可以加载大量 JSON 格式数据. json 为一般情况下的数据.
如何利用pytest+python进行接口自动化测试
06-09
利用pytest+python进行接口自动化测试的步骤如下： 1. 安装pytest和requests库：在命令行中使用pip命令安装pytest和requests库，例如： ```bash pip install pytest pip install requests ``` 2. 编写测试用例：使用Python编写测试用例文件，例如test_api.py，包括测试用例函数和测试数据，例如： ```python import requests import json def test_get_user(): url = 'http://api.example.com/user' response = requests.get(url) assert response.status_code == 200 assert response.json()['name'] == 'John' def test_create_user(): url = 'http://api.example.com/user' headers = {'Content-Type': 'application/json'} data = {'name': 'Jane', 'age': 30} response = requests.post(url, headers=headers, data=json.dumps(data)) assert response.status_code == 201 ``` 3. 运行测试用例：在命令行中使用pytest命令运行测试用例，例如： ```bash pytest test_api.py ``` 4. 生成测试报告：pytest会自动为测试结果生成测试报告，包括测试用例数量、通过数量、失败数量、错误数量、跳过数量等信息。 5. 分析测试结果：根据测试报告分析测试结果，确定是否存在缺陷。 6. 缺陷跟踪和修复：对发现的缺陷进行跟踪和修复。 7. 重复执行测试：使用pytest定期执行测试，确保接口的稳定性和可靠性。 需要注意的是，pytest支持多种测试用例的组织方式，例如使用类和方法进行测试用例管理，使用fixture进行测试数据的准备和清理等。在编写测试用例时，需要考虑接口的各种情况，例如正常情况、异常情况、边界情况等。同时需要使用断言对测试结果进行验证，确保接口的正确性和健壮性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值