k6-cucumber-steps 1.1.8 → 1.1.10

package/bin/k6-cucumber-steps.js

@@ -24,8 +24,9 @@ program
   .option("-o, --overwrite", "Overwrite report files", false)
   .option("--cleanReports", "Clean the reports folder before running")
   .option("--clean", "Alias for --cleanReports")
+  .option("-p, --payloadPath <dir>", "Directory for payload files")
   .action(async (argv) => {
-    const cucumberArgs = ["cucumber-js"];
+    // Load config file
     const configFileInput =
       argv.config || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
     const configFilePath = path.isAbsolute(configFileInput)
@@ -33,73 +34,87 @@ program
       : path.resolve(process.cwd(), configFileInput);
 
     let configOptions = {};
-
     if (fs.existsSync(configFilePath)) {
-      cucumberArgs.push("--config", configFileInput);
       try {
         const loadedConfig = require(configFilePath);
         configOptions = loadedConfig.default || loadedConfig;
       } catch (err) {
         console.warn("⚠️ Could not load config file:", err.message);
       }
-    } else {
-      console.warn(`⚠️ Config file not found at ${configFilePath}`);
     }
 
-    // Resolve cleanReports: CLI > ENV > config file
-    const cleanReports =
-      typeof argv.cleanReports === "boolean"
-        ? argv.cleanReports
-        : typeof argv.clean === "boolean"
-        ? argv.clean
-        : process.env.CLEAN_REPORTS
-        ? process.env.CLEAN_REPORTS === "true"
-        : configOptions.cleanReports;
-
-    // Clean reports directory if needed
-    const reportsDir = path.resolve("reports");
-    if (cleanReports) {
-      if (fs.existsSync(reportsDir)) {
-        fs.rmSync(reportsDir, { recursive: true, force: true });
-        console.log("🧹 Cleaned reports directory.");
-      }
-    }
-    if (!fs.existsSync(reportsDir)) {
-      fs.mkdirSync(reportsDir, { recursive: true });
+    // Build the cucumber-js command from config
+    const cucumberConfig = configOptions.default || configOptions;
+    let cliParts = [];
+
+    // Add paths
+    if (cucumberConfig.paths && Array.isArray(cucumberConfig.paths)) {
+      cliParts.push(...cucumberConfig.paths);
     }
 
-    // Build featureFiles array before using it
-    let featureFiles = [];
-    if (argv.feature) {
-      featureFiles.push(path.resolve(argv.feature));
-    } else if (Array.isArray(configOptions.paths)) {
-      featureFiles = configOptions.paths.map((f) => path.resolve(f));
+    // Add require
+    if (cucumberConfig.require && Array.isArray(cucumberConfig.require)) {
+      cucumberConfig.require.forEach((req) => {
+        cliParts.push("--require", req);
+      });
     }
 
-    let baseReportName = "load-report";
-    if (featureFiles.length === 1) {
-      baseReportName = path.basename(featureFiles[0], ".feature");
-    } else if (featureFiles.length > 1) {
-      baseReportName = "multi-feature";
+    // Add format
+    if (cucumberConfig.format && Array.isArray(cucumberConfig.format)) {
+      cucumberConfig.format.forEach((fmt) => {
+        cliParts.push("--format", fmt);
+      });
     }
-    const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
-    let reportHtmlPath = path.join(reportsDir, `cucumber-report.html`);
 
-    if (argv.reporter && !Array.isArray(configOptions.format)) {
-      cucumberArgs.push("--format", "summary");
-      cucumberArgs.push("--format", `html:${reportHtmlPath}`);
+    // Add tags
+    if (cucumberConfig.tags) {
+      cliParts.push("--tags", cucumberConfig.tags);
     }
 
-    console.log("\n▶️ Final arguments passed to cucumber-js:");
-    console.log(["npx", ...cucumberArgs].join(" ") + "\n");
+    // Determine project root (where your main package.json is)
+    const projectRoot = path.resolve(__dirname, "..");
+
+    // Determine payload directory from CLI or config, always relative to project root
+    let payloadDirRaw =
+      argv.payloadPath ||
+      (cucumberConfig.worldParameters &&
+        cucumberConfig.worldParameters.payloadPath) ||
+      "payloads";
+    const payloadDir = path.isAbsolute(payloadDirRaw)
+      ? payloadDirRaw
+      : path.join(projectRoot, payloadDirRaw);
+
+    // Add --world-parameters to CLI args
+    const worldParams = {
+      ...(cucumberConfig.worldParameters || {}),
+      payloadPath: payloadDir,
+    };
+    cliParts.push("--world-parameters", JSON.stringify(worldParams));
+
+    // Add other options as needed...
+
+    const finalCommand = ["npx", "cucumber-js", ...cliParts].join(" ");
+    console.log("▶️ Final arguments passed to cucumber-js:", finalCommand);
+
+    // Clean reports directory if requested
+    const shouldCleanReports =
+      argv.cleanReports ||
+      argv.clean ||
+      process.env.CLEAN_REPORTS === "true" ||
+      cucumberConfig.cleanReports;
+
+    if (shouldCleanReports) {
+      const reportsDir = path.join(projectRoot, "reports");
+      if (fs.existsSync(reportsDir)) {
+        fs.rmSync(reportsDir, { recursive: true, force: true });
+        fs.mkdirSync(reportsDir, { recursive: true });
+        console.log("🧹 Cleaned reports directory.");
+      }
+    }
 
-    const cucumberProcess = spawn("npx", cucumberArgs, {
+    // Now spawn the process
+    const cucumberProcess = spawn("npx", ["cucumber-js", ...cliParts], {
       stdio: "inherit",
-      env: {
-        ...process.env,
-        REPORT_HTML_PATH: reportHtmlPath,
-        K6_CUCUMBER_OVERWRITE: argv.overwrite ? "true" : "false",
-      },
     });
 
     cucumberProcess.on("close", async (code) => {
@@ -108,7 +123,9 @@ program
         console.log("✅ k6-cucumber-steps execution completed successfully.");
         try {
           await linkReports();
-          console.log("🔗 Reports linked successfully with embedded Cucumber tab.");
+          console.log(
+            "🔗 Reports linked successfully with embedded Cucumber tab."
+          );
         } catch (err) {
           console.error("⚠️ Failed to link reports:", err.message);
         }

package/package.json

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

package/scripts/linkReports.js

@@ -10,38 +10,58 @@ async function linkReports() {
     return;
   }
 
+  // Get all HTML files in the reports directory
   const htmlFiles = fs
     .readdirSync(reportsDir)
-    .filter((f) => f.endsWith(".html"));
-  const k6ReportFile = htmlFiles.find(
-    (f) => f.startsWith("k6-report") && f.endsWith(".html")
-  );
-  const cucumberReportFile = htmlFiles.find((f) =>
-    f.includes("cucumber-report")
-  );
+    .filter((f) => f.endsWith(".html"))
+    .map((f) => ({
+      name: f,
+      path: path.join(reportsDir, f),
+      mtime: fs.statSync(path.join(reportsDir, f)).mtime.getTime(),
+    }));
+
+  if (htmlFiles.length === 0) {
+    console.warn("⚠️ No HTML reports found.");
+    return;
+  }
+
+  // Find k6 report: file starting with "k6-" or fallback to most recent
+  let k6Report = htmlFiles.find((f) => f.name.startsWith("k6-"));
+  if (!k6Report) {
+    k6Report = htmlFiles.reduce((a, b) => (a.mtime > b.mtime ? a : b));
+  }
+
+  // Find all other HTML reports (excluding k6 report)
+  const otherReports = htmlFiles.filter((f) => f.name !== k6Report.name);
 
-  if (!k6ReportFile || !cucumberReportFile) {
-    console.warn("⚠️ K6 or Cucumber HTML report not found.");
+  if (!k6Report || otherReports.length === 0) {
+    console.warn("⚠️ K6 or any other HTML report not found.");
     return;
   }
 
-  const k6Path = path.join(reportsDir, k6ReportFile);
-  const cucumberPath = path.basename(cucumberReportFile);
-  let content = fs.readFileSync(k6Path, "utf8");
+  // Read k6 report content
+  let content = fs.readFileSync(k6Report.path, "utf8");
 
-  const cucumberTab = `
-    <input type="radio" name="tabs" id="tabcucumber">
-    <label for="tabcucumber"><i class="fas fa-file-alt"></i> &nbsp; Cucumber Report</label>
+  // Build tabs for each other report
+  const tabs = otherReports
+    .map(
+      (report, idx) => `
+    <input type="radio" name="tabs" id="tab${idx + 2}">
+    <label for="tab${idx + 2}"><i class="fas fa-file-alt"></i> &nbsp; ${report.name}</label>
     <div class="tab">
-      <iframe src="${cucumberPath}" style="width:100%; height:600px; border:none;"></iframe>
+      <iframe src="${report.name}" style="width:100%; height:600px; border:none;"></iframe>
     </div>
-  `;
+  `
+    )
+    .join("\n");
 
+  // Insert tabs after the first tab (assumes k6 report has a tab structure)
   content = content.replace(
     /<input type="radio" name="tabs" id="tabone"/,
-    `${cucumberTab}\n<input type="radio" name="tabs" id="tabone"`
+    `${tabs}\n<input type="radio" name="tabs" id="tabone"`
   );
 
+  // Remove any existing footer
   content = content.replace(
     /<div style="padding:10px;margin-top:20px;text-align:center">[\s\S]*?<\/div>/,
     ""

package/step_definitions/load_test_steps.js

@@ -184,9 +184,11 @@ When(
       );
     }
 
-    const basePayloadPath =
-      this.parameters?.payloadPath || path.resolve(__dirname, "../../payloads");
-    const payloadPath = path.resolve(basePayloadPath, fileName);
+    const projectRoot = path.resolve(__dirname, "..", "..");
+    const payloadDir = this.parameters?.payloadPath || "payloads";
+    const payloadPath = path.isAbsolute(payloadDir)
+      ? path.join(payloadDir, fileName)
+      : path.join(__dirname, "..", "..", payloadDir, fileName);
 
     if (!fs.existsSync(payloadPath)) {
       throw new Error(`Payload file not found: ${payloadPath}`);
@@ -261,9 +263,10 @@ Then(
 When(
   "I login via POST to {string} with payload from {string}",
   async function (endpoint, fileName) {
-    const basePayloadPath =
-      this.parameters?.payloadPath || path.resolve(__dirname, "../../payloads");
-    const payloadPath = path.resolve(basePayloadPath, fileName);
+    const payloadDir = this.parameters?.payloadPath || "payloads";
+    const payloadPath = path.isAbsolute(payloadDir)
+      ? path.join(payloadDir, fileName)
+      : path.join(__dirname, "..", "..", payloadDir, fileName);
 
     if (!fs.existsSync(payloadPath)) {
       throw new Error(`Payload file not found: ${payloadPath}`);