@zohodesk/testinglibrary 2.9.1 → 2.9.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/.gitlab-ci.yml +34 -20
  2. package/README.md +5 -0
  3. package/build/core/playwright/builtInFixtures/page.js +7 -0
  4. package/build/core/playwright/constants/fileMutexConfig.js +15 -0
  5. package/build/core/playwright/helpers/auth/checkAuthCookies.js +2 -8
  6. package/build/core/playwright/helpers/auth/loginSteps.js +26 -18
  7. package/build/core/playwright/helpers/checkAuthDirectory.js +27 -0
  8. package/build/core/playwright/helpers/fileMutex.js +55 -0
  9. package/build/core/playwright/runner/Runner.js +22 -0
  10. package/build/core/playwright/runner/RunnerHelper.js +43 -0
  11. package/build/core/playwright/runner/RunnerTypes.js +17 -0
  12. package/build/core/playwright/runner/SpawnRunner.js +110 -0
  13. package/build/core/playwright/test-runner.js +8 -34
  14. package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js +71 -0
  15. package/build/test/core/playwright/runner/__tests__/RunnerHelper.test.js +16 -0
  16. package/build/test/core/playwright/runner/__tests__/SpawnRunner.test.js +27 -0
  17. package/nobdd/uat/conf/default/actors/index.js +1 -4
  18. package/nobdd/uat/conf/default/settings.json +1 -1
  19. package/nobdd/uat/conf/nobdd/uat.config.js +12 -4
  20. package/nobdd/uat/env-config.json +3 -3
  21. package/nobdd/uat/fixtures/setup.teardown.js +2 -1
  22. package/nobdd/uat/modules/nobdd/steps/VerifyNoBDD.feature.spec.js +3 -3
  23. package/nobdd/uat.config.js +11 -4
  24. package/package.json +2 -1
  25. package/nobdd/uat/conf/default/actors/beta/custom-module.json +0 -24
  26. package/nobdd/uat/conf/default/actors/beta/index.js +0 -6
  27. package/nobdd/uat/conf/default/actors/beta/parent-child.json +0 -24
package/.gitlab-ci.yml CHANGED
@@ -1,29 +1,35 @@
1
1
  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
2
2
 
3
- #workflow:
4
- # rules:
5
- # - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
3
+ workflow:
4
+ rules:
5
+ - if: $CI_PIPELINE_SOURCE == "merge_request_event"
6
+ when: always
7
+ - if: $CI_PIPELINE_SOURCE == "web"
8
+ when: always
6
9
 
7
10
  stages:
8
11
  - build
9
12
  - unit
10
13
  - uat
11
14
 
15
+ default:
16
+ cache:
17
+ key: build-cache
18
+ paths:
19
+ - node_modules
20
+ - build
21
+
12
22
  # Install dependencies stage
13
23
  build:
14
24
  stage: build
15
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
16
25
  script:
26
+ - npm install --ignore-scripts
27
+ - npm run build
17
28
  - npm install
18
- artifacts:
19
- paths:
20
- - node_modules/
21
-
22
29
 
23
30
  # Unit tests stage
24
31
  unit:
25
32
  stage: unit
26
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
27
33
  script:
28
34
  - npm run test
29
35
  artifacts:
@@ -34,10 +40,7 @@ unit:
34
40
  # UAT tests stage
35
41
  uat-auth:
36
42
  stage: uat
37
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
38
43
  script:
39
- - npm install
40
- - npm run build
41
44
  - cd examples
42
45
  - npm install $(npm pack ../../testing-framework | tail -1)
43
46
  - output=$(npm run uatauth)
@@ -53,10 +56,7 @@ uat-auth:
53
56
 
54
57
  uat-noauth:
55
58
  stage: uat
56
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
57
59
  script:
58
- - npm install
59
- - npm run build
60
60
  - cd examples
61
61
  - npm install $(npm pack ../../testing-framework | tail -1)
62
62
  - output=$(npm run uatnoauth)
@@ -72,10 +72,7 @@ uat-noauth:
72
72
 
73
73
  uat-profile:
74
74
  stage: uat
75
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
76
75
  script:
77
- - npm install
78
- - npm run build
79
76
  - cd examples
80
77
  - npm install $(npm pack ../../testing-framework | tail -1)
81
78
  - output=$(npm run uatprofile)
@@ -89,12 +86,30 @@ uat-profile:
89
86
  paths:
90
87
  - examples/uat/playwright-report
91
88
 
92
- uat-nobdd:
89
+
90
+ uat-unauth:
93
91
  stage: uat
94
92
  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
95
93
  script:
96
94
  - npm install
97
95
  - npm run build
