k6-cucumber-steps 1.2.27 → 2.0.1

package/dist/runners/k6.runner.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.K6Runner = void 0;
+// src/runners/k6.runner.ts
+const child_process_1 = require("child_process");
+const util_1 = require("util");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const feature_parser_1 = require("../generators/feature.parser");
+const k6_script_generator_1 = require("../generators/k6-script.generator");
+const execAsync = (0, util_1.promisify)(child_process_1.exec);
+class K6Runner {
+    async runFromFeatures(featuresPath, outputScriptPath, options = {}) {
+        console.log("Loading and parsing feature files...");
+        const parser = new feature_parser_1.FeatureParser();
+        let features = await parser.loadAndParseFeatures(featuresPath);
+        // Apply tag filtering if specified
+        if (options.tags) {
+            const tagFilters = options.tags.split(",");
+            features = this.filterFeaturesByTags(features, tagFilters);
+        }
+        // Apply group filtering if specified
+        if (options.group) {
+            features = this.filterFeaturesByGroup(features, options.group);
+        }
+        console.log(`Found ${features.length} feature files`);
+        // Get all scenarios from filtered features
+        const allScenarios = features.flatMap((f) => f.scenarios);
+        console.log(`Processing ${allScenarios.length} scenarios`);
+        // Load metadata from scenarios
+        const metadata = parser.loadScenarioMetadata(allScenarios);
+        // Generate k6 script
+        const generator = new k6_script_generator_1.K6ScriptGenerator();
+        const config = {
+            language: options.language || "ts",
+            featuresDir: featuresPath,
+            outputDir: path_1.default.dirname(outputScriptPath || "./generated"),
+            includeHtmlReporter: true,
+            author: "Enyimiri Chetachi Paschal (qaPaschalE)",
+            version: require("../../package.json").version,
+        };
+        const k6Script = generator.generateK6File(allScenarios, metadata, config);
+        // Write the generated script
+        const finalOutputPath = outputScriptPath || `./generated/test.generated.${config.language}`;
+        const outputDir = path_1.default.dirname(finalOutputPath);
+        if (!fs_1.default.existsSync(outputDir)) {
+            fs_1.default.mkdirSync(outputDir, { recursive: true });
+        }
+        fs_1.default.writeFileSync(finalOutputPath, k6Script);
+        console.log(`Generated k6 script: ${finalOutputPath}`);
+        // Run the k6 test
+        await this.runK6Test(finalOutputPath, options.additionalK6Options);
+    }
+    async runK6Test(scriptPath, additionalOptions) {
+        console.log("Running k6 test...");
+        const options = ["run", scriptPath];
+        if (additionalOptions) {
+            options.push(...additionalOptions);
+        }
+        const k6Command = `k6 ${options.join(" ")}`;
+        console.log(`Executing: ${k6Command}`);
+        try {
+            const { stdout, stderr } = await execAsync(k6Command);
+            if (stdout) {
+                console.log(stdout);
+            }
+            if (stderr) {
+                console.error(stderr);
+            }
+            console.log("K6 test completed successfully");
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                console.error(`K6 test failed: ${error.message}`);
+                if (error.stderr) {
+                    console.error(error.stderr);
+                }
+                throw error;
+            }
+            else {
+                console.error(`K6 test failed with unknown error:`, error);
+                throw new Error("K6 test execution failed");
+            }
+        }
+    }
+    async runGeneratedScript(scriptPath, options) {
+        if (!fs_1.default.existsSync(scriptPath)) {
+            throw new Error(`Generated script does not exist: ${scriptPath}`);
+        }
+        await this.runK6Test(scriptPath, options);
+    }
+    filterFeaturesByTags(features, tagFilters) {
+        return features
+            .map((feature) => ({
+            ...feature,
+            scenarios: feature.scenarios.filter((scenario) => tagFilters.some((filter) => scenario.tags.includes(filter))),
+        }))
+            .filter((feature) => feature.scenarios.length > 0); // Remove features with no matching scenarios
+    }
+    filterFeaturesByGroup(features, group) {
+        return features
+            .map((feature) => ({
+            ...feature,
+            scenarios: feature.scenarios.filter((scenario) => scenario.tags.some((tag) => tag.startsWith("group:") && tag.includes(group))),
+        }))
+            .filter((feature) => feature.scenarios.length > 0); // Remove features with no matching scenarios
+    }
+    async runWithFilters(featuresPath, filters) {
+        const additionalOptions = [];
+        if (filters.vus) {
+            additionalOptions.push(`--vus ${filters.vus}`);
+        }
+        if (filters.duration) {
+            additionalOptions.push(`--duration ${filters.duration}`);
+        }
+        await this.runFromFeatures(featuresPath, undefined, {
+            tags: filters.tags,
+            group: filters.group,
+            additionalK6Options: additionalOptions,
+        });
+    }
+}
+exports.K6Runner = K6Runner;
+//# sourceMappingURL=k6.runner.js.map

