@zohodesk/testinglibrary 0.4.24-experimental → 0.4.26-experimental

package/README.md

@@ -60,6 +60,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 */
 
@@ -34,6 +32,16 @@ function getCustomAccountDetails(tags) {
 const {
   testSetup
 } = (0, _readConfigFile.generateConfigFromFile)();
+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 performDefaultPageSteps({
   context,
   $tags,
@@ -50,12 +58,10 @@ async function performDefaultPageSteps({
   }
 }
 async function verifyPageIsLoaded(page) {
-  const urlOrigin = (0, _getUrlOrigin.default)(page.url());
-  const domainOrigin = (0, _getUrlOrigin.default)(process.env.domain);
-  if (urlOrigin === domainOrigin) {
-    return true;
+  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
+    return await testSetup.validateLogin(page);
   }
-  return false;
+  return true;
 }
 var _default = exports.default = {
   page: async ({
@@ -63,45 +69,38 @@ var _default = exports.default = {
     $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();
+    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);
+        isAuthMode
+      } = (0, _readConfigFile.generateConfigFromFile)();
+      if (!isAuthMode) {
+        return;
+      }
+      const testPortalDetails = getCustomAccountDetails($tags);
+      if (testPortalDetails) {
+        await context.clearCookies();
+        const {
+          email
+        } = testPortalDetails;
+        await (0, _auth.performLoginSteps)({
+          page,
+          $tags,
+          context,
+          authFilePrefix: email,
+          ...testPortalDetails
+        }, async () => {
+          return await verifyPageIsLoaded(page);
+        }, loginSteps);
+        process.env.actorInfo = JSON.stringify(testPortalDetails);
+      }
+    } catch (error) {
+      console.error('Error during page', error);
+    } finally {
       await performDefaultPageSteps({
         context,
         $tags,

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

@@ -8,7 +8,6 @@ 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 */
@@ -16,11 +15,13 @@ var _checkAuthDirectory = require("../checkAuthDirectory");
 async function performLoginSteps({
   page,
   authFilePrefix,
-  useremail,
-  password
-}, isLoggedIn) {
+  email,
+  password,
+  context,
+  $tags
+}, isLoggedIn, loginSteps) {
   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();
@@ -29,7 +30,13 @@ async function performLoginSteps({
     await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
     const isAlreadyLoggedIn = await isLoggedIn(page);
     if (!isAlreadyLoggedIn) {
-      await (0, _accountLogin.default)(page, useremail, password);
+      await loginSteps({
+        page,
+        email,
+        password,
+        context,
+        $tags
+      });
       await page.goto(process.env.domain);
       await isLoggedIn(page);
       await page.context().storageState({
@@ -37,12 +44,12 @@ async function performLoginSteps({
       });
     }
   } 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/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,13 @@ const use = {
   viewport,
   testIdAttribute
 };
+let reporter = [['html', {
+  outputFolder: reportPath,
+  open: openReportOn
+}], ['list'], ['./custom-reporter.js']];
+if (customReporter) {
+  reporter = [customReporter, ...reporter];
+}
 
 /**
  * Playwright configuration object
@@ -57,10 +65,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