@zohodesk/testinglibrary 0.4.43-experimental → 0.4.45-experimental

package/build/test/core/playwright/__tests__/tagProcessor.test.js

@@ -2,7 +2,6 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _tagProcessor = _interopRequireDefault(require("../../../../../src/core/playwright/tagProcessor"));
-var _Configuration = _interopRequireDefault(require("../../../../../src/core/playwright/configuration/Configuration.js"));
 var _logger = require("../../../../utils/logger");
 jest.mock('../../../../utils/logger');
 describe('TagProcessor', () => {
@@ -12,83 +11,83 @@ describe('TagProcessor', () => {
   });
   test('should return tagArgs if no edition is provided', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: null
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1');
   });
   test('should handle a single edition with <= operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '<=edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
   });
   test('should handle a single edition with >= operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '>=edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1)');
   });
   test('should handle a single edition with < operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '<edition3'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
   });
   test('should handle a single edition with > operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: '>edition1'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1)');
   });
   test('should handle a single edition with no operator', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'edition2'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition1 or @edition_edition3 or @edition_edition4)');
   });
   test('should log a message if edition is not found', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'nonexistentEdition'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1');
     expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.INFO_TYPE, expect.stringContaining('No matching editions for nonexistentEdition found.'));
   });
   test('should handle multiple editions', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: 'tag1',
       edition: 'edition1,edition3'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('tag1 and not (@edition_edition2 or @edition_edition4)');
   });
   test('should build tags correctly when tags are empty', () => {
     const tagProcessor = new _tagProcessor.default(editionOrder);
-    const userArgs = new _Configuration.default({
+    const userArgs = {
       tags: '',
       edition: 'edition1'
-    });
+    };
     const result = tagProcessor.processTags(userArgs);
     expect(result).toBe('not (@edition_edition2 or @edition_edition3 or @edition_edition4)');
   });

package/nobdd/README.md

@@ -0,0 +1 @@
+npm install $(npm pack ../ | tail -1)

package/nobdd/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "testingframeworknobdd",
+  "version": "1.0.0",
+  "description": "collection of examples that we can use for testing",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "uat": "ZDTestingFramework test --mode=dev --headed",
+    "uatnobdd": "ZDTestingFramework test --mode=nobdd",
+    "uat-ci": "ZDTestingFramework test --mode=ci --headed",
+    "uat-clean": "ZDTestingFramework clearCaches",
+    "uat-debug": "ZDTestingFramework test --mode=dev --debug",
+    "uat-report": "ZDTestingFramework report --port=9009",
+    "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
+  }
+}

package/nobdd/src/App.js

@@ -0,0 +1,7 @@
+export function add(a, b) {
+  return a + b;
+}
+
+export function greet(name) {
+  return `Hello, ${name}!`;
+}

package/nobdd/uat/conf/default/actors/editions/enterprise.json

@@ -0,0 +1,24 @@
+[
+  {
+    "id": "1",
+    "edition": "enterprise",
+    "orgName": "zohodeskteam",
+    "profiles": [
+      {
+        "profile": "admin",
+        "email": "solairaj.m+26jun2023@zohotest.com",
+        "password": "Demo@1201"
+      },
+      {
+        "profile": "agent",
+        "email": "anitha.m+agentat@zohotest.com",
+        "password": "Desk@1234"
+      },
+      {
+        "profile": "lightagent",
+        "email": "anitha.m+admin@zohotest.com",
+        "password": "Moon@2018"
+      }
+    ]
+  }
+]

package/nobdd/uat/conf/default/actors/editions/index.js

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

package/nobdd/uat/conf/default/actors/index.js

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

package/nobdd/uat/conf/default/settings.json

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

package/nobdd/uat/conf/nobdd/uat.config.js

@@ -0,0 +1,36 @@
+const customFixtures = require('../../shared/commands/_index-custom-fixtures');
+
+const { getDefaultActor } = require('@zohodesk/testinglibrary/helpers');
+
+function getPrimaryCookiePath() {
+  const { email } = getDefaultActor();
+  return `uat/playwright/.auth/${email}-cookies.json`;
+}
+
+/**
+ * Represents the user configuration object.
+ * @typedef {import('@zohodesk/testinglibrary').UserConfig} UserConfig
+ */
+module.exports = {
+  headless: false,
+  retries:1,
+  openReportOn: 'never',
+  browsers: ['Chrome'],
+  isAuthMode: true,
+  authFilePath: getPrimaryCookiePath(),
+  trace: 'retain-on-failure',
+  video: 'retain-on-failure',
+  retries:1,
+  bddMode: false,
+  expectTimeout: 10 * 1000,
+  testTimeout: 60 * 1000,
+  globalTimeout: 2 * 60 * 60 * 1000,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
+  viewport: { width: 1280, height: 720 },
+  testIdAttribute: 'data-id',
+  editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
+  additionalPages: {
+    ...customFixtures
+  }
+};

