@zohodesk/testinglibrary 0.4.26-experimental → 0.4.28-experimental

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

@@ -1,10 +1,12 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _auth = require("../helpers/auth");
+var _getUrlOrigin = _interopRequireDefault(require("../helpers/auth/getUrlOrigin"));
 var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
 
@@ -32,16 +34,6 @@ function getCustomAccountDetails(tags) {
 const {
   testSetup
 } = (0, _readConfigFile.generateConfigFromFile)();
-async function loginSteps(pageDetail) {
-  const {
-    page
-  } = pageDetail;
-  if (testSetup.loginSteps && typeof testSetup.loginSteps === 'function') {
-    return await testSetup.loginSteps(pageDetail);
-  } else {
-    await page.goto(process.env.domain);
-  }
-}
 async function performDefaultPageSteps({
   context,
   $tags,
@@ -58,10 +50,12 @@ async function performDefaultPageSteps({
   }
 }
 async function verifyPageIsLoaded(page) {
-  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
-    return await testSetup.validateLogin(page);
+  const urlOrigin = (0, _getUrlOrigin.default)(page.url());
+  const domainOrigin = (0, _getUrlOrigin.default)(process.env.domain);
+  if (urlOrigin === domainOrigin) {
+    return true;
   }
-  return true;
+  return false;
 }
 var _default = exports.default = {
   page: async ({
@@ -69,38 +63,45 @@ var _default = exports.default = {
     $tags,
     page
   }, use) => {
-    try {
-      //This block is used to skip the login process if the @unauthenticated tag is added to the script
-      if ($tags.includes('@unauthenticated')) {
-        await context.clearCookies();
-        return;
-      }
+    const {
+      isAuthMode
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    if (!isAuthMode) {
+      await use(page);
+      return;
+    }
+
+    //This block is used to skip the login process if the @unauthenticated tag is added to the script
+    if ($tags.includes('@unauthenticated')) {
+      await context.clearCookies();
+      await use(page);
+      return;
+    }
+    const testPortalDetails = getCustomAccountDetails($tags);
+    if (testPortalDetails === null) {
+      await performDefaultPageSteps({
+        context,
+        $tags,
+        page
+      });
+      const user = (0, _auth.getDefaultActor)();
+      process.env.actorInfo = JSON.stringify(user);
+      await use(page);
+    } else {
+      await context.clearCookies();
       const {
-        isAuthMode
-      } = (0, _readConfigFile.generateConfigFromFile)();
-      if (!isAuthMode) {
-        return;
-      }
-      const testPortalDetails = getCustomAccountDetails($tags);
-      if (testPortalDetails) {
-        await context.clearCookies();
-        const {
-          email
-        } = testPortalDetails;
-        await (0, _auth.performLoginSteps)({
-          page,
-          $tags,
-          context,
-          authFilePrefix: email,
-          ...testPortalDetails
-        }, async () => {
-          return await verifyPageIsLoaded(page);
-        }, loginSteps);
-        process.env.actorInfo = JSON.stringify(testPortalDetails);
-      }
-    } catch (error) {
-      console.error('Error during page', error);
-    } finally {
+        email,
+        password
+      } = testPortalDetails;
+      await (0, _auth.performLoginSteps)({
+        page,
+        authFilePrefix: email,
+        useremail: email,
+        password: password
+      }, async () => {
+        return await verifyPageIsLoaded(page);
+      });
+      process.env.actorInfo = JSON.stringify(testPortalDetails);
       await performDefaultPageSteps({
         context,
         $tags,

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', 'edition', 'browsers', 'filePath'];
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers', 'filePath', 'headless'];

package/build/core/playwright/helpers/auth/loginSteps.js

@@ -8,6 +8,7 @@ exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
+var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
 /* eslint-disable no-console */
@@ -15,13 +16,11 @@ var _checkAuthDirectory = require("../checkAuthDirectory");
 async function performLoginSteps({
   page,
   authFilePrefix,
-  email,
-  password,
-  context,
-  $tags
-}, isLoggedIn, loginSteps) {
+  useremail,
+  password
+}, isLoggedIn) {
   const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
-  const lockFileName = email.replace(/[@.]/g, '_');
+  const lockFileName = useremail.replace(/[@.]/g, '_');
   const fileMutex = new _fileMutex.default((0, _checkAuthDirectory.getLockDirectoryPath)(), lockFileName, _fileMutexConfig.LOGIN_MUTEX_TIMEOUT);
   try {
     await fileMutex.acquire();
@@ -30,13 +29,7 @@ async function performLoginSteps({
     await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
     const isAlreadyLoggedIn = await isLoggedIn(page);
     if (!isAlreadyLoggedIn) {
-      await loginSteps({
-        page,
-        email,
-        password,
-        context,
-        $tags
-      });
+      await (0, _accountLogin.default)(page, useremail, password);
       await page.goto(process.env.domain);
       await isLoggedIn(page);
       await page.context().storageState({
@@ -44,12 +37,12 @@ async function performLoginSteps({
       });
     }
   } catch (error) {
-    console.error(`Error during login for ${email}:`, error);
+    console.error(`Error during login for ${useremail}:`, error);
   } finally {
     try {
       await fileMutex.release();
     } catch (releaseError) {
-      console.error(`Error releasing lock for ${email}:`, releaseError);
+      console.error(`Error releasing lock for ${useremail}:`, releaseError);
     }
   }
 }

package/build/core/playwright/index.js

@@ -1,24 +1,37 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createBdd = void 0;
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _bddFramework.createBdd;
   }
 });
-Object.defineProperty(exports, "test", {
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _playwrightBdd.test;
+    return _test.expect;
   }
 });
-var _playwrightBdd = require("playwright-bdd");
+exports.test = void 0;
+var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
-let createBdd = function () {
-  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
-};
-exports.createBdd = createBdd;
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _bddFramework.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);

package/build/core/playwright/runner/SpawnRunner.js

@@ -33,9 +33,9 @@ class SpawnRunner extends _Runner.default {
     const {
       tagArgs
     } = this.runnerObj;
-    const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? _path.default.resolve(__dirname, '../', 'setup', 'config-creator.js') : _path.default.resolve(__dirname, '../', '../', '../', '../', 'playwrightConfig.js');
+    const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? _path.default.resolve(__dirname, '../', 'setup', 'config-creator.js') : _path.default.resolve('../', '../', '../', '../', 'playwrightConfig.js');
     const beforeCommand = 'node';
-    const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
+    const bddGenPath = _path.default.resolve(__dirname, '../', '../', '../', 'bdd-framework', 'cli', 'index.js');
     const beforeArgs = [bddGenPath, '-c', require.resolve(configPath)];
     if (tagArgs) {
       beforeArgs.push('--tags');

package/build/core/playwright/setup/config-creator.js

@@ -25,8 +25,7 @@ const {
   featureFilesFolder,
   stepDefinitionsFolder,
   testIdAttribute,
-  globalTimeout,
-  customReporter
+  globalTimeout
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -40,19 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const use = {
+const testOptions = (0, _configUtils.getTestUseOptions)({
   trace,
   video,
   viewport,
   testIdAttribute
-};
-let reporter = [['html', {
-  outputFolder: reportPath,
-  open: openReportOn
-}], ['list'], ['./custom-reporter.js']];
-if (customReporter) {
-  reporter = [customReporter, ...reporter];
-}
+});
 
 /**
  * Playwright configuration object
@@ -65,12 +57,15 @@ function getPlaywrightConfig() {
     globalTimeout: globalTimeout || 3600000,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
     fullyParallel: true,
-    reporter,
+    reporter: [['html', {
+      outputFolder: reportPath,
+      open: openReportOn
+    }], ['list'], ['./custom-reporter.js']],
     timeout: testTimeout,
     expect: {
       timeout: expectTimeout
     },
-    use,
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

package/build/core/playwright/setup/config-utils.js

@@ -7,12 +7,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
+exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _playwrightBdd = require("playwright-bdd");
+var _bddFramework = require("../../../bdd-framework");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -146,15 +148,30 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
-    features: getPathsForFeatureFiles(cwd),
-    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
-    importTestFrom: require.resolve('../fixtures.js'),
+  return bddMode ? (0, _bddFramework.defineBddConfig)({
+    paths: getPathsForFeatureFiles(cwd),
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
-    disableWarnings: {
-      importTestFrom: true
-    },
     publish: true
   }) : _path.default.join(cwd, 'uat');
+}
+function getTestUseOptions({
+  viewport,
+  trace,
+  video,
+  testIdAttribute
+}) {
+  let defaultTestuseOptions = {
+    viewport,
+    testIdAttribute,
+    trace: trace ? 'on' : 'off',
+    video: video ? {
+      mode: 'on',
+      size: {
+        ...viewport
+      }
+    } : 'off'
+  };
+  return defaultTestuseOptions;
 }

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((0, _rootPath.getExecutableBinaryPath)('bddgen'));
+  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');

package/build/decorators.d.ts

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

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("playwright-bdd/decorators");
+var _decorators = require("./bdd-framework/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/auth-setup-sample.js

@@ -1,21 +1,73 @@
 /* eslint-disable no-console */
 import { test as setup, expect } from '@zohodesk/testinglibrary';
-import {
-  performLoginSteps,
-  getDefaultActor
-} from '@zohodesk/testinglibrary/helpers';
+import path from 'path';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { getAuthFileDirectory } from '../../core/playwright';
+import { Logger } from '../../utils/logger';
 
-const user = getDefaultActor();
+const userdata = require('./authUsers.json');
 
-async function verifyPageIsLoaded(page) {
-  //Implement your validation steps here
-  //Refer desk_client_app auth.setup.js
-  return true;
+const authContent = { cookies: [] };
+
+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 });
 }
 
-setup(`${user.edition} - Authentication`, async ({ page }) => {
+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);
 
-  //Implement performLoginSteps here
-  const { email, password } = user;
-  await performLoginSteps({ },verifyPageIsLoaded );
-});
+        await page.context().storageState({ path: authFile });
+      }
+    }
+  });
+});

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

@@ -0,0 +1,9 @@
+[
+    {
+        "useremail": "/ user name /",
+        "password": "/ password /",
+        "description": "/ description/",
+        "filename": "user.json",
+        "locator": "/ selector to identify page has been loaded completely /"
+    }
+]

package/build/setup-folder-structure/samples/env-config-sample.json

@@ -0,0 +1,21 @@
+{
+  "dev": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name",
+    "devURL": "Provide your devURL here"
+  },
+  "prod": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  },
+  "k8test": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  }
+}

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

@@ -10,9 +10,8 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
 function getScriptsToBeAdded() {
   return {
-    "uat": "ZDTestingFramework test --mode=dev --headed",
-    "uat-debug": "ZDTestingFramework test --mode=dev --debug",
-    "uat-validate": "ZDTestingFramework validate",
+    "uat": "ZDTestingFramework test --mode=prod --headed",
+    "uat-debug": "ZDTestingFramework test --mode=prod --debug",
     "uat-report": "ZDTestingFramework report --port=9009",
     "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
   };
@@ -72,6 +71,7 @@ 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 ....');
     } catch (err) {
       _logger.Logger.error(err);
@@ -84,21 +84,8 @@ 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 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);
+    _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);
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
   }