@zohodesk/testinglibrary 0.1.8 → 0.1.9-exp-actors

package/build/core/playwright/clear-caches.js

@@ -9,21 +9,32 @@ var _path = _interopRequireDefault(require("path"));
 var _fileUtils = require("../../utils/fileUtils");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
+function deleteAuthFiles(authFilePath) {
+  authFilePath.split('/').pop();
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
+  (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
+}
+function deletePlaywrightReport(reportPath) {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
+  (0, _fileUtils.deleteFolder)(reportPath);
+}
+function deleteGeneratedFeatures() {
+  const featuresGenPath = _path.default.resolve(process.cwd(), 'uat', '.features-gen');
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting generated features at ${featuresGenPath}`);
+  (0, _fileUtils.deleteFolder)(featuresGenPath);
+}
 function clearCaches() {
   try {
     const {
       authFilePath,
       reportPath
     } = (0, _readConfigFile.generateConfigFromFile)();
-    authFilePath.split('/').pop();
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
-    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
-    (0, _fileUtils.deleteFolder)(reportPath);
-    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), 'uat', '.features-gen'));
-    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared');
+    deleteAuthFiles(authFilePath);
+    deletePlaywrightReport(reportPath);
+    deleteGeneratedFeatures();
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared. Now you can try running npm run uat');
   } catch (err) {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies');
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies. Try manually delete folder uat/playwright and uat/playwright-report');
   }
 }
 var _default = exports.default = clearCaches;

package/build/core/playwright/codegen.js

@@ -9,11 +9,11 @@ var _child_process = require("child_process");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _rootPath = require("../../utils/rootPath");
-const userArgs = process.argv.slice(3);
-const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-const command = playwrightPath;
-const args = ['codegen'].concat(userArgs);
 function generateCodegen() {
+  const domainUrl = process.argv.slice(3);
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const args = ['codegen'].concat(domainUrl);
   const childProcess = (0, _child_process.spawn)(command, args, {
     stdio: 'inherit'
   });

package/build/core/playwright/constants/browserTypes.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BROWSER_PROJECT_MAPPING = void 0;
+const BROWSER_PROJECT_MAPPING = exports.BROWSER_PROJECT_MAPPING = {
+  CHROME: 'chromium',
+  EDGE: 'Microsoft Edge',
+  FIREFOX: 'firefox',
+  SAFARI: 'webkit'
+};

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

package/build/core/playwright/env-initializer.js

@@ -7,15 +7,19 @@ Object.defineProperty(exports, "__esModule", {
 exports.initializeEnvConfig = initializeEnvConfig;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
+var _configFileNameProvider = require("./helpers/configFileNameProvider");
+function setEnvironmentVariables(mode, configJSON) {
+  process.env.mode = mode;
+  for (const key in configJSON) {
+    process.env[key] = configJSON[key];
+  }
+}
 function initializeEnvConfig(mode = 'dev') {
   try {
-    const configFile = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), './uat/env-config.json'));
+    const configFile = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), `./${(0, _configFileNameProvider.getEnvConfigFilePath)(mode)}`));
     const configJSON = JSON.parse(configFile);
-    process.env.mode = mode;
-    for (const key in configJSON[mode]) {
-      process.env[key] = configJSON[mode][key];
-    }
+    setEnvironmentVariables(mode, configJSON);
   } catch (err) {
-    throw new Error('Config File Not Exists. Please provide a config file to intiailize the environment variables');
+    throw new Error(`Config File Not Exists. Please provide a config file ${(0, _configFileNameProvider.getEnvConfigFilePath)(mode)} to intiailize the environment variables`);
   }
 }

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

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _getUrlOrigin = _interopRequireDefault(require("./getUrlOrigin"));
+async function accountLogin(page, useremail, password) {
+  await page.locator('#login_id').fill(useremail);
+  await page.locator('#nextbtn').click();
+  await page.locator('#password').fill(password);
+  await page.locator('#nextbtn').click();
+  const domainUrlOrigin = (0, _getUrlOrigin.default)(process.env.domain);
+  await page.waitForNavigation();
+  await Promise.race([page.waitForURL(`${domainUrlOrigin}/**`), page.waitForURL('**/announcement/**')]);
+}
+var _default = exports.default = accountLogin;

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

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAuthFileDirectory = getAuthFileDirectory;
+exports.loadCookiesIfPresent = loadCookiesIfPresent;
+exports.verifyIfCookieFileExists = verifyIfCookieFileExists;
+var _path = _interopRequireDefault(require("path"));
+var _fs = require("fs");
+var _readConfigFile = require("../../readConfigFile");
+/* eslint-disable no-console */
+
+const authContent = {
+  cookies: []
+};
+function getAuthFileDirectory() {
+  const {
+    uatDirectory
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  return _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.auth'));
+}
+function verifyIfCookieFileExists(authFile) {
+  const authDirectory = getAuthFileDirectory();
+  if (!(0, _fs.existsSync)(authDirectory)) {
+    console.log('Creating auth directory for the first time setup...');
+    (0, _fs.mkdirSync)(authDirectory, {
+      recursive: true
+    });
+  }
+  if (!(0, _fs.existsSync)(authFile)) {
+    console.log('creating auth file..');
+    (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
+  }
+}
+function convertCookiesToParse(cookies, authFilePath) {
+  try {
+    return JSON.parse(cookies);
+  } catch (err) {
+    throw new Error(` Error while parsing cookies ${err} \n${_path.default.resolve(process.cwd(), authFilePath)} File is Empty`);
+    // process.exit()
+  }
+}
+async function loadCookiesIfPresent(page, authFile) {
+  verifyIfCookieFileExists(authFile);
+  const cookies = (0, _fs.readFileSync)(authFile);
+  const parsedCookies = convertCookiesToParse(cookies, authFile);
+  await page.context().addCookies(parsedCookies.cookies === undefined ? [] : parsedCookies.cookies);
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function getUrlOrigin(url) {
+  const {
+    origin
+  } = new URL(url);
+  return origin;
+}
+var _default = exports.default = getUrlOrigin;

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

@@ -0,0 +1,111 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getDefaultActor = getDefaultActor;
+exports.getListOfActors = getListOfActors;
+exports.getRunMode = getRunMode;
+exports.getUserForSelectedEditionAndProfile = getUserForSelectedEditionAndProfile;
+exports.isCI = isCI;
+exports.isDevelopmentSetup = isDevelopmentSetup;
+var _path = _interopRequireDefault(require("path"));
+var _fs = require("fs");
+var _readConfigFile = require("../../readConfigFile");
+/* eslint-disable global-require */
+function getRunMode() {
+  let {
+    mode
+  } = process.env;
+  return mode || 'dev';
+}
+function isCI() {
+  const mode = getRunMode();
+  return mode === 'CI' || mode === 'ci';
+}
+function isDevelopmentSetup() {
+  const mode = getRunMode();
+  return mode === 'DEV' || mode === 'dev';
+}
+function getDefaultActor() {
+  const {
+    uatDirectory
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  const defaultSettingFile = `conf/${getRunMode()}/settings.json`;
+  const filePath = _path.default.join(uatDirectory, defaultSettingFile);
+  if (!(0, _fs.existsSync)(filePath)) {
+    throw new Error(`${defaultSettingFile} is missing.`);
+  }
+  return require(filePath);
+}
+function getListOfActors() {
+  const {
+    uatDirectory
+  } = (0, _readConfigFile.generateConfigFromFile)();
+  const mode = getRunMode();
+  const configFile = `conf/${mode}/actors/index`;
+  const filePath = _path.default.join(uatDirectory, configFile);
+  if (!(0, _fs.existsSync)(filePath + '.js')) {
+    throw new Error(`${configFile}.js is missing.`);
+  }
+  return require(filePath);
+}
+function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
+  const {
+    editions: userdata,
+    beta: betaPortals
+  } = getListOfActors();
+  const primaryUser = getDefaultActor();
+  const edition = preferedEdition || primaryUser.edition;
+  const profile = preferredProfile || primaryUser.profile;
+  let selectedProfile = {};
+  if (betaFeature && betaFeature !== null) {
+    if (!betaPortals.hasOwnProperty(betaFeature)) {
+      throw new Error(`There is no "${betaFeature}" beta feature configured.`);
+    }
+    const betaEdition = betaPortals[betaFeature].find(portal => portal.edition === edition);
+    if (!betaEdition) {
+      throw new Error(`There is no "${edition}" edition configured in "${betaFeature}" beta feature.`);
+    }
+    const {
+      profiles: betaProfiles,
+      ...betaEditionData
+    } = betaEdition;
+    selectedProfile = betaProfiles.find(user => user.profile === profile);
+    if (!selectedProfile) {
+      throw new Error(`There is no "${profile}" configured in edition of "${edition}" in "${betaFeature}" beta features.`);
+    }
+    return {
+      ...betaEditionData,
+      ...selectedProfile
+    };
+  }
+
+  // TODO: We are returning the first data from array. We need to check the possiblity of having multiple users for same profile and possibly round robin
+  // For this we need to get the data from ci environment.
+  let testingPortal = null;
+  if (!userdata.hasOwnProperty(edition)) {
+    throw new Error(`There is no "${edition}" edition configured.`);
+  }
+  if (testDataPortal !== null) {
+    testingPortal = userdata[edition].find(editionData => editionData.orgName === testDataPortal);
+    if (!testingPortal) {
+      throw new Error(`There is no "${testDataPortal}" portal configured in "${edition}" edition.`);
+    }
+  } else {
+    testingPortal = userdata[edition] ? userdata[edition][0] : {};
+  }
+  const {
+    profiles,
+    ...editionData
+  } = testingPortal;
+  selectedProfile = profiles.find(user => user.profile === profile);
+  if (!selectedProfile) {
+    throw new Error(`There is no "${profile}" profile configured in "${edition}" edition.`);
+  }
+  return {
+    ...editionData,
+    ...selectedProfile
+  };
+}

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

@@ -0,0 +1,70 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "accountLogin", {
+  enumerable: true,
+  get: function () {
+    return _accountLogin.default;
+  }
+});
+Object.defineProperty(exports, "getDefaultActor", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getDefaultActor;
+  }
+});
+Object.defineProperty(exports, "getListOfActors", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getListOfActors;
+  }
+});
+Object.defineProperty(exports, "getRunMode", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getRunMode;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.isCI;
+  }
+});
+Object.defineProperty(exports, "isDevelopmentSetup", {
+  enumerable: true,
+  get: function () {
+    return _getUsers.isDevelopmentSetup;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _checkAuthCookies.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _loginSteps.default;
+  }
+});
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _checkAuthCookies.verifyIfCookieFileExists;
+  }
+});
+var _accountLogin = _interopRequireDefault(require("./accountLogin"));
+var _checkAuthCookies = require("./checkAuthCookies");
+var _getUsers = require("./getUsers");
+var _loginSteps = _interopRequireDefault(require("./loginSteps"));

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

