@zohodesk/testinglibrary 0.1.9 → 0.1.16-experimental

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

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TestMetaBuilder = void 0;
-exports.getTestMeta = getTestMeta;
-var _utils = require("../utils");
-/**
- * Class to build and print testMeta object containing meta info about each test.
- * Tests are identified by special key constructed from title path.
- *
- * Example:
- * const testMeta = {
- *  "Simple scenario": { pickleLocation: "3:10", tags: ["@foo"] },
- *  "Scenario with examples|Example #1": { pickleLocation: "8:26", tags: [] },
- *  "Rule 1|Scenario with examples|Example #1": { pickleLocation: "9:42", tags: [] },
- * };
- */
-
-const TEST_KEY_SEPARATOR = '|';
-class TestMetaBuilder {
-  tests = [];
-  get testCount() {
-    return this.tests.length;
-  }
-  registerTest(node, pickle) {
-    const testMeta = {
-      pickleLocation: (0, _utils.stringifyLocation)(pickle.location),
-      tags: node.tags.length ? node.tags : undefined
-    };
-    this.tests.push({
-      node,
-      testMeta
-    });
-  }
-  getObjectLines() {
-    // build object line by line to have each test on a separate line,
-    // but value should be in one line.
-    return this.tests.map(test => {
-      const testKey = this.getTestKey(test.node);
-      return `${JSON.stringify(testKey)}: ${JSON.stringify(test.testMeta)},`;
-    });
-  }
-  getTestKey(node) {
-    // .slice(1) -> b/c we remove top describe title (it's same for all tests)
-    return node.titlePath.slice(1).join(TEST_KEY_SEPARATOR);
-  }
-}
-exports.TestMetaBuilder = TestMetaBuilder;
-function getTestMeta(testMetaMap, testInfo) {
-  // .slice(2) -> b/c we remove filename and top describe title
-  const key = testInfo.titlePath.slice(2).join(TEST_KEY_SEPARATOR);
-  const testMeta = testMetaMap[key];
-  if (!testMeta) {
-    // throw new Error(`Can't find testMeta for key "${key}"`);
-    return {};
-  }
-  return testMeta;
-}

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

@@ -1,60 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TestNode = void 0;
-var _utils = require("../utils");
-/**
- * Universal TestNode class representing test or suite in a test file.
- * Holds parent-child links.
- * Allows to inherit tags and titles path.
- */
-
-const SPECIAL_TAGS = ['@only', '@skip', '@fixme'];
-class TestNode {
-  title;
-  titlePath;
-  ownTags;
-  tags;
-  flags = {};
-  constructor(gherkinNode, parent) {
-    this.title = gherkinNode.name;
-    this.titlePath = ((parent === null || parent === void 0 ? void 0 : parent.titlePath) || []).concat([this.title]);
-    this.ownTags = (0, _utils.removeDuplicates)(getTagNames(gherkinNode.tags));
-    this.tags = (0, _utils.removeDuplicates)(((parent === null || parent === void 0 ? void 0 : parent.tags) || []).concat(this.ownTags));
-    this.initFlags();
-  }
-  isSkipped() {
-    return this.flags.skip || this.flags.fixme;
-  }
-  initFlags() {
-    this.ownTags.forEach(tag => {
-      if (isSpecialTag(tag)) {
-        this.setFlag(tag);
-      }
-    });
-  }
-  // eslint-disable-next-line complexity
-  setFlag(tag) {
-    // in case of several special tags, @only takes precendence
-    if (tag === '@only') {
-      this.flags = {
-        only: true
-      };
-    }
-    if (tag === '@skip' && !this.flags.only) {
-      this.flags.skip = true;
-    }
-    if (tag === '@fixme' && !this.flags.only) {
-      this.flags.fixme = true;
-    }
-  }
-}
-exports.TestNode = TestNode;
-function getTagNames(tags) {
-  return tags.map(tag => tag.name);
-}
-function isSpecialTag(tag) {
-  return SPECIAL_TAGS.includes(tag);
-}

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

