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 文件。