@zohodesk/testinglibrary 3.2.8 → 3.2.10

package/.gitlab-ci.yml

@@ -173,3 +173,19 @@ uat-multiactor:
     when: always
     paths:
       - examples/uat/playwright-report
+      
+uat-data_generator:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-data_generator)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+

package/README.md

@@ -19,6 +19,9 @@
 
 ## Version History
 
+#### Feature
+  - To store the login session in NFS, we have provided the teardown option in the configuration
+
 ### v3.2.8 - 18-09-2025
 
 ### Bug fix

package/build/core/dataGenerator/DataGenerator.js

@@ -10,6 +10,7 @@ var _fs = _interopRequireDefault(require("fs"));
 var _logger = require("../../utils/logger");
 var _DataGeneratorHelper = require("./DataGeneratorHelper");
 var _helpers = require("@zohodesk/testinglibrary/helpers");
+var _DataGeneratorError = require("./DataGeneratorError");
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
 function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
@@ -32,6 +33,16 @@ class DataGenerator {
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `Generated response for the generator: ${generatorName} for scenario: ${scenarioName}, Response: ${JSON.stringify(response)}`);
       return response;
     } catch (error) {
+      if (error instanceof _DataGeneratorError.DataGeneratorError) {
+        console.error(error.getMessage());
+        console.error("Stack trace:", error.stack);
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error.getMessage());
+      } else {
+        console.error("Error Type:", error.constructor.name);
+        console.error("Error Message:", error.message);
+        console.error("Stack trace:", error.stack);
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `${error.constructor.name} - Message: ${error.message}`);
+      }
       console.error('Data Generation failed for the generator: ', generatorName, "\n\nError response :", error);
       throw error;
     }
@@ -58,7 +69,7 @@ async function _getGenerator(testInfo, generatorName) {
     }
   }
   if (!generator) {
-    throw new Error(`Generator "${generatorName}" could not be found in the path located at "${generatorFilePath}"`);
+    throw new _DataGeneratorError.GeneratorError(`Generator "${generatorName}" could not be found in the path located at "${generatorFilePath}"`);
   }
   return generator;
 }
@@ -71,11 +82,14 @@ async function _generateAPIGenerator(operationId) {
   }];
 }
 async function _constructApiPayload(scenarioName, processedGenerators, actorInfo) {
-  const dataGeneratorConfig = actorInfo['data-generator'] || {};
+  const dataGeneratorObj = actorInfo['data-generator'];
+  if (!dataGeneratorObj) {
+    throw new _DataGeneratorError.DataGeneratorConfigurationError(`Data Generator configuration is missing for the profile: ${actorInfo['profile']}`);
+  }
   const apiPayload = {
     scenario_name: scenarioName,
     data_generation_templates: processedGenerators,
-    ...dataGeneratorConfig
+    ...dataGeneratorObj
   };
   const account = apiPayload.account;
   if (account) {

package/build/core/dataGenerator/DataGeneratorError.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GeneratorError = exports.DataGeneratorError = exports.DataGeneratorConfigurationError = void 0;
+class DataGeneratorError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'DataGeneratorError';
+
+    // Maintains proper stack trace for where our error was thrown (only available on V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, DataGeneratorError);
+    }
+  }
+
+  /**
+   * Get formatted error message with error type and message
+   * @returns {string} Formatted error message
+   */
+  getMessage() {
+    return `\n\n ${this.name} :::  \n\n Error Message: ${this.message} \n\n `;
+  }
+}
+
+// Specific error for Data Generator configuration issues
+exports.DataGeneratorError = DataGeneratorError;
+class DataGeneratorConfigurationError extends DataGeneratorError {
+  constructor(message) {
+    super(message);
+    this.name = 'DataGeneratorConfigurationError';
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, DataGeneratorConfigurationError);
+    }
+  }
+}
+
+// Specific error for Generator related issues
+exports.DataGeneratorConfigurationError = DataGeneratorConfigurationError;
+class GeneratorError extends DataGeneratorError {
+  constructor(message) {
+    super(message);
+    this.name = 'GeneratorError';
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, GeneratorError);
+    }
+  }
+}
+exports.GeneratorError = GeneratorError;

package/build/core/dataGenerator/DataGeneratorHelper.js

