@zohodesk/testinglibrary 0.0.5-exp.15 → 0.0.5-exp.17

package/build/core/playwright/readConfigFile.js

@@ -22,6 +22,7 @@ const fileName = 'uat.config.js';
  * @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
@@ -57,6 +58,8 @@ function getAuthFilePath(filePath) {
   try {
     if ((0, _fs.existsSync)(filePath)) {
       return filePath;
+    } else {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Ensure cookies present in ${filePath}. Authetication file not Exist ...`);
     }
   } catch (err) {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Founded Path - ${filePath} Authetication file not Exist ...`);

package/build/core/playwright/setup/config-creator.js

@@ -23,7 +23,8 @@ const {
   reportPath = _path.default.join(process.cwd(), 'uat', 'playwright-report'),
   bddMode = false,
   expectTimeout = 5 * 1000,
-  testTimeout = 60 * 1000
+  testTimeout = 60 * 1000,
+  authFilePath = 'uat/playwright/.auth/user.json'
 } = (0, _readConfigFile.generateConfigFromFile)();
 let projects = browsers.map(browser => {
   if (browser === 'Chrome') {
@@ -31,7 +32,7 @@ let projects = browsers.map(browser => {
       name: 'chromium',
       use: {
         ..._test.devices['Desktop Chrome'],
-        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')) : {}
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
       },
       dependencies: isAuthMode ? ['setup'] : []
     };
@@ -41,7 +42,7 @@ let projects = browsers.map(browser => {
       use: {
         ..._test.devices['Desktop Chrome'],
         channel: 'msedge',
-        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')) : {}
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
       },
       dependencies: isAuthMode ? ['setup'] : []
     };
@@ -54,7 +55,7 @@ let projects = browsers.map(browser => {
       },
       use: {
         ..._test.devices['Desktop Firefox'],
-        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')) : {}
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
       },
       dependencies: isAuthMode ? ['setup'] : []
     };
@@ -67,7 +68,7 @@ let projects = browsers.map(browser => {
       },
       use: {
         ..._test.devices['Desktop Safari'],
-        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')) : {}
+        storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
       },
       dependencies: isAuthMode ? ['setup'] : null
     };

package/build/lib/cli.js

@@ -6,9 +6,10 @@ var _reportGenerator = _interopRequireDefault(require("../core/playwright/report
 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");
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
-const [,, option] = process.argv;
+const [,, option, ...otherOptions] = process.argv;
 // const args = process.argv.slice(3);
 // const appPath = process.cwd();
 
@@ -42,6 +43,7 @@ switch (option) {
   case 'generateSpecFile':
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Spec file...');
+      (0, _parser.generateSpecCodeForFeatureFile)(otherOptions);
       break;
     }
   default:

package/build/parser/parser.js

@@ -4,11 +4,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.generateSpecCodeForFeatureFile = generateSpecCodeForFeatureFile;
 exports.parseFeature = parseFeature;
 exports.specFileGenerator = specFileGenerator;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
+var _cliArgsToObject = require("../utils/cliArgsToObject");
+var _fileUtils = require("../utils/fileUtils");
 function parseFeature(featureContent) {
   const lines = featureContent.split('\n');
   let currentFeature = null;
@@ -86,6 +89,7 @@ function generateSpecFileContent({
   return specContent;
 }
 function specFileGenerator(filePath) {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Generating spec file using file ${filePath}`);
   // Read the Gherkin feature file
   _fs.default.readFile(filePath, 'utf8', (err, data) => {
     if (err) {
@@ -93,9 +97,15 @@ function specFileGenerator(filePath) {
     } else {
       // Parse the feature file content and get the JSON-like object
       const parsedFeature = parseFeature(data);
-      let specFilePath = _path.default.resolve(process.cwd(), '../', filePath.replace(/\.feature$/, '.spec.js'));
-      if (filePath.includes('features')) {
-        specFilePath = filePath.replace(/\.feature$/, '.spec.js').replace(/\/features\//, '/steps/');
+      let specFilePath = filePath.replace(/\.feature$/, '.spec.js');
+      if (filePath.includes('feature-files')) {
+        specFilePath = specFilePath.replace(/\/feature-files\//, '/steps/');
+      } else {
+        specFilePath = specFilePath.replace('./', '../steps/');
+      }
+      if ((0, _fileUtils.checkIfFileExists)(filePath)) {
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'File Already exists. Make sure to either delete or pass --update option true');
+        return;
       }
 
       // Output the JSON-like object
@@ -113,4 +123,13 @@ function specFileGenerator(filePath) {
       });
     }
   });
+}
+function generateSpecCodeForFeatureFile(options) {
+  let cliObj = (0, _cliArgsToObject.cliArgsToObject)(options);
+  let featureFilePath = cliObj.featureFile;
+  if (featureFilePath) {
+    specFileGenerator(_path.default.join(process.cwd(), './', featureFilePath));
+  } else {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Need option --featureFile to run this command');
+  }
 }

package/build/parser/verifier.js

@@ -1,39 +1,19 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.verifyFeatureFileWithSpecFile = verifyFeatureFileWithSpecFile;
-var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _fastGlob = _interopRequireDefault(require("fast-glob"));
 var _parser = require("./parser");
 var _logger = require("../utils/logger");
+var _fileUtils = require("../utils/fileUtils");
 // Specify the directory where you want to search for .feature and .spec.js files
-const directoryPath = '../../examples/uat';
+const directoryPath = './uat';
 
 // Use glob to match .feature files in the directory
-const featurePattern = _path.default.join(directoryPath, '**/*.feature');
+const featurePattern = _path.default.join(process.cwd(), directoryPath, '**/*.feature');
 
 // function onSpecFileNotFound() { }
 
-function checkIfFileExists(file) {
-  try {
-    _fs.default.accessSync(file, _fs.default.constants.F_OK);
-    return true;
-  } catch (err) {
-    return false;
-  }
-}
-function readFileContents(file) {
-  try {
-    let fileContents = _fs.default.readFileSync(file, 'utf-8');
-    return fileContents;
-  } catch (err) {
-    return null;
-  }
-}
 function verifyFeatureFileWithSpecFile() {
   try {
     let errorCount = 0;
@@ -42,14 +22,14 @@ function verifyFeatureFileWithSpecFile() {
     });
     featureFiles.forEach(featureFile => {
       // Construct the corresponding .spec.js filename
-      const specFile = featureFile.replace(/\.feature$/, '.spec.js').replace(/\/features\//, '/steps/');
+      const specFile = featureFile.replace(/\.feature$/, '.spec.js').replace(/\/feature-files\//, '/steps/');
       let featureFileNameExtract = featureFile.split('/').pop();
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `parsing feature file ${featureFileNameExtract}...`);
       // Check if the .spec.js file exists
 
-      if (checkIfFileExists(specFile)) {
-        let featureContents = readFileContents(featureFile);
-        let specContents = readFileContents(specFile);
+      if ((0, _fileUtils.checkIfFileExists)(specFile)) {
+        let featureContents = (0, _fileUtils.readFileContents)(featureFile);
+        let specContents = (0, _fileUtils.readFileContents)(specFile);
         //let [featureContents, specContents] = Promise.all([readFileContents(featureFile), readFileContents(specFile)]);
         if (featureContents !== null && specContents !== null) {
           const featureJSON = (0, _parser.parseFeature)(featureContents);
@@ -92,6 +72,7 @@ function verifyFeatureFileWithSpecFile() {
     }
   } catch (err) {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, err);
-    process.exit();
+    process.exit(1);
   }
-}
+}
+verifyFeatureFileWithSpecFile();

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

@@ -1,21 +1,22 @@
 "use strict";
 
 /**
-* 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 {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
+ * 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
  */
 
 /**
@@ -26,6 +27,7 @@ module.exports = {
   browsers: ['Chrome', 'Firefox'],
   mode: 'dev',
   isAuthMode: true,
+  authFilePath: 'uat/playwright/.auth/user.json',
   trace: true,
   video: true
 };

package/build/utils/fileUtils.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.checkIfFileExists = checkIfFileExists;
+exports.readFileContents = readFileContents;
+var _fs = _interopRequireDefault(require("fs"));
+function checkIfFileExists(file) {
+  try {
+    _fs.default.accessSync(file, _fs.default.constants.F_OK);
+    return true;
+  } catch (err) {
+    return false;
+  }
+}
+function readFileContents(file) {
+  try {
+    let fileContents = _fs.default.readFileSync(file, 'utf-8');
+    return fileContents;
+  } catch (err) {
+    return null;
+  }
+}

package/changelog.md

@@ -2,6 +2,16 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.0.5-exp.17
+
+- Minor bugfix
+- Added config for auth file path
+
+# 0.0.5-exp.16
+
+- Provided option for generating code from feature
+- npm run generateSpecFile -- --featureFile=filepath
+
 # 0.0.5-exp.15
 
 - parser added for feature file verification

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.5-exp.15",
+  "version": "0.0.5-exp.17",
   "description": "",
   "main": "./build/index.js",
   "scripts": {