@zohodesk/testinglibrary 0.1.9-exp-actors → 0.1.12-experimental

package/build/core/playwright/validateFeature.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
+var _readConfigFile = require("./readConfigFile");
+var _tagProcessor = _interopRequireDefault(require("./tagProcessor"));
+var _testRunner = require("./test-runner");
+var _logger = require("../../utils/logger");
+const validateFeatureFiles = () => {
+  const userArgsObject = (0, _parseUserArgs.default)();
+  const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+  const {
+    editionOrder
+  } = uatConfig;
+  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
+  const tagProcessor = new _tagProcessor.default(editionOrder);
+  const tagArgs = tagProcessor.processTags(userArgsObject);
+  (0, _testRunner.runPreprocessing)(tagArgs, configPath).then(() => {
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
+  }).catch(error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${error}`);
+  });
+};
+var _default = exports.default = validateFeatureFiles;

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/index.d.ts

@@ -1,18 +1,8 @@
 import {
   expect,
   test,
-  accountLogin,
-  getRunMode,
-  isCI,
-  isDevelopmentSetup,
-  getListOfActors,
-  getDefaultActor,
-  getUserForSelectedEditionAndProfile,
-  loadCookiesIfPresent,
-  performLoginSteps,
-  verifyIfCookieFileExists
+  createBdd
 } from './core/playwright/index';
-import { fireEvent, render } from '@testing-library/react';
 import {
   PlaywrightTestArgs,
   PlaywrightTestOptions,
@@ -81,17 +71,7 @@ export {
   expect,
   test,
   createBdd,
-  Page,
-  accountLogin,
-  getRunMode,
-  isCI,
-  isDevelopmentSetup,
-  getListOfActors,
-  getDefaultActor,
-  getUserForSelectedEditionAndProfile,
-  loadCookiesIfPresent,
-  performLoginSteps,
-  verifyIfCookieFileExists
+  Page
 };
 
 export * from '@playwright/test/types/test';

package/build/index.js

@@ -40,6 +40,12 @@ Object.defineProperty(exports, "getRunMode", {
     return _index.getRunMode;
   }
 });
+Object.defineProperty(exports, "getRunStage", {
+  enumerable: true,
+  get: function () {
+    return _index.getRunStage;
+  }
+});
 Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
   enumerable: true,
   get: function () {
@@ -70,6 +76,12 @@ Object.defineProperty(exports, "performLoginSteps", {
     return _index.performLoginSteps;
   }
 });
+Object.defineProperty(exports, "setup", {
+  enumerable: true,
+  get: function () {
+    return _index.setup;
+  }
+});
 Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {
@@ -83,8 +95,6 @@ Object.defineProperty(exports, "verifyIfCookieFileExists", {
   }
 });
 var _index = require("./core/playwright/index");
-// import { fireEvent, render } from '@testing-library/react';
-
 const {
   Given,
   Then,

package/build/lib/cli.js

@@ -2,7 +2,10 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _testRunner = _interopRequireDefault(require("../core/playwright/test-runner"));
-var _reportGenerator = _interopRequireDefault(require("../core/playwright/report-generator"));
+var _unitTestingFramework = require("@zohodesk/unit-testing-framework");
+var _PlaywrightReporter = _interopRequireDefault(require("../core/playwright/reporter/PlaywrightReporter"));
+var _ShardReporter = _interopRequireDefault(require("../core/playwright/reporter/ShardReporter"));
+var _UnitReporter = _interopRequireDefault(require("../core/playwright/reporter/UnitReporter"));
 var _codegen = _interopRequireDefault(require("../core/playwright/codegen"));
 var _logger = require("../utils/logger");
 var _setupProject = _interopRequireDefault(require("../setup-folder-structure/setupProject"));
@@ -10,15 +13,30 @@ var _parser = require("../parser/parser");
 var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
 var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
 var _parseUserArgs = _interopRequireDefault(require("../core/playwright/helpers/parseUserArgs"));
-// import createJestRunner from '../core/jest/runner/jest-runner';
-
+var _validateFeature = _interopRequireDefault(require("../core/playwright/validateFeature"));
+var _commonUtils = require("../utils/commonUtils");
 const [,, option, ...otherOptions] = process.argv;
 switch (option) {
   case 'test':
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Tests..');
       (0, _testRunner.default)();
-      //createJestRunner();
+      break;
+    }
+  case 'unit-test':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Unit Tests..');
+      (0, _unitTestingFramework.parseUnitTestArgs)(otherOptions).then(options => {
+        if (options.testPathPattern) {
+          _logger.Logger.log(_logger.Logger.INFO_TYPE, `Filtering tests with pattern: ${options.testPathPattern}`);
+        }
+        return (0, _unitTestingFramework.createJestRunner)(options);
+      });
+      break;
+    }
+  case 'validate':
+    {
+      (0, _validateFeature.default)();
       break;
     }
   case 're-run-failed':
@@ -34,9 +52,20 @@ switch (option) {
     }
   case 'report':
     {
-      // console.log('\x1b[36mGenerating Reports...\x1b[0m');
-      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Reports...');
-      (0, _reportGenerator.default)();
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating UAT Reports...');
+      _PlaywrightReporter.default.generate();
+      break;
+    }
+  case 'merge-reports':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Merging Shard Reports...');
+      _ShardReporter.default.merge();
+      break;
+    }
+  case 'ut-report':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Unit Test Reports...');
+      _UnitReporter.default.generate();
       break;
     }
   case 'codegen':
@@ -63,6 +92,12 @@ switch (option) {
       (0, _clearCaches.default)();
       break;
     }
+  case 'stepsGenerator':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Created agents and prompts md files under .github folder...');
+      (0, _commonUtils.copyGithubFolder)();
+      break;
+    }
   case 'help':
   default:
     {

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

@@ -26,10 +26,12 @@ function helpercmd() {
   _commander.program.command('report').description('This command is used to generate a report summarizing the results of  executed tests.');
   _commander.program.command('re-run-failed').description('This command will re-run the failed test cases based on test summary');
   _commander.program.command('codegen').description('This command is used to assist developer to write test case');
+  _commander.program.command('merge-reports').description('This command merges the blob reports generated by the sharded runs into a single report');
   _commander.program.option('--headed', 'Run tests with a headed browser.');
   _commander.program.option('--debug', 'This command is used to initiate a debugging session');
   _commander.program.option('--tags', 'Run specific test case with mentioned tags (Usage: -- --tags="@live")');
   _commander.program.option('--workers', 'Specify number of workers to run the test case parallely (Usage: -- --workers=2)');
+  _commander.program.option('--shard', 'Split the test suite across parallel jobs. Each shard writes a blob report which has to be merged using merge-reports (Usage: -- --shard=1/4)');
   _commander.program.option('--edition', 'Specify edition to run the test cases (Usage: -- --edition="standard". This will run the test cases with either no edition mentioned or edition standard)');
   _commander.program.option('--browsers', 'Specify the browsers on which the test case should run (Usage: -- --browsers="chrome,firefox,safari")');
   _commander.program.parse(process.argv);

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

@@ -0,0 +1,19 @@
+// This is the sample file generated by testing framework. You can change as per the respective project login
+
+const getUrlOrigin = require('../shared/url-helpers/getUrlOrigin');
+
+async function accountLogin( { page, email, password } ) {
+  await page.locator('#login_id').fill(email);
+  await page.locator('#nextbtn').click();
+  await page.locator('#password').fill(password);
+  await page.locator('#nextbtn').click();
+
+  const domainUrlOrigin = getUrlOrigin(process.env.domain);
+  await page.waitForNavigation();
+  await Promise.race([
+    page.waitForURL(`${domainUrlOrigin}/**`),
+    page.waitForURL('**/announcement/**')
+  ]);
+}
+
+module.exports  = accountLogin;

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

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

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

@@ -1,71 +1,15 @@
 /* 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 {
+  performLoginSteps,
+  getDefaultActor
+} from '@zohodesk/testinglibrary/helpers';
 
-const userdata = require('./authUsers.json');
+import { loginSteps , validateLogin } from './testSetup';
 
-const authContent = { cookies: [] };
+const user = getDefaultActor();
 
-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) {
-    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 });
-}
-
-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);
-
-        await page.context().storageState({ path: authFile });
-      }
-    }
-  });
-});
+setup(`${user.edition} - Authentication`, async ({ page }) => {
+  //Implement performLoginSteps here
+  await performLoginSteps({page, ...user},validateLogin ,loginSteps);
+}); 

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://zdesk-devops25.csez.zohocorpin.com:31037/agent",
+  "devUrl" : "" 
+}

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

@@ -0,0 +1,14 @@
+/* eslint-disable global-require */
+const accountLogin = require('./accountLogin');
+
+async function verifyPageIsLoaded({page}) {
+
+    //Implement your validation logic here
+    //Refer deskclientapp testSetup.js
+}
+
+module.exports = {
+  loginSteps:accountLogin,
+  validateLogin:verifyPageIsLoaded,
+  page:()=>{}
+};

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -1,3 +1,4 @@
+const testSetup = require('../../fixtures/testSetup');
 /**
  * @typedef {Object|null} viewportConfig
  * @property {number} width - width of the viewport
@@ -8,6 +9,7 @@
  * @typedef {Object} UserConfig
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
+ * @property {string} smokeTestTrace - trace mode for the smokeTest project (e.g. 'on', 'off', 'retain-on-failure'). Default is 'on'.
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {string} mode: mode in which the test cases needs to run
@@ -18,12 +20,13 @@
  * @property {any} reportPath : directory where report is generate
  * @property {boolean} bddMode: Feature files needs to be processed
  * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail. Can be overridden per-scenario by tagging the scenario with `@timeout_<seconds>` (e.g. `@timeout_180`). `@timeout_0` disables the timeout. Browser scaling (Firefox 2x, Safari 4x) is preserved.
  * @property {Object} additionalPages: custom pages configuration
  * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
  * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
  * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
  * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
+ * @property {boolean} failureSegregation: When true, collect runtime browser logs on failure, classify failing tests into CODE/CASE/TOOL/ENVIRONMENT, attach additional_logs, and merge tags like CODE_failure into the report. Default: true.
  */
 
 /**
@@ -36,9 +39,11 @@ module.exports = {
   isAuthMode: true,
   authFilePath: 'uat/playwright/.auth/user.json',
   trace: true,
+  smokeTestTrace: 'on',
   video: true,
   bddMode: true,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
-  viewport: { width: 1280, height: 720 }
+  viewport: { width: 1280, height: 720 },
+  testSetup
 }

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,9 +72,13 @@ 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 ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'accountLogin.js'), getSetupFileAsString('accountLogin-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating login script File ....');
+      (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'testSetup.js'), getSetupFileAsString('testSetup-sample.js'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating testSetup File ....');
     } catch (err) {
+      _logger.Logger.error(err);
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
     }
   } else {
@@ -83,8 +88,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');
   }