@zohodesk/testinglibrary 0.4.23-experimental → 0.4.24-experimental

package/build/bdd-framework/utils/exit.js

@@ -1,62 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.exit = exit;
-exports.withExitHandler = withExitHandler;
-var _worker_threads = require("worker_threads");
-/**
- * Exit utils.
- *
- * When calling process.exit() in worker thread used for test-file generation,
- * logs are not flushed (https://github.com/vitalets/playwright-bdd/issues/59).
- * That's why instead of process.exit we throw ExitError
- * that just sets process.exitCode = 1 and allow program to exit normally.
- * This esnured by wrapping code with withExitHandler().
- *
- * On the other hand, when running in the main thread, especially inside Playwright,
- * thrown error is captured by Playwright and show with additional messages (e.g. no tests found).
- * That's why in main thread we to call process.exit() to show only needed error.
- *
- * Relevant discussions:
- * - https://github.com/nodejs/node/issues/6379
- * - https://github.com/nodejs/node-v0.x-archive/issues/3737
- * - https://github.com/cucumber/cucumber-js/pull/123
- */
-
-class ExitError extends Error {
-  get stack() {
-    return '';
-  }
-}
-async function withExitHandler(fn) {
-  try {
-    return await fn();
-  } catch (e) {
-    if (e instanceof ExitError) {
-      if (e.message) {
-        // eslint-disable-next-line no-console
-        console.error(e.message);
-      }
-      process.exitCode = 1;
-    } else {
-      throw e;
-    }
-  }
-}
-function exit(...messages) {
-  messages = messages.filter(Boolean);
-  if (_worker_threads.isMainThread) {
-    // use console.error() here instead of logger.error() to have less stack
-    // for flushing messages to stderr.
-
-    if (messages.length) {
-      // eslint-disable-next-line no-console, max-depth
-      console.error('Error:', ...messages);
-    }
-    process.exit(1);
-  } else {
-    throw new ExitError(messages.join(' '));
-  }
-}

package/build/bdd-framework/utils/index.js

@@ -1,93 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.callWithTimeout = callWithTimeout;
-exports.extractTemplateParams = extractTemplateParams;
-exports.getPackageVersion = getPackageVersion;
-exports.getSymbolByName = getSymbolByName;
-exports.omit = omit;
-exports.removeDuplicates = removeDuplicates;
-exports.resolvePackageRoot = resolvePackageRoot;
-exports.stringifyLocation = stringifyLocation;
-exports.template = template;
-exports.toPosixPath = toPosixPath;
-var _fs = _interopRequireDefault(require("fs"));
-var _path = _interopRequireDefault(require("path"));
-var _util = require("util");
-const setTimeoutPromise = (0, _util.promisify)(setTimeout);
-/**
- * Returns Symbol by name.
- * See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
- */
-function getSymbolByName(target, name) {
-  const ownKeys = Reflect.ownKeys(target);
-  const symbol = ownKeys.find(key => key.toString() === `Symbol(${name})`);
-  if (!symbol) {
-    throw new Error(`Symbol "${name}" not found in target. ownKeys: ${ownKeys}`);
-  }
-  return symbol;
-}
-/**
- * Inserts params into template.
- * Params defined as <param>.
- */
-function template(t, params = {}) {
-  return t.replace(/<(.+?)>/g, (match, key) => {
-    return params[key] !== undefined ? String(params[key]) : match;
-  });
-}
-/**
- * Extracts all template params from string.
- * Params defined as <param>.
- */
-function extractTemplateParams(t) {
-  return [...t.matchAll(/<(.+?)>/g)].map(m => m[1]);
-}
-function removeDuplicates(arr) {
-  return [...new Set(arr)];
-}
-function resolvePackageRoot(packageName) {
-  const packageJsonPath = require.resolve(`${packageName}/package.json`);
-  return _path.default.dirname(packageJsonPath);
-}
-function getPackageVersion(packageName) {
-  const packageRoot = resolvePackageRoot(packageName);
-  const packageJsonPath = _path.default.join(packageRoot, 'package.json');
-  const packageJson = JSON.parse(_fs.default.readFileSync(packageJsonPath, 'utf8'));
-  return packageJson.version || '';
-}
-async function callWithTimeout(fn, timeout, timeoutMsg) {
-  if (!timeout) {
-    return fn();
-  }
-  const ac = new AbortController();
-  return Promise.race([fn(), setTimeoutPromise(timeout, null, {
-    ref: false,
-    signal: ac.signal
-  }).then(() => {
-    throw new Error(timeoutMsg || `Function timeout (${timeout} ms)`);
-  })]).finally(() => ac.abort());
-}
-function stringifyLocation({
-  line,
-  column
-}) {
-  return `${line}:${column}`;
-}
-function omit(obj, key) {
-  const res = {
-    ...obj
-  };
-  delete res[key];
-  return res;
-}
-/**
- * Returns path with "/" separator on all platforms.
- * See: https://stackoverflow.com/questions/53799385/how-can-i-convert-a-windows-path-to-posix-path-using-node-path
- */
-function toPosixPath(somePath) {
-  return somePath.split(_path.default.sep).join(_path.default.posix.sep);
-}

