@zohodesk/testinglibrary 0.4.4-experimental → 0.4.5-experimental

package/.gitlab-ci.yml

@@ -1,8 +1,8 @@
-image: node:14.17.3
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
 
-workflow:
-  rules:
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+#workflow:
+#  rules:
+#    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
 
 stages:
   - build
@@ -12,7 +12,7 @@ stages:
 # Install dependencies stage
 build:
   stage: build
-  image: node:14.17.3
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
     - npm install
   artifacts:
@@ -23,22 +23,89 @@ build:
 # Unit tests stage
 unit:
   stage: unit
-  image: node:14.17.3
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
-    - npm test
+    - npm run test
   artifacts:
     when: always
     paths:
-      - test-reports
+      - unit_reports
 
-uat:
+# UAT tests stage
+uat-auth:
   stage: uat
-  image: node:14.17.3
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
   script:
+    - npm install 
+    - npm run build
     - cd examples
-    - npm i
-    - npm run uat
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatauth)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
   artifacts:
     when: always
     paths:
-      - uat-reports
+      - examples/uat/playwright-report
+
+uat-noauth:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnoauth)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+    
+uat-profile:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatprofile)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+uat-nobdd:
+  stage: uat
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  script:
+    - npm install 
+    - npm run build
+    - cd nobdd
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnobdd)
+    - echo "$output"
+    - if [[ "$output" == *"failed"* ]]; then
+    -   exit 1
+    - fi
+
+
+  artifacts:
+    when: always
+    paths:
+      - nobdd/uat/playwright-report
+

package/README.md

@@ -32,4 +32,9 @@
   - Added support for scenario level tag support
   - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
   - Mode based configuration implementations
-  - @only option enabled in dev pipeline
+  - @only option enabled in dev pipeline
+
+### v0.3.0 - 06-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations unified

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

@@ -58,11 +58,16 @@ function getListOfActors(betaFeature) {
   } = (0, _readConfigFile.generateConfigFromFile)();
   const mode = getRunMode();
   let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
+  let betaReference = mode;
   if (!(0, _fs.existsSync)(configFile)) {
     configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
+    betaReference = "default";
   }
   if (betaFeature) {
-    configFile = _path.default.join(uatDirectory, `conf/default/actors/beta/${betaFeature}/index.js`);
+    configFile = _path.default.join(uatDirectory, `conf/${betaReference}/actors/beta/${betaFeature}/index.js`);
+    if (!(0, _fs.existsSync)(configFile)) {
+      throw new Error(`There is no beta feature configured with the name "${betaFeature}"`);
+    }
   }
   try {
     return require(configFile);
@@ -76,39 +81,12 @@ function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile,
     throw new Error("The actors data is missing.");
   }
   const {
-    editions: userdata,
-    beta: betaPortals
+    editions: userdata
   } = actorsData;
   const defaultConf = getDefaultActorConf();
   const edition = preferedEdition || defaultConf.edition;
   const profile = preferredProfile || defaultConf.profile;
   let selectedProfile = {};
-  // if (betaFeature && betaFeature !== null) {
-  //   if (!betaPortals.hasOwnProperty(betaFeature)) {
-  //     throw new Error(`There is no "${betaFeature}" beta feature configured.`);
-  //   }
-
-  //   const betaEdition = betaPortals[betaFeature][edition].find(
-  //     portal => portal.edition === edition
-  //   );
-  //   if (!betaEdition) {
-  //     throw new Error(
-  //       `There is no "${edition}" edition configured in "${betaFeature}" beta feature.`
-  //     );
-  //   }
-
-  //   const { profiles: betaProfiles, ...betaEditionData } = betaEdition;
-  //   selectedProfile = betaProfiles.find(user => user.profile === profile);
-  //   if (!selectedProfile) {
-  //     throw new Error(
-  //       `There is no "${profile}" configured in edition of "${edition}" in "${betaFeature}" beta features.`
-  //     );
-  //   }
-  //   return {
-  //     ...betaEditionData,
-  //     ...selectedProfile
-  //   };
-  // }
 
   // TODO: We are returning the first data from array. We need to check the possiblity of having multiple users for same profile and possibly round robin
   // For this we need to get the data from ci environment.

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

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+jest.mock('fs');
+jest.mock('path');
+jest.mock('../../../../../core/playwright/readConfigFile', () => ({
+  generateConfigFromFile: jest.fn(() => ({
+    uatDirectory: '/test/directory'
+  })),
+  getRunMode: jest.fn(() => 'dev')
+}));
+const {
+  getListOfActors
+} = require('../../../../../core/playwright/helpers/auth/getUsers');
+describe('getListOfActors', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    _path.default.join.mockImplementation((...args) => args.join('/'));
+  });
+  test('throws an error when config file cannot be loaded', () => {
+    _fs.existsSync.mockReturnValueOnce(true); // Main config file exists
+
+    jest.mock('/test/directory/conf/dev/actors/index.js', () => {
+      throw new Error('Loading error');
+    }, {
+      virtual: true
+    });
+    expect(() => getListOfActors()).toThrow('Error loading actor configuration from /test/directory/conf/dev/actors/index.js');
+  });
+  test('throws an error when beta feature config does not exist', () => {
+    _fs.existsSync.mockReturnValueOnce(true) // Main config file exists
+    .mockReturnValueOnce(false); // Beta feature config does not exist in either path
+
+    const betaFeature = 'nonExistentFeature';
+    expect(() => getListOfActors(betaFeature)).toThrow(`There is no beta feature configured with the name "${betaFeature}"`);
+  });
+  test('loads main configuration when betaFeature is not provided and main config file exists', () => {
+    _fs.existsSync.mockReturnValueOnce(true);
+    jest.doMock('/test/directory/conf/dev/actors/index.js', () => ({
+      actors: []
+    }), {
+      virtual: true
+    });
+    const result = getListOfActors();
+    expect(result).toEqual({
+      actors: []
+    });
+  });
+  test('falls back to default configuration if main config file does not exist', () => {
+    _fs.existsSync.mockReturnValueOnce(false).mockReturnValueOnce(true);
+    jest.doMock('/test/directory/conf/default/actors/index.js', () => ({
+      actors: []
+    }), {
+      virtual: true
+    });
+    const result = getListOfActors();
+    expect(result).toEqual({
+      actors: []
+    });
+  });
+  test('loads beta feature configuration when betaFeature is provided', () => {
+    _fs.existsSync.mockReturnValueOnce(true) // Main config file exists
+    .mockReturnValueOnce(true); // Beta feature config exists
+
+    const betaFeature = 'parentchild';
+    const betaFeaturePath = `/test/directory/conf/dev/actors/beta/${betaFeature}/index.js`;
+    jest.doMock(betaFeaturePath, () => ({
+      betaActors: []
+    }), {
+      virtual: true
+    });
+    const result = getListOfActors(betaFeature);
+    expect(result).toEqual({
+      betaActors: []
+    });
+    expect(_path.default.join).toHaveBeenCalledWith('/test/directory', `conf/dev/actors/beta/${betaFeature}/index.js`);
+  });
+});

