@zohodesk/testinglibrary 0.3.3-experimental → 0.3.5-experimental

package/build/core/playwright/configuration/UserArgs.js

@@ -0,0 +1,12 @@
+"use strict";
+
+var _cliArgsToObject = require("../../../utils/cliArgsToObject");
+class UserArgs {
+  static parseToObject(config) {
+    return (0, _cliArgsToObject.cliArgsToObject)(config);
+  }
+  static parseToArgs(object) {
+    return (0, _cliArgsToObject.objectToCliArgs)(object);
+  }
+}
+module.exports = UserArgs;

package/build/core/playwright/helpers/parseUserArgs.js

@@ -3,9 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.parseUserArgs = parseUserArgs;
 var _cliArgsToObject = require("../../../utils/cliArgsToObject");
 function parseUserArgs() {
   return (0, _cliArgsToObject.cliArgsToObject)(process.argv.slice(2));
-}
-var _default = exports.default = parseUserArgs;
+}

package/build/core/playwright/index.js

@@ -1,24 +1,37 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createBdd = void 0;
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _bddFramework.createBdd;
   }
 });
-Object.defineProperty(exports, "test", {
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _playwrightBdd.test;
+    return _test.expect;
   }
 });
-var _playwrightBdd = require("playwright-bdd");
+exports.test = void 0;
+var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
-let createBdd = function () {
-  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
-};
-exports.createBdd = createBdd;
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _bddFramework.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);

package/build/core/playwright/readConfigFile.js

@@ -5,13 +5,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.generateConfigFromFile = generateConfigFromFile;
+exports.getApplicationConfig = getApplicationConfig;
 exports.getAuthFilePath = getAuthFilePath;
+exports.getDefaultConfig = getDefaultConfig;
 exports.isUserConfigFileAvailable = isUserConfigFileAvailable;
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _mergeObjects = require("./helpers/mergeObjects");
+var _Configuration = require("./configuration/Configuration");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
@@ -124,6 +127,14 @@ function generateConfigFromFile() {
   }
   return {};
 }
