k6-cucumber-steps 1.1.3 → 1.1.4

package/.vscode/settings.json

@@ -9,5 +9,6 @@
     "step_definitions/*.js",
     "src/features/stepDefinitions/*.js"
   ],
-  "liveServer.settings.port": 5501
+  "liveServer.settings.port": 5501,
+  "git.ignoreLimitWarning": true
 }

package/bin/k6-cucumber-steps.js

@@ -3,11 +3,9 @@
 const path = require("path");
 const fs = require("fs");
 const { spawn } = require("child_process");
-const yargs = require("yargs/yargs"); // Use the correct import for yargs
-const { hideBin } = require("yargs/helpers"); // Helper to parse CLI arguments
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
 require("dotenv").config();
-const { generateHtmlReports } = require("../scripts/generateHtmlReports");
-const { linkReports } = require("../scripts/linkReports");
 
 console.log(`
   -----------------------------------------
@@ -15,6 +13,7 @@ console.log(`
   -----------------------------------------
 `);
 
+// Parse CLI arguments
 const argv = yargs(hideBin(process.argv))
   .usage("Usage: $0 run [options]")
   .option("feature", {
@@ -24,7 +23,7 @@ const argv = yargs(hideBin(process.argv))
   })
   .option("tags", {
     alias: "t",
-    describe: "Cucumber tags to filter scenarios",
+    describe: "Cucumber tags to filter scenarios (e.g., @smoke)",
     type: "string",
   })
   .option("reporter", {
@@ -46,8 +45,10 @@ const argv = yargs(hideBin(process.argv))
   })
   .help().argv;
 
+// Base Cucumber arguments
 const cucumberArgs = ["cucumber-js"];
 
+// Load custom configuration file if provided
 const configFileName =
   argv.configFile || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
 const configFilePath = path.resolve(process.cwd(), configFileName);
@@ -58,8 +59,8 @@ if (fs.existsSync(configFilePath)) {
   try {
     const loadedConfig = require(configFilePath);
     configOptions = loadedConfig.default || loadedConfig;
-  } catch {
-    console.warn("⚠️  Could not load config file");
+  } catch (err) {
+    console.warn("⚠️ Could not load config file:", err.message);
   }
 }
 
@@ -69,18 +70,18 @@ if (tags) {
   cucumberArgs.push("--tags", tags);
 }
 
-// Feature path(s)
+// Feature file(s)
 let featureFiles = [];
 if (argv.feature) {
   featureFiles.push(path.resolve(argv.feature));
 } else if (configOptions.paths && configOptions.paths.length > 0) {
-  featureFiles.push(...configOptions.paths);
+  featureFiles.push(...configOptions.paths.map((p) => path.resolve(p)));
 }
 if (featureFiles.length > 0) {
   cucumberArgs.push(...featureFiles);
 }
 
-// Require default step definitions
+// Require step definitions
 const defaultStepsPath = path.resolve(
   process.cwd(),
   "node_modules",
@@ -89,15 +90,17 @@ const defaultStepsPath = path.resolve(
 );
 cucumberArgs.push("--require", defaultStepsPath);
 
-// Also require additional custom step definitions from config, if any
+// Include additional custom step definitions from config
 if (configOptions.require && Array.isArray(configOptions.require)) {
   for (const reqPath of configOptions.require) {
-    cucumberArgs.push("--require", reqPath);
+    cucumberArgs.push("--require", path.resolve(reqPath));
   }
 }
 
-// Determine base report name
+// Reports directory setup
 const reportsDir = path.join(process.cwd(), "reports");
+
+// Clean and prepare reports directory
 const cleanReportsDir = () => {
   if (fs.existsSync(reportsDir)) {
     try {
@@ -120,6 +123,7 @@ const cleanReportsDir = () => {
 
 cleanReportsDir();
 
+// Determine base report name
 const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
 
 let baseReportName = "load-report";
@@ -136,10 +140,15 @@ const shouldOverwrite =
   process.env.K6_CUCUMBER_OVERWRITE === "true" ||
   configOptions.overwrite === true;
 
-let reportJsonPath = "reports/load-report.json";
+let reportJsonPath = path.join(reportsDir, `${baseReportName}.json`);
 let reportHtmlPath = path.join(reportsDir, `${baseReportName}.html`);
 
-// 🆕 Respect config format path if defined
+if (!shouldOverwrite) {
+  reportJsonPath = path.join(reportsDir, `${baseReportName}-${timestamp}.json`);
+  reportHtmlPath = path.join(reportsDir, `${baseReportName}-${timestamp}.html`);
+}
+
+// Respect config format path if defined
 if (Array.isArray(configOptions.format)) {
   const jsonFmt = configOptions.format.find((f) => f.startsWith("json:"));
   if (jsonFmt) {
@@ -152,8 +161,7 @@ const formatInConfig =
   Array.isArray(configOptions.format) && configOptions.format.length > 0;
 
 if (shouldGenerateReports && !formatInConfig) {
-  fs.mkdirSync(reportsDir, { recursive: true });
-  cucumberArgs.push("--format", `summary`);
+  cucumberArgs.push("--format", "summary");
   cucumberArgs.push("--format", `json:${reportJsonPath}`);
   cucumberArgs.push("--format", `html:${reportHtmlPath}`);
 }
@@ -161,6 +169,7 @@ if (shouldGenerateReports && !formatInConfig) {
 console.log("\n▶️ Final arguments passed to cucumber-js:");
 console.log(["npx", ...cucumberArgs].join(" ") + "\n");
 
+// Execute Cucumber process
 const cucumberProcess = spawn("npx", cucumberArgs, {
   stdio: "inherit",
   env: {
@@ -174,9 +183,6 @@ const cucumberProcess = spawn("npx", cucumberArgs, {
 });
 
 function detectMostRecentK6Report() {
-  const reportsDir = path.join(process.cwd(), "reports");
-  if (!fs.existsSync(reportsDir)) return null;
-
   const files = fs
     .readdirSync(reportsDir)
     .filter((file) => /^k6-report.*\.html$/.test(file))
@@ -186,7 +192,7 @@ function detectMostRecentK6Report() {
     }))
     .sort((a, b) => b.time - a.time);
 
-  return files.length > 0 ? path.join("reports", files[0].name) : null;
+  return files.length > 0 ? path.join(reportsDir, files[0].name) : null;
 }
 
 cucumberProcess.on("close", async (code) => {
@@ -194,17 +200,26 @@ cucumberProcess.on("close", async (code) => {
     console.log("-----------------------------------------");
     console.log("✅ k6-cucumber-steps execution completed successfully.");
 
-    generateHtmlReports(); // 🍋 Cucumber HTML
-
-    console.log(
-      "🚀 Cucumber HTML report reports/cucumber-report.html generated successfully 👍"
-    );
+    // Generate Cucumber HTML report
+    try {
+      await generateHtmlReports();
+      console.log(
+        `🚀 Cucumber HTML report generated successfully at: ${reportHtmlPath}`
+      );
+    } catch (err) {
+      console.error("⚠️ Failed to generate Cucumber HTML report:", err.message);
+    }
 
-    await linkReports(); // 🧬 Combine and link reports
+    // Link reports
+    try {
+      await linkReports();
+      console.log(
+        "🔗 Combined and minified HTML report available at: reports/combined-report.html"
+      );
+    } catch (err) {
+      console.error("⚠️ Failed to link reports:", err.message);
+    }
 
-    console.log(
-      "📦 Combined and minified HTML report available at: reports/combined-report.html"
-    );
     console.log("-----------------------------------------");
   } else {
     console.error("-----------------------------------------");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k6-cucumber-steps",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "main": "index.js",
   "license": "MIT",
   "repository": {
@@ -49,26 +49,22 @@
   },
   "author": "qaPaschalE",
   "description": "Cucumber step definitions for running k6 performance tests.",
+  "peerDependencies": {
+    "@cucumber/cucumber": "*",
+    "k6": "*"
+  },
   "devDependencies": {
-    "@babel/cli": "latest",
-    "@babel/core": "latest",
-    "@babel/preset-env": "latest",
-    "@types/k6": "latest",
-    "child_process": "latest",
-    "cucumber-console-formatter": "latest",
-    "cucumber-html-reporter": "latest",
-    "esbuild": "latest",
-    "form-data": "latest",
-    "k6": "latest",
-    "tsconfig-paths": "latest"
+    "@babel/cli": "^7.27.2",
+    "@babel/core": "^7.27.4",
+    "@babel/preset-env": "^7.27.2",
+    "@faker-js/faker": "^9.8.0",
+    "@types/k6": "^1.0.2",
+    "axios": "^1.10.0",
+    "dotenv": "^16.5.0",
+    "html-minifier-terser": "^7.2.0",
+    "yargs": "^18.0.0"
   },
   "dependencies": {
-    "@babel/register": "latest",
-    "@cucumber/cucumber": "latest",
-    "@faker-js/faker": "latest",
-    "axios": "^1.9.0",
-    "dotenv": "latest",
-    "html-minifier-terser": "^7.2.0",
-    "yargs": "latest"
+    "@babel/register": "^7.27.1"
   }
 }

package/scripts/linkReports.js

@@ -4,18 +4,29 @@ const path = require("path");
 const reportsDir = path.resolve("reports");
 
 /**
- * Adds internal cross-links between reports.
+ * Finds the first file that looks like a Cucumber HTML report.
  */
-function addLinksToReport(targetFile, otherFiles) {
+function findCucumberReportFile() {
+  const files = fs.readdirSync(reportsDir);
+  return files.find((f) => f.includes("cucumber") && f.endsWith(".html"));
+}
+
+/**
+ * Adds a Cucumber report tab as an iframe.
+ */
+function addLinksToReport(targetFile, cucumberFileName) {
   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>
+  <input type="radio" name="tabs" id="tabcucumber">
+  <label for="tabcucumber"><i class="fas fa-file-alt"></i> &nbsp; Cucumber Report</label>
+  <div class="tab">
+    ${
+      cucumberFileName
+        ? `<iframe src="${cucumberFileName}" style="width:100%; min-height:600px; border:none;"></iframe>`
+        : `<p style="color:red; padding:1rem;">⚠️ Cucumber HTML report not found in <code>reports/</code> directory.</p>`
+    }
+  </div>
   `;
 
   const modifiedContent = content
@@ -23,22 +34,13 @@ function addLinksToReport(targetFile, otherFiles) {
       /<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>/,
-      ""
-    );
+    .replace(/<div style="[^>]*margin-top:20px;[^>]*">[\s\S]*?<\/div>/g, "");
 
   fs.writeFileSync(targetFile, modifiedContent, "utf-8");
-  console.log(
-    `🔗 Updated ${path.basename(
-      targetFile
-    )} with Cucumber tab and removed standalone links.`
-  );
 }
 
 /**
- * Auto-link all HTML reports in the reports directory.
+ * Adds a Cucumber tab to every K6 HTML report found in /reports.
  */
 function linkReports() {
   if (!fs.existsSync(reportsDir)) {
@@ -46,20 +48,22 @@ function linkReports() {
     return;
   }
 
+  const cucumberFile = findCucumberReportFile();
+
   const htmlFiles = fs
     .readdirSync(reportsDir)
-    .filter((f) => f.endsWith(".html"))
-    .map((f) => path.join(reportsDir, f));
+    .filter((f) => /^k6-report.*\.html$/.test(f));
 
-  if (htmlFiles.length < 2) {
-    console.warn("⚠️ Not enough HTML files to link.");
+  if (htmlFiles.length === 0) {
+    console.warn("⚠️ No K6 reports found to inject.");
     return;
   }
 
-  for (const file of htmlFiles) {
-    const others = htmlFiles.filter((f) => f !== file);
-    addLinksToReport(file, others);
-  }
+  htmlFiles.forEach((file) => {
+    const fullPath = path.join(reportsDir, file);
+    addLinksToReport(fullPath, cucumberFile);
+    console.log(`🔗 Injected Cucumber tab into: ${file}`);
+  });
 }
 
 module.exports = { linkReports };