@zohodesk/testinglibrary 0.4.5-experimental → 0.4.6-experimental

package/README.md

@@ -26,15 +26,30 @@
 ### Bug fix
   - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution. 
 
-### v0.2.9 - 24-10-2024
+
+## Version History
+
+### v0.2.9 - 25-10-2024
 
 #### Feature
   - 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
+  - Latest setup related configuration changed for init option
 
-### v0.3.0 - 06-11-2024
+### v0.3.0 - 25-10-2024
 
-#### Enhancement
-   - Beta feature Actors and edition configurations unified
+#### Features
+  - Added support for scenario level tag support
+  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
+  - Below package versions are updated in this release. 
+    - playwright - 1.48.0, 
+    - playwright-bdd - 7.5.0,
+    - @playwright/test - 1.48.0,
+    - @cucumber/cucumber - 11.0.1
+  - From this version, We adopt the playwright-bdd as library instead of modified source
+
+#### Deprecations
+  - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
+  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.

package/build/core/playwright/fixtures.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _test = require("@playwright/test");
+var _playwrightBdd = require("playwright-bdd");
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _playwrightBdd.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)();
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+module.exports = {
+  test
+};

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

@@ -52,22 +52,14 @@ function getDefaultActor() {
   } = getDefaultActorConf();
   return getUserForSelectedEditionAndProfile(edition, profile);
 }
-function getListOfActors(betaFeature) {
+function getListOfActors() {
   const {
     uatDirectory
   } = (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/${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,21 +68,42 @@ function getListOfActors(betaFeature) {
   }
 }
 function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
-  const actorsData = getListOfActors(betaFeature);
+  const actorsData = getListOfActors();
   if (!actorsData || !actorsData.editions) {
     throw new Error("The actors data is missing.");
   }
   const {
-    editions: userdata
+    editions: userdata,
+    beta: betaPortals
   } = 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].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.
-
   let testingPortal = null;
   if (!userdata.hasOwnProperty(edition)) {
     throw new Error(`There is no "${edition}" edition configured.`);

package/build/core/playwright/index.js

@@ -1,37 +1,24 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "createBdd", {
+exports.createBdd = void 0;
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _bddFramework.createBdd;
+    return _test.expect;
   }
 });
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _playwrightBdd.test;
   }
 });
