前言
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:\soft\venu_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:\soft\venu_hrun\reports\20200612T144524.746202.html
OK
api層
接下來把登錄寫到api,測試用例去引用登錄api,在項目根目錄新建一個api目錄,寫login.yml文件內容
# 上海-悠悠,httprunner QQ交流群:717225969
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:\soft\venu_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:\soft\venu_hrun\reports\20200612T151122.418051.html
接下來把獲取個人信息的接口也寫到api層,get_userinfo.yml內容
token 這個參數是可變的,每次登錄都會生成一個新的值,這里為了調試的通,可以先登錄后,把token復制過來
# 上海-悠悠,httprunner QQ交流群:717225969
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:\soft\venu_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:\soft\venu_hrun\reports\20200612T151456.300635.html
用例層
用例層在項目根目錄下新建一個case目錄,專注測試用例的流程,如測試用例流程:登錄-獲取個人信息
整體設計思路:
- step1 先引用api api/login.yml 用變量get_token提取登錄的token
- step2 在 variables 中定義 token 的值,這里會覆蓋全面 api/get_userinfo.yml 中的 token 值
# 上海-悠悠,httprunner QQ交流群:717225969
- 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:\soft\venu_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:\soft\venu_hrun\reports\20200612T151840.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