@@ -1,133 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TestPoms = void 0;
-exports.buildFixtureTag = buildFixtureTag;
-var _class = require("../stepDefinitions/decorators/class");
-var _exit = require("../utils/exit");
-/**
- * Track PomNodes used in the particular test.
- * To select correct fixture for decorator steps.
- *
- * Idea: try to use the deepest child fixture for parent steps.
- *
- * Example inheritance tree:
- *      A
- *     / \
- *    B   C
- *   / \   \
- *  D   E   F
- *
- * If test uses steps from classes A and D:
- * -> resolved fixture will be D, even for steps from A.
- *
- * If test uses steps from classes A, D and C:
- * -> error, b/c A has 2 possible fixtures.
- *
- * If test uses steps from classes A and C, but @fixture tag is D:
- * -> error, b/c A has 2 possible fixtures.
- */
-
-const FIXTURE_TAG_PREFIX = '@fixture:';
-class TestPoms {
-  title;
-  // map of poms used in test
-  usedPoms = new Map();
-  constructor(title) {
-    this.title = title;
-  }
-  addByStep(pomNode) {
-    this.addUsedPom(pomNode, {
-      byTag: false
-    });
-  }
-  addByFixtureName(fixtureName) {
-    const pomNode = (0, _class.getPomNodeByFixtureName)(fixtureName);
-    this.addUsedPom(pomNode, {
-      byTag: false
-    });
-  }
-  addByTag(tag) {
-    const fixtureName = extractFixtureName(tag);
-    if (fixtureName) {
-      const pomNode = (0, _class.getPomNodeByFixtureName)(fixtureName);
-      this.addUsedPom(pomNode, {
-        byTag: true
-      });
-    }
-  }
-  /**
-     * Resolve all used pomNodes to fixtures.
-     * This is needed to handle @fixture: tagged pomNodes
-     * that does not have steps in the test, but should be considered.
-     */
-  resolveFixtures() {
-    this.usedPoms.forEach((_, pomNode) => {
-      this.getResolvedFixtures(pomNode);
-    });
-  }
-  /**
-     * Returns fixtures suitable for particular pomNode (actually for step)
-     */
-  getResolvedFixtures(pomNode) {
-    const usedPom = this.usedPoms.get(pomNode);
-    if (usedPom !== null && usedPom !== void 0 && usedPom.fixtures) {
-      return usedPom.fixtures;
-    }
-    // Recursively resolve children fixtures, used in test.
-    let childFixtures = [...pomNode.children].map(child => this.getResolvedFixtures(child)).flat();
-    if (!usedPom) {
-      return childFixtures;
-    }
-    if (childFixtures.length) {
-      this.verifyChildFixtures(pomNode, usedPom, childFixtures);
-      usedPom.fixtures = childFixtures;
-    } else {
-      usedPom.fixtures = [{
-        name: pomNode.fixtureName,
-        byTag: usedPom.byTag
-      }];
-    }
-    return usedPom.fixtures;
-  }
-  addUsedPom(pomNode, {
-    byTag
-  }) {
-    if (!pomNode) {
-      return;
-    }
-    const usedPom = this.usedPoms.get(pomNode);
-    if (usedPom) {
-      if (byTag && !usedPom.byTag) {
-        usedPom.byTag = true;
-      }
-    } else {
-      this.usedPoms.set(pomNode, {
-        byTag
-      });
-    }
-  }
-  /**
-     * For scenarios with @fixture:xxx tags verify that there are no steps from fixtures,
-     * deeper than xxx.
-     * @fixture:xxx tag provides maximum fixture that can be used in the scenario.
-     */
-  verifyChildFixtures(pomNode, usedPom, childFixtures) {
-    if (!usedPom.byTag) {
-      return;
-    }
-    const childFixturesBySteps = childFixtures.filter(f => !f.byTag);
-    if (childFixturesBySteps.length) {
-      (0, _exit.exit)(`Scenario "${this.title}" contains ${childFixturesBySteps.length} step(s)`, `not compatible with required fixture "${pomNode.fixtureName}"`);
-    }
-  }
-}
-exports.TestPoms = TestPoms;
-function extractFixtureName(tag) {
-  return tag.startsWith(FIXTURE_TAG_PREFIX) ? tag.replace(FIXTURE_TAG_PREFIX, '') : '';
-}
-function buildFixtureTag(fixtureName) {
-  return `${FIXTURE_TAG_PREFIX}${fixtureName}`;
-}

package/build/bdd-framework/hooks/scenario.js

