Tep集成 HttpRunner 与 Flask 实现开箱即用

2023-02-28

json file tep

 大家好，我是刚哥。趁着元旦假期最后一天，有着大把时间，奔着把tep做大做强的目标，好好学习了一波。在开始正文之前，先回答可能会问到的两个问题。第一个问题是为什么要集成HttpRunner?因为我最近在思考如何给tep做分层设计，参考了我司现有的接口自动化平台，它的设计是每个用例有很多测试

大家好，我是刚哥。

趁着元旦假期最后一天，有着大把时间，奔着把tep做大做强的目标，好好学习了一波。在开始正文之前，先回答可能会问到的两个问题。第一个问题是为什么要集成HttpRunner?因为我最近在思考如何给tep做分层设计，参考了我司现有的接口自动化平台，它的设计是每个用例有很多测试步骤，可以针对用例设置预设变量，然后在测试步骤中引用。正当我准备自己开发类似功能时，想到了HttpRunner，我记得HttpRunner第3版是建议直接编写pytest代码而非以前的ymal或json文件了。大有所获，HttpRunner正是以这种方式编写的代码，而且和pytest有很好的结合，很符合tep要集成的第三方包的希望。第二个问题是为什么要集成Flask?刚开始只是我用来调试代码的，等到把Mock写完以后，想到可能大家也需要调试代码，就把它做到tep里面了，并且附带了测试用例的示例代码，安装完以后就能一键运行，开箱即用，美滋滋。归根结底，都是为了把tep做大做强。

tep0.9.3正式发布

要体验HttpRunner和Flask，需要先安装或升级到tep0.9.3。

安装：

pip install tep 
1.

升级：

pip install -U tep 
1.

或者指定版本：

pip install tep==0.9.3 
1.

安装tep时会顺带安装HttpRunner和Flask，安装完以后就可以执行命令初始化项目：

tep startproject demo093 
1.

输出：

D:\PycharmProjects>tep startproject demo093 
2022-01-03 16:07:31.929 | INFO     | tep.scaffold:create_scaffold:53 - Create new project: demo093 
Project root dir: D:\PycharmProjects\demo093 
 
Created folder: demo093 
Created folder: demo093\fixtures 
Created folder: demo093\tests 
Created folder: demo093\files 
Created folder: demo093\reports 
Created folder: demo093\utils 
Created file: demo093\.gitignore 
Created file: demo093\conf.yaml 
Created file: demo093\conftest.py 
Created file: demo093\pytest.ini 
Created file: demo093\fixtures\__init__.py 
Created file: demo093\fixtures\fixture_admin.py 
Created file: demo093\fixtures\fixture_env_vars.py 
Created file: demo093\fixtures\fixture_login.py 
Created file: demo093\fixtures\fixture_your_name.py 
Created file: demo093\tests\__init__.py 
Created file: demo093\tests\test_login.py 
Created file: demo093\tests\test_post.py 
Created file: demo093\tests\test_mysql.py 
Created file: demo093\tests\test_request.py 
Created file: demo093\tests\test_login_pay.py 
Created file: demo093\tests\test_login_pay_httprunner.py 
Created file: demo093\utils\__init__.py 
Created file: demo093\utils\flask_mock_api.py 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.

修改了fixture_env_vars.py里面的domain为http://127.0.0.1:5000，这是Flask启动后的默认地址。
修改了fixture_login.py里面的登录url和username，跟Flask的Mock对应。
新增了utils\flask_mock_api.py，直接启动Mock服务。
新增了tests\test_login_pay.py，用例数据一体开发模式，登录到下单流程的示例代码，可以一键运行成功。
新增了tests\test_login_pay_httprunner.py，HttpRunner开发模式，登录到下单流程的示例代码，可以一键运行成功。

新版README.md

之前tep的README是全英文的，这次我也决定不装了，改成中文，丰富了内容，大家可以对tep有个全新和全面的了解啦。以下是全文：

tep

tep是Try Easy Pytest的首字母缩写，是一款基于pytest测试框架的测试工具，集成了各种实用的第三方包和优秀的自动化测试设计思想，帮你快速实现自动化项目落地。

安装

支持Python3.6以上，推荐Python3.8以上。

标准安装：

$ pip install tep 
1.

国内镜像：

$ pip --default-timeout=600 install -i https://pypi.tuna.tsinghua.edu.cn/simple tep 
1.

检查安装成功：

$ tep -V  # 或者 tep --version 
0.2.3 
1.
2.

快速创建项目

tep提供了脚手架，预置了项目结构和代码，打开cmd，使用startproject命令快速创建项目：