@@ -0,0 +1,36 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _accountLogin = _interopRequireDefault(require("./accountLogin"));
+var _checkAuthCookies = require("./checkAuthCookies");
+/* eslint-disable no-console */
+
+async function performLoginSteps({
+  page,
+  authFilePrefix,
+  useremail,
+  password
+}, isLoggedIn) {
+  const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
+  await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
+  await page.goto(process.env.domain);
+  await page.waitForNavigation();
+  const loginStatus = await isLoggedIn(page);
+  if (!loginStatus) {
+    await (0, _accountLogin.default)(page, useremail, password);
+    await page.goto(process.env.domain);
+
+    // await page.waitForLoadState();
+
+    await isLoggedIn(page);
+    await page.context().storageState({
+      path: authFile
+    });
+  }
+}
+var _default = exports.default = performLoginSteps;

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

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getEnvConfigFilePath = getEnvConfigFilePath;
+exports.getReportFileName = getReportFileName;
+exports.getUATFileName = getUATFileName;
+var _path = _interopRequireDefault(require("path"));
+var _fs = _interopRequireDefault(require("fs"));
+function getUATFileName() {
+  return 'uat.config.js';
+}
+function getEnvConfigFilePath(mode) {
+  const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);
+  if (_fs.default.existsSync(confFilePath)) {
+    return `uat/conf/${mode}/settings.json`;
+  }
+  return `uat/env-config.json`;
+}
+function getReportFileName() {
+  return `test-summary.json`;
+}

