@zohodesk/testinglibrary 2.9.1 → 3.0.1

package/build/bdd-framework/cucumber/loadFeatures.js

@@ -1,70 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.FeaturesLoader = void 0;
-var _gherkinStreams = require("@cucumber/gherkin-streams");
-var _gherkinUtils = require("@cucumber/gherkin-utils");
-/**
- * Load features.
- *
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/api/load_sources.ts
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/api/gherkin.ts
- */
-
-class FeaturesLoader {
-  gherkinQuery = new _gherkinUtils.Query();
-  parseErrors = [];
-  /**
-     * Loads and parses feature files.
-     * - featurePaths should be absolute.
-     *   See: https://github.com/cucumber/gherkin-streams/blob/main/src/GherkinStreams.ts#L36
-     * - if options.relativeTo is provided, uri in gherkin documents will be relative to it.
-     *   See: https://github.com/cucumber/gherkin-streams/blob/main/src/SourceMessageStream.ts#L31
-     * - options.defaultDialect is 'en' by default.
-     *   See: https://github.com/cucumber/gherkin-streams/blob/main/src/makeGherkinOptions.ts#L5
-     */
-  async load(featurePaths, options) {
-    this.gherkinQuery = new _gherkinUtils.Query();
-    this.parseErrors = [];
-    await gherkinFromPaths(featurePaths, options, envelope => {
-      this.gherkinQuery.update(envelope);
-      if (envelope.parseError) {
-        this.parseErrors.push(envelope.parseError);
-      }
-    });
-  }
-  getDocumentsCount() {
-    return this.gherkinQuery.getGherkinDocuments().length;
-  }
-  getDocumentsWithPickles() {
-    return this.gherkinQuery.getGherkinDocuments().map(gherkinDocument => {
-      const pickles = this.getDocumentPickles(gherkinDocument);
-      return {
-        ...gherkinDocument,
-        pickles
-      };
-    });
-  }
-  getDocumentPickles(gherkinDocument) {
-    return this.gherkinQuery.getPickles().filter(pickle => gherkinDocument.uri === pickle.uri).map(pickle => this.getPickleWithLocation(pickle));
-  }
-  getPickleWithLocation(pickle) {
-    const lastAstNodeId = pickle.astNodeIds[pickle.astNodeIds.length - 1];
-    const location = this.gherkinQuery.getLocation(lastAstNodeId);
-    return {
-      ...pickle,
-      location
-    };
-  }
-}
-exports.FeaturesLoader = FeaturesLoader;
-async function gherkinFromPaths(paths, options, onEnvelope) {
-  return new Promise((resolve, reject) => {
-    const gherkinMessageStream = _gherkinStreams.GherkinStreams.fromPaths(paths, options);
-    gherkinMessageStream.on('data', onEnvelope);
-    gherkinMessageStream.on('end', resolve);
-    gherkinMessageStream.on('error', reject);
-  });
-}

package/build/bdd-framework/cucumber/loadSnippetBuilder.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadSnippetBuilder = loadSnippetBuilder;
-var _cucumber = require("@cucumber/cucumber");
-/**
- * Loads snippet builder
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/builder.ts
- */
-
-async function loadSnippetBuilder(supportCodeLibrary, snippetInterface, snippetSyntax) {
-  return _cucumber.FormatterBuilder.getStepDefinitionSnippetBuilder({
-    cwd: process.cwd(),
-    snippetInterface,
-    snippetSyntax,
-    supportCodeLibrary
-  });
-}

