@zohodesk/testinglibrary 0.0.5 → 0.0.6

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

@@ -0,0 +1,100 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = setupProject;
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../utils/logger");
+function getScriptsToBeAdded() {
+  return {
+    "ua-test": "ZDTestingFramework test --mode=prod --headed",
+    "ua-test-debug": "ZDTestingFramework test --mode=prod --debug",
+    "ua-test-ci": "ZDTestingFramework test --mode=prod",
+    "ua-report": "ZDTestingFramework report --port=9009",
+    "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
+  };
+}
+function updatePackageJSONScripts() {
+  const packageJsonPath = _path.default.resolve(process.cwd(), './package.json');
+  if ((0, _fs.existsSync)(packageJsonPath)) {
+    const packageContents = (0, _fs.readFileSync)(packageJsonPath);
+    const configJSON = JSON.parse(packageContents);
+    const {
+      scripts = {}
+    } = configJSON;
+    const modifiedScripts = {
+      ...scripts,
+      ...getScriptsToBeAdded()
+    };
+    const modifiedConfigJSON = {
+      ...configJSON,
+      scripts: modifiedScripts
+    };
+    (0, _fs.writeFileSync)(packageJsonPath, JSON.stringify(modifiedConfigJSON, null, 2));
+  } else {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Unable to find package json. Run init command in the root path of the project.');
+  }
+}
+function createFolderForUAT() {
+  const uatFolder = _path.default.resolve(process.cwd(), 'uat');
+  if ((0, _fs.existsSync)(uatFolder)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Uat Folder already Exists.');
+  } else {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Uat Folder');
+    (0, _fs.mkdirSync)(uatFolder);
+  }
+}
+function getSetupFileAsString(fileName) {
+  return (0, _fs.readFileSync)(_path.default.resolve(__dirname, './samples/', fileName)).toString();
+}
+function createUatConfig() {
+  const uatConfigPath = _path.default.resolve(process.cwd(), 'uat.config.js');
+  if ((0, _fs.existsSync)(uatConfigPath)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Uat Config already Exists.');
+  } else {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Uat config file...');
+    (0, _fs.writeFileSync)(uatConfigPath, getSetupFileAsString('uat-config-sample.js'), null, 2);
+  }
+}
+function createAuthenticationFile() {
+  const isUATexist = _path.default.resolve(process.cwd(), 'uat');
+  if ((0, _fs.existsSync)(isUATexist)) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
+    try {
+      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
+      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
+        recursive: true
+      });
+      (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);
+    } catch (err) {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
+    }
+  } else {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
+  }
+}
+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);
+  } else {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
+  }
+}
+function setupProject() {
+  updatePackageJSONScripts();
+  createUatConfig();
+  createFolderForUAT();
+  createConfigJson();
+  createAuthenticationFile();
+  // Create folder for playwright . Inside .auth folder needs to be created. user.json
+  // Add playwright and test-results to .gitignore
+  setTimeout(() => {
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Setup Project is Ready ..');
+  }, 2000);
+}

package/{src → build}/utils/cliArgsToObject.js

@@ -1,63 +1,65 @@
-/**
- * Converts an array of command-line arguments into an object.
- *
- * @param {string[]} cliArgs - An array of command-line arguments.
- * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
- * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
- * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
- *
- * @example
- * // Example usage:
- * const args = ['--port=8080', '--verbose', 'input.txt'];
- * const result = cliArgsToObject(args);
- * // result will be: { port: '8080', verbose: true }
- */
-function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
-  const processEnv = {};
-  cliArgs.forEach(option => {
-    if (/^--./.test(option)) {
-      const equIndex = option.indexOf('=');
-      let key = option.slice(2, equIndex);
-      let value = option.slice(equIndex + 1);
-      if (equIndex === -1) {
-        key = option.slice(2);
-        value = true;
-      }
-      processEnv[key] = value;
-    }
-  });
-  return processEnv;
-}
-
-
-/**
- * Converts an object to an array of command-line arguments.
- *
- * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
- * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
- * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
- *
- * @example
- * // Example usage:
- * const options = { port: 8080, verbose: true, input: 'input.txt' };
- * const args = objectToCliArgs(options);
- * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
- */
-function objectToCliArgs(objectToBeConverted, isKeyNeedToBeAdded) {
-  const argsArray = [];
-
-  Object.keys(objectToBeConverted).forEach(key => {
-    if (isKeyNeedToBeAdded(key)) {
-      if (typeof objectToBeConverted[key] === 'boolean' && objectToBeConverted[key]) {
-        argsArray.push(`--${key}`)
-      } else {
-        argsArray.push(`--${key}=${objectToBeConverted[key]}`)
-      }
-    }
-  })
-
-  return argsArray;
-}
-
-
-module.exports = { cliArgsToObject, objectToCliArgs };
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cliArgsToObject = cliArgsToObject;
+exports.objectToCliArgs = objectToCliArgs;
+/**
+ * Converts an array of command-line arguments into an object.
+ *
+ * @param {string[]} cliArgs - An array of command-line arguments.
+ * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
+ * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
+ * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
+ *
+ * @example
+ * // Example usage:
+ * const args = ['--port=8080', '--verbose', 'input.txt'];
+ * const result = cliArgsToObject(args);
+ * // result will be: { port: '8080', verbose: true }
+ */
+// eslint-disable-next-line no-unused-vars
+function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
+  const processEnv = {};
+  cliArgs.forEach(option => {
+    if (/^--./.test(option)) {
+      const equIndex = option.indexOf('=');
+      let key = option.slice(2, equIndex);
+      let value = option.slice(equIndex + 1);
+      if (equIndex === -1) {
+        key = option.slice(2);
+        value = true;
+      }
+      processEnv[key] = value;
+    }
+  });
+  return processEnv;
+}
+
+/**
+ * Converts an object to an array of command-line arguments.
+ *
+ * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
+ * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
+ * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
+ *
+ * @example
+ * // Example usage:
+ * const options = { port: 8080, verbose: true, input: 'input.txt' };
+ * const args = objectToCliArgs(options);
+ * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
+ */
+function objectToCliArgs(objectToBeConverted, isKeyNeedToBeAdded) {
+  const argsArray = [];
+  Object.keys(objectToBeConverted).forEach(key => {
+    if (isKeyNeedToBeAdded(key)) {
+      if (typeof objectToBeConverted[key] === 'boolean' && objectToBeConverted[key]) {
+        argsArray.push(`--${key}`);
+      } else {
+        argsArray.push(`--${key}=${objectToBeConverted[key]}`);
+      }
+    }
+  });
+  return argsArray;
+}

