🧾 一、项目背景
在自动化测试中,我们经常需要根据不同的运行环境(如测试环境和生产环境)来执行测试脚本。本文将详细介绍如何通过命令行参数来指定运行环境,并使用 Python 和 pytest 框架实现这一功能。
🛠️ 二、配置文件设置
首先,在项目的配置文件中定义不同环境下的相关参数。以 setting.py 文件为例:
# 优先从环境变量读取运行环境
DOMAIN_ENV = os.getenv("DOMAIN_ENV", "test") # 默认为 testDOMAINS = {"prod": "https:********", # 线上环境域名"test": "http:*********" # 测试环境域名
}# Webhook 配置(用于企业微信消息推送)
WEBHOOK_URLS = {"prod": "https:***************", # 线上企微机器人地址"test": "https:***************" # 测试企微机器人地址
}# 根据当前环境选择基础域名
DOMAIN = DOMAINS.get(DOMAIN_ENV, DOMAINS["test"]) # 默认使用测试环境# 获取当前环境下的 Webhook URL
WEBHOOK_URL = WEBHOOK_URLS.get(DOMAIN_ENV, WEBHOOK_URLS["test"])# 获取 token 的配置
TOKEN_CONFIGS = {"prod": {"M": {"url": "/*********", # 登录接口"headers": {"Content-Type": "application/json; charset=UTF-8"},"data": {"username": "员工1", "password": "123456"},"jsonpath_expr": "$.data.accessToken"},"P": {"url": "/*********", # 登录接口"headers": {"Content-Type": "application/json; charset=UTF-8"},"data": {"username": "员工2", "password": "123456"},"jsonpath_expr": "$.data.accessToken"}},"test": {"M": {"url": "/*********", # 登录接口"headers": {"Content-Type": "application/json; charset=UTF-8"},"data": {"username": "员工3", "password": "123456"},"jsonpath_expr": "$.data.accessToken"},"P": {"url": "/*********", # 登录接口"headers": {"Content-Type": "application/json; charset=UTF-8"},"data": {"username": "员工4", "password": "123456"},"jsonpath_expr": "$.data.accessToken"}}
}# 当前环境下的 token 配置
TOKEN_CONFIG_M = TOKEN_CONFIGS[DOMAIN_ENV]["M"]
TOKEN_CONFIG_P = TOKEN_CONFIGS[DOMAIN_ENV]["P"]
在这个配置文件中,我们定义了两个环境:prod 和 test,并且可以根据环境变量 DOMAIN_ENV 来决定使用哪个环境。
📦 三、主程序逻辑
接下来,我们需要编写一个主程序来解析命令行参数,并据此设置环境变量。以下是 run.py 文件的内容:
import os
import argparsedef main():"""主函数负责解析命令行参数并调用测试运行逻辑。"""# 定义 ArgumentParser 并解析所有参数parser = argparse.ArgumentParser(description="运行测试用例并生成 Allure 报告")parser.add_argument("--test-path",type=str,default="tests",help="测试文件或目录的路径,默认为 'tests'")parser.add_argument("--extra-args",nargs="*",default=[],help="额外的 pytest 命令行参数")parser.add_argument("--env",type=str,default="test",choices=["test", "prod"],help="指定运行环境: test 或 prod,默认为 test")args = parser.parse_args()# 设置环境变量os.environ["DOMAIN_ENV"] = args.envprint(f"Setting DOMAIN_ENV to: {args.env}")# 运行 pytestpytest.main()# 从 conftest 中导入全局变量 failed_resultsfrom conftest import failed_resultssend_to_wechat_robot(WEBHOOK_URL, failed_results)
解释:
1、命令行参数解析:
- --test-path: 指定测试文件或目录的路径,默认是 tests。
- --extra-args: 允许传递额外的 pytest 命令行参数。
- --env: 指定运行环境,可选值为 test 或 prod,默认是 test。
2、设置环境变量:
- 在解析完命令行参数后,我们将环境变量 DOMAIN_ENV 设置为用户提供的值。这样,当我们在代码中访问这个环境变量时,就可以知道应该使用哪个环境的配置。
3、运行测试:
- 使用 pytest.main() 方法来运行测试,并传递构建好的命令行参数。
- 最后,将失败的结果发送到企业微信机器人。
🔁 四、命令行运行脚本
要运行脚本并指定测试环境,可以使用以下命令:
python run.py --env=test
或者对于生产环境:
python run.py --env=prod
你还可以指定测试路径和其他 pytest 参数:
python run.py --env=test --test-path=tests/smoke --extra-args="--html=report.html"
✅ 五、总结
通过以上步骤,我们可以轻松地根据命令行参数来指定运行环境,并且能够灵活地控制测试脚本的行为。这种方法不仅提高了测试脚本的灵活性,还使得在不同环境中切换变得非常简单。希望这篇文章对你有所帮助!