@zohodesk/testinglibrary 3.0.4 → 3.0.8

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

@@ -20,27 +20,8 @@ var _browserTypes = require("./constants/browserTypes");
 var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
 var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
 var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
-function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
-  const {
-    browsers = null
-  } = userArgsObject;
-  let browserList = (0, _configUtils.getBrowsersList)(browsers);
-  const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
-  if (debug) {
-    playwrightArgs.push('--debug');
-  }
-  if (!bddMode && tagArgs) {
-    playwrightArgs.push('--grep');
-    playwrightArgs.push(tagArgs);
-  }
-  if (!headless && !userArgsObject.headed) {
-    playwrightArgs.push('--headed');
-  }
-  if (browserList && browserList.length > 0) {
-    browserList.map(browser => playwrightArgs.push(`--project=${_browserTypes.BROWSER_PROJECT_MAPPING[browser.toUpperCase()]}`));
-  }
-  return playwrightArgs;
-}
+var _RunnerHelper = _interopRequireDefault(require("./runner/RunnerHelper"));
+var _Runner = _interopRequireDefault(require("./runner/Runner"));
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
   const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
@@ -124,18 +105,11 @@ function main() {
   const userArgsObject = userArgConfig.getAll();
   const tagProcessor = new _tagProcessor.default(editionOrder);
   const tagArgs = tagProcessor.processTags(userArgsObject);
-  const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
-  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-  const command = playwrightPath;
-  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
-  const args = ['test', '--config', configPath].concat(playwrightArgs);
-  let promises = [];
-  if (bddMode) {
-    promises.push(runPreprocessing(tagArgs, configPath));
-  }
-  Promise.all(promises).then(() => runPlaywright(command, args)).catch(err => {
-    _logger.Logger.error(err);
-    process.exit();
-  });
+  const runnerObj = new _Runner.default();
+  runnerObj.setTagArgs(tagArgs);
+  runnerObj.setUserArgs(userArgsObject);
+  runnerObj.setConfig(uatConfig);
+  const runner = _RunnerHelper.default.createRunner('spawn', runnerObj);
+  runner.run();
 }
 var _default = exports.default = main;

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

@@ -0,0 +1,19 @@
+// 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/auth-setup-sample.js

@@ -5,17 +5,11 @@ import {
   getDefaultActor
 } from '@zohodesk/testinglibrary/helpers';
 
-const user = getDefaultActor();
+import { loginSteps , validateLogin } from './testSetup';
 
-async function verifyPageIsLoaded(page) {
-  //Implement your validation steps here
-  //Refer desk_client_app auth.setup.js
-  return true;
-}
+const user = getDefaultActor();
 
 setup(`${user.edition} - Authentication`, async ({ page }) => {
-
   //Implement performLoginSteps here
-  const { email, password } = user;
-  await performLoginSteps({ },verifyPageIsLoaded );
-});
+  await performLoginSteps({page, ...user},validateLogin ,loginSteps);
+}); 

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