96
+ - cd examples
97
+ - npm install $(npm pack ../../testing-framework | tail -1)
98
+ - output=$(npm run uatunauth)
99
+ - echo "$output"
100
+ - if [[ "$output" == *"failed"* ]]; then
101
+ - exit 1
102
+ - fi
103
+
104
+
105
+ artifacts:
106
+ when: always
107
+ paths:
108
+ - examples/uat/playwright-report
109
+
110
+ uat-nobdd:
111
+ stage: uat
112
+ script:
98
113
  - cd nobdd
99
114
  - npm install $(npm pack ../../testing-framework | tail -1)
100
115
  - output=$(npm run uatnobdd)
@@ -108,4 +123,3 @@ uat-nobdd:
108
123
  when: always
109
124
  paths:
110
125
  - nobdd/uat/playwright-report
111
-
package/README.md CHANGED
@@ -38,3 +38,8 @@
38
38
 
39
39
  #### Enhancement
40
40
  - Beta feature Actors and edition configurations are unified
41
+
42
+ ### v0.2.9.2 - 22-11-2024
43
+
44
+ #### BugFix
45
+ - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.
@@ -70,6 +70,13 @@ var _default = exports.default = {
70
70
  await use(page);
71
71
  return;
72
72
  }
73
+
74
+ //This block is used to skip the login process if the @unauthenticated tag is added to the script
75
+ if ($tags.includes('@unauthenticated')) {
76
+ await context.clearCookies();
77
+ await use(page);
78
+ return;
79
+ }
73
80
  const testPortalDetails = getCustomAccountDetails($tags);
