@zohodesk/testinglibrary 0.4.57-n18-experimental → 0.4.58

package/build/utils/fileUtils.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.checkIfFileExists = checkIfFileExists;
+exports.checkIfFolderExistsWithPattern = checkIfFolderExistsWithPattern;
 exports.deleteFile = deleteFile;
 exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
@@ -12,6 +13,8 @@ exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("./logger");
+var glob = _interopRequireWildcard(require("glob"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);
@@ -69,4 +72,17 @@ function deleteFolder(folderPath) {
       throw new Error(`Error while deleting the test data file: ${folderPath}`);
     }
   }
+}
+// This function uses glob to check if a folder exists with a specific pattern
+// Glob is define patterns for matching file and directory names based on wildcards
+function checkIfFolderExistsWithPattern(folderPath) {
+  try {
+    if (glob.sync(folderPath).length > 0) {
+      return true;
+    }
+    return false;
+  } catch (err) {
+    _logger.Logger.error(err);
+    return false;
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.4.57-n18-experimental",
+  "version": "0.4.58",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -22,21 +22,20 @@
   "license": "ISC",
   "dependencies": {
     "@babel/preset-react": "7.22.5",
-    "@cucumber/cucumber": "11.2.0",
-    "@playwright/test": "1.49.1",
-    "@reportportal/agent-js-playwright": "5.1.11",
+    "@cucumber/cucumber": "9.2.0",
+    "@playwright/test": "1.42.1",
     "@testing-library/jest-dom": "5.11.9",
     "@testing-library/react": "11.2.7",
     "@testing-library/react-hooks": "7.0.2",
+    "@zohodesk/testinglibrary": "^3.1.2",
     "babel-jest": "29.6.2",
     "babel-plugin-transform-dynamic-import": "2.1.0",
     "fast-glob": "3.3.1",
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
     "msw": "1.2.3",
-    "playwright": "1.49.1",
-    "supports-color": "8.1.1",
-    "playwright-bdd": "8.0.1"
+    "playwright": "1.42.1",
+    "supports-color": "8.1.1"
   },
   "bin": {
     "ZDTestingFramework": "./bin/cli.js"
@@ -55,6 +54,7 @@
     "@babel/preset-env": "7.22.15",
     "@babel/runtime": "7.22.15",
     "commander": "11.0.0",
-    "jest-html-reporter": "3.10.2"
+    "jest-html-reporter": "3.10.2",
+    "typescript": "5.4.2"
   }
 }

package/playwright.config.js

@@ -3,23 +3,45 @@ 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
+ */
 export default defineConfig({
   testDir: path.join(path.resolve(process.cwd()), 'uat'),
   outputDir: path.join(process.cwd(), 'uat', '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,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', '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/ },
     {
@@ -57,6 +79,32 @@ export default defineConfig({
       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,
+  // },
 });
 

package/build/core/playwright/fixtures.js

@@ -1,24 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _test = require("@playwright/test");
-var _playwrightBdd = require("playwright-bdd");
-var _readConfigFile = require("./readConfigFile");
-var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
-var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
-const {
-  bddMode
-} = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _playwrightBdd.test : _test.test;
-const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
-const buildInFixturesTest = base.extend({
-  ...buildInFixtures
-});
-const userFixtures = (0, _getUserFixtures.default)();
-const userFixturesTest = base.extend({
-  ...userFixtures
-});
-const test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
-module.exports = {
-  test
-};

package/build/setup-folder-structure/samples/accountLogin-sample.js

@@ -1,19 +0,0 @@
-// This is the sample file generated by testing framework. You can change as per the respective project login
-
-const getUrlOrigin = require('../shared/url-helpers/getUrlOrigin');
-
-async function accountLogin( { page, email, password } ) {
-  await page.locator('#login_id').fill(email);
-  await page.locator('#nextbtn').click();
-  await page.locator('#password').fill(password);
-  await page.locator('#nextbtn').click();
-
-  const domainUrlOrigin = getUrlOrigin(process.env.domain);
-  await page.waitForNavigation();
-  await Promise.race([
-    page.waitForURL(`${domainUrlOrigin}/**`),
-    page.waitForURL('**/announcement/**')
-  ]);
-}
-
-module.exports  = accountLogin;

package/build/setup-folder-structure/samples/actors-index.js

@@ -1,2 +0,0 @@
-const editions = require('./editions/index');
-module.exports = { editions }

package/build/setup-folder-structure/samples/editions-index.js

@@ -1,3 +0,0 @@
-const free = require('./free.json');
-const editions = { free};
-module.exports = editions;

package/build/setup-folder-structure/samples/free-sample.json

@@ -1,25 +0,0 @@
-[
-    {
-      "id": "1",
-      "edition": "free",
-      "orgName": "orgFree",
-      "profiles": [
-        {
-          "profile": "admin",
-          "email": "admin+free@zohotest.com",
-          "password": "password@0987"
-        },
-        {
-          "profile": "agent",
-          "email": "agent@zohotest.com",
-          "password": "password@12345"
-        },
-        {
-          "profile": "lightagent",
-          "email": "lightagent@zohotest.com",
-          "password": "password@12345"
-        }
-      ]
-    }
-  ]
-  

package/build/setup-folder-structure/samples/settings.json

@@ -1,7 +0,0 @@
-{
-  "environment": "dev",
-  "edition": "enterprise",
-  "profile": "admin",
-  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
-  "devUrl" : "" 
-}

package/build/setup-folder-structure/samples/testSetup-sample.js

@@ -1,14 +0,0 @@
-/* eslint-disable global-require */
-const accountLogin = require('./accountLogin');
-
-async function verifyPageIsLoaded({page}) {
-
-    //Implement your validation logic here
-    //Refer deskclientapp testSetup.js
-}
-
-module.exports = {
-  loginSteps:accountLogin,
-  validateLogin:verifyPageIsLoaded,
-  page:()=>{}
-};

package/build/test/core/playwright/buildInFixtures/__tests__/executionContext.test.js

@@ -1,27 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _page = require("../../../../../core/playwright/builtInFixtures/page");
-var _executionContext = _interopRequireDefault(require("../../../../../core/playwright/builtInFixtures/executionContext"));
-jest.mock('../../../../../core/playwright/builtInFixtures/page');
-describe('executionContext', () => {
-  test('should pass actorInfo with details from getCustomAccountDetails to use', async () => {
-    const mockTags = ['tag1', 'tag2'];
-    const mockActorInfo = {
-      id: '1',
-      edition: 'enterprise',
-      orgName: 'orgName',
-      profile: 'admin',
-      email: 'xxx.x+uat@zohotest.com'
-    };
-    _page.getCustomAccountDetails.mockReturnValue(mockActorInfo);
-    const use = jest.fn();
-    await _executionContext.default.executionContext({
-      $tags: mockTags
-    }, use);
-    expect(_page.getCustomAccountDetails).toHaveBeenCalledWith(mockTags);
-    expect(use).toHaveBeenCalledWith({
-      actorInfo: mockActorInfo
-    });
-  });
-});