package/dist/runners/k6.runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"k6.runner.js","sourceRoot":"","sources":["../../src/runners/k6.runner.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA2B;AAC3B,iDAAqC;AACrC,+BAAiC;AACjC,4CAAoB;AACpB,gDAAwB;AAExB,iEAA6D;AAC7D,2EAAsE;AAEtE,MAAM,SAAS,GAAG,IAAA,gBAAS,EAAC,oBAAI,CAAC,CAAC;AAElC,MAAa,QAAQ;IACnB,KAAK,CAAC,eAAe,CACnB,YAAoB,EACpB,gBAAyB,EACzB,UAKI,EAAE;QAEN,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,8BAAa,EAAE,CAAC;QACnC,IAAI,QAAQ,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAE/D,mCAAmC;QACnC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3C,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC7D,CAAC;QAED,qCAAqC;QACrC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,MAAM,gBAAgB,CAAC,CAAC;QAEtD,2CAA2C;QAC3C,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,CAAC,MAAM,YAAY,CAAC,CAAC;QAE3D,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAE3D,qBAAqB;QACrB,MAAM,SAAS,GAAG,IAAI,uCAAiB,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG;YACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;YAClC,WAAW,EAAE,YAAY;YACzB,SAAS,EAAE,cAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,aAAa,CAAC;YAC1D,mBAAmB,EAAE,IAAI;YACzB,MAAM,EAAE,wCAAwC;YAChD,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO;SAC/C,CAAC;QAEF,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE1E,6BAA6B;QAC7B,MAAM,eAAe,GACnB,gBAAgB,IAAI,8BAA8B,MAAM,CAAC,QAAQ,EAAE,CAAC;QACtE,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEhD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,YAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,YAAE,CAAC,aAAa,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC;QAEvD,kBAAkB;QAClB,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,SAAS,CACb,UAAkB,EAClB,iBAA4B;QAE5B,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAElC,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACpC,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAE5C,OAAO,CAAC,GAAG,CAAC,cAAc,SAAS,EAAE,CAAC,CAAC;QAEvC,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,CAAC;YAEtD,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO,CAAC,KAAK,CAAC,mBAAmB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAClD,IAAK,KAAa,CAAC,MAAM,EAAE,CAAC;oBAC1B,OAAO,CAAC,KAAK,CAAE,KAAa,CAAC,MAAM,CAAC,CAAC;gBACvC,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;gBAC3D,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,UAAkB,EAClB,OAAkB;QAElB,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEO,oBAAoB,CAC1B,QAAuB,EACvB,UAAoB;QAEpB,OAAO,QAAQ;aACZ,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACjB,GAAG,OAAO;YACV,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/C,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAC5D;SACF,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,6CAA6C;IACrG,CAAC;IAEO,qBAAqB,CAC3B,QAAuB,EACvB,KAAa;QAEb,OAAO,QAAQ;aACZ,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACjB,GAAG,OAAO;YACV,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAChB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CACzD,CACF;SACF,CAAC,CAAC;aACF,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,6CAA6C;IACrG,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,YAAoB,EACpB,OAKC;QAED,MAAM,iBAAiB,GAAG,EAAE,CAAC;QAE7B,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,iBAAiB,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,iBAAiB,CAAC,IAAI,CAAC,cAAc,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,SAAS,EAAE;YAClD,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,mBAAmB,EAAE,iBAAiB;SACvC,CAAC,CAAC;IACL,CAAC;CACF;AA5KD,4BA4KC"}

package/dist/step-registry.d.ts