@@ -1,130 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getScenarioHooksFixtures = getScenarioHooksFixtures;
-exports.hasScenarioHooks = hasScenarioHooks;
-exports.runScenarioHooks = runScenarioHooks;
-exports.scenarioHookFactory = scenarioHookFactory;
-var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _utils = require("../utils");
-var _getLocationInFile = require("../playwright/getLocationInFile");
-var _testTypeImpl = require("../playwright/testTypeImpl");
-/**
- * Scenario level hooks: Before / After.
- *
- * before(async ({ page }) => {})
- */
-
-const scenarioHooks = [];
-let scenarioHooksFixtures;
-/**
- * Returns Before() / After() functions.
- */
-function scenarioHookFactory(type) {
-  return (...args) => {
-    addHook({
-      type,
-      options: getOptionsFromArgs(args),
-      fn: getFnFromArgs(args),
-      // offset = 3 b/c this call is 3 steps below the user's code
-      location: (0, _getLocationInFile.getLocationByOffset)(3)
-    });
-  };
-}
-function hasScenarioHooks() {
-  return scenarioHooks.length > 0;
-}
-// eslint-disable-next-line complexity, max-statements
-async function runScenarioHooks(type, fixtures) {
-  let error;
-  for (const hook of scenarioHooks) {
-    if (hook.type !== type) {
-      continue;
-    }
-    if (hook.tagsExpression && !hook.tagsExpression.evaluate(fixtures.$tags)) {
-      continue;
-    }
-    try {
-      const hookFn = wrapHookFn(hook, fixtures);
-      await (0, _testTypeImpl.runStepWithCustomLocation)(fixtures.$bddWorld.test, hook.options.name || '', hook.location, hookFn);
-    } catch (e) {
-      if (type === 'before') {
-        throw e;
-      }
-      if (!error) {
-        error = e;
-      }
-    }
-  }
-  if (error) {
-    throw error;
-  }
-}
-function getScenarioHooksFixtures() {
-  if (!scenarioHooksFixtures) {
-    const fixturesFakeObj = {
-      $bddWorld: null,
-      $tags: null,
-      $testInfo: null
-    };
-    const set = new Set();
-    scenarioHooks.forEach(hook => {
-      (0, _fixtureParameterNames.fixtureParameterNames)(hook.fn).filter(fixtureName => !Object.prototype.hasOwnProperty.call(fixturesFakeObj, fixtureName)).forEach(fixtureName => set.add(fixtureName));
-    });
-    scenarioHooksFixtures = [...set];
-  }
-  return scenarioHooksFixtures;
-}
-/**
- * Wraps hook fn with timeout and waiting Cucumber attachments to fulfill.
- */
-function wrapHookFn(hook, fixtures) {
-  const {
-    timeout
-  } = hook.options;
-  const {
-    $bddWorld
-  } = fixtures;
-  return async () => {
-    await (0, _utils.callWithTimeout)(() => hook.fn.call($bddWorld, fixtures), timeout, getTimeoutMessage(hook));
-  };
-}
-function getOptionsFromArgs(args) {
-  if (typeof args[0] === 'string') {
-    return {
-      tags: args[0]
-    };
-  }
-  if (typeof args[0] === 'object') {
-    return args[0];
-  }
-  return {};
-}
-function getFnFromArgs(args) {
-  return args.length === 1 ? args[0] : args[1];
-}
-function setTagsExpression(hook) {
-  if (hook.options.tags) {
-    hook.tagsExpression = (0, _tagExpressions.default)(hook.options.tags);
-  }
-}
-function addHook(hook) {
-  setTagsExpression(hook);
-  if (hook.type === 'before') {
-    scenarioHooks.push(hook);
-  } else {
-    // 'after' hooks run in reverse order
-    scenarioHooks.unshift(hook);
-  }
-}
-function getTimeoutMessage(hook) {
-  const {
-    timeout,
-    name: hookName
-  } = hook.options;
-  return `${hook.type} hook ${hookName ? `"${hookName}" ` : ''}timeout (${timeout} ms)`;
-}

package/build/bdd-framework/hooks/worker.js

