@zohodesk/testinglibrary 0.1.8 → 0.1.9-exp-actors

package/build/bdd-framework/run/StepInvoker.js

@@ -10,64 +10,59 @@ var _testTypeImpl = require("../playwright/testTypeImpl");
 var _defineStep = require("../stepDefinitions/defineStep");
 var _lang = require("../config/lang");
 /**
- * Class to invoke steps in generated files.
+ * Class to invoke step in playwright runner.
  */
 
 class StepInvoker {
   world;
   keyword;
-  text = '';
-  argument;
   constructor(world, keyword) {
     this.world = world;
     this.keyword = keyword;
     this.invoke = this.invoke.bind(this);
   }
+  /**
+     * Invokes particular step.
+     * See: https://github.com/cucumber/cucumber-js/blob/main/src/runtime/test_case_runner.ts#L299
+     */
   async invoke(text, argument, stepFixtures) {
-    this.text = text;
-    this.argument = argument;
-    const {
-      world
-    } = this;
-    world.stepFixtures = stepFixtures || {};
-    const stepDefinition = this.getStepDefinition();
+    this.world.$internal.currentStepFixtures = stepFixtures || {};
+    const stepDefinition = this.getStepDefinition(text);
     // Get location of step call in generated test file.
     // This call must be exactly here to have correct call stack (before async calls)
-    const location = (0, _getLocationInFile.getLocationInFile)(world.test.info().file);
-    const stepTitle = this.getStepTitle();
+    const location = (0, _getLocationInFile.getLocationInFile)(this.world.testInfo.file);
+    const stepTitle = this.getStepTitle(text);
     const code = (0, _defineStep.getStepCode)(stepDefinition);
-    const parameters = await this.getStepParameters(stepDefinition);
-    return (0, _testTypeImpl.runStepWithCustomLocation)(world.test, stepTitle, location, () => code.apply(world, parameters));
+    const parameters = await this.getStepParameters(stepDefinition, text, argument || undefined);
+    this.world.$internal.bddData.registerStep(stepDefinition, text, location);
+    return (0, _testTypeImpl.runStepWithCustomLocation)(this.world.test, stepTitle, location, () => code.apply(this.world, parameters));
   }
-  getStepDefinition() {
-    const stepDefinition = (0, _loadSteps.findStepDefinition)(this.world.options.supportCodeLibrary, this.text, this.world.testInfo.file);
+  getStepDefinition(text) {
+    const stepDefinition = (0, _loadSteps.findStepDefinition)(this.world.options.supportCodeLibrary, text, this.world.testInfo.file);
     if (!stepDefinition) {
-      throw new Error(`Undefined step: "${this.text}"`);
+      throw new Error(`Undefined step: "${text}"`);
     }
     return stepDefinition;
   }
-  async getStepParameters(stepDefinition) {
-    const {
-      text,
-      argument,
-      world
-    } = this;
+  async getStepParameters(stepDefinition, text, argument) {
+    // see: https://github.com/cucumber/cucumber-js/blob/main/src/models/step_definition.ts#L25
     const {
       parameters
     } = await stepDefinition.getInvocationParameters({
       hookParameter: {},
+      // only text and argument are needed
       step: {
         text,
         argument
       },
-      world
+      world: this.world
     });
     return parameters;
   }
-  getStepTitle() {
+  getStepTitle(text) {
     // Currently prepend keyword only for English.
     // For other langs it's more complex as we need to pass original keyword from step.
-    return (0, _lang.isEnglish)(this.world.options.lang) ? `${this.keyword} ${this.text}` : this.text;
+    return (0, _lang.isEnglish)(this.world.options.lang) ? `${this.keyword} ${text}` : text;
   }
 }
 exports.StepInvoker = StepInvoker;

package/build/bdd-framework/run/bddDataAttachment.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BddData = void 0;
+exports.getBddDataFromTestResult = getBddDataFromTestResult;
+exports.isBddDataAttachment = isBddDataAttachment;
+var _createTestStep = require("../cucumber/createTestStep");
+var _utils = require("../utils");
+const BDD_DATA_ATTACHMENT_NAME = '__bddData';
+class BddData {
+  world;
+  steps = [];
+  constructor(world) {
+    this.world = world;
+  }
+  registerStep(stepDefinition, stepText, pwStepLocation) {
+    const step = (0, _createTestStep.createTestStep)(stepDefinition, stepText);
+    this.steps.push({
+      pwStepLocation: (0, _utils.stringifyLocation)(pwStepLocation),
+      stepMatchArgumentsLists: step.stepMatchArgumentsLists || []
+    });
+  }
+  async attach(testMeta, uri) {
+    const attachment = {
+      uri,
+      pickleLocation: testMeta.pickleLocation,
+      steps: this.steps
+    };
+    await this.world.testInfo.attach(BDD_DATA_ATTACHMENT_NAME, {
+      contentType: 'application/json',
+      body: JSON.stringify(attachment)
+    });
+  }
+}
+exports.BddData = BddData;
+function getBddDataFromTestResult(result) {
+  var _attachment$body;
+  const attachment = result.attachments.find(isBddDataAttachment);
+  const attachmentBody = attachment === null || attachment === void 0 || (_attachment$body = attachment.body) === null || _attachment$body === void 0 ? void 0 : _attachment$body.toString();
+  return attachmentBody ? JSON.parse(attachmentBody) : undefined;
+}
+function isBddDataAttachment(attachment) {
+  return attachment.name === BDD_DATA_ATTACHMENT_NAME;
+}

package/build/bdd-framework/run/bddFixtures.js

@@ -12,10 +12,13 @@ var _bddWorld = require("./bddWorld");
 var _config = require("../config");
 var _env = require("../config/env");
 var _steps = require("../stepDefinitions/decorators/steps");
-var _dir = require("../config/dir");
+var _configDir = require("../config/configDir");
 var _scenario = require("../hooks/scenario");
 var _worker = require("../hooks/worker");
 var _StepInvoker = require("./StepInvoker");
+var _testMeta = require("../gen/testMeta");
+var _logger = require("../utils/logger");
+var _enrichReporterData = require("../config/enrichReporterData");
 const test = exports.test = _test.test.extend({
   // load cucumber once per worker (auto-fixture)
   // todo: maybe remove caching in cucumber/loadConfig.ts and cucumber/loadSteps.ts
@@ -23,7 +26,7 @@ const test = exports.test = _test.test.extend({
   $cucumber: [async ({}, use, workerInfo) => {
     const config = (0, _env.getConfigFromEnv)(workerInfo.project.testDir);
     const environment = {
-      cwd: (0, _dir.getPlaywrightConfigDir)()
+      cwd: (0, _configDir.getPlaywrightConfigDir)()
     };
     const {
       runConfiguration
@@ -36,12 +39,14 @@ const test = exports.test = _test.test.extend({
     await use({
       runConfiguration,
       supportCodeLibrary,
-      World
+      World,
+      config
     });
   }, {
     auto: true,
     scope: 'worker'
   }],
+  // $lang fixture can be overwritten in test file
   $lang: ({}, use) => use(''),
   // init $bddWorldFixtures with empty object, will be owerwritten in test file for cucumber-style
   $bddWorldFixtures: ({}, use) => use({}),
@@ -50,12 +55,15 @@ const test = exports.test = _test.test.extend({
     $test,
     $bddWorldFixtures,
     $cucumber,
-    $lang
+    $lang,
+    $testMeta,
+    $uri
   }, use, testInfo) => {
     const {
       runConfiguration,
       supportCodeLibrary,
-      World
+      World,
+      config
     } = $cucumber;
     const world = new World({
       testInfo,
@@ -65,12 +73,15 @@ const test = exports.test = _test.test.extend({
       $bddWorldFixtures,
       lang: $lang,
       parameters: runConfiguration.runtime.worldParameters || {},
-      log: () => {},
-      attach: async () => {}
+      log: () => _logger.logger.warn(`world.log() is noop, please use world.testInfo.attach()`),
+      attach: async () => _logger.logger.warn(`world.attach() is noop, please use world.testInfo.attach()`)
     });
     await world.init();
     await use(world);
     await world.destroy();
+    if ((0, _enrichReporterData.getEnrichReporterData)(config)) {
+      await world.$internal.bddData.attach($testMeta, $uri);
+    }
   },
   Given: ({
     $bddWorld
@@ -87,10 +98,20 @@ const test = exports.test = _test.test.extend({
   But: ({
     $bddWorld
   }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'But').invoke),
-  // init $tags with empty array, can be owerwritten in test file
-  $tags: ({}, use) => use([]),
-  // init $test with base test, but it will be always overwritten in test file
+  // init $testMetaMap with empty object, will be overwritten in each test file
+  $testMetaMap: ({}, use) => use({}),
+  // concrete test meta
+  $testMeta: ({
+    $testMetaMap
+  }, use, testInfo) => use((0, _testMeta.getTestMeta)($testMetaMap, testInfo)),
+  // concrete test tags
+  $tags: ({
+    $testMeta
+  }, use) => use($testMeta.tags || []),
+  // init $test with base test, but it will be overwritten in test file
   $test: ({}, use) => use(_test.test),
+  // feature file uri, relative to configDir, will be overwritten in test file
+  $uri: ({}, use) => use(''),
   // can be owerwritten in test file if there are scenario hooks
   $scenarioHookFixtures: ({}, use) => use({}),
   $before: [

package/build/bdd-framework/run/bddWorld.js

@@ -6,12 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 exports.BddWorld = void 0;
 exports.getWorldConstructor = getWorldConstructor;
 var _cucumber = require("@cucumber/cucumber");
+var _bddWorldInternal = require("./bddWorldInternal");
 class BddWorld extends _cucumber.World {
   options;
-  stepFixtures = {};
+  // special property to hold internal bdd related methods, must be public.
+  $internal;
   constructor(options) {
     super(options);
     this.options = options;
+    this.$internal = new _bddWorldInternal.BddWorldInternal(this);
   }
   /**
      * Use particular fixture in cucumber-style steps.
@@ -30,7 +33,7 @@ class BddWorld extends _cucumber.World {
      * See: https://github.com/Microsoft/TypeScript/pull/26349
      */
   useFixture(fixtureName) {
-    return this.stepFixtures[fixtureName];
+    return this.$internal.currentStepFixtures[fixtureName];
   }
   get page() {
     return this.options.$bddWorldFixtures.page;

package/build/bdd-framework/run/bddWorldInternal.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BddWorldInternal = void 0;
+var _bddDataAttachment = require("./bddDataAttachment");
+class BddWorldInternal {
+  currentStepFixtures = {};
+  bddData;
+  constructor(world) {
+    this.bddData = new _bddDataAttachment.BddData(world);
+  }
+}
+exports.BddWorldInternal = BddWorldInternal;

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

@@ -32,16 +32,12 @@ class Snippets {
     // exit();
   }
   async createSnippetBuilder() {
-    const {
-      snippetInterface
-    } = this.runConfiguration.formats.options;
+    const snippetInterface = this.runConfiguration.formats.options.snippetInterface;
     const snippetSyntax = this.getSnippetSyntax();
     return (0, _loadSnippetBuilder.loadSnippetBuilder)(this.supportCodeLibrary, snippetInterface, snippetSyntax);
   }
   getSnippetSyntax() {
-    const {
-      snippetSyntax
-    } = this.runConfiguration.formats.options;
+    const snippetSyntax = this.runConfiguration.formats.options.snippetSyntax;
     if (!snippetSyntax && this.isPlaywrightStyle()) {
       this.bddBuiltInSyntax = true;
       const filePath = this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
@@ -76,7 +72,7 @@ class Snippets {
       line,
       column
     } = undefinedStep.step.location;
-    const snippetWithLocation = [`// ${index}. Missing step definition for "${file.sourceFile}:${line}:${column}"`, snippet].join('\n');
+    const snippetWithLocation = [`// ${index}. Missing step definition for "${file.featureUri}:${line}:${column}"`, snippet].join('\n');
     return {
       snippet,
       snippetWithLocation

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

@@ -35,7 +35,7 @@ function defineStep(stepConfig) {
 function buildCucumberStepCode(stepConfig) {
   const code = function (...args) {
     // build the first argument (fixtures) for step fn
-    const fixturesArg = Object.assign({}, this.stepFixtures, {
+    const fixturesArg = Object.assign({}, this.$internal.currentStepFixtures, {
       $testInfo: this.testInfo,
       $test: this.test,
       $tags: this.tags

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/index.js

@@ -8,9 +8,12 @@ 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");
@@ -67,4 +70,24 @@ async function callWithTimeout(fn, timeout, timeoutMsg) {
   }).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/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/cacheLayer.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 const cacheMap = new Map();
 var _default = exports.default = {
+  // eslint-disable-next-line no-empty-pattern
   cacheLayer: async ({}, use) => {
     await use(cacheMap);
   }

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

@@ -9,17 +9,33 @@ var _page = _interopRequireDefault(require("./page"));
 var _context = _interopRequireDefault(require("./context"));
 var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
 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.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;
 }

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

@@ -4,48 +4,96 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-// function test(descrition, callback) {
-//   return test(descrition, ({ page }) => {
-//     const { locator, ...custompage } = page
-//     callback({ page: custompage })
-//   })
-// }
-// class FilteredPage {
-//   constructor(page) {
-//     this.page = page;
-//     this.allowedMethods = ['getByText', 'getByTitle'];
-//     this.context = page.context;
-//   }
-//   goto(...args) {
-//     return this.page['goto'](...args);
-//   }
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
+var _auth = require("../helpers/auth");
+var _readConfigFile = require("../readConfigFile");
+/* eslint-disable global-require */
+
+function getTagInputFromSelectedTags(tags, inputString) {
+  const selectedTag = tags.find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  return tagInput;
+}
+function getCustomAccountDetails(tags) {
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal'];
+  const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
+  if (filteredTags && filteredTags.length > 0) {
+    const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');
+    const betaFeature = getTagInputFromSelectedTags(filteredTags, '@beta');
+    const profileInfo = getTagInputFromSelectedTags(filteredTags, '@profile');
+    const editionInfo = getTagInputFromSelectedTags(filteredTags, '@edition');
+    const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+    return user;
+  }
+  return null;
+}
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function performDefaultPageSteps({
+  context,
+  $tags,
+  page
+}) {
+  if (testSetup.page && typeof testSetup.page === 'function') {
+    await testSetup.page({
+      context,
+      $tags,
+      page
+    });
+  } else {
+    await page.goto(process.env.domain);
+  }
+}
 var _default = exports.default = {
   page: async ({
+    context,
+    $tags,
     page
   }, use) => {
-    page.getBaseUrl = function () {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}`;
-    };
-    page.getCustomPageUrl = function (url) {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}/${url}`;
-    };
-    await use(page);
+    const testPortalDetails = getCustomAccountDetails($tags);
+    if (testPortalDetails === null) {
+      await performDefaultPageSteps({
+        context,
+        $tags,
+        page
+      });
+      const {
+        edition,
+        profile
+      } = (0, _auth.getDefaultActor)();
+      const user = (0, _auth.getUserForSelectedEditionAndProfile)(edition, profile);
+      const {
+        password,
+        ...actorInfo
+      } = user;
+      process.env.actorInfo = JSON.stringify(actorInfo);
+      await use(page);
+    } else {
+      await context.clearCookies();
+      const {
+        email
+      } = testPortalDetails;
+      const {
+        password,
+        ...actorInfo
+      } = testPortalDetails;
+      await (0, _auth.performLoginSteps)({
+        page,
+        authFilePrefix: email,
+        useremail: email,
+        password: password
+      }, async () => page.url().includes(process.env.domain));
+      process.env.actorInfo = JSON.stringify(actorInfo);
+      await performDefaultPageSteps({
+        context,
+        $tags,
+        page
+      });
+      await use(page);
+      await context.close();
+    }
   }
 };

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

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  unauthenticatedPage: async ({
+    browser
+  }, use) => {
+    const context = await browser.newContext({
+      storageState: null
+    });
+    const unauthenticatedPage = await context.newPage();
+    await use(unauthenticatedPage);
+    await context.close();
+  }
+};