k6-cucumber-steps 1.0.41 → 1.1.2

package/reports/load-report.json

@@ -0,0 +1,283 @@
+[
+  {
+    "description": "",
+    "elements": [
+      {
+        "description": "",
+        "id": "rate-limit-enforcement-for-/login-and-/bsp;api-allows-up-to-5-requests-in-10-seconds-(under-limit)",
+        "keyword": "Scenario",
+        "line": 9,
+        "name": "API allows up to 5 requests in 10 seconds (under limit)",
+        "steps": [
+          {
+            "arguments": [],
+            "keyword": "Given ",
+            "line": 5,
+            "name": "I login via POST to \"/api/v3/client/api/login\" with payload from \"login.json\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:262"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 894569875
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "Then ",
+            "line": 6,
+            "name": "I store the value at \"data.token\" as alias \"auth_token\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:237"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 217708
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 10,
+            "name": "I set a k6 script for POST testing",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:28"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 78040
+            }
+          },
+          {
+            "arguments": [
+              {
+                "rows": [
+                  {
+                    "cells": [
+                      "virtual_users",
+                      "duration",
+                      "http_req_failed",
+                      "http_req_duration"
+                    ]
+                  },
+                  {
+                    "cells": [
+                      "1",
+                      "10",
+                      "rate<0.05",
+                      "p(95)<2000"
+                    ]
+                  }
+                ]
+              }
+            ],
+            "keyword": "When ",
+            "line": 11,
+            "name": "I set to run the k6 script with the following configurations:",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:40"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 458667
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 14,
+            "name": "I use JSON payload from \"okra.json\" for POST to \"/api/v3/client/bsp\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:174"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 1823208
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 15,
+            "name": "I set the authentication type to \"auth_token\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:226"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 125207
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "Then ",
+            "line": 16,
+            "name": "I see the API should handle the POST request successfully",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:306"
+            },
+            "result": {
+              "status": "failed",
+              "duration": 14665569374,
+              "error_message": "Error: k6 test execution failed\n    at CustomWorld.<anonymous> (/Users/paschal/personal/k6-cucumber-steps/step_definitions/load_test_steps.js:334:13)"
+            }
+          }
+        ],
+        "tags": [
+          {
+            "name": "@rate-limit",
+            "line": 1
+          },
+          {
+            "name": "@within-limit",
+            "line": 8
+          }
+        ],
+        "type": "scenario"
+      },
+      {
+        "description": "",
+        "id": "rate-limit-enforcement-for-/login-and-/bsp;api-blocks-more-than-5-requests-in-10-seconds-(exceeds-limit)",
+        "keyword": "Scenario",
+        "line": 19,
+        "name": "API blocks more than 5 requests in 10 seconds (exceeds limit)",
+        "steps": [
+          {
+            "arguments": [],
+            "keyword": "Given ",
+            "line": 5,
+            "name": "I login via POST to \"/api/v3/client/api/login\" with payload from \"login.json\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:262"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 626931291
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "Then ",
+            "line": 6,
+            "name": "I store the value at \"data.token\" as alias \"auth_token\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:237"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 569790
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 20,
+            "name": "I set a k6 script for POST testing",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:28"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 76042
+            }
+          },
+          {
+            "arguments": [
+              {
+                "rows": [
+                  {
+                    "cells": [
+                      "virtual_users",
+                      "duration",
+                      "http_req_failed",
+                      "http_req_duration"
+                    ]
+                  },
+                  {
+                    "cells": [
+                      "6",
+                      "10",
+                      "rate>=0.50",
+                      "p(95)<3000"
+                    ]
+                  }
+                ]
+              }
+            ],
+            "keyword": "When ",
+            "line": 21,
+            "name": "I set to run the k6 script with the following configurations:",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:40"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 255083
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 24,
+            "name": "I use JSON payload from \"okra.json\" for POST to \"/api/v3/client/bsp\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:174"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 1752667
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "When ",
+            "line": 25,
+            "name": "I set the authentication type to \"auth_token\"",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:226"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 87707
+            }
+          },
+          {
+            "arguments": [],
+            "keyword": "Then ",
+            "line": 26,
+            "name": "I see the API should handle the POST request successfully",
+            "match": {
+              "location": "step_definitions/load_test_steps.js:306"
+            },
+            "result": {
+              "status": "passed",
+              "duration": 14650450625
+            }
+          }
+        ],
+        "tags": [
+          {
+            "name": "@rate-limit",
+            "line": 1
+          },
+          {
+            "name": "@exceed-limit",
+            "line": 18
+          }
+        ],
+        "type": "scenario"
+      }
+    ],
+    "id": "rate-limit-enforcement-for-/login-and-/bsp",
+    "line": 2,
+    "keyword": "Feature",
+    "name": "Rate Limit Enforcement for /login and /bsp",
+    "tags": [
+      {
+        "name": "@rate-limit",
+        "line": 1
+      }
+    ],
+    "uri": "features/bsp.feature"
+  }
+]

