@zohodesk/testinglibrary 0.0.5-exp.26 → 0.0.5-exp.28

package/build/core/playwright/readConfigFile.js

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

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

@@ -26,8 +26,9 @@ const {
   testTimeout = 60 * 1000,
   authFilePath = 'uat/playwright/.auth/user.json'
 } = (0, _readConfigFile.generateConfigFromFile)();
-let projects = browsers.map(browser => {
-  if (browser === 'Chrome') {
+let projects = browsers.map(browserName => {
+  let browser = browserName.toLowerCase();
+  if (browser === 'chrome') {
     return {
       name: 'chromium',
       use: {
@@ -36,7 +37,7 @@ let projects = browsers.map(browser => {
       },
       dependencies: isAuthMode ? ['setup'] : []
     };
-  } else if (browser === 'Edge') {
+  } else if (browser === 'edge') {
     return {
       name: 'Microsoft Edge',
       use: {
@@ -46,7 +47,7 @@ let projects = browsers.map(browser => {
       },
       dependencies: isAuthMode ? ['setup'] : []
     };
-  } else if (browser === 'Firefox') {
+  } else if (browser === 'firefox') {
     return {
       name: 'firefox',
       timeout: 4 * 60 * 1000,

package/build/parser/parser.js

@@ -12,6 +12,7 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../utils/logger");
 var _cliArgsToObject = require("../utils/cliArgsToObject");
 var _fileUtils = require("../utils/fileUtils");
+var _readConfigFile = require("../core/playwright/readConfigFile");
 function parseFeature(featureContent) {
   const lines = featureContent.split('\n');
   let currentFeature = null;
@@ -98,6 +99,10 @@ function generateSpecFileContent({
 function specFileGenerator(filePath) {
   _logger.Logger.log(_logger.Logger.INFO_TYPE, `Generating spec file using file ${filePath}`);
   // Read the Gherkin feature file
+  let {
+    featureFilesFolder = 'feature-files',
+    stepDefinitionsFolder = 'steps'
+  } = (0, _readConfigFile.generateConfigFromFile)();
   _fs.default.readFile(filePath, 'utf8', (err, data) => {
     if (err) {
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error reading the file: ${err}`);
@@ -105,10 +110,10 @@ function specFileGenerator(filePath) {
       // Parse the feature file content and get the JSON-like object
       const parsedFeature = parseFeature(data);
       let specFilePath = filePath.replace(/\.feature$/, '.spec.js');
-      if (filePath.includes('feature-files')) {
-        specFilePath = specFilePath.replace(/\/feature-files\//, '/steps/');
+      if (filePath.includes(`${featureFilesFolder}`)) {
+        specFilePath = specFilePath.replace(`/${featureFilesFolder}/`, `/${stepDefinitionsFolder}/`);
       } else {
-        specFilePath = specFilePath.replace('./', '../steps/');
+        specFilePath = specFilePath.replace('./', `${stepDefinitionsFolder}`);
       }
       if ((0, _fileUtils.checkIfFileExists)(specFilePath)) {
         _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'File Already exists. Make sure to either delete or pass --update option true');

package/build/parser/verifier.js

@@ -6,6 +6,7 @@ var _fastGlob = _interopRequireDefault(require("fast-glob"));
 var _parser = require("./parser");
 var _logger = require("../utils/logger");
 var _fileUtils = require("../utils/fileUtils");
+var _readConfigFile = require("../core/playwright/readConfigFile");
 // Specify the directory where you want to search for .feature and .spec.js files
 const directoryPath = './uat';
 
@@ -44,12 +45,16 @@ function verifyFeatureFileWithSpecFile() {
   try {
     let errorCount = 0;
     let allStepsFound = {};
+    let {
+      featureFilesFolder = 'feature-files',
+      stepDefinitionsFolder = 'steps'
+    } = (0, _readConfigFile.generateConfigFromFile)();
     const featureFiles = _fastGlob.default.globSync([featurePattern], {
       dot: true
     });
     featureFiles.forEach(featureFile => {
       // Construct the corresponding .spec.js filename
-      const specFile = featureFile.replace(/\.feature$/, '.spec.js').replace(/\/feature-files\//, '/steps/');
+      const specFile = featureFile.replace(/\.feature$/, '.spec.js').replace(`/${featureFilesFolder}/`, `/${stepDefinitionsFolder}/`);
       let featureFileNameExtract = featureFile.split('/').pop();
       let featurePrefixName = featureFileNameExtract.split('.')[0];
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `parsing feature file ${featureFileNameExtract}...`);
@@ -66,7 +71,7 @@ function verifyFeatureFileWithSpecFile() {
             if (specContents.includes(featureName)) {
               const scenarios = featureJSON.feature.scenarios;
               const specLines = specContents.split('\n'); // Split specContents into lines
-              let testDataFilePath = featureFile.replace(/\/feature-files\//, '/test-data/').replace(/\.feature$/, '.data.js');
+              let testDataFilePath = featureFile.replace(`/${featureFilesFolder}/`, '/test-data/').replace(/\.feature$/, '.data.js');
               // Examples to test data conversion. we are deleting the existing test data file and create a new file.
               (0, _fileUtils.deleteFile)(testDataFilePath);
               for (let i = 0; i < scenarios.length; i++) {

package/build/setup-folder-structure/samples/auth-setup-sample.js

@@ -42,7 +42,7 @@ userdata.forEach((data) => {
 			await page.goto(page.getBaseUrl());
 			await page.waitForLoadState();
 			if (await page.url().includes(process.env.domain)) {
-				await page.waitForSelector('header [data-id="zdsetup"]');
+				await page.waitForSelector(data.locator);
 			} else {
 				throw new Error(LOGIN_ERR_MESSAGE);
 			}

package/build/setup-folder-structure/samples/authUsers-sample.json

@@ -3,7 +3,7 @@
         "useremail": "/ user name /",
         "password": "/ password /",
         "description": "/ description/",
-        "filename": "/ filename in json format/",
+        "filename": "user.json",
         "locator": "/ selector to identify page has been loaded completely /"
     }
 ]

package/build/setup-folder-structure/samples/env-config-sample.json

@@ -1,17 +1,21 @@
 {
   "dev": {
     "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name",
+    "devURL": "Provide your devURL here"
   },
   "prod": {
     "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
   },
   "k8test": {
     "domain": "https://desk.localzoho.com/agent",
-    "username": "your-username",
-    "password": "your-password"
+    "orgName": "org-name",
+    "deptName": "dept-name",
+    "moduleName": "module-name"
   }
 }

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

@@ -15,6 +15,8 @@
  * @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
  */
 
 /**
@@ -22,10 +24,12 @@
 */
 module.exports = {
 	headless: false,
-	browsers: ['Chrome', 'Firefox'],
+	browsers: ['Chrome', 'Firefox', 'Safari', 'Edge'],
 	mode: 'dev',
 	isAuthMode: true,
 	authFilePath: 'uat/playwright/.auth/user.json',
 	trace: true,
 	video: true,
+	featureFilesFolder: 'feature-files',
+	stepDefinitionsFolder: 'steps'
 }

package/changelog.md

@@ -2,6 +2,14 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.0.5-exp.28
+
+- Bug fix while creating spec file
+
+# 0.0.5-exp.27
+
+- Added config for feature files and step definitions folder name
+
 # 0.0.5-exp.26
 
 - Type definitions for playwright added

package/package.json

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