@zohodesk/testinglibrary 0.0.66-n20-experimental → 0.0.68-n20-experimental

package/build/common/data-generator/steps/DataGenerator.spec.js

@@ -4,20 +4,16 @@ import { generateAndCacheTestData } from './DataGeneratorStepsHelper';
 const { Given } = createBdd();
 
 Given('generate a {string} entity {string} with generator {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, dataTable) => {
-    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, null, page);
+    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName);
 });
 
 Given('generate a {string} entity {string} with API {string}', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, dataTable) => {
-    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, null, page);
+    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName);
 });
 Given('generate a {string} entity {string} with generator {string} using {string} profile', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, generatorName, profile, dataTable) => {
-    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile, page);
+    await generateAndCacheTestData(executionContext, "template", generatorName, dataTable, cacheLayer, entityName, profile);
 });
 
 Given('generate a {string} entity {string} with API {string} using {string} profile', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, profile, dataTable) => {
-    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile, page);
+    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile);
 });
-
-Given('generate a {string} entity {string} with API {string} using {string} profile', async ({ page, context, i18N, cacheLayer, executionContext}, module, entityName, operationId, profile, dataTable) => {
-    await generateAndCacheTestData(executionContext, "API", operationId, dataTable, cacheLayer, entityName, profile, page);
-});

package/build/common/data-generator/steps/DataGeneratorStepsHelper.js

@@ -4,7 +4,7 @@ import DataGenerator from '@zohodesk/testinglibrary/DataGenerator';
 
 const dataGenerator = new DataGenerator();
 
