@zohodesk/testinglibrary 0.0.1 → 0.0.2-n20-experimental

package/package.json

@@ -1,31 +1,60 @@
-{
-  "name": "@zohodesk/testinglibrary",
-  "version": "0.0.1",
-  "description": "",
-  "main": "./src/index.js",
-  "scripts": {
-    "postinstall": "node bin/postinstall.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@babel/preset-env": "^7.22.9",
-    "@babel/preset-react": "^7.22.5",
-    "@playwright/test": "^1.37.1",
-    "@testing-library/jest-dom": "^5.11.9",
-    "@testing-library/react": "^11.2.7",
-    "@testing-library/react-hooks": "^7.0.2",
-    "babel-jest": "^29.6.2",
-    "babel-plugin-transform-dynamic-import": "^2.1.0",
-    "jest": "^29.6.2",
-    "jest-environment-jsdom": "^29.6.2",
-    "msw": "^1.2.3",
-    "react": "16.13.1",
-    "react-dom": "16.13.1"
-  },
-  "bin": {
-    "ZDTestingFramework": "./bin/cli.js"
-  }
-}
+{
+  "name": "@zohodesk/testinglibrary",
+  "version": "0.0.2-n20-experimental",
+  "description": "",
+  "main": "./build/index.js",
+  "scripts": {
+    "postinstall": "node bin/postinstall.js",
+    "test": "jest",
+    "clean": "rm -rf build && mkdir build",
+    "build-babel": "babel -d ./build ./src --copy-files",
+    "build": "npm run clean && npm run build-babel",
+    "prepare": "npm run build",
+    "lint": "eslint src/* --fix"
+  },
+  "exports": {
+    ".": "./build/index.js",
+    "./decorators": "./build/decorators.js",
+    "./helpers": "./build/core/playwright/helpers/auth/index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/code-frame": "7.27.1",
+    "@babel/preset-react": "7.27.1",
+    "@cucumber/cucumber": "11.3.0",
+    "@playwright/test": "1.53.2",
+    "@reportportal/agent-js-playwright": "5.1.11",
+    "@testing-library/jest-dom": "5.11.9",
+    "@testing-library/react": "11.2.7",
+    "@testing-library/react-hooks": "7.0.2",
+    "babel-jest": "29.6.2",
+    "babel-plugin-transform-dynamic-import": "2.1.0",
+    "fast-glob": "3.3.3",
+    "jest": "29.6.2",
+    "jest-environment-jsdom": "29.6.2",
+    "msw": "2.10.4",
+    "playwright": "1.53.2",
+    "supports-color": "8.1.1",
+    "playwright-bdd": "8.3.1"
+  },
+  "bin": {
+    "ZDTestingFramework": "./bin/cli.js"
+  },
+  "peerDependencies": {
+    "eslint": "*",
+    "react": "*",
+    "react-dom": "*"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.28.0",
+    "@babel/core": "7.28.0",
+    "@babel/node": "7.28.0",
+    "@babel/plugin-transform-runtime": "7.28.0",
+    "@babel/preset-env": "7.28.0",
+    "@babel/runtime": "7.28.2",
+    "commander": "14.0.0",
+    "jest-html-reporter": "4.3.0"
+  }
+}

package/playwright.config.js

