k6-cucumber-steps 1.0.41 → 1.1.1

package/bin/k6-cucumber-steps.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
-
+//bin/k6-cucumber-steps.js
 const path = require("path");
 const fs = require("fs");
 const { spawn } = require("child_process");
 const yargs = require("yargs");
 require("dotenv").config();
+const { generateHtmlReports } = require("../scripts/generateHtmlReports");
+const { linkReports } = require("../scripts/linkReports");
 
 console.log(`
   -----------------------------------------
@@ -95,9 +97,32 @@ if (configOptions.require && Array.isArray(configOptions.require)) {
 
 // Determine base report name
 const reportsDir = path.join(process.cwd(), "reports");
+// Clean and prepare reports directory
+const cleanReportsDir = () => {
+  if (fs.existsSync(reportsDir)) {
+    try {
+      fs.rmSync(reportsDir, { recursive: true, force: true });
+      console.log("🧹 Cleaned existing reports directory.");
+    } catch (err) {
+      console.error("❌ Failed to clean reports directory:", err.message);
+      process.exit(1);
+    }
+  }
+
+  try {
+    fs.mkdirSync(reportsDir, { recursive: true });
+    console.log("📁 Created fresh reports directory.");
+  } catch (err) {
+    console.error("❌ Failed to create reports directory:", err.message);
+    process.exit(1);
+  }
+};
+
+cleanReportsDir();
+
 const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
 
-let baseReportName = "load-results";
+let baseReportName = "load-report";
 if (featureFiles.length === 1) {
   const nameFromFeature = path.basename(featureFiles[0], ".feature");
   baseReportName = nameFromFeature || baseReportName;
@@ -145,12 +170,30 @@ const cucumberProcess = spawn("npx", cucumberArgs, {
 });
 
 cucumberProcess.on("close", (code) => {
-  console.log(`\n-----------------------------------------`);
   if (code === 0) {
+    console.log("-----------------------------------------");
     console.log("✅ k6-cucumber-steps execution completed successfully.");
+
+    generateHtmlReports(); // Cucumber HTML
+    console.log(
+      "🚀 Cucumber HTML report reports/cucumber-report.html generated successfully 👍"
+    );
+
+    const k6ReportPath = detectMostRecentK6Report(); // Add this helper function
+    if (k6ReportPath) {
+      console.log(
+        `📄 K6 HTML report ${k6ReportPath} generated successfully 👍`
+      );
+    }
+
+    linkReports(); // Link both reports
+
+    console.log("-----------------------------------------");
   } else {
+    console.error("-----------------------------------------");
     console.error("❌ k6-cucumber-steps execution failed.");
+    console.error("-----------------------------------------");
   }
-  console.log(`-----------------------------------------\n`);
+
   process.exit(code);
 });

package/cucumber.js

@@ -1,12 +1,12 @@
 module.exports = {
   default: {
-    require: ["./step_definitions/**/*.js"],
+    // require: ["./step_definitions/**/*.js"],
     format: [
       "summary",
-      "json:./src/examples/reports/load-report.json",
-      "html:./src/examples/reports/report.html",
+      "json:./reports/load-report.json",
+      "html:./reports/cucumber-report.html",
     ],
-    paths: ["./src/examples/features/*.feature"],
+    paths: ["./features/bsp.feature"],
     tags: "@load",
     worldParameters: {
       payloadPath: "src/examples/payloads",

package/lib/helpers/buildK6Script.js

@@ -1,14 +1,12 @@
 module.exports = function buildK6Script(config) {
   const { method, endpoints, endpoint, body, headers, options } = config;
 
-  // Ensure at least one of `endpoints` or `endpoint` is defined
   if (!endpoints?.length && !endpoint) {
     throw new Error(
       'Either "endpoints" or "endpoint" must be defined in the configuration.'
     );
   }
 
-  // Prefer API_BASE_URL, fallback to BASE_URL
   const BASE_URL = process.env.API_BASE_URL || process.env.BASE_URL;
   if (!BASE_URL) {
     throw new Error(
@@ -16,18 +14,18 @@ module.exports = function buildK6Script(config) {
     );
   }
 
-  // Resolve relative endpoints by prepending BASE_URL
   const resolveEndpoint = (url) => {
     return url.startsWith("/") ? `${BASE_URL}${url}` : url;
   };
 
-  // Convert to inline JS object (not stringified) so K6 can call JSON.stringify() itself
   const stringifiedHeaders = JSON.stringify(headers, null, 2);
   const stringifiedBody = JSON.stringify(body, null, 2);
 
   return `
 import http from 'k6/http';
 import { check } from 'k6';
+import { htmlReport } from "https://raw.githubusercontent.com/benc-uk/k6-reporter/main/dist/bundle.js";
+import { textSummary } from "https://jslib.k6.io/k6-summary/0.0.1/index.js";
 
 export const options = ${JSON.stringify(options, null, 2)};
 
@@ -40,32 +38,42 @@ export default function () {
       ? endpoints
           .map(
             (url, i) => `
-    const resolvedUrl${i} = "${resolveEndpoint(url)}";
-    const res${i} = http.request("${method}", resolvedUrl${i}, ${
+  const resolvedUrl${i} = "${resolveEndpoint(url)}";
+  const res${i} = http.request("${method}", resolvedUrl${i}, ${
               method === "GET" || method === "DELETE"
                 ? "null"
                 : "JSON.stringify(body)"
             }, { headers });
-    console.log(\`Response Body for \${resolvedUrl${i}}: \${res${i}.body}\`);
-    check(res${i}, {
-      "status is 2xx": (r) => r.status >= 200 && r.status < 300
-    });
-    `
+  console.log(\`Response Body for \${resolvedUrl${i}}: \${res${i}.body}\`);
+  check(res${i}, {
+    "status is 2xx": (r) => r.status >= 200 && r.status < 300
+  });
+  `
           )
           .join("\n")
       : `
-    const resolvedUrl = "${resolveEndpoint(endpoint)}";
-    const res = http.request("${method}", resolvedUrl, ${
+  const resolvedUrl = "${resolveEndpoint(endpoint)}";
+  const res = http.request("${method}", resolvedUrl, ${
           method === "GET" || method === "DELETE"
             ? "null"
             : "JSON.stringify(body)"
         }, { headers });
-    console.log(\`Response Body for \${resolvedUrl}: \${res.body}\`);
-    check(res, {
-      "status is 2xx": (r) => r.status >= 200 && r.status < 300
-    });
+  console.log(\`Response Body for \${resolvedUrl}: \${res.body}\`);
+  check(res, {
+    "status is 2xx": (r) => r.status >= 200 && r.status < 300
+  });
   `
   }
 }
-  `;
+
+export function handleSummary(data) {
+  const outputDir = __ENV.REPORT_OUTPUT_DIR || "reports";
+  const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
+  const filename = \`\${outputDir}/k6-report-\${timestamp}.html\`;
+  return {
+    [filename]: htmlReport(data),
+    stdout: textSummary(data, { indent: " ", enableColors: true }),
+  };
+}
+`;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k6-cucumber-steps",
-  "version": "1.0.41",
+  "version": "1.1.1",
   "main": "index.js",
   "license": "MIT",
   "repository": {

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,60 @@
+const fs = require("fs");
+const path = require("path");
+
+const reportsDir = path.resolve("reports");
+
+/**
+ * Adds internal cross-links between reports.
+ */
+function addLinksToReport(targetFile, otherFiles) {
+  const content = fs.readFileSync(targetFile, "utf-8");
+
+  // Inject the Cucumber Report tab before the Request Metrics tab
+  const cucumberTab = `
+    <input type="radio" name="tabs" id="tabcucumber">
+    <label for="tabcucumber"><i class="fas fa-file-alt"></i> &nbsp; Cucumber Report</label>
+    <div class="tab">
+      <iframe src="cucumber-report.html" style="width:100%; height:600px; border:none;"></iframe>
+    </div>
+  `;
+
+  const modifiedContent = content
+    .replace(
+      /<input type="radio" name="tabs" id="tabone"/,
+      `${cucumberTab}\n<input type="radio" name="tabs" id="tabone"`
+    )
+    // Remove standalone links to cucumber-report.html or k6-report.html
+    .replace(
+      /<div style="padding:10px;margin-top:20px;text-align:center">[\s\S]*?View (Cucumber|k6).*?<\/div>/,
+      ""
+    );
+
+  fs.writeFileSync(targetFile, modifiedContent, "utf-8");
+}
+
+/**
+ * Auto-link all HTML reports in the reports directory.
+ */
+function linkReports() {
+  if (!fs.existsSync(reportsDir)) {
+    console.warn("⚠️ No reports directory found.");
+    return;
+  }
+
+  const htmlFiles = fs
+    .readdirSync(reportsDir)
+    .filter((f) => f.endsWith(".html"))
+    .map((f) => path.join(reportsDir, f));
+
+  if (htmlFiles.length < 2) {
+    console.warn("⚠️ Not enough HTML files to link.");
+    return;
+  }
+
+  for (const file of htmlFiles) {
+    const others = htmlFiles.filter((f) => f !== file);
+    addLinksToReport(file, others);
+  }
+}
+
+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);