@zohodesk/testinglibrary 0.4.98-n18-experimental → 0.4.99-n18-experimental

package/.gitlab-ci.yml

@@ -188,19 +188,19 @@ uat-data_generator:
     paths:
       - examples/uat/playwright-report
 
-uat-search_indexing:
-  stage: uat
-  script:
-    - cd examples
-    - npm install $(npm pack ../../testing-framework | tail -1)
-    - output=$(npm run uat-search_indexing)
-    - echo "$output"
-    - node ../ValidateUATReport.js examples
-
-  artifacts:
-    when: always
-    paths:
-      - examples/uat/playwright-report
+# uat-search_indexing:
+#   stage: uat
+#   script:
+#     - cd examples
+#     - npm install $(npm pack ../../testing-framework | tail -1)
+#     - output=$(npm run uat-search_indexing)
+#     - echo "$output"
+#     - node ../ValidateUATReport.js examples
+
+#   artifacts:
+#     when: always
+#     paths:
+#       - examples/uat/playwright-report
 
 
 

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

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UAT_CONFIG_FILE = exports.TEST_SUMMARY_FILE = exports.STAGE_CONFIG_MAP_FILE = exports.SETTINGS_FILE = exports.INDEX_FILE = exports.DEFAULT_CONFIG_DIR = exports.BETA_DIR = exports.ACTOR_DIR = void 0;
+const DEFAULT_CONFIG_DIR = exports.DEFAULT_CONFIG_DIR = 'default';
+const BETA_DIR = exports.BETA_DIR = 'beta';
+const ACTOR_DIR = exports.ACTOR_DIR = 'actors';
+const UAT_CONFIG_FILE = exports.UAT_CONFIG_FILE = 'uat.config.js';
+const INDEX_FILE = exports.INDEX_FILE = 'index.js';
+const SETTINGS_FILE = exports.SETTINGS_FILE = 'settings.json';
+const TEST_SUMMARY_FILE = exports.TEST_SUMMARY_FILE = 'test-summary.json';
+const STAGE_CONFIG_MAP_FILE = exports.STAGE_CONFIG_MAP_FILE = 'uat/conf-path-map.properties';

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

