apiAutoTest 项目使用教程

1. 项目的目录结构及介绍

apiAutoTest 项目的目录结构如下：

apiAutoTest/
├── config/
│   └── config.yaml
├── data/
│   └── test_data.xlsx
├── logs/
├── report/
├── scripts/
│   └── custom_functions.py
├── tests/
│   └── test_cases.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── run.py

目录结构介绍

• config/: 存放配置文件的目录。
• data/: 存放测试数据文件的目录。
• logs/: 存放日志文件的目录。
• report/: 存放测试报告的目录。
• scripts/: 存放自定义脚本文件的目录。
• tests/: 存放测试用例文件的目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• run.py: 项目启动文件。

2. 项目的启动文件介绍

项目的启动文件是 run.py，该文件负责启动整个测试流程。以下是 run.py 的基本内容和功能介绍：

import os
import sys
from tests.test_cases import run_tests

def main():
    # 加载配置文件
    config_path = os.path.join('config', 'config.yaml')
    # 运行测试用例
    run_tests(config_path)

if __name__ == '__main__':
    main()

启动文件功能介绍

• 加载配置文件: run.py 会读取 config/config.yaml 配置文件，以获取运行测试所需的各种配置信息。
• 运行测试用例: 调用 tests.test_cases 模块中的 run_tests 函数，执行所有测试用例。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml，该文件包含了项目运行所需的各种配置信息。以下是 config.yaml 的基本内容和功能介绍：

# 配置文件示例
database:
  host: localhost
  port: 3306
  user: root
  password: 123456
  database: test_db

email:
  server: smtp.example.com
  port: 587
  user: [e-mail]
  password: 123456
  to: [[e-mail]]

logging:
  level: INFO
  file: logs/app.log

test:
  data_file: data/test_data.xlsx
  report_dir: report

配置文件功能介绍

• database: 数据库连接配置，包括主机、端口、用户名、密码和数据库名称。
• email: 邮件发送配置，包括邮件服务器、端口、用户名、密码和收件人列表。
• logging: 日志配置，包括日志级别和日志文件路径。
• test: 测试配置，包括测试数据文件路径和测试报告目录。

以上是 apiAutoTest 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。