+function getApplicationConfig() {
+  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  if ((0, _fs.existsSync)(filePath)) {
+    const config = require(filePath);
+    return config;
+  }
+  return {};
+}
 function isUserConfigFileAvailable() {
   const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
   if ((0, _fs.existsSync)(filePath)) {

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

@@ -38,12 +38,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const use = {
+const testOptions = (0, _configUtils.getTestUseOptions)({
   trace,
   video,
   viewport,
   testIdAttribute
-};
+});
 
 /**
  * Playwright configuration object
@@ -66,7 +66,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use,
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

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

@@ -7,12 +7,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
+exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _playwrightBdd = require("playwright-bdd");
+var _bddFramework = require("../../../bdd-framework");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -146,15 +148,30 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
-    features: getPathsForFeatureFiles(cwd),
-    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
-    importTestFrom: require.resolve('../fixtures.js'),
+  return bddMode ? (0, _bddFramework.defineBddConfig)({
+    paths: getPathsForFeatureFiles(cwd),
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
-    disableWarnings: {
-      importTestFrom: true
-    },
     publish: true
   }) : _path.default.join(cwd, 'uat');
+}
+function getTestUseOptions({
+  viewport,
+  trace,
+  video,
+  testIdAttribute
+}) {
+  let defaultTestuseOptions = {
+    viewport,
+    testIdAttribute,
+    trace: trace ? 'on' : 'off',
+    video: video ? {
+      mode: 'on',
+      size: {
+        ...viewport
+      }
+    } : 'off'
+  };
+  return defaultTestuseOptions;
 }

package/build/core/playwright/setup/custom-reporter.js

@@ -18,6 +18,7 @@ class JSONSummaryReporter {
     this.skipped = [];
     this.failed = [];
     this.warned = [];
+    this.errored = [];
     this.interrupted = [];
     this.timedOut = [];
     this.flakey = [];
@@ -29,7 +30,7 @@ class JSONSummaryReporter {
   onBegin() {
     this.startedAt = Date.now();
   }
-  onTestEnd(test, result) {
+  getTitle(test) {
     const title = [];
     const fileName = [];
     let clean = true;
@@ -39,35 +40,52 @@ class JSONSummaryReporter {
       }
       clean = false;
       title.push(s);
-      if (s.includes('.ts') || s.includes('.js')) {
+      if (s.endsWith('.ts') || s.endsWith('.js')) {
         fileName.push(s);
       }
     }
-    // This will publish the file name + line number test begins on
-    const z = `${fileName[0]}`;
-    // Using the t variable in the push will push a full test name + test description
-    const t = title.join(' > ');
+
+    //Using the fullTitle variable in the push will push a full test name + test description
+
+    return {
+      fullTitle: title.join(' > '),
+      fileName: fileName[0] || ''
+    };
+  }
+  onTestEnd(test, result) {
+    const {
+      fullTitle,
+      fileName
+    } = this.getTitle(test);
+
     // Set the status
-    const stepTitleList = result.steps.map(step => ({
+    const stepTitleList = result.steps.filter(step => step.error).map(step => ({
       title: step.title,
       error: step.error,
-      testTitle: t
-    })).filter(step => step.error !== undefined);
+      testTitle: fullTitle
+    }));
     if (stepTitleList.length > 0) {
       this.failedSteps = [...this.failedSteps, ...stepTitleList];
     }
-    const status = !['passed', 'skipped'].includes(result.status) && t.includes('@warn') ? 'warned' : result.status;
+    const status = !['passed', 'skipped'].includes(result.status) && fullTitle.includes('@warn') ? 'warned' : result.status;
     // Logic to push the results into the correct array
     if (result.status === 'passed' && result.retry >= 1) {
-      this.flakey.push(z);
+      this.flakey.push(fileName);
     } else {
-      this[status].push(z);
+      this[status].push(fileName);
     }
-    this[status].push(z);
+    this[status].push(fileName);
+  }
+  onError(error) {
+    this.errored.push({
+      error: error.message,
+      stack: error.stack
+    });
   }
   onEnd(result) {
     this.durationInMS = Date.now() - this.startedAt;
     this.status = result.status;
+
     // removing duplicate tests from passed array
     this.passed = this.passed.filter((element, index) => {
       return this.passed.indexOf(element) === index;
@@ -90,6 +108,14 @@ class JSONSummaryReporter {
     this.interrupted = this.interrupted.filter((element, index) => {
       return this.interrupted.indexOf(element) === index;
     });
+    this.errored = this.errored.filter((element, index) => {
+      return this.errored.indexOf(element) === index;
+    });
+    if (this.errored.length > 0) {
+      // Reflect setup failures in the final report status
+      this.status = "failed";
+    }
+
     // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
     let {
       reportPath

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

@@ -16,7 +16,9 @@ var _rootPath = require("../../utils/rootPath");
 var _tagProcessor = require("./tag-processor");
 var _configUtils = require("./setup/config-utils");
 var _browserTypes = require("./constants/browserTypes");
-var _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
+var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
+var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
+var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
 function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
   const {
     browsers = null
@@ -38,9 +40,9 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
   }
   return playwrightArgs;
 }
-async function runPreprocessing(tagArgs, configPath) {
+function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
+  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');
@@ -97,17 +99,31 @@ function runPlaywright(command, args) {
   });
 }
 function main() {
-  const userArgsObject = (0, _parseUserArgs.default)();
-  const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+  // Getting the default config's from framework
+  const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
+
+  // overriding the application config's from project
+  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)()));
+  const {
+    isAuthMode,
+    editionOrder
+  } = uatConfig.getAll();
+  const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
+  const mode = userArgConfig.get("mode");
+  (0, _envInitializer.initializeEnvConfig)(mode, isAuthMode);
+
+  // overriding the user config's from CLI
+  // const userArgConfig = new Configuration( UserArgs.parseToObject(process.argv.slice(2)) );
+  uatConfig.addAll(userArgConfig);
+
+  //This is only used for pass the user arguments to need places in legacy code. We need to rewamp that also.
+  const userArgsObject = userArgConfig.getAll();
+  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
   const {
     debug,
     bddMode = false,
-    headless = false,
-    editionOrder,
-    isAuthMode
-  } = uatConfig;
-  (0, _envInitializer.initializeEnvConfig)(userArgsObject.mode, isAuthMode);
-  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
+    headless = false
+  } = uatConfig.getAll();
   const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
   const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
   const command = playwrightPath;

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from 'playwright-bdd/decorators';
+export * from './bdd-framework/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("playwright-bdd/decorators");
+var _decorators = require("./bdd-framework/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

package/build/test/Test.js

@@ -0,0 +1,63 @@
+"use strict";
+
+// const UserArgs = require("../core/playwright/configuration/UserArgs");
+// const Configuration = require("../core/playwright/configuration/Configuration");
+
+// function main() {
+//     const config = new Configuration();
+//     config.set("reportPath", "home/reports");
+
+//     const fwConfig = new Configuration();
+//     fwConfig.set("browser", "chrome");
+//     fwConfig.set("trace", true);
+//     config.setFrameworkConfig(fwConfig);
+
+//     const appConfig = new Configuration();
+//     appConfig.set("environment", "CI");
+//     appConfig.set("edition", "test");
+//     config.setApplicationConfig(appConfig);
+
+//     const uaConfig = new Configuration();
+//     uaConfig.set("debug", true);
+//     uaConfig.set("headless", true);
+//     config.setUserArguments(uaConfig);
+
+//     console.log("default Config : ", config.get("reportPath"));
+//     console.log("framework Config : ", config.getFrameworkConfig()?.get("browser"));
+//     console.log("application Config : ", config.getApplicationConfig()?.get("environment"));
+//     console.log("User arguments : ", config.getUserArguments()?.get("debug"));
+// }
+
+// function test(){
+//    const prop = new Map();
+//    prop.set("browser","durai");
+
+//    const config = Configuration(prop);
+//    console.log("output :" +config.get("browser"));
+// //    console.log(prop);
+
+// }
+
+// function testParseToArgs(){
+//     const prop = new Map();
+//     prop.set("browser","durai");
+//     const userArgsObject = UserArgs.parseToArgs(prop);
+//     console.log(userArgsObject);
+// }
+
+function throwError() {
+  throw new Error("catch error");
+}
+function catchError() {
+  try {
+    throw new Error("catch error");
+  } catch (err) {
+    console.log(err.message);
+  }
+}
+
+// throwError();
+catchError();
+// testParseToArgs();
+
+// main();

package/build/test/core/playwright/configuration/__tests__/Configuration.test.js

@@ -0,0 +1,53 @@
+"use strict";
+
+const Configuration = require("../../../../../core/playwright/configuration/Configuration");
+const {
+  combineConfiguration
+} = require("../../../../../core/playwright/configuration/ConfigurationHelper");
+jest.mock('../../../../../core/playwright/configuration/ConfigurationHelper', () => ({
+  combineConfiguration: jest.fn()
+}));
+describe('Configuration Class', () => {
+  let config;
+  let sampleData;
+  beforeEach(() => {
+    // Sample data as a JSON object
+    sampleData = {
+      headless: false,
+      trace: true,
+      video: true,
+      bddMode: true
+    };
+
+    // Initialize the Configuration instance with sample data
+    config = new Configuration(sampleData);
+  });
+  test('should add new key-value pair to the configuration', () => {
+    config.add('newKey', 'newValue');
+    expect(config.get('newKey')).toBe('newValue');
+  });
+  test('should combine configurations correctly using addAll', () => {
+    const newConfig = new Configuration({
+      newKey1: 'newValue1',
+      trace: false // existing key to test override
+    });
+    const combinedConfig = {
+      headless: false,
+      trace: false,
+      // trace overridden
+      video: true,
+      bddMode: true,
+      newKey1: 'newValue1'
+    };
+    combineConfiguration.mockReturnValue(combinedConfig);
+    config.addAll(newConfig);
+    expect(combineConfiguration).toHaveBeenCalledWith(sampleData, newConfig.getAll());
+    expect(config.getAll()).toEqual(combinedConfig);
+  });
+  test('should return correct value for a given key', () => {
+    expect(config.get('headless')).toBe(false);
+    expect(config.get('trace')).toBe(true);
+    expect(config.get('video')).toBe(true);
+    expect(config.get('bddMode')).toBe(true);
+  });
+});