tep startproject project_name 
1.

并且提供了-venv参数，在项目初始化时，可以同时创建一个虚拟环境(推荐)：

tep startproject project_name -venv 
1.

输出测试报告

tep提供了--tep-reports参数来生成allure测试报告：

pytest  --tep-reports 
1.

报告文件存放在根目录的reports/中。

Mock服务

tep自带了一个Flask应用(utils/flask_mock_api.py)，提供了登录到下单流程的5个接口，启动后即可一键运行示例中的测试用例。

三种开发模式

tep兼容三种开发模式：用例数据一体(适合新手)、用例数据分离(适合老手)、HttpRunner(新老皆宜)。

①用例数据一体，示例代码如下所示：

def test(env_vars, login): 
    # 搜索商品 
    response = request( 
        "get", 
        url=env_vars.domain + "/searchSku", 
        headers={"token": login.token}, 
        params={"skuName": "电子书"} 
    ) 
    sku_id = jmespath.search("skuId", response.json()) 
    sku_price = jmespath.search("price", response.json()) 
    assert response.status_code < 400 
 
    # 添加购物车 
    sku_num = 3 
    response = request( 
        "post", 
        url=env_vars.domain + "/addCart", 
        headers={"token": login.token}, 
        json={"skuId": sku_id, "skuNum": sku_num} 
    ) 
    total_price = jmespath.search("totalPrice", response.json()) 
    assert response.status_code < 400 
 
    # 下单 
    response = request( 
        "post", 
        url=env_vars.domain + "/order", 
        headers={"token": login.token}, 
        json={"skuId": sku_id, "price": sku_price, "skuNum": sku_num, "totalPrice": total_price} 
    ) 
    order_id = jmespath.search("orderId", response.json()) 
    assert response.status_code < 400 
 
    # 支付 
    response = request( 
        "post", 
        url=env_vars.domain + "/pay", 
        headers={"token": login.token}, 
        json={"orderId": order_id, "payAmount": "6.9"} 
    ) 
    assert response.status_code < 400 
    assert response.json()["success"] == "true" 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.

更多内容请参考《如何使用teprunner测试平台编写从登录到下单的大流程接口自动化用例》

②用例数据分离

开发中，敬请期待...

③HttpRunner，示例代码如下所示：

from httprunner import HttpRunner, Config, Step, RunRequest 
 
 
class TestLoginPay(HttpRunner): 
    config = ( 
        Config("登录到下单流程") 
            .variables( 
            **{ 
                "skuNum": "3" 
            } 
        ) 
            .base_url("http://127.0.0.1:5000") 
    ) 
 
    teststeps = [ 
        Step( 
            RunRequest("登录") 
                .post("/login") 
                .with_headers(**{"Content-Type": "application/json"}) 
                .with_json({"username": "dongfanger", "password": "123456"}) 
                .extract() 
                .with_jmespath("body.token", "token") 
                .validate() 
                .assert_equal("status_code", 200) 
        ), 
        Step( 
            RunRequest("搜索商品") 
                .get("searchSku?skuName=电子书") 
                .with_headers(**{"token": "$token"}) 
                .extract() 
                .with_jmespath("body.skuId", "skuId") 
                .with_jmespath("body.price", "skuPrice") 
                .validate() 
                .assert_equal("status_code", 200) 
        ), 
        Step( 
            RunRequest("添加购物车") 
                .post("/addCart") 
                .with_headers(**{"Content-Type": "application/json", 
                                 "token": "$token"}) 
                .with_json({"skuId": "$skuId", "skuNum": "$skuNum"}) 
                .extract() 
                .with_jmespath("body.totalPrice", "totalPrice") 
                .validate() 
                .assert_equal("status_code", 200) 
        ), 
        Step( 
            RunRequest("下单") 
                .post("/order") 
                .with_headers(**{"Content-Type": "application/json", 
                                 "token": "$token"}) 
                .with_json({"skuId": "$skuId", "price": "$skuPrice", "skuNum": "$skuNum", "totalPrice": "$totalPrice"}) 
                .extract() 
                .with_jmespath("body.orderId", "orderId") 
                .validate() 
                .assert_equal("status_code", 200) 
        ), 
        Step( 
            RunRequest("支付") 
                .post("/pay") 
                .with_headers(**{"Content-Type": "application/json", 
                                 "token": "$token"}) 
                .with_json({"orderId": "$orderId", "payAmount": "6.9"}) 
                .validate() 
                .assert_equal("status_code", 200) 
                .assert_equal("body.success", "true") 
        ), 
    ] 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.