@zohodesk/testinglibrary 0.1.8-exp-bdd-v2 → 0.1.8-exp-bdd-v3

package/build/bdd-framework/stepDefinitions/createBdd.js

@@ -1,49 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createBdd = createBdd;
-exports.extractFixtureNames = extractFixtureNames;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _bddFixtures = require("../run/bddFixtures");
-var _testTypeImpl = require("../playwright/testTypeImpl");
-var _defineStep = require("./defineStep");
-var _exit = require("../utils/exit");
-/**
- * Stuff related to writing steps in Playwright-style.
- */
-
-function createBdd(customTest) {
-  const hasCustomTest = isCustomTest(customTest);
-  const Given = defineStepCtor('Given', hasCustomTest);
-  const When = defineStepCtor('When', hasCustomTest);
-  const Then = defineStepCtor('Then', hasCustomTest);
-  const Step = defineStepCtor('Unknown', hasCustomTest);
-  return {
-    Given,
-    When,
-    Then,
-    Step
-  };
-}
-function defineStepCtor(keyword, hasCustomTest) {
-  return (pattern, fn) => {
-    (0, _defineStep.defineStep)({
-      keyword,
-      pattern,
-      fn,
-      hasCustomTest
-    });
-  };
-}
-function extractFixtureNames(fn) {
-  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-}
-function isCustomTest(customTest) {
-  const isCustomTest = Boolean(customTest && customTest !== _bddFixtures.test);
-  if (isCustomTest && customTest && !(0, _testTypeImpl.isParentChildTest)(_bddFixtures.test, customTest)) {
-    (0, _exit.exit)(`createBdd() should use test extended from "@zohodesk/testinglibrary"`);
-  }
-  return isCustomTest;
-}

package/build/bdd-framework/stepDefinitions/createDecorators.js

