Test Runner

🚀 テストランナー - 日本語ドキュメント

このテストランナーは、FlutterやRustの cargo test を含む複数のテストフレームワークをサポートする強力なツールです。テストの実行だけでなく、結果の分析とレポートも行え、開発、CI/CDパイプライン、GitHub Actionsでの使用に最適です。

🚀 クイックスタート

このテストランナーは、多様なテストフレームワークをサポートし、テストの実行から結果の分析、レポートまでを行うことができます。Node.js 18.x と 20.x で動作し、開発やCI/CDパイプライン、GitHub Actionsでの利用に便利です。

✨ 主な機能

• 多プラットフォーム互換性：Node.js 18.x と 20.x で動作します。
• 包括的なテストサポート：Flutter、Rust、その他の汎用コマンドをサポートします。
• セキュリティ機能：特に汎用フレームワークに対して、危険なコマンドの実行を防止します。
• 構造化出力：JSON形式のテスト結果と人間が読みやすい要約を生成します。

📦 インストール

npm を使用してインストールします。

npm install test-runner

💻 使用例

基本的な使用法

Flutter テストを実行するには、以下のコマンドを使用します。

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

高度な使用法

セキュリティオプションを設定するには、以下のような JSON ファイルを作成します。

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

📚 ドキュメント

機能

1. テスト実行

   • 複数のテストフレームワークをサポートします。
   • テストレポートを自動生成します。

2. セキュリティ機能

   • 危険なコマンドの実行を防止します。
   • 設定可能なセキュリティオプションがあります。

3. Flutter テストサポート

   • 環境変数を自動的に設定します。
   • 詳細なエラー処理と出力分析を行います。

4. Rust テストサポート

   • デバッグフラグを自動的に設定します。
   • テスト結果を詳細に解析します。

5. 汎用テストサポート

   • 任意のシェルコマンドをサポートします。
   • 出力の構造化分析を行います。

セキュリティ機能

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. 柔軟な統合

   • 任意のシェルコマンドをサポートします。
   • 特定の形式を必要としません。

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

🤝 コントリビューションガイド

コードの貢献を歓迎します！詳細は CONTRIBUTING.md をご覧ください。

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細は LICENSE ファイルを参照してください。