httprunner 2.x学习4-测试用例分层

前言

httprunner 2.x版本最大的改进就是分层机制了，1.x的版本是线性设计的，每个用例都是独立的。
一个用例里面涉及到流程性的，我们测试修改个人信息是否修改成功，在yaml文件里面需写3个步骤：登录-修改个人信息-查询个人信息。
这样3个测试步骤，每个测试步骤写的test下。但是下个测试用例，重新写个yaml文件也需要遇到登录的话，这样登录的步骤就会重复去写，所以维护起来不方便。
httprunner 2.x版本开始引入分层机制，可以定义公共的方法，在用例里面直接引入步骤，这样登录方法我们只需写一次

分层机制

在自动化测试领域，自动化测试用例的可维护性是极其重要的因素，直接关系到自动化测试能否持续有效地在项目中开展。

概括来说，测试用例分层机制的核心是将接口定义、测试步骤、测试用例、测试场景进行分离，单独进行描述和维护，从而尽可能地减少自动化测试用例的维护成本。

逻辑关系图如下所示：

同时，强调如下几点核心概念：

• 测试用例（testcase）应该是完整且独立的，每条测试用例应该是都可以独立运行的
• 测试用例是测试步骤（teststep）的 有序 集合，每一个测试步骤对应一个 API 的请求描述
• 测试用例集（testsuite）是测试用例的 无序 集合，集合中的测试用例应该都是相互独立，不存在先后依赖关系的；如果确实存在先后依赖关系，那就需要在测试用例中完成依赖的处理

如果对于上述第三点感觉难以理解，不妨看下上图中的示例：

• testcase1 依赖于 testcase2，那么就可以在测试步骤（teststep12）中对 testcase2 进行引用，然后 testcase1 就是完整且可独立运行的；
• 在 testsuite 中，testcase1 与 testcase2 相互独立，运行顺序就不再有先后依赖关系了。

分层描述详解

理解了测试用例分层模型，接下来我们再来看下在分层模型下，接口、测试用例、测试用例集的描述形式。

为了更好地对接口描述进行管理，推荐使用独立的文件对接口描述进行存储，即每个文件对应一个接口描述。

接口定义描述的主要内容包括：name、variables、request、base_url、validate 等，形式如下：

# api/get_header.yml
name: get headers
base_url: http://httpbin.org
variables:
    expected_status_code: 200
request:
    url: /headers
    method: GET
validate:
    - eq: ["status_code", $expected_status_code]
    - eq: [content.headers.Host, "httpbin.org"]

其中，name 和 request 部分是必须的，request 中的描述形式与 requests.request 完全相同。
另外，API 描述需要尽量保持完整，做到可以单独运行。如果在接口描述中存在变量引用的情况，可在 variables 中对参数进行定义。
通过这种方式，可以很好地实现单个接口的调试。

(venv_hrun) D:softvenu_hrun>hrun api/get_header.yml
INFO     HttpRunner version: 2.5.7
INFO     Start to run testcase: get headers
get headers
INFO     GET http://httpbin.org/headers
INFO     status_code: 200, response_time(ms): 594.7 ms, response_length: 225 bytes

.

----------------------------------------------------------------------
Ran 1 test in 0.597s

OK
INFO     Start to render Html report ...
INFO     Generated Html report: D:softvenu_hrun
eports20200612T144524.746202.html

OK

api层

接下来把登录写到api，测试用例去引用登录api,在项目根目录新建一个api目录，写login.yml文件内容

# 上海-悠悠，httprunner QQ交流群：1121184576
name: login first
base_url: http://127.0.0.1:8000
variables:
    user: test
    password: 123456
request:
        url: /api/v1/login/
        method: POST
        headers:
            Content-Type: application/json
            User-Agent: python-requests/2.18.4
        json:
            username: $user
            password: $password
validate:
    - eq: [status_code, 200]
    - eq: [headers.Content-Type, application/json]
    - eq: [content.msg, login success!]
    - eq: [content.code, 0]

我们要保证单个接口是可以执行的

hrun api/login.yml

运行结果

(venv_hrun) D:softvenu_hrun>hrun api/login.yml
INFO     HttpRunner version: 2.5.7
INFO     Start to run testcase: login first
login first
INFO     POST http://127.0.0.1:8000/api/v1/login/
INFO     status_code: 200, response_time(ms): 179.66 ms, response_length: 109 bytes

