分享做接口测试时,搭建的测试框架思路
-
使用环境
- windows 10
- python3.7 + excel + unittest + requests + logging + database + htmlreport
目前实现功能点:
- 核心通用测试框
- token关联
- 上个接口结果的值赋予下个接口的请求参数等
- 日志模块
- 数据库模块
- 环境配置模块
- 操作excel模块
- 测试报告模块
目录
考虑因素:
接口数量:接口数量多,若放在脚本中维护不方便,所以使用excel来维护接口用例
一、excel元素设计
1、主用例元素
API接口常用的一些元素
元素 | 说明 | 例子 |
---|---|---|
id | 用例id(自定义) | case_0001 |
title | 用例标题 | 验证正常登录 |
run | 是否运行标识,yes: 运行 no:不运行 | yes |
url | 主用例接口 | /Hardware/api/Test/ |
method | 请求方法(get/post/put等) | post |
headers | 请求头 | {“Content-Type”: “application/json”} |
request_data | 请求参数 | {“key”: “data”} |
result | 记录请求结果 | {“ResponseStatus”:{“ErrorCode”:“0”}} |
expect | 预期结果 | {“ErrorCode”:“0”} |
2、依赖用例元素
主用例需要依赖的接口,可以做到上个接口的结果值赋予主用例接口的请求参数
元素 | 说明 | 例子 |
---|---|---|
depend_url | 主用例需要依赖的接口参数 | {“url”:"/depend_url", “method”:“Post”,“content”:“接口描述”} |
depend_request_data | 依赖接口的请求参数 | {“key”: “depend_data”} |
depend_result | 记录依赖接口的请求结果 | {“ResponseStatus”:{“ErrorCode”:“0”}} |
get_depend_result_for_main_case | 获取依赖请求结果的某个参数赋予主用例的请求参数 | {“depend_key”:“main_key”} |
3、sql元素
实际项目中,有几种情况需要用到查询获取值
1.API接口中,传入的参数是数据库中的某个字段值
2.请求结果的值=数据库中的某个字段值(断言用)
元素 | 说明 | 例子 |
---|---|---|
sql | 查询数据库,并获取值赋予对应参数 | [{“sql”:“select key from table”, “key”:“request_key”}] |
预览
二、操作excel
上面讲了接口用例的元素设计,接下来用脚本处理
data_config:excel元素索引配置
# coding:utf-8
# 根据索引,分别对应excel中的元素,若元素有改动,在这里维护即可
class Global_Val(object):
Id = 0
title = 1
run = 2
url = 3
request_method = 4
header = 5
depend_url = 6
depend_data = 7
depend_result = 8
depend_key = 9
data = 10
sql = 11
expect = 12
result = 13
is_success = 14
def get_id():
"""获取case_id"""
return Global_Val.Id
def get_title():
"""获取用例标题"""
return Global_Val.title
def get_url():
"""获取请求url"""
return Global_Val.url
def get_run():
"""获取是否运行"""
return Global_Val.run
def get_request_method():
"""获取请求方式"""
return Global_Val.request_method
def get_header():
"""获取header"""
return Global_Val.header
def get_depend_case():
"""case依赖"""
return Global_Val.depend_url
def get_depend_data():
"""依赖请求数据"""
return Global_Val.depend_data
def get_depend_result():
"""依赖请求结果"""
return Global_Val.depend_result
def get_depend_result_key():
"""依赖请求结果参数"""
return Global_Val.depend_key
def get_request_data():
"""请求数据"""
return Global_Val.data
def get_sql():
"""sql数据"""
return Global_Val.sql
def get_expect():
"""预期结果"""
return Global_Val.expect
def get_result():
"""实际结果"""
return Global_Val.result
def get_is_success():
"""成功/失败结果"""
return Global_Val.is_success
get_data:获取excel数据
operation_excel:封装操作excel
import json
from data import data_config
from common.operation_excel import OperationExcel
class GetData(object):
"""获取excel数据"""
def __init__(self, file_path, sheet_name):
self.opera_excel = OperationExcel(file_path, sheet_name)
def get_case_lines(self):
"""获取excel行数,即case的个数"""
return self.opera_excel.get_max_rows()
def get_is_run(self, row):
"""获取是否执行"""
col = int(data_config.get_run())
run_model = self.opera_excel.get_cell_value(row, col)
if run_model == 'yes':
flag = True
else:
flag = False
return flag
def is_header(self, row):
"""
获取header
:param row: 行号
:return:
"""
col = int(data_config.get_header())
header = self.opera_excel.get_cell_value(row, col)
if header != '':
return json.loads(header)
else:
return None
def get_request_method(self, row):
"""
获取请求方式
:param row: 行号
:return:
"""
# col 列
col = int(data_config.get_request_method())
request_method = self.opera_excel.get_cell_value(row, col)
return request_method
def get_request_url(self, row):
"""
获取url
:param row: 行号
:return:
"""
col = int(data_config.get_url())
url = self.opera_excel.get_cell_value(row, col)
return url
def get_request_data(self, row):
"""
获取请求数据
:param row:行号
:return:
"""
col = int(data_config.get_request_data())
data = self.opera_excel.get_cell_value(row, col)
if data == '':
return None
# return json.loads(data)
return eval(data)
def get_expect_data(self, row):
"""
获取预期结果
:param row:
:return:
"""
col = int(data_config.get_expect())
expect = self.opera_excel.get_cell_value(row, col)
if expect == "":
return None
else:
return eval(expect)
def write_result(self, row, value):
"""
写入结果数据
:param value: 结果
:param row: 行号
:return:
"""
col = int(data_config.get_result())
self.opera_excel.write_value(row, col, value)
def write_result_depend(self, row, value):
"""
写入依赖结果数据
:param value: 结果
:param row: 行号
:return:
"""
col = int(data_config.get_depend_result())
self.opera_excel.write_value(row, col, value)
def write_is_success(self, row, value):
"""
写入结果数据
:param value: 结果
:param row: 行号
:param col: 列号
:return:
"""
col = int(data_config.get_is_success())
self.opera_excel.write_value(row, col, value)
def get_depend_data(self, row):
"""
获取依赖数据的key
:param row:行号
:return:
"""
col = int(data_config.get_depend_data())
depend_data = self.opera_excel.get_cell_value(row, col)
if depend_data == "":
return None
else:
return json.loads(depend_data)
def get_depend_key(self, row):
"""
获取依赖请求结果的某个参数值
:param row: 行号
:return:
"""
col = int(data_config.get_depend_result_key())
depend_key = self.opera_excel.get_cell_value(row, col)
if depend_key == "":
return None
else:
return eval(depend_key)
def is_depend(self, row):
"""
判断是否有case依赖
:param row:行号
:return:
"""
col = int(data_config.get_depend_case()) # 获取是否存在数据依赖列
depend_url = self.opera_excel.get_cell_value(row, col)
if depend_url == "":
return None
else:
return depend_url
def get_title(self, row):
"""
获取用例标题
:param row: 行号
:return:
"""
col = int(data_config.get_title())
title = self.opera_excel.get_cell_value(row, col)
if title == "":
return None
else:
return title
def get_sql(self, row):
"""
获取sql
:param row: 行号
:return:
"""
col = int(data_config.get_sql())
sql = self.opera_excel.get_cell_value(row, col)
if sql == "":
return None
else:
# return json.loads(sql)
return eval(sql)
三、封装HTTP请求
runmethod:使用requests库,封装HTTP请求方法
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import requests
import urllib3
class RunMethod:
def __init__(self):
self.session = requests.session()
urllib3.disable_warnings()
def run_main(self, method, url, data=None, header=None, params=None):
"""
归类请求方法
:param method: 请求方法
:param url: 接口
:param data: 请求参数
:param header: 请求头
:return: response(请求结果)
"""
if method.lower() == 'Post'.lower(): # 向指定资源提交数据进行处理请求(例如提交表单或者上传文件)。数据被包含在请求体中。POST 请求可能会导致新的资源的建立和/或已有资源的修改。
res = self.session.post(url=url, json=data, headers=header, verify=False)
elif method.lower() == 'Get'.lower(): # 请求指定的页面信息,并返回实体主体。
res = self.session.get(url=url, json=data, headers=header, params=params, verify=False)
elif method.lower() == 'HEAD'.lower(): # 类似于 GET 请求,只不过返回的响应中没有具体的内容,用于获取报头
res = self.session.head(url=url, json=data, headers=header, verify=False)
elif method.lower() == 'PUT'.lower(): # 从客户端向服务器传送的数据取代指定的文档的内容。
res = self.session.put(url=url, json=data, headers=header, verify=False)
elif method