python+requests+pytest 接口自动化的实现

主要思路:
①对 requests 进行二次封装,做到定制化效果
②使用 excel 存放接口请求数据,作为数据驱动
③里面有一些功能模仿了 jmeter,比如用户参数定义、jsonpath 提取
④用 pytest 进行测试用例管理

一、环境

python==3.8.0
requests==2.31.0
pytest==7.4
还有一些其他第三方库例如 allure 报告、jsonpath 等
这块不过多介绍,安装 python 配置环境变量,pip install 命令安装所需插件即可

二、项目目录结构

图片

1、config:用来存放项目配置文件,包括接口基础配置,数据库信息等,使用的是 configparser 进行读取

图片

2、Outputs 层存放了日志和测试报告,这里报告用的是 allure

图片

图片

3、resources 存放的是测试数据 (这里用的 excel 作为接口数据驱动) 以及其他的一些测试文件等

4、Testcases 存放测试类

5、utils:工具类,包含了读取配置、记录日志、http 请求、接口数据处理等功能

三、重点功能介绍

1、读取 excel

实现代码如下:

  1. from openpyxl import load_workbookclass DoExcel:

  2. def __init__(self, file_name):

  3. # 打开文件 self.filepath = os.path.join(resources,'case_datas', f'{file_name}.xlsx')

  4. # 获取工作表 self.wb = load_workbook(self.filepath)

  5. # 获取当前sheet self.ws = self.wb.active

  6. def get_data_from_excel(self):

  7. '''从excel获取测试数据'''

  8. datas = []

  9. for row in range(1, self.ws.max_row + 1):

  10. row_data = {}

  11. if row > 1:

  12. # 将行数据转为字典数据格式 for column in range(1, self.ws.max_column + 1):

  13. row_data[f"{self.ws.cell(1, column).value}"] = self.ws.cell(row, column).value

  14. # 将json_path转字典 if row_data["json_path"]:

  15. row_data["json_path"] = {k: v for item in row_data["json_path"].split("&") for k, v in[item.split("=")]}

  16. datas.append(row_data)

  17. self.wb.close()

  18. return datas

  19. def close(self):

  20. # 关闭文件流 self.wb.close()

数据文档格式:

图片

(这里目前只支持单 sheet 页读取,后续将扩展成 sheet 名称传参获取方式)

2、requests 请求部分

  1. import requestsclass HttpRequest:

  2. def __init__(self):

  3. self.session = requests.sessions.session()

  4. self.global_headers = {"X-Request-Sign": "xxxxxxxxx"}

  5. def set_headers(self, path, content_type, headers):

  6. # 判断接口是登录时,将Authorization请求头删除 if path in ["oauth/oauth/userlogin", "/oauth/oauth/login"] and "Authorization" in self.global_headers.keys():

  7. self.global_headers.pop("Authorization")

  8. # 判断content_type为json时,添加请求头content_type if content_type == "json":

  9. self.global_headers["Content-Type"] = "application/json;charset=UTF-8"

  10. # 判断content_type不为json时,删除请求头content_type elif content_type != "json" and "Content-Type" in self.global_headers.keys():

  11. self.global_headers.pop("Content-Type")

  12. # 将接口信息中的请求头更新到global_headers中 if headers:

  13. self.global_headers.update(headers)

  14. def set_token(self, path, res_code, res_json):

  15. # 请求接口为登录并且返回成功时,将token附加到headers里 if path == "/oauth/oauth/login" and res_code == 200:

  16. token = json_path(res_json, "$.data.access_token")

  17. self.global_headers["Authorization"] = f"Bearer {token}"

  18. def clear_headers(self, headers):

  19. # 清除无用的请求头 if headers:

  20. for i in headers.keys():

  21. if i in self.global_headers.keys():

  22. self.global_headers.pop(i)

  23. def http_request(self, datas, file=None):

  24. log_info.log_info('--------------------')

  25. log_info.log_info('↓↓↓↓↓接口请求开始↓↓↓↓↓')

  26. # 拼接url base从配置文件获取+参数传递接口路径 urls = config.get_strValue('api', 'base_url') + datas["path"]

  27. self.set_headers(path=datas["path"], content_type=datas["content_type"], headers=datas["headers"])

  28. log_info.log_info(f'接口名称:{datas["desc"]}')

  29. log_info.log_info(f"请求地址:{urls}")

  30. log_info.log_info(f"请求头:{self.global_headers}")

  31. log_info.log_info(f'请求参数:{datas["params"]}')

  32. print((f"请求地址:{urls}"))

  33. res = None

  34. # 请求封装,这里用的session会话保持,https请求需要将verify设置为False try:

  35. if datas["method"].lower() == 'get':

  36. res = self.session.request(datas["method"], urls, params=datas["params"], headers=self.global_headers,

  37. verify=False)

  38. elif datas["method"].lower() == 'post':

  39. if datas["content_type"] in ["form", "upload"]:

  40. res = self.session.request(datas["method"], urls, data=datas["params"], headers=self.global_headers,

  41. files=file,verify=False)

  42. elif datas["content_type"] == "json":

  43. res = self.session.request(datas["method"], urls, json=datas["params"], headers=self.global_headers,

  44. verify=False)

  45. log_info.log_info(f"响应信息:{res.text}")

  46. except Exception as e:

  47. log_info.log_info(e)

  48. raise e

  49. self.set_token(path=datas["path"], res_code=res.status_code, res_json=res.json())

  50. self.clear_headers(headers=datas["headers"])

  51. log_info.log_info('↑↑↑↑↑接口请求结束↑↑↑↑↑')

  52. log_info.log_info('--------------------')

  53. return res

  54. def close(self):

  55. self.session.close()

