k6-cucumber-steps 1.0.32 → 1.0.34

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["cucumberopen.cucumber-official"]
+}

package/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "cucumber.features": [
+    "src/features/*.feature",
+    "src/features/**/*.feature",
+    "src/features/**/*.k6.feature",
+    "src/features/template/*.feature"
+  ],
+  "cucumber.glue": [
+    "step_definitions/*.js",
+    "src/features/stepDefinitions/*.js"
+  ]
+}

package/README.md

@@ -122,6 +122,7 @@ Here's a step-by-step guide to using `k6-cucumber-steps` in your project:
         "json:reports/load-report.json", // For JSON report
         "html:reports/report.html", // For HTML report
       ],
+      paths: ["./features/*.feature"],
       tags: process.env.TAGS,
       overwrite: false, // Default to not overwrite the report file
     };
@@ -172,12 +173,12 @@ Feature: API Performance Testing
     When I set to run the k6 script with the following configurations:
       | virtual_users | duration | http_req_failed | http_req_duration |
       | 50            | 10       | rate<0.05       | p(95)<3000        |
-    And I set the following endpoint(s) used:
+    And I set the following endpoints used:
       """
       /api/profile
       [https://reqres.in/api/users?page=2](https://reqres.in/api/users?page=2)
       """
-    And when the authentication type is "none"
+    And I set the authentication type to "none"
     Then I see the API should handle the GET request successfully
 ```
 
@@ -190,9 +191,9 @@ Feature: API Performance Testing
     Given I set a k6 script for POST testing
     When I set to run the k6 script with the following configurations:
       | virtual_users | duration | http_req_failed | http_req_duration |
-      | 20            | 60       | rate<0.01       | p(95)<300         |
-    And the authentication type is "bearer_token"
-    And I set the following endpoint(s) used:
+      |            20 |       60 | rate<0.01       | p(95)<300         |
+    When I set the authentication type to "bearer_token"
+    And I set the following endpoints used:
       """
       /api/v1/users
       """
@@ -204,6 +205,7 @@ Feature: API Performance Testing
       }
       """
     Then I see the API should handle the POST request successfully
+
 ```
 
 ## Step Definitions
@@ -211,10 +213,10 @@ Feature: API Performance Testing
 ### Authentication Steps
 
 ```gherkin
-When I set the authentication type is "api_key"
-When I set the authentication type is "bearer_token"
-When I set the authentication type is "basic"
-When I set the authentication type is "none"
+When I set the authentication type to "api_key"
+When I set the authentication type to "bearer_token"
+When I set the authentication type to "basic"
+When I set the authentication type to "none"
 ```
 
 ### Request Configuration Steps
@@ -223,7 +225,7 @@ When I set the authentication type is "none"
 Given I set a k6 script for {word} testing
 When I set to run the k6 script with the following configurations:
 When I set the request headers:
-When I set the following endpoint(s) used:
+When I set the following endpoints used:
 When I set the following {word} body is used for {string}
 ```
 

package/bin/k6-cucumber-steps.js

@@ -6,7 +6,6 @@ const { spawn } = require("child_process");
 const yargs = require("yargs");
 require("dotenv").config();
 
-// 🚀 Welcome Message
 console.log(`
   -----------------------------------------
   🚀 Starting k6-cucumber-steps execution...
@@ -50,22 +49,15 @@ const configFileName =
   argv.configFile || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
 const configFilePath = path.resolve(process.cwd(), configFileName);
 
-console.log(`🔍 Looking for config file: ${configFileName}`);
-console.log(`📁 Resolved config file path: ${configFilePath}`);
-
 let configOptions = {};
 if (fs.existsSync(configFilePath)) {
-  console.log("✅ Config file found, including in cucumber arguments...");
   cucumberArgs.push("--config", configFileName);
-
   try {
     const loadedConfig = require(configFilePath);
     configOptions = loadedConfig.default || loadedConfig;
-  } catch (err) {
-    console.warn("⚠️  Failed to load options from config file.");
+  } catch {
+    console.warn("⚠️  Could not load config file");
   }
-} else {
-  console.warn("⚠️  Config file not found, skipping...");
 }
 
 // Tags
