k6-cucumber-steps 1.2.24 → 1.2.26

package/lib/helpers/buildK6Script.js

@@ -1,20 +1,31 @@
-export default function buildK6Script(config) {
-  const { method, endpoints, endpoint, body, headers, options, baseUrl } =
-    config;
+export default function buildK6Script(config = {}) {
+  const {
+    method: httpMethod,
+    endpoints,
+    endpoint,
+    body,
+    headers,
+    options,
+    baseUrl,
+    worldParameters,
+  } = config;
 
   const BASE_URL =
     baseUrl ||
-    (config.worldParameters && config.worldParameters.baseUrl) ||
+    (worldParameters && worldParameters.baseUrl) ||
     process.env.API_BASE_URL ||
     process.env.BASE_URL;
 
   if (!BASE_URL) {
     throw new Error(
-      "No base URL found: please provide baseUrl inline (step/world/feature) or set API_BASE_URL/BASE_URL in environment variables."
+      "❌ No base URL found: please provide baseUrl inline (step/world/feature) or set API_BASE_URL/BASE_URL in environment variables."
     );
   }
 
   const resolveEndpoint = (url) => {
+    if (!url || typeof url !== "string") {
+      throw new Error("❌ Invalid or missing endpoint URL.");
+    }
     return url.startsWith("/") ? `${BASE_URL}${url}` : url;
   };
 
@@ -31,6 +42,12 @@ export default function buildK6Script(config) {
     process.env.npm_config_report_output_dir ||
     "reports";
 
+  if (!endpoint && (!Array.isArray(endpoints) || endpoints.length === 0)) {
+    throw new Error(
+      "❌ You must provide either 'endpoint' or 'endpoints' to buildK6Script."
+    );
+  }
+
   return `
 import http from 'k6/http';
 import { check } from 'k6';
@@ -44,33 +61,33 @@ export default function () {
   const body = ${stringifiedBody};
 
   ${
-    endpoints?.length
+    Array.isArray(endpoints) && endpoints.length
       ? endpoints
           .map(
             (url, i) => `
   const resolvedUrl${i} = "${resolveEndpoint(url)}";
-  const res${i} = http.request("${method}", resolvedUrl${i}, ${
-              method === "GET" || method === "DELETE"
+  const res${i} = http.request("${httpMethod}", resolvedUrl${i}, ${
+              httpMethod === "GET" || httpMethod === "DELETE"
                 ? "null"
                 : "JSON.stringify(body)"
             }, { headers });
   check(res${i}, {
     "status is 2xx": (r) => r.status >= 200 && r.status < 300,
-  "response body is not empty": (r) => r.body && r.body.length > 0,
+    "response body is not empty": (r) => r.body && r.body.length > 0,
   });
   `
           )
           .join("\n")
       : `
   const resolvedUrl = "${resolveEndpoint(endpoint)}";
-  const res = http.request("${method}", resolvedUrl, ${
-          method === "GET" || method === "DELETE"
+  const res = http.request("${httpMethod}", resolvedUrl, ${
+          httpMethod === "GET" || httpMethod === "DELETE"
             ? "null"
             : "JSON.stringify(body)"
         }, { headers });
   check(res, {
     "status is 2xx": (r) => r.status >= 200 && r.status < 300,
-  "response body is not empty": (r) => r.body && r.body.length > 0,
+    "response body is not empty": (r) => r.body && r.body.length > 0,
   });
   `
   }

package/lib/helpers/resolveBody.js

@@ -1,6 +1,10 @@
-const fs = require("fs");
-const path = require("path");
-const faker = require("@faker-js/faker").faker;
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import { faker } from "@faker-js/faker";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 /**
  * Recursively resolves all placeholders in an object.
@@ -60,7 +64,7 @@ function resolveDeep(data, env) {
  * @param {object} env - Object containing environment variables or aliases
  * @returns {object} - Fully resolved JS object
  */
-module.exports = function resolveBody(template, env = {}) {
+export default function resolveBody(template, env = {}) {
   try {
     const parsed = JSON.parse(template);
     return resolveDeep(parsed, env);
@@ -71,4 +75,4 @@ module.exports = function resolveBody(template, env = {}) {
     );
     throw new Error("Invalid JSON template provided to resolveBody");
   }
-};
+}

package/lib/helpers/runK6ScriptFromWorld.js

@@ -1,3 +1,6 @@
+import { generateK6Script, runK6Script } from "../utils/k6Runner.js";
+import buildK6Script from "./buildK6Script.js";
+
 export async function runK6ScriptFromWorld(world, method, isMulti = false) {
   const scriptContent = buildK6Script({
     method,

package/lib/utils/k6Runner.js

@@ -3,12 +3,13 @@ import { exec } from "child_process";
 import { v4 as uuidv4 } from "uuid";
 import { promises as fs } from "fs";
 import { fileURLToPath } from "url";
-import packageJson from "../../package.json" assert { type: "json" };
 
 // __dirname workaround for ESM
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-
+const pkgPath = path.resolve(__dirname, "../../package.json");
+const pkgContent = await fs.readFile(pkgPath, "utf-8");
+const packageJson = JSON.parse(pkgContent);
 /**
  * Generates a temporary k6 script file.
  * @param {string} scriptContent - The content of the k6 script.

package/package.json

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

package/step_definitions/load_test_steps.js

@@ -1,21 +1,15 @@
 // e2e/step_definitions/load_test_steps.js
 
 import { Given, When, Then } from "@cucumber/cucumber";
-import path from "path";
 import fs from "fs";
-import { fileURLToPath } from "url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
+import path from "path";
 import crypto from "crypto";
 import * as dotenv from "dotenv";
 import resolvePayloadPath from "../lib/helpers/resolvePayloadPath.js";
 import resolveBody from "../lib/helpers/resolveBody.js";
-// import buildK6Script from "../lib/helpers/buildK6Script.js";
+import buildK6Script from "../lib/helpers/buildK6Script.js";
 import generateHeaders from "../lib/helpers/generateHeaders.js";
-// import { runK6Script } from "../lib/utils/k6Runner.js";
-import { runK6ScriptFromWorld } from "../../../helpers/runK6ScriptFromWorld.js";
+import { runK6Script } from "../lib/utils/k6Runner.js";
 
 dotenv.config();
 
@@ -352,7 +346,7 @@ export async function When_I_set_method_body_for_endpoint(
   );
 }
 When(
-  /^I set the following (\w+) body is used for "([^"]+)"$/,
+  `^I set the following (\w+) body is used for "([^"]+)"$`,
   When_I_set_method_body_for_endpoint
 );
 /**
@@ -617,95 +611,79 @@ if (!fs.existsSync(reportDir)) {
   fs.mkdirSync(reportDir, { recursive: true });
 }
 
-// Then(
-//   /^I see the API should handle the (\w+) request successfully$/,
-//   { timeout: 300000 },
-//   async function (method) {
-//     if (!this.config || !this.config.method) {
-//       throw new Error("Configuration is missing or incomplete.");
-//     }
-//     const expectedMethod = method.toUpperCase();
-//     const actualMethod = this.config.method.toUpperCase();
-//     if (actualMethod !== expectedMethod) {
-//       throw new Error(
-//         `Mismatched HTTP method: expected "${expectedMethod}", got "${actualMethod}"`
-//       );
-//     }
-//     try {
-//       const scriptContent = buildK6Script(this.config);
-//       const uniqueId = crypto.randomBytes(8).toString("hex");
-//       const scriptFileName = `k6-script-${uniqueId}.js`;
-//       const scriptPath = path.join(reportDir, scriptFileName);
-//       fs.writeFileSync(scriptPath, scriptContent, "utf-8");
-//       this.log?.(`✅ k6 script generated at: "${scriptPath}"`);
-
-//       this.log?.(`🚀 Running k6 script: "${scriptFileName}"...`);
-//       const { stdout, stderr, code } = await runK6Script(
-//         scriptPath,
-//         process.env.K6_CUCUMBER_OVERWRITE === "true"
-//       );
-//       if (stdout) this.log?.(`k6 STDOUT:\n${stdout}`);
-//       if (stderr) this.log?.(`k6 STDERR:\n${stderr}`);
-
-//       if (code !== 0) {
-//         throw new Error(
-//           `k6 process exited with code ${code}. Check k6 output for details.`
-//         );
-//       }
-//       this.log?.(
-//         `✅ k6 script executed successfully for ${expectedMethod} request.`
-//       );
-
-//       const saveK6Script =
-//         process.env.saveK6Script === "true" ||
-//         process.env.SAVE_K6_SCRIPT === "true" ||
-//         this.parameters?.saveK6Script === true;
-
-//       if (!saveK6Script) {
-//         try {
-//           fs.unlinkSync(scriptPath);
-//           this.log?.(`🧹 Temporary k6 script deleted: "${scriptPath}"`);
-//         } catch (cleanupErr) {
-//           this.log?.(
-//             `⚠️ Warning: Could not delete temporary k6 script file: "${scriptPath}". Error: ${
-//               cleanupErr instanceof Error
-//                 ? cleanupErr.message
-//                 : String(cleanupErr)
-//             }`
-//           );
-//         }
-//       } else {
-//         this.log?.(
-//           `ℹ️  k6 script kept at: "${scriptPath}". Set SAVE_K6_SCRIPT=false to delete automatically.`
-//         );
-//       }
-//     } catch (error) {
-//       this.log?.(
-//         `❌ Failed to generate or run k6 script: ${
-//           error instanceof Error ? error.message : String(error)
-//         }`
-//       );
-//       throw new Error(
-//         `k6 script generation or execution failed: ${
-//           error instanceof Error ? error.message : String(error)
-//         }`
-//       );
-//     }
-//   }
-// );
-
-// Single endpoint
 Then(
-  "I see the API should handle the {word} request successfully",
+  /^I see the API should handle the (\w+) request successfully$/,
+  { timeout: 300000 },
   async function (method) {
-    await runK6ScriptFromWorld(this, method);
-  }
-);
+    if (!this.config || !this.config.method) {
+      throw new Error("Configuration is missing or incomplete.");
+    }
+    const expectedMethod = method.toUpperCase();
+    const actualMethod = this.config.method.toUpperCase();
+    if (actualMethod !== expectedMethod) {
+      throw new Error(
+        `Mismatched HTTP method: expected "${expectedMethod}", got "${actualMethod}"`
+      );
+    }
+    try {
+      const scriptContent = buildK6Script(this.config);
+      const uniqueId = crypto.randomBytes(8).toString("hex");
+      const scriptFileName = `k6-script-${uniqueId}.js`;
+      const scriptPath = path.join(reportDir, scriptFileName);
+      fs.writeFileSync(scriptPath, scriptContent, "utf-8");
+      this.log?.(`✅ k6 script generated at: "${scriptPath}"`);
+
+      this.log?.(`🚀 Running k6 script: "${scriptFileName}"...`);
+      const { stdout, stderr, code } = await runK6Script(
+        scriptPath,
+        process.env.K6_CUCUMBER_OVERWRITE === "true"
+      );
+      if (stdout) this.log?.(`k6 STDOUT:\n${stdout}`);
+      if (stderr) this.log?.(`k6 STDERR:\n${stderr}`);
 
-// Multi-endpoint
-Then(
-  "I run the script for multiple endpoints with method {word}",
-  async function (method) {
-    await runK6ScriptFromWorld(this, method, true);
+      if (code !== 0) {
+        throw new Error(
+          `k6 process exited with code ${code}. Check k6 output for details.`
+        );
+      }
+      this.log?.(
+        `✅ k6 script executed successfully for ${expectedMethod} request.`
+      );
+
+      const saveK6Script =
+        process.env.saveK6Script === "true" ||
+        process.env.SAVE_K6_SCRIPT === "true" ||
+        this.parameters?.saveK6Script === true;
+
+      if (!saveK6Script) {
+        try {
+          fs.unlinkSync(scriptPath);
+          this.log?.(`🧹 Temporary k6 script deleted: "${scriptPath}"`);
+        } catch (cleanupErr) {
+          this.log?.(
+            `⚠️ Warning: Could not delete temporary k6 script file: "${scriptPath}". Error: ${
+              cleanupErr instanceof Error
+                ? cleanupErr.message
+                : String(cleanupErr)
+            }`
+          );
+        }
+      } else {
+        this.log?.(
+          `ℹ️  k6 script kept at: "${scriptPath}". Set SAVE_K6_SCRIPT=false to delete automatically.`
+        );
+      }
+    } catch (error) {
+      this.log?.(
+        `❌ Failed to generate or run k6 script: ${
+          error instanceof Error ? error.message : String(error)
+        }`
+      );
+      throw new Error(
+        `k6 script generation or execution failed: ${
+          error instanceof Error ? error.message : String(error)
+        }`
+      );
+    }
   }
 );

package/step_definitions/world.js

@@ -1,5 +1,5 @@
 //world.js
-const { setWorldConstructor } = require("@cucumber/cucumber");
+import { setWorldConstructor } from "@cucumber/cucumber";
 
 class CustomWorld {
   constructor({ parameters, pickle }) {