package/build/bdd-framework/cucumber/loadSteps.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.findStepDefinition = findStepDefinition;
-exports.hasTsNodeRegister = hasTsNodeRegister;
-exports.loadSteps = loadSteps;
-var _api = require("@cucumber/cucumber/api");
-var _transform = require("../playwright/transform");
-var _exit = require("../utils/exit");
-const cache = new Map();
-async function loadSteps(runConfiguration, environment = {}) {
-  const cacheKey = JSON.stringify(runConfiguration);
-  let lib = cache.get(cacheKey);
-  if (!lib) {
-    // use Playwright's built-in hook to compile TypeScript steps
-    const uninstall = !hasTsNodeRegister(runConfiguration) ? (0, _transform.installTransform)() : () => {};
-    lib = (0, _api.loadSupport)(runConfiguration, environment).finally(() => uninstall());
-    cache.set(cacheKey, lib);
-  }
-  return lib;
-}
-/**
- * Finds step definition by step text.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/runtime/assemble_test_cases.ts#L103
- *
- * Handling case when several step definitions found:
- * https://github.com/cucumber/cucumber-js/blob/main/src/runtime/test_case_runner.ts#L313
- */
-function findStepDefinition(supportCodeLibrary, stepText, file) {
-  const matchedSteps = supportCodeLibrary.stepDefinitions.filter(step => {
-    return step.matchesStepName(stepText);
-  });
-  if (matchedSteps.length === 0) {
-    return;
-  }
-  if (matchedSteps.length > 1) {
-    (0, _exit.exit)([`Multiple step definitions matched for text: "${stepText}" (${file})`,
-    // todo: print location of every step definition (as in cucumber)
-    ...matchedSteps.map(s => `  ${s.pattern}`)].join('\n'));
-  }
-  return matchedSteps[0];
-}
-function hasTsNodeRegister(runConfiguration) {
-  return runConfiguration.support.requireModules.includes('ts-node/register');
-}

package/build/bdd-framework/cucumber/resolveFeaturePaths.js

@@ -1,62 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.resovleFeaturePaths = resovleFeaturePaths;
-var _fs = _interopRequireDefault(require("fs"));
-var _path = _interopRequireDefault(require("path"));
-var _environment = require("@cucumber/cucumber/lib/api/environment");
-var _console_logger = require("@cucumber/cucumber/lib/api/console_logger");
-var _utils = require("../utils");
-/**
- * Representation of https://github.com/cucumber/cucumber-js/blob/main/src/paths/paths.ts
- * Since Cucumber 10.1 resolvePaths was moved from lib/api/paths to lib/paths/paths.
- * This module makes resolvePaths working with any version of Cucumber.
- * See: https://github.com/cucumber/cucumber-js/pull/2361/files
- *
- * todo: replace with own paths resolution.
- */
-
-/**
- * Returns list of absolute feature paths.
- */
-// eslint-disable-next-line max-statements
-async function resovleFeaturePaths(runConfiguration, environment = {}) {
-  const {
-    cwd,
-    stderr,
-    debug
-  } = (0, _environment.mergeEnvironment)(environment);
-  const logger = new _console_logger.ConsoleLogger(stderr, debug);
-  const cucumberRoot = (0, _utils.resolvePackageRoot)('@cucumber/cucumber');
-  const pathsModuleBefore10_1 = _path.default.join(cucumberRoot, 'lib/api/paths.js');
-  const pathsModuleAfter10_1 = _path.default.join(cucumberRoot, 'lib/paths/paths.js');
-  const isNewResolvePaths = _fs.default.existsSync(pathsModuleAfter10_1);
-  if (isNewResolvePaths) {
-    const {
-      resolvePaths
-    } = require(pathsModuleAfter10_1);
-    const {
-      sourcePaths,
-      unexpandedSourcePaths
-    } = await resolvePaths(logger, cwd, runConfiguration.sources);
-    return {
-      featurePaths: sourcePaths,
-      unexpandedFeaturePaths: unexpandedSourcePaths
-    };
-  } else {
-    const {
-      resolvePaths
-    } = require(pathsModuleBefore10_1);
-    const {
-      featurePaths,
-      unexpandedFeaturePaths
-    } = await resolvePaths(logger, cwd, runConfiguration.sources);
-    return {
-      featurePaths,
-      unexpandedFeaturePaths
-    };
-  }
-}

package/build/bdd-framework/cucumber/stepArguments.js

