@zohodesk/testinglibrary 0.1.8-stb-bdd-v26 → 0.1.9

package/build/core/playwright/types.js

@@ -0,0 +1,43 @@
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+
+/**
+ * @typedef {Object|null} testSetupConfig
+ * @property {any} page - Function that will be called while setting up page fixtures
+ * @property {any} context - Function that will be called while setting up context fixtures
+ */
+
+/**
+ * Represents the user configuration object.
+ * @typedef {Object} UserConfig
+ * @property {string} uatDirectory - Directory in which uat configuration is places.
+ * @property {string} headless - Headless Browsers mode.
+ * @property {number} trace - trace for test cases.
+ * @property {boolean} video - video for test cases,
+ * @property {boolean} debug - debug mode
+ * @property {string} mode: mode in which the test cases needs to run
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
+ * @property {string} authFilePath - File Path where the cookies stored
+ * @property {any} browsers: List of browsers
+ * @property {string} openReportOn: default Option value (never, on-failure and always)
+ * @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 {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 {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
+ * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
+ */
+"use strict";

package/build/decorators.d.ts

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

package/build/decorators.js

@@ -1,2 +1,16 @@
-// export * from './bdd-framework/decorators';
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _decorators = require("./bdd-framework/decorators");
+Object.keys(_decorators).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _decorators[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _decorators[key];
+    }
+  });
+});

package/build/index.d.ts

@@ -1,12 +1,79 @@
-import { expect, test } from './core/playwright/index';
-// import { fireEvent, render } from '@testing-library/react';
-import {
-  PlaywrightTestArgs,
-  PlaywrightTestOptions,
-  PlaywrightWorkerArgs,
-  PlaywrightWorkerOptions,
-  TestType,
-  Page
-} from '@playwright/test';
-
-export * from '@playwright/test/types/test';
+import { expect, test, accountLogin,
+  getListOfUsers,
+  getPrimaryUser,
+  getUserForSelectedEditionAndProfile,
+  isCI,
+  loadCookiesIfPresent,
+  performLoginSteps,
+  verifyIfCookieFileExists } 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();
+
+type UserConfig = import('./core/playwright/readConfigFile').UserConfig;
+
+export { 
+  UserConfig,
+  Given, Then, When, Step, And, But, expect, test, 
+  createBdd, Page, accountLogin,
+  getListOfUsers,
+  getPrimaryUser,
+  getUserForSelectedEditionAndProfile,
+  isCI,
+  loadCookiesIfPresent,
+  performLoginSteps,
+  verifyIfCookieFileExists };
+
+export * from '@playwright/test/types/test';

package/build/index.js

@@ -4,16 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.When = exports.Then = exports.Step = exports.Given = exports.But = exports.And = void 0;
-Object.defineProperty(exports, "createBdd", {
+Object.defineProperty(exports, "accountLogin", {
   enumerable: true,
   get: function () {
-    return _bddPoc.createBdd;
+    return _index.accountLogin;
   }
 });
-Object.defineProperty(exports, "createNativeBDD", {
+Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
-    return _bddPoc.createNativeBDD;
+    return _index.createBdd;
   }
 });
 Object.defineProperty(exports, "expect", {
@@ -22,24 +22,66 @@ Object.defineProperty(exports, "expect", {
     return _index.expect;
   }
 });
+Object.defineProperty(exports, "getListOfUsers", {
+  enumerable: true,
+  get: function () {
+    return _index.getListOfUsers;
+  }
+});
+Object.defineProperty(exports, "getPrimaryUser", {
+  enumerable: true,
+  get: function () {
+    return _index.getPrimaryUser;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _index.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _index.isCI;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _index.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _index.performLoginSteps;
+  }
+});
 Object.defineProperty(exports, "test", {
   enumerable: true,
   get: function () {
     return _index.test;
   }
 });
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _index.verifyIfCookieFileExists;
+  }
+});
 var _index = require("./core/playwright/index");
-var _bddPoc = require("./bdd-poc");
 // import { fireEvent, render } from '@testing-library/react';
+
 const {
   Given,
   Then,
   When,
-  And
-} = (0, _bddPoc.createBdd)();
-exports.And = And;
+  Step
+} = (0, _index.createBdd)();
+exports.Step = Step;
 exports.When = When;
 exports.Then = Then;
 exports.Given = Given;
-const Step = exports.Step = Then;
+const And = exports.And = Then;
 const But = exports.But = Then;

package/build/lib/cli.js

@@ -9,12 +9,10 @@ var _setupProject = _interopRequireDefault(require("../setup-folder-structure/se
 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';
 
 const [,, option, ...otherOptions] = process.argv;
-// const args = process.argv.slice(3);
-// const appPath = process.cwd();
-
 switch (option) {
   case 'test':
     {
@@ -23,6 +21,17 @@ switch (option) {
       //createJestRunner();
       break;
     }
+  case 're-run-failed':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Failed Tests..');
+      let {
+        filePath
+      } = (0, _parseUserArgs.default)();
+      process.env.isRerunFailedCases = true;
+      process.env.filePath = filePath;
+      (0, _testRunner.default)();
+      break;
+    }
   case 'report':
     {
       // console.log('\x1b[36mGenerating Reports...\x1b[0m');

package/build/lib/post-install.js

@@ -5,13 +5,21 @@ var _path = _interopRequireDefault(require("path"));
 var _child_process = require("child_process");
 var _logger = require("../utils/logger");
 var _rootPath = require("../utils/rootPath");
-const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-const command = playwrightPath;
-const args = ['install'];
-_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Downloading browsers for running tests');
-const childProcess = (0, _child_process.spawn)(command, args, {
-  stdio: 'inherit'
-});
-childProcess.on('error', error => {
-  _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
-});
+// We are skipping the download of browsers when NODE_ENV is set to production or flag SKIP_BROWSER_DOWNLOAD is set to true
+
+let isSkipDownloadingBrowsers = Boolean(process.env.SKIP_BROWSER_DOWNLOAD);
+let isProductionMode = process.env.NODE_ENV === 'production';
+if (isSkipDownloadingBrowsers || isProductionMode) {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Skipping browsers download in production mode');
+} else {
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const args = ['install'];
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Downloading browsers for running tests`);
+  const childProcess = (0, _child_process.spawn)(command, args, {
+    stdio: 'inherit'
+  });
+  childProcess.on('error', error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+  });
+}

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

@@ -24,11 +24,14 @@ function helpercmd() {
   _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('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.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('--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);
 }
 var _default = exports.default = helpercmd;

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

@@ -1,25 +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>
-
+<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/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 });
+      }
+
+    }
+
+  });
+
+
+})