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

本项目实现接口自动化的技术选型：Python+Requests+Pytest+YAML+Allure ，主要是针对以前开发的一个接口项目来进行学习，经过 Python+Requests 来发送和处理HTTP协议的请求接口，使用 Pytest 做为测试执行器，使用 YAML 来管理测试数据，使用 Allure 来生成测试报告。

接口项目开发学习：
使用Flask开发简单接口(1)--GET请求接口
使用Flask开发简单接口(2)--POST请求接口
使用Flask开发简单接口(3)--引入MySQL
使用Flask开发简单接口(4)--借助Redis实现token验证
使用Flask开发简单接口(5)--数据加密处理

项目说明

本项目在实现过程当中，把整个项目拆分红请求方法封装、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_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

注意：由于我这里是针对本身的接口项目进行测试，若是想直接执行个人测试用例来查看效果，须要提早部署上面提到的接口项目。

测试报告效果展现

在命令行执行命令：pytest 运行用例后，会获得一个测试报告的原始文件，但这个时候还不能打开成HTML的报告，还须要在项目根目录下，执行命令启动 allure 服务：

# 须要提早配置allure环境，才能够直接使用命令行
allure serve ./report

最终，能够看到测试报告的效果图以下：