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

package/build/setup-folder-structure/samples/git-ignore.sample.js

@@ -1,33 +1,37 @@
-import { existsSync, readFileSync, writeFileSync } from 'fs';
-import path from 'path';
-import { Logger } from '../utils/logger';
-import { generateConfigFromFile } from '../core/playwright/readConfigFile';
-
-
-const { reportPath = path.resolve(process.cwd(), 'uat', 'playwright-reports') } = generateConfigFromFile();
-const testResultsPath = path.resolve(process.cwd(), 'uat', 'test-results');
-
-const testResultsRelativepath = path.relative(path.resolve(process.cwd(), '../', '../'), testResultsPath)
-const reportRelativepath = path.relative(path.resolve(process.cwd(), '../', '../'), reportPath)
-
-const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}`
-
-function updateGitIgnore() {
-  if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {
-    let gitIgnoreData = readFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore'), 'utf-8', (err) => {
-      if (err) {
-        Logger.log(Logger.FAILURE_TYPE, 'cannot able to read git ignore ')
-        // process.exit()
-      }
-    })
-    if (gitIgnoreData.includes(dirpathtoIgnore)) {
-      return
-    } else {
-      writeFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore', dirpathtoIgnore, null, 2))
-    }
-  } else {
-    Logger.log(Logger.INFO_TYPE, 'GitIgnore file is No Found ....')
-  }
-}
-
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import path from 'path';
+import { Logger } from '../utils/logger';
+import { generateConfigFromFile } from '../core/playwright/readConfigFile';
+const gitIgnoreAbsolutePath = path.resolve(process.cwd(), '../', '../')
+
+const { reportPath = path.resolve(process.cwd(), 'uat', 'playwright-reports') } = generateConfigFromFile();
+const testResultsPath = path.resolve(process.cwd(), 'uat', 'test-results');
+
+const testResultsRelativepath = path.relative(gitIgnoreAbsolutePath, testResultsPath)
+const reportRelativepath = path.relative(gitIgnoreAbsolutePath, reportPath)
+
+
+const absolutePathfeaturegen = path.resolve(process.cwd(), 'uat', '.features-gen');
+const featuregenRelativePath = path.relative(gitIgnoreAbsolutePath,absolutePathfeaturegen)
+
+const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}\n${featuregenRelativePath}`
+
+function updateGitIgnore() {
+  if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {
+    let gitIgnoreData = readFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore'), 'utf-8', (err) => {
+      if (err) {
+        Logger.log(Logger.FAILURE_TYPE, 'cannot able to read git ignore ')
+        // process.exit()
+      }
+    })
+    if (gitIgnoreData.includes(dirpathtoIgnore)) {
+      return
+    } else {
+      writeFileSync(path.resolve(process.cwd(), '../', '../', '.gitignore', dirpathtoIgnore, null, 2))
+    }
+  } else {
+    Logger.log(Logger.INFO_TYPE, 'GitIgnore file is No Found ....')
+  }
+}
+
 export default updateGitIgnore;

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

@@ -1,43 +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
- * @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 }
- */
-
-/**
-* @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/setup-folder-structure/setupProject.js

@@ -61,14 +61,18 @@ function createUatConfig() {
 function createAuthenticationFile() {
   const isUATexist = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(isUATexist)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
     try {
-      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
-      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
-        recursive: true
-      });
+      if (!(0, _fs.existsSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'))) {
+        (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
+      }
+      if (!(0, _fs.existsSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'))) {
+        (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
+          recursive: true
+        });
+      }
       (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.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
     }
@@ -91,6 +95,7 @@ function setupProject() {
   createFolderForUAT();
   createConfigJson();
   createAuthenticationFile();
+  //updateGitIgnore()
   // Create folder for playwright . Inside .auth folder needs to be created. user.json
   // Add playwright and test-results to .gitignore
   setTimeout(() => {

package/build/utils/cliArgsToObject.js

@@ -5,19 +5,20 @@ 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 }
+exports.parseUserArgs = parseUserArgs;
+/**
+ * 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 +38,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 = [];
@@ -62,4 +63,7 @@ function objectToCliArgs(objectToBeConverted, isKeyNeedToBeAdded) {
     }
   });
   return argsArray;
+}
+function parseUserArgs() {
+  return cliArgsToObject(process.argv.slice(2));
 }

package/build/utils/fileUtils.js

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.checkIfFileExists = checkIfFileExists;
 exports.deleteFile = deleteFile;
+exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
 function checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);
@@ -26,9 +28,7 @@ function readFileContents(filePath) {
   }
 }
 function writeFileContents(filePath, content, writeOptions = {}) {
-  let filePaths = filePath.split('/');
-  let fileName = filePaths.pop();
-  let directoryPath = filePaths.join('/');
+  const directoryPath = _path.default.dirname(filePath);
 
   // Check if the directory exists
   if (!_fs.default.existsSync(directoryPath)) {
@@ -37,7 +37,7 @@ function writeFileContents(filePath, content, writeOptions = {}) {
     });
   }
   try {
-    _fs.default.writeFileSync(`${directoryPath}/${fileName}`, content, writeOptions);
+    _fs.default.writeFileSync(`${filePath}`, content, writeOptions);
   } catch (err) {
     throw new Error(err);
   }
@@ -50,4 +50,15 @@ function deleteFile(filePath) {
       throw new Error(`Error while deleting the test data file: ${filePath}`);
     }
   }
+}
+function deleteFolder(folderPath) {
+  if (_fs.default.existsSync(folderPath)) {
+    try {
+      _fs.default.rmdirSync(folderPath, {
+        recursive: true
+      });
+    } catch (err) {
+      throw new Error(`Error while deleting the test data file: ${folderPath}`);
+    }
+  }
 }

package/changelog.md

@@ -1,74 +1,137 @@
-# Testing Framework
-
-## Framework that abstracts the configuration for playwright and Jest
-
-# 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-exp.1
+**Enhancements**
+- Added option to specify browsers in command line.
+  - npm run uat -- --browsers='chrome,firefox'
+
+# 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
+  }
 };