@zohodesk/testinglibrary 0.0.3 → 0.0.4-n20-experimental

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

@@ -1,24 +0,0 @@
-const { readFileSync } = require('fs');
-const path = require('path');
-
-
-
-function initializeEnvConfig(mode = 'dev') {
-  try {
-    const configFile = readFileSync(path.resolve(process.cwd(), './uat/config.json'));
-
-    const configJSON = JSON.parse(configFile);
-    process.env.mode = mode;
-    for (const key in configJSON[mode]) {
-      process.env[key] = configJSON[mode][key];
-    }
-  } catch (err) {
-    throw new Error('Config File Not Exists. Please provide a config file to intiailize the environment variables')
-  }
-
-}
-
-
-module.exports = {
-  initializeEnvConfig
-};

package/src/core/playwright/index.js

@@ -1,82 +0,0 @@
-const { expect, test: base } = require('@playwright/test');
-// function test(descrition, callback) {
-//   return test(descrition, ({ page }) => {
-//     const { locator, ...custompage } = page
-//     callback({ page: custompage })
-//   })
-// }
-
-// class FilteredPage {
-//   constructor(page) {
-//     this.page = page;
-//     this.allowedMethods = ['getByText', 'getByTitle'];
-//     this.context = page.context;
-//   }
-
-//   goto(...args) {
-//     return this.page['goto'](...args);
-//   }
-
-
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-
-
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
-
-const test = base.extend({
-  page: async ({ baseURL, page }, use) => {
-    // const proxyPage = new Proxy(page, {
-    //   get: function (obj, prop) {
-    //     console.log('Gettig Priop', prop);
-    //     let filterMethod = FilteredPage(page)[prop];
-    //     if (filterMethod) {
-    //       return filterMethod;
-    //     } else {
-    //       return obj[prop] ? obj[prop] : 'property does not exist';
-    //     }
-    //   }
-    // })
-    page.getBaseUrl = function () {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}`;
-    }
-
-    page.getCustomPageUrl = function (url) {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`
-      }
-      return `${process.env.domain}/${url}`
-    }
-    await use(page);
-
-
-    //await use(new FilteredPage(page));
-
-    // await use(async (page) => {
-    //   delete page.getByTestId;
-    //   await page;
-    // });
-
-  },
-  context: async ({ context }, use) => {
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
-    await use(context);
-  }
-})
-
-
-module.exports = {
-  expect,
-  test
-}

package/src/core/playwright/readConfigFile.js

@@ -1,30 +0,0 @@
-const { existsSync } = require('fs');
-const path = require('path');
-
-const fileName = 'uat.config.js';
-
-function generateConfigFromFile() {
-  const filePath = path.resolve(process.cwd(), fileName);
-
-  if (existsSync(filePath)) {
-    const config = require(filePath);
-    return config;
-  }
-
-  return {};
-}
-
-function isUserConfigFileAvailable() {
-  const filePath = path.resolve(process.cwd(), fileName);
-  if (existsSync(filePath)) {
-    return true;
-  }
-  return false;
-}
-
-
-module.exports = {
-  fileName,
-  isUserConfigFileAvailable,
-  generateConfigFromFile
-};

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

@@ -1,43 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { Logger } = require('../../utils/logger');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getExecutableBinaryPath('playwright'));;
-const command = playwrightPath;
-const reportPath = path.resolve(process.cwd(), './playwright-report');
-
-
-const args = ['show-report', reportPath].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,79 +0,0 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const { generateConfigFromFile } = require('../readConfigFile');
-const numCPUs = require('os').cpus().length;
-
-const defaultBrowser = ['Chrome']
-
-const { browsers = defaultBrowser, isAuthMode, trace = false, video = false } = generateConfigFromFile();
-
-
-let projects = browsers.map(browser => {
-  if (browser === 'Chrome') {
-    return {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : null
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'Firefox') {
-    return {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : null
-      },
-      dependencies: isAuthMode ? ['setup'] : [],
-    };
-  } else if (browser === 'safari') {
-    return {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: isAuthMode ? path.resolve(process.cwd(), 'playwright/.auth/user.json') : null
-      },
-      dependencies: isAuthMode ? ['setup'] : null,
-    }
-  }
-}).filter(Boolean);
-
-console.log(projects);
-
-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: path.join(process.cwd(), 'playwright-report'), open: "always" }]],
-  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,64 +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 } = require('./readConfigFile');
-const { getExecutableBinaryPath } = require('../../utils/rootPath');
-
-
-
-// Access the command line arguments
-const userArgs = process.argv.slice(2);
-
-const userArgsObject = cliArgsToObject(userArgs);
-
-
-// Environment variables Initialization
-initializeEnvConfig(userArgsObject.mode ? userArgsObject.mode : 'dev');
-
-
-const playwrightArgs = objectToCliArgs(userArgsObject, (key) => !CUSTOM_COMMANDS.includes(key));
-
-// 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);
-
-
-function createTestRunner() {
-  // 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,35 +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 [, , 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;
-  }
-
-  default: {
-    console.log('Supported Commands test and report')
-    break;
-  }
-}

package/src/utils/cliArgsToObject.js

@@ -1,35 +0,0 @@
-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;
-}
-
-
-module.exports = { cliArgsToObject, objectToCliArgs };

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
-}