@@ -1,112 +1,62 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const numCPUs = require('os').cpus().length;
-
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-// require('dotenv').config();
-
-/**
- * @see https://playwright.dev/docs/test-configuration
- */
-module.exports = defineConfig({
-  testDir: path.join(path.resolve(process.cwd()), 'uat'),
-  outputDir: path.join(process.cwd(), 'test-results'),
-  /* Run tests in files in parallel */
-  fullyParallel: true,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
-  forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : 1,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: [['html', { outputFolder: path.join(process.cwd(), 'playwright-report'), open: "always" }]],
-  timeout: 60 * 1000,
-  expect: {
-    timeout: 5 * 1000,
-  },
-
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    //baseURL: process.env.domain,
-
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: 'on',
-    video: {
-      mode: 'on',
-      size: { width: 640, height: 480 }
-    }
-  },
-
-  /* Configure projects for major browsers */
-  projects: [
-    { name: 'setup', testMatch: /.*\.setup\.js/ },
-    {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: path.resolve(process.cwd(), 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: path.resolve(process.cwd(), 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: path.resolve(process.cwd(), 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    /* Test against mobile viewports. */
-    // {
-    //   name: 'Mobile Chrome',
-    //   use: { ...devices['Pixel 5'] },
-    // },
-    // {
-    //   name: 'Mobile Safari',
-    //   use: { ...devices['iPhone 12'] },
-    // },
-
-    /* Test against branded browsers. */
-    // {
-    //   name: 'Microsoft Edge',
-    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
-    // },
-    // {
-    //   name: 'Google Chrome',
-    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
-    // },
-  ],
-
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-  //   command: 'npm run start',
-  //   url: 'http://127.0.0.1:3000',
-  //   reuseExistingServer: !process.env.CI,
-  // },
-});
-
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+const path = require('path');
+const numCPUs = require('os').cpus().length;
+
+export default defineConfig({
+  testDir: path.join(path.resolve(process.cwd()), 'uat'),
+  outputDir: path.join(process.cwd(), 'uat', 'test-results'),
+  fullyParallel: true,
+  retries: process.env.CI ? 2 : 0,
+  reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', 'playwright-report'), open: "always" }]],
+  timeout: 60 * 1000,
+  expect: {
+    timeout: 5 * 1000,
+  },
+  use: {
+    trace: 'on',
+    video: {
+      mode: 'on',
+      size: { width: 640, height: 480 }
+    }
+  },
+  projects: [
+    { name: 'setup', testMatch: /.*\.setup\.js/ },
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+    {
+      name: 'firefox',
+      timeout: 4 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000,
+      },
+      use: {
+        ...devices['Desktop Firefox'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+    {
+      name: 'webkit',
+      timeout: 2 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000,
+      },
+      use: {
+        ...devices['Desktop Safari'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+  ],
+});
+

package/src/core/jest/setup/index.js

@@ -1,165 +0,0 @@
-//$Id$//
-import TestUtils from 'react-dom/test-utils';
-import { expect } from '@jest/globals'
-import React from 'react';
-import PropTypes from 'prop-types';
-import ReactDOM from 'react-dom';
-import '@testing-library/jest-dom/extend-expect';
-// let mockDomain = 'htt' + 'p://zoho.com';
-// const { document } = new JSDOM('').window;
-// global.document = document;
-// global.window = document.defaultView;
-// global.navigator = global.window.navigator;
-// global.localStorage = global.sessionStorage = {
-//   getItem(key) {
-//     return this[key];
-//   },
-//   setItem(key, value) {
-//     if (value.length > 100) {
-//       throw new Error('Data size is too exceeded');
-//     }
-//     this[key] = value;
-//   },
-//   removeItem(key) {
-//     delete this[key];
-//   },
-//   clear() {
-//     let keys = ['getItem', 'setItem', 'removeItem', 'clear'];
-//     for (let key in this) {
-//       if (keys.indexOf(key) === -1) {
-//         delete this[key];
-//       }
-//     }
-//   }
-// };
-// global.ZE_Init = {};
-// global.String.prototype.contains = function (text) {
-//   return this.indexOf(text) != -1;
-// };
-// global.TestUtils = TestUtils;
-// // let xmlReq = XMLHttpRequest;
-// // window.XMLHttpRequest = function () {
-// //   let xmlReqCopy = new xmlReq();
-// //   let originalOpen = xmlReqCopy.open;
-// //   xmlReqCopy.open = function () {
-// //     if (arguments[1].indexOf('http') != 0) {
-// //       arguments[1] = mockDomain + arguments[1];
-// //     }
-// //     return originalOpen.apply(this, arguments);
-// //   };
-// //   return xmlReqCopy;
-// // };
-
-// TestUtils.scryRenderedComponentsWithTestid = function (dom, name) {
-//   let componentList = TestUtils.findAllInRenderedTree(dom, (i, j) => {
-//     if (TestUtils.isDOMComponent(i)) {
-//       let val = i.getAttribute('data-id');
-//       if (typeof val !== 'undefined' && val == name) {
-//         return true;
-//       }
-//       return false;
-//     }
-//   });
-//   return componentList;
-// };
-
-// TestUtils.findRenderedComponentsWithTestid = function (dom, name) {
-//   let list = TestUtils.scryRenderedComponentsWithTestid(dom, name);
-//   if (list.length !== 1) {
-//     throw new Error(
-//       `Did not find exactly one match (found: ${list.length}) ` +
-//       `for data-id:${name}`
-//     );
-//   }
-//   return list[0];
-// };
-
-// global.render = function (Component, props) {
-//   const renderedDOM = TestUtils.renderIntoDocument(<Component {...props} />);
-//   return {
-//     props,
-//     renderedDOM
-//   };
-// };
-
-// global.setup = function (Component, props, state) {
-//   let router = {
-//     router: {
-//       push() { },
-//       createHref(ob) {
-//         return ob.pathname;
-//       },
-//       isActive() {
-//         return true;
-//       },
-//       replace() { },
-//       go() { },
-//       goBack() { },
-//       goForward() { },
-//       setRouteLeaveHook() { },
-//       getState() { }
-//     },
-//     store: {
-//       getState() {
-//         return state;
-//       }
-//     }
-//   };
-//   // var store = {
-//   // 	store:{
-//   // 		getState:function(){return state;}
-//   // 	}
-//   // }
-//   var Component = higherComponent(Component, router);
-//   const renderedDOM = TestUtils.renderIntoDocument(
-//     <Component {...props} />,
-//     router
-//   );
-//   return {
-//     props,
-//     renderedDOM
-//   };
-// };
-
-// function higherComponent(ActualComponent, context) {
-//   if (context) {
-//     class HigherComponent extends React.Component {
-//       constructor() {
-//         super();
-//       }
-
-//       getChildContext() {
-//         return context;
-//       }
-
-//       render() {
-//         return <ActualComponent {...this.props} />;
-//       }
-//     }
-
-//     HigherComponent.childContextTypes = {
-//       router: PropTypes.any,
-//       store: PropTypes.any
-//     };
-
-//     return HigherComponent;
-//   }
-//   return ActualComponent;
-// }
-// global.window.matchMedia =
-//   window.matchMedia ||
-//   function () {
-//     return {
-//       matches: false,
-//       addListener() { },
-//       removeListener() { }
-//     };
-//   };
-// // global.renderHTML = function(comp) {
-// //   return ReactDOM.findDOMNode(comp);
-// // };
-
-// global.TestUtils = TestUtils;
-// global.getI18NValue = function (inp) {
-//   return inp;
-// };

package/src/core/playwright/codegen.js

@@ -1,61 +0,0 @@
-const { spawn } = require('child_process')
-const path = require('path');
-const getFilePathWithExtension = require('../../utils/getFilePath');
-const { chromium } = require('@playwright/test');
-const { Logger } = require('../../utils/logger');
-const { getBinPath } = require('../../utils/rootPath');
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getBinPath(), getFilePathWithExtension('playwright'));
-const command = playwrightPath;
-
-const args = ['codegen'].concat(userArgs);
-
-function generateCodegen() {
-  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();
-
-  });
-}
-
-
-// Another way to record. Below way will load the url in autheticated state if present
-// function generateCodegen() {
-//   (async () => {
-//     // Make sure to run headed.
-//     const browser = await chromium.launch({ headless: false });
-
-//     // Setup context however you like.
-//     const context = await browser.newContext({ storageState: path.resolve(process.cwd(), 'playwright/.auth/user.json') });
-//     await context.route('**/*', route => route.continue());
-
-//     // Pause the page, and start recording manually.
-//     const page = await context.newPage();
-//     console.log(userArgs.join(''));
-//     await page.goto(`https://${userArgs.join('')}`);
-//     await page.pause();
-//   })();
-// }
-
-module.exports = generateCodegen;

package/src/core/playwright/custom-commands.js

@@ -1,3 +0,0 @@
-module.exports = {
-  CUSTOM_COMMANDS: ['mode']
-}

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,81 +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,18 +0,0 @@
-const { existsSync } = require('fs');
-const path = require('path');
-
-const fileName = 'test.config.js';
-
-function generateConfigFromFile() {
-  const filePath = path.resolve(process.cwd(), fileName);
-
-  if (existsSync(filePath)) {
-    const config = require(filePath);
-    return config;
-  }
-
-  return {};
-}
-
-
-module.exports = generateConfigFromFile;

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

@@ -1,44 +0,0 @@
-const { spawn } = require('child_process');
-const path = require('path');
-const { Logger } = require('../../utils/logger');
-const getFilePathWithExtension = require('../../utils/getFilePath');
-const { getBinPath } = require('../../utils/rootPath');
-
-
-const userArgs = process.argv.slice(3);
-
-const playwrightPath = path.resolve(getBinPath(), getFilePathWithExtension('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;