package/nobdd/uat/env-config.json

@@ -0,0 +1,20 @@
+{
+  "dev": {
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  },
+  "prod": {
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+    "orgName": "sangeetha.t@zohocorp.com",
+    "deptName": "sangeethat",
+    "moduleName": "sangeethat"
+  },
+  "ci": {
+    "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+    "orgName": "clientcicdk8",
+    "deptName": "clientcicdk8",
+    "moduleName": "tickets"
+  }
+}

package/nobdd/uat/fixtures/auth.setup.js

@@ -0,0 +1,44 @@
+/* eslint-disable no-console */
+import {
+  test as setup,
+  expect
+} from '@zohodesk/testinglibrary';
+import {
+  getDefaultActor,
+  getUserForSelectedEditionAndProfile,
+  performLoginSteps
+} from '@zohodesk/testinglibrary/helpers'
+import { SETUP_HOME_PAGE_SELECTORS } from '../modules/Setup/dom-selectors/SetupSelectors';
+import getUrlOrigin from '../shared/url-helpers/getUrlOrigin';
+
+const { edition, profile } = getDefaultActor();
+
+const user = getUserForSelectedEditionAndProfile(edition, profile);
+
+async function verifyPageIsLoaded(page) {
+  const urlOrigin = getUrlOrigin(page.url());
+  const domainOrigin = getUrlOrigin(process.env.domain);
+  if (urlOrigin === domainOrigin) {
+    await expect(
+      page
+        .locator('header')
+        .getByLabel(SETUP_HOME_PAGE_SELECTORS.SETUP_ICON_LABEL)
+    ).toBeVisible();
+    return true;
+  }
+  return false;
+}
+
+setup(`${user.edition} - Authentication`, async ({ page }) => {
+  const { email, password } = user;
+  await performLoginSteps(
+    {
+      page,
+      authFilePrefix: email,
+      useremail: email,
+      password: password
+    },
+    verifyPageIsLoaded
+  );
+  //await completeOnboardings({ page });
+});

package/nobdd/uat/fixtures/setup.teardown.js

@@ -0,0 +1,33 @@
+import fs from 'fs';
+import path from 'path';
+import {
+  test as teardown,
+  expect
+} from '@zohodesk/testinglibrary';
+import { isDevelopmentSetup, loadCookiesIfPresent } from '@zohodesk/testinglibrary/helpers'
+import getUrlOrigin from '../shared/url-helpers/getUrlOrigin';
+
+// We are adding teardown logic only in CI mode
+if (!isDevelopmentSetup()) {
+  teardown(`Log out scenarios`, async ({ page }) => {
+    const authDirectory = path.resolve(
+      process.cwd(),
+      'uat',
+      'playwright',
+      '.auth'
+    );
+    const files = fs.readdirSync(authDirectory);
+    const promises = files.map(async file => {
+      const authFilePath = path.join(authDirectory, file);
+      await loadCookiesIfPresent(page, authFilePath);
+      const domainOrigin = getUrlOrigin(process.env.domain);
+      const logoutURL = `${domainOrigin}/support/logout.sas`;
+      await page.goto(logoutURL);
+      await page.waitForNavigation();
+      await expect(page.locator('[id="signin_flow"]')).toBeVisible();
+      await fs.rmSync(authFilePath);
+    });
+
+    await Promise.all(promises);
+  });
+}

package/nobdd/uat/modules/nobdd/steps/VerifyNoBDD.feature.spec.js

@@ -0,0 +1,16 @@
+import { test, expect } from "@zohodesk/testinglibrary";
+
+test.describe("Verify no authentication required @nobdd", () => {
+
+  test("Verify the page is not logged in", async ({ page }) => {
+
+    await page.goto(process.env.domain);
+
+    await page.waitForSelector('#login');
+
+    const isLoggedIn = await page.isVisible('#login');
+    expect(isLoggedIn).toBe(true);
+
+  });
+
+});

package/nobdd/uat/shared/commands/_index-custom-fixtures.js

@@ -0,0 +1,9 @@
+const i18n = require('./i18n');
+const unAuthenticatedPage = require('./unauthenticatedPage');
+
+const customFixtures = {
+  ...i18n,
+  ...unAuthenticatedPage
+};
+
+module.exports = customFixtures;

package/nobdd/uat/shared/commands/i18n.js

