@zohodesk/testinglibrary 0.0.5 → 0.0.6

package/src/core/playwright/report-generator.js

@@ -1,45 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { Logger } = require('../../utils/logger');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-const { generateConfigFromFile } = require('./readConfigFile');
-
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));;
-const command = playwrightPath;
-const { reportPath : htmlPath = path.resolve(process.cwd(), './playwright-report') } = generateConfigFromFile()
-const reportPath = htmlPath
-
-
-const args = ['show-report', htmlPath].concat(userArgs);
-
-function generateReport() {
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-  childProcess.on('error', (error) => {
-    Logger.log(Logger.FAILURE_TYPE, error);
-  })
-
-  childProcess.on('exit', (code, signal) => {
-    Logger.log(Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-
-    process.exit();
-  });
-
-  process.on('exit', () => {
-    Logger.log(Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    childProcess.kill();
-    return;
-  });
-
-  process.on('SIGINT', () => {
-    Logger.log(Logger.INFO_TYPE, 'Cleaning up...');
-    childProcess.kill();
-    process.exit();
-
-  });
-}
-
-
-module.exports = generateReport;

package/src/core/playwright/setup/config-creator.js

@@ -1,77 +0,0 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const { generateConfigFromFile, getAuthFilePath } = require('../readConfigFile');
-const { existsSync } = require('fs');
-const numCPUs = require('os').cpus().length;
-
-const defaultBrowser = ['Chrome']
-
-const { browsers = defaultBrowser, trace = false, video = false, isAuthMode, openReportOn, reportPath = path.join(process.cwd(), 'playwright-report') } = generateConfigFromFile();
-
-let projects = browsers.map(browser => {
-  if (browser === 'Chrome') {
-    return {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: isAuthMode ? getAuthFilePath(path.resolve(process.cwd(), 'playwright/.auth/user.json')) : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'Firefox') {
-    return {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: isAuthMode ? getAuthFilePath(path.resolve(process.cwd(), 'playwright/.auth/user.json')) : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'safari') {
-    return {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: isAuthMode ? getAuthFilePath(path.resolve(process.cwd(), 'playwright/.auth/user.json')) : {}
-      },
-      dependencies: isAuthMode ? ['setup'] : null,
-    }
-  }
-}).filter(Boolean);
-
-module.exports = defineConfig({
-  testDir: path.join(path.resolve(process.cwd()), 'uat'),
-  outputDir: path.join(process.cwd(), 'test-results'),
-  fullyParallel: true,
-  forbidOnly: !!process.env.CI,
-  retries: process.env.CI ? 2 : 0,
-  workers: process.env.CI ? 1 : 1,
-  reporter: [['html', { outputFolder: reportPath, open: openReportOn }]], 
-  timeout: 60 * 1000,
-  expect: {
-    timeout: 5 * 1000,
-  },
-
-  use: {
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: { width: 640, height: 480 }
-    } : 'off'
-  },
-
-  projects: isAuthMode ? [
-    { name: 'setup', testMatch: /.*\.setup\.js/ },
-    ...projects
-  ] : [...projects]
-});
-

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

@@ -1,67 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { CUSTOM_COMMANDS } = require('./custom-commands');
-const { cliArgsToObject, objectToCliArgs } = require('../../utils/cliArgsToObject');
-const { initializeEnvConfig } = require('./env-initializer');
-const { Logger } = require('../../utils/logger');
-const { isUserConfigFileAvailable, generateConfigFromFile } = require('./readConfigFile');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-
-function createTestRunner() {
-  // Access the command line arguments
-  const userArgs = process.argv.slice(2);
-
-  const userArgsObject = cliArgsToObject(userArgs);
-
-
-  const { debug, mode = 'dev' } = generateConfigFromFile();
-
-  // Environment variables Initialization
-  initializeEnvConfig(userArgsObject.mode ? userArgsObject.mode : mode);
-
-
-  const playwrightArgs = objectToCliArgs(userArgsObject, (key) => !CUSTOM_COMMANDS.includes(key));
-
-  if (debug) {
-    playwrightArgs.push('--debug')
-  }
-
-  // Command and arguments for npx playwright test
-  const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));
-
-  const command = playwrightPath;
-
-  const configPath = isUserConfigFileAvailable() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
-
-  const args = ['test', '--config', configPath].concat(playwrightArgs);
-  // Spawn the child process
-
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-
-  childProcess.on('error', (error) => {
-    Logger.log(Logger.FAILURE_TYPE, error);
-  })
-
-  childProcess.on('exit', (code, signal) => {
-    Logger.log(Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-
-    process.exit();
-  });
-
-  process.on('exit', () => {
-    Logger.log(Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    //childProcess.kill();
-    return;
-  });
-
-  process.on('SIGINT', () => {
-    Logger.log(Logger.INFO_TYPE, 'Cleaning up...');
-    //childProcess.kill();
-    process.exit();
-
-  });
-}
-
-
-module.exports = createTestRunner;

package/src/index.js

@@ -1,9 +0,0 @@
-const { expect, test } = require('./core/playwright/index');
-const { fireEvent, render } = require('@testing-library/react');
-
-module.exports = {
-  expect,
-  test,
-  fireEvent,
-  render
-}

package/src/lib/cli.js

@@ -1,42 +0,0 @@
-const createTestRunner = require("../core/playwright/test-runner");
-const createJestRunner = require('../core/jest/runner/jest-runner');
-const generateReport = require("../core/playwright/report-generator");
-const generateCodegen = require('../core/playwright/codegen')
-const { Logger } = require("../utils/logger");
-const setupProject = require("../setup-folder-structure/setupProject");
-
-const [, , option] = process.argv;
-const args = process.argv.slice(3);
-const appPath = process.cwd();
-
-
-switch (option) {
-  case 'test': {
-    Logger.log(Logger.SUCCESS_TYPE, 'Running Tests..');
-    createTestRunner();
-    //createJestRunner();
-    break;
-  }
-  case 'report': {
-    // console.log('\x1b[36mGenerating Reports...\x1b[0m');
-    Logger.log(Logger.SUCCESS_TYPE, 'Generating Reports...');
-    generateReport();
-    break;
-  }
-  case 'codegen': {
-    Logger.log(Logger.INFO_TYPE, 'The purpose of codegen is to assist developer .....')
-    generateCodegen();
-    break;
-  }
-
-  case 'init': {
-    Logger.log(Logger.SUCCESS_TYPE, 'Initializing projects...');
-    setupProject();
-    break;
-  }
-
-  default: {
-    console.log('Supported Commands test and report')
-    break;
-  }
-}

package/src/setup-folder-structure/env-config-sample.json

@@ -1,17 +0,0 @@
-{
-  "dev": {
-    "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
-  },
-  "prod": {
-    "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
-  },
-  "k8test": {
-    "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
-  }
-}

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

@@ -1,99 +0,0 @@
-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

@@ -1,22 +0,0 @@
-/**
-* 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

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

package/src/utils/getFilePath.js

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

package/src/utils/rootPath.js

@@ -1,51 +0,0 @@
-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
-}