@@ -15,7 +15,7 @@ async function processGenerator(generators, dataTable) {
     dataTable.forEach(row => {
       const generatorName = row.DG_API_NAME;
       if (generatorName === generator.name) {
-        generator.params = generator.params ? generator.params : [];
+        generator.params = generator.params ? generator.params : {};
 
         // The API name row is only used for matching the template
         // Filter out DG_API_NAME and collect other values

package/build/core/playwright/readConfigFile.js

@@ -19,6 +19,7 @@ var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
+    isTearDown: true,
     uatDirectory: _path.default.join(process.cwd(), 'uat'),
     headless: false,
     browsers: ['Chrome'],

package/build/core/playwright/setup/Project.js

@@ -0,0 +1,35 @@
+"use strict";
+
+class Project {
+  constructor(name) {
+    this.properties = {};
+    this.properties.name = name;
+  }
+  setTestDir(value) {
+    this.properties.testDir = value;
+  }
+  setTestMatch(value) {
+    this.properties.testMatch = value;
+  }
+  setRetries(value) {
+    this.properties.retries = value;
+  }
+  setUse(value) {
+    this.properties.use = value;
+  }
+  setTearDown(value) {
+    this.properties.teardown = value;
+  }
+  setDependencies(value) {
+    this.properties.dependencies = value;
+  }
+  setProperty(key, value) {
+    this.properties[key] = value;
+  }
+  getProperties() {
+    return this.properties;
+  }
+}
+module.exports = {
+  Project
+};

package/build/core/playwright/setup/ProjectConfiguration.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cleanupConfig = cleanupConfig;
+exports.setupConfig = setupConfig;
+exports.smokeTestConfig = smokeTestConfig;
+var _path = _interopRequireDefault(require("path"));
+var _Project = require("./Project");
+var _configUtils = require("./config-utils");
+var _readConfigFile = require("../readConfigFile");
+const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+const {
+  isAuthMode,
+  isTearDown,
+  isSmokeTest,
+  bddMode,
+  authFilePath,
+  trace,
+  video,
+  testIdAttribute,
+  viewport
+} = uatConfig;
+function setupConfig() {
+  const setupProject = new _Project.Project('setup');
+  setupProject.setTestMatch(/.*\.setup\.js/);
+  setupProject.setTestDir(_path.default.join(process.cwd(), 'uat'));
+  setupProject.setTearDown(isTearDown ? 'cleanup' : '');
+  const setupProjectConfig = [setupProject.getProperties()];
+  return setupProjectConfig;
+}
+function smokeTestConfig() {
+  const smokeTestProject = new _Project.Project('smokeTest');
+  const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
+    featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
+    stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+    outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
+    uatPath: _path.default.join(process.cwd(), 'uat', 'smokeTest')
+  });
+  const commonConfig = {
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+  };
+  smokeTestProject.setTestDir(smokeTestDir);
+  smokeTestProject.setRetries(0);
+  smokeTestProject.setUse({
+    ...commonConfig
+  });
+  smokeTestProject.setDependencies(isAuthMode ? ['setup'] : []);
+  const smokeTestProjectConfig = [smokeTestProject.getProperties()];
+  return smokeTestProjectConfig;
+}
+function defaultConfig() {
+  const defaultProject = new _Project.Project('default');
+  const testDir = (0, _configUtils.getTestDir)(bddMode, {
+    featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
+    stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+    outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
+    uatPath: _path.default.join(process.cwd(), 'uat')
+  });
+  const use = {
+    trace,
+    video,
+    viewport,
+    testIdAttribute
+  };
+  defaultProject.setUse(use);
+  defaultProject.setTestDir(testDir);
+  defaultProject.setDependencies(isSmokeTest ? ['smokeTest'] : []);
+  const defaultProjectConfig = [defaultProject.getProperties()];
+  return defaultProjectConfig;
+}
+function cleanupConfig() {
+  const cleanupProject = new _Project.Project('cleanup');
+  cleanupProject.setTestMatch(/.*\.teardown\.js/);
+  cleanupProject.setTestDir(_path.default.join(process.cwd(), 'uat'));
+  const cleanupProjectConfig = [cleanupProject.getProperties()];
+  return cleanupProjectConfig;
+}

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

@@ -9,47 +9,36 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
+var _ProjectConfiguration = require("./ProjectConfiguration");
 const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
+  bddMode,
   browsers,
   isSmokeTest,
-  trace,
-  video,
+  isTearDown,
   isAuthMode,
   openReportOn,
   reportPath,
-  bddMode,
   expectTimeout,
   testTimeout,
   authFilePath,
   viewport,
-  featureFilesFolder,
-  stepDefinitionsFolder,
-  testIdAttribute,
   globalTimeout,
-  customReporter
+  customReporter,
+  trace,
+  video,
+  testIdAttribute
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
   isSmokeTest,
+  isTearDown,
   authFilePath,
   expectTimeout,
   testTimeout,
   viewport
 });
-const testDir = (0, _configUtils.getTestDir)(bddMode, {
-  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
-  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
-  outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
-  uatPath: _path.default.join(process.cwd(), 'uat')
-});
-const use = {
-  trace,
-  video,
-  viewport,
-  testIdAttribute
-};
 let reporter = [['html', {
   outputFolder: reportPath,
   open: openReportOn
@@ -66,29 +55,22 @@ if (customReporter) {
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
 
+const use = {
+  trace,
+  video,
+  viewport,
+  testIdAttribute
+};
+const testDir = (0, _configUtils.getTestDir)(bddMode, {
+  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+  outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
+  uatPath: _path.default.join(process.cwd(), 'uat')
+});
 function getPlaywrightConfig() {
-  const commonConfig = {
-    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
-  };
-  const dependencies = isAuthMode ? ['setup'] : [];
-  const smokeTestProject = isSmokeTest ? smokeTestConfig() : [];
-  function smokeTestConfig() {
-    const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
-      featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
-      stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
-      outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
-      uatPath: _path.default.join(process.cwd(), 'uat', 'smokeTest')
-    });
-    return [{
-      name: 'smokeTest',
-      testDir: smokeTestDir,
-      use: {
-        ...commonConfig
-      },
-      dependencies: dependencies,
-      retries: 0
-    }];
-  }
+  const smokeTestProject = isSmokeTest ? (0, _ProjectConfiguration.smokeTestConfig)() : [];
+  const setupProject = isAuthMode ? (0, _ProjectConfiguration.setupConfig)() : [];
+  const cleanupProject = isTearDown ? (0, _ProjectConfiguration.cleanupConfig)() : [];
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -100,16 +82,7 @@ function getPlaywrightConfig() {
       timeout: expectTimeout
     },
     use,
-    projects: isAuthMode ? [{
-      name: 'setup',
-      testMatch: /.*\.setup\.js/,
-      testDir: _path.default.join(process.cwd(), 'uat'),
-      teardown: 'cleanup'
-    }, ...smokeTestProject, {
-      name: 'cleanup',
-      testMatch: /.*\.teardown\.js/,
-      testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects, ...smokeTestProject],
+    projects: [...setupProject, ...smokeTestProject, ...projects, ...cleanupProject],
     ...uatConfig
   };
   return playwrightConfig;