package/build/bdd-framework/utils/jsStringWrap.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.jsStringWrap = jsStringWrap;
-/**
- * Adopted version of https://github.com/joliss/js-string-escape
- * - added support of backticks
- * - added 'quotes' option to indicate which quotes to escape
- * - wrap result string with provided quotes
- *
- * Considered alternative is https://github.com/mathiasbynens/jsesc,
- * but it provides additional functionality and much slower
- * See: https://github.com/mathiasbynens/jsesc/issues/16
- */
-function jsStringWrap(str, {
-  quotes = 'single'
-} = {}) {
-  const wrapQuote = quotes === 'single' ? "'" : quotes === 'double' ? '"' : '`';
-  // eslint-disable-next-line complexity
-  const escapedStr = ('' + str).replace(/["'`\\\n\r\u2028\u2029]/g, character => {
-    // Escape all characters not included in SingleStringCharacters and
-    // DoubleStringCharacters on
-    // http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4
-    switch (character) {
-      case wrapQuote:
-      case '\\':
-        return '\\' + character;
-      // Four possible LineTerminator characters need to be escaped:
-      case '\n':
-        return '\\n';
-      case '\r':
-        return '\\r';
-      case '\u2028':
-        return '\\u2028';
-      case '\u2029':
-        return '\\u2029';
-      default:
-        return character;
-    }
-  });
-  return `${wrapQuote}${escapedStr}${wrapQuote}`;
-}

package/build/bdd-framework/utils/logger.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.logger = exports.Logger = void 0;
-/**
- * Simple logger
- */
-class Logger {
-  options;
-  constructor(options = {}) {
-    this.options = options;
-  }
-  log(...args) {
-    if (this.options.verbose) {
-      console.log(...args);
-    }
-  }
-  warn(...args) {
-    // using log() to output warnings to stdout, not stderr
-    console.log(...args);
-  }
-  error(...args) {
-    console.error(...args);
-  }
-}
-// default logger
-exports.Logger = Logger;
-const logger = exports.logger = new Logger();

package/build/bdd-framework/utils/stripAnsiEscapes.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.stripAnsiEscapes = stripAnsiEscapes;
-/**
- * Copied from Playwright.
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/reporters/base.ts#L529
- *
- * Note: there is also 'strip-ansi' package, but is't ESM only.
- * Adding it is tricky now.
- * See: https://www.npmjs.com/package/strip-ansi
- */
-const ansiRegex = new RegExp(
-// eslint-disable-next-line max-len, no-control-regex
-'([\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~])))', 'g');
-function stripAnsiEscapes(str) {
-  return str.replace(ansiRegex, '');
-}

package/build/setup-folder-structure/samples/authUsers-sample.json

@@ -1,9 +0,0 @@
-[
-    {
-        "useremail": "/ user name /",
-        "password": "/ password /",
-        "description": "/ description/",
-        "filename": "user.json",
-        "locator": "/ selector to identify page has been loaded completely /"
-    }
-]

package/build/setup-folder-structure/samples/env-config-sample.json

@@ -1,21 +0,0 @@
-{
-  "dev": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name",
-    "devURL": "Provide your devURL here"
-  },
-  "prod": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name"
-  },
-  "k8test": {
-    "domain": "https://desk.localzoho.com/agent",
-    "orgName": "org-name",
-    "deptName": "dept-name",
-    "moduleName": "module-name"
-  }
-}

package/nobdd/README.md

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

package/nobdd/package.json

@@ -1,17 +0,0 @@
-{
-  "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/uat/conf/default/actors/editions/enterprise.json

@@ -1,24 +0,0 @@
-[
-  {
-    "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

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

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

@@ -1,36 +0,0 @@
-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

@@ -1,20 +0,0 @@
-{
-  "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

@@ -1,44 +0,0 @@
-/* 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

@@ -1,33 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

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

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

@@ -1,25 +0,0 @@
-/* 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

@@ -1,8 +0,0 @@
-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

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

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

@@ -1,44 +0,0 @@
-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

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

package/nobdd/uat.config.js

@@ -1,37 +0,0 @@
-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:""
-};