@zohodesk/testinglibrary 0.0.3 → 0.0.5

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

@@ -0,0 +1,99 @@
+const { readFileSync, existsSync, writeFileSync, mkdirSync } = require('fs');
+const path = require('path');
+const { Logger } = require('../utils/logger');
+
+
+function getScriptsToBeAdded() {
+  return {
+    "ua-test": "ZDTestingFramework test --mode=prod --headed",
+    "ua-test-debug": "ZDTestingFramework test --mode=prod --debug",
+    "ua-report": "ZDTestingFramework report --port=9009",
+    "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
+  }
+}
+
+function updatePackageJSONScripts() {
+  const packageJsonPath = path.resolve(process.cwd(), './package.json')
+  if (existsSync(packageJsonPath)) {
+    const packageContents = readFileSync(packageJsonPath);
+    const configJSON = JSON.parse(packageContents);
+    const { scripts = {} } = configJSON;
+    const modifiedScripts = { ...scripts, ...getScriptsToBeAdded() };
+    const modifiedConfigJSON = { ...configJSON, scripts: modifiedScripts };
+    writeFileSync(packageJsonPath, JSON.stringify(modifiedConfigJSON, null, 2));
+  } else {
+    Logger.log(Logger.FAILURE_TYPE, 'Unable to find package json. Run init command in the root path of the project.');
+    process.exit();
+  }
+}
+
+
+function createFolderForUAT() {
+  const uatFolder = path.resolve(process.cwd(), 'uat');
+
+  if (existsSync(uatFolder)) {
+    Logger.log(Logger.INFO_TYPE, 'Uat Folder already Exists.');
+    process.exit();
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'Creating Uat Folder');
+    mkdirSync(uatFolder);
+  }
+}
+
+function getSetupFileAsString(fileName) {
+  return readFileSync(path.resolve(__dirname, './', fileName)).toString();
+}
+
+function createUatConfig() {
+  const uatConfigPath = path.resolve(process.cwd(), 'uat.config.js');
+  if (existsSync(uatConfigPath)) {
+    Logger.log(Logger.INFO_TYPE, 'Uat Config already Exists.');
+    process.exit();
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'Creating Uat config file...');
+    writeFileSync(uatConfigPath, getSetupFileAsString('uat-config-sample.js'), null, 2)
+  }
+}
+
+function  createAuthenticationFile() {
+  const isUATexist = path.resolve(process.cwd(), 'uat')
+  if (existsSync(isUATexist)) {
+    Logger.log(Logger.INFO_TYPE, 'Creating Authentication File ....')
+    try {
+      mkdirSync(path.resolve(process.cwd(), 'playwright'), { recursive: true })
+      mkdirSync(path.resolve(process.cwd(), 'playwright', '.auth'), { recursive: true })
+      const authFilePath = path.resolve(process.cwd(), 'playwright', '.auth', 'user.json')
+      writeFileSync(authFilePath, getSetupFileAsString('user-example.json'), null, 2)
+    } catch (err) {
+      Logger.log(Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat')
+    }
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
+  }
+}
+
+function createConfigJson() {
+  const uatFolder = path.resolve(process.cwd(), 'uat');
+  if (existsSync(uatFolder)) {
+    Logger.log(Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
+    writeFileSync(path.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2)
+  } else {
+    Logger.log(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.log(Logger.SUCCESS_TYPE, 'Setup Project is Ready ..')
+}, 2000)
+
+module.exports = setupProject; 

package/src/setup-folder-structure/uat-config-sample.js

@@ -0,0 +1,22 @@
+/**
+* Represents the user configuration object.
+* @typedef {Object} UserConfig
+* @property {string} headless - Headless Browsers mode.
+* @property {number} trace - trace for test cases.
+* @property {boolean} video - video for test cases,
+* @property {boolean} debug - debug mode
+* @property {string} mode: mode in which the test cases needs to run
+* @property {boolean} isAuthMode -  Auth Mode
+* @property {any} browsers: List of browsers
+*/
+/**
+* @type {UserConfig}
+*/
+module.exports = {
+  headed: true,
+  browsers: ['Chrome', 'Firefox'],
+  mode: 'dev',
+  isAuthMode: true,
+  trace: true,
+  video: true,
+}

package/src/setup-folder-structure/user-example.json

@@ -0,0 +1,3 @@
+{
+    "cookies": []
+}

package/src/utils/cliArgsToObject.js

@@ -1,35 +1,63 @@
-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;
-}
-
-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;
-}
-
-
+/**
+ * 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 };

package/src/utils/getFilePath.js

@@ -1,9 +1,9 @@
-const { platform } = require('os');
-
-const isWindows = platform().toLowerCase() === 'win32';
-
-function getFilePathWithExtension(binName) {
-  return isWindows ? `${binName}.cmd` : binName;
-}
-
+const { platform } = require('os');
+
+const isWindows = platform().toLowerCase() === 'win32';
+
+function getFilePathWithExtension(binName) {
+  return isWindows ? `${binName}.cmd` : binName;
+}
+
 module.exports = getFilePathWithExtension;

package/src/utils/logger.js

@@ -1,28 +1,28 @@
-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];
-      this.consoleLogger.log(`${color[0]}${message}${color[1]}`)
-    }
-  }
-}
-
-
-module.exports = {
-  Logger: logger()
+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];
+      this.consoleLogger.log(`${color[0]}${message}${color[1]}`)
+    }
+  }
+}
+
+
+module.exports = {
+  Logger: logger()
 }

package/src/utils/rootPath.js

@@ -1,51 +1,51 @@
-const path = require('path')
-const fs = require('fs');
-const { Logger } = require('./logger');
-const getFilePathWithExtension = require('./getFilePath');
-
-function findBinaryPath(directory, command) {
-  const binaryPath = path.join(directory, '.bin', getFilePathWithExtension(command));
-  if (fs.existsSync(binaryPath)) {
-    return binaryPath;
-  }
-
-  // Recursively search parent directories. Might be time-consuming ?? Can we look for npm module like which?
-  const parentDir = path.dirname(directory);
-  if (parentDir === directory) {
-    return null;
-  }
-
-  return findBinaryPath(parentDir, command);
-}
-
-function getRootPath() {
-  return path.resolve(__dirname, '../', '../');
-}
-
-function getRootNodeModulesPath() {
-  return path.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.log(Logger.FAILURE_TYPE, `Error: Could not find executable bin file. Make sure to npm install before proceeding`);
-    process.exit();
-  }
-}
-
-module.exports = {
-  getRootPath,
-  getBinPath,
-  getRootNodeModulesPath,
-  getExecutableBinaryPath
+const path = require('path')
+const fs = require('fs');
+const { Logger } = require('./logger');
+const getFilePathWithExtension = require('./getFilePath');
+
+function findBinaryPath(directory, command) {
+  const binaryPath = path.join(directory, '.bin', getFilePathWithExtension(command));
+  if (fs.existsSync(binaryPath)) {
+    return binaryPath;
+  }
+
+  // Recursively search parent directories. Might be time-consuming ?? Can we look for npm module like which?
+  const parentDir = path.dirname(directory);
+  if (parentDir === directory) {
+    return null;
+  }
+
+  return findBinaryPath(parentDir, command);
+}
+
+function getRootPath() {
+  return path.resolve(__dirname, '../', '../');
+}
+
+function getRootNodeModulesPath() {
+  return path.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.log(Logger.FAILURE_TYPE, `Error: Could not find executable bin file. Make sure to npm install before proceeding`);
+    process.exit();
+  }
+}
+
+module.exports = {
+  getRootPath,
+  getBinPath,
+  getRootNodeModulesPath,
+  getExecutableBinaryPath
 }