@zohodesk/testinglibrary 0.1.8-exp-bdd-v3 → 0.1.8-exp-bdd-v4

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/parser.js

@@ -108,7 +108,6 @@ function generateSpecFileContent({
     });
     //specContent += `});\n\n`;
   }
-
   return specContent;
 }
 function updateExistingSpecFile({

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

@@ -0,0 +1,34 @@
+"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.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/git-ignore.sample.js

@@ -2,15 +2,19 @@ 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(path.resolve(process.cwd(), '../', '../'), testResultsPath)
-const reportRelativepath = path.relative(path.resolve(process.cwd(), '../', '../'), reportPath)
+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}`
+const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}\n${featuregenRelativePath}`
 
 function updateGitIgnore() {
   if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {

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

@@ -11,7 +11,7 @@
  * @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 {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) 
@@ -22,7 +22,8 @@
  * @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 {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
  */
 
 /**

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/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/build/utils/logger.js

@@ -54,5 +54,4 @@ class LoggerImpl {
     this.consoleLogger.log(`${color[0]}${message}${color[1]}`);
   }
 }
-const Logger = new LoggerImpl();
-exports.Logger = Logger;
+const Logger = exports.Logger = new LoggerImpl();

package/build/utils/stepDefinitionsFormatter.js

@@ -5,8 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.delimiters = void 0;
 exports.findDelimiterFromStep = findDelimiterFromStep;
-const delimiters = ["Given", "When", "Then", "And"];
-exports.delimiters = delimiters;
+const delimiters = exports.delimiters = ["Given", "When", "Then", "And"];
 function findDelimiterFromStep(step) {
   return delimiters.find(delimiter => step.includes(delimiter));
 }

package/changelog.md

@@ -1,6 +1,63 @@
 # 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