@gherkle/runner 0.1.0

package/dist/config.js

@@ -0,0 +1,165 @@
+"use strict";
+/**
+ * Configuration loading and validation for @gherkle/runner
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = loadConfig;
+exports.generateSampleConfig = generateSampleConfig;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const DEFAULT_CONFIG = {
+    apiUrl: 'https://app.gherkle.com',
+    name: 'gherkle-runner',
+    labels: [],
+    framework: 'playwright',
+    featuresPath: './features',
+    stepDefinitionsPath: './steps',
+    supportPath: './support',
+    browsers: ['chromium'],
+    headless: true,
+    testTimeout: 30000,
+    stepTimeout: 10000,
+    screenshots: 'on-failure',
+    video: 'never',
+    env: {},
+};
+const CONFIG_FILE_NAMES = [
+    'gherkle-runner.config.js',
+    'gherkle-runner.config.mjs',
+    'gherkle-runner.config.ts',
+    '.gherklerc.js',
+    '.gherklerc.json',
+];
+/**
+ * Load configuration from file and environment
+ */
+function loadConfig(cliOptions = {}) {
+    let fileConfig = {};
+    // Try to find and load config file
+    for (const filename of CONFIG_FILE_NAMES) {
+        const configPath = path.resolve(process.cwd(), filename);
+        if (fs.existsSync(configPath)) {
+            try {
+                if (filename.endsWith('.json')) {
+                    fileConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+                }
+                else {
+                    // For JS/TS files, we'd need to use require or dynamic import
+                    // For now, just log that we found it
+                    console.log(`Found config file: ${configPath}`);
+                    try {
+                        // eslint-disable-next-line @typescript-eslint/no-require-imports
+                        const loaded = require(configPath);
+                        fileConfig = loaded.default || loaded;
+                    }
+                    catch {
+                        console.warn(`Could not load ${configPath}, using defaults`);
+                    }
+                }
+                break;
+            }
+            catch (err) {
+                console.warn(`Error loading ${configPath}:`, err);
+            }
+        }
+    }
+    // Environment variables override
+    const envConfig = {};
+    if (process.env.GHERKLE_TOKEN) {
+        envConfig.token = process.env.GHERKLE_TOKEN;
+    }
+    if (process.env.GHERKLE_API_URL) {
+        envConfig.apiUrl = process.env.GHERKLE_API_URL;
+    }
+    if (process.env.GHERKLE_RUNNER_NAME) {
+        envConfig.name = process.env.GHERKLE_RUNNER_NAME;
+    }
+    // Merge configs: defaults < file < env < cli (omit undefined cli so defaults are kept)
+    const definedCli = Object.fromEntries(Object.entries(cliOptions).filter(([, v]) => v !== undefined));
+    const config = {
+        ...DEFAULT_CONFIG,
+        ...fileConfig,
+        ...envConfig,
+        ...definedCli,
+    };
+    // Validate required fields
+    if (!config.token) {
+        throw new Error('Token is required. Provide via --token, GHERKLE_TOKEN env var, or config file.');
+    }
+    return config;
+}
+/**
+ * Generate a sample config file
+ */
+function generateSampleConfig() {
+    return `// gherkle-runner.config.js
+module.exports = {
+  // Connection (required)
+  token: process.env.GHERKLE_TOKEN,
+
+  // Runner identification
+  name: 'my-runner',
+  labels: ['local', 'dev'],
+
+  // Test framework
+  framework: 'playwright', // 'playwright' | 'cypress' | 'cucumber'
+
+  // Paths
+  featuresPath: './features',
+  stepDefinitionsPath: './steps',
+  supportPath: './support',
+
+  // Browser configuration (E2E only)
+  browsers: ['chromium'],
+  headless: true,
+
+  // Timeouts
+  testTimeout: 30000,
+  stepTimeout: 10000,
+
+  // Artifacts
+  screenshots: 'on-failure', // 'always' | 'on-failure' | 'never'
+  video: 'never',
+
+  // Environment
+  baseUrl: process.env.BASE_URL || 'http://localhost:3000',
+  env: {
+    API_URL: process.env.API_URL,
+  },
+};
+`;
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEH,gCA4DC;AAKD,oDAqCC;AAtKD,uCAAyB;AACzB,2CAA6B;AAmC7B,MAAM,cAAc,GAAyB;IAC3C,MAAM,EAAE,yBAAyB;IACjC,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE,EAAE;IACV,SAAS,EAAE,YAAY;IACvB,YAAY,EAAE,YAAY;IAC1B,mBAAmB,EAAE,SAAS;IAC9B,WAAW,EAAE,WAAW;IACxB,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,KAAK;IAClB,WAAW,EAAE,KAAK;IAClB,WAAW,EAAE,YAAY;IACzB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,EAAE;CACR,CAAC;AAEF,MAAM,iBAAiB,GAAG;IACxB,0BAA0B;IAC1B,2BAA2B;IAC3B,0BAA0B;IAC1B,eAAe;IACf,iBAAiB;CAClB,CAAC;AAEF;;GAEG;AACH,SAAgB,UAAU,CAAC,aAAmC,EAAE;IAC9D,IAAI,UAAU,GAAyB,EAAE,CAAC;IAE1C,mCAAmC;IACnC,KAAK,MAAM,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;QACzD,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACH,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC/B,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;gBAChE,CAAC;qBAAM,CAAC;oBACN,8DAA8D;oBAC9D,qCAAqC;oBACrC,OAAO,CAAC,GAAG,CAAC,sBAAsB,UAAU,EAAE,CAAC,CAAC;oBAChD,IAAI,CAAC;wBACH,iEAAiE;wBACjE,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;wBACnC,UAAU,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;oBACxC,CAAC;oBAAC,MAAM,CAAC;wBACP,OAAO,CAAC,IAAI,CAAC,kBAAkB,UAAU,kBAAkB,CAAC,CAAC;oBAC/D,CAAC;gBACH,CAAC;gBACD,MAAM;YACR,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,IAAI,CAAC,iBAAiB,UAAU,GAAG,EAAE,GAAG,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;IACH,CAAC;IAED,iCAAiC;IACjC,MAAM,SAAS,GAAyB,EAAE,CAAC;IAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAC9B,SAAS,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAC9C,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC;QAChC,SAAS,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IACjD,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,CAAC;QACpC,SAAS,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IACnD,CAAC;IAED,uFAAuF;IACvF,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CACnC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CACtC,CAAC;IAC1B,MAAM,MAAM,GAAG;QACb,GAAG,cAAc;QACjB,GAAG,UAAU;QACb,GAAG,SAAS;QACZ,GAAG,UAAU;KACC,CAAC;IAEjB,2BAA2B;IAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB;IAClC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmCR,CAAC;AACF,CAAC"}

package/dist/frameworks/cucumber-subprocess.d.ts

@@ -0,0 +1,129 @@
+/**
+ * CucumberSubprocessExecutor — runs AI-generated step defs via a forked
+ * @cucumber/cucumber child process and maps its envelope stream into the
+ * runner's existing scenario/step/run events.
+ *
+ * Why a subprocess (not in-process)?
+ *   1. Cancel: SIGTERM the child cleanly; cannot kill an in-process loop.
+ *   2. Isolation: user-supplied AI-generated code can crash or leak module
+ *      state. A long-lived runner cannot afford either.
+ *   3. Module cache: Cucumber.js registers hooks at module load. Two
+ *      consecutive runs in the same process would double-register.
+ *
+ * Tmpdir layout written by prepareTmpdir():
+ *
+ *   <tmpdir>/
+ *     features/<feature_id>.feature
+ *     steps/<suggested_filename>
+ *     support/world.<js|ts>
+ *     cucumber.cjs
+ *     .use-ts                 (only when language === 'typescript')
+ *
+ * The path layout matters: the AI prompt emits
+ *   import { ICustomWorld } from '../support/world'
+ * relative to a step-def file. With step-defs at steps/* and the World at
+ * support/world.*, that import resolves cleanly with no source rewriting.
+ *
+ * Envelope → runner event mapping:
+ *
+ *   envelope.testCase           → record testCaseId → pickleId
+ *   envelope.pickle             → record pickleId → { name, uri }
+ *   envelope.testCaseStarted    → onScenarioStart(pickleId, name)
+ *   envelope.testStepFinished   → onStepComplete(pickleId, StepResult)
+ *   envelope.testCaseFinished   → onScenarioComplete(pickleId, status, durationMs, error?)
+ *
+ * Cancel:
+ *   - SIGTERM, then SIGKILL after 5s if the child is still alive.
+ *   - Cleanup (rm -rf tmpdir) runs on child 'exit', so it fires for
+ *     completion, cancellation, AND crash.
+ *
+ * Lifecycle state machine (the cross-process flow that bit us in review):
+ *
+ *   parent (agent.ts)               child (cucumber-worker)
+ *   ───────────────────             ─────────────────────────
+ *   prepareTmpdir()
+ *   fork(worker, [tmpdir]) ───────► boot, require @cucumber/cucumber
+ *                                   load tmpdir/cucumber.cjs
+ *                                   runCucumber({onMessage})
+ *                                          │
+ *                       envelope ◄─────────┤
+ *                       envelope ◄─────────┤
+ *                       envelope ◄─────────┤
+ *                          ...             │
+ *                       envelope ◄─────────┘ runCucumber resolves
+ *                       {kind:'done', success} ◄── process.send({...}, () => exit)
+ *                                                       │
+ *   child.on('exit', code, signal) ◄──────────── child exits
+ *      │
+ *      ├─ killTimer cleared
+ *      ├─ cleanupTmpdir() (best-effort)
+ *      ├─ if __fatal stashed → reject(fatal)
+ *      ├─ if signal SIGTERM/SIGKILL → resolve(partial)   ← cancel path
+ *      └─ else → resolve(all scenarios)
+ *
+ *   cancel() called any time before exit:
+ *     SIGTERM → killTimer schedules SIGKILL(+5s) → exit fires above
+ */
+import { FeatureContent, GeneratedStepDef, ScenarioResult, StepResult, TestStatus } from '../types';
+export interface CucumberExecutorCallbacks {
+    onScenarioStart: (scenarioId: string, scenarioName: string, featureName: string) => void;
+    onStepComplete: (scenarioId: string, step: StepResult) => void;
+    onScenarioComplete: (scenarioId: string, status: TestStatus, durationMs: number, error?: string) => void;
+}
+export declare class CucumberSubprocessExecutor {
+    private child;
+    private tmpdir;
+    private killTimer;
+    private readonly workerPathOverride?;
+    constructor(opts?: {
+        workerPath?: string;
+    });
+    executeAll(features: FeatureContent[], stepDefinitions: GeneratedStepDef[], env: Record<string, string>, callbacks: CucumberExecutorCallbacks): Promise<ScenarioResult[]>;
+    /**
+     * Cancel an in-flight run. Idempotent; safe to call after the child has
+     * already exited.
+     */
+    cancel(): void;
+    prepareTmpdir(features: FeatureContent[], stepDefinitions: GeneratedStepDef[]): Promise<string>;
+    private cleanupTmpdir;
+    /**
+     * A minimal World that exposes `this.page`, `this.context`, and `this.env`
+     * to step definitions. AI-generated code expects these via the
+     * `ICustomWorld` import. The TS variant exports `ICustomWorld` as a type
+     * alias so the prompt's `import { ICustomWorld } from '../support/world'`
+     * compiles; the JS variant just exports the constructor.
+     *
+     * Browser is launched per scenario (cheap with chromium) so a crashing
+     * step does not poison subsequent scenarios.
+     */
+    private worldShim;
+    private cucumberConfig;
+}
+/**
+ * Translates the Cucumber.js envelope stream into runner-shaped events.
+ *
+ * Cucumber emits envelopes in topological order: `pickle` and `testCase`
+ * envelopes arrive BEFORE their corresponding `testCaseStarted`, so the
+ * id→pickle and testCase→pickle lookup maps are always populated by the
+ * time we need them. Out-of-order arrivals (which shouldn't happen but
+ * are guarded against) silently skip rather than crash.
+ *
+ * Lookup chain for any in-flight step/scenario event:
+ *   testStepFinished.testCaseStartedId
+ *     → startedToTestCase  → testCase.id
+ *     → testCaseToPickle   → pickle.id (the scenario identity we emit)
+ *     → pickles            → { name, uri (feature path inside tmpdir) }
+ *     → featureIdFromUri   → DB feature_id
+ *     → featureIdToOriginalName → DB path (what server-side map keys on)
+ *
+ * Status rollup at testCaseFinished:
+ *   any step failed → 'failed'
+ *   else if every step skipped → 'skipped'
+ *   else → 'passed'
+ */
+export interface EnvelopeMapper {
+    handle(envelope: unknown): void;
+    getScenarios(): ScenarioResult[];
+}
+export declare function createEnvelopeMapper(featureIdToOriginalName: Map<string, string>, callbacks: CucumberExecutorCallbacks): EnvelopeMapper;
+//# sourceMappingURL=cucumber-subprocess.d.ts.map

package/dist/frameworks/cucumber-subprocess.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cucumber-subprocess.d.ts","sourceRoot":"","sources":["../../src/frameworks/cucumber-subprocess.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AAMH,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,UAAU,EACX,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,yBAAyB;IACxC,eAAe,EAAE,CACf,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,KAChB,IAAI,CAAC;IACV,cAAc,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;IAC/D,kBAAkB,EAAE,CAClB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM,KACX,IAAI,CAAC;CACX;AAID,qBAAa,0BAA0B;IACrC,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,SAAS,CAA+B;IAIhD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAS;gBAEjC,IAAI,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO;IAIxC,UAAU,CACd,QAAQ,EAAE,cAAc,EAAE,EAC1B,eAAe,EAAE,gBAAgB,EAAE,EACnC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC3B,SAAS,EAAE,yBAAyB,GACnC,OAAO,CAAC,cAAc,EAAE,CAAC;IA4E5B;;;OAGG;IACH,MAAM,IAAI,IAAI;IAuBR,aAAa,CACjB,QAAQ,EAAE,cAAc,EAAE,EAC1B,eAAe,EAAE,gBAAgB,EAAE,GAClC,OAAO,CAAC,MAAM,CAAC;YAuDJ,aAAa;IAY3B;;;;;;;;;OASG;IACH,OAAO,CAAC,SAAS;IA+EjB,OAAO,CAAC,cAAc;CAYvB;AAID;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,YAAY,IAAI,cAAc,EAAE,CAAC;CAClC;AAED,wBAAgB,oBAAoB,CAClC,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5C,SAAS,EAAE,yBAAyB,GACnC,cAAc,CAqFhB"}