在日常测试工作中,我们的测试用例可能需要在多环境中运行,为了实现一套测试脚本能在不同的测试环境中使用,我们需要把与环境有关的参数抽取出来,每次运行用例时,可以指定运行时(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"
}