74
81
  if (testPortalDetails === null) {
75
82
  await performDefaultPageSteps({
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.LOGIN_MUTEX_TIMEOUT = void 0;
7
+ const LOGIN_MUTEX_TIMEOUT = exports.LOGIN_MUTEX_TIMEOUT = {
8
+ stale: 100000,
9
+ retries: {
10
+ retries: 10,
11
+ factor: 1,
12
+ minTimeout: 10000,
13
+ maxTimeout: 20000
14
+ }
15
+ };
@@ -10,6 +10,7 @@ exports.verifyIfCookieFileExists = verifyIfCookieFileExists;
10
10
  var _path = _interopRequireDefault(require("path"));
11
11
  var _fs = require("fs");
12
12
  var _readConfigFile = require("../../readConfigFile");
13
+ var _checkAuthDirectory = require("../checkAuthDirectory");
13
14
  var _logger = require("../../../../utils/logger");
14
15
  /* eslint-disable no-console */
15
16
 
@@ -23,13 +24,7 @@ function getAuthFileDirectory() {
23
24
  return _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.auth'));
24
25
  }
25
26
  function verifyIfCookieFileExists(authFile) {
26
- const authDirectory = getAuthFileDirectory();
27
- if (!(0, _fs.existsSync)(authDirectory)) {
28
- console.log('Creating auth directory for the first time setup...');
29
- (0, _fs.mkdirSync)(authDirectory, {
30
- recursive: true
31
- });
32
- }
27
+ (0, _checkAuthDirectory.createAuthDirectoryIfNotExist)();
33
28
  if (!(0, _fs.existsSync)(authFile)) {
34
29
  console.log('creating auth file..');
35
30
  (0, _fs.writeFileSync)(authFile, JSON.stringify(authContent, null, 2));
@@ -41,7 +36,6 @@ function convertCookiesToParse(cookies, authFilePath) {
41
36
  } catch (err) {
42
37
  _logger.Logger.error(err);
43
38
  throw new Error(` Error while parsing cookies ${err} \n${_path.default.resolve(process.cwd(), authFilePath)} File is Empty`);
44
- // process.exit()
45
39
  }
46
40
  }
47
41
  async function loadCookiesIfPresent(page, authFile) {
@@ -6,8 +6,11 @@ Object.defineProperty(exports, "__esModule", {
6
6
  });
7
7
  exports.default = void 0;
8
8
  var _path = _interopRequireDefault(require("path"));
9
+ var _fileMutex = _interopRequireDefault(require("../fileMutex"));
10
+ var _fileMutexConfig = require("../../constants/fileMutexConfig");
9
11
  var _accountLogin = _interopRequireDefault(require("./accountLogin"));
10
12
  var _checkAuthCookies = require("./checkAuthCookies");
13
+ var _checkAuthDirectory = require("../checkAuthDirectory");
11
14
  /* eslint-disable no-console */
12
15
 
13
16
  async function performLoginSteps({
@@ -17,25 +20,30 @@ async function performLoginSteps({
17
20
  password
18
21
  }, isLoggedIn) {
19
22
  const authFile = _path.default.resolve(_path.default.join((0, _checkAuthCookies.getAuthFileDirectory)(), `${authFilePrefix}-cookies.json`));
20
- await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
21
- await page.goto(process.env.domain);
22
-
23
- // await page.waitForNavigation();
24
-
25
- // await page.waitForLoadState('networkidle')
26
-
27
- await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
28
- const loginStatus = await isLoggedIn(page);
29
- if (!loginStatus) {
30
- await (0, _accountLogin.default)(page, useremail, password);
23
+ const lockFileName = useremail.replace(/[@.]/g, '_');
24
+ const fileMutex = new _fileMutex.default((0, _checkAuthDirectory.getLockDirectoryPath)(), lockFileName, _fileMutexConfig.LOGIN_MUTEX_TIMEOUT);
25
+ try {
26
+ await fileMutex.acquire();
27
+ await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
31
28
  await page.goto(process.env.domain);
32
-
33
- // await page.waitForLoadState();
34
-
35
- await isLoggedIn(page);
36
- await page.context().storageState({
37
- path: authFile
38
- });
29
+ await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
30
+ const isAlreadyLoggedIn = await isLoggedIn(page);
31
+ if (!isAlreadyLoggedIn) {
32
+ await (0, _accountLogin.default)(page, useremail, password);
33
+ await page.goto(process.env.domain);
34
+ await isLoggedIn(page);
35
+ await page.context().storageState({
36
+ path: authFile
37
+ });
38
+ }
39
+ } catch (error) {
40
+ console.error(`Error during login for ${useremail}:`, error);
41
+ } finally {
42
+ try {
43
+ await fileMutex.release();
44
+ } catch (releaseError) {
45
+ console.error(`Error releasing lock for ${useremail}:`, releaseError);
46
+ }
39
47
  }
40
48
  }
41
49
  var _default = exports.default = performLoginSteps;
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.createAuthDirectoryIfNotExist = createAuthDirectoryIfNotExist;
8
+ exports.getLockDirectoryPath = getLockDirectoryPath;
9
+ var _fs = require("fs");
10
+ var _path = _interopRequireDefault(require("path"));
11
+ var _checkAuthCookies = require("./auth/checkAuthCookies");
12
+ var _readConfigFile = require("../readConfigFile");
13
+ function createAuthDirectoryIfNotExist() {
14
+ const authDirectory = (0, _checkAuthCookies.getAuthFileDirectory)();
15
+ if (!(0, _fs.existsSync)(authDirectory)) {
16
+ console.log('Creating auth directory for the first time setup...');
17
+ (0, _fs.mkdirSync)(authDirectory, {
18
+ recursive: true
19
+ });
20
+ }
21
+ }
22
+ function getLockDirectoryPath() {
23
+ const {
24
+ uatDirectory
25
+ } = (0, _readConfigFile.generateConfigFromFile)();
26
+ return _path.default.resolve(_path.default.join(uatDirectory, 'playwright', '.lock'));
27
+ }
@@ -0,0 +1,55 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.default = void 0;
8
+ var _path = _interopRequireDefault(require("path"));
9
+ var _properLockfile = _interopRequireDefault(require("proper-lockfile"));
10
+ var _fs = require("fs");
11
+ function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
12
+ function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
13
+ function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
14
+ var _getLockFilePath = /*#__PURE__*/new WeakSet();
15
+ var _createDirectoryIfNotExist = /*#__PURE__*/new WeakSet();
16
+ class FileMutex {
17
+ constructor(directory, lockFileName, options = {}) {
18
+ _classPrivateMethodInitSpec(this, _createDirectoryIfNotExist);
19
+ _classPrivateMethodInitSpec(this, _getLockFilePath);
20
+ this.directory = directory;
21
+ this.lockFileName = lockFileName + ".lock";
22
+ this.options = options;
23
+ }
24
+ async acquire() {
25
+ _classPrivateMethodGet(this, _createDirectoryIfNotExist, _createDirectoryIfNotExist2).call(this);
26
+ const lockFilePath = _path.default.resolve(this.directory, this.lockFileName);
27
+ try {
28
+ if (!(0, _fs.existsSync)(lockFilePath)) {
29
+ console.log(`[DEBUG] Creating missing lock file:`, this.lockFileName);
30
+ (0, _fs.writeFileSync)(lockFilePath, 'locked');
31
+ }
32
+ await _properLockfile.default.lock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this), this.options);
33
+ } catch (err) {
34
+ throw new Error(`Failed to acquire lock after ${this.options.retries.retries} attempts: ${err.message}`);
35
+ }
36
+ }
37
+ async release() {
38
+ try {
39
+ await _properLockfile.default.unlock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this));
40
+ } catch (err) {
41
+ throw new Error(`Failed to release lock: ${err.message}`);
42
+ }
43
+ }
44
+ }
45
+ function _getLockFilePath2() {
46
+ return _path.default.resolve(_path.default.join(this.directory, this.lockFileName));
47
+ }
48
+ function _createDirectoryIfNotExist2() {
49
+ if (!(0, _fs.existsSync)(this.directory)) {
50
+ (0, _fs.mkdirSync)(this.directory, {
51
+ recursive: true
52
+ });
53
+ }
54
+ }
55
+ var _default = exports.default = FileMutex;
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+
3
+ class Runner {
4
+ constructor(config) {
5
+ this.tagArgs = "";
6
+ this.userArgs = "";
7
+ this.config = config;
8
+ }
9
+ setUserArgs(userArgs) {
10
+ this.userArgs = userArgs;
11
+ }
12
+ setTagArgs(tagArgs) {
13
+ this.tagArgs = tagArgs;
14
+ }
15
+ setConfig(config) {
16
+ this.config = config;
17
+ }
18
+ run() {
19
+ throw new Error("Method 'run()' must be implemented.");
20
+ }
21
+ }
22
+ module.exports = Runner;
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.default = void 0;
8
+ var _RunnerTypes = _interopRequireDefault(require("./RunnerTypes"));
9
+ var _configUtils = require("../setup/config-utils");
10
+ var _cliArgsToObject = require("../../../utils/cliArgsToObject");
11
+ var _browserTypes = require("../constants/browserTypes");
12
+ var _customCommands = require("../custom-commands");
13
+ class RunnerHelper {
14
+ static createRunner(type, runnerObj) {
15
+ const runnerClass = _RunnerTypes.default.getRunnerClass(type, runnerObj);
16
+ if (!runnerClass) {
17
+ throw new Error("Invalid runner type");
18
+ }
19
+ return runnerClass;
20
+ }
21
+ static getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
22
+ const {
23
+ browsers = null
24
+ } = userArgsObject;
25
+ let browserList = (0, _configUtils.getBrowsersList)(browsers);
26
+ const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
27
+ if (debug) {
28
+ playwrightArgs.push('--debug');
29
+ }
30
+ if (!bddMode && tagArgs) {
31
+ playwrightArgs.push('--grep');
32
+ playwrightArgs.push(tagArgs);
33
+ }
34
+ if (!headless && !userArgsObject.headed) {
35
+ playwrightArgs.push('--headed');
36
+ }
37
+ if (browserList && browserList.length > 0) {
38
+ browserList.map(browser => playwrightArgs.push(`--project=${_browserTypes.BROWSER_PROJECT_MAPPING[browser.toUpperCase()]}`));
39
+ }
40
+ return playwrightArgs;
41
+ }
42
+ }
43
+ var _default = exports.default = RunnerHelper;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _SpawnRunner = _interopRequireDefault(require("./SpawnRunner"));
5
+ class RunnerTypes {
6
+ static getRunnerClass(type, runnerObj) {
7
+ const RunnerClass = this.runnerTypes[type];
8
+ if (!RunnerClass) {
9
+ throw new Error("Invalid runner type");
10
+ }
11
+ return new RunnerClass(runnerObj);
12
+ }
13
+ static runnerTypes = {
14
+ spawn: _SpawnRunner.default //require("./SpawnRunner"), // used lazy loading to reduce circular dependencies
15
+ };
16
+ }
17
+ module.exports = RunnerTypes;
@@ -0,0 +1,110 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _readConfigFile = require("../readConfigFile");
5
+ var _rootPath = require("../../../utils/rootPath");
6
+ var _path = _interopRequireDefault(require("path"));
7
+ var _logger = require("../../../utils/logger");
8
+ var _child_process = require("child_process");
9
+ var _RunnerHelper = _interopRequireDefault(require("./RunnerHelper"));
10
+ var _Runner = _interopRequireDefault(require("./Runner"));
11
+ class SpawnRunner extends _Runner.default {
12
+ constructor(runnerObj) {
13
+ super(runnerObj);
14
+ this.runnerObj = runnerObj;
15
+ }
16
+ run() {
17
+ const {
18
+ config
19
+ } = this.runnerObj;
20
+ let promises = [];
21
+ const {
22
+ bddMode
23
+ } = config.getAll();
24
+ if (bddMode) {
25
+ promises.push(this.runPreprocessing());
26
+ }
27
+ Promise.all(promises).then(() => this.runPlaywright()).catch(err => {
28
+ _logger.Logger.error(err);
29
+ process.exit();
30
+ });
31
+ }
32
+ runPreprocessing() {
33
+ const {
34
+ tagArgs
35
+ } = this.runnerObj;
36
+ const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? _path.default.resolve(__dirname, '../', 'setup', 'config-creator.js') : _path.default.resolve('../', '../', '../', '../', 'playwrightConfig.js');
37
+ const beforeCommand = 'node';
38
+ const bddGenPath = _path.default.resolve(__dirname, '../', '../', '../', 'bdd-framework', 'cli', 'index.js');
39
+ const beforeArgs = [bddGenPath, '-c', require.resolve(configPath)];
40
+ if (tagArgs) {
41
+ beforeArgs.push('--tags');
42
+ beforeArgs.push(tagArgs);
43
+ }
44
+ return new Promise((resolve, reject) => {
45
+ const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs, {
46
+ stdio: 'inherit',
47
+ env: {
48
+ ...process.env
49
+ }
50
+ });
51
+ childProcessForPreprocessing.on('error', data => {
52
+ _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
53
+ reject(data);
54
+ });
55
+ childProcessForPreprocessing.on('exit', code => {
56
+ if (code === 0) {
57
+ _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
58
+ resolve();
59
+ } else {
60
+ reject(`BddGen exited with code ${code}`);
61
+ }
62
+ });
63
+ });
64
+ }
65
+ runPlaywright() {
66
+ const {
67
+ tagArgs,
68
+ config,
69
+ userArgs
70
+ } = this.runnerObj;
71
+ const {
72
+ debug,
73
+ bddMode = false,
74
+ headless = false
75
+ } = config.getAll();
76
+ const playwrightArgs = _RunnerHelper.default.getPlaywrightArgs(userArgs, debug, bddMode, tagArgs, headless);
77
+ const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
78
+ const command = playwrightPath;
79
+ const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? _path.default.resolve(__dirname, '../', 'setup', 'config-creator.js') : _path.default.resolve('../', '../', '../', '../', 'playwrightConfig.js');
80
+ const args = ['test', '--config', require.resolve(configPath)].concat(playwrightArgs);
81
+ return new Promise((resolve, reject) => {
82
+ const childProcessForRunningPlaywright = (0, _child_process.spawn)(command, args, {
83
+ stdio: 'inherit',
84
+ env: {
85
+ ...process.env
86
+ }
87
+ });
88
+ childProcessForRunningPlaywright.on('error', error => {
89
+ _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
90
+ });
91
+ childProcessForRunningPlaywright.on('exit', (code, signal) => {
92
+ if (code !== 0) {
93
+ reject(`Child Process Exited with Code ${code} and Signal ${signal}`);
94
+ } else {
95
+ _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Test Ran Successfully');
96
+ resolve();
97
+ }
98
+ });
99
+ process.on('exit', () => {
100
+ childProcessForRunningPlaywright.kill();
101
+ reject('Terminating Playwright Process...');
102
+ });
103
+ process.on('SIGINT', () => {
104
+ childProcessForRunningPlaywright.kill();
105
+ reject('Cleaning up...');
106
+ });
107
+ });
108
+ }
109
+ }
110
+ module.exports = SpawnRunner;
@@ -20,27 +20,8 @@ var _browserTypes = require("./constants/browserTypes");
20
20
  var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
21
21
  var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
22
22
  var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
23
- function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
24
- const {
25
- browsers = null
26
- } = userArgsObject;
27
- let browserList = (0, _configUtils.getBrowsersList)(browsers);
28
- const playwrightArgs = (0, _cliArgsToObject.objectToCliArgs)(userArgsObject, key => !_customCommands.CUSTOM_COMMANDS.includes(key));
29
- if (debug) {
30
- playwrightArgs.push('--debug');
31
- }
32
- if (!bddMode && tagArgs) {
33
- playwrightArgs.push('--grep');
34
- playwrightArgs.push(tagArgs);
35
- }
36
- if (!headless && !userArgsObject.headed) {
37
- playwrightArgs.push('--headed');
38
- }
39
- if (browserList && browserList.length > 0) {
40
- browserList.map(browser => playwrightArgs.push(`--project=${_browserTypes.BROWSER_PROJECT_MAPPING[browser.toUpperCase()]}`));
41
- }
42
- return playwrightArgs;
43
- }
23
+ var _RunnerHelper = _interopRequireDefault(require("./runner/RunnerHelper"));
24
+ var _Runner = _interopRequireDefault(require("./runner/Runner"));
44
25
  function runPreprocessing(tagArgs, configPath) {
45
26
  const beforeCommand = 'node';
46
27
  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
@@ -124,18 +105,11 @@ function main() {
124
105
  const userArgsObject = userArgConfig.getAll();
125
106
  const tagProcessor = new _tagProcessor.default(editionOrder);
126
107
  const tagArgs = tagProcessor.processTags(userArgsObject);
127
- const playwrightArgs = getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless);
128
- const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
129
- const command = playwrightPath;
130
- const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
131
- const args = ['test', '--config', configPath].concat(playwrightArgs);
132
- let promises = [];
133
- if (bddMode) {
134
- promises.push(runPreprocessing(tagArgs, configPath));
135
- }
136
- Promise.all(promises).then(() => runPlaywright(command, args)).catch(err => {
137
- _logger.Logger.error(err);
138
- process.exit();
139
- });
108
+ const runnerObj = new _Runner.default();
109
+ runnerObj.setTagArgs(tagArgs);
110
+ runnerObj.setUserArgs(userArgsObject);
111
+ runnerObj.setConfig(uatConfig);
112
+ const runner = _RunnerHelper.default.createRunner('spawn', runnerObj);
113
+ runner.run();
140
114
  }
141
115
  var _default = exports.default = main;
@@ -0,0 +1,71 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _fileMutex = _interopRequireDefault(require("../../../../../core/playwright/helpers/fileMutex"));
5
+ var _properLockfile = _interopRequireDefault(require("proper-lockfile"));
6
+ var _path = _interopRequireDefault(require("path"));
7
+ var _fs = _interopRequireDefault(require("fs"));
8
+ jest.mock('proper-lockfile');
9
+ jest.mock('fs');
10
+ describe('FileMutex', () => {
11
+ const directory = '/tmp/locks';
12
+ const lockFileName = 'test-lock';
13
+ const options = {
14
+ stale: 10000,
15
+ retries: {
16
+ retries: 5,
17
+ factor: 1,
18
+ minTimeout: 5000,
19
+ maxTimeout: 8000
20
+ }
21
+ };
22
+ const lockFilePath = _path.default.resolve(directory, lockFileName + '.lock');
23
+ let fileMutex;
24
+ beforeEach(() => {
25
+ fileMutex = new _fileMutex.default(directory, lockFileName, options);
26
+ jest.clearAllMocks();
27
+ });
28
+ describe('acquire', () => {
29
+ it('should create the directory if it does not exist', async () => {
30
+ _fs.default.existsSync.mockReturnValue(false);
31
+ _fs.default.mkdirSync.mockImplementation(() => {});
32
+ _properLockfile.default.lock.mockResolvedValue();
33
+ await fileMutex.acquire();
34
+ expect(_fs.default.existsSync).toHaveBeenCalledWith(directory);
35
+ expect(_fs.default.mkdirSync).toHaveBeenCalledWith(directory, {
36
+ recursive: true
37
+ });
38
+ });
39
+ it('should create the lock file if it does not exist', async () => {
40
+ _fs.default.existsSync.mockImplementation(filePath => filePath !== lockFilePath);
41
+ _fs.default.writeFileSync.mockImplementation(() => {});
42
+ _properLockfile.default.lock.mockResolvedValue();
43
+ await fileMutex.acquire();
44
+ expect(_fs.default.existsSync).toHaveBeenCalledWith(lockFilePath);
45
+ expect(_fs.default.writeFileSync).toHaveBeenCalledWith(lockFilePath, 'locked');
46
+ });
47
+ it('should acquire the lock using proper-lockfile', async () => {
48
+ _fs.default.existsSync.mockReturnValue(true);
49
+ _properLockfile.default.lock.mockResolvedValue();
50
+ await fileMutex.acquire();
51
+ expect(_properLockfile.default.lock).toHaveBeenCalledWith(lockFilePath, options);
52
+ });
53
+ it('should throw an error if lock acquisition fails', async () => {
54
+ const errorMessage = 'Lock acquisition failed';
55
+ _properLockfile.default.lock.mockRejectedValue(new Error(errorMessage));
56
+ await expect(fileMutex.acquire()).rejects.toThrow(`Failed to acquire lock after ${options.retries.retries} attempts: ${errorMessage}`);
57
+ });
58
+ });
59
+ describe('release', () => {
60
+ it('should release the lock using proper-lockfile', async () => {
61
+ _properLockfile.default.unlock.mockResolvedValue();
62
+ await fileMutex.release();
63
+ expect(_properLockfile.default.unlock).toHaveBeenCalledWith(lockFilePath);
64
+ });
65
+ it('should throw an error if lock release fails', async () => {
66
+ const errorMessage = 'Lock release failed';
67
+ _properLockfile.default.unlock.mockRejectedValue(new Error(errorMessage));
68
+ await expect(fileMutex.release()).rejects.toThrow(`Failed to release lock: ${errorMessage}`);
69
+ });
70
+ });
71
+ });
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _RunnerHelper = _interopRequireDefault(require("../../../../../core/playwright/runner/RunnerHelper"));
5
+ var _SpawnRunner = _interopRequireDefault(require("../../../../../core/playwright/runner/SpawnRunner"));
6
+ describe('RunnerHelper', () => {
7
+ describe('createRunner', () => {
8
+ it('should throw error on invalid runner type', () => {
9
+ expect(() => _RunnerHelper.default.createRunner('invalid-type', {})).toThrow("Invalid runner type");
10
+ });
11
+ it('should create a valid runner class', () => {
12
+ const runnerInstance = _RunnerHelper.default.createRunner('spawn', {});
13
+ expect(runnerInstance).toBeInstanceOf(_SpawnRunner.default); // Directly pass the result
14
+ });
15
+ });
16
+ });
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _RunnerHelper = _interopRequireDefault(require("../../../../../core/playwright/runner/RunnerHelper"));
5
+ var _Runner = _interopRequireDefault(require("../../../../../core/playwright/runner/Runner"));
6
+ var _Configuration = _interopRequireDefault(require("../../../../../core/playwright/configuration/Configuration"));
7
+ jest.mock('child_process');
8
+ jest.mock('../../../../../utils/logger');
9
+ describe('SpawnRunner', () => {
10
+ let spawnRunner;
11
+ const runnerObj = new _Runner.default();
12
+ beforeEach(() => {
13
+ const config = new _Configuration.default({});
14
+ config.add("bddMode", true);
15
+ runnerObj.setConfig(config);
16
+ runnerObj.setTagArgs(["--headed"]);
17
+ spawnRunner = _RunnerHelper.default.createRunner('spawn', runnerObj);
18
+ });
19
+ describe('run', () => {
20
+ it('should call runPreprocessing when bddMode is true', () => {
21
+ const runPreprocessingSpy = jest.spyOn(spawnRunner, 'runPreprocessing').mockResolvedValue();
22
+ const runPlaywrightSpy = jest.spyOn(spawnRunner, 'runPlaywright').mockResolvedValue();
23
+ spawnRunner.run();
24
+ expect(runPreprocessingSpy).toHaveBeenCalled();
25
+ });
26
+ });
27
+ });
@@ -1,5 +1,2 @@
1
1
  const editions = require('./editions/index');
2
- const beta = require('./beta/index');
3
-
4
-
5
- module.exports = { editions, beta }
2
+ module.exports = { editions }
@@ -2,5 +2,5 @@
2
2
  "environment": "ci",
3
3
  "edition": "enterprise",
4
4
  "profile": "admin",
5
- "domain": "https://zdesk-devops08.csez.zohocorpin.com:31007/agent"
5
+ "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent"
6
6
  }
