httprunner3原始碼解讀（一）：簡介+使用介紹
阿新 • • 發佈：2021-10-30
一、簡介
1、httprunner是什麼？
HttpRunner 是一款面向 HTTP(S) 協議的通用測試框架，只需編寫維護一份 pytest/YAML/JSON 指令碼，即可實現自動化測試、效能測試、線上監控、持續整合等多種測試需求。
2、設計哲學
3、主要特徵
- 繼承的所有強大功能requests，只需以人工方式獲得樂趣即可處理HTTP（S）。
- 以YAML或JSON格式定義測試用例，pytest以簡潔優雅的方式執行。
- 在HAR支援下記錄並生成測試用例。
- 支援variables/ extract/ validate/hooks機制，以建立非常複雜的測試方案。
- 使用debugtalk.py外掛，任何功能都可以在測試用例的任何部分使用。
- 使用jmespath，提取和驗證json響應從未如此簡單。
- 有了pytest，數百個外掛隨時可用。
- 使用allure，測試報告可以非常強大。
- 通過重複使用locust，您可以進行效能測試，而無需進行額外的工作。
- 支援CLI命令，與CI/CD完美結合。
4、框架流程
二、框架使用
1、下載安裝
使用pip命令進行安裝
pip install httprunner
安裝後效驗是否安裝成功，可以使用如下命令進行效驗
httprunner -V 3.1.6
httprunner：主命令，用於所有功能
httprunner run，用於執行YAML / JSON / pytest測試用例
httprunner make，用於將YAML / JSON測試用例轉換為pytest檔案
httprunner har2case，用於將HAR轉換為YAML / JSON測試用例
locusts：用於對locusts進行負載測試
2、原始碼獲取
# https://github.com/httprunner/httprunner git clone https://github.com/httprunner/httprunner.git
3、官方文件：https://docs.httprunner.org/
4、測試用例格式關係
5、建立新專案
PS D:\private\src\hruntest> httprunner startproject -h usage: httprunner startproject [-h] [project_name] positional arguments: project_name Specify new project name. optional arguments: -h, --help show this help message and exit
PS D:\private\src\hruntest> httprunner startprojectdemo
6、用har2case生成測試用例
使用charles、fiddler抓包工具進行錄屏，並匯出（export）
匯出檔案型別選擇為.har字尾。
使用har2case命令用法
PS D:\private\src\hruntest> httprunner har2case -h
usage: httprunner har2case [-h] [-2y] [-2j] [--filter FILTER] [--exclude EXCLUDE] [har_source_file]
positional arguments:
har_source_file Specify HAR source file
optional arguments:
-h, --help show this help message and exit
-2y, --to-yml, --to-yaml
Convert to YAML format, if not specified, convert to pytest format by default.
-2j, --to-json Convert to JSON format, if not specified, convert to pytest format by default.
--filter FILTER Specify filter keyword, only url include filter string will be converted.
--exclude EXCLUDE Specify exclude keyword, url that includes exclude string will be ignored, multiple keywords can be joined with '|'
7、執行測試用例
httprunner run = make + pytest
PS D:\private\src\hruntest> httprunner run D:\private\src\hruntest\demo\testcases 2021-10-30 11:24:56.584 | INFO | httprunner.make:__make:512 - make path: D:\private\src\hruntest\demo\testcases 2021-10-30 11:24:56.590 | INFO | httprunner.compat:ensure_testcase_v3:219 - ensure compatibility with testcase format v2 2021-10-30 11:24:56.595 | INFO | httprunner.loader:load_dot_env_file:127 - Loading environment variables from D:\private\src\hruntest\demo\.env 2021-10-30 11:24:56.595 | DEBUG | httprunner.utils:set_os_environ:33 - Set OS environment variable: USERNAME 2021-10-30 11:24:56.596 | DEBUG | httprunner.utils:set_os_environ:33 - Set OS environment variable: PASSWORD 2021-10-30 11:24:56.597 | INFO | httprunner.make:make_testcase:349 - start to make testcase: D:\private\src\hruntest\demo\testcases\demo_testcase_ref.ym l 2021-10-30 11:24:56.618 | INFO | httprunner.compat:ensure_testcase_v3:219 - ensure compatibility with testcase format v2 2021-10-30 11:24:56.620 | INFO | httprunner.make:make_testcase:349 - start to make testcase: D:\private\src\hruntest\demo\testcases\demo_testcase_reques t.yml 2021-10-30 11:24:56.620 | INFO | httprunner.make:make_testcase:442 - generated testcase: D:\private\src\hruntest\demo\testcases\demo_testcase_request_te st.py 2021-10-30 11:24:56.622 | INFO | httprunner.make:make_testcase:442 - generated testcase: D:\private\src\hruntest\demo\testcases\demo_testcase_ref_test.p y 2021-10-30 11:24:56.628 | INFO | httprunner.compat:ensure_testcase_v3:219 - ensure compatibility with testcase format v2 2021-10-30 11:24:56.629 | INFO | httprunner.make:make_testcase:349 - start to make testcase: D:\private\src\hruntest\demo\testcases\demo_testcase_reques t.yml 2021-10-30 11:24:56.629 | INFO | httprunner.make:format_pytest_with_black:170 - format pytest cases with black ... reformatted D:\private\src\hruntest\demo\testcases\demo_testcase_ref_test.py reformatted D:\private\src\hruntest\demo\testcases\demo_testcase_request_test.py All done! ✨ � ✨ 2 files reformatted. 2021-10-30 11:24:57.237 | INFO | httprunner.cli:main_run:56 - start to run tests with pytest. HttpRunner version: 3.1.6 =================================================================== test session starts =================================================================== platform win32 -- Python 3.9.6, pytest-5.4.3, py-1.10.0, pluggy-0.13.1 rootdir: D:\private\src\hruntest plugins: html-2.1.1, metadata-1.11.0 collected 2 items demo\testcases\demo_testcase_request_test.py . [ 50%] demo\testcases\demo_testcase_ref_test.py . [100%] ==================================================================== 2 passed in 4.68s ==================================================================== PS D:\private\src\hruntest>
8、引數驅動
主要講解CSV格式，通過parameters關鍵字，引數列表中間加“-”序列。${P（CSV檔案相對路徑）}
config:
name: "business type info test"
variables:
username: "admin"
password: "2wsx@WSX"
parameters:
ids-combineNe-realNeType-slNeType: ${parameterize(data/base_ne/base_ne_ids.csv)}
# 兩種格式：ids-combineNe-realNeType-slNeType: ${P(data/base_ne/base_ne_ids.csv)}
base_url: "http://192.xxx.xxx.xxx:8080"
verify: False
引數使用情況
- name: /base-ne/ids
request:
headers:
Authorization: $token
Content-Type: application/json
method: GET
params:
ids: $ids
url: /base-ne/ids
validate:
- eq: ["status_code", 200]
- eq:
- body.result[0].combineNe
- $combineNe
- eq:
- body.result[0].realNeType
- $realNeType
- eq:
- body.result[0].slNeType
- $slNeType
CSV檔案格式如下：
ids,combineNe,realNeType,slNeType 1,eNode/MME,MME,eNode 2,gNode/AMF,AMF,gNode 3,PGW/PBC,PBC,PGW 4,PSBC/I-CSF,I-CSF,PSBC 5,S-CSC/HSS,HSS,S-CSC 6,S-CSC/AS,AS,S-CSC 7,eNode/SGW,SGW,eNode
用例執行時，會執行七次。
9、allure報告
Httprunner提供pytest預設的報告格式
hrun ./testcases/login.yml --html=reports/demo.html
執行用例：
pytest testcases/base_ne/base_ne_ids.pytest --alluredir reports (最終報告可以看到執行日誌) hrun testcases/base_ne --alluredir=reports （沒有執行日誌）
生成報告命令：
allure generate reports allure generate reports -o allure-report --clean -o allure-report:是指定清空測試報告的檔案 –clean:是為了清空已有的測試報告