@@ -21,17 +21,13 @@ function addHelperLogsForEnvInitialization() {
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `Going to use default mode as dev`);
 }
 function initializeEnvConfig(stage, mode, isAuthMode) {
+  if (!mode) {
+    addHelperLogsForEnvInitialization();
+    mode = 'dev';
+  }
+  const configFilePath = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), `./${(0, _configFileNameProvider.getEnvConfigFilePath)(stage, mode)}`));
   try {
-    if (!mode) {
-      addHelperLogsForEnvInitialization();
-      mode = 'dev';
-    }
-    if (!stage) {
-      stage = 'uat';
-      _logger.Logger.log(_logger.Logger.INFO_TYPE, `No stage specified. Using default stage as 'uat'`);
-    }
-    const configFile = (0, _fs.readFileSync)(_path.default.resolve(process.cwd(), `./${(0, _configFileNameProvider.getEnvConfigFilePath)(stage, mode)}`));
-    const configJSON = JSON.parse(configFile);
+    const configJSON = JSON.parse(configFilePath);
     setEnvironmentVariables({
       ...configJSON,
       stage,
@@ -43,6 +39,6 @@ function initializeEnvConfig(stage, mode, isAuthMode) {
     }
   } catch (err) {
     _logger.Logger.error(err);
-    throw new Error(`Config File Not Exists. Please provide a config file to initialize the environment variables`);
+    throw new Error(`Config File Not Exists. Please provide a ${configFilePath} to initialize the environment variables`);
   }
 }

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

@@ -13,8 +13,9 @@ exports.isCI = isCI;
 exports.isDevelopmentSetup = isDevelopmentSetup;
 var _path = _interopRequireDefault(require("path"));
 var _fs = require("fs");
-var _resolveStageConfigPath = require("./../resolveStageConfigPath");
+var _configPathResolver = require("../configPathResolver");
 var _ConfigurationHelper = require("./../../configuration/ConfigurationHelper");
+var _configFiles = require("../../constants/configFiles");
 /* eslint-disable global-require */
 function getRunMode() {
   let {
@@ -32,12 +33,12 @@ function isDevelopmentSetup() {
 }
 function getDefaultActorConf() {
   const stage = (0, _ConfigurationHelper.getRunStage)();
-  const stageConfig = (0, _resolveStageConfigPath.resolveStageConfigPath)(stage);
-  const modeSettingsFile = `${stageConfig}/${getRunMode()}/settings.json`;
+  const stagePath = (0, _configPathResolver.getConfigPath)(stage);
+  const modeSettingsFile = `${stagePath}/${getRunMode()}/${_configFiles.SETTINGS_FILE}`;
   const filePath = _path.default.join(_path.default.resolve(process.cwd(), modeSettingsFile));
   try {
     if (!(0, _fs.existsSync)(filePath)) {
-      const defaultSettingsFile = _path.default.join(_path.default.resolve(process.cwd(), `${stage}/conf/default/settings.json`));
+      const defaultSettingsFile = _path.default.join(_path.default.resolve(process.cwd(), `${stagePath}/${_configFiles.DEFAULT_CONFIG_DIR}/${_configFiles.SETTINGS_FILE}`));
       return require(defaultSettingsFile);
     }
     return require(filePath);
@@ -55,15 +56,15 @@ function getDefaultActor() {
 function getListOfActors(betaFeature) {
   const mode = getRunMode();
   const stage = (0, _ConfigurationHelper.getRunStage)();
-  const stageConfig = (0, _resolveStageConfigPath.resolveStageConfigPath)(stage);
-  let configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stageConfig}/${mode}/actors/index.js`));
+  const stagePath = (0, _configPathResolver.getConfigPath)(stage);
+  let configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stagePath}/${mode}/${_configFiles.ACTOR_DIR}/${_configFiles.INDEX_FILE}`));
   let betaReference = mode;
   if (!(0, _fs.existsSync)(configFile)) {
-    configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stage}/conf/default/actors/index.js`));
+    configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stagePath}/${_configFiles.DEFAULT_CONFIG_DIR}/${_configFiles.ACTOR_DIR}/${_configFiles.INDEX_FILE}`));
     betaReference = "default";
   }
   if (betaFeature) {
-    configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stageConfig}/${betaReference}/actors/beta/${betaFeature}/index.js`));
+    configFile = _path.default.join(_path.default.resolve(process.cwd(), `${stagePath}/${betaReference}/${_configFiles.ACTOR_DIR}/${_configFiles.BETA_DIR}/${betaFeature}/${_configFiles.INDEX_FILE}`));
     if (!(0, _fs.existsSync)(configFile)) {
       throw new Error(`There is no beta feature configured with the name "${betaFeature}"`);
     }

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

@@ -11,27 +11,28 @@ var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _auth = require("./auth");
 var _ConfigurationHelper = require("./../configuration/ConfigurationHelper");
-var _resolveStageConfigPath = require("./resolveStageConfigPath");
+var _configPathResolver = require("./configPathResolver");
+var _configFiles = require("../constants/configFiles");
 function getUATFileName(stage, mode) {
   stage = stage || (0, _ConfigurationHelper.getRunStage)();
   mode = mode || (0, _auth.getRunMode)();
-  const stageConfig = (0, _resolveStageConfigPath.resolveStageConfigPath)(stage);
-  const uatConfFilePath = _path.default.resolve(process.cwd(), `${stageConfig}/${mode}/uat.config.js`);
+  const stagePath = (0, _configPathResolver.getConfigPath)(stage);
+  const uatConfFilePath = _path.default.resolve(process.cwd(), `${stagePath}/${mode}/${_configFiles.UAT_CONFIG_FILE}`);
   if (_fs.default.existsSync(uatConfFilePath)) {
     return uatConfFilePath;
   }
   ;
-  return _path.default.resolve(process.cwd(), `${stage}/conf/default/uat.config.js`);
+  return _path.default.resolve(process.cwd(), `${stagePath}/${_configFiles.DEFAULT_CONFIG_DIR}/${_configFiles.UAT_CONFIG_FILE}`);
 }
 function getEnvConfigFilePath(stage, mode) {
-  const stageConfig = (0, _resolveStageConfigPath.resolveStageConfigPath)(stage);
-  const confFilePath = `${stageConfig}/${mode}/settings.json`;
+  const stagePath = (0, _configPathResolver.getConfigPath)(stage);
+  const confFilePath = `${stagePath}/${mode}/${_configFiles.SETTINGS_FILE}`;
   // TODO: Actors Mode as config
   if (_fs.default.existsSync(confFilePath)) {
     return confFilePath;
   }
-  return `${stage}/conf/default/settings.json`;
+  return `${stagePath}/${_configFiles.DEFAULT_CONFIG_DIR}/${_configFiles.SETTINGS_FILE}`;
 }
 function getReportFileName() {
-  return `test-summary.json`;
+  return `${_configFiles.TEST_SUMMARY_FILE}`;
 }

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

@@ -0,0 +1,36 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConfigPath = getConfigPath;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _propertiesReader = _interopRequireDefault(require("properties-reader"));
+var _logger = require("../../../utils/logger");
+var _configFiles = require("../constants/configFiles");
+//This function reads a properties file and returns the entire properties
+
+function readPropertiesFile(relativeFilePath) {
+  const filePath = _path.default.resolve(process.cwd(), relativeFilePath);
+  if (!_fs.default.existsSync(filePath)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Properties file ${filePath} not found at path. Using default configurations.`);
+    return {
+      get: () => 'uat/conf'
+    };
+  }
+  const properties = (0, _propertiesReader.default)(filePath);
+  return properties;
+}
+
+// This function return the value for the passed arguments key
+
+function getConfigPath(stage) {
+  const props = readPropertiesFile(_configFiles.STAGE_CONFIG_MAP_FILE);
+  const configPath = props.get(stage);
+  if (!configPath) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `No config mapping found for stage: "${stage}"`);
+  }
+  return configPath;
+}

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