@@ -0,0 +1,14 @@
+/* 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/setup-folder-structure/samples/uat-config-sample.js

@@ -1,3 +1,4 @@
+const testSetup = require('../../fixtures/testSetup');
 /**
  * @typedef {Object|null} viewportConfig
  * @property {number} width - width of the viewport
@@ -40,5 +41,6 @@ module.exports = {
   bddMode: true,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
-  viewport: { width: 1280, height: 720 }
+  viewport: { width: 1280, height: 720 },
+  testSetup
 }

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

@@ -73,6 +73,10 @@ function createAuthenticationFile() {
       }
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'accountLogin.js'), getSetupFileAsString('accountLogin-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating login script File ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'testSetup.js'), getSetupFileAsString('testSetup-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating testSetup File ....');
     } catch (err) {
       _logger.Logger.error(err);
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');

package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js

@@ -2,93 +2,70 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _fileMutex = _interopRequireDefault(require("../../../../../core/playwright/helpers/fileMutex"));
-var _lockfile = _interopRequireDefault(require("lockfile"));
+var _properLockfile = _interopRequireDefault(require("proper-lockfile"));
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
-jest.mock('lockfile');
+jest.mock('proper-lockfile');
 jest.mock('fs');
 describe('FileMutex', () => {
-  const mockDirectory = '/tmp';
-  const mockFileName = 'test_user';
-  const mockTimeout = {
-    wait: 5000,
-    retries: 5,
-    stale: 60000
+  const directory = '/tmp/locks';
+  const lockFileName = 'test-lock';
+  const options = {
+    stale: 10000,
+    retries: {
+      retries: 5,
+      factor: 1,
+      minTimeout: 5000,
+      maxTimeout: 8000
+    }
   };
+  const lockFilePath = _path.default.resolve(directory, lockFileName + '.lock');
   let fileMutex;
   beforeEach(() => {
-    fileMutex = new _fileMutex.default(mockDirectory, mockFileName, mockTimeout);
-  });
-  afterEach(() => {
+    fileMutex = new _fileMutex.default(directory, lockFileName, options);
     jest.clearAllMocks();
   });
   describe('acquire', () => {
-    it('should resolve when lockfile.lock succeeds and call getLockFilePath correctly', async () => {
-      const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
-      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
-        expect(lockPath).toBe(expectedPath);
-        expect(options).toEqual(mockTimeout);
-        callback(null);
-      });
-      await expect(fileMutex.acquire()).resolves.toBeUndefined();
-      expect(_lockfile.default.lock).toHaveBeenCalledWith(expectedPath, mockTimeout, expect.any(Function));
-    });
-    it('should reject when lockfile.lock fails', async () => {
-      const mockError = new Error('Lock failed');
-      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
-        expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
-        expect(options).toEqual(mockTimeout);
-        callback(mockError);
-      });
-      await expect(fileMutex.acquire()).rejects.toThrow('Lock failed');
-      expect(_lockfile.default.lock).toHaveBeenCalled();
-    });
-    it('should create the directory if it does not exist and acquire the lock', async () => {
+    it('should create the directory if it does not exist', async () => {
       _fs.default.existsSync.mockReturnValue(false);
-      _fs.default.mkdirSync.mockImplementation((dir, options) => {
-        expect(dir).toBe(mockDirectory);
-        expect(options).toEqual({
-          recursive: true
-        });
-      });
-      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
-        expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
-        expect(options).toEqual(mockTimeout);
-        callback(null);
-      });
-      await expect(fileMutex.acquire()).resolves.toBeUndefined();
-      expect(_fs.default.existsSync).toHaveBeenCalledWith(mockDirectory);
-      expect(_fs.default.mkdirSync).toHaveBeenCalledWith(mockDirectory, {
+      _fs.default.mkdirSync.mockImplementation(() => {});
+      _properLockfile.default.lock.mockResolvedValue();
+      await fileMutex.acquire();
+      expect(_fs.default.existsSync).toHaveBeenCalledWith(directory);
+      expect(_fs.default.mkdirSync).toHaveBeenCalledWith(directory, {
         recursive: true
       });
-      expect(_lockfile.default.lock).toHaveBeenCalled();
     });
-    it('should not create the directory if it already exists', async () => {
+    it('should create the lock file if it does not exist', async () => {
+      _fs.default.existsSync.mockImplementation(filePath => filePath !== lockFilePath);
+      _fs.default.writeFileSync.mockImplementation(() => {});
+      _properLockfile.default.lock.mockResolvedValue();
+      await fileMutex.acquire();
+      expect(_fs.default.existsSync).toHaveBeenCalledWith(lockFilePath);
+      expect(_fs.default.writeFileSync).toHaveBeenCalledWith(lockFilePath, 'locked');
+    });
+    it('should acquire the lock using proper-lockfile', async () => {
       _fs.default.existsSync.mockReturnValue(true);
-      _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
-        callback(null);
-      });
-      await expect(fileMutex.acquire()).resolves.toBeUndefined();
-      expect(_fs.default.mkdirSync).not.toHaveBeenCalled();
-      expect(_lockfile.default.lock).toHaveBeenCalled();
+      _properLockfile.default.lock.mockResolvedValue();
+      await fileMutex.acquire();
+      expect(_properLockfile.default.lock).toHaveBeenCalledWith(lockFilePath, options);
+    });
+    it('should throw an error if lock acquisition fails', async () => {
+      const errorMessage = 'Lock acquisition failed';
+      _properLockfile.default.lock.mockRejectedValue(new Error(errorMessage));
+      await expect(fileMutex.acquire()).rejects.toThrow(`Failed to acquire lock after ${options.retries.retries} attempts: ${errorMessage}`);
     });
   });
   describe('release', () => {
-    it('should resolve when lockfile.unlock succeeds and call getLockFilePath correctly', async () => {
-      const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
-      _lockfile.default.unlock.mockImplementation((path, callback) => {
-        callback(null);
-      });
-      await expect(fileMutex.release()).resolves.toBeUndefined();
-      expect(_lockfile.default.unlock).toHaveBeenCalledWith(expectedPath, expect.any(Function));
+    it('should release the lock using proper-lockfile', async () => {
+      _properLockfile.default.unlock.mockResolvedValue();
+      await fileMutex.release();
+      expect(_properLockfile.default.unlock).toHaveBeenCalledWith(lockFilePath);
     });
-    it('should reject when lockfile.unlock fails', async () => {
-      const mockError = new Error('Unlock failed');
-      _lockfile.default.unlock.mockImplementation((path, callback) => {
-        callback(mockError);
-      });
-      await expect(fileMutex.release()).rejects.toThrow('Unlock failed');
-      expect(_lockfile.default.unlock).toHaveBeenCalled();
+    it('should throw an error if lock release fails', async () => {
+      const errorMessage = 'Lock release failed';
+      _properLockfile.default.unlock.mockRejectedValue(new Error(errorMessage));
+      await expect(fileMutex.release()).rejects.toThrow(`Failed to release lock: ${errorMessage}`);
     });
   });
 });

package/build/test/core/playwright/runner/__tests__/RunnerHelper.test.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _RunnerHelper = _interopRequireDefault(require("../../../../../core/playwright/runner/RunnerHelper"));
+var _SpawnRunner = _interopRequireDefault(require("../../../../../core/playwright/runner/SpawnRunner"));
+describe('RunnerHelper', () => {
+  describe('createRunner', () => {
+    it('should throw error on invalid runner type', () => {
+      expect(() => _RunnerHelper.default.createRunner('invalid-type', {})).toThrow("Invalid runner type");
+    });
+    it('should create a valid runner class', () => {
+      const runnerInstance = _RunnerHelper.default.createRunner('spawn', {});
+      expect(runnerInstance).toBeInstanceOf(_SpawnRunner.default); // Directly pass the result
+    });
+  });
+});

package/build/test/core/playwright/runner/__tests__/SpawnRunner.test.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _RunnerHelper = _interopRequireDefault(require("../../../../../core/playwright/runner/RunnerHelper"));
+var _Runner = _interopRequireDefault(require("../../../../../core/playwright/runner/Runner"));
+var _Configuration = _interopRequireDefault(require("../../../../../core/playwright/configuration/Configuration"));
+jest.mock('child_process');
+jest.mock('../../../../../utils/logger');
+describe('SpawnRunner', () => {
+  let spawnRunner;
+  const runnerObj = new _Runner.default();
+  beforeEach(() => {
+    const config = new _Configuration.default({});
+    config.add("bddMode", true);
+    runnerObj.setConfig(config);
+    runnerObj.setTagArgs(["--headed"]);
+    spawnRunner = _RunnerHelper.default.createRunner('spawn', runnerObj);
+  });
+  describe('run', () => {
+    it('should call runPreprocessing when bddMode is true', () => {
+      const runPreprocessingSpy = jest.spyOn(spawnRunner, 'runPreprocessing').mockResolvedValue();
+      const runPlaywrightSpy = jest.spyOn(spawnRunner, 'runPlaywright').mockResolvedValue();
+      spawnRunner.run();
+      expect(runPreprocessingSpy).toHaveBeenCalled();
+    });
+  });
+});