@dev-blinq/cucumber-js 1.0.0-amdocs

package/lib/configuration/validate_configuration.d.ts

@@ -0,0 +1,3 @@
+import { IConfiguration } from './types';
+import { ILogger } from '../logger';
+export declare function validateConfiguration(configuration: IConfiguration, logger: ILogger): void;

package/lib/configuration/validate_configuration.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfiguration = void 0;
+function validateConfiguration(configuration, logger) {
+    if (configuration.publishQuiet) {
+        logger.warn('`publishQuiet` option is no longer needed, you can remove it from your configuration; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md');
+    }
+    if (configuration.retryTagFilter && !configuration.retry) {
+        throw new Error('a positive `retry` count must be specified when setting `retryTagFilter`');
+    }
+}
+exports.validateConfiguration = validateConfiguration;
+//# sourceMappingURL=validate_configuration.js.map

package/lib/configuration/validate_configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate_configuration.js","sourceRoot":"","sources":["../../src/configuration/validate_configuration.ts"],"names":[],"mappings":";;;AAGA,SAAgB,qBAAqB,CACnC,aAA6B,EAC7B,MAAe;IAEf,IAAI,aAAa,CAAC,YAAY,EAAE;QAC9B,MAAM,CAAC,IAAI,CACT,kKAAkK,CACnK,CAAA;KACF;IACD,IAAI,aAAa,CAAC,cAAc,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE;QACxD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAA;KACF;AACH,CAAC;AAdD,sDAcC","sourcesContent":["import { IConfiguration } from './types'\nimport { ILogger } from '../logger'\n\nexport function validateConfiguration(\n  configuration: IConfiguration,\n  logger: ILogger\n): void {\n  if (configuration.publishQuiet) {\n    logger.warn(\n      '`publishQuiet` option is no longer needed, you can remove it from your configuration; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md'\n    )\n  }\n  if (configuration.retryTagFilter && !configuration.retry) {\n    throw new Error(\n      'a positive `retry` count must be specified when setting `retryTagFilter`'\n    )\n  }\n}\n"]}

package/lib/filter_stack_trace.d.ts

@@ -0,0 +1,3 @@
+import { StackFrame } from 'error-stack-parser';
+export declare function isFileNameInCucumber(fileName: string): boolean;
+export declare function filterStackTrace(frames: StackFrame[]): StackFrame[];

package/lib/filter_stack_trace.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterStackTrace = exports.isFileNameInCucumber = void 0;
+const path_1 = __importDefault(require("path"));
+const value_checker_1 = require("./value_checker");
+const projectRootPath = path_1.default.join(__dirname, '..');
+const projectChildDirs = ['src', 'lib', 'node_modules'];
+function isFileNameInCucumber(fileName) {
+    return projectChildDirs.some((dir) => fileName.startsWith(path_1.default.join(projectRootPath, dir)));
+}
+exports.isFileNameInCucumber = isFileNameInCucumber;
+function filterStackTrace(frames) {
+    if (isErrorInCucumber(frames)) {
+        return frames;
+    }
+    const index = frames.findIndex((x) => isFrameInCucumber(x));
+    if (index === -1) {
+        return frames;
+    }
+    return frames.slice(0, index);
+}
+exports.filterStackTrace = filterStackTrace;
+function isErrorInCucumber(frames) {
+    const filteredFrames = frames.filter((x) => !isFrameInNode(x));
+    return filteredFrames.length > 0 && isFrameInCucumber(filteredFrames[0]);
+}
+function isFrameInCucumber(frame) {
+    const fileName = (0, value_checker_1.valueOrDefault)(frame.getFileName(), '');
+    return isFileNameInCucumber(fileName);
+}
+function isFrameInNode(frame) {
+    const fileName = (0, value_checker_1.valueOrDefault)(frame.getFileName(), '');
+    return !fileName.includes(path_1.default.sep);
+}
+//# sourceMappingURL=filter_stack_trace.js.map

