ApiTestEngine 项目使用教程

1. 项目目录结构及介绍

ApiTestEngine 项目的目录结构如下：

ApiTestEngine/
├── docs/
│   ├── README.md
│   └── ...
├── testcases/
│   ├── testcase1.yml
│   ├── testcase2.yml
│   └── ...
├── core/
│   ├── __init__.py
│   ├── cases.py
│   └── ...
├── config/
│   ├── config.yml
│   └── ...
├── main.py
├── requirements.txt
├── setup.py
└── README.md

目录结构介绍

• docs/: 存放项目的文档文件，包括 README.md 等。
• testcases/: 存放测试用例文件，通常以 YAML 或 JSON 格式编写。
• core/: 核心代码目录，包含测试用例执行引擎的实现。
• config/: 配置文件目录，存放项目的配置文件。
• main.py: 项目的启动文件，用于执行测试用例。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。
• setup.py: 项目的安装脚本，用于安装项目及其依赖。
• README.md: 项目的介绍文件，通常包含项目的基本信息和使用说明。

2. 项目启动文件介绍

main.py

main.py 是 ApiTestEngine 项目的启动文件，用于执行测试用例。其主要功能包括：

• 加载配置文件。
• 读取测试用例文件。
• 执行测试用例。
• 生成测试报告。

以下是 main.py 的基本结构：

import os
import sys
from core.cases import run_test
from config.config import load_config

def main():
    # 加载配置文件
    config = load_config()
    
    # 读取测试用例文件
    testcase_path = os.path.join(os.getcwd(), 'testcases')
    testcases = []
    for root, dirs, files in os.walk(testcase_path):
        for file in files:
            if file.endswith('.yml') or file.endswith('.json'):
                testcases.append(os.path.join(root, file))
    
    # 执行测试用例
    for testcase in testcases:
        result = run_test(testcase, config)
        print(result)

if __name__ == "__main__":
    main()

启动方式

可以通过以下命令启动项目：

python main.py

3. 项目配置文件介绍

config.yml

config.yml 是 ApiTestEngine 项目的配置文件，用于配置测试环境、全局变量等信息。以下是一个示例配置文件的内容：

env:
  base_url: "http://127.0.0.1:8000"
  timeout: 10

global_variables:
  token: "debugtalk"
  user_id: 12345

database:
  - name: "test_db"
    type: "mysql"
    config:
      host: "localhost"
      port: 3306
      user: "root"
      password: "123456"

配置文件介绍

• env: 配置测试环境的基本信息，如 base_url 和 timeout。
• global_variables: 定义全局变量，可以在测试用例中引用。
• database: 配置数据库连接信息，支持多个数据库连接。

配置文件加载

在 main.py 中，通过 load_config 函数加载配置文件：

from config.config import load_config

def main():
    config = load_config()
    # ...

load_config 函数会读取 config.yml 文件，并将其内容解析为 Python 字典，供测试用例执行时使用。

总结

通过本教程，您应该已经了解了 ApiTestEngine 项目的目录结构、启动文件和配置文件的基本使用方法。接下来，您可以根据项目的文档和代码进一步探索和使用 ApiTestEngine 进行接口自动化测试。