@zohodesk/testinglibrary 0.1.8-exp-bdd-v1 → 0.1.8-exp.1

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

@@ -13,10 +13,7 @@ var _envInitializer = require("./env-initializer");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
 var _rootPath = require("../../utils/rootPath");
-var _main = require("../../bdd-poc/main");
-function parseUserArgs() {
-  return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
-}
+var _tagProcessor = require("./tag-processor");
 function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
   const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
   if (debug) {
@@ -67,7 +64,6 @@ function runPlaywright(command, args) {
     });
     childProcessForRunningPlaywright.on('exit', (code, signal) => {
       if (code !== 0) {
-        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
         reject(`Child Process Exited with Code ${code} and Signal ${signal}`);
       } else {
         _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Test Ran Successfully');
@@ -75,25 +71,26 @@ function runPlaywright(command, args) {
       }
     });
     process.on('exit', () => {
-      //childProcessForRunningPlaywright.kill();
+      childProcessForRunningPlaywright.kill();
       reject('Terminating Playwright Process...');
     });
     process.on('SIGINT', () => {
-      //childProcessForRunningPlaywright.kill();
+      childProcessForRunningPlaywright.kill();
       reject('Cleaning up...');
     });
   });
 }
 function main() {
-  const userArgsObject = parseUserArgs();
+  const userArgsObject = (0, _cliArgsToObject.parseUserArgs)();
   // eslint-disable-next-line
-  const tagArgs = userArgsObject['tags'];
   const {
     debug,
     mode = 'dev',
     bddMode = false,
-    headless = false
+    headless = false,
+    editionOrder
   } = (0, _readConfigFile.generateConfigFromFile)();
+  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
   const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
   (0, _envInitializer.initializeEnvConfig)(userArgsObject.mode ? userArgsObject.mode : mode);
   const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
@@ -102,8 +99,7 @@ function main() {
   const args = ['test', '--config', configPath].concat(playwrightArgs);
   let promises = [];
   if (bddMode) {
-    (0, _main.cucumberBDDtoTestFile)();
-    // promises.push(runPreprocessing(tagArgs, configPath));
+    promises.push(runPreprocessing(tagArgs, configPath));
   }
   Promise.all(promises).then(() => runPlaywright(command, args)).catch(err => {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, err);

package/build/index.d.ts

@@ -1,5 +1,60 @@
-import { Given, Then, When, Step, expect, test, createBdd } from './core/playwright/index';
-import { fireEvent, render } from '@testing-library/react';
-
-export { Given, Then, When, Step, expect, test, createBdd, fireEvent, render };
-export * from '@playwright/test/types/test';
+import { expect, test } from './core/playwright/index';
+import { fireEvent, render } from '@testing-library/react';
+import {
+  PlaywrightTestArgs,
+  PlaywrightTestOptions,
+  PlaywrightWorkerArgs,
+  PlaywrightWorkerOptions,
+  TestType,
+  Page
+} from '@playwright/test';
+import { DefineStepPattern } from '@cucumber/cucumber/lib/support_code_library_builder/types';
+
+export type KeyValue = { [key: string]: any };
+
+export type BuiltInFixturesWorker = PlaywrightWorkerArgs &
+  PlaywrightWorkerOptions;
+export type BuiltInFixtures = PlaywrightTestArgs &
+  PlaywrightTestOptions &
+  BuiltInFixturesWorker;
+
+export type FixturesArg<T extends KeyValue = {}, W extends KeyValue = {}> = T &
+  W &
+  BuiltInFixtures;
+
+export declare let hasCustomTest: boolean;
+
+export declare function createBdd<
+  T extends KeyValue = BuiltInFixtures,
+  W extends KeyValue = BuiltInFixturesWorker,
+  World
+>(
+  customTest?: TestType<T, W> | null,
+  _CustomWorld?: new (...args: any[]) => World
+): {
+  Given: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  When: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Then: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  And: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  But: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Step: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Before: any;
+  After: any;
+  BeforeAll: any;
+  AfterAll: any;
+};
+
+type StepFunctionFixturesArg<
+  T extends KeyValue,
+  W extends KeyValue
+> = FixturesArg<T, W>;
+type StepFunction<T extends KeyValue, W extends KeyValue> = (
+  fixtures: StepFunctionFixturesArg<T, W>,
+  ...args: any[]
+) => unknown;
+
+const { Given, Then, When, Step, And, But } = createBdd();
+
+export { Given, Then, When, Step, And, But, expect, test, createBdd, Page };
+
+export * from '@playwright/test/types/test';

package/build/index.js

@@ -3,17 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.When = exports.Then = exports.Step = exports.Given = void 0;
+exports.When = exports.Then = exports.Step = exports.Given = exports.But = exports.And = void 0;
 Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
-    return _exportMethods.createBdd;
-  }
-});
-Object.defineProperty(exports, "createNativeBDD", {
-  enumerable: true,
-  get: function () {
-    return _stepDefinitions.createNativeBDD;
+    return _index.createBdd;
   }
 });
 Object.defineProperty(exports, "expect", {
@@ -29,16 +23,28 @@ Object.defineProperty(exports, "test", {
   }
 });
 var _index = require("./core/playwright/index");
-var _exportMethods = require("./bdd-poc/core-runner/exportMethods");
-var _stepDefinitions = require("./bdd-poc/core-runner/stepDefinitions");
+// const { expect, test, createBdd } = require('./core/playwright/index');
+// const { fireEvent, render } = require('@testing-library/react');
+
+// module.exports = {
+//   expect,
+//   test,
+//   fireEvent,
+//   render,
+//   createBdd
+// }
+
 // import { fireEvent, render } from '@testing-library/react';
+
 const {
   Given,
   Then,
   When,
   Step
-} = (0, _exportMethods.createBdd)();
+} = (0, _index.createBdd)();
 exports.Step = Step;
 exports.When = When;
 exports.Then = Then;
