Python+Requests+Pytest+YAML+Allure实现接口自动化

最后

🍅 硬核资料：关注即可领取PPT模板、简历模板、行业经典书籍PDF。
🍅 技术互助：技术群大佬指点迷津，你的问题可能不是问题，求资源在群里喊一声。
🍅 面试题库：由技术群里的小伙伴们共同投稿，热乎的大厂面试真题，持续更新中。
🍅 知识体系：含编程语言、算法、大数据生态圈组件（Mysql、Hive、Spark、Flink）、数据仓库、Python、前端等等。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

当然，如果感兴趣的话，还可以再对接口自动化进行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_url
        self.session = requests.session()
 
    def get(self, url, **kwargs):
        return self.request(url, "GET", **kwargs)
 
    def post(self, url, data=None, json=None, **kwargs):
        return self.request(url, "POST", data, json, **kwargs)
 
    def put(self, url, data=None, **kwargs):
        return self.request(url, "PUT", data, **kwargs)
 
    def delete(self, url, **kwargs):
        return self.request(url, "DELETE", **kwargs)
 
    def patch(self, url, data=None, **kwargs):
        return self.request(url, "PATCH", data, **kwargs)
 
    def request(self, url, method, data=None, json=None, **kwargs):
        url = self.api_root_url + url
        headers = 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_data
 
@pytest.fixture(scope="function")
def testcase_data(request):
    testcase_name = request.function.__name__
    return api_data.get(testcase_name)`

数据准备和清理

在接口自动化中，为了保证用例可稳定、重复地执行，我们还需要有测试前置操作和后置操作，即数据准备和数据清理工作。

@pytest.fixture(scope="function")
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.single
    @pytest.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

做了那么多年开发，自学了很多门编程语言，我很明白学习资源对于学一门新语言的重要性，这些年也收藏了不少的Python干货，对我来说这些东西确实已经用不到了，但对于准备自学Python的人来说，或许它就是一个宝藏，可以给你省去很多的时间和精力。

别在网上瞎学了，我最近也做了一些资源的更新，只要你是我的粉丝，这期福利你都可拿走。

我先来介绍一下这些东西怎么用，文末抱走。

---

（1）Python所有方向的学习路线（新版）

这是我花了几天的时间去把Python所有方向的技术点做的整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。

最近我才对这些路线做了一下新的更新，知识体系更全面了。

（2）Python学习视频

包含了Python入门、爬虫、数据分析和web开发的学习视频，总共100多个，虽然没有那么全面，但是对于入门来说是没问题的，学完这些之后，你可以按照我上面的学习路线去网上找其他的知识资源进行进阶。

（3）100多个练手项目

我们在看视频学习的时候，不能光动眼动脑不动手，比较科学的学习方法是在理解之后运用它们，这时候练手项目就很适合了，只是里面的项目比较多，水平也是参差不齐，大家可以挑自己能做的项目去练练。

（4）200多本电子书

这些年我也收藏了很多电子书，大概200多本，有时候带实体书不方便的话，我就会去打开电子书看看，书籍可不一定比视频教程差，尤其是权威的技术书籍。

基本上主流的和经典的都有，这里我就不放图了，版权问题，个人看看是没有问题的。

（5）Python知识点汇总

知识点汇总有点像学习路线，但与学习路线不同的点就在于，知识点汇总更为细致，里面包含了对具体知识点的简单说明，而我们的学习路线则更为抽象和简单，只是为了方便大家只是某个领域你应该学习哪些技术栈。

（6）其他资料

还有其他的一些东西，比如说我自己出的Python入门图文类教程，没有电脑的时候用手机也可以学习知识，学会了理论之后再去敲代码实践验证，还有Python中文版的库资料、MySQL和HTML标签大全等等，这些都是可以送给粉丝们的东西。

这些都不是什么非常值钱的东西，但对于没有资源或者资源不是很好的学习者来说确实很不错，你要是用得到的话都可以直接抱走，关注过我的人都知道，这些都是可以拿到的。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！