package/jest.config.js

@@ -5,6 +5,16 @@ const appPath = process.cwd();
 const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
 
 module.exports = {
+  reporters: [
+    "default",
+    [
+      "jest-html-reporter",
+      {
+        outputPath: "unit_reports/unit-report.html",
+        pageTitle: "Unit Report"
+      }
+    ]
+  ],
   rootDir: process.cwd(),
   testEnvironment: 'node',
 

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/beta/custom-module.json

@@ -0,0 +1,24 @@
+[
+  {
+    "id": "1",
+    "edition": "enterprise",
+    "orgName": "custommoduleportal",
+    "profiles": [
+      {
+        "profile": "admin",
+        "email": "indragith.m+agent@zohotest.com",
+        "password": "Paara!2019"
+      },
+      {
+        "profile": "agent",
+        "email": "indragith.m+agent@zohotest.com",
+        "password": "Paara!2019"
+      },
+      {
+        "profile": "lightagent",
+        "email": "indragith.m+abc1@zohotest.com",
+        "password": "Paara!2019"
+      }
+    ]
+  }
+]

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

@@ -0,0 +1,6 @@
+const parentchild = require('./parent-child.json');
+const custommodule = require('./custom-module.json');
+
+const beta = { parentchild, custommodule };
+
+module.exports = beta;

package/nobdd/uat/conf/default/actors/beta/parent-child.json

@@ -0,0 +1,24 @@
+[
+  {
+    "id": "1",
+    "edition": "enterprise",
+    "orgName": "parentchildportal",
+    "profiles": [
+      {
+        "profile": "admin",
+        "email": "indragith.m@zohocorp.com",
+        "password": "Paara!2019"
+      },
+      {
+        "profile": "agent",
+        "email": "indragith.m+agent@zohotest.com",
+        "password": "Paara!2019"
+      },
+      {
+        "profile": "lightagent",
+        "email": "indragith.m+abc1@zohotest.com",
+        "password": "Paara!2019"
+      }
+    ]
+  }
+]

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,5 @@
+const editions = require('./editions/index');
+const beta = require('./beta/index');
+
+
+module.exports = { editions, beta }

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

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

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

@@ -0,0 +1,28 @@
+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: true,
+  openReportOn: 'never',
+  browsers: ['Chrome'],
+  isAuthMode: false,
+  authFilePath: getPrimaryCookiePath(),
+  trace: true,
+  video: true,
+  bddMode: false,
+  viewport: { width: 1280, height: 720 },
+  testIdAttribute: 'data-id',
+  additionalPages: {
+    ...customFixtures
+  }
+};

package/nobdd/uat/env-config.json

@@ -0,0 +1,20 @@
+{
+  "dev": {
+    "domain": "https://desk.localzoho.com/agent",
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
+  },
+  "prod": {
+    "domain": "https://desk.localzoho.com/agent/",
+    "orgName": "sangeetha.t@zohocorp.com",
+    "deptName": "sangeethat",
+    "moduleName": "sangeethat"
+  },
+  "ci": {
+    "domain": "https://zdesk-devops08.csez.zohocorpin.com:31007/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,32 @@
+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);
+      await page.goto(`${domainOrigin}/support/logout.sas `);
+      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('https://desk.localzoho.com/');
+
+    await page.waitForSelector('.zgh-accounts');
+
+    const isLoggedIn = await page.isVisible('.zgh-accounts');
+    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,30 @@
+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,
+  openReportOn: 'never',
+  browsers: ['Chrome'],
+  isAuthMode: true,
+  authFilePath: getPrimaryCookiePath(),
+  trace: true,
+  video: true,
+  bddMode: true,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
+  viewport: { width: 1280, height: 720 },
+  testIdAttribute: 'data-id',
+  additionalPages: {
+    ...customFixtures
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.4.4-experimental",
+  "version": "0.4.5-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -53,6 +53,7 @@
     "@babel/preset-env": "7.22.15",
     "@babel/runtime": "7.22.15",
     "commander": "^11.0.0",
+    "jest-html-reporter": "^3.10.2",
     "typescript": "^5.4.2"
   }
 }