@zohodesk/testinglibrary 2.9.1 → 3.0.2

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

@@ -1,66 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createBdd = createBdd;
-exports.hasCustomTest = void 0;
-var _bddFixtures = require("../run/bddFixtures");
-var _testTypeImpl = require("../playwright/testTypeImpl");
-var _defineStep = require("./defineStep");
-var _exit = require("../utils/exit");
-var _scenario = require("../hooks/scenario");
-var _worker = require("../hooks/worker");
-/**
- * Stuff related to writing steps in Playwright-style.
- */
-
-// Global flag showing that custom test was passed.
-// Used when checking 'importTestFrom' config option.
-// todo: https://github.com/vitalets/playwright-bdd/issues/46
-let hasCustomTest = exports.hasCustomTest = false;
-function createBdd(customTest) {
-  if (!hasCustomTest) {
-    exports.hasCustomTest = hasCustomTest = isCustomTest(customTest);
-  }
-  const Given = defineStepCtor('Given', hasCustomTest);
-  const When = defineStepCtor('When', hasCustomTest);
-  const Then = defineStepCtor('Then', hasCustomTest);
-  const Step = defineStepCtor('Unknown', hasCustomTest);
-  const Before = (0, _scenario.scenarioHookFactory)('before');
-  const After = (0, _scenario.scenarioHookFactory)('after');
-  const BeforeAll = (0, _worker.workerHookFactory)('beforeAll');
-  const AfterAll = (0, _worker.workerHookFactory)('afterAll');
-  return {
-    Given,
-    When,
-    Then,
-    Step,
-    Before,
-    After,
-    BeforeAll,
-    AfterAll
-  };
-}
-function defineStepCtor(keyword, hasCustomTest) {
-  return (pattern, fn) => {
-    (0, _defineStep.defineStep)({
-      keyword,
-      pattern,
-      fn,
-      hasCustomTest
-    });
-  };
-}
-function isCustomTest(customTest) {
-  if (!customTest || customTest === _bddFixtures.test) {
-    return false;
-  }
-  assertTestHasBddFixtures(customTest);
-  return true;
-}
-function assertTestHasBddFixtures(customTest) {
-  if (!(0, _testTypeImpl.isTestContainsSubtest)(customTest, _bddFixtures.test)) {
-    (0, _exit.exit)(`createBdd() should use 'test' extended from "playwright-bdd"`);
-  }
-}

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

@@ -1,68 +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");
-/**
- * Class level @Fixture decorator.
- */
-
-/**
- * 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,99 +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,
-      // 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 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,62 +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) {
-    // build the first argument (fixtures) for step fn
-    const fixturesArg = Object.assign({}, this.$internal.currentStepFixtures, {
-      $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/steps/createBdd.js

@@ -1,78 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createBdd = createBdd;
-exports.hasCustomTest = void 0;
-var _bddFixtures = require("../run/bddFixtures");
-var _testTypeImpl = require("../playwright/testTypeImpl");
-var _defineStep = require("./defineStep");
-var _exit = require("../utils/exit");
-var _scenario = require("../hooks/scenario");
-var _worker = require("../hooks/worker");
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-/**
- * Stuff related to writing steps in Playwright-style.
- */
-
-// Global flag showing that custom test was passed.
-// Used when checking 'importTestFrom' config option.
-// todo: https://github.com/vitalets/playwright-bdd/issues/46
-let hasCustomTest = exports.hasCustomTest = false;
-function createBdd(customTest, _CustomWorld) {
-  if (!hasCustomTest) {
-    exports.hasCustomTest = hasCustomTest = isCustomTest(customTest);
-  }
-  const Given = defineStepCtor('Given', hasCustomTest);
-  const When = defineStepCtor('When', hasCustomTest);
-  const Then = defineStepCtor('Then', hasCustomTest);
-  const Step = defineStepCtor('Unknown', hasCustomTest);
-  const Before = (0, _scenario.scenarioHookFactory)('before');
-  const After = (0, _scenario.scenarioHookFactory)('after');
-  const BeforeAll = (0, _worker.workerHookFactory)('beforeAll');
-  const AfterAll = (0, _worker.workerHookFactory)('afterAll');
-  return {
-    Given,
-    When,
-    Then,
-    Step,
-    Before,
-    After,
-    BeforeAll,
-    AfterAll
-  };
-}
-function defineStepCtor(keyword, hasCustomTest) {
-  return (pattern, fn) => {
-    (0, _defineStep.defineStep)({
-      keyword,
-      pattern,
-      fn,
-      hasCustomTest
-    });
-    return (fixtures, ...args) => {
-      assertStepIsCalledWithRequiredFixtures(pattern, fn, fixtures);
-      return fn(fixtures, ...args);
-    };
-  };
-}
-function isCustomTest(customTest) {
-  if (!customTest || customTest === _bddFixtures.test) {
-    return false;
-  }
-  assertTestHasBddFixtures(customTest);
-  return true;
-}
-function assertTestHasBddFixtures(customTest) {
-  if (!(0, _testTypeImpl.isTestContainsSubtest)(customTest, _bddFixtures.test)) {
-    (0, _exit.exit)(`createBdd() should use 'test' extended from "playwright-bdd"`);
-  }
-}
-function assertStepIsCalledWithRequiredFixtures(pattern, fn, fixtures) {
-  const fixtureNames = (0, _fixtureParameterNames.fixtureParameterNames)(fn);
-  const missingFixtures = fixtureNames.filter(fixtureName => !Object.prototype.hasOwnProperty.call(fixtures, fixtureName));
-  if (missingFixtures.length) {
-    throw new Error([`Invocation of step "${pattern}" from another step does not pass all required fixtures.`, `Missings fixtures: ${missingFixtures.join(', ')}`].join(' '));
-  }
-}

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

@@ -1,68 +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");
-/**
- * Class level @Fixture decorator.
- */
-
-/**
- * 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, _context) => {
-    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/steps/decorators/steps.js

@@ -1,98 +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
-    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,
-      // 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 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/steps/defineStep.js

@@ -1,62 +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) {
-    // build the first argument (fixtures) for step fn
-    const fixturesArg = Object.assign({}, this.$internal.currentStepFixtures, {
-      $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/steps/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/AutofillMap.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AutofillMap = void 0;
-/**
- * Extended Map that automatically creates item if it does not exist.
- */
-class AutofillMap extends Map {
-  getOrCreate(key, createFn) {
-    let item = this.get(key);
-    if (!item) {
-      item = createFn(key);
-      this.set(key, item);
-    }
-    return item;
-  }
-}
-exports.AutofillMap = AutofillMap;