package/scripts/generateHtmlReports.js

@@ -0,0 +1,53 @@
+const fs = require("fs");
+const path = require("path");
+const reporter = require("cucumber-html-reporter");
+
+function getJsonReportPath() {
+  // 1. Check for cucumber.js or custom config
+  const configFile = path.resolve("cucumber.js");
+  if (fs.existsSync(configFile)) {
+    const configText = fs.readFileSync(configFile, "utf-8");
+
+    const match = configText.match(/json:(.*?\.json)/);
+    if (match && match[1]) {
+      const reportPath = match[1].trim().replace(/['"`]/g, "");
+      console.log(`📝 Found report path in cucumber.js: ${reportPath}`);
+      return reportPath;
+    }
+  }
+
+  // 2. Check environment variable
+  if (process.env.CUCUMBER_JSON) {
+    console.log(
+      `📝 Using report path from CUCUMBER_JSON: ${process.env.CUCUMBER_JSON}`
+    );
+    return process.env.CUCUMBER_JSON;
+  }
+
+  // 3. Fallback to default
+  console.log("📝 Using default report path: reports/load-report.json");
+  return "reports/load-report.json";
+}
+
+function generateHtmlReports() {
+  const jsonReportPath = getJsonReportPath();
+
+  if (!fs.existsSync(jsonReportPath)) {
+    console.warn(`⚠️ Cucumber JSON report not found at: ${jsonReportPath}`);
+    return;
+  }
+
+  const reportDir = path.dirname(jsonReportPath);
+
+  reporter.generate({
+    theme: "bootstrap",
+    jsonFile: jsonReportPath,
+    output: path.join(reportDir, "cucumber-report.html"),
+    reportSuiteAsScenarios: true,
+    launchReport: false,
+    name: "k6-cucumber-steps Performance Report",
+    brandTitle: "📊 Performance Test Summary",
+  });
+}
+
+module.exports = { generateHtmlReports };

package/scripts/linkReports.js

@@ -0,0 +1,122 @@
+const fs = require("fs");
+const path = require("path");
+const { minify } = require("html-minifier-terser");
+
+const reportsDir = path.resolve("reports");
+
+function findCucumberReportPath() {
+  const files = fs.readdirSync(reportsDir);
+  return files.find((f) => f.includes("cucumber") && f.endsWith(".html"));
+}
+
+function extractCucumberBody(filepath) {
+  const html = fs.readFileSync(filepath, "utf-8");
+
+  // Remove <script> tags to avoid JS conflicts
+  const withoutScripts = html.replace(/<script[\s\S]*?<\/script>/gi, "");
+
+  const match = withoutScripts.match(/<body[^>]*>([\s\S]*)<\/body>/i);
+  return match
+    ? match[1]
+    : "<p>⚠️ Failed to extract body of Cucumber report.</p>";
+}
+
+function extractK6ReportBody(file) {
+  const html = fs.readFileSync(file, "utf-8");
+  const match = html.match(/<body[^>]*>([\s\S]*)<\/body>/i);
+  return match ? match[1] : "";
+}
+
+function buildCombinedHtml({ title, k6Bodies, cucumberBody }) {
+  const tabs = k6Bodies
+    .map(
+      (_, i) => `
+    <input type="radio" name="tabs" id="tabk6${i}" ${i === 0 ? "checked" : ""}>
+    <label for="tabk6${i}">K6 Report ${i + 1}</label>
+    <div class="tab">
+      ${k6Bodies[i]}
+    </div>
+  `
+    )
+    .join("\n");
+
+  const cucumberTab = `
+    <input type="radio" name="tabs" id="tabcucumber">
+    <label for="tabcucumber">Cucumber Report</label>
+    <div class="tab">
+      <div style="max-height:80vh; overflow:auto; padding:1rem;">
+        ${cucumberBody}
+      </div>
+    </div>
+  `;
+
+  const fullTabs = cucumberBody ? cucumberTab + tabs : tabs;
+
+  return `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <title>${title}</title>
+  <link rel="stylesheet" href="https://unpkg.com/purecss@2.0.3/build/pure-min.css" crossorigin="anonymous">
+  <style>
+    body { margin:1rem; font-family:sans-serif; }
+    .tabs { display:flex; flex-wrap:wrap; }
+    .tabs label { order:1; padding:1rem; cursor:pointer; background:#ddd; margin-right:0.2rem; border-radius:5px 5px 0 0; }
+    .tabs .tab { order:99; flex-grow:1; width:100%; display:none; padding:1rem; background:#fff; }
+    .tabs input[type="radio"] { display:none; }
+    .tabs input[type="radio"]:checked + label { background:#fff; font-weight:bold; }
+    .tabs input[type="radio"]:checked + label + .tab { display:block; }
+  </style>
+</head>
+<body>
+  <h1>${title}</h1>
+  <div class="tabs">
+    ${fullTabs}
+  </div>
+</body>
+</html>`;
+}
+
+async function linkReports() {
+  if (!fs.existsSync(reportsDir)) {
+    console.warn("⚠️ No reports directory found.");
+    return;
+  }
+
+  const cucumberFile = findCucumberReportPath();
+  const cucumberBody = cucumberFile
+    ? extractCucumberBody(path.join(reportsDir, cucumberFile))
+    : null;
+
+  const k6Files = fs
+    .readdirSync(reportsDir)
+    .filter((f) => /^k6-report.*\.html$/.test(f));
+  if (k6Files.length === 0) {
+    console.warn("⚠️ No K6 reports found.");
+    return;
+  }
+
+  const k6Bodies = k6Files.map((f) =>
+    extractK6ReportBody(path.join(reportsDir, f))
+  );
+
+  const combinedHtml = buildCombinedHtml({
+    title: "Combined K6 + Cucumber Report",
+    k6Bodies,
+    cucumberBody,
+  });
+
+  const finalHtml = await minify(combinedHtml, {
+    collapseWhitespace: true,
+    removeComments: true,
+    minifyCSS: true,
+  });
+
+  const outPath = path.join(reportsDir, "combined-report.html");
+  fs.writeFileSync(outPath, finalHtml, "utf-8");
+
+  console.log(`✅ Combined and minified report saved to: ${outPath}`);
+}
+
+module.exports = { linkReports };

package/.env.example

@@ -1,17 +0,0 @@
-# .env
-TEST_ENVIRONMENT=STAGING
-APP_VERSION=1.0.0
-BROWSER=Chrome 100.0.4896.88
-PLATFORM=Windows 10
-PARALLEL=Scenarios
-EXECUTED=Remote
-
-# Base URLs
-API_BASE_URL=https://test-api.example.com
-BASE_URL=https://example.com
-AUTH_URL=https://auth.example.com
-PAYMENT_URL=https://payment.example.com
-
-# Secret Parameters
-API_KEY=your-secret-api-key-12345
-BEARER_TOKEN=your_bearer_token_here

package/generateReport.js

@@ -1,24 +0,0 @@
-const reporter = require("cucumber-html-reporter");
-
-// Configuration for the HTML report
-const options = {
-  theme: "bootstrap", // You can change the theme to 'simple', 'compact', etc.
-  jsonFile: "reports/load-results.json", // Path to the JSON file generated by Cucumber
-  output: "reports/report.html", // Path where you want to save the HTML report
-  reportSuiteAsScenarios: true, // Group scenarios by their name
-  launchReport: true, // Automatically open the report in the browser
-  metadata: {
-    browser: {
-      name: "Chrome" || "unknown",
-      version: "89" || "unknown",
-    },
-    device: "Local test machine",
-    platform: {
-      name: "MacOS",
-      version: "20.04",
-    },
-  },
-};
-
-// Generate the report
-reporter.generate(options);