-exports.Given = Given;
+exports.Given = Given;
+const And = exports.And = Then;
+const But = exports.But = Then;

package/build/lib/cli.js

@@ -7,6 +7,8 @@ var _codegen = _interopRequireDefault(require("../core/playwright/codegen"));
 var _logger = require("../utils/logger");
 var _setupProject = _interopRequireDefault(require("../setup-folder-structure/setupProject"));
 var _parser = require("../parser/parser");
+var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
+var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
 const [,, option, ...otherOptions] = process.argv;
@@ -46,9 +48,16 @@ switch (option) {
       (0, _parser.generateSpecCodeForFeatureFile)(otherOptions);
       break;
     }
+  case 'clearCaches':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Clearing caches...');
+      (0, _clearCaches.default)();
+      break;
+    }
+  case 'help':
   default:
     {
-      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Supported Commands test and report');
+      (0, _helper.default)();
       break;
     }
 }

package/build/parser/sample.feature

@@ -1,34 +1,34 @@
-Feature: Home Page
-
-  Scenario: Home Page Default content
-    Given user is on "<App>" home page
-    Then user gets a "<App>" bootcamp section
-    And username is also displayed on right corner
-
-    Examples: 
-      | App    |
-      | GitHub |
-
-  Scenario: GitHub Bootcamp Section
-    Given user is on "<Site>" home page
-    When user focuses on "<Site>" Bootcamp Section
-    Then user gets an option to setup git
-    And user gets an option to create repository
-    And user gets an option to Fork Repository
-    And user gets an option to work together
-
-    Examples: 
-      | Site   |
-      | GitHub |
-
-  Scenario: Top Banner content
-    Given user is on "<Product>" home page
-    When user focuses on Top Banner
-    Then user gets an option of home page
-    And user gets an option to search
-    And user gets settings options
-    And user gets an option to logout
-
-    Examples: 
-      | Product |
-      | GitHub  |
+Feature: Home Page
+
+  Scenario: Home Page Default content
+    Given user is on "<App>" home page
+    Then user gets a "<App>" bootcamp section
+    And username is also displayed on right corner
+
+    Examples: 
+      | App    |
+      | GitHub |
+
+  Scenario: GitHub Bootcamp Section
+    Given user is on "<Site>" home page
+    When user focuses on "<Site>" Bootcamp Section
+    Then user gets an option to setup git
+    And user gets an option to create repository
+    And user gets an option to Fork Repository
+    And user gets an option to work together
+
+    Examples: 
+      | Site   |
+      | GitHub |
+
+  Scenario: Top Banner content
+    Given user is on "<Product>" home page
+    When user focuses on Top Banner
+    Then user gets an option of home page
+    And user gets an option to search
+    And user gets settings options
+    And user gets an option to logout
+
+    Examples: 
+      | Product |
+      | GitHub  |

