@zohodesk/testinglibrary 4.1.2 → 4.1.4

package/README.md

@@ -17,6 +17,22 @@
 
      - npm run report
 
+### v4.1.4/v3.3.3 - 18-06-2026
+
+#### Bugfix
+- Dependency project failure stats pushed into custom reporter
+- `stepDefinitionsFolder` hardcoded changes removed
+
+### v4.1.3/v3.3.2 - 08-06-2026
+
+#### Features
+ - Scenario-Based Timeouts: Define custom execution limits directly in your feature files using Gherkin tags (e.g., @timeout_180).
+
+### v4.1.2/v3.3.1 - 21-05-2026
+
+#### Features
+- Supported UnitTest via testing-framework
+
 ### v4.1.1/v3.3.0 - 28-01-2026
 
 #### Features

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/constants/reporterConstants.js

@@ -12,5 +12,9 @@ class ReporterConstants {
   static DEFAULT_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/${stage}/test-results/playwright-test-results.json`;
   static LAST_RUN_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/${stage}/test-results/.last-run.json`;
   static DEFAULT_UNIT_TEST_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/unit-test/unit_reports/report.html`;
+  static PROJECT_FAILURE_REASON_MAP = {
+    'setup': 'Login case failure',
+    'smokeTest': 'Smoke test failure'
+  };
 }
 exports.default = ReporterConstants;

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

@@ -23,7 +23,8 @@ const {
   trace,
   video,
   testIdAttribute,
-  viewport
+  viewport,
+  stepDefinitionsFolder
 } = uatConfig;
 function setupConfig() {
   const setupProject = new _Project.Project('setup');
@@ -38,7 +39,7 @@ function smokeTestConfig() {
   const smokeTestProject = new _Project.Project('smokeTest');
   const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
     featureFilesFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'smokeTest', '**', '*.feature'),
-    stepDefinitionsFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', '**', 'steps', '*.spec.js'),
+    stepDefinitionsFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', '**', stepDefinitionsFolder, '*.spec.js'),
     outputDir: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, '.features-smoke-gen'),
     uatPath: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'smokeTest')
   });

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

@@ -29,7 +29,8 @@ const {
   customReporter,
   trace,
   video,
-  testIdAttribute
+  testIdAttribute,
+  stepDefinitionsFolder
 } = uatConfig;
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -64,7 +65,7 @@ const use = {
 };
 const testDir = (0, _configUtils.getTestDir)(bddMode, {
   featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
-  stepDefinitionsFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', '**', 'steps', '*.spec.js'),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', '**', stepDefinitionsFolder, '*.spec.js'),
   outputDir: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, '.features-gen'),
   uatPath: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage)
 });

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,6 +12,18 @@ var _readConfigFile = require("../readConfigFile");
 var _logger = require("../../../utils/logger");
 var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _mergeAbortedTests = _interopRequireDefault(require("../reporter/helpers/mergeAbortedTests"));
+var _reporterConstants = _interopRequireDefault(require("../constants/reporterConstants"));
+// Traverse the suite tree upward until we reach the project-level suite
+function getProjectName(test) {
+  let suite = test.parent;
+  while (suite) {
+    var _suite$project, _suite;
+    const name = (_suite$project = (_suite = suite).project) === null || _suite$project === void 0 || (_suite$project = _suite$project.call(_suite)) === null || _suite$project === void 0 ? void 0 : _suite$project.name;
+    if (name) return name;
+    suite = suite.parent;
+  }
+  return '';
+}
 class JSONSummaryReporter {
   constructor() {
     this.durationInMS = -1;
@@ -27,6 +39,7 @@ class JSONSummaryReporter {
     this.status = 'unknown';
     this.startedAt = 0;
     this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
+    this.failedProject = null;
   }
   onBegin() {
     this.startedAt = Date.now();
@@ -76,6 +89,13 @@ class JSONSummaryReporter {
       this[status].push(fileName);
     }
     this[status].push(fileName);
+    const isFailure = result.status !== 'passed' && result.status !== 'skipped';
+    if (isFailure && !this.failedProject) {
+      const projectName = getProjectName(test);
+      if (projectName) {
+        this.failedProject = projectName;
+      }
+    }
   }
   onError(error) {
     this.errored.push({
@@ -116,6 +136,9 @@ class JSONSummaryReporter {
       // Reflect setup failures in the final report status
       this.status = "failed";
     }
+    if (this.failedProject && _reporterConstants.default.PROJECT_FAILURE_REASON_MAP[this.failedProject]) {
+      this.failureReason = _reporterConstants.default.PROJECT_FAILURE_REASON_MAP[this.failedProject];
+    }
 
     // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
     let {

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/lib/cli.js

@@ -24,14 +24,13 @@ switch (option) {
     }
   case 'unit-test':
     {
-      const testFile = process.argv[3];
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Unit Tests..');
-      const options = {};
-      if (testFile) {
-        _logger.Logger.log(_logger.Logger.INFO_TYPE, `Filtering tests with pattern: ${testFile}`);
-        options.testPathPattern = testFile;
-      }
-      (0, _unitTestingFramework.createJestRunner)(options);
+      (0, _unitTestingFramework.parseUnitTestArgs)(otherOptions).then(options => {
+        if (options.testPathPattern) {
+          _logger.Logger.log(_logger.Logger.INFO_TYPE, `Filtering tests with pattern: ${options.testPathPattern}`);
+        }
+        return (0, _unitTestingFramework.createJestRunner)(options);
+      });
       break;
     }
   case 'validate':

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/build/utils/commonUtils.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.copyCommonSpecs = copyCommonSpecs;
-exports.copyGithubFolder = copyGithubFolder;
 var _fileUtils = require("./fileUtils");
 var _path = _interopRequireDefault(require("path"));
 var _configConstants = _interopRequireDefault(require("../core/playwright/constants/configConstants"));
@@ -18,12 +17,4 @@ function copyCommonSpecs() {
   const destDirectory = _path.default.resolve(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'modules', '.testingLib-common');
   (0, _fileUtils.deleteFolder)(destDirectory);
   (0, _fileUtils.copyDirectory)(commonSpecPath, destDirectory);
-}
-function copyGithubFolder() {
-  const libraryPath = require.resolve("@zohodesk/testinglibrary");
-  // libraryPath will be build/index.js, go two levels up to reach the package root where .github lives
-  const githubSrcPath = _path.default.resolve(libraryPath, '../../', '.github');
-  const destDirectory = _path.default.resolve(process.cwd(), '../../', '.github');
-  (0, _fileUtils.deleteFolder)(destDirectory);
-  (0, _fileUtils.copyDirectory)(githubSrcPath, destDirectory);
 }