@@ -0,0 +1,14 @@
+declare const stepRegistry: {
+    givenSteps: Map<string, Function>;
+    whenSteps: Map<string, Function>;
+    thenSteps: Map<string, Function>;
+    andSteps: Map<string, Function>;
+    butSteps: Map<string, Function>;
+};
+export declare function Given(pattern: string, fn: Function): void;
+export declare function When(pattern: string, fn: Function): void;
+export declare function Then(pattern: string, fn: Function): void;
+export declare function And(pattern: string, fn: Function): void;
+export declare function But(pattern: string, fn: Function): void;
+export { stepRegistry };
+//# sourceMappingURL=step-registry.d.ts.map

package/dist/step-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-registry.d.ts","sourceRoot":"","sources":["../src/step-registry.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,YAAY;;;;;;CAMjB,CAAC;AAEF,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,CAEzD;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,CAExD;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,CAExD;AAED,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,CAGvD;AAED,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,IAAI,CAGvD;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/step-registry.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stepRegistry = void 0;
+exports.Given = Given;
+exports.When = When;
+exports.Then = Then;
+exports.And = And;
+exports.But = But;
+// src/step-registry.ts (create this file)
+// Internal registry to store step definitions
+const stepRegistry = {
+    givenSteps: new Map(),
+    whenSteps: new Map(),
+    thenSteps: new Map(),
+    andSteps: new Map(),
+    butSteps: new Map(),
+};
+exports.stepRegistry = stepRegistry;
+function Given(pattern, fn) {
+    stepRegistry.givenSteps.set(pattern, fn);
+}
+function When(pattern, fn) {
+    stepRegistry.whenSteps.set(pattern, fn);
+}
+function Then(pattern, fn) {
+    stepRegistry.thenSteps.set(pattern, fn);
+}
+function And(pattern, fn) {
+    // And is typically treated as When in Cucumber
+    stepRegistry.whenSteps.set(pattern, fn);
+}
+function But(pattern, fn) {
+    // But is typically treated as When in Cucumber
+    stepRegistry.whenSteps.set(pattern, fn);
+}
+//# sourceMappingURL=step-registry.js.map

