Test Runner

🚀 测试运行器 - 中文文档

这个测试运行器是一款功能强大的工具，支持多种测试框架，如 Flutter 和 Rust 的 cargo test。它不仅能执行测试，还能对测试结果进行分析和报告，适用于开发、CI/CD 管道以及 GitHub Actions 等场景。

🚀 快速开始

这个测试运行器功能丰富，支持多种测试框架，能为开发、CI/CD 等流程提供有力支持。以下是简单的安装和使用步骤。

安装

通过 npm 进行安装：

npm install test-runner

使用示例

• 运行 Flutter 测试：

npx test-runner run flutter-tester --path=test/

• 配置安全选项：

{
  "securityOptions": {
    "allowSudo": true,
    "allowShellExpansion": false
  }
}

✨ 主要特性

• 多平台兼容性：可在 Node.js 18.x 和 20.x 环境上运行。
• 全面的测试支持：支持 Flutter、Rust 以及其他通用命令。
• 安全功能：能有效防止执行危险命令，尤其是针对通用框架。
• 结构化输出：生成 JSON 格式的测试结果和人类可读的总结。

📦 安装指南

通过 npm 安装该测试运行器：

npm install test-runner

💻 使用示例

基础用法

运行 Flutter 测试：

npx test-runner run flutter-tester --path=test/

高级用法

配置安全选项：

{
  "securityOptions": {
    "allowSudo": true,
    "allowShellExpansion": false
  }
}

📚 详细文档

特性

1. 测试执行
   • 支持多种测试框架。
   • 自动生成测试报告。
2. 安全特性
   • 防止危险命令的执行。
   • 可配置的安全选项。
3. Flutter 测试支持
   • 自动配置环境变量。
   • 详细的错误处理和输出分析。
4. Rust 测试支持
   • 自动设置调试标志。
   • 详细解析测试结果。
5. 通用测试支持
   • 支持任意 shell 命令。
   • 输出结构化分析。

安全功能

1. 命令验证
   • 默认阻止 sudo 和 su。
   • 防止危险操作如 rm -rf /。
   • 限制文件系统写入位置。
2. 环境变量清理
   • 过滤潜在危险的变量。
   • 禁止覆盖关键系统变量。
   • 确保路径安全。
3. 配置选项

{
  "securityOptions": {
    "allowSudo": false,
    "allowSu": false,
    "allowShellExpansion": true,
    "allowPipeToFile": false
  }
}

Flutter 测试支持

1. 环境配置
   • 自动设置 PATH 和 PUB_CACHE。
   • 验证 Flutter 安装。
2. 错误处理
   • 捕获堆栈跟踪和断言失败。
   • 详细错误报告。
3. 输出处理
   • 保存完整测试输出。
   • 提供结构化结果和原始日志。

Rust 测试支持

1. 环境配置
   • 设置 RUST_BACKTRACE=1 以提高错误消息的可读性。
2. 结果解析
   • 分析每个测试的结果。
   • 捕获失败测试的详细信息。

通用测试支持

1. 自动输出分析
   • 将输出划分为逻辑块。
   • 识别通过/失败指示。
2. 灵活集成
   • 支持任意 shell 命令。
   • 非特定格式要求。
3. 安全特性
   • 防止危险命令执行。
   • 可配置的安全选项。

输出格式

测试运行器生成结构化的输出，同时保留完整的原始日志：

{
  "status": "success",
  "tests": {
    "passed": 10,
    "failed": 2,
    "total": 12
  }
}

开发指南

安装依赖

使用 npm 安装所有依赖项：

npm install

运行测试

执行以下命令运行测试套件：

npm test

CI/CD 集成

在 GitHub Actions 中进行配置：

steps:
  - name: Run tests
    run: npx test-runner run --config=test-config.json

🔧 技术细节

测试运行器生成的输出包含结构化信息和完整的原始日志，示例如下：

{
  "status": "success",
  "tests": {
    "passed": 10,
    "failed": 2,
    "total": 12
  }
}

🤝 贡献指南

欢迎贡献代码！请阅读 CONTRIBUTING.md 了解如何参与。

📄 许可证

项目遵循 MIT 许可证。更多信息请查看 LICENSE 文件。