.

----------------------------------------------------------------------
Ran 1 test in 0.183s

OK
INFO     Start to render Html report ...
INFO     Generated Html report: D:softvenu_hrun
eports20200612T151122.418051.html

接下来把获取个人信息的接口也写到api层，get_userinfo.yml内容
token 这个参数是可变的，每次登录都会生成一个新的值，这里为了调试的通，可以先登录后，把token复制过来

# 上海-悠悠，httprunner QQ交流群：1121184576
name: get user info case1
base_url: http://127.0.0.1:8000
variables:
    token: 1c5ef1856edec117ac989eb8def4abbaae28673e
request:
    url: /api/v1/userinfo/
    method: GET
    headers:
        Content-Type: application/json
        User-Agent: python-requests/2.18.4
        Authorization: Token $token          # 引用token

运行后结果

(venv_hrun) D:softvenu_hrun>hrun api/get_userinfo.yml
INFO     HttpRunner version: 2.5.7
INFO     Start to run testcase: get user info case1
get user info case1
INFO     GET http://127.0.0.1:8000/api/v1/userinfo/
INFO     status_code: 200, response_time(ms): 209.11 ms, response_length: 126 bytes

.

----------------------------------------------------------------------
Ran 1 test in 0.211s

OK
INFO     Start to render Html report ...
INFO     Generated Html report: D:softvenu_hrun
eports20200612T151456.300635.html

用例层

用例层在项目根目录下新建一个case目录，专注测试用例的流程，如测试用例流程：登录-获取个人信息
整体设计思路：

• step1 先引用api api/login.yml 用变量get_token提取登录的token
• step2 在 variables 中定义 token 的值，这里会覆盖全面 api/get_userinfo.yml 中的 token 值

# 上海-悠悠，httprunner QQ交流群：1121184576
- config:
    name: "test userinfo"

- test:
    name: login-setup
    api: api/login.yml
    extract:
        - get_token: content.token
    validate:
        - eq: ["status_code", 200]
        - len_eq: ["content.token", 40]

- test:
   name: get user info case1
   api: api/get_userinfo.yml
   variables:
      token: $get_token
   validate:
        - eq: [status_code, 200]
        - eq: [headers.Content-Type, application/json]
        - eq: [content.data.0.age, 24]
        - eq: [content.data.0.name, test]
        - eq: [content.data.0.mail, xxx@qq.com]

运行结果

(venv_hrun) D:softvenu_hrun>hrun case
INFO     HttpRunner version: 2.5.7
INFO     Start to run testcase: test userinfo
login-setup
INFO     POST http://127.0.0.1:8000/api/v1/login/
INFO     status_code: 200, response_time(ms): 165.57 ms, response_length: 109 bytes

.
get user info case1
INFO     GET http://127.0.0.1:8000/api/v1/userinfo/
INFO     status_code: 200, response_time(ms): 187.49 ms, response_length: 126 bytes

.

----------------------------------------------------------------------
Ran 2 tests in 0.360s

OK
INFO     Start to render Html report ...
INFO     Generated Html report: D:softvenu_hrun
eports20200612T151840.103147.html

层级结构

推荐的方式汇总如下：

• debugtalk.py 放置在项目根目录下，假设为 PRJ_ROOT_DIR
• .env 放置在项目根目录下，路径为 PRJ_ROOT_DIR/.env
• 接口定义（API）放置在 PRJ_ROOT_DIR/api/ 目录下
• 测试用例（testcase）放置在 PRJ_ROOT_DIR/testcases/ 目录下
• 测试用例集（testsuite）文件必须放置在 PRJ_ROOT_DIR/testsuites/ 目录下
• data 文件夹：存储参数化文件，或者项目依赖的文件，路径为 PRJ_ROOT_DIR/data/
• reports 文件夹：存储HTML 测试报告，生成路径为 PRJ_ROOT_DIR/reports/

目录结构如下所示：

tests
├── .env
├── data
│   ├── app_version.csv
│   └── account.csv
├── api
│   ├── create_user.yml
│   ├── get_headers.yml
│   ├── get_userinfo.yml
│   └── login.yml
├── debugtalk.py
├── testcases
│   ├── test_userinfo.yml
│   ├── deps
│   │   └── check_and_create.yml
│   └── setup.yml
└── testsuites
    ├── create_users.yml
    └── create_users_with_parameters.yml