@@ -1,109 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Fixture = Fixture;
-exports.appendDecoratorSteps = appendDecoratorSteps;
-exports.createStepDecorator = createStepDecorator;
-exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
-var _bddFixtures = require("../run/bddFixtures");
-var _defineStep = require("./defineStep");
-var _buildStepDefinition = require("../cucumber/buildStepDefinition");
-/* eslint-disable no-unused-vars */
-/**
- * Define steps via decorators.
- */
-
-const pomGraph = new Map();
-const decoratedStepSymbol = Symbol('decoratedStep');
-const decoratedSteps = new Set();
-function Fixture(fixtureName) {
-  // context parameter is required for decorator by TS even though it's not used
-  return (Ctor, _context) => {
-    createPomNode(Ctor, fixtureName);
-  };
-}
-function createStepDecorator(keyword) {
-  return pattern => {
-    // context parameter is required for decorator by TS even though it's not used
-    return (method, _context) => {
-      method[decoratedStepSymbol] = {
-        keyword,
-        pattern,
-        fn: method,
-        hasCustomTest: true,
-        isDecorator: true
-      };
-    };
-  };
-}
-function appendDecoratorSteps(supportCodeLibrary) {
-  decoratedSteps.forEach(stepConfig => {
-    const {
-      keyword,
-      pattern,
-      fn
-    } = stepConfig;
-    stepConfig.fn = (fixturesArg, ...args) => {
-      const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
-      return fn.call(fixture, ...args);
-    };
-    const code = (0, _defineStep.buildCucumberStepFn)(stepConfig);
-    const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
-      keyword,
-      pattern,
-      code,
-      line: 0,
-      // not used in playwright-bdd
-      options: {},
-      // not used in playwright-bdd
-      uri: '' // not used in playwright-bdd
-    }, supportCodeLibrary);
-    supportCodeLibrary.stepDefinitions.push(stepDefinition);
-  });
-  decoratedSteps.clear();
-  // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
-}
-
-function getPomNodeByFixtureName(fixtureName) {
-  for (const pomNode of pomGraph.values()) {
-    if (pomNode.fixtureName === fixtureName) return pomNode;
-  }
-}
-function createPomNode(Ctor, fixtureName) {
-  const pomNode = {
-    fixtureName,
-    children: new Set()
-  };
-  pomGraph.set(Ctor, pomNode);
-  getDecoratedSteps(Ctor).forEach(stepConfig => {
-    stepConfig.pomNode = pomNode;
-    decoratedSteps.add(stepConfig);
-  });
-  const parentCtor = Object.getPrototypeOf(Ctor);
-  if (!parentCtor) return;
-  const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
-  parentPomNode === null || parentPomNode === void 0 || parentPomNode.children.add(pomNode);
-  return pomNode;
-}
-function getDecoratedSteps(Ctor) {
-  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return [];
-  const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
-  return Object.keys(propertyDescriptors)
-  // filter out getters / setters
-  .filter(methodName => typeof propertyDescriptors[methodName].value === 'function').map(methodName => {
-    return propertyDescriptors[methodName].value[decoratedStepSymbol];
-  }).filter(Boolean);
-}
-function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
-  // there should be exatcly one suitable fixture in fixturesArg
-  const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
-  if (fixtureNames.length === 0) {
-    throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  if (fixtureNames.length > 1) {
-    throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  return fixturesArg[fixtureNames[0]];
-}

package/build/bdd-framework/stepDefinitions/decorators/poms.js

@@ -1,64 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Fixture = Fixture;
-exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
-var _steps = require("./steps");
-var _exit = require("../../utils/exit");
-/**
- * POM classes marked with @Fixture
- */
-
-/**
- * Graph of POM class inheritance.
- * Allows to guess correct fixture by step text.
- */
-const pomGraph = new Map();
-/**
- * @Fixture decorator.
- */
-function Fixture(fixtureName) {
-  // context parameter is required for decorator by TS even though it's not used
-  return Ctor => {
-    createPomNode(Ctor, fixtureName);
-  };
-}
-function createPomNode(Ctor, fixtureName) {
-  const pomNode = {
-    fixtureName,
-    className: Ctor.name,
-    children: new Set()
-  };
-  ensureUniqueFixtureName(pomNode);
-  pomGraph.set(Ctor, pomNode);
-  (0, _steps.linkStepsWithPomNode)(Ctor, pomNode);
-  linkParentWithPomNode(Ctor, pomNode);
-  return pomNode;
-}
-function ensureUniqueFixtureName({
-  fixtureName,
-  className
-}) {
-  if (!fixtureName) {
-    return;
-  }
-  const existingPom = getPomNodeByFixtureName(fixtureName);
-  if (existingPom) {
-    (0, _exit.exit)(`Duplicate fixture name "${fixtureName}"`, `defined for classes: ${existingPom.className}, ${className}`);
-  }
-}
-function linkParentWithPomNode(Ctor, pomNode) {
-  const parentCtor = Object.getPrototypeOf(Ctor);
-  if (!parentCtor) return;
-  // if parentCtor is not in pomGraph, add it.
-  // Case: parent class is not marked with @Fixture, but has decorator steps (base class)
-  const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
-  parentPomNode.children.add(pomNode);
-}
-function getPomNodeByFixtureName(fixtureName) {
-  for (const pomNode of pomGraph.values()) {
-    if (pomNode.fixtureName === fixtureName) return pomNode;
-  }
-}

package/build/bdd-framework/stepDefinitions/decorators/steps.js

@@ -1,94 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.appendDecoratorSteps = appendDecoratorSteps;
-exports.createStepDecorator = createStepDecorator;
-exports.linkStepsWithPomNode = linkStepsWithPomNode;
-var _bddFixtures = require("../../run/bddFixtures");
-var _buildStepDefinition = require("../../cucumber/buildStepDefinition");
-var _defineStep = require("../defineStep");
-/**
- * Define steps via decorators.
- */
-
-// initially we sotre step data inside method,
-// and then extract it in @Fixture decorator call
-const decoratedStepSymbol = Symbol('decoratedStep');
-// global list of all decorator steps
-const decoratedSteps = new Set();
-/**
- * Creates @Given, @When, @Then decorators.
- */
-function createStepDecorator(keyword) {
-  return pattern => {
-    // context parameter is required for decorator by TS even though it's not used
-    // eslint-disable-next-line no-unused-vars
-    return (method, _context) => {
-      saveStepConfigToMethod(method, {
-        keyword,
-        pattern,
-        fn: method,
-        hasCustomTest: true
-      });
-    };
-  };
-}
-function linkStepsWithPomNode(Ctor, pomNode) {
-  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return;
-  const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
-  return Object.values(propertyDescriptors).forEach(descriptor => {
-    const stepConfig = getStepConfigFromMethod(descriptor);
-    if (!stepConfig) return;
-    stepConfig.pomNode = pomNode;
-    decoratedSteps.add(stepConfig);
-  });
-}
-/**
- * Append decorator steps to Cucumber's supportCodeLibrary.
- */
-function appendDecoratorSteps(supportCodeLibrary) {
-  decoratedSteps.forEach(stepConfig => {
-    const {
-      keyword,
-      pattern,
-      fn
-    } = stepConfig;
-    stepConfig.fn = (fixturesArg, ...args) => {
-      const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
-      return fn.call(fixture, ...args);
-    };
-    const code = (0, _defineStep.buildCucumberStepCode)(stepConfig);
-    const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
-      keyword,
-      pattern,
-      code,
-      line: 0,
-      options: {},
-      uri: '' // not used in playwright-bdd
-    }, supportCodeLibrary);
-    supportCodeLibrary.stepDefinitions.push(stepDefinition);
-  });
-  decoratedSteps.clear();
-  // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
-}
-
-function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
-  // there should be exatcly one suitable fixture in fixturesArg
-  const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
-  if (fixtureNames.length === 0) {
-    throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  if (fixtureNames.length > 1) {
-    throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  return fixturesArg[fixtureNames[0]];
-}
-function saveStepConfigToMethod(method, stepConfig) {
-  method[decoratedStepSymbol] = stepConfig;
-}
-function getStepConfigFromMethod(descriptor) {
-  // filter out getters / setters
-  return typeof descriptor.value === 'function' ? descriptor.value[decoratedStepSymbol] : undefined;
-}

package/build/bdd-framework/stepDefinitions/defineStep.js

@@ -1,61 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildCucumberStepCode = buildCucumberStepCode;
-exports.defineStep = defineStep;
-exports.getStepCode = getStepCode;
-var _cucumber = require("@cucumber/cucumber");
-var _exit = require("../utils/exit");
-/**
- * Defines step by config.
- * Calls cucumber's Given(), When(), Then() under the hood.
- */
-function defineStep(stepConfig) {
-  const {
-    keyword,
-    pattern
-  } = stepConfig;
-  const cucumberDefineStepFn = getCucumberDefineStepFn(keyword);
-  const code = buildCucumberStepCode(stepConfig);
-  try {
-    cucumberDefineStepFn(pattern, code);
-  } catch (e) {
-    // todo: detect that this is import from test file
-    // and skip/delay registering cucumber steps until cucumber is loaded
-    const isMissingCucumber = /Cucumber that isn't running/i.test(e.message);
-    if (isMissingCucumber) {
-      (0, _exit.exit)(`Option "importTestFrom" should point to a separate file without step definitions`, `(e.g. without calls of Given, When, Then)`);
-    } else {
-      throw e;
-    }
-  }
-}
-function buildCucumberStepCode(stepConfig) {
-  const code = function (...args) {
-    const fixturesArg = Object.assign({}, this.customFixtures, {
-      $testInfo: this.testInfo,
-      $test: this.test,
-      $tags: this.tags
-    });
-    return stepConfig.fn.call(this, fixturesArg, ...args);
-  };
-  code.stepConfig = stepConfig;
-  return code;
-}
-function getStepCode(stepDefinition) {
-  return stepDefinition.code;
-}
-function getCucumberDefineStepFn(keyword) {
-  switch (keyword) {
-    case 'Given':
-      return _cucumber.Given;
-    case 'When':
-      return _cucumber.When;
-    case 'Then':
-      return _cucumber.Then;
-    default:
-      return _cucumber.defineStep;
-  }
-}

package/build/bdd-framework/stepDefinitions/stepConfig.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getStepConfig = getStepConfig;
-exports.isDecorator = isDecorator;
-exports.isPlaywrightStyle = isPlaywrightStyle;
-/**
- * Playwright-bdd's step config.
- */
-function getStepConfig(step) {
-  return step.code.stepConfig;
-}
-function isDecorator(stepConfig) {
-  return Boolean(stepConfig === null || stepConfig === void 0 ? void 0 : stepConfig.pomNode);
-}
-/**
- * Cucumber-style steps don't have stepConfig
- * b/c they created directly via cucumber's Given, When, Then.
- */
-function isPlaywrightStyle(stepConfig) {
-  return Boolean(stepConfig);
-}

package/build/bdd-framework/utils/exit.js

@@ -1,54 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.exit = exit;
-exports.withExitHandler = withExitHandler;
-var _logger = require("./logger");
-var _worker_threads = require("worker_threads");
-/**
- * Exit utils.
- *
- * When calling process.exit() in worker thread used for file generation,
- * logs are not flushed (https://github.com/vitalets/playwright-bdd/issues/59).
- * That's why instead of process.exit we throw ExitError
- * that just sets process.exitCode = 1 and allow program to exit normally.
- *
- * On the other hand, when running in main thread, especially inside Playwright,
- * thrown error is captured by Playwright and show with additional messages (e.g. no tests found).
- * That's why in main thread we to call process.exit() to show only needed error.
- *
- * Relevant discussions:
- * - https://github.com/nodejs/node/issues/6379
- * - https://github.com/nodejs/node-v0.x-archive/issues/3737
- * - https://github.com/cucumber/cucumber-js/pull/123
- */
-
-class ExitError extends Error {
-  get stack() {
-    return '';
-  }
-}
-async function withExitHandler(fn) {
-  try {
-    return await fn();
-  } catch (e) {
-    if (e instanceof ExitError) {
-      process.exitCode = 1;
-    } else {
-      throw e;
-    }
-  }
-}
-function exit(...messages) {
-  messages = messages.filter(Boolean);
-  if (_worker_threads.isMainThread) {
-    if (messages.length) {
-      _logger.logger.error('Error:', ...messages);
-    }
-    process.exit(1);
-  } else {
-    throw new ExitError(messages.join(' '));
-  }
-}

package/build/bdd-framework/utils/index.js

@@ -1,44 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPackageVersion = getPackageVersion;
-exports.getSymbolByName = getSymbolByName;
-exports.removeDuplicates = removeDuplicates;
-exports.resolvePackageRoot = resolvePackageRoot;
-exports.template = template;
-var _fs = _interopRequireDefault(require("fs"));
-var _path = _interopRequireDefault(require("path"));
-// See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
-function getSymbolByName(target, name) {
-  const ownKeys = Reflect.ownKeys(target);
-  const symbol = ownKeys.find(key => key.toString() === `Symbol(${name})`);
-  if (!symbol) {
-    throw new Error(`Symbol "${name}" not found in target. ownKeys: ${ownKeys}`);
-  }
-  return symbol;
-}
-/**
- * Inserts params into template.
- * Params defined as <param>.
- */
-function template(t, params = {}) {
-  return t.replace(/<(.+?)>/g, (match, key) => {
-    return params[key] !== undefined ? String(params[key]) : match;
-  });
-}
-function removeDuplicates(arr) {
-  return [...new Set(arr)];
-}
-function resolvePackageRoot(packageName) {
-  const packageJsonPath = require.resolve(`${packageName}/package.json`);
-  return _path.default.dirname(packageJsonPath);
-}
-function getPackageVersion(packageName) {
-  const packageRoot = resolvePackageRoot(packageName);
-  const packageJsonPath = _path.default.join(packageRoot, 'package.json');
-  const packageJson = JSON.parse(_fs.default.readFileSync(packageJsonPath, 'utf8'));
-  return packageJson.version || '';
-}

package/build/bdd-framework/utils/jsStringWrap.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.jsStringWrap = jsStringWrap;
-/**
- * Adopted version of https://github.com/joliss/js-string-escape
- * - added support of backticks
- * - added 'quotes' option to indicate which quotes to escape
- * - wrap result string with provided quotes
- *
- * Considered alternative is https://github.com/mathiasbynens/jsesc,
- * but it provides additional functionality and much slower
- * See: https://github.com/mathiasbynens/jsesc/issues/16
- */
-function jsStringWrap(str, {
-  quotes = 'single'
-} = {}) {
-  const wrapQuote = quotes === 'single' ? "'" : quotes === 'double' ? '"' : '`';
-  // eslint-disable-next-line complexity
-  const escapedStr = ('' + str).replace(/["'`\\\n\r\u2028\u2029]/g, character => {
-    // Escape all characters not included in SingleStringCharacters and
-    // DoubleStringCharacters on
-    // http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4
-    switch (character) {
-      case wrapQuote:
-      case '\\':
-        return '\\' + character;
-      // Four possible LineTerminator characters need to be escaped:
-      case '\n':
-        return '\\n';
-      case '\r':
-        return '\\r';
-      case '\u2028':
-        return '\\u2028';
-      case '\u2029':
-        return '\\u2029';
-      default:
-        return character;
-    }
-  });
-  return `${wrapQuote}${escapedStr}${wrapQuote}`;
-}

package/build/bdd-framework/utils/logger.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.logger = exports.Logger = void 0;
-/**
- * Simple logger
- */
-class Logger {
-  options;
-  constructor(options = {}) {
-    this.options = options;
-  }
-  log(...args) {
-    if (this.options.verbose) console.log(...args);
-  }
-  warn(...args) {
-    // using log() to output warnings to stdout, not stderr
-    console.log(...args);
-  }
-  error(...args) {
-    console.error(...args);
-  }
-}
-// default logger
-exports.Logger = Logger;
-const logger = new Logger();
-exports.logger = logger;