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

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/context.js

@@ -1,22 +1,13 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _logCollector = require("../helpers/logCollector");
 const {
-  testSetup,
-  uatDirectory,
-  runtimeLogs = {}
+  testSetup
 } = (0, _readConfigFile.generateConfigFromFile)();
-
-// Keep runtime logs OUTSIDE reportPath (HTML reporter wipes it on onEnd) and
-// outside test-results (Playwright outputDir is cleaned each run).
-const LOGS_DIR = _path.default.join(uatDirectory, 'runtime-logs');
 async function performDefaultContextSteps({
   context
 }) {
@@ -29,37 +20,13 @@ async function performDefaultContextSteps({
 var _default = exports.default = {
   context: async ({
     context
-  }, use, testInfo) => {
+  }, use) => {
     await context.addInitScript(() =>
     // eslint-disable-next-line no-undef
     window.localStorage.setItem('isDnBannerHide', true));
     await performDefaultContextSteps({
       context
     });
-    const collector = new _logCollector.LogCollector(runtimeLogs.limits);
-    collector.attachToContext(context);
-    testInfo.runtimeLogs = collector;
-    try {
-      await use(context);
-    } finally {
-      collector.detach();
-      const failureOnly = runtimeLogs.mode === 'failure-only';
-      const isFailure = testInfo.status && testInfo.status !== testInfo.expectedStatus;
-      const shouldFlush = !failureOnly || isFailure;
-      const summary = collector.toSummary();
-      let filePath = null;
-      if (shouldFlush) {
-        const base = `w${testInfo.workerIndex}-${testInfo.testId}-${testInfo.retry}`;
-        filePath = collector.flushToFile(LOGS_DIR, base);
-      }
-      await testInfo.attach('runtime-log', {
-        contentType: 'application/json',
-        body: Buffer.from(JSON.stringify({
-          schemaVersion: 1,
-          summary,
-          file: filePath
-        }))
-      });
-    }
+    await use(context);
   }
 };

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

@@ -55,11 +55,7 @@ function getDefaultConfig() {
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
     testSetup: {},
-    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
-    showCaseTimings: true,
-    runtimeLogs: {
-      mode: 'failure-only'
-    }
+    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
@@ -109,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
@@ -117,8 +113,6 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
  * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
  * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
- * @property {boolean} showCaseTimings: When true, the console reporter prints per-case start/end wall-clock times (h:mm:ss AM/PM) and a case-timings.json sidecar is written to reportPath for the HTML report addon. Default: true.
- * @property {Object} runtimeLogs: Runtime browser log capture. { mode: 'failure-only' | 'always', limits?: { maxEvents, captureHeaders, ignoreUrlPatterns } }. Default: { mode: 'failure-only' }.
  */
 
 /**

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/setup/custom-reporter.js

@@ -12,22 +12,6 @@ var _readConfigFile = require("../readConfigFile");
 var _logger = require("../../../utils/logger");
 var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _mergeAbortedTests = _interopRequireDefault(require("../reporter/helpers/mergeAbortedTests"));
-function formatTime(date) {
-  return date.toLocaleTimeString('en-US', {
-    hour: 'numeric',
-    minute: '2-digit',
-    second: '2-digit',
-    hour12: true
-  });
-}
-function formatDuration(ms) {
-  if (ms < 1000) return `${ms}ms`;
-  const totalSeconds = ms / 1000;
-  if (totalSeconds < 60) return `${totalSeconds.toFixed(2)}s`;
-  const minutes = Math.floor(totalSeconds / 60);
-  const seconds = (totalSeconds - minutes * 60).toFixed(2);
-  return `${minutes}m ${seconds}s`;
-}
 class JSONSummaryReporter {
   constructor() {
     this.durationInMS = -1;
@@ -42,22 +26,11 @@ class JSONSummaryReporter {
     this.failedSteps = [];
     this.status = 'unknown';
     this.startedAt = 0;
-    const config = (0, _readConfigFile.generateConfigFromFile)();
-    this._open = config.openReportOn;
-    this._showCaseTimings = config.showCaseTimings !== false;
-    this._caseTimings = [];
+    this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
   }
   onBegin() {
     this.startedAt = Date.now();
   }
-  onTestBegin(test) {
-    if (!this._showCaseTimings) return;
-    const {
-      fullTitle
-    } = this.getTitle(test);
-    const startedAtLabel = formatTime(new Date());
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `▶ ${fullTitle} — started at ${startedAtLabel}`);
-  }
   getTitle(test) {
     const title = [];
     const fileName = [];
@@ -103,55 +76,6 @@ class JSONSummaryReporter {
       this[status].push(fileName);
     }
     this[status].push(fileName);
-    if (this._showCaseTimings && result.startTime) {
-      const startDate = new Date(result.startTime);
-      const endDate = new Date(startDate.getTime() + (result.duration || 0));
-      const startLabel = formatTime(startDate);
-      const endLabel = formatTime(endDate);
-      const durationLabel = formatDuration(result.duration || 0);
-      const statusGlyph = result.status === 'passed' ? '✓' : result.status === 'skipped' ? '○' : '✗';
-      const logType = result.status === 'passed' ? _logger.Logger.SUCCESS_TYPE : result.status === 'skipped' ? _logger.Logger.INFO_TYPE : _logger.Logger.FAILURE_TYPE;
-      _logger.Logger.log(logType, `${statusGlyph} ${fullTitle} — ended at ${endLabel} (started ${startLabel}, took ${durationLabel})`);
-      const isFailure = result.status !== 'passed' && result.status !== 'skipped';
-      if (isFailure) {
-        var _result$error;
-        const runtimeAttachment = (result.attachments || []).find(a => a.name === 'runtime-log' && a.body);
-        let runtime = null;
-        if (runtimeAttachment) {
-          try {
-            runtime = JSON.parse(runtimeAttachment.body.toString('utf8'));
-          } catch {
-            // malformed attachment; skip
-          }
-        }
-        this._caseTimings.push({
-          title: fullTitle,
-          fileName,
-          status: result.status,
-          retry: result.retry,
-          startTime: startDate.toISOString(),
-          endTime: endDate.toISOString(),
-          startTimeFormatted: startLabel,
-          endTimeFormatted: endLabel,
-          duration: result.duration || 0,
-          durationFormatted: durationLabel,
-          errorMessage: (_result$error = result.error) === null || _result$error === void 0 ? void 0 : _result$error.message,
-          failedSteps: (result.steps || []).filter(step => step.error).map(step => {
-            var _step$error;
-            return {
-              title: step.title,
-              error: (_step$error = step.error) === null || _step$error === void 0 ? void 0 : _step$error.message
-            };
-          }),
-          ...(runtime ? {
-            runtime: {
-              summary: runtime.summary,
-              logFile: runtime.file
-            }
-          } : {})
-        });
-      }
-    }
   }
   onError(error) {
     this.errored.push({
@@ -198,16 +122,6 @@ class JSONSummaryReporter {
       reportPath
     } = (0, _readConfigFile.generateConfigFromFile)();
     (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', (0, _configFileNameProvider.getReportFileName)()), JSON.stringify(this, null, '  '));
-    if (this._showCaseTimings && this._caseTimings.length > 0) {
-      const timingsPayload = {
-        suiteStartedAt: new Date(this.startedAt).toISOString(),
-        suiteEndedAt: new Date(this.startedAt + this.durationInMS).toISOString(),
-        suiteDurationMs: this.durationInMS,
-        failedCount: this._caseTimings.length,
-        cases: this._caseTimings
-      };
-      (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, 'case-timings.json'), JSON.stringify(timingsPayload, null, '  '));
-    }
   }
   onExit() {
     // Update .last-run.json with aborted tests due to timing out or interruption

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);
+  });
+});