在这里我根据项目情况,进行了请求头的特殊处理;
①实例化对象的时候添加了全局请求头
②根据不同类型的请求和传参格式对 content-type 做了相应处理
③token 的处理
④最后请求后把当前无用请求头部分做了清理

3、接口数据处理

  1. class DataHandle:

  2. def datas_init(self,datas,params_list):

  3. self.datas = datas

  4. self.params_list = params_list

  5. def headers_handle(self):

  6. # 将请求头进行参数化 if self.datas["headers"]:

  7. self.datas["headers"] = re_replace(self.datas["headers"], self.params_list)

  8. # 请求头转字典格式 if self.datas["headers"]:

  9. self.datas["headers"] = {k: v for item in self.datas["headers"].split("&") for k, v in [item.split("=", 1)]}

  10. return self.datas["headers"]

  11. def params_handle(self):

  12. # 将请求参数进行参数化 if self.datas["params"]:

  13. self.datas["params"] = re_replace(self.datas["params"], self.params_list)

  14. # 这里把请求参数格式化,转成不同方法需要的参数格式 # 将form表单格式的参数转化成字典 if self.datas["content_type"] in ["form","upload"] and self.datas["params"]:

  15. self.datas["params"] = {k: v for item in self.datas["params"].split("&") for k, v in [item.split("=")]}

  16. # 将json字符串解包为字典 elif self.datas["content_type"] == "json":

  17. self.datas["params"] = eval(self.datas["params"])

  18. return self.datas["params"]

  19. def user_var_handle(self,res):

  20. # 获取响应信息中下文接口用到的参数 if self.datas["json_path"]:

  21. for i in self.datas["json_path"].keys():

  22. self.params_list[i] = json_path(res.json(), self.datas["json_path"][i])

  23. return self.params_list

  24. def assert_handle(self,res):

  25. # 将预期结果处理 if self.datas["except"]:

  26. # 参数化替换 self.datas["except"] = re_replace(self.datas["except"], self.params_list)

  27. # 转成字符串列表 self.datas["except"] = self.datas["except"].split("&")

  28. # 断言 for i in self.datas["except"]:

  29. print(f"断言:{i}")

  30. assert i in res.text

  31. def send_request(self,datas,file=None):

  32. res = http_request.http_request(datas,file)

  33. return res

这里主要做了几点处理:
①将请求头部分做了参数化替换并进行了数据格式转换,转为字典格式
②请求 body 进行参数化,并根据请求方式和 content-type 做了相应处理
③用户参数处理,用 jsonpath 获取响应信息字段值存放到测试类属性中
④预期结果断言处理(这里统一用的自带的 assert 方法,还没进行二次封装)
⑤将更新后的 data 发送请求

4、测试类,测试方法

  1. class TestDemo(DataHandle):

  2. params_list = {'custName': unique_string(), "custCertiNo": random_string(),

  3. "custLegalPersonCertiNo": random_string(18), "custBankAccount": random_string(18),

  4. "managerStamp":{"file": ("testpicture.png", open(upload_file + "\\" + "testpicture.png", "rb"), "image/png")}

  5. }

  6. @ pytest.mark.usefixtures("login_guanliren")

  7. @ pytest.mark.parametrize("datas", DoExcel("demo").get_data_from_excel())

  8. def test_case(self, datas):

  9. # 数据初始化 self.datas_init(datas, self.params_list)

  10. # 请求头处理 datas["headers"] = self.headers_handle()

  11. # 请求参数处理 datas["params"] = self.params_handle()

  12. # 获取文件名 filename = datas["filename"]

  13. # 发送接口请求 res = self.send_request(datas=datas,file=self.params_list[filename] if datas["content_type"] == "upload" else None)

  14. # 参数列表处理 self.params_list = self.user_var_handle(res)

  15. # 预期结果及断言 self.assert_handle(res)

这里测试类继承了上面的 DataHandle 类,测试方法中可以调用父类方法进行测试数据的处理
params_list 是用字典存放的参数化的数据,我这里是通过正则替换把请求参数里面的需要被替换的部分找到 params_list 里的 key,将 value 进行替换

5、runner 执行测试用例

  1. import pytestfrom project.utils.base_dir import *if __name__ == '__main__':

  2. pytest.main(['-vs', f'{test_class}', f'--alluredir={allure_dir} ', '--clean-alluredir'])

  3. os.system(f"allure generate {allure_dir} -o {allure_html} --clean")

调用 pytest 的 main 方法进行命令行参数执行,添加了 allure 生成测试报告

图片

6、测试报告展示

图片

图片

7、未完成功能

①excel 读取:现在只支持当前 sheet 页读取,后续扩展成传 sheet 名称指定获取
②数据库断言:excel 添加一列存放 sql 语句,发送接口请求后查询数据库,将这部分加进断言里
③http_requests 目前只有 get 和 post 方法,后续将其他方法也封装进去
④断言方式:目前没有对断言封装,用的自带的 assert 函数,后面可以进行二次封装或用第三方库实现

最后希望可以给一些想要入手自动化的同学们一些参考吧,也希望各路大神留言提提意见。

行动吧,在路上总比一直观望的要好,未来的你肯定会感 谢现在拼搏的自己!如果想学习提升找不到资料,没人答疑解惑时,请及时加入扣群: 320231853,里面有各种软件测试+开发资料和技术可以一起交流学习哦。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!

  • 8
    点赞
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值