@getkist/action-test

Test harness actions for validating kist action plugins.

Features

• 🧪 Lightweight action to verify plugin loading and execution
• ⏱️ Optional delay to simulate work
• 🔄 Repeat logging to shape output
• 📊 Configurable log levels (info, warn, error)
• 💾 Write run metadata and payloads to JSON files
• ❌ Forced failure mode for testing error handling

Installation

npm install --save-dev @getkist/action-test

Quick Start

pipeline:
    stages:
        - name: test
          steps:
              - name: smoke-test
                action: TestHarnessAction
                options:
                    message: "plugin loaded successfully"

Documentation

• Usage Guide - YAML and programmatic examples
• Configuration - All available options
• Examples - Real-world test scenarios
• API Reference - Generated TypeDoc documentation
• Troubleshooting - Common issues and solutions
• Performance Guide - Tips for optimization

Actions

TestHarnessAction

Lightweight test action for validating plugin behavior.

Options:

• message (string, optional) - Log message
• shouldFail (boolean, optional) - Throw when true
• delayMs (number, optional) - Delay before finishing (ms)
• repeat (number, optional) - Repeat message N times
• logLevel (info|warn|error, optional) - Logging severity
• outputPath (string, optional) - JSON file for metadata
• payload (object, optional) - Extra data to write

Development

npm run build        # Compile TypeScript
npm run test         # Run tests
npm run lint         # Check code quality
npm run docs         # Generate API documentation
npm run format       # Format code with Prettier

License

MIT