@zohodesk/testinglibrary 0.4.46-experimental → 0.4.48-experimental

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/build/setup-folder-structure/samples/settings.json

@@ -0,0 +1,7 @@
+{
+  "environment": "dev",
+  "edition": "enterprise",
+  "profile": "admin",
+  "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/__tests__/tagProcessor.test.js

@@ -2,7 +2,6 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _tagProcessor = _interopRequireDefault(require("../../../../../src/core/playwright/tagProcessor"));
-var _Configuration = _interopRequireDefault(require("../../../../../src/core/playwright/configuration/Configuration.js"));
 var _logger = require("../../../../utils/logger");
 jest.mock('../../../../utils/logger');
 describe('TagProcessor', () => {
@@ -12,83 +11,83 @@ describe('TagProcessor', () => {
   });
   test('should return tagArgs if no edition is provided', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: null
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1');
   });
   test('should handle a single edition with <= operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '<=edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
   });
   test('should handle a single edition with >= operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '>=edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1)');
   });
   test('should handle a single edition with < operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '<edition3'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
   });
   test('should handle a single edition with > operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '>edition1'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1)');
   });
   test('should handle a single edition with no operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1 or @edition_edition3 or @edition_edition4)');
   });
   test('should log a message if edition is not found', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'nonexistentEdition'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1');
     expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.INFO_TYPE, expect.stringContaining('No matching editions for nonexistentEdition found.'));
   });
   test('should handle multiple editions', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'edition1,edition3'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition2 or @edition_edition4)');
   });
   test('should build tags correctly when tags are empty', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: '',
       edition: 'edition1'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('not (@edition_edition2 or @edition_edition3 or @edition_edition4)');
   });

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);