@zohodesk/testinglibrary 0.1.8-stb-bdd-v26 → 0.1.9

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

@@ -0,0 +1,99 @@
+"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

@@ -0,0 +1,62 @@
+"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

@@ -0,0 +1,24 @@
+"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

@@ -0,0 +1,20 @@
+"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;

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

@@ -0,0 +1,62 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.exit = exit;
+exports.withExitHandler = withExitHandler;
+var _worker_threads = require("worker_threads");
+/**
+ * Exit utils.
+ *
+ * When calling process.exit() in worker thread used for test-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.
+ * This esnured by wrapping code with withExitHandler().
+ *
+ * On the other hand, when running in the 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) {
+      if (e.message) {
+        // eslint-disable-next-line no-console
+        console.error(e.message);
+      }
+      process.exitCode = 1;
+    } else {
+      throw e;
+    }
+  }
+}
+function exit(...messages) {
+  messages = messages.filter(Boolean);
+  if (_worker_threads.isMainThread) {
+    // use console.error() here instead of logger.error() to have less stack
+    // for flushing messages to stderr.
+
+    if (messages.length) {
+      // eslint-disable-next-line no-console, max-depth
+      console.error('Error:', ...messages);
+    }
+    process.exit(1);
+  } else {
+    throw new ExitError(messages.join(' '));
+  }
+}

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

@@ -0,0 +1,93 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.callWithTimeout = callWithTimeout;
+exports.extractTemplateParams = extractTemplateParams;
+exports.getPackageVersion = getPackageVersion;
+exports.getSymbolByName = getSymbolByName;
+exports.omit = omit;
+exports.removeDuplicates = removeDuplicates;
+exports.resolvePackageRoot = resolvePackageRoot;
+exports.stringifyLocation = stringifyLocation;
+exports.template = template;
+exports.toPosixPath = toPosixPath;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _util = require("util");
+const setTimeoutPromise = (0, _util.promisify)(setTimeout);
+/**
+ * Returns Symbol by name.
+ * 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;
+  });
+}
+/**
+ * Extracts all template params from string.
+ * Params defined as <param>.
+ */
+function extractTemplateParams(t) {
+  return [...t.matchAll(/<(.+?)>/g)].map(m => m[1]);
+}
+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 || '';
+}
+async function callWithTimeout(fn, timeout, timeoutMsg) {
+  if (!timeout) {
+    return fn();
+  }
+  const ac = new AbortController();
+  return Promise.race([fn(), setTimeoutPromise(timeout, null, {
+    ref: false,
+    signal: ac.signal
+  }).then(() => {
+    throw new Error(timeoutMsg || `Function timeout (${timeout} ms)`);
+  })]).finally(() => ac.abort());
+}
+function stringifyLocation({
+  line,
+  column
+}) {
+  return `${line}:${column}`;
+}
+function omit(obj, key) {
+  const res = {
+    ...obj
+  };
+  delete res[key];
+  return res;
+}
+/**
+ * Returns path with "/" separator on all platforms.
+ * See: https://stackoverflow.com/questions/53799385/how-can-i-convert-a-windows-path-to-posix-path-using-node-path
+ */
+function toPosixPath(somePath) {
+  return somePath.split(_path.default.sep).join(_path.default.posix.sep);
+}

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

@@ -0,0 +1,44 @@
+"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

@@ -0,0 +1,30 @@
+"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 = exports.logger = new Logger();

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

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.stripAnsiEscapes = stripAnsiEscapes;
+/**
+ * Copied from Playwright.
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/reporters/base.ts#L529
+ *
+ * Note: there is also 'strip-ansi' package, but is't ESM only.
+ * Adding it is tricky now.
+ * See: https://www.npmjs.com/package/strip-ansi
+ */
+const ansiRegex = new RegExp(
+// eslint-disable-next-line max-len, no-control-regex
+'([\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~])))', 'g');
+function stripAnsiEscapes(str) {
+  return str.replace(ansiRegex, '');
+}

package/build/core/playwright/builtInFixtures/addTags.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _default = exports.default = {
   addTags: [async ({
-    $tags = []
+    $tags
   }, use, testInfo) => {
     testInfo.annotations.push({
       type: 'tags',

package/build/core/playwright/builtInFixtures/context.js

@@ -4,12 +4,29 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _readConfigFile = require("../readConfigFile");
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function performDefaultContextSteps({
+  context
+}) {
+  if (testSetup.context && typeof testSetup.context === 'function') {
+    await testSetup.context({
+      context
+    });
+  }
+}
 var _default = exports.default = {
   context: async ({
     context
   }, use) => {
+    await context.addInitScript(() =>
     // eslint-disable-next-line no-undef
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
+    window.localStorage.setItem('isDnBannerHide', true));
+    await performDefaultContextSteps({
+      context
+    });
     await use(context);
   }
 };

package/build/core/playwright/builtInFixtures/i18N.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/* eslint-disable no-undef */
+/* eslint-disable no-param-reassign */
+
+// Note: We are duplicating below method from @zohodesk/i18n. We are not importing it as react package not yet availble in test environment.
+function replaceI18NValuesWithRegex(i18nStr, values) {
+  if (typeof values !== 'undefined') {
+    if (Array.isArray(values)) {
+      for (let i = 0; i < values.length; i++) {
+        i18nStr = i18nStr.replace(new RegExp(`\\{${i}\\}`, 'g'), values[i]);
+      }
+    } else {
+      i18nStr = i18nStr.replace(new RegExp('\\{0\\}', 'g'), values);
+    }
+  }
+  return i18nStr;
+}
+var _default = exports.default = {
+  i18N: async ({
+    page
+  }, use) => {
+    await use(async (key, values) => {
+      const i18nValue = await page.evaluate(i18nKey => window.i18n[i18nKey], key);
+      const i18nStr = replaceI18NValuesWithRegex(i18nValue, values);
+      return i18nStr;
+    });
+  }
+};

package/build/core/playwright/builtInFixtures/index.js

@@ -8,21 +8,33 @@ exports.default = void 0;
 var _page = _interopRequireDefault(require("./page"));
 var _context = _interopRequireDefault(require("./context"));
 var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
-// import addTags from './addTags';
-
-const addTags = {
-  $tags: ({}, use) => use([])
-};
+var _addTags = _interopRequireDefault(require("./addTags"));
+var _i18N = _interopRequireDefault(require("./i18N"));
+var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
+function extractTagsFromTitle(text) {
+  return text.match(/@\w+/g) || [];
+}
 function getBuiltInFixtures(bddMode) {
   let builtInFixtures = {
     ..._page.default,
     ..._context.default,
-    ..._cacheLayer.default
+    ..._cacheLayer.default,
+    ..._i18N.default,
+    ..._unauthenticatedPage.default
   };
   if (bddMode) {
     builtInFixtures = {
       ...builtInFixtures,
-      ...addTags
+      ..._addTags.default
+    };
+  } else {
+    builtInFixtures = {
+      ...builtInFixtures,
+      $tags: async ({}, use, testInfo) => {
+        // Extract only the elements after the "@" symbol as tags
+        const tags = testInfo.title ? extractTagsFromTitle(testInfo.title) : [];
+        await use(tags);
+      }
     };
   }
   return builtInFixtures;