Test Runner

🚀 Test Runner

A powerful test runner supporting multiple testing frameworks, including Flutter and Rust's cargo test. It can execute tests, analyze and report results, suitable for development, CI/CD pipelines, and GitHub Actions.

🚀 Quick Start

This test runner is a powerful tool that supports multiple testing frameworks, including Flutter and Rust's cargo test. It can not only execute tests but also analyze and report results, making it suitable for development, CI/CD pipelines, and GitHub Actions.

✨ Features

• Multi - platform Compatibility: Runs on Node.js 18.x and 20.x.
• Comprehensive Test Support: Supports Flutter, Rust, and other general commands.
• Security Features: Prevents the execution of dangerous commands, especially for general frameworks.
• Structured Output: Generates test results in JSON format and a human - readable summary.

📦 Installation

Install via npm:

npm install test-runner

💻 Usage Examples

Basic Usage

Run Flutter tests:

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

Advanced Usage

Configure security options:

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

📚 Documentation

Features

1. Test Execution
   • Supports multiple testing frameworks.
   • Automatically generates test reports.
2. Security Features
   • Prevents the execution of dangerous commands.
   • Configurable security options.
3. Flutter Test Support
   • Automatically configures environment variables.
   • Detailed error handling and output analysis.
4. Rust Test Support
   • Automatically sets debugging flags.
   • Parses test results in detail.
5. General Test Support
   • Supports arbitrary shell commands.
   • Structured output analysis.

Security Features

1. Command Validation
   • Blocks sudo and su by default.
   • Prevents dangerous operations like rm -rf /.
   • Restricts file system write locations.
2. Environment Variable Cleaning
   • Filters potentially dangerous variables.
   • Prohibits overwriting critical system variables.
   • Ensures path security.
3. Configuration Options

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

Flutter Test Support

1. Environment Configuration
   • Automatically sets PATH and PUB_CACHE.
   • Validates Flutter installation.
2. Error Handling
   • Captures stack traces and assertion failures.
   • Detailed error reports.
3. Output Handling
   • Saves the complete test output.
   • Provides structured results and raw logs.

Rust Test Support

1. Environment Configuration
   • Sets RUST_BACKTRACE = 1 to improve the readability of error messages.
2. Result Parsing
   • Analyzes the results of each test.
   • Captures detailed information about failed tests.

General Test Support

1. Automatic Output Analysis
   • Divides the output into logical blocks.
   • Identifies pass/fail indicators.
2. Flexible Integration
   • Supports arbitrary shell commands.
   • No specific format requirements.
3. Security Features
   • Prevents the execution of dangerous commands.
   • Configurable security options.

Output Format

The test runner generates structured output while retaining the complete raw logs:

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

Development Guide

Install Dependencies

Install all dependencies using npm:

npm install

Run Tests

Execute the following command to run the test suite:

npm test

CI/CD Integration

Configure in GitHub Actions:

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

Contribution Guide

Contributions are welcome! Please read CONTRIBUTING.md to learn how to participate.

📄 License

This project is licensed under the MIT License. For more information, please see the LICENSE file.