package/build/utils/fileUtils.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.checkIfFileExists = checkIfFileExists;
+exports.deleteFile = deleteFile;
+exports.readFileContents = readFileContents;
+exports.writeFileContents = writeFileContents;
+var _fs = _interopRequireDefault(require("fs"));
+function checkIfFileExists(file) {
+  try {
+    _fs.default.accessSync(file, _fs.default.constants.F_OK);
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+function readFileContents(filePath) {
+  try {
+    let fileContents = _fs.default.readFileSync(filePath, 'utf-8');
+    return fileContents;
+  } catch (err) {
+    return null;
+  }
+}
+function writeFileContents(filePath, content, writeOptions = {}) {
+  let filePaths = filePath.split('/');
+  let fileName = filePaths.pop();
+  let directoryPath = filePaths.join('/');
+
+  // Check if the directory exists
+  if (!_fs.default.existsSync(directoryPath)) {
+    _fs.default.mkdirSync(directoryPath, {
+      recursive: true
+    });
+  }
+  try {
+    _fs.default.writeFileSync(`${directoryPath}/${fileName}`, content, writeOptions);
+  } catch (err) {
+    throw new Error(err);
+  }
+}
+function deleteFile(filePath) {
+  if (checkIfFileExists(filePath)) {
+    try {
+      _fs.default.unlinkSync(filePath);
+    } catch (err) {
+      throw new Error(`Error while deleting the test data file: ${filePath}`);
+    }
+  }
+}

package/build/utils/getFilePath.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = getFilePathWithExtension;
+var _os = require("os");
+const isWindows = (0, _os.platform)().toLowerCase() === 'win32';
+function getFilePathWithExtension(binName) {
+  return isWindows ? `${binName}.cmd` : binName;
+}

package/build/utils/logger.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Logger = void 0;
+// const SUCCESS_TYPE = 'success';
+// const FAILURE_TYPE = 'failure';
+// const INFO_TYPE = 'info';
+
+// function logger() {
+//   this.colors = {
+//     'success': ['\x1b[36m', '\x1b[0m'],
+//     'failure': ['\x1b[31m', '\x1b[0m'],
+//     'info': ['\x1b[33m', '\x1b[0m']
+//   }
+//   this.consoleLogger = console;
+//   return {
+//     SUCCESS_TYPE,
+//     FAILURE_TYPE,
+//     INFO_TYPE,
+//     error: () => { },
+//     info: () => { },
+//     log: (type, message) => {
+//       const color = this.colors[type];
+//       console.log(type, color)
+//       this.consoleLogger.log(`${color[0]}${message}${color[1]}`)
+//     }
+//   }
+// }
+
+// module.exports = {
+//   Logger: logger()
+// }
+
+class LoggerImpl {
+  constructor() {
+    this.SUCCESS_TYPE = 'success';
+    this.FAILURE_TYPE = 'failure';
+    this.INFO_TYPE = 'info';
+    this.colors = {
+      'success': ['\x1b[36m', '\x1b[0m'],
+      'failure': ['\x1b[31m', '\x1b[0m'],
+      'info': ['\x1b[33m', '\x1b[0m']
+    };
+    this.consoleLogger = console;
+  }
+  error(err) {
+    this.consoleLogger.error(err);
+  }
+  info() {}
+  log(type, message) {
+    const color = this.colors[type];
+    this.consoleLogger.log(`${color[0]}${message}${color[1]}`);
+  }
+}
+const Logger = new LoggerImpl();
+exports.Logger = Logger;

package/build/utils/rootPath.js

@@ -0,0 +1,46 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getBinPath = getBinPath;
+exports.getExecutableBinaryPath = getExecutableBinaryPath;
+exports.getRootNodeModulesPath = getRootNodeModulesPath;
+exports.getRootPath = getRootPath;
+var _path = _interopRequireDefault(require("path"));
+var _fs = _interopRequireDefault(require("fs"));
+var _logger = require("./logger");
+var _getFilePath = _interopRequireDefault(require("./getFilePath"));
+function findBinaryPath(directory, command) {
+  const binaryPath = _path.default.join(directory, '.bin', (0, _getFilePath.default)(command));
+  if (_fs.default.existsSync(binaryPath)) {
+    return binaryPath;
+  }
+
+  // Recursively search parent directories. Might be time-consuming ?? Can we look for npm module like which?
+  const parentDir = _path.default.dirname(directory);
+  if (parentDir === directory) {
+    return null;
+  }
+  return findBinaryPath(parentDir, command);
+}
+function getRootPath() {
+  return _path.default.resolve(__dirname, '../', '../');
+}
+function getRootNodeModulesPath() {
+  return _path.default.resolve(getRootPath(), 'node_modules');
+}
+function getBinPath(command) {
+  const packageNodeModulesPath = getRootNodeModulesPath();
+  return findBinaryPath(packageNodeModulesPath, command);
+}
+function getExecutableBinaryPath(command) {
+  const binPath = getBinPath(command);
+  if (binPath !== null) {
+    return binPath;
+  } else {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error: Could not find executable bin ${command} file. Make sure to npm install before proceeding`);
+    process.exit();
+  }
+}

package/build/utils/stepDefinitionsFormatter.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.delimiters = void 0;
+exports.findDelimiterFromStep = findDelimiterFromStep;
+const delimiters = ["Given", "When", "Then", "And"];
+exports.delimiters = delimiters;
+function findDelimiterFromStep(step) {
+  return delimiters.find(delimiter => step.includes(delimiter));
+}

package/jest.config.js

@@ -1,64 +1,64 @@
-const path = require('path');
-const { existsSync } = require('fs');
-const appPath = process.cwd();
-
-const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
-
-module.exports = {
-  rootDir: process.cwd(),
-  testEnvironment: 'jsdom',
-
-  setupFilesAfterEnv: [
-    existsSync(appGlobals) && appGlobals,
-    path.resolve(__dirname, 'src', 'core', 'jest', 'setup', 'index.js')
-  ].filter(Boolean),
-
-  transform: {
-    '^.+\\.(js|jsx)$': path.resolve(
-      __dirname,
-      'src',
-      'core',
-      'jest',
-      'preprocessor',
-      'jsPreprocessor.js'
-    )
-  },
-
-  modulePathIgnorePatterns: ['/build/'],
-
-  transformIgnorePatterns: [
-    '/node_modules/(?!(@zohodesk)/)'
-  ],
-
-  testPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/',
-    '/uat/'
-  ],
-
-  watchPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/'
-  ],
-
-  clearMocks: true,
-  resetMocks: false,
-
-  collectCoverage: true,
-  collectCoverageFrom: ['src/**/*.js'],
-  coverageDirectory: './build/cov',
-  coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100
-    }
-  },
-  globals: {
-    __DEVELOPMENT__: true,
-    __DOCS__: false,
-    __TEST__: true
-  }
+const path = require('path');
+const { existsSync } = require('fs');
+const appPath = process.cwd();
+
+const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
+
+module.exports = {
+  rootDir: process.cwd(),
+  testEnvironment: 'jsdom',
+
+  setupFilesAfterEnv: [
+    existsSync(appGlobals) && appGlobals,
+    path.resolve(__dirname, 'src', 'core', 'jest', 'setup', 'index.js')
+  ].filter(Boolean),
+
+  transform: {
+    '^.+\\.(js|jsx)$': path.resolve(
+      __dirname,
+      'src',
+      'core',
+      'jest',
+      'preprocessor',
+      'jsPreprocessor.js'
+    )
+  },
+
+  modulePathIgnorePatterns: ['/build/'],
+
+  transformIgnorePatterns: [
+    '/node_modules/(?!(@zohodesk)/)'
+  ],
+
+  testPathIgnorePatterns: [
+    '/node_modules/',
+    '/build/',
+    '/uat/'
+  ],
+
+  watchPathIgnorePatterns: [
+    '/node_modules/',
+    '/build/'
+  ],
+
+  clearMocks: true,
+  resetMocks: false,
+
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.js'],
+  coverageDirectory: './build/cov',
+  coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+  globals: {
+    __DEVELOPMENT__: true,
+    __DOCS__: false,
+    __TEST__: true
+  }
 };