k6-cucumber-steps 1.1.7 → 1.1.9

package/bin/k6-cucumber-steps.js

@@ -19,110 +19,107 @@ program
   .command("run")
   .option("-f, --feature <path>", "Feature file path")
   .option("-t, --tags <string>", "Cucumber tags")
-  .option("-c, --config <file>", "Custom config file") // changed from --configFile to --config
+  .option("-c, --config <file>", "Custom config file")
   .option("-r, --reporter", "Enable report generation", false)
   .option("-o, --overwrite", "Overwrite report files", false)
   .option("--cleanReports", "Clean the reports folder before running")
-  .option("--clean", "Alias for --cleanReports");
+  .option("--clean", "Alias for --cleanReports")
+  .option("-p, --payloadPath <dir>", "Directory for payload files")
+  .action(async (argv) => {
+    // Load config file
+    const configFileInput =
+      argv.config || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
+    const configFilePath = path.isAbsolute(configFileInput)
+      ? configFileInput
+      : 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);
+      }
+    }
 
-program.parse(process.argv);
+    // 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);
+    }
+
+    // Add require
+    if (cucumberConfig.require && Array.isArray(cucumberConfig.require)) {
+      cucumberConfig.require.forEach((req) => {
+        cliParts.push("--require", req);
+      });
+    }
 
-const argv = program.opts();
-
-const cucumberArgs = ["cucumber-js"];
-
-// Update all references to argv.configFile to argv.config:
-const configFileInput =
-  argv.config || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
-const configFilePath = path.isAbsolute(configFileInput)
-  ? configFileInput
-  : 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 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));
-}
-
-let baseReportName = "load-report";
-if (featureFiles.length === 1) {
-  baseReportName = path.basename(featureFiles[0], ".feature");
-} else if (featureFiles.length > 1) {
-  baseReportName = "multi-feature";
-}
-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}`);
-}
-
-console.log("\n▶️ Final arguments passed to cucumber-js:");
-console.log(["npx", ...cucumberArgs].join(" ") + "\n");
-
-const cucumberProcess = spawn("npx", cucumberArgs, {
-  stdio: "inherit",
-  env: {
-    ...process.env,
-    REPORT_HTML_PATH: reportHtmlPath,
-    K6_CUCUMBER_OVERWRITE: argv.overwrite ? "true" : "false",
-  },
-});
-
-cucumberProcess.on("close", async (code) => {
-  if (code === 0) {
-    console.log("-----------------------------------------");
-    console.log("✅ k6-cucumber-steps execution completed successfully.");
-    try {
-      await linkReports();
-      console.log("🔗 Reports linked successfully with embedded Cucumber tab.");
-    } catch (err) {
-      console.error("⚠️ Failed to link reports:", err.message);
+    // Add format
+    if (cucumberConfig.format && Array.isArray(cucumberConfig.format)) {
+      cucumberConfig.format.forEach((fmt) => {
+        cliParts.push("--format", fmt);
+      });
     }
-    console.log("-----------------------------------------");
-  } else {
-    console.error("-----------------------------------------");
-    console.error("❌ k6-cucumber-steps execution failed.");
-    console.error("-----------------------------------------");
-  }
-  process.exit(code);
-});
+
+    // Add tags
+    if (cucumberConfig.tags) {
+      cliParts.push("--tags", cucumberConfig.tags);
+    }
+
+    // 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);
+
+    // Now spawn the process
+    const cucumberProcess = spawn("npx", ["cucumber-js", ...cliParts], {
+      stdio: "inherit",
+    });
+
+    cucumberProcess.on("close", async (code) => {
+      if (code === 0) {
+        console.log("-----------------------------------------");
+        console.log("✅ k6-cucumber-steps execution completed successfully.");
+        try {
+          await linkReports();
+          console.log(
+            "🔗 Reports linked successfully with embedded Cucumber tab."
+          );
+        } catch (err) {
+          console.error("⚠️ Failed to link reports:", err.message);
+        }
+        console.log("-----------------------------------------");
+      } else {
+        console.error("-----------------------------------------");
+        console.error("❌ k6-cucumber-steps execution failed.");
+        console.error("-----------------------------------------");
+      }
+      process.exit(code);
+    });
+  });
+
+program.parse(process.argv);

package/package.json

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

package/scripts/cucumber.js

@@ -0,0 +1,18 @@
+module.exports = {
+  default: {
+    require: ["./step_definitions/**/*.js"],
+    format: [
+      "summary",
+      "json:./reports/load-report.json",
+      "html:./reports/cucumber-report.html",
+    ],
+    paths: ["./features/bsp.feature"],
+    tags: "@get",
+    cleanReports: true,
+    worldParameters: {
+      payloadPath: "payloads",
+    },
+    overwrite: true,
+    reporter: true,
+  },
+};

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}`);