@testsmith/perfornium 0.1.0

package/README.md

@@ -0,0 +1,360 @@
+# Perfornium
+
+> A powerful, flexible, and easy-to-use performance testing framework for REST APIs, SOAP services, and web applications.
+
+[![npm version](https://img.shields.io/npm/v/@testsmith/perfornium.svg)](https://www.npmjs.com/package/@testsmith/perfornium)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
+[![CI](https://github.com/testsmith-io/perfornium/actions/workflows/ci.yml/badge.svg)](https://github.com/testsmith-io/perfornium/actions/workflows/ci.yml)
+
+## ✨ Features
+
+- 🚀 **Easy to Use** - Simple YAML syntax or powerful TypeScript DSL
+- 🔧 **Highly Extensible** - Plugin architecture for protocols and outputs
+- 🌐 **Multi-Protocol** - REST, SOAP, and Web (Playwright) support
+- 📊 **Rich Reporting** - JSON, CSV, InfluxDB, Graphite, HTML reports
+- ⚡ **High Performance** - Efficient load generation with virtual users
+- 🎯 **Flexible Load Patterns** - Basic, stepping, arrivals, and custom patterns
+- 📈 **Real-time Metrics** - Monitor performance as tests run
+- 🔄 **Data-Driven** - CSV data support for realistic test scenarios
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Global installation
+npm install -g @testsmith/perfornium
+
+# Or as a project dependency
+npm install --save-dev @testsmith/perfornium
+```
+
+### Your First Test (YAML)
+
+Create a file `my-test.yml`:
+
+```yaml
+name: "Simple API Test"
+global:
+  base_url: "https://jsonplaceholder.typicode.com"
+
+load:
+  pattern: "basic"
+  virtual_users: 10
+  duration: "1m"
+
+scenarios:
+  - name: "get_posts"
+    steps:
+      - method: "GET"
+        path: "/posts"
+        checks:
+          - type: "status"
+            value: 200
+
+outputs:
+  - type: "json"
+    file: "results.json"
+
+report:
+  generate: true
+  output: "report.html"
+```
+
+Run it:
+
+```bash
+perfornium run my-test.yml
+```
+
+### Your First Test (TypeScript)
+
+```typescript
+import { test } from '@testsmith/perfornium/dsl';
+
+test('API Test')
+  .baseUrl('https://jsonplaceholder.typicode.com')
+  .scenario('Get Posts', 100)
+    .get('/posts')
+      .check('status', 200)
+      .done()
+  .withLoad({ pattern: 'basic', virtual_users: 10, duration: '1m' })
+  .run();
+```
+
+## 📖 Documentation
+
+Full documentation is available at [https://testsmith-io.github.io/perfornium](https://testsmith-io.github.io/perfornium)
+
+- [Quick Start](https://testsmith-io.github.io/perfornium/#/quick-start) - Get started in minutes
+- [Configuration Guide](https://testsmith-io.github.io/perfornium/#/config/yaml) - YAML and TypeScript configuration
+- [Load Patterns](https://testsmith-io.github.io/perfornium/#/load-patterns/basic) - Basic, stepping, and arrival patterns
+- [Examples](https://testsmith-io.github.io/perfornium/#/examples/rest-basic) - Real-world examples
+
+## 🎯 Use Cases
+
+### REST API Testing
+
+Test any REST API with support for:
+- All HTTP methods (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS)
+- Authentication (Basic, Bearer, OAuth, Digest)
+- All payload types (JSON, XML, Form, Multipart)
+- Query parameters and custom headers
+- Response validation and data extraction
+
+```yaml
+steps:
+  - method: "POST"
+    path: "/api/users"
+    auth:
+      type: "bearer"
+      token: "your-token"
+    json:
+      name: "John Doe"
+      email: "john@example.com"
+    checks:
+      - type: "status"
+        value: 201
+    extract:
+      - name: "user_id"
+        type: "json_path"
+        expression: "$.id"
+```
+
+### Web Application Testing
+
+Test web applications with Playwright:
+
+```yaml
+global:
+  web:
+    type: "chromium"
+    headless: true
+    base_url: "https://example.com"
+
+scenarios:
+  - name: "user_journey"
+    steps:
+      - type: "web"
+        action:
+          command: "goto"
+          url: "/"
+      - type: "web"
+        action:
+          command: "fill"
+          selector: "#email"
+          value: "test@example.com"
+      - type: "web"
+        action:
+          command: "click"
+          selector: "#submit"
+```
+
+### SOAP Service Testing
+
+```yaml
+global:
+  wsdl_url: "http://example.com/service?WSDL"
+
+scenarios:
+  - name: "soap_test"
+    steps:
+      - type: "soap"
+        operation: "GetUser"
+        args:
+          userId: 123
+```
+
+## 🎨 Load Patterns
+
+### Basic Pattern
+Fixed number of virtual users for a duration:
+
+```yaml
+load:
+  pattern: "basic"
+  virtual_users: 50
+  ramp_up: "30s"
+  duration: "5m"
+```
+
+### Stepping Pattern
+Gradually increase load:
+
+```yaml
+load:
+  pattern: "stepping"
+  steps:
+    - users: 10
+      duration: "2m"
+    - users: 25
+      duration: "3m"
+    - users: 50
+      duration: "5m"
+```
+
+### Arrivals Pattern
+Constant arrival rate:
+
+```yaml
+load:
+  pattern: "arrivals"
+  rate: 10  # users per second
+  duration: "5m"
+```
+
+### Multiple Profiles
+Run different patterns concurrently:
+
+```yaml
+load:
+  pattern: "mixed"
+  profiles:
+    - name: "readers"
+      pattern: "basic"
+      virtual_users: 100
+      scenarios: ["read_data"]
+    - name: "writers"
+      pattern: "stepping"
+      scenarios: ["write_data"]
+```
+
+## 📊 Outputs and Reporting
+
+Perfornium supports multiple output formats:
+
+```yaml
+outputs:
+  # Raw metrics
+  - type: "csv"
+    file: "results/metrics.csv"
+
+  # Structured results
+  - type: "json"
+    file: "results/results.json"
+
+  # Time-series databases
+  - type: "influxdb"
+    url: "http://localhost:8086"
+    database: "perfornium"
+
+  # Metrics backends
+  - type: "graphite"
+    url: "localhost:2003"
+
+  # Webhooks
+  - type: "webhook"
+    url: "https://example.com/webhook"
+
+# Beautiful HTML reports
+report:
+  generate: true
+  output: "results/report.html"
+```
+
+## 💡 TypeScript DSL
+
+For complex tests, use the TypeScript DSL:
+
+```typescript
+import { test, load, testData } from '@testsmith/perfornium/dsl';
+
+const config = test('E-Commerce Test')
+  .description('User shopping journey')
+  .baseUrl('https://api.shop.com')
+  .variables({ environment: 'staging' })
+
+  .withLoad({
+    pattern: 'stepping',
+    duration: '10m',
+    steps: [
+      { users: 10, duration: '3m' },
+      { users: 25, duration: '4m' },
+      { users: 50, duration: '3m' }
+    ]
+  })
+
+  .scenario('Shopping Flow', 100)
+    .beforeScenario(async (context) => {
+      context.variables.userId = testData.uuid();
+    })
+
+    .get('/products')
+      .check('status', 200)
+      .extract('product_id', '$.products[0].id')
+
+    .post('/cart', {
+      product_id: '{{product_id}}',
+      quantity: 1
+    })
+      .withBearerToken('{{auth_token}}')
+      .check('status', 201)
+
+    .done()
+
+  .withJSONOutput('results/shopping.json')
+  .withReport('results/shopping-report.html')
+
+  .build();
+
+// Run it
+import { TestRunner } from '@testsmith/perfornium';
+await new TestRunner(config).run();
+```
+
+## 🛠️ CLI Commands
+
+```bash
+# Run a test
+perfornium run test.yml
+
+# Validate configuration
+perfornium validate test.yml
+
+# Run distributed test
+perfornium distributed --config test.yml --workers 4
+
+# Generate report from results
+perfornium report --results results.json --output report.html
+```
+
+## 🏗️ Architecture
+
+```
+perfornium/
+├── src/
+│   ├── protocols/      # Protocol handlers (REST, SOAP, Web)
+│   ├── load-patterns/  # Load generation patterns
+│   ├── core/           # Test runner and execution engine
+│   ├── outputs/        # Output handlers
+│   ├── reporting/      # HTML report generation
+│   ├── dsl/            # TypeScript DSL
+│   └── config/         # Configuration types
+│
+├── examples/           # Example configurations
+├── tmp/test-project/   # Sample test project
+└── docs/              # Documentation
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📝 License
+
+MIT
+
+## 🙏 Acknowledgments
+
+Built with:
+- [Axios](https://axios-http.com/) - HTTP client
+- [Playwright](https://playwright.dev/) - Web testing
+- [Commander](https://github.com/tj/commander.js) - CLI framework
+- [Handlebars](https://handlebarsjs.com/) - Templating
+
+---
+
+**Happy Load Testing!** 🚀
+
+For more information, see the [documentation](https://testsmith-io.github.io/perfornium).

package/dist/cli/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/cli.js

@@ -0,0 +1,192 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const run_1 = require("./commands/run");
+const validate_1 = require("./commands/validate");
+const report_1 = require("./commands/report");
+const worker_1 = require("./commands/worker");
+const init_1 = require("./commands/init");
+const mock_1 = require("./commands/mock");
+const native_recorder_1 = require("../recorder/native-recorder");
+const distributed_1 = require("./commands/distributed");
+// Add new import commands
+const import_1 = require("./commands/import");
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const packageJson = require('../../package.json');
+const program = new commander_1.Command();
+program
+    .name('perfornium')
+    .description(packageJson.description)
+    .version(packageJson.version);
+program
+    .command('run')
+    .description('Run a performance test')
+    .argument('<config>', 'Test configuration file')
+    .option('-e, --env <environment>', 'Environment configuration')
+    .option('-w, --workers <workers>', 'Comma-separated list of worker addresses')
+    .option('-o, --output <directory>', 'Output directory for results')
+    .option('-r, --report', 'Generate HTML report after test')
+    .option('--dry-run', 'Validate configuration without running test')
+    .option('-v, --verbose', 'Enable verbose logging (info level)')
+    .option('-d, --debug', 'Enable debug logging (very detailed)')
+    .option('--max-users <number>', 'Maximum virtual users override')
+    .option('-g, --global <key=value>', 'Override global config (supports dot notation: browser.headless=false)', collectGlobals, [])
+    .action(run_1.runCommand);
+// Helper function to collect --global options
+function collectGlobals(value, previous) {
+    previous.push(value);
+    return previous;
+}
+program
+    .command('distributed')
+    .description('Run a distributed performance test across multiple workers')
+    .argument('<config>', 'Test configuration file')
+    .option('-e, --env <environment>', 'Environment configuration')
+    .option('-w, --workers <workers>', 'Comma-separated list of worker addresses (host:port)')
+    .option('--workers-file <file>', 'JSON file containing worker configurations')
+    .option('-s, --strategy <strategy>', 'Load distribution strategy (even|capacity_based|round_robin|geographic)', 'capacity_based')
+    .option('--sync-start', 'Synchronize test start across all workers')
+    .option('-o, --output <directory>', 'Output directory for results')
+    .option('-r, --report', 'Generate HTML report after test')
+    .option('-v, --verbose', 'Enable verbose logging (info level)')
+    .option('-d, --debug', 'Enable debug logging (very detailed)')
+    .action(distributed_1.distributedCommand);
+program
+    .command('validate')
+    .description('Validate test configuration')
+    .argument('<config>', 'Test configuration file')
+    .option('-e, --env <environment>', 'Environment configuration')
+    .action(validate_1.validateCommand);
+program
+    .command('report')
+    .description('Generate HTML report from results')
+    .argument('<results>', 'Results file (JSON or CSV)')
+    .option('-o, --output <file>', 'Output HTML file', 'report.html')
+    .option('-t, --template <template>', 'Custom report template')
+    .option('--title <title>', 'Custom report title')
+    .action(report_1.reportCommand);
+// ============================================
+// Record Command
+// ============================================
+program
+    .command('record')
+    .description('Record web interactions for test creation (Ctrl+W to add wait points)')
+    .argument('<url>', 'Starting URL for recording')
+    .option('-o, --output <file>', 'Output file for recorded scenario')
+    .option('--viewport <viewport>', 'Browser viewport size (e.g., 1920x1080)')
+    .option('--base-url <url>', 'Base URL to relativize recorded URLs')
+    .option('-f, --format <format>', 'Output format: yaml, json, or typescript', 'yaml')
+    .action(async (url, options) => {
+    // Auto-determine file extension if output not specified
+    // Save to tests/web directory by default
+    if (!options.output) {
+        const extensions = {
+            yaml: 'tests/web/recorded-scenario.yml',
+            json: 'tests/web/recorded-scenario.json',
+            typescript: 'tests/web/recorded-scenario.spec.ts'
+        };
+        options.output = extensions[options.format] || 'tests/web/recorded-scenario.yml';
+    }
+    await (0, native_recorder_1.startNativeRecording)(url, {
+        output: options.output,
+        format: options.format,
+        viewport: options.viewport,
+        baseUrl: options.baseUrl
+    });
+});
+// ============================================
+// Import Commands
+// ============================================
+const importCmd = program
+    .command('import <type>')
+    .description('Import API definitions to generate test scenarios')
+    .argument('<source>', 'Source file to import');
+// Common import options
+const addImportOptions = (cmd) => {
+    return cmd
+        .option('-o, --output <dir>', 'Output directory', './tests')
+        .option('-f, --format <format>', 'Output format: yaml, json, or typescript', 'yaml')
+        .option('-i, --interactive', 'Interactive mode for selecting endpoints')
+        .option('--auto-correlate', 'Automatically detect and apply data correlations')
+        .option('--base-url <url>', 'Override base URL from specification')
+        .option('--scenarios-per-file <n>', 'Number of scenarios per output file', '10')
+        .option('-v, --verbose', 'Verbose output with detailed information');
+};
+// OpenAPI import
+addImportOptions(importCmd
+    .command('openapi <file>')
+    .description('Import from OpenAPI/Swagger specification')
+    .option('--tags <tags>', 'Filter by tags (comma-separated)')
+    .option('--exclude-tags <tags>', 'Exclude specific tags (comma-separated)')
+    .option('--paths <patterns>', 'Filter by path patterns (comma-separated regex)')
+    .option('--methods <methods>', 'Filter by HTTP methods (comma-separated)')).action(async (file, options) => {
+    await (0, import_1.importCommand)('openapi', file, options);
+});
+// WSDL import
+addImportOptions(importCmd
+    .command('wsdl <file>')
+    .description('Import from WSDL file')
+    .option('--services <names>', 'Filter by service names (comma-separated)')
+    .option('--operations <names>', 'Filter by operation names (comma-separated)')
+    .option('--soap-version <version>', 'SOAP version: 1.1, 1.2, or both', 'both')).action(async (file, options) => {
+    await (0, import_1.importCommand)('wsdl', file, options);
+});
+// HAR import
+addImportOptions(importCmd
+    .command('har <file>')
+    .description('Import from HAR (HTTP Archive) file')
+    .option('--filter-domains <domains>', 'Include specific domains (comma-separated)')
+    .option('--exclude-domains <domains>', 'Exclude specific domains (comma-separated)')
+    .option('--methods <methods>', 'Filter by HTTP methods (comma-separated)')
+    .option('--skip-static', 'Skip static resources (images, CSS, JS)', true)).action(async (file, options) => {
+    await (0, import_1.importCommand)('har', file, options);
+});
+// importCmd
+//     .command('postman')
+//     .description('Import test scenarios from Postman collection')
+//     .argument('<collection-file>', 'Postman collection file (JSON)')
+//     .option('-o, --output <directory>', 'Output directory for generated tests', './tests')
+//     .option('-f, --format <format>', 'Output format (yaml|json)', 'yaml')
+//     .option('--environment <env-file>', 'Postman environment file')
+//     .option('--folders <folders>', 'Comma-separated list of folder names to include')
+//     .option('--auto-correlate', 'Automatically detect and apply data correlations', true)
+//     .option('--interactive', 'Interactive request selection', true)
+//     .option('-v, --verbose', 'Enable verbose logging')
+//     .action((collectionFile, options) => importCommand('postman', collectionFile, options));
+// NEW: Correlate command
+// program
+//     .command('correlate')
+//     .description('Analyze and apply data correlations to existing test configuration')
+//     .argument('<config-file>', 'Test configuration file to analyze')
+//     .option('-o, --output <file>', 'Output file for correlated configuration')
+//     .option('--report <file>', 'Generate correlation analysis report')
+//     .option('--auto-apply', 'Automatically apply detected correlations', true)
+//     .option('--confidence <threshold>', 'Minimum confidence threshold (0-1)', '0.6')
+//     .option('--interactive', 'Interactive correlation review and selection')
+//     .option('--patterns <file>', 'Custom correlation patterns file')
+//     .option('-v, --verbose', 'Enable verbose logging')
+//     .action(correlateCommand);
+program
+    .command('worker')
+    .description('Start a worker node for distributed testing')
+    .option('-p, --port <port>', 'Port to listen on', '8080')
+    .option('--host <host>', 'Host to bind to', 'localhost')
+    .action(worker_1.workerCommand);
+program
+    .command('init')
+    .description('Initialize a new test project')
+    .argument('[directory]', 'Project directory', '.')
+    .option('-t, --template <template>', 'Project template (basic|api|web|mixed)', 'basic')
+    .option('--examples', 'Include example test configurations')
+    .option('-f, --force', 'Overwrite existing project files')
+    .option('--dry-run', 'Preview files without creating them')
+    .action(init_1.initCommand);
+program
+    .command('mock')
+    .description('Start a mock API server for testing')
+    .option('-p, --port <port>', 'Port to listen on', '3000')
+    .option('--host <host>', 'Host to bind to', 'localhost')
+    .option('-d, --delay <ms>', 'Add delay to all responses (ms)', '0')
+    .action(mock_1.mockCommand);
+program.parse();

package/dist/cli/commands/distributed.d.ts

@@ -0,0 +1,11 @@
+export declare function distributedCommand(configPath: string, options: {
+    workers?: string;
+    workersFile?: string;
+    strategy?: string;
+    syncStart?: boolean;
+    env?: string;
+    output?: string;
+    report?: boolean;
+    verbose?: boolean;
+    debug?: boolean;
+}): Promise<void>;