@zohodesk/testinglibrary 0.4.45-experimental → 0.4.47-experimental

package/build/core/playwright/tagProcessor.js

@@ -1,23 +1,13 @@
 "use strict";
 
 var _logger = require("../../utils/logger");
-function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-var _buildTagsString = /*#__PURE__*/new WeakSet();
-var _parseEdition = /*#__PURE__*/new WeakSet();
-var _processSingleEdition = /*#__PURE__*/new WeakSet();
-var _processMultipleEditions = /*#__PURE__*/new WeakSet();
-var _getEditionArgs = /*#__PURE__*/new WeakSet();
-var _buildEditionTags = /*#__PURE__*/new WeakSet();
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+var _TagProcessor_brand = /*#__PURE__*/new WeakSet();
 class TagProcessor {
   constructor(editionOrder) {
-    _classPrivateMethodInitSpec(this, _buildEditionTags);
-    _classPrivateMethodInitSpec(this, _getEditionArgs);
-    _classPrivateMethodInitSpec(this, _processMultipleEditions);
-    _classPrivateMethodInitSpec(this, _processSingleEdition);
-    _classPrivateMethodInitSpec(this, _parseEdition);
-    _classPrivateMethodInitSpec(this, _buildTagsString);
+    _classPrivateMethodInitSpec(this, _TagProcessor_brand);
     this.editionOrder = editionOrder;
   }
   processTags(userArgs) {
@@ -25,36 +15,36 @@ class TagProcessor {
     const edition = userArgs['edition'] || null;
     if (!edition) return tagArgs;
     const editionsArray = edition.split(',');
-    const editionTags = editionsArray.length === 1 ? _classPrivateMethodGet(this, _processSingleEdition, _processSingleEdition2).call(this, editionsArray[0], tagArgs) : _classPrivateMethodGet(this, _processMultipleEditions, _processMultipleEditions2).call(this, editionsArray, tagArgs);
+    const editionTags = editionsArray.length === 1 ? _assertClassBrand(_TagProcessor_brand, this, _processSingleEdition).call(this, editionsArray[0], tagArgs) : _assertClassBrand(_TagProcessor_brand, this, _processMultipleEditions).call(this, editionsArray, tagArgs);
     return editionTags;
   }
 }
-function _buildTagsString2(tags, editionTags) {
+function _buildTagsString(tags, editionTags) {
   return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
 }
-function _parseEdition2(edition) {
+function _parseEdition(edition) {
   if (edition.startsWith('<=')) return ['<=', edition.slice(2)];
   if (edition.startsWith('>=')) return ['>=', edition.slice(2)];
   if (edition.startsWith('<')) return ['<', edition.slice(1)];
   if (edition.startsWith('>')) return ['>', edition.slice(1)];
   return [null, edition];
 }
-function _processSingleEdition2(selectedEdition, tagArgs) {
-  const editionArgs = _classPrivateMethodGet(this, _getEditionArgs, _getEditionArgs2).call(this, selectedEdition);
+function _processSingleEdition(selectedEdition, tagArgs) {
+  const editionArgs = _assertClassBrand(_TagProcessor_brand, this, _getEditionArgs).call(this, selectedEdition);
   if (editionArgs && editionArgs.length > 0) {
-    const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, editionArgs, 'or');
-    return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+    const editionTags = _assertClassBrand(_TagProcessor_brand, this, _buildEditionTags).call(this, editionArgs, 'or');
+    return _assertClassBrand(_TagProcessor_brand, this, _buildTagsString).call(this, tagArgs, editionTags);
   }
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
   return tagArgs;
 }
-function _processMultipleEditions2(editionsArray, tagArgs) {
+function _processMultipleEditions(editionsArray, tagArgs) {
   const filteredEditions = this.editionOrder.filter(edition => !editionsArray.includes(edition));
-  const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, filteredEditions, 'or');
-  return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+  const editionTags = _assertClassBrand(_TagProcessor_brand, this, _buildEditionTags).call(this, filteredEditions, 'or');
+  return _assertClassBrand(_TagProcessor_brand, this, _buildTagsString).call(this, tagArgs, editionTags);
 }
-function _getEditionArgs2(selectedEdition) {
-  const [operator, editionValue] = _classPrivateMethodGet(this, _parseEdition, _parseEdition2).call(this, selectedEdition.toLowerCase());
+function _getEditionArgs(selectedEdition) {
+  const [operator, editionValue] = _assertClassBrand(_TagProcessor_brand, this, _parseEdition).call(this, selectedEdition.toLowerCase());
   const index = this.editionOrder.findIndex(edition => edition.toLowerCase() === editionValue);
   if (index === -1) {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
@@ -73,7 +63,7 @@ function _getEditionArgs2(selectedEdition) {
       return this.editionOrder.filter((_, i) => i !== index);
   }
 }
-function _buildEditionTags2(editionArgs, operator = 'or') {
+function _buildEditionTags(editionArgs, operator = 'or') {
   return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
 }
 module.exports = TagProcessor;

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

@@ -24,7 +24,7 @@ var _RunnerHelper = _interopRequireDefault(require("./runner/RunnerHelper"));
 var _Runner = _interopRequireDefault(require("./runner/Runner"));
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from './bdd-framework/decorators';
+export * from 'playwright-bdd/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("./bdd-framework/decorators");
+var _decorators = require("playwright-bdd/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

package/build/setup-folder-structure/samples/accountLogin-sample.js

@@ -0,0 +1,19 @@
+// This is the sample file generated by testing framework. You can change as per the respective project login
+
+const getUrlOrigin = require('../shared/url-helpers/getUrlOrigin');
+
+async function accountLogin( { page, email, password } ) {
+  await page.locator('#login_id').fill(email);
+  await page.locator('#nextbtn').click();
+  await page.locator('#password').fill(password);
+  await page.locator('#nextbtn').click();
+
+  const domainUrlOrigin = getUrlOrigin(process.env.domain);
+  await page.waitForNavigation();
+  await Promise.race([
+    page.waitForURL(`${domainUrlOrigin}/**`),
+    page.waitForURL('**/announcement/**')
+  ]);
+}
+
+module.exports  = accountLogin;

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -1,73 +1,15 @@
 /* eslint-disable no-console */
 import { test as setup, expect } from '@zohodesk/testinglibrary';
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-import { getAuthFileDirectory } from '../../core/playwright';
-import { Logger } from '../../utils/logger';
+import {
+  performLoginSteps,
+  getDefaultActor
+} from '@zohodesk/testinglibrary/helpers';
 
-const userdata = require('./authUsers.json');
+import { loginSteps , validateLogin } from './testSetup';
 
-const authContent = { cookies: [] };
+const user = getDefaultActor();
 
-const LOGIN_ERR_MESSAGE = 'Need go be logged in';
-// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
-
-function convertCookiesToParse(cookies, authFilePath) {
-  try {
-    return JSON.parse(cookies);
-  } catch (err) {
-    Logger.error(err);
-    throw new Error(
-      ` Error while parsing cookies ${err} \n${path.resolve(
-        process.cwd(),
-        authFilePath
-      )} File is Empty`
-    );
-    // process.exit()
-  }
-}
-const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
-if (!existsSync(authDirectory)) {
-  console.log('Creating auth directory for the first time setup...');
-  mkdirSync(authDirectory, { recursive: true });
-}
-
-userdata.forEach(data => {
-  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
-  if (!existsSync(authFile)) {
-    console.log('creating auth file..');
-    writeFileSync(authFile, JSON.stringify(authContent, null, 2));
-  }
-  setup(data.description, async ({ page }) => {
-    try {
-      const cookies = readFileSync(authFile);
-      const parsedCookies = convertCookiesToParse(cookies, authFile);
-      await page
-        .context()
-        .addCookies(
-          parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
-        );
-      await page.goto(page.getBaseUrl());
-      await page.waitForLoadState();
-      if (await page.url().includes(process.env.domain)) {
-        await page.waitForSelector(data.locator);
-      } else {
-        throw new Error(LOGIN_ERR_MESSAGE);
-      }
-    } catch (err) {
-      if (err.message === LOGIN_ERR_MESSAGE) {
-        await expect(page.locator('.load-bg')).toBeHidden();
-        await page.locator('#login_id').type(data.useremail);
-        await page.locator('#nextbtn').click();
-        await page.locator('#password').type(data.password);
-        await page.locator('#nextbtn').click();
-
-        await page.waitForLoadState('networkidle');
-
-        await page.waitForSelector(data.locator);
-
-        await page.context().storageState({ path: authFile });
-      }
-    }
-  });
-});
+setup(`${user.edition} - Authentication`, async ({ page }) => {
+  //Implement performLoginSteps here
+  await performLoginSteps({page, ...user},validateLogin ,loginSteps);
+}); 

package/build/setup-folder-structure/samples/editions-index.js

@@ -0,0 +1,3 @@
+const free = require('./free.json');
+const editions = { free};
+module.exports = editions;

package/build/setup-folder-structure/samples/free-sample.json

@@ -0,0 +1,25 @@
+[
+    {
+      "id": "1",
+      "edition": "free",
+      "orgName": "orgFree",
+      "profiles": [
+        {
+          "profile": "admin",
+          "email": "admin+free@zohotest.com",
+          "password": "password@0987"
+        },
+        {
+          "profile": "agent",
+          "email": "agent@zohotest.com",
+          "password": "password@12345"
+        },
+        {
+          "profile": "lightagent",
+          "email": "lightagent@zohotest.com",
+          "password": "password@12345"
+        }
+      ]
+    }
+  ]
+  

package/{nobdd/uat/conf/default → build/setup-folder-structure/samples}/settings.json

@@ -1,6 +1,7 @@
 {
-  "environment": "ci",
+  "environment": "dev",
   "edition": "enterprise",
   "profile": "admin",
-  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent"
-}
+  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+  "devUrl" : "" 
+}

package/build/setup-folder-structure/samples/testSetup-sample.js

@@ -0,0 +1,14 @@
+/* eslint-disable global-require */
+const accountLogin = require('./accountLogin');
+
+async function verifyPageIsLoaded({page}) {
+
+    //Implement your validation logic here
+    //Refer deskclientapp testSetup.js
+}
+
+module.exports = {
+  loginSteps:accountLogin,
+  validateLogin:verifyPageIsLoaded,
+  page:()=>{}
+};

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -1,3 +1,4 @@
+const testSetup = require('../../fixtures/testSetup');
 /**
  * @typedef {Object|null} viewportConfig
  * @property {number} width - width of the viewport
@@ -40,5 +41,6 @@ module.exports = {
   bddMode: true,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
-  viewport: { width: 1280, height: 720 }
+  viewport: { width: 1280, height: 720 },
+  testSetup
 }

package/build/setup-folder-structure/setupProject.js

@@ -10,8 +10,9 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
 function getScriptsToBeAdded() {
   return {
-    "uat": "ZDTestingFramework test --mode=prod --headed",
-    "uat-debug": "ZDTestingFramework test --mode=prod --debug",
+    "uat": "ZDTestingFramework test --mode=dev --headed",
+    "uat-debug": "ZDTestingFramework test --mode=dev --debug",
+    "uat-validate": "ZDTestingFramework validate",
     "uat-report": "ZDTestingFramework report --port=9009",
     "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
   };
@@ -71,8 +72,11 @@ function createAuthenticationFile() {
         });
       }
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
-      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'accountLogin.js'), getSetupFileAsString('accountLogin-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating login script File ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'testSetup.js'), getSetupFileAsString('testSetup-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating testSetup File ....');
     } catch (err) {
       _logger.Logger.error(err);
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
@@ -84,8 +88,21 @@ function createAuthenticationFile() {
 function createConfigJson() {
   const uatFolder = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(uatFolder)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2);
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
+    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
+      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
+        recursive: true
+      });
+    }
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
+    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
+      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
+        recursive: true
+      });
+    }
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
   }

package/build/test/core/playwright/helpers/__tests__/configFileNameProvider.test.js

@@ -24,7 +24,7 @@ describe('getUATFileName', () => {
   });
   test('return the default config files for pipeline matched files not exists', () => {
     const mode = 'ci';
-    const defaultPath = `${mockCwd}/uat.config.js`;
+    const defaultPath = `${mockCwd}/uat/conf/default/uat.config.js`;
     _fs.existsSync.mockReturnValue(false);
     _path.default.resolve.mockImplementation((...args) => args.join('/'));
     const result = (0, _configFileNameProvider.getUATFileName)(mode);