@zohodesk/testinglibrary 0.1.8-bdd-30.1 → 0.1.8-bdd-30.2

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

@@ -1,44 +1,44 @@
-/**
- * @typedef {Object|null} viewportConfig
- * @property {number} width - width of the viewport
- * @property {number} height - height of the viewport 
- */
-/**
- * Represents the user configuration object.
- * @typedef {Object} UserConfig
- * @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
- */
-
-/**
-* @type {UserConfig}
-*/
-module.exports = {
-  headless: false,
-  browsers: ['Chrome', 'Firefox', 'Safari', 'Edge'],
-  mode: 'dev',
-  isAuthMode: true,
-  authFilePath: 'uat/playwright/.auth/user.json',
-  trace: true,
-  video: true,
-  bddMode: true,
-  featureFilesFolder: 'feature-files',
-  stepDefinitionsFolder: 'steps',
-  viewport: { width: 1280, height: 720 }
-}
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport 
+ */
+/**
+ * Represents the user configuration object.
+ * @typedef {Object} UserConfig
+ * @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
+ */
+
+/**
+* @type {UserConfig}
+*/
+module.exports = {
+  headless: false,
+  browsers: ['Chrome', 'Firefox', 'Safari', 'Edge'],
+  mode: 'dev',
+  isAuthMode: true,
+  authFilePath: 'uat/playwright/.auth/user.json',
+  trace: true,
+  video: true,
+  bddMode: true,
+  featureFilesFolder: 'feature-files',
+  stepDefinitionsFolder: 'steps',
+  viewport: { width: 1280, height: 720 }
+}

package/build/utils/PathProviderOfConfig.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFeatureFilePath = getFeatureFilePath;
+exports.getStepFilePath = getStepFilePath;
+var _readConfigFile = require("../core/playwright/readConfigFile");
+var _stringManipulation = require("../bdd-poc/utils/stringManipulation");
+var _path = _interopRequireDefault(require("path"));
+const {
+  featureFilesFolder,
+  stepDefinitionsFolder
+} = (0, _readConfigFile.generateConfigFromFile)();
+function getFeatureFilePath() {
+  return (0, _stringManipulation.convertUnixPathToWindowsPath)(_path.default.resolve(process.cwd(), 'uat', 'modules', '**', featureFilesFolder || '**', '**', '*.feature'));
+}
+function getStepFilePath() {
+  return (0, _stringManipulation.convertUnixPathToWindowsPath)(_path.default.resolve(process.cwd(), 'uat', 'modules', '**', stepDefinitionsFolder || '**', '**', '*.spec.js'));
+}
+
+/**
+ *  loosly coupled and repo context
+ */

package/build/utils/cliArgsToObject.js

@@ -5,19 +5,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.cliArgsToObject = cliArgsToObject;
 exports.objectToCliArgs = objectToCliArgs;
-/**
- * Converts an array of command-line arguments into an object.
- *
- * @param {string[]} cliArgs - An array of command-line arguments.
- * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
- * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
- * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
- *
- * @example
- * // Example usage:
- * const args = ['--port=8080', '--verbose', 'input.txt'];
- * const result = cliArgsToObject(args);
- * // result will be: { port: '8080', verbose: true }
+/**
+ * Converts an array of command-line arguments into an object.
+ *
+ * @param {string[]} cliArgs - An array of command-line arguments.
+ * @param {boolean} [isKeyNeedToBeAdded=true] - Indicates whether the keys should be added to the resulting object.
+ * @returns {Object} An object representing the command-line arguments, where keys are argument names (without '--') and values are argument values.
+ * If `isKeyNeedToBeAdded` is set to `false`, only values are included in the object with numeric indexes as keys.
+ *
+ * @example
+ * // Example usage:
+ * const args = ['--port=8080', '--verbose', 'input.txt'];
+ * const result = cliArgsToObject(args);
+ * // result will be: { port: '8080', verbose: true }
  */
 // eslint-disable-next-line no-unused-vars
 function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
@@ -37,18 +37,18 @@ function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
   return processEnv;
 }
 