-export async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null, page = null) {
+export async function generateAndCacheTestData(executionContext, type, identifier, dataTable, cacheLayer, entityName, profile = null) {
     let actorInfo;
     const testInfo = test.info();
     const scenarioName = testInfo.title.split('/').pop() || 'Unknown Scenario';
@@ -16,6 +16,6 @@ export async function generateAndCacheTestData(executionContext, type, identifie
         actorInfo = executionContext.actorInfo;
     }
     
-    const generatedData = await dataGenerator.generate(testInfo, actorInfo, type, identifier, scenarioName, dataTable ? dataTable.hashes() : [], page);
+    const generatedData = await dataGenerator.generate(testInfo, actorInfo, type, identifier, scenarioName, dataTable ? dataTable.hashes() : []);
     await cacheLayer.set(entityName, generatedData.data);
 }

package/build/core/dataGenerator/DataGenerator.js

@@ -9,7 +9,6 @@ var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _logger = require("../../utils/logger");
 var _DataGeneratorHelper = require("./DataGeneratorHelper");
-var _Authenticator = _interopRequireDefault(require("./authenticator/Authenticator.js"));
 var _helpers = require("@zohodesk/testinglibrary/helpers");
 var _DataGeneratorError = require("./DataGeneratorError");
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
@@ -20,7 +19,7 @@ class DataGenerator {
   constructor() {
     _classPrivateMethodInitSpec(this, _DataGenerator_brand);
   }
-  async generate(testInfo, actorInfo, generatorType, generatorName, scenarioName, dataTable, page = null) {
+  async generate(testInfo, actorInfo, generatorType, generatorName, scenarioName, dataTable) {
     try {
       let generators;
       if (generatorType === 'API') {
@@ -29,7 +28,7 @@ class DataGenerator {
         generators = await _assertClassBrand(_DataGenerator_brand, this, _getGenerator).call(this, testInfo, generatorName);
       }
       const processedGenerators = await (0, _DataGeneratorHelper.processGenerator)(generators, dataTable);
-      const apiPayload = await _assertClassBrand(_DataGenerator_brand, this, _constructApiPayload).call(this, scenarioName, processedGenerators, actorInfo, page);
+      const apiPayload = await _assertClassBrand(_DataGenerator_brand, this, _constructApiPayload).call(this, scenarioName, processedGenerators, actorInfo);
       const response = await (0, _DataGeneratorHelper.makeRequest)(process.env.DG_SERVICE_DOMAIN + process.env.DG_SERVICE_API_PATH, apiPayload);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `Generated response for the generator: ${generatorName} for scenario: ${scenarioName}, Response: ${JSON.stringify(response)}`);
       return response;
@@ -73,12 +72,12 @@ async function _generateAPIGenerator(operationId) {
     name: operationId
   }];
 }
-async function _constructApiPayload(scenarioName, processedGenerators, actorInfo, page = null) {
+async function _constructApiPayload(scenarioName, processedGenerators, actorInfo) {
   const dataGeneratorObj = actorInfo['data-generator'];
   if (!dataGeneratorObj) {
     throw new _DataGeneratorError.DataGeneratorConfigurationError(`Data Generator configuration is missing for the profile: ${actorInfo['profile']}`);
   }
-  let apiPayload = {
+  const apiPayload = {
     scenario_name: scenarioName,
     data_generation_templates: processedGenerators,
     ...dataGeneratorObj
@@ -95,10 +94,6 @@ async function _constructApiPayload(scenarioName, processedGenerators, actorInfo
     environmentDetails.host = domainUrl.origin;
   }
   apiPayload.environmentDetails = environmentDetails;
-
-  // Only perform auth augmentation via Authenticator
-  apiPayload = await new _Authenticator.default().constructPayload(apiPayload, actorInfo, page);
-  console.log("Final API Payload after authentication augmentation: ", JSON.stringify(apiPayload));
   return apiPayload;
 }
 var _default = exports.default = DataGenerator;

package/build/core/playwright/builtInFixtures/caseTimeout.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _caseTimeoutResolver = require("../helpers/caseTimeoutResolver");
+var _default = exports.default = {
+  caseTimeout: [async ({
+    $tags
+  }, use, testInfo) => {
+    const timeoutMs = (0, _caseTimeoutResolver.resolveCaseTimeoutMs)($tags, testInfo.project.name);
+    if (timeoutMs !== null) {
+      testInfo.setTimeout(timeoutMs);
+    }
+    await use();
+  }, {
+    auto: true
+  }]
+};

package/build/core/playwright/builtInFixtures/index.js

@@ -9,6 +9,7 @@ var _page = _interopRequireDefault(require("./page"));
 var _context = _interopRequireDefault(require("./context"));
 var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
 var _addTags = _interopRequireDefault(require("./addTags"));
+var _caseTimeout = _interopRequireDefault(require("./caseTimeout"));
 var _i18N = _interopRequireDefault(require("./i18N"));
 var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
 var _executionContext = _interopRequireDefault(require("./executionContext"));
@@ -24,7 +25,8 @@ function getBuiltInFixtures(bddMode) {
     ..._cacheLayer.default,
     ..._i18N.default,
     ..._unauthenticatedPage.default,
-    ..._executionContext.default
+    ..._executionContext.default,
+    ..._caseTimeout.default
   };
   if (bddMode) {
     builtInFixtures = {

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

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getBrowserTimeoutFactor = getBrowserTimeoutFactor;
+var _browserTypes = require("../constants/browserTypes");
+function getBrowserTimeoutFactor(projectName) {
+  if (projectName === _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX) {
+    return 2;
+  }
+  if (projectName === _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI) {
+    return 4;
+  }
+  return 1;
+}

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

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TIMEOUT_TAG_PATTERN = void 0;
+exports.findTimeoutTags = findTimeoutTags;
+exports.parseTimeoutSeconds = parseTimeoutSeconds;
+exports.resolveCaseTimeoutMs = resolveCaseTimeoutMs;
+var _logger = require("../../../utils/logger");
+var _browserTimeoutFactor = require("./browserTimeoutFactor");
+const TIMEOUT_TAG_PATTERN = exports.TIMEOUT_TAG_PATTERN = /^@timeout_(\d+)$/;
+function findTimeoutTags(tags) {
+  if (!Array.isArray(tags)) {
+    return [];
+  }
+  return tags.filter(tag => typeof tag === 'string' && TIMEOUT_TAG_PATTERN.test(tag));
+}
+function parseTimeoutSeconds(tag) {
+  const match = tag.match(TIMEOUT_TAG_PATTERN);
+  return match ? Number(match[1]) : null;
+}
+function resolveCaseTimeoutMs(tags, projectName) {
+  const matched = findTimeoutTags(tags);
+  if (matched.length === 0) {
+    return null;
+  }
+  if (matched.length > 1) {
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Multiple @timeout_* tags found (${matched.join(', ')}). Using the first one: ${matched[0]}`);
+  }
+  const seconds = parseTimeoutSeconds(matched[0]);
+  if (seconds === 0) {
+    return 0;
+  }
+  const factor = (0, _browserTimeoutFactor.getBrowserTimeoutFactor)(projectName);
+  return seconds * 1000 * factor;
+}

package/build/core/playwright/readConfigFile.js

@@ -105,7 +105,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {any} reportPath : directory where report is generate
  * @property {boolean} bddMode: Feature files needs to be processed
  * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail. Can be overridden per-scenario by tagging the scenario with `@timeout_<seconds>` (e.g. `@timeout_180`). `@timeout_0` disables the timeout. Browser scaling (Firefox 2x, Safari 4x) is preserved.
  * @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

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

@@ -15,6 +15,7 @@ var _readConfigFile = require("../readConfigFile");
 var _playwrightBdd = require("playwright-bdd");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
+var _browserTimeoutFactor = require("../helpers/browserTimeoutFactor");
 var _fileUtils = require("../../../utils/fileUtils");
 var _ConfigurationHelper = require("../configuration/ConfigurationHelper");
 var _configConstants = _interopRequireDefault(require("../constants/configConstants"));
@@ -69,11 +70,12 @@ function getBrowserConfig({
       dependencies
     };
   } else if (browser === 'firefox') {
+    const factor = (0, _browserTimeoutFactor.getBrowserTimeoutFactor)(_browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX);
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX,
-      timeout: 2 * testTimeout,
+      timeout: factor * testTimeout,
       expect: {
-        timeout: 2 * expectTimeout
+        timeout: factor * expectTimeout
       },
       use: {
         ..._test.devices['Desktop Firefox'],
@@ -82,11 +84,12 @@ function getBrowserConfig({
       dependencies
     };
   } else if (browser === 'safari') {
+    const factor = (0, _browserTimeoutFactor.getBrowserTimeoutFactor)(_browserTypes.BROWSER_PROJECT_MAPPING.SAFARI);
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI,
-      timeout: 4 * testTimeout,
+      timeout: factor * testTimeout,
       expect: {
-        timeout: 4 * expectTimeout
+        timeout: factor * expectTimeout
       },
       use: {
         ..._test.devices['Desktop Safari'],

package/build/core/playwright/types.js

@@ -31,7 +31,7 @@
  * @property {any} reportPath : directory where report is generate
  * @property {boolean} bddMode: Feature files needs to be processed
  * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail. Can be overridden per-scenario by tagging the scenario with `@timeout_<seconds>` (e.g. `@timeout_180`). `@timeout_0` disables the timeout. Browser scaling (Firefox 2x, Safari 4x) is preserved.
  * @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

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

@@ -19,7 +19,7 @@ const testSetup = require('../../fixtures/testSetup');
  * @property {any} reportPath : directory where report is generate
  * @property {boolean} bddMode: Feature files needs to be processed
  * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
- * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail. Can be overridden per-scenario by tagging the scenario with `@timeout_<seconds>` (e.g. `@timeout_180`). `@timeout_0` disables the timeout. Browser scaling (Firefox 2x, Safari 4x) is preserved.
  * @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

package/build/test/core/playwright/buildInFixtures/__tests__/caseTimeout.test.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _caseTimeout = _interopRequireDefault(require("../../../../../core/playwright/builtInFixtures/caseTimeout"));
+var _caseTimeoutResolver = require("../../../../../core/playwright/helpers/caseTimeoutResolver");
+var _browserTypes = require("../../../../../core/playwright/constants/browserTypes");
+var _logger = require("../../../../../utils/logger");
+jest.mock('../../../../../utils/logger');
+describe('resolveCaseTimeoutMs', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('returns null when no timeout tag is present', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@smoke', '@edition_Free'], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBeNull();
+  });
+  test('returns null when tags is not an array', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(undefined, _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBeNull();
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(null, _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBeNull();
+  });
+  test('parses @timeout_<n> as seconds for Chrome (factor 1)', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_180'], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBe(180000);
+  });
+  test('applies Firefox 2x multiplier', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_180'], _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX)).toBe(360000);
+  });
+  test('returns 0 (no timeout) when tag is @timeout_0, regardless of browser', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_0'], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBe(0);
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_0'], _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX)).toBe(0);
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_0'], _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI)).toBe(0);
+  });
+  test('uses the first matching tag and logs a warning when multiple are present', () => {
+    const result = (0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_120', '@timeout_300'], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME);
+    expect(result).toBe(120_000);
+    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.INFO_TYPE, expect.stringContaining('Multiple @timeout_* tags found'));
+  });
+  test('ignores malformed timeout-like tags', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_', '@timeout_abc', '@timeout_-5', '@timeoutfoo'], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBeNull();
+  });
+  test('ignores non-string entries in tags', () => {
+    expect((0, _caseTimeoutResolver.resolveCaseTimeoutMs)(['@timeout_60', null, undefined, 42], _browserTypes.BROWSER_PROJECT_MAPPING.CHROME)).toBe(60_000);
+  });
+});
+describe('caseTimeout fixture', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  function getFixture() {
+    return _caseTimeout.default.caseTimeout[0];
+  }
+  test('is registered as an auto fixture', () => {
+    expect(_caseTimeout.default.caseTimeout[1]).toEqual({
+      auto: true
+    });
+  });
+  test('calls testInfo.setTimeout with scaled value when tag matches', async () => {
+    const use = jest.fn();
+    const testInfo = {
+      project: {
+        name: _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX
+      },
+      setTimeout: jest.fn()
+    };
+    await getFixture()({
+      $tags: ['@timeout_30']
+    }, use, testInfo);
+    expect(testInfo.setTimeout).toHaveBeenCalledWith(60_000);
+    expect(use).toHaveBeenCalled();
+  });
+  test('does not call testInfo.setTimeout when no tag is present', async () => {
+    const use = jest.fn();
+    const testInfo = {
+      project: {
+        name: _browserTypes.BROWSER_PROJECT_MAPPING.CHROME
+      },
+      setTimeout: jest.fn()
+    };
+    await getFixture()({
+      $tags: ['@smoke']
+    }, use, testInfo);
+    expect(testInfo.setTimeout).not.toHaveBeenCalled();
+    expect(use).toHaveBeenCalled();
+  });
+  test('passes 0 through to testInfo.setTimeout for @timeout_0', async () => {
+    const use = jest.fn();
+    const testInfo = {
+      project: {
+        name: _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI
+      },
+      setTimeout: jest.fn()
+    };
+    await getFixture()({
+      $tags: ['@timeout_0']
+    }, use, testInfo);
+    expect(testInfo.setTimeout).toHaveBeenCalledWith(0);
+  });
+});

package/jest.config.js

@@ -35,7 +35,7 @@ module.exports = {
     '^.+\\.jsx?$': 'babel-jest'
   },
   
-  testMatch: ['**/__tests__/**/*.test.js', '**/__test__/**/*.test.js'],
+  testMatch: ['**/__tests__/**/*.test.js'],
 
   modulePathIgnorePatterns: ['/build/'],