api-tests-coverage 1.0.0

package/dist/src/perfResilienceCoverage.d.ts

@@ -0,0 +1,155 @@
+export type ResilienceCategory = 'timeout' | 'retry' | 'circuit-breaker' | 'fallback' | 'rate-limiting' | 'bulkhead';
+export declare const RESILIENCE_CATEGORIES: ResilienceCategory[];
+/** An API endpoint derived from the OpenAPI spec */
+export interface PerformanceEndpoint {
+    /** Unique identifier, e.g. "GET /users" */
+    id: string;
+    method: string;
+    path: string;
+}
+/** Thresholds used to evaluate load-test metrics */
+export interface PerformanceThresholds {
+    /** Maximum acceptable median response time in ms (default: 500) */
+    responseMs: number;
+    /** Maximum acceptable error rate as a fraction 0–1 (default: 0.05) */
+    errorRate: number;
+}
+/** Parsed metrics for a single endpoint from a load-test result file */
+export interface LoadTestMetrics {
+    /** Endpoint identifier (matches PerformanceEndpoint.id or a label) */
+    endpoint: string;
+    /** Number of requests sampled */
+    sampleCount: number;
+    /** Average response time in ms */
+    avg: number;
+    /** Median (P50) response time in ms */
+    median: number;
+    /** 95th-percentile response time in ms */
+    p95: number;
+    /** 99th-percentile response time in ms */
+    p99: number;
+    /** Error rate (0–1) */
+    errorRate: number;
+    /** Requests per second */
+    throughput: number;
+}
+/** Performance coverage result for one endpoint */
+export interface PerformanceCoverage {
+    endpoint: PerformanceEndpoint;
+    /** True when at least one load-test result was found for this endpoint */
+    hasLoadTestData: boolean;
+    metrics?: LoadTestMetrics;
+    /** Whether the median response time is within the threshold */
+    meetsResponseTime: boolean;
+    /** Whether the error rate is within the threshold */
+    meetsErrorRate: boolean;
+    /** Overall status */
+    status: 'good' | 'needs-improvement' | 'missing-data';
+}
+/** A single resilience scenario (e.g. timeout handling for GET /users) */
+export interface ResilienceScenario {
+    /** Unique identifier, e.g. "timeout:GET /users" */
+    id: string;
+    category: ResilienceCategory;
+    description: string;
+    /** Associated endpoint, if scenario is endpoint-specific */
+    endpoint?: PerformanceEndpoint;
+}
+/** Coverage result for one resilience scenario */
+export interface ResilienceScenarioCoverage {
+    scenario: ResilienceScenario;
+    covered: boolean;
+    /** Test description strings that matched this scenario */
+    matchedTests: string[];
+}
+export interface ResilienceCategorySummary {
+    total: number;
+    covered: number;
+}
+/** Full performance and resilience coverage report */
+export interface PerfResilienceReport {
+    totalEndpoints: number;
+    endpointsWithLoadData: number;
+    performanceCoveragePercent: number;
+    performanceCoverages: PerformanceCoverage[];
+    totalResilienceScenarios: number;
+    coveredResilienceScenarios: number;
+    resilienceCoveragePercent: number;
+    resilienceCoverages: ResilienceScenarioCoverage[];
+    resilienceCategorySummary: Record<ResilienceCategory, ResilienceCategorySummary>;
+}
+/** Keywords used to detect resilience tests in test descriptions */
+export declare const RESILIENCE_KEYWORDS: Record<ResilienceCategory, string[]>;
+/**
+ * Parse an OpenAPI/Swagger spec and return a flat list of endpoints.
+ */
+export declare function parseEndpointsFromSpec(specPath: string): Promise<PerformanceEndpoint[]>;
+/**
+ * Parse one or more load-test result files.
+ * Supported formats:
+ *  - JMeter .jtl / .csv  (comma-separated with standard JMeter headers)
+ *  - k6 JSON summary     (`{ "metrics": { "http_req_duration": { "values": { ... } } } }`)
+ *
+ * Returns a map from endpoint label → LoadTestMetrics.
+ */
+export declare function parseLoadTestResults(filePaths: string[]): Map<string, LoadTestMetrics>;
+/**
+ * Parse a JMeter .jtl / .csv file.
+ *
+ * Expected header (standard JMeter format):
+ *   timeStamp,elapsed,label,responseCode,success,bytes,sentBytes,grpThreads,allThreads,Latency,Connect
+ *
+ * Returns a map of label → aggregated LoadTestMetrics.
+ */
+export declare function parseJMeterCsv(csvContent: string): Map<string, LoadTestMetrics>;
+/**
+ * Parse a k6 JSON summary file.
+ *
+ * Supports both the top-level summary format:
+ *   `{ "metrics": { "http_req_duration": { "values": { "avg", "med", "p(95)", "p(99)" } } } }`
+ * and a per-URL breakdown when present in `scenarios` or `groups` keys.
+ */
+export declare function parseK6Json(jsonContent: string): Map<string, LoadTestMetrics>;
+/**
+ * Build the list of resilience scenarios to check.
+ *
+ * For each endpoint we create one scenario per resilience category.
+ * This gives a measurable and exhaustive checklist.
+ */
+export declare function buildResilienceScenarios(endpoints: PerformanceEndpoint[]): ResilienceScenario[];
+export interface TestEntry {
+    description: string;
+    filePath: string;
+}
+/**
+ * Read test files matching a glob and extract test descriptions.
+ * Recognises Jest/Mocha-style `test(`, `it(`, and `describe(` calls.
+ */
+export declare function collectTestEntries(testsGlob: string): Promise<TestEntry[]>;
+/**
+ * Determine whether a test entry covers a given resilience scenario.
+ *
+ * Matching rules (applied to test description only):
+ *  1. Explicit `@resilience <scenarioId>` annotation
+ *  2. Category keywords AND (endpoint path or method in description)
+ *  3. Category keywords alone (for global/category-level coverage)
+ */
+export declare function testCoversScenario(entry: TestEntry, scenario: ResilienceScenario): boolean;
+/**
+ * Analyse test files and return coverage for each resilience scenario.
+ */
+export declare function analyzeResilienceCoverage(scenarios: ResilienceScenario[], testsGlob: string): Promise<ResilienceScenarioCoverage[]>;
+/**
+ * Compute performance coverage for each endpoint.
+ */
+export declare function analyzePerformanceCoverage(endpoints: PerformanceEndpoint[], metricsMap: Map<string, LoadTestMetrics>, thresholds: PerformanceThresholds): PerformanceCoverage[];
+/**
+ * Assemble the full PerfResilienceReport from individual coverage lists.
+ */
+export declare function buildPerfResilienceReport(performanceCoverages: PerformanceCoverage[], resilienceCoverages: ResilienceScenarioCoverage[]): PerfResilienceReport;
+/**
+ * Write `reports/perf-resilience-coverage.json` and
+ * `reports/perf-resilience-coverage.html` to `reportsDir`.
+ */
+export declare function generatePerfResilienceReports(report: PerfResilienceReport, reportsDir: string): void;
+//# sourceMappingURL=perfResilienceCoverage.d.ts.map

