在阿里云备案网站通过,深圳网站建设营销策划,自己搞个网站需要多少钱,wordpress vip 插件下载本项目实现接口自动化的技术选型#xff1a;PythonRequestsPytestYAMLAllure #xff0c;主要是针对之前开发的一个接口项目来进行学习#xff0c;通过 PythonRequests 来发送和处理HTTP协议的请求接口#xff0c;使用 Pytest 作为测试执行器#xff0c;使用 YAML 来管理测…
本项目实现接口自动化的技术选型PythonRequestsPytestYAMLAllure 主要是针对之前开发的一个接口项目来进行学习通过 PythonRequests 来发送和处理HTTP协议的请求接口使用 Pytest 作为测试执行器使用 YAML 来管理测试数据使用 Allure 来生成测试报告
一、项目说明
本项目在实现过程中把整个项目拆分成请求方法封装、HTTP接口封装、关键字封装、测试用例等模块。
首先利用Python把HTTP接口封装成Python接口接着把这些Python接口组装成一个个的关键字再把关键字组装成测试用例而测试数据则通过YAML文件进行统一管理然后再通过Pytest测试执行器来运行这些脚本并结合Allure输出测试报告
当然如果感兴趣的话还可以再对接口自动化进行Jenkins持续集成
GitHub项目源码地址 https://github.com/wintests/pytestDemo
二、项目结构
api 接口封装层如封装HTTP接口为Python接口
common 各种工具类 core requests请求方法封装、关键字返回结果类 config 配置文件 data 测试数据文件管理 operation 关键字封装层如把多个Python接口封装为关键字 pytest.ini pytest配置文件 requirements.txt 相关依赖包文件 testcases 测试用例
三、请求方法封装
在 core/rest_client.py 文件中对 Requests 库下一些常见的请求方法进行了简单封装以便调用起来更加方便。 class RestClient():def __init__(self, api_root_url):self.api_root_url api_root_urlself.session requests.session()def get(self, url, **kwargs):return self.request(url, GET, **kwargs)def post(self, url, dataNone, jsonNone, **kwargs):return self.request(url, POST, data, json, **kwargs)def put(self, url, dataNone, **kwargs):return self.request(url, PUT, data, **kwargs)def delete(self, url, **kwargs):return self.request(url, DELETE, **kwargs)def patch(self, url, dataNone, **kwargs):return self.request(url, PATCH, data, **kwargs)def request(self, url, method, dataNone, jsonNone, **kwargs):url self.api_root_url urlheaders dict(**kwargs).get(headers)params dict(**kwargs).get(params)files dict(**kwargs).get(params)cookies dict(**kwargs).get(params)self.request_log(url, method, data, json, params, headers, files, cookies)if method GET:return self.session.get(url, **kwargs)if method POST:return requests.post(url, data, json, **kwargs)if method PUT:if json:# PUT 和 PATCH 中没有提供直接使用json参数的方法因此需要用data来传入data complexjson.dumps(json)return self.session.put(url, data, **kwargs)if method DELETE:return self.session.delete(url, **kwargs)if method PATCH:if json:data complexjson.dumps(json)return self.session.patch(url, data, **kwargs)
四、HTTP接口 封装为 Python接口
在 api/user.py 文件中将上面封装好的HTTP接口再次封装为不同的Python接口。不同的Python接口会处理不同URL下的请求。
class User(RestClient):def __init__(self, api_root_url, **kwargs):super(User, self).__init__(api_root_url, **kwargs)def list_all_users(self, **kwargs):return self.get(/users, **kwargs)def list_one_user(self, username, **kwargs):return self.get(/users/{}.format(username), **kwargs)def register(self, **kwargs):return self.post(/register, **kwargs)def login(self, **kwargs):return self.post(/login, **kwargs)def update(self, user_id, **kwargs):return self.put(/update/user/{}.format(user_id), **kwargs)def delete(self, name, **kwargs):return self.post(/delete/user/{}.format(name), **kwargs)
五、关键字返回结果类
在 core/result_base.py 下定义了一个空类 ResultBase 该类主要用于自定义关键字返回结果。
class ResultBase():pass
自定义示例
result ResultBase()
result.success False
result.msg res.json()[msg]
result.response res在多流程的业务场景测试下通过自定义期望保存的返回数据值以便更好的进行断言。
六、关键字封装
关键字应该是具有一定业务意义的在封装关键字的时候可以通过调用多个Python接口来完成。在某些情况下比如测试一个充值接口的时候在充值后可能需要调用查询接口得到最新账户余额来判断查询结果与预期结果是否一致那么可以这样来进行测试
1, 首先可以把 充值-查询 的操作封装为一个关键字在这个关键字中依次调用充值和查询的接口并可以自定义关键字的返回结果。 2, 接着在编写测试用例的时候直接调用关键字来进行测试这时就可以拿到关键字返回的结果那么断言的时候就可以直接对关键字返回结果进行断言。
七、测试用例层
根据用例名分配测试数据
测试数据位于 data 文件夹下在这里使用 YAML 来管理测试数据同时要求测试数据中第一层的名称需要与测试用例的方法名保持一致如 test_get_all_user_info 、test_delete_user。
test_get_all_user_info:# 期望结果,期望返回码,期望返回信息# except_result, except_code, except_msg- [True, 0, 查询成功]
省略
test_delete_user:# 删除的用户名,期望结果,期望返回码,期望返回信息# username, except_result, except_code, except_msg- [测试test, True, 0, 删除用户信息成功]- [wintest3, False, 3006, 该用户不允许删除]
这里借助 fixture 方法我们就能够通过 request.function.__name__ 自动获取到当前执行用例的函数名 testcase_name 当我们传入测试数据 api_data 之后接着便可以使用 api_data.get(testcase_name) 来获取到对应用例的测试数据。
import pytest
from testcases.conftest import api_datapytest.fixture(scopefunction)
def testcase_data(request):testcase_name request.function.__name__return api_data.get(testcase_name)
数据准备和清理
在接口自动化中为了保证用例可稳定、重复地执行我们还需要有测试前置操作和后置操作即数据准备和数据清理工作。
pytest.fixture(scopefunction)
def delete_register_user():注册用户前先删除数据用例执行之后再次删除以清理数据del_sql base_data[init_sql][delete_register_user]db.execute_db(del_sql)logger.info(注册用户操作清理用户--准备注册新用户)logger.info(执行前置SQL{}.format(del_sql))yield # 用于唤醒 teardown 操作db.execute_db(del_sql)logger.info(注册用户操作删除注册的用户)logger.info(执行后置SQL{}.format(del_sql))
在这里以用户注册用例为例。对于前置操作我们应该准备一条删除SQL用于将数据库中已存在的相同用户删除对于后置操作我们应该再执行删除SQL确保该测试数据正常完成清理工作。
在测试用例中我们只需要在用例上传入 fixture 的函数参数名 delete_register_user 这样就可以调用 fixture 实现测试前置及后置操作。当然也可以使用pytest装饰器 pytest.mark.usefixtures() 来完成如
pytest.mark.usefixtures(delete_register_user)
Allure用例描述
在这里我们结合 Allure 来实现输出测试报告同时我们可以使用其装饰器来添加一些用例描述并显示到测试报告中以便报告内容更加清晰、直观、可读。如使用 allure.title() 自定义报告中显示的用例标题使用 allure.description() 自定义用例的描述内容使用 allure.step() 可在报告中显示操作步骤使用 allure.issue() 可在报告中显示缺陷及其链接等。
allure.step(步骤1 注册用户)
def step_1(username, password, telephone, sex, address):logger.info(步骤1 注册用户 {}, {}, {}, {}, {}.format(username, password, telephone, sex, address))allure.severity(allure.severity_level.NORMAL)
allure.epic(针对单个接口的测试)
allure.feature(用户注册模块)
class TestUserRegister():用户注册allure.story(用例--注册用户信息)allure.description(该用例是针对获取用户注册接口的测试)allure.issue(https://www.cnblogs.com/wintest, name点击跳转到对应BUG的链接地址)allure.testcase(https://www.cnblogs.com/wintest, name点击跳转到对应用例的链接地址)allure.title(测试数据【 {username}{password}{telephone}{sex}{address}{except_result}{except_code}{except_msg}】)pytest.mark.singlepytest.mark.parametrize(username, password, telephone, sex, address, except_result, except_code, except_msg,api_data[test_register_user])pytest.mark.usefixtures(delete_register_user)def test_delete_user(self, login_fixture, username, except_result, except_code, except_msg):
省略
七、项目部署
首先下载项目源码后在根目录下找到 requirements.txt 文件然后通过 pip 工具安装 requirements.txt 依赖执行命令
pip3 install -r requirements.txt
接着修改 config/setting.ini 配置文件在Windows环境下安装相应依赖之后在命令行窗口执行命令
pytest
注意因为我这里是针对自己的接口项目进行测试如果想直接执行我的测试用例来查看效果需要提前部署上面提到的接口项目。
八、测试报告效果展示
在命令行执行命令pytest 运行用例后会得到一个测试报告的原始文件但这个时候还不能打开成HTML的报告还需要在项目根目录下执行命令启动 allure 服务
# 需要提前配置allure环境才可以直接使用命令行
allure serve ./report
最终可以看到测试报告的效果图如下 最后感谢每一个认真阅读我文章的人礼尚往来总是要有的虽然不是什么很值钱的东西如果你用得到的话可以直接拿走 这些资料对于【软件测试】的朋友来说应该是最全面最完整的备战仓库这个仓库也陪伴上万个测试工程师们走过最艰难的路程希望也能帮助到你