package/build/parser/sample.spec.js

@@ -2,34 +2,34 @@
 
 var _testinglibrary = require("@zohodesk/testinglibrary");
 _testinglibrary.test.describe('Home Page', () => {
-  /*
-  ** Given user is on "<App>" home page
-  ** Then user gets a "<App>" bootcamp section
-  ** And username is also displayed on right corner
+  /*
+  ** Given user is on "<App>" home page
+  ** Then user gets a "<App>" bootcamp section
+  ** And username is also displayed on right corner
   */
   (0, _testinglibrary.test)('Home Page Default content', () => {
     // Your implementation here
   });
 
-  /*
-  ** Given user is on "<Site>" home page
-  ** When user focuses on "<Site>" Bootcamp Section
-  ** Then user gets an option to setup git
-  ** And user gets an option to create repository
-  ** And user gets an option to Fork Repository
-  ** And user gets an option to work together
+  /*
+  ** Given user is on "<Site>" home page
+  ** When user focuses on "<Site>" Bootcamp Section
+  ** Then user gets an option to setup git
+  ** And user gets an option to create repository
+  ** And user gets an option to Fork Repository
+  ** And user gets an option to work together
   */
   (0, _testinglibrary.test)('GitHub Bootcamp Section', () => {
     // Your implementation here
   });
 
-  /*
-  ** Given user is on "<Product>" home page
-  ** When user focuses on Top Banner
-  ** Then user gets an option of home page
-  ** And user gets an option to search
-  ** And user gets settings options
-  ** And user gets an option to logout
+  /*
+  ** Given user is on "<Product>" home page
+  ** When user focuses on Top Banner
+  ** Then user gets an option of home page
+  ** And user gets an option to search
+  ** And user gets settings options
+  ** And user gets an option to logout
   */
   (0, _testinglibrary.test)('Top Banner content', () => {
     // Your implementation here

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

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commander = require("commander");
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../utils/logger");
+function helpercmd() {
+  const packageJsonPath = _path.default.resolve(process.cwd(), './package.json');
+  if ((0, _fs.existsSync)(packageJsonPath) && process.argv.includes('--version')) {
+    const {
+      dependencies
+    } = require(packageJsonPath);
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, `zohodesk/testinglibrary Version : ${dependencies['@zohodesk/testinglibrary']}`);
+    _commander.program.version(dependencies['@zohodesk/testinglibrary'] || '0.0.1');
+    return;
+  }
+  _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Supported Commands...');
+  _commander.program.name('npx ZDTestingFramework');
+  _commander.program.command('test').description('This command is used to execute tests');
+  _commander.program.command('init').description('This command will initialize Project');
+  _commander.program.command('report').description('This command is used to generate a report summarizing the results of  executed tests.');
+  _commander.program.command('codegen').description('This command is used to assist developer to write test case');
+  _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('--browsers', 'Specify the browsers on which the test case should run (Usage: -- --browsers="chrome,firefox,safari")');
+  _commander.program.parse(process.argv);
+}
+var _default = exports.default = helpercmd;

package/build/setup-folder-structure/reportEnhancement/addonScript.html

@@ -0,0 +1,25 @@
+<script>
+    function sortEdition(event) {
+      var currentURL = window.location.href;
+      const endPointCount = window.location.href.indexOf('#');
+      if (!(endPointCount == -1)) {
+        window.history.pushState({}, '', currentURL.slice(0, endPointCount));
+        currentURL = currentURL.slice(0, endPointCount);
+      }
+      console.log(currentURL);
+      window.open(`${currentURL}#?q=@edition_${event.target.value}`, '_self');
+    }
+  </script>
+  <div class="mainContainer" style="margin-left: 20px; display: flex;">
+    <div class="selectEditionContainer" style="padding: 20px;">
+      <select class="selectEdition" style="padding: 5px; width: 100px; border-radius: 6px; border: 1px solid var(--color-border-default);"  onchange="sortEdition(event)">
+        <option value="EnterPrise">EnterPrise</option>
+        <option value="Professional">Professional</option>
+        <option value="Express">Express</option>
+        <option value="Standard">Standard</option>
+        <option value="Free">Free</option>
+      </select>
+    </div>
+  </div>
+
+  

package/build/setup-folder-structure/reportEnhancement/reportAlteration.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.preProcessReport = preProcessReport;
+var _fs = _interopRequireDefault(require("fs"));
+var _logger = require("./../../utils/logger");
+var _path = _interopRequireDefault(require("path"));
+const htmlFilePath = _path.default.resolve(process.cwd(), 'uat', 'playwright-report', 'index.html');
+const fileHtml = _fs.default.readFileSync(htmlFilePath, 'utf-8');
+const addOnHtml = _fs.default.readFileSync(_path.default.resolve(__filename, '../', 'addonScript.html'), 'utf-8');
+const splitedHTML = fileHtml.split('\n');
+const toAdd = addOnHtml.split('\n');
+function preProcessReport() {
+  if (_fs.default.existsSync(htmlFilePath)) {
+    const modifiedContent = [...splitedHTML.slice(0, 55), ...toAdd, ...splitedHTML.slice(56)].join('').toString();
+    _fs.default.writeFileSync(htmlFilePath, modifiedContent);
+    return;
+  } else {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Report is not generated Properly ...');
+  }
+  return null;
+}

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

@@ -1,72 +1,72 @@
-/* eslint-disable no-console */
-import { test as setup, expect } from '@zohodesk/testinglibrary';
-import path from 'path';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-
-const userdata = require('./authUsers.json');
-
-const authDirectory = path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
-
-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) {
-    throw new Error(` Error while parsing cookies ${err} \n${path.resolve(process.cwd(), authFilePath)} File is Empty`)
-    // process.exit()
-  }
-}
-
-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 });
-      }
-
-    }
-
-  });
-
-
-})
+/* eslint-disable no-console */
+import { test as setup, expect } from '@zohodesk/testinglibrary';
+import path from 'path';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+
+const userdata = require('./authUsers.json');
+
+const authDirectory = path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
+
+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) {
+    throw new Error(` Error while parsing cookies ${err} \n${path.resolve(process.cwd(), authFilePath)} File is Empty`)
+    // process.exit()
+  }
+}
+
+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 });
+      }
+
+    }
+
+  });
+
+
+})

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

@@ -1,9 +1,9 @@
-[
-    {
-        "useremail": "/ user name /",
-        "password": "/ password /",
-        "description": "/ description/",
-        "filename": "user.json",
-        "locator": "/ selector to identify page has been loaded completely /"
-    }
+[
+    {
+        "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 +1,21 @@
-{
-  "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"
-  }
+{
+  "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"
+  }
 }