-/**
- * Converts an object to an array of command-line arguments.
- *
- * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
- * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
- * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
- *
- * @example
- * // Example usage:
- * const options = { port: 8080, verbose: true, input: 'input.txt' };
- * const args = objectToCliArgs(options);
- * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
+/**
+ * Converts an object to an array of command-line arguments.
+ *
+ * @param {Object} objectToBeConverted - The object to be converted to command-line arguments.
+ * @param {(string|function(string): boolean)} [isKeyNeedToBeAdded=true] - A string representing a key, or a function that determines whether a key should be added to the resulting array.
+ * @returns {string[]} An array of command-line arguments generated from the object's key-value pairs. Keys are transformed into argument names (with '--') and values are added as argument values.
+ *
+ * @example
+ * // Example usage:
+ * const options = { port: 8080, verbose: true, input: 'input.txt' };
+ * const args = objectToCliArgs(options);
+ * // args will be: ['--port=8080', '--verbose', '--input=input.txt']
  */
 function objectToCliArgs(objectToBeConverted, isKeyNeedToBeAdded) {
   const argsArray = [];

package/build/utils/fileUtils.js

@@ -8,10 +8,13 @@ exports.checkIfFileExists = checkIfFileExists;
 exports.createFolderSync = createFolderSync;
 exports.deleteFile = deleteFile;
 exports.deleteFolder = deleteFolder;
+exports.getFilesFromGivenPattern = getFilesFromGivenPattern;
 exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireWildcard(require("fs"));
 var _path = _interopRequireDefault(require("path"));
+var _fastGlob = _interopRequireDefault(require("fast-glob"));
+var _logger = require("./logger");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function checkIfFileExists(file) {
@@ -30,6 +33,13 @@ function readFileContents(filePath) {
     return null;
   }
 }
+async function getFilesFromGivenPattern(pattern, options) {
+  const files = await _fastGlob.default.globSync(pattern, options);
+  if (files.length == 0) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `given pattern - ${pattern} files are not found`);
+  }
+  return files;
+}
 function writeFileContents(filePath, content, writeOptions = {}) {
   const directoryPath = _path.default.dirname(filePath);
 

package/changelog.md

@@ -1,131 +1,131 @@
-# Testing Framework
-
-## Framework that abstracts the configuration for playwright and Jest
-# 0.1.8
-**Issue Fixes**
-- Fix #9 Custom report generate Error on Windows
-- Add Tags annotations only on bddMode
-
-**Enhancements**
-- Added Failed steps in test summary
-
-# 0.1.7
-**Enhancements**
-- Added option to run  teardown logic.
-- Added support for tag based filtering.
-- Playwright-bdd version updated to 5.6.0.
-- New fixture added to add tag as annotations in test report
-
-**Issue Fixes**
-- Edition command option. Fixed the edition tags not generated properly
-
-# 0.1.6
-
-**Enhancements**
-- New Command option Added `--edition`.
-- New Configuration Added `editionOrder`.
-  `In uat.config.js, editionOrder: ['Free', 'Express']`
-- Cache Layer added
-
-**USAGE**
- - npm run uat --edition="Free"
-
-
-
-# 0.1.5
-
-**Enhancements**
-
-- Playwright version updated to `1.40.1`
-- And and But Support added
-- Added Code Suggestions support
-- Custom Reporter added. Now the report will be available in json format.
-- New Commands added.
-
-  `- help: npx ZDTestingFramework help`
-
-  - Will list down the commands available in the tool
-
-  `- clearCaches: npx ZDTestingFramework clearCaches`
-
-  - Will clear the exisiting cookies in the authentication setup
-
-**Issue Fixes**
-
-- Fixed Issue that occurs while quitting node process.
-
-# 0.1.4
-
-- `testIdAttribute` config added
-- Fixed issue while reading boolean configuration values
-
-# 0.1.3
-
-- uat config sample file updated with `bddMode` and `viewport` values
-- user configuration issue fix when the value is undefined
-
-# 0.1.2
-
-- Bdd version updated to `5.4.0`
-- Playwright version updated to `1.39.0`
-
-# 0.1.1
-
-- Fixed post install script error
-- Fixed error `@cucumber/gherkin` not found. Cause of this issue is updating @cucumber/cucumber to 9.5.0. Reverting this version to 9.2.0
-- Removed testing library exports
-
-# 0.1.0
-
-- Removed eslint as dev dependencies as it causes `npm aliases not supported error` for npm version < 6
-
-# 0.0.9
-
-- Video sized in report adjusted to viewport size
-- Changes in package.json scripts while setting up project
-
-# 0.0.8
-
-- Tags Support
-- Enable running without bddmode feature
-- viewport configuration
-- Internal Change - Code refactoring
-
-# 0.0.7
-
-- Removed react and react-dom as dependencies. Added this as peer dependency
-
-# 0.0.6
-
-## Provided Initial Support for cucumber feature files
-
-    - Playwright-bdd and cucumber added as dependencies
-    - Added config bddMode which toggles the feature files processing
-    - Added expect timeout and test timeout as an option
-    - Decorators support for given, when and then. Typescript support needed to use this feature
-
-## Internal Library change
-
-    - Provided support for import/export statements
-
-# 0.0.5
-
-- Added Init command to initialize the folder structure and configuration for testing
-- Renamed config.json to env-config.json
-- Configured report file path directory and Handled Edge case in Cookies Handling
-
-# 0.0.4
-
-- Issue Fixes while loading the storage state
-
-# 0.0.3
-
-- Added Support for custom config generator based on user preferences
-
-# 0.0.2
-
-- Fix for Finding directories inside node_modules folder
-
-# 0.0.1
-
-- test and report command support
+# Testing Framework
+
+## Framework that abstracts the configuration for playwright and Jest
+# 0.1.8
+**Issue Fixes**
+- Fix #9 Custom report generate Error on Windows
+- Add Tags annotations only on bddMode
+
+**Enhancements**
+- Added Failed steps in test summary
+
+# 0.1.7
+**Enhancements**
+- Added option to run  teardown logic.
+- Added support for tag based filtering.
+- Playwright-bdd version updated to 5.6.0.
+- New fixture added to add tag as annotations in test report
+
+**Issue Fixes**
+- Edition command option. Fixed the edition tags not generated properly
+
+# 0.1.6
+
+**Enhancements**
+- New Command option Added `--edition`.
+- New Configuration Added `editionOrder`.
+  `In uat.config.js, editionOrder: ['Free', 'Express']`
+- Cache Layer added
+
+**USAGE**
+ - npm run uat --edition="Free"
+
+
+
+# 0.1.5
+
+**Enhancements**
+
+- Playwright version updated to `1.40.1`
+- And and But Support added
+- Added Code Suggestions support
+- Custom Reporter added. Now the report will be available in json format.
+- New Commands added.
+
+  `- help: npx ZDTestingFramework help`
+
+  - Will list down the commands available in the tool
+
+  `- clearCaches: npx ZDTestingFramework clearCaches`
+
+  - Will clear the exisiting cookies in the authentication setup
+
+**Issue Fixes**
+
+- Fixed Issue that occurs while quitting node process.
+
+# 0.1.4
+
+- `testIdAttribute` config added
+- Fixed issue while reading boolean configuration values
+
+# 0.1.3
+
+- uat config sample file updated with `bddMode` and `viewport` values
+- user configuration issue fix when the value is undefined
+
+# 0.1.2
+
+- Bdd version updated to `5.4.0`
+- Playwright version updated to `1.39.0`
+
+# 0.1.1
+
+- Fixed post install script error
+- Fixed error `@cucumber/gherkin` not found. Cause of this issue is updating @cucumber/cucumber to 9.5.0. Reverting this version to 9.2.0
+- Removed testing library exports
+
+# 0.1.0
+
+- Removed eslint as dev dependencies as it causes `npm aliases not supported error` for npm version < 6
+
+# 0.0.9
+
+- Video sized in report adjusted to viewport size
+- Changes in package.json scripts while setting up project
+
+# 0.0.8
+
+- Tags Support
+- Enable running without bddmode feature
+- viewport configuration
+- Internal Change - Code refactoring
+
+# 0.0.7
+
+- Removed react and react-dom as dependencies. Added this as peer dependency
+
+# 0.0.6
+
+## Provided Initial Support for cucumber feature files
+
+    - Playwright-bdd and cucumber added as dependencies
+    - Added config bddMode which toggles the feature files processing
+    - Added expect timeout and test timeout as an option
+    - Decorators support for given, when and then. Typescript support needed to use this feature
+
+## Internal Library change
+
+    - Provided support for import/export statements
+
+# 0.0.5
+
+- Added Init command to initialize the folder structure and configuration for testing
+- Renamed config.json to env-config.json
+- Configured report file path directory and Handled Edge case in Cookies Handling
+
+# 0.0.4
+
+- Issue Fixes while loading the storage state
+
+# 0.0.3
+
+- Added Support for custom config generator based on user preferences
+
+# 0.0.2
+
+- Fix for Finding directories inside node_modules folder
+
+# 0.0.1
+
+- test and report command support

package/jest.config.js

@@ -1,64 +1,64 @@
-const path = require('path');
-const { existsSync } = require('fs');
-const appPath = process.cwd();
-
-const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
-
-module.exports = {
-  rootDir: process.cwd(),
-  testEnvironment: 'jsdom',
-
-  setupFilesAfterEnv: [
-    existsSync(appGlobals) && appGlobals,
-    path.resolve(__dirname, 'src', 'core', 'jest', 'setup', 'index.js')
-  ].filter(Boolean),
-
-  transform: {
-    '^.+\\.(js|jsx)$': path.resolve(
-      __dirname,
-      'src',
-      'core',
-      'jest',
-      'preprocessor',
-      'jsPreprocessor.js'
-    )
-  },
-
-  modulePathIgnorePatterns: ['/build/'],
-
-  transformIgnorePatterns: [
-    '/node_modules/(?!(@zohodesk)/)'
-  ],
-
-  testPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/',
-    '/uat/'
-  ],
-
-  watchPathIgnorePatterns: [
-    '/node_modules/',
-    '/build/'
-  ],
-
-  clearMocks: true,
-  resetMocks: false,
-
-  collectCoverage: true,
-  collectCoverageFrom: ['src/**/*.js'],
-  coverageDirectory: './build/cov',
-  coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100
-    }
-  },
-  globals: {
-    __DEVELOPMENT__: true,
-    __DOCS__: false,
-    __TEST__: true
-  }
+const path = require('path');
+const { existsSync } = require('fs');
+const appPath = process.cwd();
+
+const appGlobals = path.resolve(appPath, '__testUtils__', 'globals.js');
+
+module.exports = {
+  rootDir: process.cwd(),
+  testEnvironment: 'jsdom',
+
+  setupFilesAfterEnv: [
+    existsSync(appGlobals) && appGlobals,
+    path.resolve(__dirname, 'src', 'core', 'jest', 'setup', 'index.js')
+  ].filter(Boolean),
+
+  transform: {
+    '^.+\\.(js|jsx)$': path.resolve(
+      __dirname,
+      'src',
+      'core',
+      'jest',
+      'preprocessor',
+      'jsPreprocessor.js'
+    )
+  },
+
+  modulePathIgnorePatterns: ['/build/'],
+
+  transformIgnorePatterns: [
+    '/node_modules/(?!(@zohodesk)/)'
+  ],
+
+  testPathIgnorePatterns: [
+    '/node_modules/',
+    '/build/',
+    '/uat/'
+  ],
+
+  watchPathIgnorePatterns: [
+    '/node_modules/',
+    '/build/'
+  ],
+
+  clearMocks: true,
+  resetMocks: false,
+
+  collectCoverage: true,
+  collectCoverageFrom: ['src/**/*.js'],
+  coverageDirectory: './build/cov',
+  coverageReporters: ['lcov', 'json', 'html', 'json-summary', 'text'],
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+  globals: {
+    __DEVELOPMENT__: true,
+    __DOCS__: false,
+    __TEST__: true
+  }
 };