@@ -74,66 +66,69 @@ if (tags) {
   cucumberArgs.push("--tags", tags);
 }
 
-// Feature file(s)
-const feature = argv.feature || process.env.FEATURE_PATH;
-if (feature) {
-  cucumberArgs.push(path.resolve(process.cwd(), feature));
+// Feature path(s)
+let featureFiles = [];
+if (argv.feature) {
+  featureFiles.push(path.resolve(argv.feature));
 } else if (configOptions.paths && configOptions.paths.length > 0) {
-  cucumberArgs.push(...configOptions.paths);
+  featureFiles.push(...configOptions.paths);
+}
+if (featureFiles.length > 0) {
+  cucumberArgs.push(...featureFiles);
 }
 
-// Reporting
+// Require default step definitions
+const defaultStepsPath = path.resolve(
+  process.cwd(),
+  "node_modules",
+  "k6-cucumber-steps",
+  "step_definitions"
+);
+cucumberArgs.push("--require", defaultStepsPath);
+
+// Also require additional custom step definitions from config, if any
+if (configOptions.require && Array.isArray(configOptions.require)) {
+  for (const reqPath of configOptions.require) {
+    cucumberArgs.push("--require", reqPath);
+  }
+}
+
+// Determine base report name
 const reportsDir = path.join(process.cwd(), "reports");
 const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
 
-const shouldGenerateReports = argv.reporter || configOptions.reporter || false;
+let baseReportName = "load-results";
+if (featureFiles.length === 1) {
+  const nameFromFeature = path.basename(featureFiles[0], ".feature");
+  baseReportName = nameFromFeature || baseReportName;
+} else if (featureFiles.length > 1) {
+  baseReportName = "multi-feature";
+}
 
+const shouldGenerateReports = argv.reporter || configOptions.reporter || false;
 const shouldOverwrite =
   argv.overwrite ||
   process.env.K6_CUCUMBER_OVERWRITE === "true" ||
   configOptions.overwrite === true;
 
-// Build base names from feature file(s)
-let baseNames = [];
+let reportJsonPath = path.join(reportsDir, `${baseReportName}.json`);
+let reportHtmlPath = path.join(reportsDir, `${baseReportName}.html`);
 
-if (feature) {
-  baseNames = [path.basename(feature, path.extname(feature))];
-} else if (configOptions.paths && configOptions.paths.length > 0) {
-  baseNames = configOptions.paths.map((p) => path.basename(p, path.extname(p)));
-} else {
-  baseNames = ["load-results"];
+if (!shouldOverwrite) {
+  reportJsonPath = path.join(reportsDir, `${baseReportName}-${timestamp}.json`);
+  reportHtmlPath = path.join(reportsDir, `${baseReportName}-${timestamp}.html`);
 }
 
-// Generate report paths
-const reportPaths = baseNames.map((base) => {
-  const jsonName = shouldOverwrite
-    ? `${base}.json`
-    : `${base}-${timestamp}.json`;
-  const htmlName = shouldOverwrite
-    ? `${base}.html`
-    : `${base}-${timestamp}.html`;
-
-  return {
-    json: path.join(reportsDir, jsonName),
-    html: path.join(reportsDir, htmlName),
-  };
-});
+const formatInConfig =
+  Array.isArray(configOptions.format) && configOptions.format.length > 0;
 
-// Inject report formats into cucumber arguments
-if (shouldGenerateReports) {
+if (shouldGenerateReports && !formatInConfig) {
   fs.mkdirSync(reportsDir, { recursive: true });
-
-  cucumberArgs.push("--format", "summary");
-
-  reportPaths.forEach(({ json, html }) => {
-    cucumberArgs.push("--format", `json:${json}`);
-    cucumberArgs.push("--format", `html:${html}`);
-  });
+  cucumberArgs.push("--format", `summary`);
+  cucumberArgs.push("--format", `json:${reportJsonPath}`);
+  cucumberArgs.push("--format", `html:${reportHtmlPath}`);
 }
 
-console.log("📝 Reporter Enabled:", shouldGenerateReports);
-console.log("📝 Overwrite Enabled:", shouldOverwrite);
-
 console.log("\n▶️ Final arguments passed to cucumber-js:");
 console.log(["npx", ...cucumberArgs].join(" ") + "\n");
 
@@ -143,9 +138,9 @@ const cucumberProcess = spawn("npx", cucumberArgs, {
     ...process.env,
     K6_CUCUMBER_OVERWRITE: shouldOverwrite ? "true" : "false",
     TAGS: tags,
-    FEATURE_PATH: feature,
-    REPORT_JSON_PATH: reportPaths[0]?.json,
-    REPORT_HTML_PATH: reportPaths[0]?.html,
+    FEATURE_PATH: featureFiles.join(","),
+    REPORT_JSON_PATH: reportJsonPath,
+    REPORT_HTML_PATH: reportHtmlPath,
   },
 });
 

package/index.js

@@ -1,24 +1 @@
-// Import necessary modules
-const buildK6Script = require("./libs/helpers/buildK6Script");
-const generateHeaders = require("./libs/helpers/generateHeaders");
-const resolveBody = require("./libs/helpers/resolveBody");
-const {
-  generateK6Script: generateTempK6Script,
-  runK6Script,
-} = require("./libs/utils/k6Runner");
-
-// Export the main functionalities of the package
-module.exports = {
-  // Helper functions
-  buildK6Script,
-  generateHeaders,
-  resolveBody,
-
-  // k6 script generation and execution utilities
-  generateK6Script: generateTempK6Script,
-  runK6Script,
-
-  // Step definitions (optional, if users need direct access)
-  stepDefinitions: require("./step_definitions/load_test_steps"),
-};
 export * from "./step_definitions/load_test_steps.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k6-cucumber-steps",
-  "version": "1.0.32",
+  "version": "1.0.34",
   "main": "index.js",
   "license": "MIT",
   "repository": {
@@ -50,23 +50,21 @@
   "author": "qaPaschalE",
   "description": "Cucumber step definitions for running k6 performance tests.",
   "devDependencies": {
-    "@babel/cli": "^7.27.0",
-    "@babel/core": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
-    "@types/k6": "^1.0.2",
-    "child_process": "^1.0.2",
-    "cucumber-console-formatter": "^1.0.0",
-    "cucumber-html-reporter": "^6.0.0",
-    "esbuild": "^0.25.3",
-    "form-data": "^4.0.2",
-    "k6": "^0.0.0",
-    "tsconfig-paths": "^4.2.0"
-  },
-  "dependencies": {
-    "@babel/register": "^7.25.9",
-    "@cucumber/cucumber": "^11.2.0",
-    "@faker-js/faker": "^9.7.0",
-    "dotenv": "^16.5.0",
-    "yargs": "^17.7.2"
+    "@babel/cli": "latest",
+    "@babel/core": "latest",
+    "@babel/preset-env": "latest",
+    "@babel/register": "latest",
+    "@cucumber/cucumber": "latest",
+    "@faker-js/faker": "latest",
+    "@types/k6": "latest",
+    "child_process": "latest",
+    "cucumber-console-formatter": "latest",
+    "cucumber-html-reporter": "latest",
+    "dotenv": "latest",
+    "esbuild": "latest",
+    "form-data": "latest",
+    "k6": "latest",
+    "tsconfig-paths": "latest",
+    "yargs": "latest"
   }
 }