@zohodesk/testinglibrary 3.0.7 → 3.0.9

package/.gitlab-ci.yml

@@ -18,14 +18,19 @@ default:
     paths:
       - node_modules
       - build
+      - npm-shrinkwrap.json
 
 # Install dependencies stage
 build:
   stage: build
   script:
+    - npm -v
+    - node -v
     - npm install --ignore-scripts
     - npm run build
     - npm install
+    - npm shrinkwrap
+    - npm run build
 
 # Unit tests stage
 unit:
@@ -101,7 +106,7 @@ uat-nobdd:
   script:
     - cd nobdd
     - npm install $(npm pack ../../testing-framework | tail -1)
-    - output=$(npm run uatnobdd)
+    - output=$(npm run uatnobdd -- --headless)
     - echo "$output"
     - node ../ValidateUATReport.js nobdd
 

package/README.md

@@ -29,6 +29,28 @@
 
 ## Version History
 
+### v3.0.8 - 25-12-2024
+
+#### Enhancement
+  - Added support to disable headless mode using command line arguments
+  - Proper validation added for node 14 build process
+  - Removed unwanted uat.config.js files in test projects (examples / nobdd)
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+  - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.
+  
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
+
+### v0.2.9.1 - 14-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations are unified 
+
 ### v0.2.9 - 25-10-2024
 
 #### Feature
@@ -60,6 +82,11 @@
 #### Issue Fix
 - Adding bddmode to get the fixtures.
 
+### v0.3.3 - 27-11-2024
+
+#### Feature
+- Custom report integration support (ReportPortal)
+
 ### v0.2.9.1 - 14-11-2024
 
 #### Enhancement

package/build/core/playwright/builtInFixtures/page.js

@@ -1,12 +1,10 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _auth = require("../helpers/auth");
-var _getUrlOrigin = _interopRequireDefault(require("../helpers/auth/getUrlOrigin"));
 var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
 
@@ -29,84 +27,68 @@ function getCustomAccountDetails(tags) {
     const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
     return user;
   }
-  return null;
+  return (0, _auth.getDefaultActor)();
 }
 const {
   testSetup
 } = (0, _readConfigFile.generateConfigFromFile)();