@@ -4,13 +4,13 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _configFileNameProvider = require("../../../../../core/playwright/helpers/configFileNameProvider");
-var _resolveStageConfigPath = require("../../../../../core/playwright/helpers/resolveStageConfigPath");
+var _configPathResolver = require("../../../../../core/playwright/helpers/configPathResolver");
 jest.mock('fs');
 jest.mock('path', () => ({
   resolve: jest.fn()
 }));
-jest.mock("../../../../../core/playwright/helpers/resolveStageConfigPath", () => ({
-  resolveStageConfigPath: jest.fn()
+jest.mock("../../../../../core/playwright/helpers/configPathResolver", () => ({
+  getConfigPath: jest.fn()
 }));
 const mockCwd = '/mock/current/directory';
 _path.default.resolve = jest.fn();
@@ -23,11 +23,11 @@ describe('getUATFileName', () => {
   test('should return pipeline-matched config path when file exists', () => {
     const stage = 'uat';
     const mode = 'cd';
-    _resolveStageConfigPath.resolveStageConfigPath.mockReturnValue(`${stage}/conf`);
+    _configPathResolver.getConfigPath.mockReturnValue(`${stage}/conf`);
     _fs.existsSync.mockReturnValue(true);
     const expected = `${process.cwd()}/${stage}/conf/${mode}/uat.config.js`;
     const result = (0, _configFileNameProvider.getUATFileName)(stage, mode);
-    expect(_resolveStageConfigPath.resolveStageConfigPath).toHaveBeenCalledWith(stage);
+    expect(_configPathResolver.getConfigPath).toHaveBeenCalledWith(stage);
     expect(_fs.existsSync).toHaveBeenCalledWith(expected);
     expect(result).toBe(expected);
   });
@@ -46,7 +46,7 @@ describe('getUATFileName', () => {
     const stageConfigPath = 'uat/conf';
     const nonExistingPath = `${mockCwd}/${stageConfigPath}/${mockMode}/uat.config.js`;
     const expectedDefaultPath = `${mockCwd}/${mockStage}/conf/default/uat.config.js`;
-    _resolveStageConfigPath.resolveStageConfigPath.mockReturnValue(stageConfigPath);
+    _configPathResolver.getConfigPath.mockReturnValue(stageConfigPath);
     _fs.existsSync.mockReturnValue(false);
     const result = (0, _configFileNameProvider.getUATFileName)(mockStage, mockMode);
     expect(_fs.existsSync).toHaveBeenCalledWith(nonExistingPath);
@@ -59,15 +59,15 @@ describe('getEnvConfigFilePath', () => {
     _path.default.resolve.mockImplementation((...segments) => segments.join('/'));
   });
   test('should return conf file path when file exists', () => {
-    _resolveStageConfigPath.resolveStageConfigPath.mockReturnValue('uat/conf');
+    _configPathResolver.getConfigPath.mockReturnValue('uat/conf');
     _fs.existsSync.mockReturnValue(true);
     const result = (0, _configFileNameProvider.getEnvConfigFilePath)('uat', 'cd');
-    expect(_resolveStageConfigPath.resolveStageConfigPath).toHaveBeenCalledWith('uat');
+    expect(_configPathResolver.getConfigPath).toHaveBeenCalledWith('uat');
     expect(_fs.existsSync).toHaveBeenCalled();
     expect(result).toBe('uat/conf/cd/settings.json');
   });
   test('should return default path when file does not exist', () => {
-    _resolveStageConfigPath.resolveStageConfigPath.mockReturnValue('uat/conf');
+    _configPathResolver.getConfigPath.mockReturnValue('uat/conf');
     _fs.existsSync.mockReturnValue(false);
     const result = (0, _configFileNameProvider.getEnvConfigFilePath)('uat', 'ci');
     expect(result).toBe('uat/conf/default/settings.json');

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

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _fs = _interopRequireDefault(require("fs"));
+var _propertiesReader = _interopRequireDefault(require("properties-reader"));
+var _configPathResolver = require("../../../../../core/playwright/helpers/configPathResolver");
+var _logger = require("../../../../../utils/logger");
+jest.mock('../../../../../utils/logger', () => ({
+  Logger: {
+    log: jest.fn(),
+    FAILURE_TYPE: 'FAILURE'
+  }
+}));
+jest.mock('fs');
+jest.mock('path');
+jest.mock('properties-reader');
+describe('getConfigPath', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('should return correct stageConfig when mapping exists', () => {
+    const mockProps = {
+      get: jest.fn(() => 'uat/conf')
+    };
+    _propertiesReader.default.mockReturnValue(mockProps);
+    _fs.default.existsSync.mockReturnValue(true);
+    const result = (0, _configPathResolver.getConfigPath)('uat');
+    expect(mockProps.get).toHaveBeenCalledWith('uat');
+    expect(result).toBe('uat/conf');
+    expect(_logger.Logger.log).not.toHaveBeenCalled();
+  });
+  test('should log failure when stage mapping does not exist', () => {
+    const mockProps = {
+      get: jest.fn(() => undefined)
+    };
+    _propertiesReader.default.mockReturnValue(mockProps);
+    _fs.default.existsSync.mockReturnValue(true);
+    const result = (0, _configPathResolver.getConfigPath)('invalidStage');
+    expect(result).toEqual(undefined);
+    expect(_logger.Logger.log).toHaveBeenCalledWith('FAILURE', 'No config mapping found for stage: "invalidStage"');
+  });
+});

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

@@ -4,11 +4,11 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _getUsers = require("../../../../../core/playwright/helpers/auth/getUsers");
-var _resolveStageConfigPath = require("../../../../../core/playwright/helpers/resolveStageConfigPath");
+var _configPathResolver = require("../../../../../core/playwright/helpers/configPathResolver");
 jest.mock('fs');
 jest.mock('path');
-jest.mock('../../../../../core/playwright/helpers/resolveStageConfigPath', () => ({
-  resolveStageConfigPath: jest.fn()
+jest.mock('../../../../../core/playwright/helpers/configPathResolver', () => ({
+  getConfigPath: jest.fn()
 }));
 describe('getListOfActors', () => {
   const stageConfig = 'uat/conf';
@@ -18,7 +18,7 @@ describe('getListOfActors', () => {
     jest.clearAllMocks();
     _path.default.join.mockImplementation((...args) => args.join('/'));
     _path.default.resolve.mockImplementation((...args) => args.join('/'));
-    _resolveStageConfigPath.resolveStageConfigPath.mockReturnValue('uat/conf');
+    _configPathResolver.getConfigPath.mockReturnValue('uat/conf');
   });
   test('throws an error when config file cannot be loaded', () => {
     _fs.default.existsSync.mockReturnValueOnce(true);