package/lib/filter_stack_trace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter_stack_trace.js","sourceRoot":"","sources":["../src/filter_stack_trace.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,mDAAgD;AAGhD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;AAClD,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,CAAC,CAAA;AAEvD,SAAgB,oBAAoB,CAAC,QAAgB;IACnD,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CACnC,QAAQ,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,CACrD,CAAA;AACH,CAAC;AAJD,oDAIC;AAED,SAAgB,gBAAgB,CAAC,MAAoB;IACnD,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE;QAC7B,OAAO,MAAM,CAAA;KACd;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAA;IAC3D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;QAChB,OAAO,MAAM,CAAA;KACd;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;AAC/B,CAAC;AATD,4CASC;AAED,SAAS,iBAAiB,CAAC,MAAoB;IAC7C,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9D,OAAO,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAA;AAC1E,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAiB;IAC1C,MAAM,QAAQ,GAAG,IAAA,8BAAc,EAAC,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AACvC,CAAC;AAED,SAAS,aAAa,CAAC,KAAiB;IACtC,MAAM,QAAQ,GAAG,IAAA,8BAAc,EAAC,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAI,CAAC,GAAG,CAAC,CAAA;AACrC,CAAC","sourcesContent":["import path from 'path'\nimport { valueOrDefault } from './value_checker'\nimport { StackFrame } from 'error-stack-parser'\n\nconst projectRootPath = path.join(__dirname, '..')\nconst projectChildDirs = ['src', 'lib', 'node_modules']\n\nexport function isFileNameInCucumber(fileName: string): boolean {\n  return projectChildDirs.some((dir) =>\n    fileName.startsWith(path.join(projectRootPath, dir))\n  )\n}\n\nexport function filterStackTrace(frames: StackFrame[]): StackFrame[] {\n  if (isErrorInCucumber(frames)) {\n    return frames\n  }\n  const index = frames.findIndex((x) => isFrameInCucumber(x))\n  if (index === -1) {\n    return frames\n  }\n  return frames.slice(0, index)\n}\n\nfunction isErrorInCucumber(frames: StackFrame[]): boolean {\n  const filteredFrames = frames.filter((x) => !isFrameInNode(x))\n  return filteredFrames.length > 0 && isFrameInCucumber(filteredFrames[0])\n}\n\nfunction isFrameInCucumber(frame: StackFrame): boolean {\n  const fileName = valueOrDefault(frame.getFileName(), '')\n  return isFileNameInCucumber(fileName)\n}\n\nfunction isFrameInNode(frame: StackFrame): boolean {\n  const fileName = valueOrDefault(frame.getFileName(), '')\n  return !fileName.includes(path.sep)\n}\n"]}

package/lib/formatter/api.d.ts

@@ -0,0 +1,2 @@
+declare const getProjectByAccessKey: (access_key: string) => Promise<any>;
+export { getProjectByAccessKey };

package/lib/formatter/api.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectByAccessKey = void 0;
+const axios_1 = __importDefault(require("axios"));
+const tunnel_1 = __importDefault(require("tunnel"));
+const getSSoUrl = () => {
+    switch (process.env.NODE_ENV_BLINQ) {
+        case 'local':
+            return 'http://localhost:5000/api/auth';
+        case 'dev':
+            return 'https://dev.api.blinq.io/api/auth';
+        case 'stage':
+            return 'https://stage.api.blinq.io/api/auth';
+        default:
+            return 'https://api.blinq.io/api/auth';
+    }
+};
+const getProxy = () => {
+    if (!process.env.PROXY) {
+        return null;
+    }
+    const proxy = process.env.PROXY;
+    const url = new URL(proxy);
+    const proxyObject = {
+        host: url.hostname,
+        port: Number(url.port),
+    };
+    const { username, password } = url;
+    if (username && password) {
+        //@ts-ignore
+        proxyObject.proxyAuth = `${username}:${password}`;
+    }
+    return tunnel_1.default.httpsOverHttp({ proxy: proxyObject });
+};
+const getProjectByAccessKey = async (access_key) => {
+    const ssoUrl = getSSoUrl();
+    const accessKeyUrl = `${ssoUrl}/getProjectByAccessKey`;
+    const response = await axios_1.default.post(accessKeyUrl, {
+        access_key,
+        httpAgent: getProxy(),
+        proxy: false,
+    });
+    if (response.status !== 200) {
+        console.error('Error: Invalid access key');
+        process.exit(1);
+    }
+    return response.data;
+};
+exports.getProjectByAccessKey = getProjectByAccessKey;
+//# sourceMappingURL=api.js.map

package/lib/formatter/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/formatter/api.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AACzB,oDAA2B;AAE3B,MAAM,SAAS,GAAG,GAAG,EAAE;IACnB,QAAQ,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;QAClC,KAAK,OAAO;YACV,OAAO,gCAAgC,CAAA;QACzC,KAAK,KAAK;YACR,OAAO,mCAAmC,CAAA;QAC5C,KAAK,OAAO;YACV,OAAO,qCAAqC,CAAA;QAC9C;YACE,OAAO,+BAA+B,CAAA;KACzC;AACH,CAAC,CAAA;AACD,MAAM,QAAQ,GAAG,GAAG,EAAE;IACpB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE;QACtB,OAAO,IAAI,CAAA;KACZ;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAA;IAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;IAC1B,MAAM,WAAW,GAAG;QAClB,IAAI,EAAE,GAAG,CAAC,QAAQ;QAClB,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;KACvB,CAAA;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAA;IAElC,IAAI,QAAQ,IAAI,QAAQ,EAAE;QACxB,YAAY;QACZ,WAAW,CAAC,SAAS,GAAG,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAA;KAClD;IACD,OAAO,gBAAM,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;AACrD,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,KAAK,EAAE,UAAiB,EAAE,EAAE;IACxD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;IAC1B,MAAM,YAAY,GAAG,GAAG,MAAM,wBAAwB,CAAA;IACtD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE;QAC9C,UAAU;QACV,SAAS,EAAE,QAAQ,EAAE;QACrB,KAAK,EAAE,KAAK;KACb,CAAC,CAAA;IACF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;QAC3B,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KAChB;IACD,OAAO,QAAQ,CAAC,IAAI,CAAA;AACtB,CAAC,CAAC;AAEO,sDAAqB","sourcesContent":["import axios from 'axios'\nimport tunnel from 'tunnel'\n\nconst getSSoUrl = () => {\n    switch (process.env.NODE_ENV_BLINQ) {\n      case 'local':\n        return 'http://localhost:5000/api/auth'\n      case 'dev':\n        return 'https://dev.api.blinq.io/api/auth'\n      case 'stage':\n        return 'https://stage.api.blinq.io/api/auth'\n      default:\n        return 'https://api.blinq.io/api/auth'\n    }\n  }\n  const getProxy = () => {\n    if (!process.env.PROXY) {\n      return null\n    }\n  \n    const proxy = process.env.PROXY\n    const url = new URL(proxy)\n    const proxyObject = {\n      host: url.hostname,\n      port: Number(url.port),\n    }\n  \n    const { username, password } = url\n  \n    if (username && password) {\n      //@ts-ignore\n      proxyObject.proxyAuth = `${username}:${password}`\n    }\n    return tunnel.httpsOverHttp({ proxy: proxyObject })\n  }\n  \n  const getProjectByAccessKey = async (access_key:string) => {\n    const ssoUrl = getSSoUrl()\n    const accessKeyUrl = `${ssoUrl}/getProjectByAccessKey`\n    const response = await axios.post(accessKeyUrl, {\n      access_key,\n      httpAgent: getProxy(),\n      proxy: false,\n    })\n    if (response.status !== 200) {\n      console.error('Error: Invalid access key')\n      process.exit(1)\n    }\n    return response.data\n  };\n\n  export { getProjectByAccessKey };"]}

package/lib/formatter/builder.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import StepDefinitionSnippetBuilder from './step_definition_snippet_builder';
+import { ISupportCodeLibrary } from '../support_code_library_builder/types';
+import Formatter, { FormatOptions, IFormatterCleanupFn, IFormatterLogFn } from '.';
+import { EventEmitter } from 'events';
+import EventDataCollector from './helpers/event_data_collector';
+import { Writable as WritableStream } from 'stream';
+import { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax';
+interface IGetStepDefinitionSnippetBuilderOptions {
+    cwd: string;
+    snippetInterface?: SnippetInterface;
+    snippetSyntax?: string;
+    supportCodeLibrary: ISupportCodeLibrary;
+}
+export interface IBuildOptions {
+    env: NodeJS.ProcessEnv;
+    cwd: string;
+    eventBroadcaster: EventEmitter;
+    eventDataCollector: EventDataCollector;
+    log: IFormatterLogFn;
+    parsedArgvOptions: FormatOptions;
+    stream: WritableStream;
+    cleanup: IFormatterCleanupFn;
+    supportCodeLibrary: ISupportCodeLibrary;
+}
+declare const FormatterBuilder: {
+    build(type: string, options: IBuildOptions): Promise<Formatter>;
+    getConstructorByType(type: string, cwd: string): Promise<typeof Formatter>;
+    getStepDefinitionSnippetBuilder({ cwd, snippetInterface, snippetSyntax, supportCodeLibrary, }: IGetStepDefinitionSnippetBuilderOptions): Promise<StepDefinitionSnippetBuilder>;
+    loadCustomClass(type: 'formatter' | 'syntax', descriptor: string, cwd: string): Promise<any>;
+    loadFile(urlOrName: URL | string): Promise<any>;
+    resolveConstructor(ImportedCode: any): any;
+};
+export default FormatterBuilder;

package/lib/formatter/builder.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_color_fns_1 = __importDefault(require("./get_color_fns"));
+const javascript_snippet_syntax_1 = __importDefault(require("./step_definition_snippet_builder/javascript_snippet_syntax"));
+const path_1 = __importDefault(require("path"));
+const step_definition_snippet_builder_1 = __importDefault(require("./step_definition_snippet_builder"));
+const value_checker_1 = require("../value_checker");
+const snippet_syntax_1 = require("./step_definition_snippet_builder/snippet_syntax");
+const url_1 = require("url");
+const formatters_1 = __importDefault(require("./helpers/formatters"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { importer } = require('../importer');
+const FormatterBuilder = {
+    async build(type, options) {
+        const FormatterConstructor = await FormatterBuilder.getConstructorByType(type, options.cwd);
+        const colorFns = (0, get_color_fns_1.default)(options.stream, options.env, options.parsedArgvOptions.colorsEnabled);
+        const snippetBuilder = await FormatterBuilder.getStepDefinitionSnippetBuilder({
+            cwd: options.cwd,
+            snippetInterface: options.parsedArgvOptions.snippetInterface,
+            snippetSyntax: options.parsedArgvOptions.snippetSyntax,
+            supportCodeLibrary: options.supportCodeLibrary,
+        });
+        return new FormatterConstructor({
+            colorFns,
+            snippetBuilder,
+            ...options,
+        });
+    },
+    async getConstructorByType(type, cwd) {
+        const formatters = formatters_1.default.getFormatters();
+        return formatters[type]
+            ? formatters[type]
+            : await FormatterBuilder.loadCustomClass('formatter', type, cwd);
+    },
+    async getStepDefinitionSnippetBuilder({ cwd, snippetInterface, snippetSyntax, supportCodeLibrary, }) {
+        if ((0, value_checker_1.doesNotHaveValue)(snippetInterface)) {
+            snippetInterface = snippet_syntax_1.SnippetInterface.Synchronous;
+        }
+        let Syntax = javascript_snippet_syntax_1.default;
+        if ((0, value_checker_1.doesHaveValue)(snippetSyntax)) {
+            Syntax = await FormatterBuilder.loadCustomClass('syntax', snippetSyntax, cwd);
+        }
+        return new step_definition_snippet_builder_1.default({
+            snippetSyntax: new Syntax(snippetInterface),
+            parameterTypeRegistry: supportCodeLibrary.parameterTypeRegistry,
+        });
+    },
+    async loadCustomClass(type, descriptor, cwd) {
+        let normalized = descriptor;
+        if (descriptor.startsWith('.')) {
+            normalized = (0, url_1.pathToFileURL)(path_1.default.resolve(cwd, descriptor));
+        }
+        else if (descriptor.startsWith('file://')) {
+            normalized = new URL(descriptor);
+        }
+        let CustomClass = await FormatterBuilder.loadFile(normalized);
+        CustomClass = FormatterBuilder.resolveConstructor(CustomClass);
+        if ((0, value_checker_1.doesHaveValue)(CustomClass)) {
+            return CustomClass;
+        }
+        else {
+            throw new Error(`Custom ${type} (${descriptor}) does not export a function/class`);
+        }
+    },
+    async loadFile(urlOrName) {
+        let result;
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            result = require(typeof urlOrName === 'string'
+                ? urlOrName
+                : (0, url_1.fileURLToPath)(urlOrName));
+        }
+        catch (error) {
+            if (error.code === 'ERR_REQUIRE_ESM') {
+                result = await importer(urlOrName);
+            }
+            else {
+                throw error;
+            }
+        }
+        return result;
+    },
+    resolveConstructor(ImportedCode) {
+        if ((0, value_checker_1.doesNotHaveValue)(ImportedCode)) {
+            return null;
+        }
+        if (typeof ImportedCode === 'function') {
+            return ImportedCode;
+        }
+        else if (typeof ImportedCode === 'object' &&
+            typeof ImportedCode.default === 'function') {
+            return ImportedCode.default;
+        }
+        return null;
+    },
+};
+exports.default = FormatterBuilder;
+//# sourceMappingURL=builder.js.map

package/lib/formatter/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../src/formatter/builder.ts"],"names":[],"mappings":";;;;;AAAA,oEAAyC;AACzC,4HAAiG;AACjG,gDAAuB;AACvB,wGAA4E;AAO5E,oDAAkE;AAIlE,qFAAmF;AACnF,6BAAkD;AAClD,sEAA6C;AAC7C,8DAA8D;AAC9D,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AAqB3C,MAAM,gBAAgB,GAAG;IACvB,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAAsB;QAC9C,MAAM,oBAAoB,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,CACtE,IAAI,EACJ,OAAO,CAAC,GAAG,CACZ,CAAA;QACD,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAC1B,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,GAAG,EACX,OAAO,CAAC,iBAAiB,CAAC,aAAa,CACxC,CAAA;QACD,MAAM,cAAc,GAClB,MAAM,gBAAgB,CAAC,+BAA+B,CAAC;YACrD,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,gBAAgB,EAAE,OAAO,CAAC,iBAAiB,CAAC,gBAAgB;YAC5D,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,aAAa;YACtD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC/C,CAAC,CAAA;QACJ,OAAO,IAAI,oBAAoB,CAAC;YAC9B,QAAQ;YACR,cAAc;YACd,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,IAAY,EACZ,GAAW;QAEX,MAAM,UAAU,GACd,oBAAU,CAAC,aAAa,EAAE,CAAA;QAE5B,OAAO,UAAU,CAAC,IAAI,CAAC;YACrB,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAClB,CAAC,CAAC,MAAM,gBAAgB,CAAC,eAAe,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,+BAA+B,CAAC,EACpC,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GACsB;QACxC,IAAI,IAAA,gCAAgB,EAAC,gBAAgB,CAAC,EAAE;YACtC,gBAAgB,GAAG,iCAAgB,CAAC,WAAW,CAAA;SAChD;QACD,IAAI,MAAM,GAAG,mCAAuB,CAAA;QACpC,IAAI,IAAA,6BAAa,EAAC,aAAa,CAAC,EAAE;YAChC,MAAM,GAAG,MAAM,gBAAgB,CAAC,eAAe,CAC7C,QAAQ,EACR,aAAa,EACb,GAAG,CACJ,CAAA;SACF;QACD,OAAO,IAAI,yCAA4B,CAAC;YACtC,aAAa,EAAE,IAAI,MAAM,CAAC,gBAAgB,CAAC;YAC3C,qBAAqB,EAAE,kBAAkB,CAAC,qBAAqB;SAChE,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAA4B,EAC5B,UAAkB,EAClB,GAAW;QAEX,IAAI,UAAU,GAAiB,UAAU,CAAA;QACzC,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,UAAU,GAAG,IAAA,mBAAa,EAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAA;SAC1D;aAAM,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC3C,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;SACjC;QACD,IAAI,WAAW,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAC7D,WAAW,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;QAC9D,IAAI,IAAA,6BAAa,EAAC,WAAW,CAAC,EAAE;YAC9B,OAAO,WAAW,CAAA;SACnB;aAAM;YACL,MAAM,IAAI,KAAK,CACb,UAAU,IAAI,KAAK,UAAU,oCAAoC,CAClE,CAAA;SACF;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,SAAuB;QACpC,IAAI,MAAM,CAAA;QACV,IAAI;YACF,8DAA8D;YAC9D,MAAM,GAAG,OAAO,CAAC,OAAO,SAAS,KAAK,QAAQ;gBAC5C,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAA,mBAAa,EAAC,SAAS,CAAC,CAAC,CAAA;SAC9B;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACpC,MAAM,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAA;aACnC;iBAAM;gBACL,MAAM,KAAK,CAAA;aACZ;SACF;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,kBAAkB,CAAC,YAAiB;QAClC,IAAI,IAAA,gCAAgB,EAAC,YAAY,CAAC,EAAE;YAClC,OAAO,IAAI,CAAA;SACZ;QACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;YACtC,OAAO,YAAY,CAAA;SACpB;aAAM,IACL,OAAO,YAAY,KAAK,QAAQ;YAChC,OAAO,YAAY,CAAC,OAAO,KAAK,UAAU,EAC1C;YACA,OAAO,YAAY,CAAC,OAAO,CAAA;SAC5B;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF,CAAA;AAED,kBAAe,gBAAgB,CAAA","sourcesContent":["import getColorFns from './get_color_fns'\nimport JavascriptSnippetSyntax from './step_definition_snippet_builder/javascript_snippet_syntax'\nimport path from 'path'\nimport StepDefinitionSnippetBuilder from './step_definition_snippet_builder'\nimport { ISupportCodeLibrary } from '../support_code_library_builder/types'\nimport Formatter, {\n  FormatOptions,\n  IFormatterCleanupFn,\n  IFormatterLogFn,\n} from '.'\nimport { doesHaveValue, doesNotHaveValue } from '../value_checker'\nimport { EventEmitter } from 'events'\nimport EventDataCollector from './helpers/event_data_collector'\nimport { Writable as WritableStream } from 'stream'\nimport { SnippetInterface } from './step_definition_snippet_builder/snippet_syntax'\nimport { fileURLToPath, pathToFileURL } from 'url'\nimport Formatters from './helpers/formatters'\n// eslint-disable-next-line @typescript-eslint/no-var-requires\nconst { importer } = require('../importer')\n\ninterface IGetStepDefinitionSnippetBuilderOptions {\n  cwd: string\n  snippetInterface?: SnippetInterface\n  snippetSyntax?: string\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nexport interface IBuildOptions {\n  env: NodeJS.ProcessEnv\n  cwd: string\n  eventBroadcaster: EventEmitter\n  eventDataCollector: EventDataCollector\n  log: IFormatterLogFn\n  parsedArgvOptions: FormatOptions\n  stream: WritableStream\n  cleanup: IFormatterCleanupFn\n  supportCodeLibrary: ISupportCodeLibrary\n}\n\nconst FormatterBuilder = {\n  async build(type: string, options: IBuildOptions): Promise<Formatter> {\n    const FormatterConstructor = await FormatterBuilder.getConstructorByType(\n      type,\n      options.cwd\n    )\n    const colorFns = getColorFns(\n      options.stream,\n      options.env,\n      options.parsedArgvOptions.colorsEnabled\n    )\n    const snippetBuilder =\n      await FormatterBuilder.getStepDefinitionSnippetBuilder({\n        cwd: options.cwd,\n        snippetInterface: options.parsedArgvOptions.snippetInterface,\n        snippetSyntax: options.parsedArgvOptions.snippetSyntax,\n        supportCodeLibrary: options.supportCodeLibrary,\n      })\n    return new FormatterConstructor({\n      colorFns,\n      snippetBuilder,\n      ...options,\n    })\n  },\n\n  async getConstructorByType(\n    type: string,\n    cwd: string\n  ): Promise<typeof Formatter> {\n    const formatters: Record<string, typeof Formatter> =\n      Formatters.getFormatters()\n\n    return formatters[type]\n      ? formatters[type]\n      : await FormatterBuilder.loadCustomClass('formatter', type, cwd)\n  },\n\n  async getStepDefinitionSnippetBuilder({\n    cwd,\n    snippetInterface,\n    snippetSyntax,\n    supportCodeLibrary,\n  }: IGetStepDefinitionSnippetBuilderOptions) {\n    if (doesNotHaveValue(snippetInterface)) {\n      snippetInterface = SnippetInterface.Synchronous\n    }\n    let Syntax = JavascriptSnippetSyntax\n    if (doesHaveValue(snippetSyntax)) {\n      Syntax = await FormatterBuilder.loadCustomClass(\n        'syntax',\n        snippetSyntax,\n        cwd\n      )\n    }\n    return new StepDefinitionSnippetBuilder({\n      snippetSyntax: new Syntax(snippetInterface),\n      parameterTypeRegistry: supportCodeLibrary.parameterTypeRegistry,\n    })\n  },\n\n  async loadCustomClass(\n    type: 'formatter' | 'syntax',\n    descriptor: string,\n    cwd: string\n  ) {\n    let normalized: URL | string = descriptor\n    if (descriptor.startsWith('.')) {\n      normalized = pathToFileURL(path.resolve(cwd, descriptor))\n    } else if (descriptor.startsWith('file://')) {\n      normalized = new URL(descriptor)\n    }\n    let CustomClass = await FormatterBuilder.loadFile(normalized)\n    CustomClass = FormatterBuilder.resolveConstructor(CustomClass)\n    if (doesHaveValue(CustomClass)) {\n      return CustomClass\n    } else {\n      throw new Error(\n        `Custom ${type} (${descriptor}) does not export a function/class`\n      )\n    }\n  },\n\n  async loadFile(urlOrName: URL | string) {\n    let result\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-var-requires\n      result = require(typeof urlOrName === 'string'\n        ? urlOrName\n        : fileURLToPath(urlOrName))\n    } catch (error) {\n      if (error.code === 'ERR_REQUIRE_ESM') {\n        result = await importer(urlOrName)\n      } else {\n        throw error\n      }\n    }\n    return result\n  },\n\n  resolveConstructor(ImportedCode: any) {\n    if (doesNotHaveValue(ImportedCode)) {\n      return null\n    }\n    if (typeof ImportedCode === 'function') {\n      return ImportedCode\n    } else if (\n      typeof ImportedCode === 'object' &&\n      typeof ImportedCode.default === 'function'\n    ) {\n      return ImportedCode.default\n    }\n    return null\n  },\n}\n\nexport default FormatterBuilder\n"]}

package/lib/formatter/bvt_analysis_formatter.d.ts

@@ -0,0 +1,30 @@
+import Formatter, { IFormatterOptions } from '.';
+import ReportGenerator from './helpers/report_generator';
+export default class BVTAnalysisFormatter extends Formatter {
+    static reportGenerator: ReportGenerator;
+    static reRunFailedStepsIndex: {
+        testCaseId: string;
+        failedStepIndex: number;
+    }[] | null;
+    private reportGenerator;
+    private uploader;
+    private exit;
+    private START;
+    private runName;
+    private failedStepsIndex;
+    private summaryFormatter;
+    private rootCauseArray;
+    constructor(options: IFormatterOptions);
+    private sendEvent;
+    private uploadReport;
+    finished(): Promise<any>;
+    private analyzeReport;
+    private processTestCases;
+    private processTestCase;
+    private uploadFinalReport;
+    private retrain;
+    private rerun;
+    private call_cucumber_client;
+    private getAppDataDir;
+}
+export declare function logReportLink(runId: string, projectId: string): void;

package/lib/formatter/bvt_analysis_formatter.js

@@ -0,0 +1,334 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logReportLink = void 0;
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = __importDefault(require("path"));
+const tmp_1 = require("tmp");
+const _1 = __importDefault(require("."));
+const value_checker_1 = require("../value_checker");
+const report_generator_1 = __importDefault(require("./helpers/report_generator"));
+const uploader_1 = __importDefault(require("./helpers/uploader"));
+const os_1 = __importDefault(require("os"));
+const api_1 = require("./api");
+const summary_formatter_1 = __importDefault(require("./summary_formatter"));
+const constants_1 = require("./helpers/constants");
+const axios_client_1 = require("../configuration/axios_client");
+const util_1 = require("util");
+const child_process_2 = require("child_process");
+//User token
+const TOKEN = process.env.TOKEN;
+class BVTAnalysisFormatter extends _1.default {
+    constructor(options) {
+        super(options);
+        this.reportGenerator = new report_generator_1.default();
+        this.uploader = new uploader_1.default(this.reportGenerator);
+        this.exit = false;
+        this.rootCauseArray = [];
+        this.summaryFormatter = new summary_formatter_1.default(options);
+        BVTAnalysisFormatter.reportGenerator = this.reportGenerator;
+        this.rootCauseArray = [];
+        this.failedStepsIndex = [];
+        BVTAnalysisFormatter.reRunFailedStepsIndex = process.env.RERUN
+            ? JSON.parse(process.env.RERUN)
+            : null;
+        if (!TOKEN && process.env.BVT_FORMATTER === 'ANALYSIS') {
+            throw new Error('TOKEN must be set');
+        }
+        this.sendEvent(constants_1.ActionEvents.cli_run_tests);
+        options.eventBroadcaster.on('envelope', async (envelope, data) => {
+            if ((0, value_checker_1.doesHaveValue)(envelope.testCaseFinished) && data) {
+                const { rootCause, report } = data;
+                if (!rootCause.status) {
+                    console.error(`Root cause: ${rootCause.failClass}\n, ${rootCause.analysis}\nfailing step: ${rootCause.failedStep}`);
+                    this.rootCauseArray.push({ rootCause, report });
+                    this.failedStepsIndex.push({
+                        testCaseId: report.id,
+                        failedStepIndex: rootCause.failedStep,
+                    });
+                }
+                return;
+            }
+            await this.reportGenerator.handleMessage(envelope);
+            if ((0, value_checker_1.doesHaveValue)(envelope.meta) &&
+                (0, value_checker_1.doesHaveValue)(envelope.meta.runName)) {
+                this.runName = envelope.meta.runName;
+            }
+            if ((0, value_checker_1.doesHaveValue)(envelope.testRunFinished)) {
+                this.START = Date.now();
+                if (process.env.BVT_FORMATTER === 'ANALYSIS') {
+                    await this.analyzeReport();
+                }
+                else {
+                    // await this.uploadReport(report)
+                }
+                this.exit = true;
+            }
+        });
+    }
+    sendEvent(event) {
+        axios_client_1.axiosClient
+            .post(`${constants_1.SERVICES_URI.STORAGE}/event`, {
+            event,
+        }, {
+            headers: {
+                Authorization: `Bearer ${TOKEN}`,
+                'x-source': 'cucumber_js',
+            },
+        })
+            .catch((err) => {
+            // Error with events, ignoring
+        });
+    }
+    async uploadReport(report) {
+        const uploadSuccessful = await this.uploadFinalReport(report);
+        if (uploadSuccessful && report.result.status !== 'FAILED') {
+            process.exit(0);
+        }
+        process.exit(1);
+    }
+    async finished() {
+        await new Promise((resolve) => {
+            const checkInterval = setInterval(() => {
+                let anyRem;
+                if (process.env.UPLOADING_TEST_CASE) {
+                    anyRem = JSON.parse(process.env.UPLOADING_TEST_CASE);
+                }
+                else {
+                    anyRem = undefined;
+                }
+                if (this.exit && (!anyRem || anyRem.length === 0)) {
+                    // clearInterval(checkInterval)
+                    // resolve(null)
+                    if (this.reportGenerator.getReport().result.status === 'FAILED') {
+                        process.exit(1);
+                    }
+                    else {
+                        process.exit(0);
+                    }
+                }
+            }, 100); // check every 100ms
+        });
+    }
+    async analyzeReport() {
+        if (this.rootCauseArray.length === 0 ||
+            process.env.NO_RETRAIN === 'false') {
+            if (this.rootCauseArray.length === 0) {
+                this.log('No test failed. No need to retrain\n');
+            }
+            if (process.env.NO_RETRAIN === 'false') {
+                this.log('Retraining is skipped since the failed step contains an API request\n');
+            }
+            // const uploadSuccessful = await this.uploadFinalReport(report)
+            // process.exit(0)
+            this.exit = true;
+            return;
+        }
+        //checking if the type of report.result is JsonResultFailed or not
+        this.log('Some tests failed, starting the retraining...\n');
+        await this.processTestCases();
+        if (this.reportGenerator.getReport().result.status === 'FAILED') {
+            process.exit(1);
+        }
+        process.exit(0);
+    }
+    async processTestCases() {
+        for (const { rootCause, report } of this.rootCauseArray) {
+            await this.processTestCase(rootCause, report);
+        }
+    }
+    async processTestCase(rootCause, report) {
+        const failedTestSteps = rootCause.failedStep;
+        if (BVTAnalysisFormatter.reRunFailedStepsIndex &&
+            BVTAnalysisFormatter.reRunFailedStepsIndex.length > 0) {
+            const previousRun = BVTAnalysisFormatter.reRunFailedStepsIndex[0];
+            if (previousRun.failedStepIndex === failedTestSteps) {
+                console.log('Same step has failed again, skipping retraining');
+                BVTAnalysisFormatter.reRunFailedStepsIndex.shift();
+                return;
+            }
+            BVTAnalysisFormatter.reRunFailedStepsIndex.shift();
+        }
+        const retrainStats = await this.retrain(failedTestSteps, report);
+        if (!retrainStats) {
+            return;
+        }
+        await this.uploader.modifyTestCase({
+            ...report,
+            retrainStats,
+        });
+        await this.rerun(report);
+    }
+    async uploadFinalReport(finalReport) {
+        let success = true;
+        try {
+            const { projectId, runId } = await this.uploader.uploadRun(finalReport, this.runName);
+            logReportLink(runId, projectId);
+        }
+        catch (err) {
+            this.log('Error uploading report\n');
+            if ('stack' in err) {
+                this.log(err.stack);
+            }
+            success = false;
+        }
+        finally {
+            try {
+                (0, fs_1.writeFileSync)(path_1.default.join(this.reportGenerator.reportFolder, 'report.json'), JSON.stringify(finalReport, null, 2), 'utf-8');
+            }
+            catch (e) {
+                console.error('failed to write report.json to local disk');
+            }
+        }
+        //this.log(JSON.stringify(finalReport, null, 2))
+        return success;
+    }
+    async retrain(failedTestCases, testCase) {
+        const data = await (0, api_1.getProjectByAccessKey)(TOKEN);
+        const currentTimestampInSeconds = Math.floor(Date.now() / 1000);
+        if (data.project.expriration_date < currentTimestampInSeconds) {
+            console.log('Warning: Your project has expired, retraining is restricted. Please contact sales.');
+            process.exit(1);
+        }
+        return await this.call_cucumber_client(failedTestCases, testCase);
+    }
+    async rerun(report) {
+        await new Promise((resolve) => {
+            const node_path = process.argv.shift();
+            const args = [
+                path_1.default.join(process.cwd(), 'node_modules', '@dev-blinq', 'cucumber-js', 'bin', 'cucumber.js'),
+                '--name',
+                `^${report.scenarioName}$`,
+                '--exit',
+                '--format',
+                'bvt',
+                '--run-name',
+                `${report.scenarioName}@debug`,
+                path_1.default.join(process.cwd(), 'features', `${report.featureName}.feature`),
+            ];
+            const cucumberClient = (0, child_process_1.spawn)(node_path, args, {
+                env: {
+                    ...process.env,
+                    RERUN: JSON.stringify(this.failedStepsIndex),
+                },
+            });
+            cucumberClient.stdout.on('data', (data) => {
+                console.log(data.toString());
+            });
+            cucumberClient.stderr.on('data', (data) => {
+                console.error(data.toString());
+            });
+            cucumberClient.on('close', () => {
+                resolve();
+            });
+        });
+    }
+    async call_cucumber_client(stepsToRetrain, testCase) {
+        return new Promise((resolve, reject) => {
+            const cucumber_client_path = path_1.default.resolve(process.cwd(), 'node_modules', '@dev-blinq', 'cucumber_client', 'bin', 'client', 'cucumber.js');
+            const args = [
+                process.cwd(),
+                path_1.default.join(process.cwd(), testCase.uri),
+                `${testCase.scenarioName}`,
+                'undefined',
+                `${stepsToRetrain},`,
+            ];
+            if (process.env.BLINQ_ENV) {
+                args.push(`--env=${process.env.BLINQ_ENV}`);
+            }
+            if (!(0, fs_1.existsSync)(path_1.default.join(this.getAppDataDir(), 'blinq.io', '.temp'))) {
+                (0, promises_1.mkdir)(path_1.default.join(this.getAppDataDir(), 'blinq.io', '.temp'), {
+                    recursive: true,
+                });
+            }
+            (0, tmp_1.tmpName)(async (err, name) => {
+                const tempFile = path_1.default.join(this.getAppDataDir(), 'blinq.io', '.temp', path_1.default.basename(name));
+                console.log('File path: ', tempFile);
+                await (0, promises_1.writeFile)(tempFile, '', 'utf-8');
+                args.push(`--temp-file=${tempFile}`);
+                const cucumberClient = (0, child_process_1.spawn)('node', [cucumber_client_path, ...args], {
+                    env: {
+                        ...process.env,
+                    },
+                });
+                cucumberClient.stdout.on('data', (data) => {
+                    console.log(data.toString());
+                });
+                cucumberClient.stderr.on('data', (data) => {
+                    console.error(data.toString());
+                });
+                cucumberClient.on('close', async (code) => {
+                    if (code === 0) {
+                        const reportData = (0, fs_1.readFileSync)(tempFile, 'utf-8');
+                        const retrainStats = JSON.parse(reportData);
+                        await (0, promises_1.unlink)(tempFile);
+                        resolve(retrainStats);
+                    }
+                    else {
+                        this.log('Error retraining\n');
+                        try {
+                            const reportData = (0, fs_1.readFileSync)(tempFile, 'utf-8');
+                            const retrainStats = JSON.parse(reportData);
+                            await (0, promises_1.unlink)(tempFile);
+                            resolve(retrainStats);
+                        }
+                        catch (e) {
+                            this.log('Error  reading scenario report\n ' + e);
+                            resolve(null);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    getAppDataDir() {
+        if (process.env.BLINQ_APPDATA_DIR) {
+            return process.env.BLINQ_APPDATA_DIR;
+        }
+        let appDataDir;
+        switch (process.platform) {
+            case 'win32':
+                appDataDir = process.env.APPDATA;
+                break;
+            case 'darwin':
+                appDataDir = path_1.default.join(os_1.default.homedir(), 'Library', 'Application Support');
+                break;
+            default:
+                appDataDir = path_1.default.join(os_1.default.homedir(), '.config');
+                break;
+        }
+        return appDataDir;
+    }
+}
+exports.default = BVTAnalysisFormatter;
+function logReportLink(runId, projectId) {
+    let reportLinkBaseUrl = 'https://app.blinq.io';
+    if (process.env.NODE_ENV_BLINQ === 'local') {
+        reportLinkBaseUrl = 'http://localhost:3000';
+    }
+    else if (process.env.NODE_ENV_BLINQ === 'dev') {
+        reportLinkBaseUrl = 'https://dev.app.blinq.io';
+    }
+    else if (process.env.NODE_ENV_BLINQ === 'stage') {
+        reportLinkBaseUrl = 'https://stage.app.blinq.io';
+    }
+    const reportLink = `${reportLinkBaseUrl}/${projectId}/run-report/${runId}`;
+    console.log(`Report link: ${reportLink}\n`);
+    try {
+        publishReportLinkToGuacServer(reportLink);
+    }
+    catch (err) {
+    }
+}
+exports.logReportLink = logReportLink;
+function publishReportLinkToGuacServer(reportLink) {
+    if ((0, fs_1.existsSync)("/tmp/report_publish.sh")) {
+        const execAsync = (0, util_1.promisify)(child_process_2.exec);
+        execAsync("sh /tmp/report_publish.sh " + reportLink);
+    }
+}
+//# sourceMappingURL=bvt_analysis_formatter.js.map