@zohodesk/testinglibrary 0.0.5-exp.21 → 0.0.5-exp.23

package/build/core/playwright/test-runner.js

@@ -23,7 +23,8 @@ function createTestRunner() {
   const {
     debug,
     mode = 'dev',
-    bddMode = false
+    bddMode = false,
+    headless = false
   } = (0, _readConfigFile.generateConfigFromFile)();
 
   // Environment variables Initialization
@@ -35,6 +36,9 @@ function createTestRunner() {
   if (tagArgs) {
     playwrightArgs.push(`--grep ${tagArgs}`);
   }
+  if (!headless && !userArgsObject.headed) {
+    playwrightArgs.push('--headed');
+  }
 
   // ZDTetsting test --tags=@live
   // Command and arguments for npx playwright test

package/build/parser/verifier.js

@@ -28,10 +28,11 @@ function verifyIfMultipleStepsExists(steps) {
   });
   return isMultipleStepsFound;
 }
-function extractExamplesToSeperateFile(examples, scenarioIndex, filePath) {
-  let exampleFileContent = `export const scenario${scenarioIndex} = ${JSON.stringify(examples, null, 2)}`;
+function extractExamplesToSeperateFile(examples, scenarioIndex, filePath, featureName) {
+  let exampleFileContent = `export const ${featureName.toUpperCase()}_SCENARIO_${scenarioIndex} = ${JSON.stringify(examples, null, 2)};\r\n`;
+  const cleanedData = exampleFileContent.replace(/\r\n/g, '\n');
   try {
-    (0, _fileUtils.writeFileContents)(filePath, exampleFileContent, {
+    (0, _fileUtils.writeFileContents)(filePath, cleanedData, {
       flag: 'a'
     });
   } catch (err) {
@@ -50,6 +51,7 @@ function verifyFeatureFileWithSpecFile() {
       // Construct the corresponding .spec.js filename
       const specFile = featureFile.replace(/\.feature$/, '.spec.js').replace(/\/feature-files\//, '/steps/');
       let featureFileNameExtract = featureFile.split('/').pop();
+      let featurePrefixName = featureFileNameExtract.split('.')[0];
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `parsing feature file ${featureFileNameExtract}...`);
       // Check if the .spec.js file exists
 
@@ -71,7 +73,7 @@ function verifyFeatureFileWithSpecFile() {
                 let scenario = scenarios[i];
                 const scenarioName = scenario.name;
                 const scenarioExamples = scenario.examples;
-                extractExamplesToSeperateFile(scenarioExamples, i, testDataFilePath);
+                extractExamplesToSeperateFile(scenarioExamples, i, testDataFilePath, featurePrefixName);
 
                 // spec file check
                 if (!specLines.some(line => line.includes(scenarioName))) {

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

@@ -0,0 +1,67 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _testinglibrary = require("@zohodesk/testinglibrary");
+var _path = _interopRequireDefault(require("path"));
+var _fs = require("fs");
+/* eslint-disable no-console */
+
+const userdata = require('./authUsers.json');
+const authDirectory = _path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth');
+const authContent = {
+  "cookies": []
+};
+const LOGIN_ERR_MESSAGE = 'Need go be logged in';
+// const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
+
+function convertCookiesToParse(cookies, authFilePath) {
+  try {
+    return JSON.parse(cookies);
+  } catch (err) {
+    throw new Error(` Error while parsing cookies ${err} \n${_path.default.resolve(process.cwd(), authFilePath)} File is Empty`);
+    // process.exit()
+  }
+}
+
+if (!(0, _fs.existsSync)(authDirectory)) {
+  console.log('Creating auth directory for the first time setup...');
+  (0, _fs.mkdirSync)(authDirectory, {
+    recursive: true
+  });
+}
+userdata.map(data => {
+  let authFile = _path.default.resolve(_path.default.join(authDirectory, `${data.filename}`));
+  if (!(0, _fs.existsSync)(authFile)) {
+    console.log('creating auth file..');
+    (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
+  }
+  (0, _testinglibrary.test)(data.description, async ({
+    page
+  }) => {
+    try {
+      const cookies = (0, _fs.readFileSync)(authFile);
+      const parsedCookies = convertCookiesToParse(cookies, authFile);
+      await page.context().addCookies(parsedCookies.cookies == undefined ? [] : parsedCookies.cookies);
+      await page.goto(page.getBaseUrl());
+      await page.waitForLoadState();
+      if (await page.url().includes(process.env.domain)) {
+        await page.waitForSelector('header [data-id="zdsetup"]');
+      } else {
+        throw new Error(LOGIN_ERR_MESSAGE);
+      }
+    } catch (err) {
+      if (err.message === LOGIN_ERR_MESSAGE) {
+        await (0, _testinglibrary.expect)(page.locator('.load-bg')).toBeHidden();
+        await page.locator('#login_id').type(data.useremail);
+        await page.locator('#nextbtn').click();
+        await page.locator('#password').type(data.password);
+        await page.locator('#nextbtn').click();
+        await page.waitForLoadState("networkidle");
+        await page.waitForSelector(data.locator);
+        await page.context().storageState({
+          path: authFile
+        });
+      }
+    }
+  });
+});

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

@@ -0,0 +1,9 @@
+[
+    {
+        "useremail": "/ user name /",
+        "password": "/ password /",
+        "description": "/ description/",
+        "filename": "/ filename/",
+        "locator": "/ locator /"
+    }
+]

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

@@ -12,6 +12,7 @@ function getScriptsToBeAdded() {
   return {
     "ua-test": "ZDTestingFramework test --mode=prod --headed",
     "ua-test-debug": "ZDTestingFramework test --mode=prod --debug",
+    "ua-test-ci": "ZDTestingFramework test --mode=prod",
     "ua-report": "ZDTestingFramework report --port=9009",
     "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
   };
@@ -35,14 +36,12 @@ function updatePackageJSONScripts() {
     (0, _fs.writeFileSync)(packageJsonPath, JSON.stringify(modifiedConfigJSON, null, 2));
   } else {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Unable to find package json. Run init command in the root path of the project.');
-    process.exit();
   }
 }
 function createFolderForUAT() {
   const uatFolder = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(uatFolder)) {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Uat Folder already Exists.');
-    process.exit();
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Uat Folder');
     (0, _fs.mkdirSync)(uatFolder);
@@ -55,7 +54,6 @@ function createUatConfig() {
   const uatConfigPath = _path.default.resolve(process.cwd(), 'uat.config.js');
   if ((0, _fs.existsSync)(uatConfigPath)) {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Uat Config already Exists.');
-    process.exit();
   } else {
     _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Uat config file...');
     (0, _fs.writeFileSync)(uatConfigPath, getSetupFileAsString('uat-config-sample.js'), null, 2);
@@ -66,14 +64,12 @@ function createAuthenticationFile() {
   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', 'playwright'), {
-        recursive: true
-      });
+      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
       (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
         recursive: true
       });
-      const authFilePath = _path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth', 'user.json');
-      (0, _fs.writeFileSync)(authFilePath, getSetupFileAsString('user-example.json'), null, 2);
+      (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', 'authUser.json'), getSetupFileAsString('authUsers-sample.js'), null, 2);
     } catch (err) {
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
     }

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

@@ -23,7 +23,7 @@
 * @type {UserConfig}
 */
 module.exports = {
-  headed: true,
+  headless: false,
   browsers: ['Chrome', 'Firefox'],
   mode: 'dev',
   isAuthMode: true,

package/changelog.md

@@ -2,6 +2,14 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.0.5-exp.23
+
+- Auth File Setup Configuration changes
+
+# 0.0.5-exp.22
+
+- Bug fixes while creating examples file
+
 # 0.0.5-exp.21
 
 - Bug fixes while creating examples file

package/package.json

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

package/build/setup-folder-structure/user-example.json

@@ -1,3 +0,0 @@
-{
-    "cookies": []
-}