@@ -1,89 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getWorkerHooksFixtures = getWorkerHooksFixtures;
-exports.runWorkerHooks = runWorkerHooks;
-exports.workerHookFactory = workerHookFactory;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _utils = require("../utils");
-/**
- * Worker-level hooks: BeforeAll / AfterAll.
- */
-
-const workerHooks = [];
-let workerHooksFixtures;
-/**
- * Returns BeforeAll() / AfterAll() functions.
- */
-function workerHookFactory(type) {
-  return (...args) => {
-    addHook({
-      type,
-      options: getOptionsFromArgs(args),
-      fn: getFnFromArgs(args)
-    });
-  };
-}
-// eslint-disable-next-line complexity
-async function runWorkerHooks(type, fixtures) {
-  let error;
-  for (const hook of workerHooks) {
-    if (hook.type !== type) {
-      continue;
-    }
-    const {
-      timeout
-    } = hook.options;
-    try {
-      await (0, _utils.callWithTimeout)(() => hook.fn(fixtures), timeout, getTimeoutMessage(hook));
-    } catch (e) {
-      if (type === 'beforeAll') {
-        throw e;
-      }
-      if (!error) {
-        error = e;
-      }
-    }
-  }
-  if (error) {
-    throw error;
-  }
-}
-function getWorkerHooksFixtures() {
-  if (!workerHooksFixtures) {
-    const fixturesFakeObj = {
-      $workerInfo: null
-    };
-    const set = new Set();
-    workerHooks.forEach(hook => {
-      (0, _fixtureParameterNames.fixtureParameterNames)(hook.fn).filter(fixtureName => !Object.prototype.hasOwnProperty.call(fixturesFakeObj, fixtureName)).forEach(fixtureName => set.add(fixtureName));
-    });
-    workerHooksFixtures = [...set];
-  }
-  return workerHooksFixtures;
-}
-function getOptionsFromArgs(args) {
-  if (typeof args[0] === 'object') {
-    return args[0];
-  }
-  return {};
-}
-function getFnFromArgs(args) {
-  return args.length === 1 ? args[0] : args[1];
-}
-function addHook(hook) {
-  if (hook.type === 'beforeAll') {
-    workerHooks.push(hook);
-  } else {
-    // 'afterAll' hooks run in reverse order
-    workerHooks.unshift(hook);
-  }
-}
-function getTimeoutMessage(hook) {
-  const {
-    timeout
-  } = hook.options;
-  return `${hook.type} hook timeout (${timeout} ms)`;
-}

package/build/bdd-framework/index.js

@@ -1,52 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "BDDInputConfig", {
-  enumerable: true,
-  get: function () {
-    return _config.BDDInputConfig;
-  }
-});
-Object.defineProperty(exports, "BddWorld", {
-  enumerable: true,
-  get: function () {
-    return _bddWorld.BddWorld;
-  }
-});
-Object.defineProperty(exports, "BddWorldOptions", {
-  enumerable: true,
-  get: function () {
-    return _bddWorld.BddWorldOptions;
-  }
-});
-Object.defineProperty(exports, "createBdd", {
-  enumerable: true,
-  get: function () {
-    return _createBdd.createBdd;
-  }
-});
-Object.defineProperty(exports, "cucumberReporter", {
-  enumerable: true,
-  get: function () {
-    return _helper.cucumberReporter;
-  }
-});
-Object.defineProperty(exports, "defineBddConfig", {
-  enumerable: true,
-  get: function () {
-    return _config.defineBddConfig;
-  }
-});
-Object.defineProperty(exports, "test", {
-  enumerable: true,
-  get: function () {
-    return _bddFixtures.test;
-  }
-});
-var _config = require("./config");
-var _createBdd = require("./stepDefinitions/createBdd");
-var _bddFixtures = require("./run/bddFixtures");
-var _bddWorld = require("./run/bddWorld");
-var _helper = require("./reporter/cucumber/helper");

package/build/bdd-framework/playwright/fixtureParameterNames.js

