# WebTestRunner

**Repository Path**: Hellchin/web-test-runner

## Basic Information

- **Project Name**: WebTestRunner
- **Description**: WebTestRunner：专注于Web应用测试的开源项目，提供高效、易用的测试工具，支持多种浏览器和环境配置，助力开发者快速构建自动化测试方案。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-23
- **Last Updated**: 2025-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web Test Runner

Web Test Runner 是一个基于 Playwright 的 Web 自动化测试框架，提供高效、易用的测试工具，支持多种浏览器和环境配置。

## 特性

- 支持多种浏览器（Chromium/Firefox/WebKit）
- 支持多环境配置
- 内置等待和断言机制
- 支持参数化测试
- 支持测试报告生成
- 支持日志记录
- 易于扩展的插件系统
- **中文别名支持**：支持使用中文别名调用方法和函数
- **智能元素定位**：支持多种定位策略和智能等待
- **多页面管理**：支持多标签页和iframe操作

## 项目结构

```
web-test-runner/
├── docs/                     # 项目文档
│   ├── api/                 # API文档
│   ├── examples/           # 使用示例
│   └── guide/              # 使用指南
├── src/                     # 源代码目录
│   └── framework/          # 框架核心
├── tests/                   # 测试目录
│   ├── cases/              # 测试用例
│   ├── data/              # 测试数据
│   ├── reports/           # 测试报告
│   └── resources/         # 测试资源
├── examples/               # 示例代码
├── config/                # 配置文件目录
└── requirements.txt      # 依赖包列表
```

## 快速开始

### 安装

1. 克隆项目：
```bash
git clone https://your-repository/web-test-runner.git
cd web-test-runner
```

2. 创建虚拟环境（推荐）：
```bash
python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\\Scripts\\activate   # Windows
```

3. 安装依赖：
```bash
pip install -r requirements.txt
```

4. 安装浏览器：
```bash
playwright install
```

### 运行示例

运行简单的登录测试示例：
```bash
python examples/basic/simple_login_test.py
```

或者使用命令行工具运行：
```bash
python run.py -e dev -t tests/cases/login/test_login.py
```

## 配置说明

配置文件位于 `config` 目录：

- `default.json`：默认配置
- `env/dev.json`：开发环境配置
- `env/test.json`：测试环境配置
- `env/prod.json`：生产环境配置

示例配置：
```json
{
    "is_debug": true,
    "browser_type": "chromium",
    "host": "127.0.0.1:9222",
    "global_variable": {
        "username": "test_user",
        "password": "test_password"
    }
}
```

## 核心功能

### 中文别名系统

框架支持使用中文别名调用方法和函数：

```python
@KeyWordManage.chinese_alias_of_function("加法1")
def add1(a, b):
    return a + b

# 使用中文别名调用
calc.加法1(2, 3)  # 返回5
```

类方法也支持中文别名：

```python
class Calculator(metaclass=ChineseAliasMeta):
    @KeyWordManage.chinese_alias("加法")
    def add(self, a, b):
        return a + b

# 使用中文别名调用
calc = Calculator()
calc.加法(2, 3)  # 返回5
```

## 编写测试用例

测试用例使用 Python 字典格式定义，包含测试套件（suite）和测试用例（case）：

```python
suite_data = {
    'id': "TS_LOGIN_001",
    'name': "登录功能测试套件",
    'setup_step': [
        {
            "desc": "打开浏览器",
            "method": "open_browser",
            "params": {
                "browser_type": "chromium"
            }
        }
    ],
    "cases": [
        {
            'id': "TC_LOGIN_001",
            'name': "正确用户名密码登录",
            "steps": [
                {
                    "desc": "输入用户名",
                    "method": "fill_value",
                    "params": {
                        "locator": "//input[@id='username']",
                        "value": "${{username}}"
                    }
                }
            ]
        }
    ]
}
```

## 命令行工具

```bash
python run.py [-h] [-e ENV] [-t TEST] [-r]

参数说明：
  -h, --help            显示帮助信息
  -e ENV, --env ENV     环境配置(default/dev/test/prod)
  -t TEST, --test TEST  测试用例文件或目录
  -r, --report         生成测试报告
```

## API参考

详细API文档请参考：[核心API参考](docs/api/core_api.md)

## 贡献指南

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request

## 许可证

本项目基于 MIT 许可证开源 - 查看 [LICENSE](LICENSE) 文件了解更多细节