@edgetesting/jmeter 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# @edgetesting/jmeter
+
+CLI wrapper that uploads JMeter `.jtl` result files to [EdgeTesting](https://edgetesting.io), evaluates SLA thresholds, and automatically creates Jira bug reports on violations.
+
+## Requirements
+
+- Node.js 18+
+- Apache JMeter (for running tests)
+- An EdgeTesting workspace with an API key
+
+## Installation
+
+```bash
+npm install -g @edgetesting/jmeter
+
+# Or use without installing
+npx @edgetesting/jmeter --help
+```
+
+## Quick start
+
+```bash
+# 1. Run your JMeter test
+jmeter -n -t my-test-plan.jmx -l results.jtl
+
+# 2. Upload results with a 500ms SLA
+npx edgetesting-jmeter --file results.jtl --id TC-100 --sla 500
+```
+
+## Options
+
+| Flag | Required | Description |
+|---|---|---|
+| `--file <path>` | yes | Path to the `.jtl` file (CSV or XML) |
+| `--id <automation_id>` | yes | EdgeTesting automation ID, e.g. `TC-100` |
+| `--sla <ms>` | no | Latency SLA in ms — bug created if avg or P95 exceeds this |
+| `--sla-error-pct <n>` | no | Error rate SLA — bug created if error % exceeds this |
+| `--issue <jira_key>` | no | Override the Jira issue key on the test case |
+| `--api-key <key>` | no | API key (or set `EDGETESTING_API_KEY`) |
+| `--api-url <url>` | no | Base URL (or set `EDGETESTING_API_URL`) |
+| `--dry-run` | no | Parse and print metrics locally, no upload |
+
+## Environment variables
+
+```bash
+EDGETESTING_API_KEY=et_xxxx
+EDGETESTING_API_URL=https://your-edgetesting-instance.com
+```
+
+## Metrics extracted
+
+- Average latency (ms)
+- P95 and P99 latency (ms)
+- Min / Max latency
+- Throughput (requests/sec)
+- Error percentage
+- Per-endpoint breakdown
+
+## SLA violations
+
+When a threshold is breached the CLI:
+- Creates a Bug Report in EdgeTesting
+- Posts a Markdown metrics table as a Jira comment
+- Exits with code `1` to fail your CI build
+
+Severity is derived automatically based on how far the result exceeds the threshold.
+
+## Supported .jtl formats
+
+- **CSV** — default JMeter output (`timeStamp,elapsed,label,success,Latency,...`)
+- **XML** — standard JMeter XML with `<httpSample>` / `<sample>` elements
+
+## License
+
+MIT

package/bin/edgetesting-jmeter.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict';
+
+require('../src/index.js');

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@edgetesting/jmeter",
+  "version": "1.0.0",
+  "description": "CLI wrapper to upload JMeter .jtl results to EdgeTesting, evaluate SLA thresholds, and auto-create Jira bug reports on violations",
+  "bin": {
+    "edgetesting-jmeter": "./bin/edgetesting-jmeter.js"
+  },
+  "main": "./src/index.js",
+  "type": "commonjs",
+  "files": [
+    "bin",
+    "src",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "prepublishOnly": "node --check src/index.js && node --check bin/edgetesting-jmeter.js && echo 'Syntax OK'"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "form-data": "^4.0.0",
+    "node-fetch": "^2.7.0"
+  },
+  "keywords": [
+    "jmeter",
+    "performance",
+    "load-testing",
+    "edgetesting",
+    "qa",
+    "sla",
+    "jira",
+    "cli"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edgetesting/jmeter"
+  },
+  "homepage": "https://edgetesting.io",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.js

@@ -0,0 +1,275 @@
+#!/usr/bin/env node
+'use strict';
+
+const { program } = require('commander');
+const FormData    = require('form-data');
+const fetch       = require('node-fetch');
+const fs          = require('fs');
+const path        = require('path');
+
+// ── Banner ────────────────────────────────────────────────────────────────────
+const RESET  = '\x1b[0m';
+const BOLD   = '\x1b[1m';
+const GREEN  = '\x1b[32m';
+const RED    = '\x1b[31m';
+const YELLOW = '\x1b[33m';
+const CYAN   = '\x1b[36m';
+const DIM    = '\x1b[2m';
+
+function log(msg)        { console.log(msg); }
+function ok(msg)         { console.log(`${GREEN}✔${RESET}  ${msg}`); }
+function fail(msg)       { console.error(`${RED}✘${RESET}  ${msg}`); }
+function warn(msg)       { console.warn(`${YELLOW}⚠${RESET}  ${msg}`); }
+function info(msg)       { console.log(`${CYAN}ℹ${RESET}  ${msg}`); }
+function dim(msg)        { console.log(`${DIM}${msg}${RESET}`); }
+function bold(msg)       { return `${BOLD}${msg}${RESET}`; }
+
+function printBanner() {
+  log('');
+  log(`${BOLD}${CYAN}  EdgeTesting JMeter${RESET}`);
+  log(`${DIM}  Performance results uploader & SLA evaluator${RESET}`);
+  log('');
+}
+
+// ── CLI definition ────────────────────────────────────────────────────────────
+program
+  .name('edgetesting-jmeter')
+  .description('Upload a JMeter .jtl results file to EdgeTesting and evaluate SLA thresholds.')
+  .version('1.0.0')
+  .requiredOption(
+    '-f, --file <path>',
+    'Path to the JMeter .jtl results file (CSV or XML)'
+  )
+  .requiredOption(
+    '-i, --id <automation_id>',
+    'EdgeTesting automation ID of the test case (e.g. TC-100)'
+  )
+  .option(
+    '--sla <ms>',
+    'Latency SLA in milliseconds. Triggers a bug report if avg or P95 exceeds this value.',
+    (v) => parseInt(v, 10)
+  )
+  .option(
+    '--sla-error-pct <pct>',
+    'Error rate SLA as a percentage (e.g. 1.0 = fail if >1% errors).',
+    (v) => parseFloat(v)
+  )
+  .option(
+    '--issue <jira_issue_key>',
+    'Override the Jira issue key stored on the test case (e.g. PROJ-42)'
+  )
+  .option(
+    '--api-key <key>',
+    'EdgeTesting API key. Defaults to EDGETESTING_API_KEY env var.'
+  )
+  .option(
+    '--api-url <url>',
+    'EdgeTesting base URL. Defaults to EDGETESTING_API_URL env var.'
+  )
+  .option(
+    '--dry-run',
+    'Parse the .jtl file and print metrics without uploading to EdgeTesting.'
+  );
+
+program.parse(process.argv);
+const opts = program.opts();
+
+// ── Main ──────────────────────────────────────────────────────────────────────
+(async () => {
+  printBanner();
+
+  // ── Resolve config from opts → env vars ─────────────────────────────────
+  const apiKey = opts.apiKey || process.env.EDGETESTING_API_KEY || '';
+  const apiUrl = (opts.apiUrl || process.env.EDGETESTING_API_URL || '')
+    .replace(/\/api\/v1\/?$/, '')
+    .replace(/\/$/, '');
+
+  const jtlPath      = path.resolve(opts.file);
+  const automationId = opts.id;
+  const slaMs        = opts.sla        ?? null;
+  const slaErrPct    = opts.slaErrorPct ?? null;
+  const issueKey     = opts.issue       ?? null;
+  const isDryRun     = opts.dryRun      ?? false;
+
+  // ── Validate file ────────────────────────────────────────────────────────
+  if (!fs.existsSync(jtlPath)) {
+    fail(`File not found: ${jtlPath}`);
+    process.exit(1);
+  }
+
+  const stat    = fs.statSync(jtlPath);
+  const sizeMb  = (stat.size / 1024 / 1024).toFixed(2);
+
+  info(`File:          ${bold(jtlPath)}`);
+  info(`Size:          ${sizeMb} MB`);
+  info(`Automation ID: ${bold(automationId)}`);
+  if (slaMs)     info(`SLA Latency:   ${bold(slaMs + 'ms')}`);
+  if (slaErrPct) info(`SLA Errors:    ${bold(slaErrPct + '%')}`);
+  if (issueKey)  info(`Jira Issue:    ${bold(issueKey)}`);
+  log('');
+
+  // ── Dry run — parse locally and exit ────────────────────────────────────
+  if (isDryRun) {
+    warn('Dry run mode — parsing locally, not uploading.');
+    try {
+      const metrics = await parseLocally(jtlPath);
+      printMetrics(metrics, slaMs, slaErrPct);
+    } catch (err) {
+      fail('Parse error: ' + err.message);
+      process.exit(1);
+    }
+    return;
+  }
+
+  // ── Validate credentials ─────────────────────────────────────────────────
+  if (!apiKey) {
+    fail('No API key. Set EDGETESTING_API_KEY or pass --api-key.');
+    process.exit(1);
+  }
+  if (!apiUrl) {
+    fail('No API URL. Set EDGETESTING_API_URL or pass --api-url.');
+    process.exit(1);
+  }
+
+  // ── Upload ───────────────────────────────────────────────────────────────
+  info(`Uploading to:  ${apiUrl}/api/v1/performance-executions`);
+  log('');
+
+  const form = new FormData();
+  form.append('file',          fs.createReadStream(jtlPath), path.basename(jtlPath));
+  form.append('automation_id', automationId);
+  if (slaMs     !== null) form.append('sla_latency_ms',       String(slaMs));
+  if (slaErrPct !== null) form.append('sla_error_percentage', String(slaErrPct));
+  if (issueKey)           form.append('jira_issue_key',       issueKey);
+
+  let response;
+  try {
+    response = await fetch(`${apiUrl}/api/v1/performance-executions`, {
+      method:  'POST',
+      headers: {
+        Authorization: `Bearer ${apiKey}`,
+        ...form.getHeaders(),
+      },
+      body: form,
+    });
+  } catch (err) {
+    fail('Network error: ' + err.message);
+    process.exit(1);
+  }
+
+  let body;
+  try {
+    body = await response.json();
+  } catch {
+    const text = await response.text().catch(() => '');
+    fail(`HTTP ${response.status} — unexpected response: ${text.slice(0, 200)}`);
+    process.exit(1);
+  }
+
+  if (!response.ok) {
+    fail(`HTTP ${response.status}: ${body.error || body.message || JSON.stringify(body)}`);
+    process.exit(1);
+  }
+
+  // ── Results ──────────────────────────────────────────────────────────────
+  printMetrics(body.metrics, slaMs, slaErrPct);
+
+  log('');
+  log(`  ${bold('Execution ID:')}  ${body.execution_id}`);
+  log(`  ${bold('Status:')}        ${body.status === 'passed' ? GREEN + 'PASSED' + RESET : RED + 'FAILED' + RESET}`);
+
+  if (body.sla_violated) {
+    log('');
+    warn(bold('SLA Violations:'));
+    for (const reason of (body.sla_reasons || [])) {
+      log(`  ${RED}•${RESET} ${reason}`);
+    }
+    if (body.bug_report_id) {
+      log('');
+      warn(`Bug report #${body.bug_report_id} created in EdgeTesting`);
+      warn('Jira comment posted automatically');
+    }
+  } else {
+    log('');
+    ok('All SLA thresholds passed.');
+  }
+
+  log('');
+
+  // Exit with non-zero if SLA violated — useful for CI gates
+  if (body.sla_violated) process.exit(1);
+})();
+
+// ── Local parser (dry-run only) ───────────────────────────────────────────────
+async function parseLocally(filePath) {
+  const content = fs.readFileSync(filePath, 'utf8').trim();
+  const isXml   = content.startsWith('<');
+
+  if (isXml) {
+    throw new Error('Local XML parsing not supported in dry-run. Use CSV format or upload normally.');
+  }
+
+  const lines   = content.split('\n').map(l => l.trim()).filter(Boolean);
+  let headers   = null;
+  const samples = [];
+
+  for (const line of lines) {
+    const row = line.split(',');
+    if (!headers) {
+      const known = ['timestamp','elapsed','label','success','latency','responsecode'];
+      const isHeader = row.some(c => known.includes(c.toLowerCase().trim()));
+      if (isHeader) { headers = row.map(h => h.trim()); continue; }
+      headers = ['timeStamp','elapsed','label','responseCode','responseMessage',
+                 'threadName','dataType','success','failureMessage','bytes',
+                 'sentBytes','grpThreads','allThreads','URL','Latency','IdleTime','Connect'];
+    }
+    const obj      = Object.fromEntries(headers.map((h, i) => [h, (row[i] || '').trim()]));
+    const latency  = parseFloat(obj.Latency || obj.latency || obj.elapsed || 0);
+    const elapsed  = parseFloat(obj.elapsed || 0);
+    const success  = (obj.success || 'true').toLowerCase() === 'true';
+    samples.push({ latency_ms: latency || elapsed, elapsed_ms: elapsed, success });
+  }
+
+  if (!samples.length) throw new Error('No samples found.');
+
+  const latencies = samples.map(s => s.latency_ms).sort((a, b) => a - b);
+  const count     = latencies.length;
+  const errors    = samples.filter(s => !s.success).length;
+  const avg       = latencies.reduce((a, b) => a + b, 0) / count;
+  const p95idx    = Math.ceil(0.95 * count) - 1;
+  const p99idx    = Math.ceil(0.99 * count) - 1;
+
+  return {
+    sample_count:     count,
+    error_percentage: parseFloat(((errors / count) * 100).toFixed(2)),
+    avg_latency_ms:   parseFloat(avg.toFixed(2)),
+    p95_latency_ms:   latencies[Math.max(0, p95idx)],
+    p99_latency_ms:   latencies[Math.max(0, p99idx)],
+    min_latency_ms:   latencies[0],
+    max_latency_ms:   latencies[count - 1],
+    throughput_rps:   null,
+  };
+}
+
+// ── Pretty-print metrics table ────────────────────────────────────────────────
+function printMetrics(m, slaMs, slaErrPct) {
+  if (!m) return;
+
+  const slaFlag = (val, threshold) => {
+    if (threshold == null) return '';
+    return val > threshold ? `  ${RED}↑ exceeds ${threshold}${RESET}` : `  ${GREEN}✔${RESET}`;
+  };
+
+  log(`  ${DIM}${'─'.repeat(52)}${RESET}`);
+  log(`  ${bold('Metric')}                 ${bold('Value')}`);
+  log(`  ${DIM}${'─'.repeat(52)}${RESET}`);
+  log(`  Samples                ${m.sample_count}`);
+  log(`  Avg Latency            ${m.avg_latency_ms}ms${slaFlag(m.avg_latency_ms, slaMs)}`);
+  log(`  P95 Latency            ${m.p95_latency_ms}ms${slaFlag(m.p95_latency_ms, slaMs)}`);
+  log(`  P99 Latency            ${m.p99_latency_ms}ms`);
+  log(`  Min / Max              ${m.min_latency_ms}ms / ${m.max_latency_ms}ms`);
+  if (m.throughput_rps != null)
+    log(`  Throughput             ${m.throughput_rps} req/s`);
+  log(`  Error Rate             ${m.error_percentage}%${slaFlag(m.error_percentage, slaErrPct)}`);
+  log(`  ${DIM}${'─'.repeat(52)}${RESET}`);
+}