@zohodesk/testinglibrary 0.4.6-experimental → 0.4.7-experimental

package/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
 
 #workflow:
 #  rules:
@@ -12,7 +12,7 @@ stages:
 # Install dependencies stage
 build:
   stage: build
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm install
   artifacts:
@@ -23,7 +23,7 @@ build:
 # Unit tests stage
 unit:
   stage: unit
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm run test
   artifacts:
@@ -34,7 +34,7 @@ unit:
 # UAT tests stage
 uat-auth:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm install 
     - npm run build
@@ -53,7 +53,7 @@ uat-auth:
 
 uat-noauth:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm install 
     - npm run build
@@ -72,7 +72,7 @@ uat-noauth:
     
 uat-profile:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm install 
     - npm run build
@@ -91,7 +91,7 @@ uat-profile:
 
 uat-nobdd:
   stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
+  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
   script:
     - npm install 
     - npm run build

package/README.md

@@ -49,7 +49,13 @@
     - @playwright/test - 1.48.0,
     - @cucumber/cucumber - 11.0.1
   - From this version, We adopt the playwright-bdd as library instead of modified source
-
+  - Published on 11-11-2024
+  
 #### Deprecations
   - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
-  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.

package/build/core/playwright/fixtures.js

@@ -10,7 +10,7 @@ const {
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _playwrightBdd.test : _test.test;
-const buildInFixtures = (0, _builtInFixtures.default)();
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
 const buildInFixturesTest = base.extend({
   ...buildInFixtures
 });

package/build/core/playwright/tagProcessor.js

@@ -0,0 +1,79 @@
+"use strict";
+
+var _logger = require("../../utils/logger");
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+var _buildTagsString = /*#__PURE__*/new WeakSet();
+var _parseEdition = /*#__PURE__*/new WeakSet();
+var _processSingleEdition = /*#__PURE__*/new WeakSet();
+var _processMultipleEditions = /*#__PURE__*/new WeakSet();
+var _getEditionArgs = /*#__PURE__*/new WeakSet();
+var _buildEditionTags = /*#__PURE__*/new WeakSet();
+class TagProcessor {
+  constructor(editionOrder) {
+    _classPrivateMethodInitSpec(this, _buildEditionTags);
+    _classPrivateMethodInitSpec(this, _getEditionArgs);
+    _classPrivateMethodInitSpec(this, _processMultipleEditions);
+    _classPrivateMethodInitSpec(this, _processSingleEdition);
+    _classPrivateMethodInitSpec(this, _parseEdition);
+    _classPrivateMethodInitSpec(this, _buildTagsString);
+    this.editionOrder = editionOrder;
+  }
+  processTags(userArgs) {
+    const tagArgs = userArgs['tags'] || '';
+    const edition = userArgs['edition'] || null;
+    if (!edition) return tagArgs;
+    const editionsArray = edition.split(',');
+    const editionTags = editionsArray.length === 1 ? _classPrivateMethodGet(this, _processSingleEdition, _processSingleEdition2).call(this, editionsArray[0], tagArgs) : _classPrivateMethodGet(this, _processMultipleEditions, _processMultipleEditions2).call(this, editionsArray, tagArgs);
+    return editionTags;
+  }
+}
+function _buildTagsString2(tags, editionTags) {
+  return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
+}
+function _parseEdition2(edition) {
+  if (edition.startsWith('<=')) return ['<=', edition.slice(2)];
+  if (edition.startsWith('>=')) return ['>=', edition.slice(2)];
+  if (edition.startsWith('<')) return ['<', edition.slice(1)];
+  if (edition.startsWith('>')) return ['>', edition.slice(1)];
+  return [null, edition];
+}
+function _processSingleEdition2(selectedEdition, tagArgs) {
+  const editionArgs = _classPrivateMethodGet(this, _getEditionArgs, _getEditionArgs2).call(this, selectedEdition);
+  if (editionArgs && editionArgs.length > 0) {
+    const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, editionArgs, 'or');
+    return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+  }
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
+  return tagArgs;
+}
+function _processMultipleEditions2(editionsArray, tagArgs) {
+  const filteredEditions = this.editionOrder.filter(edition => !editionsArray.includes(edition));
+  const editionTags = _classPrivateMethodGet(this, _buildEditionTags, _buildEditionTags2).call(this, filteredEditions, 'or');
+  return _classPrivateMethodGet(this, _buildTagsString, _buildTagsString2).call(this, tagArgs, editionTags);
+}
+function _getEditionArgs2(selectedEdition) {
+  const [operator, editionValue] = _classPrivateMethodGet(this, _parseEdition, _parseEdition2).call(this, selectedEdition.toLowerCase());
+  const index = this.editionOrder.findIndex(edition => edition.toLowerCase() === editionValue);
+  if (index === -1) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions for ${selectedEdition} found. Running with default edition`);
+    return [];
+  }
+  switch (operator) {
+    case '<=':
+      return this.editionOrder.slice(index + 1);
+    case '>=':
+      return this.editionOrder.slice(0, index);
+    case '<':
+      return this.editionOrder.slice(index);
+    case '>':
+      return this.editionOrder.slice(0, index + 1);
+    default:
+      return this.editionOrder.filter((_, i) => i !== index);
+  }
+}
+function _buildEditionTags2(editionArgs, operator = 'or') {
+  return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
+}
+module.exports = TagProcessor;

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

@@ -14,7 +14,7 @@ var _envInitializer = require("./env-initializer");
 var _logger = require("../../utils/logger");
 var _readConfigFile = require("./readConfigFile");
 var _rootPath = require("../../utils/rootPath");
-var _tagProcessor = require("./tag-processor");
+var _tagProcessor = _interopRequireDefault(require("./tagProcessor"));
 var _configUtils = require("./setup/config-utils");
 var _browserTypes = require("./constants/browserTypes");
 var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
@@ -122,7 +122,8 @@ function main() {
 
   //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 tagProcessor = new _tagProcessor.default(editionOrder);
+  const tagArgs = tagProcessor.processTags(userArgsObject);
   const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
   const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
   const command = playwrightPath;

package/build/core/playwright/validateFeature.js

@@ -7,40 +7,9 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
 var _readConfigFile = require("./readConfigFile");
-var _tagProcessor = require("./tag-processor");
+var _tagProcessor = _interopRequireDefault(require("./tagProcessor"));
 var _testRunner = require("./test-runner");
 var _logger = require("../../utils/logger");
-// @cucumber/gherkins need to be includ in package.json
-
-// const getFeatureFiles = (dir) => {
-//     let featureFiles = [];
-//     const files = fs.readdirSync(dir, { withFileTypes: true });
-//     files.forEach(file => {
-//       const fullPath = path.join(dir, file.name);
-//       if (file.isDirectory()) {
-//         featureFiles = featureFiles.concat(getFeatureFiles(fullPath));
-//       } else if (file.isFile() && fullPath.endsWith('.feature')) {
-//         featureFiles.push(fullPath);
-//       }
-//     });
-//     return featureFiles;
-//   };
-
-//const validateFeatureFiles = () => {
-// const featuresDir = path.join(process.cwd(), 'uat/modules');
-// const parser = new Parser();
-// const featureFiles = getFeatureFiles(featuresDir);
-// featureFiles.forEach( filePath => {
-//         const featureFileContent = fs.readFileSync(filePath, 'utf-8');
-//         try {
-//             parser.parse(featureFileContent);
-//             console.log(`${filePath}: Feature file is valid!`);
-//         } catch (error) {
-//             console.error(`${filePath}: Feature file is invalid - ${error.message}`);
-//         }
-// })
-//}
-
 const validateFeatureFiles = () => {
   const userArgsObject = (0, _parseUserArgs.default)();
   const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
@@ -48,7 +17,8 @@ const validateFeatureFiles = () => {
     editionOrder
   } = uatConfig;
   const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
-  const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
+  const tagProcessor = new _tagProcessor.default(editionOrder);
+  const tagArgs = tagProcessor.processTags(userArgsObject);
   (0, _testRunner.runPreprocessing)(tagArgs, configPath).then(() => {
     _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
   }).catch(error => {

package/build/test/core/playwright/__tests__/tagProcessor.test.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _tagProcessor = _interopRequireDefault(require("../../../../../src/core/playwright/tagProcessor"));
+var _logger = require("../../../../utils/logger");
+jest.mock('../../../../utils/logger');
+describe('TagProcessor', () => {
+  const editionOrder = ['edition1', 'edition2', 'edition3', 'edition4'];
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('should return tagArgs if no edition is provided', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: null
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1');
+  });
+  test('should handle a single edition with <= operator', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: '<=edition2'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
+  });
+  test('should handle a single edition with >= operator', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: '>=edition2'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition1)');
+  });
+  test('should handle a single edition with < operator', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: '<edition3'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
+  });
+  test('should handle a single edition with > operator', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: '>edition1'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition1)');
+  });
+  test('should handle a single edition with no operator', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: 'edition2'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition1 or @edition_edition3 or @edition_edition4)');
+  });
+  test('should log a message if edition is not found', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: 'nonexistentEdition'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1');
+    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.INFO_TYPE, expect.stringContaining('No matching editions for nonexistentEdition found.'));
+  });
+  test('should handle multiple editions', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: 'tag1',
+      edition: 'edition1,edition3'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('tag1 and not (@edition_edition2 or @edition_edition4)');
+  });
+  test('should build tags correctly when tags are empty', () => {
+    const tagProcessor = new _tagProcessor.default(editionOrder);
+    const userArgs = {
+      tags: '',
+      edition: 'edition1'
+    };
+    const result = tagProcessor.processTags(userArgs);
+    expect(result).toBe('not (@edition_edition2 or @edition_edition3 or @edition_edition4)');
+  });
+});

package/build/test/core/playwright/__tests__/validateFeature.test.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _validateFeature = _interopRequireDefault(require("../../../../core/playwright/validateFeature"));
 var _parseUserArgs = _interopRequireDefault(require("../../../../core/playwright/helpers/parseUserArgs"));
 var _readConfigFile = require("../../../../core/playwright/readConfigFile");
-var _tagProcessor = require("../../../../core/playwright/tag-processor");
+var _tagProcessor = _interopRequireDefault(require("../../../../core/playwright/tagProcessor"));
 var _testRunner = require("../../../../core/playwright/test-runner");
 var _logger = require("../../../../utils/logger");
 jest.mock('../../../../core/playwright/helpers/parseUserArgs', () => ({
@@ -12,7 +12,7 @@ jest.mock('../../../../core/playwright/helpers/parseUserArgs', () => ({
   default: jest.fn()
 }));
 jest.mock('../../../../core/playwright/readConfigFile');
-jest.mock('../../../../core/playwright/tag-processor');
+jest.mock('../../../../core/playwright/tagProcessor');
 jest.mock('../../../../core/playwright/test-runner');
 jest.mock('../../../../utils/logger', () => ({
   __esModule: true,
@@ -23,8 +23,13 @@ jest.mock('../../../../utils/logger', () => ({
   }
 }));
 describe('validateFeatureFiles', () => {
+  let tagProcessorInstance;
   beforeEach(() => {
     jest.clearAllMocks();
+    tagProcessorInstance = {
+      processTags: jest.fn()
+    };
+    _tagProcessor.default.mockImplementation(() => tagProcessorInstance);
   });
   test('runPreprocessing with correct arguments and log success', async () => {
     const mockUserArgs = {
@@ -37,19 +42,19 @@ describe('validateFeatureFiles', () => {
     _readConfigFile.generateConfigFromFile.mockReturnValue(mockConfig);
     _readConfigFile.isUserConfigFileAvailable.mockReturnValue(true);
     const mockTagArgs = ['@beta_admin'];
-    _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
+    tagProcessorInstance.processTags.mockReturnValue(mockTagArgs);
     _testRunner.runPreprocessing.mockResolvedValueOnce();
     await (0, _validateFeature.default)();
     expect(_parseUserArgs.default).toHaveBeenCalled();
     expect(_readConfigFile.generateConfigFromFile).toHaveBeenCalled();
     expect(_readConfigFile.isUserConfigFileAvailable).toHaveBeenCalled();
-    expect(_tagProcessor.tagProcessor).toHaveBeenCalledWith(mockUserArgs, ["beta", "enterprice"]);
+    expect(tagProcessorInstance.processTags).toHaveBeenCalledWith(mockUserArgs);
     expect(_testRunner.runPreprocessing).toHaveBeenCalledWith(mockTagArgs, expect.stringContaining('config-creator.js'));
     expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
   });
   test('runPreprocessing with playwright conf', async () => {
     const mockTagArgs = ['@beta_admin'];
-    _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
+    tagProcessorInstance.processTags.mockReturnValue(mockTagArgs);
     _readConfigFile.isUserConfigFileAvailable.mockReturnValue(false);
     _testRunner.runPreprocessing.mockResolvedValueOnce();
     await (0, _validateFeature.default)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.4.6-experimental",
+  "version": "0.4.7-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {

package/build/core/playwright/tag-processor.js

@@ -1,68 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.tagProcessor = tagProcessor;
-var _logger = require("../../utils/logger");
-/* eslint-disable dot-notation */
-
-function getTagsString(tags, editionTags) {
-  return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
-}
-function getEdition(edition) {
-  if (edition.startsWith('<=')) {
-    return ['<=', edition.slice(2)];
-  } else if (edition.startsWith('>=')) {
-    return ['>=', edition.slice(2)];
-  } else if (edition.startsWith('<')) {
-    return ['<', edition.slice(1)];
-  } else if (edition.startsWith('>')) {
-    return ['>', edition.slice(1)];
-  }
-  return [null, edition];
-}
-function editionPreprocessing(editionOrder, selectedEdition) {
-  const [operator, editionToBeSearched] = getEdition(selectedEdition.toLowerCase());
-  const index = editionOrder.findIndex(edition => edition.toLowerCase() === editionToBeSearched);
-  if (index !== -1) {
-    let resultArray;
-    if (operator === '<=') {
-      resultArray = editionOrder.slice(index + 1);
-    } else if (operator === '>=') {
-      resultArray = editionOrder.slice(0, index);
-    } else if (operator === '<') {
-      resultArray = editionOrder.slice(index);
-    } else if (operator === '>') {
-      resultArray = editionOrder.slice(0, index + 1);
-    } else {
-      resultArray = editionOrder.filter((_, order) => order !== index);
-    }
-    return resultArray;
-  }
-  _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
-  return [];
-}
-function buildEditionTags(editionArgs, operator) {
-  return editionArgs.map(edition => `@edition_${edition}`).join(` ${operator} `);
-}
-function tagProcessor(userArgsObject, editionOrder) {
-  let tagArgs = userArgsObject['tags'];
-  const edition = userArgsObject['edition'] || null;
-  if (edition !== null) {
-    let editionsArray = edition.split(',');
-    if (editionsArray.length === 1) {
-      const editionArgs = editionPreprocessing(editionOrder, edition);
-      if (editionArgs && editionArgs.length > 0) {
-        const editionTags = buildEditionTags(editionArgs, 'or');
-        tagArgs = `${getTagsString(tagArgs, editionTags)}`;
-      }
-    } else {
-      // More than one edition given
-      const filteredEditions = editionOrder.filter(edition => !editionsArray.includes(edition));
-      const editionTags = buildEditionTags(filteredEditions, 'or');
-      tagArgs = `${getTagsString(tagArgs, editionTags)}`;
-    }
-  }
-  return tagArgs;
-}