package/build/core/playwright/helpers/getUserFixtures.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _logger = require("../../../utils/logger");
+var _readConfigFile = require("../readConfigFile");
+function getUserFixtures() {
+  const {
+    additionalPages
+  } = (0, _readConfigFile.generateConfigFromFile)();
+
+  // if (additionalPages.page || additionalPages.context) {
+  //   // Logger.log(
+  //   //   Logger.INFO_TYPE,
+  //   //   'Not allowed to override the page and context fixture. Use Test Setup in uat configuration'
+  //   // );
+  // }
+
+  return additionalPages;
+}
+var _default = exports.default = getUserFixtures;

package/build/core/playwright/helpers/mergeObjects.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeObjects = mergeObjects;
+// Utility function to merge objects using spread operator
+function mergeObjects(obj1, obj2) {
+  return {
+    ...obj1,
+    ...obj2
+  };
+}

package/build/core/playwright/helpers/parseUserArgs.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _cliArgsToObject = require("../../../utils/cliArgsToObject");
+function parseUserArgs() {
+  return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
+}
+var _default = exports.default = parseUserArgs;

package/build/core/playwright/index.js

@@ -5,6 +5,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.When = exports.Then = exports.Given = void 0;
+Object.defineProperty(exports, "accountLogin", {
+  enumerable: true,
+  get: function () {
+    return _index.accountLogin;
+  }
+});
 Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
