@zohodesk/testinglibrary 0.0.3 → 0.0.5

package/src/core/playwright/readConfigFile.js

@@ -1,30 +1,63 @@
-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
+const { existsSync } = require('fs');
+const path = require('path');
+const { Logger } = require('../../utils/logger');
+
+const fileName = 'uat.config.js';
+
+/**
+ * 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
+ * @property {string} openReportOn: default Option value (never, on-failure and always) 
+ * @property {any} reportPath : directory where report is generate
+ */
+
+
+/**
+ * Generates a configuration object from a file, if it exists.
+ *
+ * @returns {UserConfig}
+*/
+function generateConfigFromFile() {
+  const filePath = path.resolve(process.cwd(), fileName);
+
+  if (existsSync(filePath)) {
+    /** @type {UserConfig} */
+    const config = require(filePath);
+    return config;
+  }
+
+  return {};
+}
+
+function isUserConfigFileAvailable() {
+  const filePath = path.resolve(process.cwd(), fileName);
+  if (existsSync(filePath)) {
+    return true;
+  }
+  return false;
+}
+
+function getAuthFilePath(filePath){
+  try{
+    if(existsSync(filePath)){
+      return filePath
+    }
+  }catch(err){
+    Logger.log(Logger.FAILURE_TYPE,`Founded Path - ${filePath} Authetication file not Exist ...`)
+  }
+
+}
+
+module.exports = {
+  fileName,
+  isUserConfigFileAvailable,
+  generateConfigFromFile,
+  getAuthFilePath
 };

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

@@ -1,43 +1,45 @@
-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();
-
-  });
-}
-
-
+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,79 +1,77 @@
-// @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]
-});
-
+// @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,64 +1,67 @@
-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;
+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 +1,9 @@
-const { expect, test } = require('./core/playwright/index');
-const { fireEvent, render } = require('@testing-library/react');
-
-module.exports = {
-  expect,
-  test,
-  fireEvent,
-  render
+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 +1,42 @@
-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;
-  }
+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

@@ -0,0 +1,17 @@
+{
+  "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"
+  }
+}