package/dist/src/perfResilienceCoverage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"perfResilienceCoverage.d.ts","sourceRoot":"","sources":["../../src/perfResilienceCoverage.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,UAAU,CAAC;AAEf,eAAO,MAAM,qBAAqB,EAAE,kBAAkB,EAOrD,CAAC;AAEF,oDAAoD;AACpD,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oDAAoD;AACpD,MAAM,WAAW,qBAAqB;IACpC,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,sEAAsE;IACtE,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,mDAAmD;AACnD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,0EAA0E;IAC1E,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,+DAA+D;IAC/D,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qDAAqD;IACrD,cAAc,EAAE,OAAO,CAAC;IACxB,qBAAqB;IACrB,MAAM,EAAE,MAAM,GAAG,mBAAmB,GAAG,cAAc,CAAC;CACvD;AAED,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED,kDAAkD;AAClD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,0DAA0D;IAC1D,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,sDAAsD;AACtD,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,0BAA0B,EAAE,MAAM,CAAC;IACnC,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C,wBAAwB,EAAE,MAAM,CAAC;IACjC,0BAA0B,EAAE,MAAM,CAAC;IACnC,yBAAyB,EAAE,MAAM,CAAC;IAClC,mBAAmB,EAAE,0BAA0B,EAAE,CAAC;IAClD,yBAAyB,EAAE,MAAM,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,CAAC;CAClF;AAID,oEAAoE;AACpE,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,CA0BpE,CAAC;AAMF;;GAEG;AACH,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAe7F;AAID;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAsBtF;AAID;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAqC/E;AAID;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CA6E7E;AAsDD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,mBAAmB,EAAE,GAAG,kBAAkB,EAAE,CAe/F;AAqBD,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAchF;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAmB1F;AAED;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,SAAS,EAAE,kBAAkB,EAAE,EAC/B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAgBvC;AAuCD;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,mBAAmB,EAAE,EAChC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,EACxC,UAAU,EAAE,qBAAqB,GAChC,mBAAmB,EAAE,CA4BvB;AAID;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,oBAAoB,EAAE,mBAAmB,EAAE,EAC3C,mBAAmB,EAAE,0BAA0B,EAAE,GAChD,oBAAoB,CAiCtB;AAID;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,oBAAoB,EAC5B,UAAU,EAAE,MAAM,GACjB,IAAI,CAON"}