@@ -1,93 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.fixtureParameterNames = fixtureParameterNames;
-/**
- * Extracted from playwright.
- * https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/fixtures.ts#L226
- */
-/* eslint-disable max-statements, complexity, max-len, max-depth */
-const signatureSymbol = Symbol('signature');
-function fixtureParameterNames(fn) {
-  if (typeof fn !== 'function') {
-    return [];
-  }
-  if (!fn[signatureSymbol]) {
-    fn[signatureSymbol] = innerFixtureParameterNames(fn);
-  }
-  return fn[signatureSymbol];
-}
-function innerFixtureParameterNames(fn) {
-  const text = filterOutComments(fn.toString());
-  const match = text.match(/(?:async)?(?:\s+function)?[^(]*\(([^)]*)/);
-  if (!match) {
-    return [];
-  }
-  const trimmedParams = match[1].trim();
-  if (!trimmedParams) {
-    return [];
-  }
-  const [firstParam] = splitByComma(trimmedParams);
-  if (firstParam[0] !== '{' || firstParam[firstParam.length - 1] !== '}') {
-    throw new Error('First argument must use the object destructuring pattern: ' + firstParam + ' ' + fn.toString());
-  }
-  const props = splitByComma(firstParam.substring(1, firstParam.length - 1)).map(prop => {
-    const colon = prop.indexOf(':');
-    return colon === -1 ? prop.trim() : prop.substring(0, colon).trim();
-  });
-  const restProperty = props.find(prop => prop.startsWith('...'));
-  if (restProperty) {
-    throw new Error(`Rest property "${restProperty}" is not supported. List all used fixtures explicitly, separated by comma. ${fn.toString()}`);
-  }
-  return props;
-}
-function filterOutComments(s) {
-  const result = [];
-  let commentState = 'none';
-  for (let i = 0; i < s.length; ++i) {
-    if (commentState === 'singleline') {
-      if (s[i] === '\n') {
-        commentState = 'none';
-      }
-    } else if (commentState === 'multiline') {
-      if (s[i - 1] === '*' && s[i] === '/') {
-        commentState = 'none';
-      }
-    } else if (commentState === 'none') {
-      if (s[i] === '/' && s[i + 1] === '/') {
-        commentState = 'singleline';
-      } else if (s[i] === '/' && s[i + 1] === '*') {
-        commentState = 'multiline';
-        i += 2;
-      } else {
-        result.push(s[i]);
-      }
-    }
-  }
-  return result.join('');
-}
-function splitByComma(s) {
-  const result = [];
-  const stack = [];
-  let start = 0;
-  for (let i = 0; i < s.length; i++) {
-    if (s[i] === '{' || s[i] === '[') {
-      stack.push(s[i] === '{' ? '}' : ']');
-    } else if (s[i] === stack[stack.length - 1]) {
-      stack.pop();
-    } else if (!stack.length && s[i] === ',') {
-      const token = s.substring(start, i).trim();
-      if (token) {
-        result.push(token);
-      }
-      start = i + 1;
-    }
-  }
-  const lastToken = s.substring(start).trim();
-  if (lastToken) {
-    result.push(lastToken);
-  }
-  return result;
-}

package/build/bdd-framework/playwright/getLocationInFile.js

@@ -1,79 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getLocationByOffset = getLocationByOffset;
-exports.getLocationInFile = getLocationInFile;
-var _url = _interopRequireDefault(require("url"));
-var _utils = require("./utils");
-/**
- * Finds first frame in the callstack that matches provided file.
- * Constructs location object from that frame.
- *
- * Example:
- * Calling getLocationInFile('file-3.js');
- * Call stack:
- * - at <anonymous> (file-1.js:1:2)
- * - at myFunction2 (file-2.js:3:4)
- * - at myFunction3 (file-3.js:5:6)
- * - at myFunction4 (file-4.js:7:8)
- *
- * Returned value: { file: 'file-3.js', line: 5, column: 6 }
- */
-function getLocationInFile(filePath) {
-  const filePathUrl = _url.default.pathToFileURL(filePath).toString();
-  return getLocationBy(stackFrames => {
-    return stackFrames.find(frame => {
-      const frameFile = frame.getFileName();
-      return frameFile === filePath || frameFile === filePathUrl;
-    });
-  });
-}
-function getLocationByOffset(offset) {
-  return getLocationBy(stackFrames => stackFrames[offset]);
-}
-/**
- * Iterates stacktrace of the call of this function
- * and finds frame using provided findFrame predicate.
- * Constructs location object from the found frame.
- *
- * This function is based on Playwright's wrapFunctionWithLocation().
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/transform/transform.ts#L261
- */
-function getLocationBy(findFrame) {
-  const {
-    sourceMapSupport
-  } = (0, _utils.requirePlaywrightModule)('lib/utilsBundle.js');
-  const oldPrepareStackTrace = Error.prepareStackTrace;
-  // modify prepareStackTrace to return Location object instead of string
-  Error.prepareStackTrace = (error, stackFrames) => {
-    const foundFrame = findFrame(stackFrames);
-    if (!foundFrame) {
-      return {
-        file: '',
-        line: 0,
-        column: 0
-      };
-    }
-    const frame = sourceMapSupport.wrapCallSite(foundFrame);
-    const fileName = frame.getFileName();
-    // Node error stacks for modules use file:// urls instead of paths.
-    const file = fileName !== null && fileName !== void 0 && fileName.startsWith('file://') ? _url.default.fileURLToPath(fileName) : fileName;
-    return {
-      file,
-      line: frame.getLineNumber(),
-      column: frame.getColumnNumber()
-    };
-  };
-  // commented stackTraceLImit modification, todo: check if it has perf impact
-  // const oldStackTraceLimit = Error.stackTraceLimit;
-  // Error.stackTraceLimit = level + 1;
-  const obj = {};
-  Error.captureStackTrace(obj);
-  const location = obj.stack;
-  // Error.stackTraceLimit = oldStackTraceLimit;
-  Error.prepareStackTrace = oldPrepareStackTrace;
-  return location;
-}