自动化框架 - 核心功能使用指南 - 配置文件使用指南

1. 配置文件结构

环境配置文件通常用于定义不同环境测试环境参数。

命名格式：<XXX>.yml

示例：

  qa.yaml：测试环境配置。

  prod.yaml：生产环境配置。

以下是一个示例配置文件 config.yml 的结构

示例：

config.yml

2. 配置信息说明

1. params

在yml文件中，key指定为“params”，用于全局参数，可以包含多个子键，用于存储通用的配置信息,

可在Excel中直接调用，格式为$parentkey.childkey， 通常在测试用例表中Params或者ParamsSetID对应的测试数据表中使用

示例：

{
    "username": $user".a_code"
}

说明:以上 user.a_account 将会从config.yml 中 parmas 下user中的a_account字段中的值（如下）

params:
  user:
    a_account: "msxXXX"
    a_code: "msxfXXX"

2. modules

在yml文件中，key指定为“modules”，用于模块配置，每个模块可以有自己的配置项

以common中的 API 模块为例，包括以下信息 class_path: 模块对应的类路径。只能为: src.modules.api.api.APIModule base_url: 模块的基础URL。例如，http://10.245.209.149:81/。 timeout: 请求超时时间（秒），可选。例如，30。 retry_attempts: 重试次数，可选。例如，3。 retry_delay: 重试间隔时间（秒），可选。例如，1.

示例：

admin_api:
  class_path: "src.modules.api.api.APIModule"
  base_url: "http://10.245.209.149:81/"
 redis_api:
  class_path: "src.modules.api.api.APIModule"
  base_url: "http://10.245.29.73:20001/"

说明：以上admin_api和redis_api均为module name，二者都是APIModule的实例， 区别是base_url不同。module name自定义，可根据配置信息不同，配置多个。Module name 对应ExcelModule”字段使用

3. logging

在yml文件中，key指定为“logging”，用于日志配置，包括日志级别、是否启用、日志格式等。

• 配置项说明
• level: 日志级别，可选值为 DEBUG, INFO, WARNING, ERROR, CRITICAL。推荐INFO，需要更多信息配置为DEBUG。默认INFO
• format: 日志格式字符串。默认值为 %(asctime)s - %(name)s - %(levelname)s - %(message)s。以下是一些常用的格式占位符：
  • • 配置项的详细说明：
    • formats: 报告的格式，可以是 html、json 等。支持多种格式，例如: ['html', 'json']
    • reportName: 报告的名称。例如： 'Automation自动化测试报告'
    • online: 在线报告配置。
      • disabled: 是否禁用在线报告。默认值为 true。如果设置为 true，则不会生成在线报告。例如： disabled: true
      • host: 在线报告主机的 IP 地址或域名。例如：'172.17.68.116'
      • port: 在线报告主机的端口。例如 8080
      • name: 在线报告的名称。例如： 'Automation自动化测试报告'

 

5. execution

在yml文件中，key指定为“execution”, 配置项用于定义自动化测试的执行策略。

• 配置项的详细说明：
• stop_on_failure: 失败时是否停止执行。
  • 类型: 布尔值。默认: false
  • 说明: 如果设置为 true，当测试用例或步骤失败时，测试执行将立即停止。如果设置为 false，即使有失败的测试用例或步骤，测试执行将继续进行。
• continue_on_step_failure: 步骤失败时是否继续执行。
  • 类型: 布尔值。默认值: true
  • 说明: 如果设置为 true，当某个测试步骤失败时，测试执行将继续进行。如果设置为 false，当某个测试步骤失败时，测试执行将停止。