@zohodesk/testinglibrary 0.1.5 → 0.1.6

package/build/core/playwright/custom-commands.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CUSTOM_COMMANDS = void 0;
-const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags'];
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition'];

package/build/core/playwright/index.js

@@ -55,6 +55,7 @@ const {
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _bddFramework.test : _test.test;
+const cacheMap = new Map();
 const test = exports.test = base.extend({
   page: async ({
     page
@@ -98,6 +99,11 @@ const test = exports.test = base.extend({
     await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
     await use(context);
   },
+  cacheLayer: async ({
+    context
+  }, use) => {
+    await use(cacheMap);
+  },
   ...additionalPages
 });
 const {

package/build/core/playwright/readConfigFile.js

@@ -34,7 +34,8 @@ function getDefaultConfig() {
     additionalPages: {},
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
-    testIdAttribute: 'data-testid'
+    testIdAttribute: 'data-testid',
+    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
@@ -83,6 +84,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
  * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
  * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
+ * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
  */
 
 /**

package/build/core/playwright/tag-processor.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tagProcessor = tagProcessor;
+function getTagsString(tags, editionTags) {
+  return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
+}
+function getEdition(edition) {
+  if (edition.startsWith('<=')) {
+    return ['<=', edition.slice(2)];
+  } else if (edition.startsWith('>=')) {
+    return ['>=', edition.slice(2)];
+  } else if (edition.startsWith('<')) {
+    return ['<', edition.slice(1)];
+  } else if (edition.startsWith('>')) {
+    return ['>', edition.slice(1)];
+  }
+  return [null, edition];
+}
+function editionPreprocessing(editionOrder, selectedEdition) {
+  const [operator, editionToBeSearched] = getEdition(selectedEdition.toLowerCase());
+  const index = editionOrder.findIndex(edition => edition.toLowerCase() === editionToBeSearched);
+  if (index !== -1) {
+    let resultArray;
+    if (operator === '<=') {
+      resultArray = editionOrder.slice(index + 1);
+    } else if (operator === '>=') {
+      resultArray = editionOrder.slice(0, index);
+    } else if (operator === '<') {
+      resultArray = editionOrder.slice(index);
+    } else if (operator === '>') {
+      resultArray = editionOrder.slice(0, index + 1);
+    } else {
+      resultArray = editionOrder.filter((_, order) => order !== index);
+    }
+    return resultArray;
+  }
+  Logger.log(Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
+  return [];
+}
+function buildEditionTags(editionArgs, operator) {
+  return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
+}
+function tagProcessor(userArgsObject, editionOrder) {
+  let tagArgs = userArgsObject['tags'];
+  const edition = userArgsObject['edition'] || null;
+  if (edition !== null) {
+    let editionsArray = edition.split(',');
+    if (editionsArray.length === 1) {
+      const editionArgs = editionPreprocessing(editionOrder, edition);
+      if (editionArgs && editionArgs.length > 0) {
+        const editionTags = buildEditionTags(editionArgs, 'or');
+        tagArgs = `${getTagsString(tagArgs, editionTags)}`;
+      }
+    } else {
+      // More than one edition given
+      const editionTags = buildEditionTags(editionsArray, 'and');
+      tagArgs = `${getTagsString(tagArgs, editionTags)}`;
+    }
+  }
+  return tagArgs;
+}

package/build/core/playwright/test-runner.js

@@ -13,6 +13,7 @@ var _envInitializer = require("./env-initializer");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
 var _rootPath = require("../../utils/rootPath");
+var _tagProcessor = require("./tag-processor");
 function parseUserArgs() {
   return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
 }
@@ -85,13 +86,15 @@ function runPlaywright(command, args) {
 function main() {
   const userArgsObject = parseUserArgs();
   // eslint-disable-next-line
-  const tagArgs = userArgsObject['tags'];
+
   const {
     debug,
     mode = 'dev',
     bddMode = false,
-    headless = false
+    headless = false,
+    editionOrder
   } = (0, _readConfigFile.generateConfigFromFile)();
+  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
   const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
   (0, _envInitializer.initializeEnvConfig)(userArgsObject.mode ? userArgsObject.mode : mode);
   const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));

package/changelog.md

@@ -2,6 +2,19 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.1.6
+
+**Enhancements**
+- New Command option Added `--edition`.
+- New Configuration Added `editionOrder`.
+  `In uat.config.js, editionOrder: ['Free', 'Express']`
+- Cache Layer added
+
+**USAGE**
+ - npm run uat --edition="Free"
+
+
+
 # 0.1.5
 
 **Enhancements**

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -23,7 +23,6 @@
     "@babel/preset-react": "7.22.5",
     "@cucumber/cucumber": "9.2.0",
     "@playwright/test": "1.40.1",
-    "playwright": "1.40.1",
     "@testing-library/jest-dom": "5.11.9",
     "@testing-library/react": "11.2.7",
     "@testing-library/react-hooks": "7.0.2",
@@ -32,7 +31,8 @@
     "fast-glob": "3.3.1",
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
-    "msw": "1.2.3"
+    "msw": "1.2.3",
+    "playwright": "1.40.1"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"