扩展pytest接口自动化框架-MS数据解析功能
开篇
MeterSphere的数据源通过html页面上传后，需要将请求方式进行拆分。
get接口的参数，常以params的方式进行传参，也就是在url后带上参数。
post接口一般是以json字符串的形式传参，也有params方式进行传参的。而在MeterSphere里面，post可以使用它所自带的jsonSchema的界面功能来定义参数，也就是key-value的方式。也可以手写json。这里我们以jsonSchema的方式进行解析。
基于这两种类型的接口（put、delete接口也遵循get接口）来做分支。get接口走get接口参数的生成方法。post同理。
沿着这个思路，就开始着手准备自动化脚本逆向用例生成的第一个函数。
思路梳理
首先确定我们所想要的用例模板以及我们要解析的数据结构。我将两个数据结构的示例都列在了下面。
明确了目标，最先要做的，就是获取数据流
获取到数据流后，判断接口请求的类型
根据请求类型，将数据流分成不同的分支，然后发给所对应的生成参数的方法。
最后将这些参数拼接成我们想要的用例模板
下例为MeterSphere的json格式示例
{
"projectName": "",
"protocol": "HTTP",
"projectId": ",
"version": "v1.20.6-lts-1e3d1547",
"data": [
{
"id": "",
"projectId": "",
"name": "测试",
"method": "POST",
"modulePath": "/path1/path2/...",
"environmentId": null,
"schedule": null,
"status": "Underway",
"moduleId": "",
"userId": "admin",
"createTime": 1655860767171,
"updateTime": 1655860767171,
"protocol": "HTTP",
"path": "/api/v1/pub/stop",
"num": 100666,
"tags": null,
"originalState": null,
"createUser": "Administrator",
"caseTotal": "0",
"caseStatus": "-",
"casePassingRate": "-",
"deleteTime": null,
"deleteUserId": null,
"order": 3155000,
"refId": "08f6bde7-c906-459d-8a9b-95632bbeb5ee",
"versionId": "989beb9c-ebc8-45d3-8a80-967b06f2d192",
"latest": true,
"description": null,
"request": "{name:ss,canshu:111}",
"response": "respone",
"remark": null
}
],
"cases": [],
"mocks": [],
}下例为最后解析成的用例样式
- api_name: callback_rooms
case_name: $ddt{case_name}
content_type: application/json
parameterize:
- - case_name
- 字段1
- 字段2
- 字段3
- - 常规用例
- oU
- 70
- 79
request:
base_url: url...
headers: null
json:
root:
字段1: $ddt{字段1}
字段2: $ddt{字段2}
字段3: $ddt{字段3}
method: POST
url: /xxx/xxx
validata:
- contains: 200得到MeterSphere数据并做解析
# 得到MeterSphere数据并做解析
def get_ms_data(filename):
"""
get_data: 数据源
apis: 接口清单
get_params: get请求参数
api_name: 接口名称
method: 请求方式
get_apis: get接口
:return:拼接好的数据集
"""
# 所有接口的字典数据集合
apis = {}
# 获取ms文件流
with open(filename, "r", encoding="utf-8") as f:
request_params = json.load(f)
# 解析参数.判断接口是什么请求
for i in request_params["data"]:
get_data = i
path = get_data["path"]
api_name = str(path).split("/")
if len(api_name) > 1:
api_name = api_name[-2] + "_" + api_name[-1]
else:
api_name = api_name[-1]
method = get_data["method"]
get_apis = {
path: {
"api_name": api_name,
"method": method,
"content_type": "application/json"
}
}
if method.lower() in ["get", "put", "delete"]:
# 如果是get请求.调用解析get参数
try:
# 调用生成params参数
get_params = get_arguments(json.loads(get_data["request"])["arguments"])
get_apis[path].update(get_params)
apis.update(get_apis)
except Exception as e:
print_log(Exception(e))
else:
try:
# 兼容post接口中的请求参数是parasm类型
if "arguments" in get_data["request"] and "jsonSchema" not in json.loads(get_data["request"])["body"]:
# 调用生成params参数
get_params = get_arguments(json.loads(get_data["request"])["arguments"])
get_apis[path].update(get_params)
get_apis[path]["content_type"] = "application/text"
apis.update(get_apis)
else:
# 兼容post是jsonSchema对象的参数类型
if "jsonSchema" in json.loads(get_data["request"])["body"]:
try:
global NODE
NODE = True
post_params = deal_with_data(
data=json.loads(get_data["request"])["body"]["jsonSchema"],
required_list=json.loads(get_data["request"])["body"]["jsonSchema"][
"required"])
get_apis[path].update(post_params)
apis.update(get_apis)
except KeyError:
post_params = deal_with_data(
data=json.loads(get_data["request"])["body"]["jsonSchema"])
get_apis[path].update(post_params)
apis.update(get_apis)
else:
print("测试")
# 后续迭代
...
except Exception as e:
print_log(Exception(e))
raise Exception(e)
return apis这个函数我把它构想成一个经理，接到需求后，根据每个人的职责不同，分给所对应的人。然后接收这些手下的工作反馈，把这些反馈组装成报告。
在编写过程中，只是一股脑的想把这件事做完。忽略了定义函数时需要遵循的单一职责原则（SRP原则，在python工匠中提到，每个函数应该遵循单一职责。这样方便后期维护）。上面这个函数，即做了类型判断的工作，也做了数据拼接、分配给指定函数的工作。这样如果要修改某一个职责的话。这个函数就需要做好整体维护的准备。基于此大家在编写函数的时候，也尽可能保证函数的单一职责。
最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：
