BDD - Python Behave 用户自定义配置文件
- 引言
- 默认 behave.ini 配置文件
- 自定义配置文件
- json 格式的配置文件
- ini 格式的配置文件
- 实例应用
- 项目结构
- 代码
- BDD/Features/user_data.feature 文件
- BDD/steps/user_data_steps.py 文件
- BDD/environment.py 文件
- 默认配置文件 behave.ini
- 自定义配置文件
- vscode 环境下 behave 设置 .vscode/settings.json 文件
- 执行
- 用默认 behave.ini 自定义的变量值
- 命令行自定义变量值
引言
前面《BDD - Python Behave 配置文件 behave.ini》有介绍默认配置文件 behave.ini 一些通用配置。《BDD - Python Behave 用户自定义命令行选项 -D》通过命令行或默认配置文件 behave.ini 自定义参数。在实际自动化测试项目中,不同环境测试配置也不一样,例如:服务器地址,数据库名,API URL 等等,Behave 测试框架怎么自定义配置文件并应用到不同的测试环境中,今天就来了解一下,这也是框架设计的一部分,非常重要。
想了解更多 Behave 相关的文章,欢迎阅读《Python BDD Behave 系列》,持续更新中。
默认 behave.ini 配置文件
在项目根目录下,创建 behave.ini 文件,在 behave.userdata 处用户自定义参数。这里的用户参数通常是整个项目的全局参数,不区分环境。
[behave.userdata]
env = dev
脚本可以通过 context.config.userdata[‘env’] 便可访问到
自定义配置文件
官网 User Data,用户可以自定义配置文件 json 格式或 ini 格式,只是需要在 before_all() hook 中加载解析后才能应用的测试用例中。
json 格式的配置文件
新建一个 userconfig.json 文件,内容如下:
{"user": "user_name","pw": "password"
}
在 environment.py 文件中,before_all hook 中加载该配置文件
configfile_json = userdata.get(“configfile”, “BDD/config/userconfig.json”)
获取配置文件,后面参数是配置文件的相对路径。
from behave import *
import os
import json
from behave.configuration import ConfigParserdef before_all(context):userdata = context.config.userdata# get json configconfigfile_json = userdata.get("configfile", "BDD/config/userconfig.json")if os.path.exists(configfile_json):config = json.load(open(configfile_json))userdata.update(config)
这样就可以通过 context.config.userdata[‘user’] 和 context.config.userdata[‘pw’] 来访问了
ini 格式的配置文件
新建 dev_userconfig.ini 文件用来配置 dev 环境,内容如下:
[behave.userdata.more]
db = dev_db
新建 prod_userconfig.ini 文件用来配置 prod 环境,内容如下:
[behave.userdata.more]
db = prod_db
在 environment.py 文件中,before_all hook 中加载该配置文件
可以根据默认配置文件 behave.ini 中 或通过命令行参数自定义的 env 变量来加载相应的配置文件
env = userdata.get("env")
configfile = userdata.get("configfile", f"BDD/config/{env}_userconfig.ini")
section = userdata.get("config_section", "behave.userdata.more")
以上是用来获取配置文件并指定 section 部分,然后通过 ConfigParser 解析加载配置项。
from behave import *
import os
import json
from behave.configuration import ConfigParserdef before_all(context):context.before_all = "before all"userdata = context.config.userdata# get ini configenv = userdata.get("env") configfile = userdata.get("configfile", f"BDD/config/{env}_userconfig.ini")section = userdata.get("config_section", "behave.userdata.more")parser = ConfigParser()parser.read(configfile)if parser.has_section(section):userdata.update(parser.items(section))
这样就可以通过 context.config.userdata[‘db’] 来访问了
实例应用
综合上面的讲解,来个完整的案例吧,基本上可以解决不同环境的配置问题。
项目结构
代码
BDD/Features/user_data.feature 文件
# user_data.feature
Feature: Context User Data Example@user_dataScenario: User data scenarioGiven user data is setThen get the user data
BDD/steps/user_data_steps.py 文件
# user_data_steps.pyfrom behave import *@given('user data is set')
def step_user_data_is_set(context):pass@then('get the user data')
def then_get_user_data(context):print(f"env:{context.config.userdata['env']}")print(f"user:{context.config.userdata['user']}")print(f"pw:{context.config.userdata['pw']}")print(f"pw:{context.config.userdata['db']}")
BDD/environment.py 文件
# environment.pyfrom behave import *
import os
import json
from behave.configuration import ConfigParserdef before_all(context):userdata = context.config.userdata# get json configconfigfile_json = userdata.get("configfile", "BDD/config/userconfig.json")if os.path.exists(configfile_json):config = json.load(open(configfile_json))userdata.update(config)# get ini configenv = userdata.get("env") configfile = userdata.get("configfile", f"BDD/config/{env}_userconfig.ini")section = userdata.get("config_section", "behave.userdata.more")parser = ConfigParser()parser.read(configfile)if parser.has_section(section):userdata.update(parser.items(section)) print("userdata", userdata)
默认配置文件 behave.ini
# behave.ini
[behave]
paths=BDD/Features/user_data
dry_run = false
format = my_html
outfiles = output/my_report.html
stdout_capture = False[behave.formatters]
my_html = behave_html_formatter:HTMLFormatter[behave.userdata]
env = dev
自定义配置文件
BDD/config/userconfig.json 文件,内容如下:
{"user": "user_name","pw": "password"
}
BDD/config/dev_userconfig.ini 文件用来配置 dev 环境,内容如下:
[behave.userdata.more]
db = dev_db
BDD/config/prod_userconfig.ini 文件用来配置 prod 环境,内容如下:
[behave.userdata.more]
db = prod_db
vscode 环境下 behave 设置 .vscode/settings.json 文件
{"behave-vsc.featuresPath": "BDD/Features"
}
执行
当前是项目根目录 C:\Automation\Test
用默认 behave.ini 自定义的变量值
执行命令:behave
默认取 env = dev,所以会加载到 dev_userconfig.ini,
所以 db = dev_db
PS C:\Automation\Test> behave
userdata {'env': 'dev', 'user': 'user_name', 'pw': 'password', 'db': 'dev_db'}
Feature: Context User Data Example # BDD/Features/user_data/user_data.feature:2@user_dataScenario: User data scenario # BDD/Features/user_data/user_data.feature:5 Given user data is set # BDD/steps/user_data_steps.py:5Then get the user data # BDD/steps/user_data_steps.py:9
env:dev
user:user_name
pw:password
pw:dev_db1 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
2 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.000s
命令行自定义变量值
执行命令:behave -D env=prod
会覆盖默认配置文件 behave.ini 中 env=dev 的值,用最新的 env=prod,会加载到 prod_userconfig.ini 文件,db=prod_db
PS C:\Automation\Test> behave -D env=prod
userdata {'env': 'prod', 'user': 'user_name', 'pw': 'password', 'db': 'prod_db'}
Feature: Context User Data Example # BDD/Features/user_data/user_data.feature:2@user_dataScenario: User data scenario # BDD/Features/user_data/user_data.feature:5Given user data is set # BDD/steps/user_data_steps.py:5Then get the user data # BDD/steps/user_data_steps.py:9
env:prod
user:user_name
pw:password
pw:prod_db1 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
2 steps passed, 0 failed, 0 skipped, 0 undefined
Took 0m0.001s