@@ -12,16 +12,24 @@ function getPrimaryCookiePath() {
12
12
  * @typedef {import('@zohodesk/testinglibrary').UserConfig} UserConfig
13
13
  */
14
14
  module.exports = {
15
- headless: true,
15
+ headless: false,
16
+ retries:1,
16
17
  openReportOn: 'never',
17
18
  browsers: ['Chrome'],
18
- isAuthMode: false,
19
+ isAuthMode: true,
19
20
  authFilePath: getPrimaryCookiePath(),
20
- trace: true,
21
- video: true,
21
+ trace: 'retain-on-failure',
22
+ video: 'retain-on-failure',
23
+ retries:1,
22
24
  bddMode: false,
25
+ expectTimeout: 10 * 1000,
26
+ testTimeout: 60 * 1000,
27
+ globalTimeout: 2 * 60 * 60 * 1000,
28
+ featureFilesFolder: 'feature-files',
29
+ stepDefinitionsFolder: 'steps',
23
30
  viewport: { width: 1280, height: 720 },
24
31
  testIdAttribute: 'data-id',
32
+ editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
25
33
  additionalPages: {
26
34
  ...customFixtures
27
35
  }
@@ -1,18 +1,18 @@
1
1
  {
2
2
  "dev": {
3
- "domain": "https://desk.localzoho.com/agent",
3
+ "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
4
4
  "orgName": "org-name",
5
5
  "deptName": "dept-name",
6
6
  "moduleName": "module-name"
7
7
  },
8
8
  "prod": {
9
- "domain": "https://desk.localzoho.com/agent/",
9
+ "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
10
10
  "orgName": "sangeetha.t@zohocorp.com",
11
11
  "deptName": "sangeethat",
12
12
  "moduleName": "sangeethat"
13
13
  },
14
14
  "ci": {
15
- "domain": "https://zdesk-devops08.csez.zohocorpin.com:31007/agent/",
15
+ "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
16
16
  "orgName": "clientcicdk8",
17
17
  "deptName": "clientcicdk8",
18
18
  "moduleName": "tickets"
@@ -21,7 +21,8 @@ if (!isDevelopmentSetup()) {
21
21
  const authFilePath = path.join(authDirectory, file);
22
22
  await loadCookiesIfPresent(page, authFilePath);
23
23
  const domainOrigin = getUrlOrigin(process.env.domain);
24
- await page.goto(`${domainOrigin}/support/logout.sas `);
24
+ const logoutURL = `${domainOrigin}/support/logout.sas`;
25
+ await page.goto(logoutURL);
25
26
  await page.waitForNavigation();
26
27
  await expect(page.locator('[id="signin_flow"]')).toBeVisible();
27
28
  await fs.rmSync(authFilePath);
@@ -4,11 +4,11 @@ test.describe("Verify no authentication required @nobdd", () => {
4
4
 
5
5
  test("Verify the page is not logged in", async ({ page }) => {
6
6
 
7
- await page.goto('https://desk.localzoho.com/');
7
+ await page.goto(process.env.domain);
8
8
 
9
- await page.waitForSelector('.zgh-accounts');
9
+ await page.waitForSelector('#login');
10
10
 
11
- const isLoggedIn = await page.isVisible('.zgh-accounts');
11
+ const isLoggedIn = await page.isVisible('#login');
12
12
  expect(isLoggedIn).toBe(true);
13
13
 
14
14
  });
@@ -13,18 +13,25 @@ function getPrimaryCookiePath() {
13
13
  */
14
14
  module.exports = {
15
15
  headless: false,
16
+ retries:1,
16
17
  openReportOn: 'never',
17
18
  browsers: ['Chrome'],
18
19
  isAuthMode: true,
19
20
  authFilePath: getPrimaryCookiePath(),
20
- trace: true,
21
- video: true,
22
- bddMode: true,
21
+ trace: 'retain-on-failure',
22
+ video: 'retain-on-failure',
23
+ retries:1,
24
+ bddMode: false,
25
+ expectTimeout: 10 * 1000,
26
+ testTimeout: 60 * 1000,
27
+ globalTimeout: 2 * 60 * 60 * 1000,
23
28
  featureFilesFolder: 'feature-files',
24
29
  stepDefinitionsFolder: 'steps',
25
30
  viewport: { width: 1280, height: 720 },
26
31
  testIdAttribute: 'data-id',
32
+ editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
27
33
  additionalPages: {
28
34
  ...customFixtures
29
- }
35
+ },
36
+ url:""
30
37
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zohodesk/testinglibrary",
3
- "version": "2.9.1",
3
+ "version": "2.9.3",
4
4
  "description": "",
5
5
  "main": "./build/index.js",
6
6
  "scripts": {
@@ -34,6 +34,7 @@
34
34
  "jest-environment-jsdom": "29.6.2",
35
35
  "msw": "1.2.3",
36
36
  "playwright": "1.42.1",
37
+ "proper-lockfile": "4.1.2",
37
38
  "supports-color": "8.1.1"
38
39
  },
39
40
  "bin": {
@@ -1,24 +0,0 @@
1
- [
2
- {
3
- "id": "1",
4
- "edition": "enterprise",
5
- "orgName": "custommoduleportal",
6
- "profiles": [
7
- {
8
- "profile": "admin",
9
- "email": "indragith.m+agent@zohotest.com",
10
- "password": "Paara!2019"
11
- },
12
- {
13
- "profile": "agent",
14
- "email": "indragith.m+agent@zohotest.com",
15
- "password": "Paara!2019"
16
- },
17
- {
18
- "profile": "lightagent",
19
- "email": "indragith.m+abc1@zohotest.com",
20
- "password": "Paara!2019"
21
- }
22
- ]
23
- }
24
- ]
@@ -1,6 +0,0 @@
1
- const parentchild = require('./parent-child.json');
2
- const custommodule = require('./custom-module.json');
3
-
4
- const beta = { parentchild, custommodule };
5
-
6
- module.exports = beta;
@@ -1,24 +0,0 @@
1
- [
2
- {
3
- "id": "1",
4
- "edition": "enterprise",
5
- "orgName": "parentchildportal",
6
- "profiles": [
7
- {
8
- "profile": "admin",
9
- "email": "indragith.m@zohocorp.com",
10
- "password": "Paara!2019"
11
- },
12
- {
13
- "profile": "agent",
14
- "email": "indragith.m+agent@zohotest.com",
15
- "password": "Paara!2019"
16
- },
17
- {
18
- "profile": "lightagent",
19
- "email": "indragith.m+abc1@zohotest.com",
20
- "password": "Paara!2019"
21
- }
22
- ]
23
- }
24
- ]