在日常測試工作中,我們的測試用例可能需要在多環境中運行,為了實現一套測試腳本能在不同的測試環境中使用,我們需要把與環境有關的參數抽取出來,每次運行用例時,可以指定運行時(RunTime)環境變量,來達到同一用例在不同的環境中執行。
環境變量的定義
建議把環境變量定義在一個文件中,如.env
# .env
admin_base_url=https://openadmintest92.aiyuangong.com
loginName=18617270901
password=123456
環境變量讀取格式
環境變量的讀取采用格式${ENV(envname)}
,其中,envname
為變量名稱,如下面的:
${ENV(admin_base_url)}
,${ENV(loginName)}
,${ENV(passwod)}
from api.common.login import Login
from httprunner import HttpRunner, Config, Step, RunRequest
class TestOpenAdminLogin(HttpRunner):
config = (
Config("admin端登錄成功")
.base_url("${ENV(admin_base_url)}")
.variables(**{
"loginName": "${ENV(loginName)}",
"password": "${ENV(password)}"
}).verify(False)
)
teststeps = [
Step(
RunRequest("登錄請求")
.post(Login.path).with_json(Login.json)
.extract()
.with_jmespath("body.data.userProfiles[0].id", "userid")
.with_jmespath("body.data.access_token", "access_token")
.validate()
.assert_equal("body.code", 200)
)
]
if __name__ == '__main__':
TestOpenAdminLogin().test_start()
通過執行用例的日志可以看出,三處的變量都已經替換成功了。
- log打印
================== request details ==================
method : POST
url : https://openadmintest92.aiyuangong.com/api/sysmgr-web/auth/common-login
headers : {
"User-Agent": "python-requests/2.24.0",
"Accept-Encoding": "gzip, deflate",
"Accept": "*/*",
"Connection": "keep-alive",
"HRUN-Request-ID": "HRUN-d0b1d603-a50d-4559-b643-1ed6f6d0105c-941168",
"Content-Length": "50",
"Content-Type": "application/json"
}
cookies : {}
body : {
"loginName": "18617270901",
"password": "123456"
}
多環境處理
理想的情況是,每個環境維護一份環境變量,變量的名字都是一致的,這樣就可以做到不修改用例的情況下,指定不同的環境變量文件就可以讀取不同的變量值,在前期版本httprunner是可以通過執行用例時,在命令行通過命令參數出--dot-env-path
指定環境變量文件的,但是新版本的特性中,好像目前并為支持該參數,所以只能想其他辦法。
原理:HttpRunner 運行時,會自動將 .env
文件中的內容加載到運行時(RunTime
)的環境變量中,然后在運行時中就可以對環境變量進行讀取了
思考:既然HttpRunner目前只認.env
文件中的變量,那么我們可不可以自己定義不同的環境變量環境,執行用例時,指定自己的環境變量文件,前置的寫入到.env
文件呢?
建立環境變量管理文件
建立一個文件夾envs
,在其中維護環境變量文件,例如創建兩個文件
- test92.env :92測試環境
admin_base_url=https://openadmintest92.aiyuangong.com
loginName=18617270901
password=123456
- test.env :預發測試環境
admin_base_url=https://openadmintest.aiyuangong.com
loginName=18825169888
password=123456
可以看到兩個環境的變量名都一致,變量值不一致
編寫前置替換腳本
- 編寫一個py腳本文件,放置在項目根目錄(與
.env
文件同一級別),在運行用例值執行此腳本,指定變量文件名,就會讀取指定文件的變量然后全量替換.env
里的文本內容。
import os
import sys
def read_env(filepath):
current_path = os.path.abspath(os.path.dirname(__file__))
print("current_path:",current_path)
re_data=os.path.join(current_path, filepath)
env_file=os.path.join(current_path,'.env')
print("當前指定的要替換的env:", re_data)
data_renew=""
with open(re_data, 'r',encoding="utf-8") as ff:
for line in ff:
line = line.strip()
if not len(line) or line.startswith('#'):
continue
else:
data_renew += line+'\n'
with open(env_file,'w',encoding="utf-8") as f:
f.write(data_renew)
print(data_renew)
if __name__ == "__main__":
#用于jenkins讀取參數執行
filepath=sys.argv[1]
config=read_env(filepath)
執行前構建
python read_env.py envs/test.env
意思是把預發環境的變量拷貝到.env
文件中,執行完成后,查看.env
文件發現已經寫入。
# .env
admin_base_url=https://openadmintest.aiyuangong.com
loginName=18825169888
password=123456
執行用例
查看日志,變量值都是預發環境的,至此基本需求實現
================== request details ==================
method : POST
url : https://openadmintest.aiyuangong.com/api/sysmgr-web/auth/common-login
headers : {
"User-Agent": "python-requests/2.24.0",
"Accept-Encoding": "gzip, deflate",
"Accept": "*/*",
"Connection": "keep-alive",
"HRUN-Request-ID": "HRUN-d3dd12b5-87d5-4cf9-9dc3-cab699876935-439333",
"Content-Length": "50",
"Content-Type": "application/json"
}
cookies : {}
body : {
"loginName": "18825169888",
"password": "123456"
}