k6-cucumber-steps 1.2.22 → 1.2.24

package/bin/k6-cucumber-steps.js

@@ -1,11 +1,17 @@
 #!/usr/bin/env node
-const path = require("path");
-const fs = require("fs");
-const { spawn } = require("child_process");
-const { Command } = require("commander");
-require("dotenv").config();
+import path from "path";
+import fs from "fs/promises";
+import { spawn } from "child_process";
+import { Command } from "commander";
+import { fileURLToPath } from "url";
+import dotenv from "dotenv";
+import { linkReports } from "../scripts/linkReports.js";
 
-const { linkReports } = require("../scripts/linkReports");
+dotenv.config();
+
+// Allow __dirname in ESM
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 console.log(`
   -----------------------------------------
@@ -26,9 +32,9 @@ program
   .option("--reporter", "Enable report generation", false)
   .option("--clean", "Alias for --cleanReports", false)
   .option("-p, --payloadPath <dir>", "Directory for payload files")
-  // Add CLI options for all config options
+  .option("--script <file>", "k6 script file to run")
+  .option("--k6Config <file>", "k6 config file to use")
   .action(async (argv) => {
-    // Load config file
     const configFileInput =
       argv.config || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
     const configFilePath = path.isAbsolute(configFileInput)
@@ -36,20 +42,16 @@ program
       : path.resolve(process.cwd(), configFileInput);
 
     let configOptions = {};
-    if (fs.existsSync(configFilePath)) {
-      try {
-        const loadedConfig = require(configFilePath);
-        configOptions = loadedConfig.default || loadedConfig;
-      } catch (err) {
-        console.warn("⚠️ Could not load config file:", err.message);
-      }
+    try {
+      const configModule = await import(pathToFileURL(configFilePath).href);
+      configOptions = configModule.default || configModule;
+    } catch (err) {
+      console.warn("⚠️ Could not load config file:", err.message);
     }
 
-    // Build the cucumber-js command from config
     const cucumberConfig = configOptions.default || configOptions;
-    let cliParts = [];
+    const cliParts = [];
 
-    // Add paths
     if (cucumberConfig.paths && Array.isArray(cucumberConfig.paths)) {
       cliParts.push(...cucumberConfig.paths);
     }
@@ -57,21 +59,14 @@ program
       cliParts.push(argv.feature);
     }
 
-    // Add require
     if (cucumberConfig.require && Array.isArray(cucumberConfig.require)) {
-      cucumberConfig.require.forEach((req) => {
-        cliParts.push("--require", req);
-      });
+      cucumberConfig.require.forEach((req) => cliParts.push("--require", req));
     }
 
-    // Add format
     if (cucumberConfig.format && Array.isArray(cucumberConfig.format)) {
-      cucumberConfig.format.forEach((fmt) => {
-        cliParts.push("--format", fmt);
-      });
+      cucumberConfig.format.forEach((fmt) => cliParts.push("--format", fmt));
     }
 
-    // Add tags
     if (cucumberConfig.tags) {
       cliParts.push("--tags", cucumberConfig.tags);
     }
@@ -79,26 +74,23 @@ program
       cliParts.push("--tags", argv.tags);
     }
 
-    // Determine project root (where your main package.json is)
     const projectRoot = process.cwd();
 
-    // 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.resolve(projectRoot, payloadDirRaw);
     console.log("📦 Resolved payload path:", payloadDir);
 
-    // Add --world-parameters to CLI args
     const worldParams = {
       ...(cucumberConfig.worldParameters || {}),
       payloadPath: payloadDir,
     };
     cliParts.push("--world-parameters", JSON.stringify(worldParams));
 
-    // Add CLI options for k6 script and config
     if (argv.script) {
       cliParts.push("--script", argv.script);
     }
@@ -107,12 +99,9 @@ program
     }
 
     const finalCommand = ["npx", "cucumber-js", ...cliParts].join(" ");
-
     console.log("▶️ Final arguments passed to cucumber-js:", finalCommand);
 
-    // Collect options to pass as env vars
     const extraEnv = {
-      // Priority: cucumberConfig > CLI
       SAVE_K6_SCRIPT:
         cucumberConfig.saveK6Script === true || argv.saveK6Script === true
           ? "true"
@@ -133,19 +122,19 @@ program
           : "false",
     };
 
-    // Clean reports directory if requested
     const shouldCleanReports =
       argv.cleanReports || argv.clean || 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 });
+      try {
+        await fs.rm(reportsDir, { recursive: true, force: true });
+        await fs.mkdir(reportsDir, { recursive: true });
+      } catch (err) {
+        console.error("Failed to clean reports folder:", err.message);
       }
     }
 
-    // Now spawn the process
     const cucumberProcess = spawn("npx", ["cucumber-js", ...cliParts], {
       stdio: "inherit",
       env: { ...process.env, ...extraEnv },
@@ -174,3 +163,9 @@ program
   });
 
 program.parse(process.argv);
+
+// Helper to handle dynamic import path
+function pathToFileURL(p) {
+  const url = new URL("file://" + path.resolve(p));
+  return url;
+}

package/package.json

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

package/scripts/linkReports.js

@@ -1,16 +1,44 @@
-const fs = require("fs");
-const path = require("path");
-const { minify } = require("html-minifier-terser");
+import fs from "fs";
+import path from "path";
+import { minify } from "html-minifier-terser";
+import { fileURLToPath } from "url";
+import { exec } from "child_process";
+import os from "os";
 
-const reportsDir = path.resolve("reports");
+// ESM __dirname workaround
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-async function linkReports() {
+const reportsDir = path.resolve(__dirname, "../reports");
+
+/**
+ * Opens a file in the default browser based on OS.
+ * @param {string} filePath - Absolute file path to open.
+ */
+function openInBrowser(filePath) {
+  const platform = os.platform();
+  const command =
+    platform === "darwin"
+      ? `open "${filePath}"`
+      : platform === "win32"
+      ? `start "" "${filePath}"`
+      : `xdg-open "${filePath}"`; // Linux
+
+  exec(command, (err) => {
+    if (err) {
+      console.error("⚠️ Failed to open the report in browser:", err.message);
+    } else {
+      console.log("🌐 Report opened in your default browser.");
+    }
+  });
+}
+
+export async function linkReports() {
   if (!fs.existsSync(reportsDir)) {
     console.warn("⚠️ No reports directory found.");
     return;
   }
 
-  // Get all HTML files in the reports directory, excluding any with "combined-" in the name
   const htmlFiles = fs
     .readdirSync(reportsDir)
     .filter((f) => f.endsWith(".html") && !f.includes("combined-"))
@@ -25,43 +53,40 @@ async function linkReports() {
     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 (!k6Report || otherReports.length === 0) {
     console.warn("⚠️ K6 or any other HTML report not found.");
     return;
   }
 
-  // Read k6 report content
   let content = fs.readFileSync(k6Report.path, "utf8");
 
-  // 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>
+    <label for="tab${idx + 2}"><i class="fas fa-file-alt"></i> &nbsp; ${
+        report.name
+      }</label>
     <div class="tab">
-      <iframe src="${report.name}" 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"/,
     `${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>/,
     ""
@@ -77,6 +102,6 @@ async function linkReports() {
   fs.writeFileSync(combinedPath, minified, "utf8");
 
   console.log(`📄 Combined report generated at: ${combinedPath}`);
-}
 
-module.exports = { linkReports };
+  openInBrowser(combinedPath);
+}