@@ -0,0 +1,25 @@
+/* eslint-disable no-param-reassign */
+
+// Note: We are duplicating below method from @zohodesk/i18n. We are not importing it as react package not yet availble in test environment.
+function replaceI18NValuesWithRegex(i18nStr, values) {
+  if (typeof values !== 'undefined') {
+    if (Array.isArray(values)) {
+      for (let i = 0; i < values.length; i++) {
+        i18nStr = i18nStr.replace(new RegExp(`\\{${i}\\}`, 'g'), values[i]);
+      }
+    } else {
+      i18nStr = i18nStr.replace(new RegExp('\\{0\\}', 'g'), values);
+    }
+  }
+  return i18nStr;
+}
+
+module.exports = {
+  i18N: async ({ page }, use) => {
+    await use(async (key, values) => {
+      const i18nValue = await page.evaluate((i18nKey) => window.i18n[i18nKey], key);
+      const i18nStr = replaceI18NValuesWithRegex(i18nValue, values)
+      return i18nStr;
+    })
+  }
+}

package/nobdd/uat/shared/commands/unauthenticatedPage.js

@@ -0,0 +1,8 @@
+module.exports = {
+  unauthenticatedPage: async ({ browser }, use) => {
+    const context = await browser.newContext({ storageState: null });
+    const unauthenticatedPage = await context.newPage();
+    await use(unauthenticatedPage);
+    await context.close();
+  }
+}

package/nobdd/uat/shared/index.js

@@ -0,0 +1,7 @@
+const completeOnboardings = require("./onboardings/onboardingUpdate")
+
+
+
+module.exports = {
+    completeOnboardings
+}

package/nobdd/uat/shared/onboardings/onboardingUpdate.js

@@ -0,0 +1,44 @@
+async function get_cookie(page) {
+  return page.evaluate(async () => {
+    const results = document.cookie.match(`crmcsr=(.*?)(;|$)`);
+    if (results) {
+      return unescape(results[1]);
+    }
+    return null;
+  });
+}
+
+async function getOnboardings({ page, cookieVal }) {
+  return page.evaluate(
+    async (cookieVal) =>
+      fetch('/api/v1/onboardingStatus', {
+        method: 'GET',
+        headers: {
+          orgId: window.currentOrg.id,
+          'X-ZCSRF-TOKEN': `crmcsrfparam=${cookieVal}`
+        }
+      }).then((r) => (r.ok ? r.json() : Promise.reject(r))),
+    cookieVal
+  );
+}
+
+async function completeOnboardings({ page }) {
+  const cookieVal = await get_cookie(page);
+  const onboardings = await getOnboardings({ page });
+  if (onboardings.pending.length) {
+    await page.evaluate(
+      async ({ cookieVal, onboardings }) =>
+        fetch('/api/v1/onboardingStatus/markComplete', {
+          method: 'POST',
+          headers: {
+            orgId: window.currentOrg.id,
+            'X-ZCSRF-TOKEN': `crmcsrfparam=${cookieVal}`
+          },
+          body: JSON.stringify({ items: onboardings.pending })
+        }),
+      { cookieVal, onboardings }
+    );
+  }
+}
+
+module.exports = completeOnboardings;

package/nobdd/uat/shared/url-helpers/getUrlOrigin.js

@@ -0,0 +1,6 @@
+function getUrlOrigin(url) {
+  const { origin } = new URL(url);
+  return origin;
+}
+
+module.exports = getUrlOrigin;

package/nobdd/uat.config.js

@@ -0,0 +1,37 @@
+const customFixtures = require('./uat/shared/commands/_index-custom-fixtures');
+
+const { getDefaultActor } = require('@zohodesk/testinglibrary/helpers');
+
+function getPrimaryCookiePath() {
+  const { email } = getDefaultActor();
+  return `uat/playwright/.auth/${email}-cookies.json`;
+}
+
+/**
+ * Represents the user configuration object.
+ * @typedef {import('@zohodesk/testinglibrary').UserConfig} UserConfig
+ */
+module.exports = {
+  headless: false,
+  retries:1,
+  openReportOn: 'never',
+  browsers: ['Chrome'],
+  isAuthMode: true,
+  authFilePath: getPrimaryCookiePath(),
+  trace: 'retain-on-failure',
+  video: 'retain-on-failure',
+  retries:1,
+  bddMode: false,
+  expectTimeout: 10 * 1000,
+  testTimeout: 60 * 1000,
+  globalTimeout: 2 * 60 * 60 * 1000,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
+  viewport: { width: 1280, height: 720 },
+  testIdAttribute: 'data-id',
+  editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
+  additionalPages: {
+    ...customFixtures
+  },
+  url:""
+};