@@ -1,21 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseStepArgument = parseStepArgument;
-var _util = _interopRequireDefault(require("util"));
-var _valueChecker = require("./valueChecker");
-/**
- * Based on: https://github.com/cucumber/cucumber-js/blob/main/src/step_arguments.ts
- */
-
-function parseStepArgument(arg, mapping) {
-  if ((0, _valueChecker.doesHaveValue)(arg.dataTable)) {
-    return mapping.dataTable(arg.dataTable);
-  } else if ((0, _valueChecker.doesHaveValue)(arg.docString)) {
-    return mapping.docString(arg.docString);
-  }
-  throw new Error(`Unknown step argument: ${_util.default.inspect(arg)}`);
-}

package/build/bdd-framework/cucumber/types.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/build/bdd-framework/cucumber/valueChecker.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.doesHaveValue = doesHaveValue;
-exports.doesNotHaveValue = doesNotHaveValue;
-exports.valueOrDefault = valueOrDefault;
-/**
- * Based on: https://github.com/cucumber/cucumber-js/blob/main/src/value_checker.ts
- */
-function doesHaveValue(value) {
-  return !doesNotHaveValue(value);
-}
-function doesNotHaveValue(value) {
-  return value === null || value === undefined;
-}
-function valueOrDefault(value, defaultValue) {
-  if (doesHaveValue(value)) {
-    return value;
-  }
-  return defaultValue;
-}

package/build/bdd-framework/decorators.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "Fixture", {
-  enumerable: true,
-  get: function () {
-    return _class.Fixture;
-  }
-});
-exports.When = exports.Then = exports.Step = exports.Given = void 0;
-var _class = require("./steps/decorators/class");
-var _steps = require("./steps/decorators/steps");
-const Given = exports.Given = (0, _steps.createStepDecorator)('Given');
-const When = exports.When = (0, _steps.createStepDecorator)('When');
-const Then = exports.Then = (0, _steps.createStepDecorator)('Then');
-const Step = exports.Step = (0, _steps.createStepDecorator)('Unknown');