-exports.test = void 0;
-var _bddFramework = require("../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _test = require("@playwright/test");
-var _readConfigFile = require("./readConfigFile");
-var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
-var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
-const {
-  bddMode
-} = (0, _readConfigFile.generateConfigFromFile)();
-let base = bddMode ? _bddFramework.test : _test.test;
-const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
-const buildInFixturesTest = base.extend({
-  ...buildInFixtures
-});
-const userFixtures = (0, _getUserFixtures.default)();
-const userFixturesTest = base.extend({
-  ...userFixtures
-});
-const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
+let createBdd = function () {
+  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
+};
+exports.createBdd = createBdd;

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

@@ -39,12 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const testOptions = (0, _configUtils.getTestUseOptions)({
+const use = {
   trace,
   video,
   viewport,
   testIdAttribute
-});
+};
 
 /**
  * Playwright configuration object
@@ -65,7 +65,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use: testOptions,
+    use,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

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

@@ -7,14 +7,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
-exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _bddFramework = require("../../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
-var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -148,30 +146,15 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _bddFramework.defineBddConfig)({
-    paths: getPathsForFeatureFiles(cwd),
-    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
+  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
+    features: getPathsForFeatureFiles(cwd),
+    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
+    importTestFrom: require.resolve('../fixtures.js'),
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    disableWarnings: {
+      importTestFrom: true
+    },
     publish: true
   }) : _path.default.join(cwd, 'uat');
-}
-function getTestUseOptions({
-  viewport,
-  trace,
-  video,
-  testIdAttribute
-}) {
-  let defaultTestuseOptions = {
-    viewport,
-    testIdAttribute,
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: {
-        ...viewport
-      }
-    } : 'off'
-  };
-  return defaultTestuseOptions;
 }

package/build/core/playwright/test-runner.js

@@ -43,7 +43,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
 }
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
+  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from './bdd-framework/decorators';
+export * from 'playwright-bdd/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("./bdd-framework/decorators");
+var _decorators = require("playwright-bdd/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

package/build/setup-folder-structure/samples/actors-index.js

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

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -1,73 +1,21 @@
 /* eslint-disable no-console */
 import { test as setup, expect } from '@zohodesk/testinglibrary';
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-import { getAuthFileDirectory } from '../../core/playwright';
-import { Logger } from '../../utils/logger';
+import {
+  performLoginSteps,
+  getDefaultActor
+} from '@zohodesk/testinglibrary/helpers';
 
-const userdata = require('./authUsers.json');
+const user = getDefaultActor();
 
-const authContent = { cookies: [] };
-
-const LOGIN_ERR_MESSAGE = 'Need go be logged in';
-// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
-
-function convertCookiesToParse(cookies, authFilePath) {
-  try {
-    return JSON.parse(cookies);
-  } catch (err) {
-    Logger.error(err);
-    throw new Error(
-      ` Error while parsing cookies ${err} \n${path.resolve(
-        process.cwd(),
-        authFilePath
-      )} File is Empty`
-    );
-    // process.exit()
-  }
-}
-const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
-if (!existsSync(authDirectory)) {
-  console.log('Creating auth directory for the first time setup...');
-  mkdirSync(authDirectory, { recursive: true });
+async function verifyPageIsLoaded(page) {
+  //Implement your validation steps here
+  //Refer desk_client_app auth.setup.js
+  return true;
 }
 
-userdata.forEach(data => {
-  const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
-  if (!existsSync(authFile)) {
-    console.log('creating auth file..');
-    writeFileSync(authFile, JSON.stringify(authContent, null, 2));
-  }
-  setup(data.description, async ({ page }) => {
-    try {
-      const cookies = readFileSync(authFile);
-      const parsedCookies = convertCookiesToParse(cookies, authFile);
-      await page
-        .context()
-        .addCookies(
-          parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
-        );
-      await page.goto(page.getBaseUrl());
-      await page.waitForLoadState();
-      if (await page.url().includes(process.env.domain)) {
-        await page.waitForSelector(data.locator);
-      } else {
-        throw new Error(LOGIN_ERR_MESSAGE);
-      }
-    } catch (err) {
-      if (err.message === LOGIN_ERR_MESSAGE) {
-        await expect(page.locator('.load-bg')).toBeHidden();
-        await page.locator('#login_id').type(data.useremail);
-        await page.locator('#nextbtn').click();
-        await page.locator('#password').type(data.password);
-        await page.locator('#nextbtn').click();
-
-        await page.waitForLoadState('networkidle');
-
-        await page.waitForSelector(data.locator);
+setup(`${user.edition} - Authentication`, async ({ page }) => {
 
-        await page.context().storageState({ path: authFile });
-      }
-    }
-  });
-});
+  //Implement performLoginSteps here
+  const { email, password } = user;
+  await performLoginSteps({ },verifyPageIsLoaded );
+});

package/build/setup-folder-structure/samples/editions-index.js

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

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

@@ -0,0 +1,25 @@
+[
+    {
+      "id": "1",
+      "edition": "free",
+      "orgName": "orgFree",
+      "profiles": [
+        {
+          "profile": "admin",
+          "email": "admin+free@zohotest.com",
+          "password": "password@0987"
+        },
+        {
+          "profile": "agent",
+          "email": "agent@zohotest.com",
+          "password": "password@12345"
+        },
+        {
+          "profile": "lightagent",
+          "email": "lightagent@zohotest.com",
+          "password": "password@12345"
+        }
+      ]
+    }
+  ]
+  

package/build/setup-folder-structure/samples/settings.json

@@ -0,0 +1,7 @@
+{
+  "environment": "dev",
+  "edition": "enterprise",
+  "profile": "admin",
+  "domain": "https://desk.localzoho.com/agent",
+  "devUrl" : "" 
+}

package/build/setup-folder-structure/setupProject.js

@@ -10,8 +10,9 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
 function getScriptsToBeAdded() {
   return {
-    "uat": "ZDTestingFramework test --mode=prod --headed",
-    "uat-debug": "ZDTestingFramework test --mode=prod --debug",
+    "uat": "ZDTestingFramework test --mode=dev --headed",
+    "uat-debug": "ZDTestingFramework test --mode=dev --debug",
+    "uat-validate": "ZDTestingFramework validate",
     "uat-report": "ZDTestingFramework report --port=9009",
     "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
   };
@@ -71,7 +72,6 @@ function createAuthenticationFile() {
         });
       }
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
-      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
     } catch (err) {
       _logger.Logger.error(err);
@@ -84,8 +84,21 @@ function createAuthenticationFile() {
 function createConfigJson() {
   const uatFolder = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(uatFolder)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
-    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2);
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
+    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
+      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
+        recursive: true
+      });
+    }
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
+    if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
+      (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
+        recursive: true
+      });
+    }
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
+    (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
   }