package/dist/step-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-registry.js","sourceRoot":"","sources":["../src/step-registry.ts"],"names":[],"mappings":";;;AAUA,sBAEC;AAED,oBAEC;AAED,oBAEC;AAED,kBAGC;AAED,kBAGC;AA9BD,0CAA0C;AAC1C,8CAA8C;AAC9C,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,IAAI,GAAG,EAAoB;IACvC,SAAS,EAAE,IAAI,GAAG,EAAoB;IACtC,SAAS,EAAE,IAAI,GAAG,EAAoB;IACtC,QAAQ,EAAE,IAAI,GAAG,EAAoB;IACrC,QAAQ,EAAE,IAAI,GAAG,EAAoB;CACtC,CAAC;AAwBO,oCAAY;AAtBrB,SAAgB,KAAK,CAAC,OAAe,EAAE,EAAY;IACjD,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,SAAgB,IAAI,CAAC,OAAe,EAAE,EAAY;IAChD,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED,SAAgB,IAAI,CAAC,OAAe,EAAE,EAAY;IAChD,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED,SAAgB,GAAG,CAAC,OAAe,EAAE,EAAY;IAC/C,+CAA+C;IAC/C,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED,SAAgB,GAAG,CAAC,OAAe,EAAE,EAAY;IAC/C,+CAA+C;IAC/C,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1C,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,35 @@
+import { DataTable, DocString } from "@cucumber/messages";
+export interface FeatureFile {
+    path: string;
+    content: string;
+    scenarios: Scenario[];
+}
+export interface Scenario {
+    name: string;
+    steps: Step[];
+    tags: string[];
+    description?: string;
+}
+export interface Step {
+    keyword: string;
+    text: string;
+    argument?: DataTable | DocString;
+}
+export interface ScenarioMetadata {
+    scenarioName: string;
+    vus?: number;
+    duration?: string;
+    thresholds?: Record<string, any>;
+    tags: string[];
+    group?: string;
+    stages?: string;
+}
+export interface ProjectConfig {
+    language: "js" | "ts";
+    featuresDir: string;
+    outputDir: string;
+    includeHtmlReporter: boolean;
+    author: string;
+    version: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,8 +1,18 @@
 {
   "name": "k6-cucumber-steps",
-  "version": "1.2.27",
-  "main": "index.js",
-  "license": "MIT",
+  "version": "2.0.1",
+  "description": "Generate k6 test scripts from Cucumber feature files",
+  "main": "dist/cli.js",
+  "bin": {
+    "k6-cucumber-steps": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "node dist/cli.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/qaPaschalE/k6-cucumber-steps.git"
@@ -10,75 +20,43 @@
   "bugs": {
     "url": "https://github.com/qaPaschalE/k6-cucumber-steps/issues"
   },
-  "type": "module",
   "funding": {
     "type": "github",
     "url": "https://github.com/sponsors/qaPaschalE"
   },
   "homepage": "https://github.com/qaPaschalE/k6-cucumber-steps#readme",
-  "scripts": {
-    "stress": "npx cucumber-js --format json:stress-results.json --tags @stress",
-    "stress:report": "cucumber-html-reporter --jsonFile=stress-results.json --output=stress-report.html",
-    "loadTest": "npx cucumber-js --format json:reports/load-results.json --tags @loadTest",
-    "load:report": "cucumber-html-reporter --jsonFile=load-results.json --output=load-report.html",
-    "test": "cucumber-js features/ --require-module @babel/register --require step_definitions/",
-    "build": "npm run clean && npm run compile",
-    "clean": "rm -rf dist/",
-    "compile": "babel src/ -d dist/",
-    "docs": "jsdoc --configure jsdoc.json --verbose"
-  },
-  "cucumber": {
-    "require": [
-      "step_definitions/**/*.js"
-    ]
-  },
-  "bin": {
-    "k6-cucumber-steps": "./bin/k6-cucumber-steps.js"
-  },
-  "files": [
-    "bin/",
-    "lib/",
-    "step_definitions/",
-    "scripts/",
-    "package.json",
-    "README.md",
-    "docs/",
-    "LICENSE"
-  ],
   "keywords": [
     "k6",
     "cucumber",
-    "bdd",
-    "performance-testing",
-    "api-testing",
-    "load-testing",
-    "stress-testing",
-    "steps",
-    "test-automation"
+    "gherkin",
+    "testing",
+    "performance",
+    "automation",
+    "bdd"
   ],
-  "engines": {
-    "node": ">=20"
-  },
-  "author": "qaPaschalE <paschal.enyimiri@gmail.com>",
-  "description": "Cucumber step definitions for running k6 performance tests.",
-  "peerDependencies": {
-    "@cucumber/cucumber": "*",
-    "k6": "*"
-  },
+  "author": "Enyimiri Chetachi Paschal (qaPaschalE)",
+  "license": "MIT",
   "dependencies": {
-    "@babel/cli": "^7.27.2",
-    "@babel/core": "^7.27.4",
-    "@babel/preset-env": "^7.27.2",
-    "@babel/register": "^7.27.1",
-    "@faker-js/faker": "^9.8.0",
-    "@types/k6": "^1.0.2",
-    "commander": "^14.0.0",
-    "dotenv": "^16.5.0",
-    "html-minifier-terser": "^7.2.0"
+    "@cucumber/cucumber": "^12.6.0",
+    "@cucumber/gherkin": "^26.2.0",
+    "@cucumber/messages": "^23.0.0",
+    "commander": "^14.0.2",
+    "gherkin": "^9.0.0",
+    "typescript": "^5.9.3"
   },
   "devDependencies": {
-    "clean-jsdoc-theme": "^4.3.0",
-    "jsdoc": "^4.0.4",
-    "taffydb": "^2.7.3"
-  }
+    "@types/fs-extra": "^11.0.4",
+    "@types/jquery": "^3.5.33",
+    "@types/k6": "^1.5.0",
+    "@types/node": "^25.0.10",
+    "fs-extra": "^11.3.3",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-markdown": "^4.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "templates/**/*",
+    "README.md",
+    "LICENSE"
+  ]
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Enyimiri Chetachi Paschal
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of **k6-cucumber-steps** (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/bin/k6-cucumber-steps.js

@@ -1,176 +0,0 @@
-#!/usr/bin/env node
-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";
-
-dotenv.config();
-
-// Allow __dirname in ESM
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-console.log(`
-  -----------------------------------------
-  🚀 Starting k6-cucumber-steps execution...
-  -----------------------------------------
-`);
-
-const program = new Command();
-
-program
-  .command("run")
-  .option("-f, --feature <path>", "Feature file path")
-  .option("-t, --tags <string>", "Cucumber tags")
-  .option("-c, --config <file>", "Custom config file")
-  .option("--saveK6Script", "Keep generated k6 script files", false)
-  .option("--overwrite", "Overwrite report files", false)
-  .option("--cleanReports", "Clean the reports folder before running", false)
-  .option("--reporter", "Enable report generation", false)
-  .option("--clean", "Alias for --cleanReports", false)
-  .option("-p, --payloadPath <dir>", "Directory for payload files")
-  .option("--script <file>", "k6 script file to run")
-  .option("--k6Config <file>", "k6 config file to use")
-  .action(async (argv) => {
-    const configFileInput =
-      argv.config || process.env.CUCUMBER_CONFIG_FILE || "cucumber.js";
-    const configFilePath = path.isAbsolute(configFileInput)
-      ? configFileInput
-      : path.resolve(process.cwd(), configFileInput);
-
-    let configOptions = {};
-    try {
-      const configModule = await import(pathToFileURL(configFilePath).href);
-      configOptions = configModule.default || configModule;
-    } catch (err) {
-      console.warn("⚠️ Could not load config file:", err.message);
-    }
-
-    const cucumberConfig = configOptions.default || configOptions;
-    const cliParts = [];
-
-    if (cucumberConfig.paths && Array.isArray(cucumberConfig.paths)) {
-      cliParts.push(...cucumberConfig.paths);
-    }
-    if (argv.feature) {
-      cliParts.push(argv.feature);
-    }
-
-    if (cucumberConfig.import && Array.isArray(cucumberConfig.import)) {
-      cucumberConfig.import.forEach((imp) => cliParts.push("--import", imp));
-    }
-    if (cucumberConfig.require) {
-      console.warn(
-        "⚠️ 'require' is incompatible with ESM. Use 'import' instead."
-      );
-    }
-
-    if (cucumberConfig.format && Array.isArray(cucumberConfig.format)) {
-      cucumberConfig.format.forEach((fmt) => cliParts.push("--format", fmt));
-    }
-
-    if (cucumberConfig.tags) {
-      cliParts.push("--tags", cucumberConfig.tags);
-    }
-    if (argv.tags) {
-      cliParts.push("--tags", argv.tags);
-    }
-
-    const projectRoot = process.cwd();
-
-    let payloadDirRaw =
-      argv.payloadPath ||
-      (cucumberConfig.worldParameters &&
-        cucumberConfig.worldParameters.payloadPath) ||
-      "payloads";
-
-    const payloadDir = path.resolve(projectRoot, payloadDirRaw);
-    console.log("📦 Resolved payload path:", payloadDir);
-
-    const worldParams = {
-      ...(cucumberConfig.worldParameters || {}),
-      payloadPath: payloadDir,
-    };
-    cliParts.push("--world-parameters", JSON.stringify(worldParams));
-
-    if (argv.script) {
-      cliParts.push("--script", argv.script);
-    }
-    if (argv.k6Config) {
-      cliParts.push("--k6Config", argv.k6Config);
-    }
-
-    const finalCommand = ["npx", "cucumber-js", ...cliParts].join(" ");
-    console.log("▶️ Final arguments passed to cucumber-js:", finalCommand);
-
-    const extraEnv = {
-      SAVE_K6_SCRIPT:
-        cucumberConfig.saveK6Script === true || argv.saveK6Script === true
-          ? "true"
-          : "false",
-      K6_CUCUMBER_OVERWRITE:
-        cucumberConfig.overwrite === true || argv.overwrite === true
-          ? "true"
-          : "false",
-      CLEAN_REPORTS:
-        cucumberConfig.cleanReports === true ||
-        argv.cleanReports === true ||
-        argv.clean === true
-          ? "true"
-          : "false",
-      K6_CUCUMBER_REPORTER:
-        cucumberConfig.reporter === true || argv.reporter === true
-          ? "true"
-          : "false",
-    };
-
-    const shouldCleanReports =
-      argv.cleanReports || argv.clean || cucumberConfig.cleanReports;
-
-    if (shouldCleanReports) {
-      const reportsDir = path.join(projectRoot, "reports");
-      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);
-      }
-    }
-
-    const cucumberProcess = spawn("npx", ["cucumber-js", ...cliParts], {
-      stdio: "inherit",
-      env: { ...process.env, ...extraEnv },
-    });
-
-    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);
-
-// Helper to handle dynamic import path
-function pathToFileURL(p) {
-  const url = new URL("file://" + path.resolve(p));
-  return url;
-}

package/docs/data/search.json

@@ -1 +0,0 @@
-{"list":[{"title":"CustomWorld","link":"<a href=\"global.html#CustomWorld\">CustomWorld</a>"},{"title":"Given_I_set_k6_script_for_method_testing","link":"<a href=\"global.html#Given_I_set_k6_script_for_method_testing\">Given_I_set_k6_script_for_method_testing</a>","description":"<p>Initializes the k6 script configuration by setting the primary HTTP method for the load test.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>Given I set a k6 script for {word} testing\n</code></pre>"},{"title":"Given_I_set_k6_script_for_method_testing#config","link":"<a href=\"global.html#Given_I_set_k6_script_for_method_testing#config\">config</a>"},{"title":"K6Config","link":"<a href=\"global.html#K6Config\">K6Config</a>"},{"title":"Then_I_store_value_as_alias","link":"<a href=\"global.html#Then_I_store_value_as_alias\">Then_I_store_value_as_alias</a>","description":"<p>Stores a value from the last API response into the Cucumber World's aliases context.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>Then I store the value at &quot;data.token&quot; as alias &quot;authToken&quot;\n</code></pre>"},{"title":"When_I_login_via_POST_with_payload_from_file","link":"<a href=\"global.html#When_I_login_via_POST_with_payload_from_file\">When_I_login_via_POST_with_payload_from_file</a>","description":"<p>Logs in via a POST request to a specified endpoint using a JSON payload from a file.\nThe response data is stored for subsequent steps.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I login via POST to &quot;/auth/login&quot; with payload from &quot;admin_credentials.json&quot;\n</code></pre>"},{"title":"When_I_set_authentication_type","link":"<a href=\"global.html#When_I_set_authentication_type\">When_I_set_authentication_type</a>","description":"<p>Sets the authentication type for the k6 request, generating relevant headers.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I set the authentication type to &quot;BearerToken&quot;\n</code></pre>"},{"title":"When_I_set_endpoints_used","link":"<a href=\"global.html#When_I_set_endpoints_used\">When_I_set_endpoints_used</a>","description":"<p>Sets the list of endpoints to be used in the k6 script. These are typically used when\nthe k6 script iterates over multiple URLs.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I set the following endpoints used:\n/api/v1/users\n/api/v1/products\n/api/v1/orders\n</code></pre>"},{"title":"When_I_set_k6_script_configurations","link":"<a href=\"global.html#When_I_set_k6_script_configurations\">When_I_set_k6_script_configurations</a>","description":"<p>Configures the k6 script options (VUs, duration, stages, thresholds) from a data table.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I set to run the k6 script with the following configurations:\n| virtual_users | duration | stages               | http_req_failed | http_req_duration | error_rate      |\n| 10            | 30       |                      | p(99)&lt;0.01      | p(99)&lt;500         | rate&lt;0.01       |\n|               |          | [{&quot;duration&quot;:&quot;10s&quot;,&quot;target&quot;:10}] | p(90)&lt;0.01      | p(90)&lt;200         | rate&lt;0.001      |\n</code></pre>"},{"title":"When_I_set_method_body_for_endpoint","link":"<a href=\"global.html#When_I_set_method_body_for_endpoint\">When_I_set_method_body_for_endpoint</a>","description":"<p>Sets the request body for a specific HTTP method and endpoint.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I set the following POST body is used for &quot;/api/v1/create&quot;\n{ &quot;name&quot;: &quot;test&quot;, &quot;email&quot;: &quot;test@example.com&quot; }\n</code></pre>"},{"title":"When_I_set_request_headers","link":"<a href=\"global.html#When_I_set_request_headers\">When_I_set_request_headers</a>","description":"<p>Sets request headers for the k6 script. Headers are merged with any existing headers.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I set the request headers:\n| Header         | Value                |\n| Content-Type   | application/json     |\n| Authorization  | Bearer &lt;my_token>    |\n</code></pre>"},{"title":"When_I_use_JSON_payload_from_file_for_method_to_endpoint","link":"<a href=\"global.html#When_I_use_JSON_payload_from_file_for_method_to_endpoint\">When_I_use_JSON_payload_from_file_for_method_to_endpoint</a>","description":"<p>Loads a JSON payload from a file to be used as the request body for a specific\nmethod and endpoint in the k6 script.</p>\n<pre class=\"prettyprint source lang-gherkin\"><code>When I use JSON payload from &quot;user_create.json&quot; for POST to &quot;/api/v1/users&quot;\n</code></pre>"}]}