@zohodesk/testinglibrary 0.3.5-experimental → 0.3.7-experimental

package/build/core/playwright/configuration/ConfigurationHelper.js

@@ -12,16 +12,9 @@ var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _mergeObjects = require("../helpers/mergeObjects");
 var _fs = require("fs");
 const Configuration = require("./Configuration");
-function checkForDeprecatedKeys(configKey) {
-  let deprecatedConfigInUatConfigFile = ['mode'];
-  if (deprecatedConfigInUatConfigFile.includes(configKey)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
-  }
-}
 function combineConfiguration(defaultConfig, userConfiguration) {
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
-    checkForDeprecatedKeys(configKey);
     let configValue = userConfiguration[configKey];
     if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
@@ -33,12 +26,12 @@ function combineConfiguration(defaultConfig, userConfiguration) {
   });
   return (0, _mergeObjects.mergeObjects)(defaultConfig, configurationObj);
 }
-function getApplicationConfig() {
+function getApplicationConfig(mode) {
   let filePath = "";
   try {
-    filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+    filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)(mode));
     if (!(0, _fs.existsSync)(filePath)) {
-      throw new Error("catch error");
+      throw new Error("Exception while getting the uat file from the application - " + filePath);
     }
     const config = require(filePath);
     return config;

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

@@ -10,7 +10,6 @@ var _path = _interopRequireDefault(require("path"));
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _logger = require("../../utils/logger");
 var _getUsers = require("./helpers/auth/getUsers");
-var _readConfigFile = require("./readConfigFile");
 function setEnvironmentVariables(configJSON) {
   for (const key in configJSON) {
     process.env[key] = configJSON[key];

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

@@ -33,12 +33,17 @@ function getDefaultActorConf() {
   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.`);
+  const modeSettingsFile = `conf/${getRunMode()}/settings.json`;
+  const filePath = _path.default.join(uatDirectory, modeSettingsFile);
+  try {
+    if (!(0, _fs.existsSync)(filePath)) {
+      const defaultSettingsFile = _path.default.join(uatDirectory, `conf/default/settings.json`);
+      return require(defaultSettingsFile);
+    }
+    return require(filePath);
+  } catch (error) {
+    throw new Error(`${defaultSettingFile} ${filePath} both files are missing.`);
   }
-  return require(filePath);
 }
 function getDefaultActor() {
   const {
@@ -52,18 +57,25 @@ function getListOfActors() {
     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.`);
+  let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
+  if (!(0, _fs.existsSync)(configFile)) {
+    configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
+  }
+  try {
+    return require(configFile);
+  } catch (error) {
+    throw new Error(`Error loading actor configuration from ${configFile}`);
   }
-  return require(filePath);
 }
 function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
+  const actorsData = getListOfActors();
+  if (!actorsData || !actorsData.editions) {
+    throw new Error("The actors data is missing.");
+  }
   const {
     editions: userdata,
     beta: betaPortals
-  } = getListOfActors();
+  } = actorsData;
   const defaultConf = getDefaultActorConf();
   const edition = preferedEdition || defaultConf.edition;
   const profile = preferredProfile || defaultConf.profile;

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

@@ -9,8 +9,14 @@ exports.getReportFileName = getReportFileName;
 exports.getUATFileName = getUATFileName;
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
-function getUATFileName() {
-  return 'uat.config.js';
+var _auth = require("./auth");
+function getUATFileName(mode) {
+  mode = mode || (0, _auth.getRunMode)();
+  const uatConfFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/uat.config.js`);
+  if (_fs.default.existsSync(uatConfFilePath)) {
+    return uatConfFilePath;
+  }
+  return _path.default.resolve(process.cwd(), `uat.config.js`);
 }
 function getEnvConfigFilePath(mode) {
   const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);
@@ -18,7 +24,7 @@ function getEnvConfigFilePath(mode) {
   if (_fs.default.existsSync(confFilePath)) {
     return `uat/conf/${mode}/settings.json`;
   }
-  return `uat/env-config.json`;
+  return `uat/conf/default/settings.json`;
 }
 function getReportFileName() {
   return `test-summary.json`;

package/build/core/playwright/readConfigFile.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.generateConfigFromFile = generateConfigFromFile;
-exports.getApplicationConfig = getApplicationConfig;
 exports.getAuthFilePath = getAuthFilePath;
 exports.getDefaultConfig = getDefaultConfig;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
@@ -14,7 +13,6 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _mergeObjects = require("./helpers/mergeObjects");
-var _Configuration = require("./configuration/Configuration");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
@@ -35,26 +33,18 @@ function getDefaultConfig() {
       height: 720
     },
     debug: false,
-    mode: process.env.mode || 'dev',
+    testIdAttribute: 'data-testid',
     additionalPages: {},
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
-    testIdAttribute: 'data-testid',
     testSetup: {},
     editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
-function checkForDeprecatedKeys(configKey) {
-  let deprecatedConfigInUatConfigFile = ['mode'];
-  if (deprecatedConfigInUatConfigFile.includes(configKey)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
-  }
-}
 function combineDefaultConfigWithUserConfig(userConfiguration) {
   let defaultConfig = getDefaultConfig();
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
-    checkForDeprecatedKeys(configKey);
     let configValue = userConfiguration[configKey];
     if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
@@ -113,11 +103,15 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  *
  * @returns {UserConfig}
  */
+
+function getConfigFilePath() {
+  return _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+}
 function generateConfigFromFile() {
   if (cachedConfig !== null) {
     return cachedConfig; // If cached, return the cached configuration
   }
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  const filePath = getConfigFilePath();
   if ((0, _fs.existsSync)(filePath)) {
     /** @type {UserConfig} */
     const config = require(filePath);
@@ -127,16 +121,8 @@ function generateConfigFromFile() {
   }
   return {};
 }
-function getApplicationConfig() {
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
-  if ((0, _fs.existsSync)(filePath)) {
-    const config = require(filePath);
-    return config;
-  }
-  return {};
-}
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  const filePath = getConfigFilePath();
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

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

@@ -103,27 +103,25 @@ function main() {
   const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
 
   // overriding the application config's from project
-  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)()));
-  const {
-    isAuthMode,
-    editionOrder
-  } = uatConfig.getAll();
+
   const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
   const mode = userArgConfig.get("mode");
-  (0, _envInitializer.initializeEnvConfig)(mode, isAuthMode);
+  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)(mode)));
 
   // overriding the user config's from CLI
-  // const userArgConfig = new Configuration( UserArgs.parseToObject(process.argv.slice(2)) );
   uatConfig.addAll(userArgConfig);
-
-  //This is only used for pass the user arguments to need places in legacy code. We need to rewamp that also.
-  const userArgsObject = userArgConfig.getAll();
-  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
   const {
+    isAuthMode,
+    editionOrder,
     debug,
     bddMode = false,
     headless = false
   } = uatConfig.getAll();
+  (0, _envInitializer.initializeEnvConfig)(mode, isAuthMode);
+
+  //This is only used for pass the user arguments to need places in legacy code. We need to rewamp that also.
+  const userArgsObject = userArgConfig.getAll();
+  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
   const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
   const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
   const command = playwrightPath;

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

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _configFileNameProvider = require("../../../../../core/playwright/helpers/configFileNameProvider");
+jest.mock('fs');
+jest.mock('path');
+const mockCwd = '/mock/current/directory';
+_path.default.resolve = jest.fn();
+process.cwd = jest.fn(() => mockCwd);
+describe('getUATFileName', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('return the pipeline matched config files for pipeline matched files exists', () => {
+    const mode = 'cd';
+    const mockPath = `${mockCwd}/uat/conf/${mode}/uat.config.js`;
+    _fs.existsSync.mockReturnValue(true);
+    _path.default.resolve.mockImplementation((...args) => args.join('/'));
+    const result = (0, _configFileNameProvider.getUATFileName)(mode);
+    expect(_fs.existsSync).toHaveBeenCalledWith(mockPath);
+    expect(result).toBe(mockPath);
+  });
+  test('return the default config files for pipeline matched files not exists', () => {
+    const mode = 'ci';
+    const defaultPath = `${mockCwd}/uat.config.js`;
+    _fs.existsSync.mockReturnValue(false);
+    _path.default.resolve.mockImplementation((...args) => args.join('/'));
+    const result = (0, _configFileNameProvider.getUATFileName)(mode);
+    expect(_fs.existsSync).toHaveBeenCalledWith(`${mockCwd}/uat/conf/${mode}/uat.config.js`);
+    expect(result).toBe(defaultPath);
+  });
+});

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.3.4-experimental",
+  "version": "0.3.7-experimental",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.3.5-experimental",
+  "version": "0.3.7-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {

package/build/test/Test.js

@@ -1,63 +0,0 @@
-"use strict";
-
-// const UserArgs = require("../core/playwright/configuration/UserArgs");
-// const Configuration = require("../core/playwright/configuration/Configuration");
-
-// function main() {
-//     const config = new Configuration();
-//     config.set("reportPath", "home/reports");
-
-//     const fwConfig = new Configuration();
-//     fwConfig.set("browser", "chrome");
-//     fwConfig.set("trace", true);
-//     config.setFrameworkConfig(fwConfig);
-
-//     const appConfig = new Configuration();
-//     appConfig.set("environment", "CI");
-//     appConfig.set("edition", "test");
-//     config.setApplicationConfig(appConfig);
-
-//     const uaConfig = new Configuration();
-//     uaConfig.set("debug", true);
-//     uaConfig.set("headless", true);
-//     config.setUserArguments(uaConfig);
-
-//     console.log("default Config : ", config.get("reportPath"));
-//     console.log("framework Config : ", config.getFrameworkConfig()?.get("browser"));
-//     console.log("application Config : ", config.getApplicationConfig()?.get("environment"));
-//     console.log("User arguments : ", config.getUserArguments()?.get("debug"));
-// }
-
-// function test(){
-//    const prop = new Map();
-//    prop.set("browser","durai");
-
-//    const config = Configuration(prop);
-//    console.log("output :" +config.get("browser"));
-// //    console.log(prop);
-
-// }
-
-// function testParseToArgs(){
-//     const prop = new Map();
-//     prop.set("browser","durai");
-//     const userArgsObject = UserArgs.parseToArgs(prop);
-//     console.log(userArgsObject);
-// }
-
-function throwError() {
-  throw new Error("catch error");
-}
-function catchError() {
-  try {
-    throw new Error("catch error");
-  } catch (err) {
-    console.log(err.message);
-  }
-}
-
-// throwError();
-catchError();
-// testParseToArgs();
-
-// main();