-async function performDefaultPageSteps({
-  context,
-  $tags,
-  page
-}) {
-  if (testSetup.page && typeof testSetup.page === 'function') {
-    await testSetup.page({
-      context,
-      $tags,
-      page
-    });
+async function loginSteps(pageDetail) {
+  const {
+    page
+  } = pageDetail;
+  if (testSetup.loginSteps && typeof testSetup.loginSteps === 'function') {
+    return await testSetup.loginSteps(pageDetail);
   } else {
     await page.goto(process.env.domain);
   }
 }
-async function verifyPageIsLoaded(page) {
-  const urlOrigin = (0, _getUrlOrigin.default)(page.url());
-  const domainOrigin = (0, _getUrlOrigin.default)(process.env.domain);
-  if (urlOrigin === domainOrigin) {
-    return true;
+async function performDefaultPageSteps(testInfo) {
+  if (testSetup.page && typeof testSetup.page === 'function') {
+    await testSetup.page(testInfo);
+  }
+}
+async function verifyPageIsLoaded(testInfo) {
+  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
+    return await testSetup.validateLogin(testInfo);
   }
-  return false;
+  return true;
 }
 var _default = exports.default = {
   page: async ({
     context,
     $tags,
     page
-  }, use) => {
-    const {
-      isAuthMode
-    } = (0, _readConfigFile.generateConfigFromFile)();
-    if (!isAuthMode) {
-      await use(page);
-      return;
-    }
-
-    //This block is used to skip the login process if the @unauthenticated tag is added to the script
-    if ($tags.includes('@unauthenticated')) {
-      await context.clearCookies();
-      await use(page);
-      return;
-    }
-    const testPortalDetails = getCustomAccountDetails($tags);
-    if (testPortalDetails === null) {
-      await performDefaultPageSteps({
-        context,
-        $tags,
-        page
-      });
-      const user = (0, _auth.getDefaultActor)();
-      process.env.actorInfo = JSON.stringify(user);
-      await use(page);
-    } else {
-      await context.clearCookies();
+  }, use, testInfo) => {
+    let testPortalDetails = getCustomAccountDetails($tags);
+    let testDetails = {
+      page,
+      $tags,
+      context,
+      ...testPortalDetails
+    };
+    try {
+      //This block is used to skip the login process if the @unauthenticated tag is added to the script
+      if ($tags.includes('@unauthenticated')) {
+        await context.clearCookies();
+        return;
+      }
       const {
-        email,
-        password
-      } = testPortalDetails;
-      await (0, _auth.performLoginSteps)({
-        page,
-        authFilePrefix: email,
-        useremail: email,
-        password: password
-      }, async () => {
-        return await verifyPageIsLoaded(page);
-      });
-      process.env.actorInfo = JSON.stringify(testPortalDetails);
-      await performDefaultPageSteps({
-        context,
-        $tags,
-        page
-      });
+        isAuthMode
+      } = (0, _readConfigFile.generateConfigFromFile)();
+      if (!isAuthMode) {
+        return;
+      }
+      if (testPortalDetails && testInfo.project.name !== 'setup') {
+        await context.clearCookies();
+        await (0, _auth.performLoginSteps)(testDetails, async testInfo => {
+          return await verifyPageIsLoaded(testInfo);
+        }, loginSteps);
+        process.env.actorInfo = JSON.stringify(testPortalDetails);
+      }
+    } catch (e) {
+      console.error('Error during page', e);
+    } finally {
+      await performDefaultPageSteps(testDetails);
       await use(page);
       await context.close();
     }

package/build/core/playwright/clear-caches.js

@@ -9,6 +9,7 @@ var _path = _interopRequireDefault(require("path"));
 var _fileUtils = require("../../utils/fileUtils");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
+var _checkAuthDirectory = require("./helpers/checkAuthDirectory");
 function deleteAuthFiles(authFilePath) {
   authFilePath = _path.default.resolve(process.cwd(), authFilePath);
   const authFileFolder = _path.default.dirname(authFilePath);
@@ -24,6 +25,11 @@ function deleteGeneratedFeatures() {
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting generated features at ${featuresGenPath}`);
   (0, _fileUtils.deleteFolder)(featuresGenPath);
 }
+function deleteLockFiles() {
+  const lockFilePath = (0, _checkAuthDirectory.getLockDirectoryPath)();
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting lock files at ${lockFilePath}`);
+  (0, _fileUtils.deleteFolder)(lockFilePath);
+}
 function clearCaches() {
   try {
     const {
@@ -33,6 +39,7 @@ function clearCaches() {
     deleteAuthFiles(authFilePath);
     deletePlaywrightReport(reportPath);
     deleteGeneratedFeatures();
+    deleteLockFiles();
     _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared. Now you can try running npm run uat');
   } catch (err) {
     _logger.Logger.error(err);

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

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CUSTOM_COMMANDS = void 0;
-const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers', 'filePath'];
+const CUSTOM_COMMANDS = exports.CUSTOM_COMMANDS = ['mode', 'tags', 'edition', 'browsers', 'filePath', 'headless'];

package/build/core/playwright/helpers/auth/loginSteps.js

@@ -8,41 +8,38 @@ exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
-var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
 /* eslint-disable no-console */
 
-async function performLoginSteps({
-  page,
-  authFilePrefix,
-  useremail,
-  password
-}, isLoggedIn) {
+async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {
+  let {
+    page,
+    authFilePrefix,
+    email
+  } = testInfo;
+  authFilePrefix = authFilePrefix || email;
   const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
-  const lockFileName = useremail.replace(/[@.]/g, '_');
+  const lockFileName = email.replace(/[@.]/g, '_');
   const fileMutex = new _fileMutex.default((0, _checkAuthDirectory.getLockDirectoryPath)(), lockFileName, _fileMutexConfig.LOGIN_MUTEX_TIMEOUT);
   try {
     await fileMutex.acquire();
     await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
-    await page.goto(process.env.domain);
-    await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
-    const isAlreadyLoggedIn = await isLoggedIn(page);
+    const isAlreadyLoggedIn = await isLoggedIn(testInfo);
     if (!isAlreadyLoggedIn) {
-      await (0, _accountLogin.default)(page, useremail, password);
-      await page.goto(process.env.domain);
-      await isLoggedIn(page);
+      await loginSteps(testInfo);
+      await isLoggedIn(testInfo);
       await page.context().storageState({
         path: authFile
       });
     }
   } catch (error) {
-    console.error(`Error during login for ${useremail}:`, error);
+    console.error(`Error during login for ${email}:`, error);
   } finally {
     try {
       await fileMutex.release();
     } catch (releaseError) {
-      console.error(`Error releasing lock for ${useremail}:`, releaseError);
+      console.error(`Error releasing lock for ${email}:`, releaseError);
     }
   }
 }

package/build/core/playwright/helpers/configFileNameProvider.js

@@ -16,7 +16,7 @@ function getUATFileName(mode) {
   if (_fs.default.existsSync(uatConfFilePath)) {
     return uatConfFilePath;
   }
-  return _path.default.resolve(process.cwd(), `uat.config.js`);
+  return _path.default.resolve(process.cwd(), `uat/conf/default/uat.config.js`);
 }
 function getEnvConfigFilePath(mode) {
   const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);

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

@@ -21,13 +21,13 @@ class FileMutex {
   }
   async acquire() {
     _assertClassBrand(_FileMutex_brand, this, _createDirectoryIfNotExist).call(this);
-    const lockFilePath = _path.default.resolve(this.directory, this.lockFileName);
+    const lockFilePath = _assertClassBrand(_FileMutex_brand, this, _getLockFilePath).call(this);
     try {
       if (!(0, _fs.existsSync)(lockFilePath)) {
         console.log(`[DEBUG] Creating missing lock file:`, this.lockFileName);
         (0, _fs.writeFileSync)(lockFilePath, 'locked');
       }
-      await _properLockfile.default.lock(_assertClassBrand(_FileMutex_brand, this, _getLockFilePath).call(this), this.options);
+      await _properLockfile.default.lock(lockFilePath, this.options);
     } catch (err) {
       throw new Error(`Failed to acquire lock after ${this.options.retries.retries} attempts: ${err.message}`);
     }

package/build/core/playwright/setup/config-creator.js

@@ -25,7 +25,8 @@ const {
   featureFilesFolder,
   stepDefinitionsFolder,
   testIdAttribute,
-  globalTimeout
+  globalTimeout,
+  customReporter
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -45,6 +46,15 @@ const use = {
   viewport,
   testIdAttribute
 };
+let reporter = [['html', {
+  outputFolder: reportPath,
+  open: openReportOn
+}], ['list'], ['json', {
+  outputFile: _path.default.join(process.cwd(), 'uat', 'test-results', 'test-results.json')
+}], ['./custom-reporter.js']];
+if (customReporter) {
+  reporter = [customReporter, ...reporter];
+}
 
 /**
  * Playwright configuration object
@@ -57,10 +67,7 @@ function getPlaywrightConfig() {
     globalTimeout: globalTimeout || 3600000,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
     fullyParallel: true,
-    reporter: [['html', {
-      outputFolder: reportPath,
-      open: openReportOn
-    }], ['list'], ['./custom-reporter.js']],
+    reporter,
     timeout: testTimeout,
     expect: {
       timeout: expectTimeout

package/build/index.js

@@ -70,6 +70,12 @@ Object.defineProperty(exports, "performLoginSteps", {
     return _index.performLoginSteps;
   }
 });
+Object.defineProperty(exports, "setup", {
+  enumerable: true,
+  get: function () {
+    return _index.setup;
+  }
+});
 Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {

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__/configFileNameProvider.test.js

@@ -24,7 +24,7 @@ describe('getUATFileName', () => {
   });
   test('return the default config files for pipeline matched files not exists', () => {
     const mode = 'ci';
-    const defaultPath = `${mockCwd}/uat.config.js`;
+    const defaultPath = `${mockCwd}/uat/conf/default/uat.config.js`;
     _fs.existsSync.mockReturnValue(false);
     _path.default.resolve.mockImplementation((...args) => args.join('/'));
     const result = (0, _configFileNameProvider.getUATFileName)(mode);