@@ -17,17 +23,73 @@ Object.defineProperty(exports, "expect", {
     return _test.expect;
   }
 });
+Object.defineProperty(exports, "getDefaultActor", {
+  enumerable: true,
+  get: function () {
+    return _index.getDefaultActor;
+  }
+});
+Object.defineProperty(exports, "getListOfActors", {
+  enumerable: true,
+  get: function () {
+    return _index.getListOfActors;
+  }
+});
+Object.defineProperty(exports, "getRunMode", {
+  enumerable: true,
+  get: function () {
+    return _index.getRunMode;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _index.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _index.isCI;
+  }
+});
+Object.defineProperty(exports, "isDevelopmentSetup", {
+  enumerable: true,
+  get: function () {
+    return _index.isDevelopmentSetup;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _index.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _index.performLoginSteps;
+  }
+});
 exports.test = void 0;
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _index.verifyIfCookieFileExists;
+  }
+});
 var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
 var _readConfigFile = require("./readConfigFile");
 var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _index = require("./helpers/auth/index");
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
 const {
-  additionalPages: userFixtures,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _bddFramework.test : _test.test;
 const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const userFixtures = (0, _getUserFixtures.default)();
 const test = exports.test = base.extend({
   ...buildInFixtures,
   ...userFixtures

package/build/core/playwright/readConfigFile.js

@@ -4,16 +4,17 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.fileName = void 0;
 exports.generateConfigFromFile = generateConfigFromFile;
 exports.getAuthFilePath = getAuthFilePath;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
-const fileName = exports.fileName = 'uat.config.js';
+var _configFileNameProvider = require("./helpers/configFileNameProvider");
+var _mergeObjects = require("./helpers/mergeObjects");
 function getDefaultConfig() {
   return {
+    uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],
     trace: false,
@@ -35,6 +36,7 @@ function getDefaultConfig() {
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
     testIdAttribute: 'data-testid',
+    testSetup: {},
     editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
@@ -51,21 +53,29 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `key - ${configKey} is not yet supported in uat configuration. This will not be used while creating playwright configuration`);
     }
   });
-  return {
-    ...defaultConfig,
-    ...configurationObj
-  };
+  return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
 }
-
 /**
  * @typedef {Object|null} viewportConfig
  * @property {number} width - width of the viewport
- * @property {number} height - height of the viewport 
+ * @property {number} height - height of the viewport
+ */
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+
+/**
+ * @typedef {Object|null} testSetupConfig
+ * @property {any} page - Function that will be called while setting up page fixtures
+ * @property {any} context - Function that will be called while setting up context fixtures
  */
 
 /**
  * Represents the user configuration object.
  * @typedef {Object} UserConfig
+ * @property {string} uatDirectory - Directory in which uat configuration is places.
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
  * @property {boolean} video - video for test cases,
@@ -74,7 +84,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
  * @property {string} authFilePath - File Path where the cookies stored
  * @property {any} browsers: List of browsers
- * @property {string} openReportOn: default Option value (never, on-failure and always) 
+ * @property {string} openReportOn: default Option value (never, on-failure and always)
  * @property {any} reportPath : directory where report is generate
  * @property {boolean} bddMode: Feature files needs to be processed
  * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
@@ -85,15 +95,16 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @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
+ * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
  */
 
 /**
  * Generates a configuration object from a file, if it exists.
  *
  * @returns {UserConfig}
-*/
+ */
 function generateConfigFromFile() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     /** @type {UserConfig} */
     const config = require(filePath);
@@ -103,7 +114,7 @@ function generateConfigFromFile() {
   return {};
 }
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), fileName);
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }