@zohodesk/testinglibrary 0.0.74-n20-experimental → 0.0.82-n20-experimental

package/build/core/playwright/readConfigFile.js

@@ -37,6 +37,7 @@ function getDefaultConfig() {
     forbidOnly: false,
     retries: 0,
     trace: false,
+    smokeTestTrace: 'on',
     video: false,
     isAuthMode: false,
     openReportOn: 'never',
@@ -55,7 +56,11 @@ function getDefaultConfig() {
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
     testSetup: {},
-    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
+    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
+    showCaseTimings: false,
+    browserLogs: {
+      mode: 'failure-only'
+    }
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
@@ -96,6 +101,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {string} uatDirectory - Directory in which uat configuration is places.
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
+ * @property {string} smokeTestTrace - trace mode for the smokeTest project (e.g. 'on', 'off', 'retain-on-failure'). Default is 'on'.
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
@@ -113,6 +119,8 @@ 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} browserLogs: Runtime browser log capture. { mode: 'failure-only' | 'always', limits?: { maxEvents, captureHeaders, ignoreUrlPatterns, ignoreMessagePatterns } }. ignoreMessagePatterns is a list of RegExp matched against console-error text and pageerror messages; matching events are skipped. Default: { mode: 'failure-only' }.
  */
 
 /**

package/build/core/playwright/setup/ProjectConfiguration.js

@@ -21,6 +21,7 @@ const {
   bddMode,
   authFilePath,
   trace,
+  smokeTestTrace,
   video,
   testIdAttribute,
   viewport,
@@ -44,7 +45,8 @@ function smokeTestConfig() {
     uatPath: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'smokeTest')
   });
   const commonConfig = {
-    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {},
+    trace: smokeTestTrace
   };
   smokeTestProject.setTestDir(smokeTestDir);
   smokeTestProject.setRetries(0);

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

@@ -24,6 +24,22 @@ function getProjectName(test) {
   }
   return '';
 }
+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;
@@ -38,12 +54,23 @@ class JSONSummaryReporter {
     this.failedSteps = [];
     this.status = 'unknown';
     this.startedAt = 0;
-    this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
+    const config = (0, _readConfigFile.generateConfigFromFile)();
+    this._open = config.openReportOn;
+    this._showCaseTimings = config.showCaseTimings !== false;
+    this._caseTimings = [];
     this.failedProject = null;
   }
   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 = [];
@@ -89,6 +116,55 @@ 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
+            }
+          } : {})
+        });
+      }
+    }
     const isFailure = result.status !== 'passed' && result.status !== 'skipped';
     if (isFailure && !this.failedProject) {
       const projectName = getProjectName(test);
@@ -145,6 +221,16 @@ 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

@@ -21,6 +21,7 @@
  * @property {string} uatDirectory - Directory in which uat configuration is places.
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
+ * @property {string} smokeTestTrace - trace mode for the smokeTest project (e.g. 'on', 'off', 'retain-on-failure'). Default is 'on'.
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {string} mode: mode in which the test cases needs to run

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

@@ -9,6 +9,7 @@ const testSetup = require('../../fixtures/testSetup');
  * @typedef {Object} UserConfig
  * @property {string} headless - Headless Browsers mode.
  * @property {number} trace - trace for test cases.
+ * @property {string} smokeTestTrace - trace mode for the smokeTest project (e.g. 'on', 'off', 'retain-on-failure'). Default is 'on'.
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {string} mode: mode in which the test cases needs to run
@@ -37,6 +38,7 @@ module.exports = {
   isAuthMode: true,
   authFilePath: 'uat/playwright/.auth/user.json',
   trace: true,
+  smokeTestTrace: 'on',
   video: true,
   bddMode: true,
   featureFilesFolder: 'feature-files',

package/build/test/core/dataGenerator/authenticator/__tests__/Authenticator.test.js

@@ -0,0 +1,88 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _Authenticator = _interopRequireDefault(require("../../../../../../src/core/dataGenerator/authenticator/Authenticator"));
+describe('Authenticator', () => {
+  it('should throw an error when an unknown authentication type is present', async () => {
+    const authenticator = new _Authenticator.default();
+    const apiPayload = {
+      account: {
+        name: 'sample'
+      }
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          authentications: ['apikey', 'basic']
+        }
+      }
+    };
+    await expect(authenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('Unknown authentication type: "apikey"');
+  });
+  it('should route oauth2 authentication and merge oauth2 config into payload', async () => {
+    const authenticator = new _Authenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          authentications: ['oauth2'],
+          oauth2: {
+            client_id: 'client_1',
+            client_secret: 'secret_1'
+          }
+        }
+      }
+    };
+    const result = await authenticator.constructPayload(apiPayload, actorInfo);
+    expect(result.account.oauth2).toEqual({
+      client_id: 'client_1',
+      client_secret: 'secret_1'
+    });
+  });
+  it('should treat authentication values case-insensitively and deduplicate them', async () => {
+    const authenticator = new _Authenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          authentications: ['OAUTH2', 'oauth2', 'OAuth2'],
+          oauth2: {
+            scope: 'read'
+          }
+        }
+      }
+    };
+    const result = await authenticator.constructPayload(apiPayload, actorInfo);
+    expect(result.account.oauth2).toEqual({
+      scope: 'read'
+    });
+  });
+  it('should apply only the first supported authentication type', async () => {
+    const authenticator = new _Authenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          authentications: ['oauth2', 'org-oauth'],
+          oauth2: {
+            client_id: 'oauth-client'
+          },
+          org_oauth: {
+            org_id: 'org-101'
+          }
+        }
+      }
+    };
+    const result = await authenticator.constructPayload(apiPayload, actorInfo);
+    expect(result.account.oauth2).toEqual({
+      client_id: 'oauth-client'
+    });
+    expect(result.account.org_oauth).toBeUndefined();
+  });
+});

package/build/test/core/dataGenerator/authenticator/__tests__/JWTauthenticator.test.js

@@ -0,0 +1,129 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _JWTauthenticator = _interopRequireDefault(require("../../../../../../src/core/dataGenerator/authenticator/JWTauthenticator"));
+describe('JWTauthenticator', () => {
+  let fetchMock;
+  beforeEach(() => {
+    fetchMock = jest.fn();
+    global.fetch = fetchMock;
+    process.env.DG_JWT_AUTH_URL = 'https://jwt-auth.example.com';
+    process.env.DG_DOMAIN_URL = 'https://domain.example.com';
+    process.env.DG_JWT_AUTHENTICATOR_API = 'https://authenticator.example.com/jwtToken';
+  });
+  afterEach(() => {
+    delete global.fetch;
+    delete process.env.DG_JWT_AUTH_URL;
+    delete process.env.DG_DOMAIN_URL;
+    delete process.env.DG_JWT_AUTHENTICATOR_API;
+  });
+  it('should throw when jwt-oauth config is missing', async () => {
+    const jwtAuthenticator = new _JWTauthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      email: 'user@example.com',
+      'data-generator': {
+        account: {}
+      }
+    };
+    await expect(jwtAuthenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('JWT authentication failed: "jwt-oauth" is missing in actor configuration');
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+  it('should fetch jwt access token and set it in authHeaders', async () => {
+    fetchMock.mockResolvedValue({
+      ok: true,
+      json: async () => ({
+        access_token: 'access-token-123'
+      })
+    });
+    const jwtAuthenticator = new _JWTauthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      email: 'user.one@example.com',
+      'data-generator': {
+        account: {
+          'jwt-oauth': {
+            jwt_secret: 'jwt-secret',
+            response_type: 'token',
+            client_id: '12345.client-id',
+            token_url: 'https://token.example.com/12345/oauth'
+          }
+        }
+      }
+    };
+    const result = await jwtAuthenticator.constructPayload(apiPayload, actorInfo);
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(fetchMock).toHaveBeenCalledWith('https://authenticator.example.com/jwtToken', expect.objectContaining({
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    }));
+    const requestBody = JSON.parse(fetchMock.mock.calls[0][1].body);
+    expect(requestBody).toEqual(expect.objectContaining({
+      user_token: encodeURIComponent('user.one@example.com'),
+      jwt_secret: 'jwt-secret',
+      jwt_auth_url: 'https://jwt-auth.example.com',
+      response_type: 'token',
+      client_id: '12345.client-id',
+      token_url: 'https://token.example.com/12345/oauth',
+      domain_url: 'https://domain.example.com'
+    }));
+    expect(result.account.authHeaders.Authorization).toBe('Zoho-oauthtoken access-token-123');
+  });
+  it('should throw a descriptive error when authenticator API returns non-ok response', async () => {
+    fetchMock.mockResolvedValue({
+      ok: false,
+      status: 500,
+      text: async () => 'internal error'
+    });
+    const jwtAuthenticator = new _JWTauthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      email: 'user@example.com',
+      'data-generator': {
+        account: {
+          'jwt-oauth': {
+            jwt_secret: 'jwt-secret',
+            response_type: 'token',
+            client_id: '12345.client-id',
+            token_url: 'https://token.example.com/12345/oauth'
+          }
+        }
+      }
+    };
+    await expect(jwtAuthenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('JWT authenticator error! status: 500, body: internal error');
+  });
+  it('should throw when authenticator response has no access_token', async () => {
+    fetchMock.mockResolvedValue({
+      ok: true,
+      json: async () => ({
+        token_type: 'Bearer'
+      })
+    });
+    const jwtAuthenticator = new _JWTauthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      email: 'user@example.com',
+      'data-generator': {
+        account: {
+          'jwt-oauth': {
+            jwt_secret: 'jwt-secret',
+            response_type: 'token',
+            client_id: '12345.client-id',
+            token_url: 'https://token.example.com/12345/oauth'
+          }
+        }
+      }
+    };
+    await expect(jwtAuthenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('JWT authenticator did not return access_token');
+  });
+});

package/build/test/core/dataGenerator/authenticator/__tests__/OAuthAuthenticator.test.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _OAuthAuthenticator = _interopRequireDefault(require("../../../../../../src/core/dataGenerator/authenticator/OAuthAuthenticator"));
+describe('OAuthAuthenticator', () => {
+  it('should assign oauth2 from actor info into payload account', async () => {
+    const oauthAuthenticator = new _OAuthAuthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          oauth2: {
+            client_id: 'new-client',
+            scope: 'tickets.read'
+          }
+        }
+      }
+    };
+    const result = await oauthAuthenticator.constructPayload(apiPayload, actorInfo);
+    expect(result.account.oauth2).toEqual({
+      client_id: 'new-client',
+      scope: 'tickets.read'
+    });
+  });
+  it('should throw when oauth2 is absent in actor configuration', async () => {
+    const oauthAuthenticator = new _OAuthAuthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {}
+      }
+    };
+    await expect(oauthAuthenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('OAuth2 authentication failed: "oauth2" is missing in actor configuration');
+  });
+});

package/build/test/core/dataGenerator/authenticator/__tests__/OrgOAuthAuthenticator.test.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _OrgOAuthAuthenticator = _interopRequireDefault(require("../../../../../../src/core/dataGenerator/authenticator/OrgOAuthAuthenticator"));
+describe('OrgOAuthAuthenticator', () => {
+  it('should assign org_oauth from actor info into payload account', async () => {
+    const orgOAuthAuthenticator = new _OrgOAuthAuthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {
+          org_oauth: {
+            org_id: 'org-1001',
+            region: 'us'
+          }
+        }
+      }
+    };
+    const result = await orgOAuthAuthenticator.constructPayload(apiPayload, actorInfo);
+    expect(result.account.org_oauth).toEqual({
+      org_id: 'org-1001',
+      region: 'us'
+    });
+  });
+  it('should throw when org_oauth is absent in actor configuration', async () => {
+    const orgOAuthAuthenticator = new _OrgOAuthAuthenticator.default();
+    const apiPayload = {
+      account: {}
+    };
+    const actorInfo = {
+      'data-generator': {
+        account: {}
+      }
+    };
+    await expect(orgOAuthAuthenticator.constructPayload(apiPayload, actorInfo)).rejects.toThrow('OrgOAuth authentication failed: "org_oauth" is missing in actor configuration');
+  });
+});

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

@@ -13,7 +13,10 @@ jest.mock('../../../../core/playwright/helpers/parseUserArgs', () => ({
 }));
 jest.mock('../../../../core/playwright/readConfigFile');
 jest.mock('../../../../core/playwright/tagProcessor');
-jest.mock('../../../../core/playwright/test-runner');
+jest.mock('../../../../core/playwright/test-runner', () => ({
+  __esModule: true,
+  runPreprocessing: jest.fn()
+}));
 jest.mock('../../../../utils/logger', () => ({
   __esModule: true,
   Logger: {

package/build/test/core/playwright/runner/__tests__/RunnerHelper.test.js

@@ -3,6 +3,9 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _RunnerHelper = _interopRequireDefault(require("../../../../../core/playwright/runner/RunnerHelper"));
 var _SpawnRunner = _interopRequireDefault(require("../../../../../core/playwright/runner/SpawnRunner"));
+jest.mock('../../../../../core/playwright/setup/config-utils', () => ({
+  getBrowsersList: jest.fn().mockReturnValue([])
+}));
 describe('RunnerHelper', () => {
   describe('createRunner', () => {
     it('should throw error on invalid runner type', () => {

package/build/test/core/playwright/runner/__tests__/SpawnRunner.test.js

@@ -6,6 +6,9 @@ var _Runner = _interopRequireDefault(require("../../../../../core/playwright/run
 var _Configuration = _interopRequireDefault(require("../../../../../core/playwright/configuration/Configuration"));
 jest.mock('child_process');
 jest.mock('../../../../../utils/logger');
+jest.mock('../../../../../core/playwright/setup/config-utils', () => ({
+  getBrowsersList: jest.fn().mockReturnValue([])
+}));
 describe('SpawnRunner', () => {
   let spawnRunner;
   const runnerObj = new _Runner.default();