package/build/bdd-framework/gen/fixtures.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractFixtureNames = extractFixtureNames;
-exports.extractFixtureNamesFromFnBodyMemo = extractFixtureNamesFromFnBodyMemo;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _bddFixtures = require("../run/bddFixtures");
-var _exit = require("../utils/exit");
-const bodyFixturesSymbol = Symbol('bodyFixtures');
-/**
- * This function is used for playwright-style steps and decorators.
- * It extracts fixtures names from first parameter of function
- * using Playwright's helper.
- */
-function extractFixtureNames(fn) {
-  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-}
-/**
- * This function is used for cucumber-style steps.
- * It looks for `this.useFixture('xxx')` entries in function body
- * and extracts fixtures names from it.
- */
-function extractFixtureNamesFromFnBodyMemo(fn) {
-  if (typeof fn !== 'function') {
-    return [];
-  }
-  const fnWithFixtures = fn;
-  if (!fnWithFixtures[bodyFixturesSymbol]) {
-    fnWithFixtures[bodyFixturesSymbol] = extractFixtureNamesFromFnBody(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-  }
-  return fnWithFixtures[bodyFixturesSymbol];
-}
-function extractFixtureNamesFromFnBody(fn) {
-  const matches = fn.toString().matchAll(/this\.useFixture\((.+)\)/gi) || [];
-  return [...matches].map(match => getFixtureName(match[1]));
-}
-function getFixtureName(arg) {
-  if (!/^['"`]/.test(arg)) {
-    // todo: log file location with incorrect useFixture
-    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
-  }
-  if (arg.startsWith('`') && arg.includes('${')) {
-    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
-  }
-  return arg.replace(/['"`]/g, '');
-}

package/build/bdd-framework/gen/formatter.js

@@ -1,167 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Formatter = void 0;
-var _jsStringWrap = require("../utils/jsStringWrap");
-var _utils = require("../utils");
-var _utils2 = require("../playwright/utils");
-/**
- * Helper to format Playwright test file.
- */
-
-const supportsTags = _utils2.playwrightVersion >= '1.42.0';
-class Formatter {
-  config;
-  constructor(config) {
-    this.config = config;
-  }
-  fileHeader(featureUri, importTestFrom) {
-    // always use "/" for imports, see #91
-    const importTestFromFile = (0, _utils.toPosixPath)((importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.file) || '@zohodesk/testinglibrary');
-    let varName = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.varName) || 'test';
-    if (varName !== 'test') {
-      varName = `${varName} as test`;
-    }
-    return [`/** Generated from: ${featureUri} */`,
-    // prettier-ignore
-    // this.quoted() is not possible for 'import from' as backticks not parsed
-    `import { ${varName} } from ${JSON.stringify(importTestFromFile)};`, ''];
-  }
-  describe(node, children) {
-    const firstLine = `test.${this.getFunction('describe', node)}(${this.quoted(node.title)}, () => {`;
-    if (!children.length) {
-      return [`${firstLine}});`, ''];
-    }
-    return [firstLine,
-    // prettier-ignore
-    ...this.describeConfigure(node).map(indent), '', ...children.map(indent), `});`, ''];
-  }
-  beforeEach(fixtures, children) {
-    const fixturesStr = [...fixtures].join(', ');
-    // prettier-ignore
-    return [`test.beforeEach(async ({ ${fixturesStr} }) => {`, ...children.map(indent), `});`, ''];
-  }
-  test(node, fixtures, children) {
-    const fixturesStr = [...fixtures].join(', ');
-    const title = this.quoted(node.title);
-    const tags = this.testTags(node);
-    const firstLine = `${this.getFunction('test', node)}(${title}, ${tags}async ({ ${fixturesStr} }) => {`;
-    if (!children.length) {
-      return [`${firstLine}});`, ''];
-    }
-    const lines = [firstLine,
-    // prettier-ignore
-    ...children.map(indent), `});`, ''];
-    // wrap test into anonymous describe in case of retries / timeout tags
-    const specialTagsConfigure = this.describeConfigure(node);
-    return specialTagsConfigure.length ? ['test.describe(() => {',
-    // prettier-ignore
-    ...specialTagsConfigure.map(indent), '', ...lines.map(indent), `});`, ''] : lines;
-  }
-  // eslint-disable-next-line max-params
-  step(keyword, text, argument, fixtureNames = []) {
-    const fixtures = fixtureNames.length ? `{ ${fixtureNames.join(', ')} }` : '';
-    const argumentArg = argument ? JSON.stringify(argument) : fixtures ? 'null' : '';
-    const textArg = this.quoted(text);
-    const args = [textArg, argumentArg, fixtures].filter(arg => arg !== '').join(', ');
-    return `await ${keyword}(${args});`;
-  }
-  missingStep(keyword, text) {
-    return `// missing step: ${keyword}(${this.quoted(text)});`;
-  }
-  technicalSection(testMetaBuilder, featureUri, fixtures) {
-    return ['// == technical section ==',
-    // prettier-ignore
-    '', 'test.use({', ...['$test: ({}, use) => use(test),', '$testMetaMap: ({}, use) => use(testMetaMap),', `$uri: ({}, use) => use(${this.quoted(featureUri)}),`, ...fixtures].map(indent), '});', '', 'const testMetaMap = {', ...testMetaBuilder.getObjectLines().map(indent), '};'];
-  }
-  bddWorldFixtures() {
-    const fixturesObj = {
-      page: null,
-      context: null,
-      browser: null,
-      browserName: null,
-      request: null
-    };
-    const fixtures = Object.keys(fixturesObj).join(', ');
-    return [`$bddWorldFixtures: ({ ${fixtures} }, use) => use({ ${fixtures} }),`];
-  }
-  scenarioHookFixtures(fixtureNames) {
-    if (!fixtureNames.length) {
-      return [];
-    }
-    const fixtures = fixtureNames.join(', ');
-    return [`$scenarioHookFixtures: ({ ${fixtures} }, use) => use({ ${fixtures} }),`];
-  }
-  workerHookFixtures(fixtureNames) {
-    if (!fixtureNames.length) {
-      return [];
-    }
-    const fixtures = fixtureNames.join(', ');
-    const scope = this.quoted('worker');
-    return [`$workerHookFixtures: [({ ${fixtures} }, use) => use({ ${fixtures} }), { scope: ${scope} }],`];
-  }
-  langFixture(lang) {
-    return [`$lang: ({}, use) => use(${this.quoted(lang)}),`];
-  }
-  // eslint-disable-next-line complexity
-  getFunction(baseFn, node) {
-    if (node.specialTags.only) {
-      return `${baseFn}.only`;
-    }
-    // describe.fail is not supported
-    if (baseFn === 'test' && node.specialTags.fail) {
-      return `${baseFn}.fail`;
-    }
-    if (node.specialTags.skip) {
-      return `${baseFn}.skip`;
-    }
-    if (node.specialTags.fixme) {
-      return `${baseFn}.fixme`;
-    }
-    return baseFn;
-  }
-  describeConfigure(node) {
-    const options = {};
-    const {
-      retries,
-      timeout,
-      mode
-    } = node.specialTags;
-    if (retries !== undefined) {
-      options.retries = retries;
-    }
-    if (timeout !== undefined) {
-      options.timeout = timeout;
-    }
-    if (mode !== undefined) {
-      options.mode = mode;
-    }
-    return Object.keys(options).length ? [`test.describe.configure(${JSON.stringify(options)});`] : [];
-  }
-  testTags(node) {
-    return supportsTags && node.tags.length ? `{ tag: [${node.tags.map(tag => this.quoted(tag)).join(', ')}] }, ` : '';
-  }
-  testTimeout(node) {
-    const {
-      timeout
-    } = node.specialTags;
-    return timeout !== undefined ? [`test.setTimeout(${timeout});`] : [];
-  }
-  /**
-     * Apply this function only to string literals (mostly titles here).
-     * Objects and arrays are handled with JSON.strinigfy,
-     * b/c object keys can't be in backticks.
-     * See: https://stackoverflow.com/questions/33194138/template-string-as-object-property-name
-     */
-  quoted(str) {
-    return (0, _jsStringWrap.jsStringWrap)(str, {
-      quotes: this.config.quotes
-    });
-  }
-}
-exports.Formatter = Formatter;
-function indent(value) {
-  return value ? `${'  '}${value}` : value;
-}

package/build/bdd-framework/gen/i18n.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getKeywordsMap = getKeywordsMap;
-var _gherkin = require("@cucumber/gherkin");
-/**
- * Get i18n keywords.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/cli/i18n.ts
- */
-
-function getKeywordsMap(language) {
-  const origMap = _gherkin.dialects[language];
-  if (!origMap) {
-    throw new Error(`Language not found: ${language}`);
-  }
-  const targetMap = new Map();
-  const enKeywords = Object.keys(origMap);
-  enKeywords.forEach(enKeyword => handleKeyword(enKeyword, origMap, targetMap));
-  return targetMap;
-}
-function handleKeyword(enKeyword, origMap, targetMap) {
-  const nativeKeywords = origMap[enKeyword];
-  // Array.isArray converts to any[]
-  if (typeof nativeKeywords === 'string') {
-    return;
-  }
-  nativeKeywords.forEach(nativeKeyword => {
-    nativeKeyword = nativeKeyword.trim();
-    if (!nativeKeyword || nativeKeyword === '*') {
-      return;
-    }
-    targetMap.set(nativeKeyword, capitalizeFirstLetter(enKeyword));
-  });
-}
-function capitalizeFirstLetter(s) {
-  return s.charAt(0).toUpperCase() + s.slice(1);
-}