@zohodesk/testinglibrary 0.4.7-experimental → 0.4.9-experimental

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 (139) hide show
  1. package/.gitlab-ci.yml +16 -23
  2. package/README.md +9 -25
  3. package/build/bdd-framework/cli/commands/env.js +42 -0
  4. package/build/bdd-framework/cli/commands/export.js +62 -0
  5. package/build/bdd-framework/cli/commands/test.js +64 -0
  6. package/build/bdd-framework/cli/index.js +11 -0
  7. package/build/bdd-framework/cli/options.js +19 -0
  8. package/build/bdd-framework/cli/worker.js +13 -0
  9. package/build/bdd-framework/config/configDir.js +35 -0
  10. package/build/bdd-framework/config/enrichReporterData.js +23 -0
  11. package/build/bdd-framework/config/env.js +50 -0
  12. package/build/bdd-framework/config/index.js +94 -0
  13. package/build/bdd-framework/config/lang.js +14 -0
  14. package/build/bdd-framework/cucumber/buildStepDefinition.js +43 -0
  15. package/build/bdd-framework/cucumber/createTestStep.js +43 -0
  16. package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +126 -0
  17. package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +72 -0
  18. package/build/bdd-framework/cucumber/formatter/PickleParser.js +25 -0
  19. package/build/bdd-framework/cucumber/formatter/durationHelpers.js +13 -0
  20. package/build/bdd-framework/cucumber/formatter/getColorFns.js +57 -0
  21. package/build/bdd-framework/cucumber/formatter/index.js +16 -0
  22. package/build/bdd-framework/cucumber/formatter/locationHelpers.js +16 -0
  23. package/build/bdd-framework/cucumber/loadConfig.js +17 -0
  24. package/build/bdd-framework/cucumber/loadFeatures.js +70 -0
  25. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +20 -0
  26. package/build/bdd-framework/cucumber/loadSteps.js +47 -0
  27. package/build/bdd-framework/cucumber/resolveFeaturePaths.js +62 -0
  28. package/build/bdd-framework/cucumber/stepArguments.js +21 -0
  29. package/build/bdd-framework/cucumber/types.js +5 -0
  30. package/build/bdd-framework/cucumber/valueChecker.js +23 -0
  31. package/build/bdd-framework/decorators.js +18 -0
  32. package/build/bdd-framework/gen/fixtures.js +48 -0
  33. package/build/bdd-framework/gen/formatter.js +167 -0
  34. package/build/bdd-framework/gen/i18n.js +39 -0
  35. package/build/bdd-framework/gen/index.js +197 -0
  36. package/build/bdd-framework/gen/specialTags.js +70 -0
  37. package/build/bdd-framework/gen/testFile.js +470 -0
  38. package/build/bdd-framework/gen/testMeta.js +60 -0
  39. package/build/bdd-framework/gen/testNode.js +35 -0
  40. package/build/bdd-framework/gen/testPoms.js +133 -0
  41. package/build/bdd-framework/hooks/scenario.js +130 -0
  42. package/build/bdd-framework/hooks/worker.js +89 -0
  43. package/build/bdd-framework/index.js +52 -0
  44. package/build/bdd-framework/playwright/fixtureParameterNames.js +93 -0
  45. package/build/bdd-framework/playwright/getLocationInFile.js +79 -0
  46. package/build/bdd-framework/playwright/loadConfig.js +42 -0
  47. package/build/bdd-framework/playwright/loadUtils.js +33 -0
  48. package/build/bdd-framework/playwright/testTypeImpl.js +79 -0
  49. package/build/bdd-framework/playwright/transform.js +88 -0
  50. package/build/bdd-framework/playwright/types.js +12 -0
  51. package/build/bdd-framework/playwright/utils.js +56 -0
  52. package/build/bdd-framework/reporter/cucumber/base.js +52 -0
  53. package/build/bdd-framework/reporter/cucumber/custom.js +73 -0
  54. package/build/bdd-framework/reporter/cucumber/helper.js +12 -0
  55. package/build/bdd-framework/reporter/cucumber/html.js +40 -0
  56. package/build/bdd-framework/reporter/cucumber/index.js +74 -0
  57. package/build/bdd-framework/reporter/cucumber/json.js +312 -0
  58. package/build/bdd-framework/reporter/cucumber/junit.js +205 -0
  59. package/build/bdd-framework/reporter/cucumber/message.js +20 -0
  60. package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +82 -0
  61. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +197 -0
  62. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +43 -0
  63. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +52 -0
  64. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +105 -0
  65. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +70 -0
  66. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +45 -0
  67. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +27 -0
  68. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +38 -0
  69. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +128 -0
  70. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +154 -0
  71. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +123 -0
  72. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +67 -0
  73. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +114 -0
  74. package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +30 -0
  75. package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwStepUtils.js +70 -0
  76. package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +35 -0
  77. package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +5 -0
  78. package/build/bdd-framework/run/StepInvoker.js +69 -0
  79. package/build/bdd-framework/run/bddData/index.js +59 -0
  80. package/build/bdd-framework/run/bddData/types.js +5 -0
  81. package/build/bdd-framework/run/bddFixtures.js +192 -0
  82. package/build/bdd-framework/run/bddWorld.js +79 -0
  83. package/build/bdd-framework/run/bddWorldInternal.js +11 -0
  84. package/build/bdd-framework/snippets/index.js +132 -0
  85. package/build/bdd-framework/snippets/snippetSyntax.js +43 -0
  86. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +26 -0
  87. package/build/bdd-framework/snippets/snippetSyntaxTs.js +18 -0
  88. package/build/bdd-framework/stepDefinitions/createBdd.js +66 -0
  89. package/build/bdd-framework/stepDefinitions/decorators/class.js +68 -0
  90. package/build/bdd-framework/stepDefinitions/decorators/steps.js +99 -0
  91. package/build/bdd-framework/stepDefinitions/defineStep.js +62 -0
  92. package/build/bdd-framework/stepDefinitions/stepConfig.js +24 -0
  93. package/build/bdd-framework/steps/createBdd.js +78 -0
  94. package/build/bdd-framework/steps/decorators/class.js +68 -0
  95. package/build/bdd-framework/steps/decorators/steps.js +98 -0
  96. package/build/bdd-framework/steps/defineStep.js +62 -0
  97. package/build/bdd-framework/steps/stepConfig.js +24 -0
  98. package/build/bdd-framework/utils/AutofillMap.js +20 -0
  99. package/build/bdd-framework/utils/exit.js +62 -0
  100. package/build/bdd-framework/utils/index.js +93 -0
  101. package/build/bdd-framework/utils/jsStringWrap.js +44 -0
  102. package/build/bdd-framework/utils/logger.js +30 -0
  103. package/build/bdd-framework/utils/stripAnsiEscapes.js +20 -0
  104. package/build/core/playwright/constants/fileMutexConfig.js +11 -0
  105. package/build/core/playwright/helpers/auth/checkAuthCookies.js +2 -8
  106. package/build/core/playwright/helpers/auth/getUsers.js +12 -25
  107. package/build/core/playwright/helpers/auth/loginSteps.js +28 -18
  108. package/build/core/playwright/helpers/checkAuthDirectory.js +17 -0
  109. package/build/core/playwright/helpers/fileMutex.js +58 -0
  110. package/build/core/playwright/index.js +23 -10
  111. package/build/core/playwright/setup/config-creator.js +3 -3
  112. package/build/core/playwright/setup/config-utils.js +25 -8
  113. package/build/core/playwright/test-runner.js +1 -1
  114. package/build/decorators.d.ts +1 -1
  115. package/build/decorators.js +1 -1
  116. package/build/setup-folder-structure/samples/auth-setup-sample.js +66 -14
  117. package/build/setup-folder-structure/samples/authUsers-sample.json +9 -0
  118. package/build/setup-folder-structure/samples/env-config-sample.json +21 -0
  119. package/build/setup-folder-structure/setupProject.js +5 -18
  120. package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js +94 -0
  121. package/build/test/core/playwright/helpers/__tests__/getUsers_ListOfActors.test.js +80 -0
  122. package/nobdd/src/App.js +7 -0
  123. package/nobdd/uat/conf/default/actors/index.js +1 -4
  124. package/nobdd/uat/conf/default/settings.json +1 -1
  125. package/nobdd/uat/conf/nobdd/uat.config.js +12 -4
  126. package/nobdd/uat/env-config.json +3 -3
  127. package/nobdd/uat/fixtures/setup.teardown.js +2 -1
  128. package/nobdd/uat/modules/nobdd/steps/VerifyNoBDD.feature.spec.js +3 -3
  129. package/nobdd/uat.config.js +9 -3
  130. package/npm-shrinkwrap.json +2175 -5825
  131. package/package.json +8 -7
  132. package/build/core/playwright/fixtures.js +0 -24
  133. package/build/setup-folder-structure/samples/actors-index.js +0 -3
  134. package/build/setup-folder-structure/samples/editions-index.js +0 -3
  135. package/build/setup-folder-structure/samples/free-sample.json +0 -25
  136. package/build/setup-folder-structure/samples/settings.json +0 -7
  137. package/nobdd/uat/conf/default/actors/beta/custom-module.json +0 -24
  138. package/nobdd/uat/conf/default/actors/beta/index.js +0 -6
  139. package/nobdd/uat/conf/default/actors/beta/parent-child.json +0 -24
@@ -52,14 +52,22 @@ function getDefaultActor() {
52
52
  } = getDefaultActorConf();
53
53
  return getUserForSelectedEditionAndProfile(edition, profile);
54
54
  }
55
- function getListOfActors() {
55
+ function getListOfActors(betaFeature) {
56
56
  const {
57
57
  uatDirectory
58
58
  } = (0, _readConfigFile.generateConfigFromFile)();
59
59
  const mode = getRunMode();
60
60
  let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
61
+ let betaReference = mode;
61
62
  if (!(0, _fs.existsSync)(configFile)) {
62
63
  configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
64
+ betaReference = "default";
65
+ }
66
+ if (betaFeature) {
67
+ configFile = _path.default.join(uatDirectory, `conf/${betaReference}/actors/beta/${betaFeature}/index.js`);
68
+ if (!(0, _fs.existsSync)(configFile)) {
69
+ throw new Error(`There is no beta feature configured with the name "${betaFeature}"`);
70
+ }
63
71
  }
64
72
  try {
65
73
  return require(configFile);
@@ -68,42 +76,21 @@ function getListOfActors() {
68
76
  }
69
77
  }
70
78
  function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
71
- const actorsData = getListOfActors();
79
+ const actorsData = getListOfActors(betaFeature);
72
80
  if (!actorsData || !actorsData.editions) {
73
81
  throw new Error("The actors data is missing.");
74
82
  }
75
83
  const {
76
- editions: userdata,
77
- beta: betaPortals
84
+ editions: userdata
78
85
  } = actorsData;
79
86
  const defaultConf = getDefaultActorConf();
80
87
  const edition = preferedEdition || defaultConf.edition;
81
88
  const profile = preferredProfile || defaultConf.profile;
82
89
  let selectedProfile = {};
83
- if (betaFeature && betaFeature !== null) {
84
- if (!betaPortals.hasOwnProperty(betaFeature)) {
85
- throw new Error(`There is no "${betaFeature}" beta feature configured.`);
86
- }
87
- const betaEdition = betaPortals[betaFeature].find(portal => portal.edition === edition);
88
- if (!betaEdition) {
89
- throw new Error(`There is no "${edition}" edition configured in "${betaFeature}" beta feature.`);
90
- }
91
- const {
92
- profiles: betaProfiles,
93
- ...betaEditionData
94
- } = betaEdition;
95
- selectedProfile = betaProfiles.find(user => user.profile === profile);
96
- if (!selectedProfile) {
97
- throw new Error(`There is no "${profile}" configured in edition of "${edition}" in "${betaFeature}" beta features.`);
98
- }
99
- return {
100
- ...betaEditionData,
101
- ...selectedProfile
102
- };
103
- }
104
90
 
105
91
  // TODO: We are returning the first data from array. We need to check the possiblity of having multiple users for same profile and possibly round robin
106
92
  // For this we need to get the data from ci environment.
93
+
107
94
  let testingPortal = null;
108
95
  if (!userdata.hasOwnProperty(edition)) {
109
96
  throw new Error(`There is no "${edition}" edition configured.`);
@@ -6,6 +6,8 @@ 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");
11
13
  /* eslint-disable no-console */
@@ -17,25 +19,33 @@ async function performLoginSteps({
17
19
  password
18
20
  }, isLoggedIn) {
19
21
  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);
22
+ const lockFileName = useremail.replace(/[@.]/g, '_');
23
+ const fileMutex = new _fileMutex.default((0, _checkAuthCookies.getAuthFileDirectory)(), lockFileName, _fileMutexConfig.LOGIN_MUTEX_TIMEOUT);
24
+ try {
25
+ const cookiesExist = await (0, _checkAuthCookies.loadCookiesIfPresent)(page, authFile);
31
26
  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
- });
27
+ await Promise.race([page.waitForNavigation(), page.waitForLoadState('networkidle'), page.waitForTimeout(5000)]);
28
+ const isAlreadyLoggedIn = await isLoggedIn(page);
29
+ if (cookiesExist && isAlreadyLoggedIn) {
30
+ console.log('Account is already logged in. Skipping lock.');
31
+ } else {
32
+ await fileMutex.acquire();
33
+ try {
34
+ if (!isAlreadyLoggedIn) {
35
+ await (0, _accountLogin.default)(page, useremail, password);
36
+ await page.goto(process.env.domain);
37
+ await isLoggedIn(page);
38
+ await page.context().storageState({
39
+ path: authFile
40
+ });
41
+ }
42
+ } finally {
43
+ await fileMutex.release();
44
+ }
45
+ }
46
+ } catch (error) {
47
+ console.error('Error during login:', error);
48
+ await fileMutex.release();
39
49
  }
40
50
  }
41
51
  var _default = exports.default = performLoginSteps;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.createAuthDirectoryIfNotExist = createAuthDirectoryIfNotExist;
7
+ var _fs = require("fs");
8
+ var _checkAuthCookies = require("./auth/checkAuthCookies");
9
+ function createAuthDirectoryIfNotExist() {
10
+ const authDirectory = (0, _checkAuthCookies.getAuthFileDirectory)();
11
+ if (!(0, _fs.existsSync)(authDirectory)) {
12
+ console.log('Creating auth directory for the first time setup...');
13
+ (0, _fs.mkdirSync)(authDirectory, {
14
+ recursive: true
15
+ });
16
+ }
17
+ }
@@ -0,0 +1,58 @@
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 _lockfile = _interopRequireDefault(require("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, timeout) {
18
+ _classPrivateMethodInitSpec(this, _createDirectoryIfNotExist);
19
+ _classPrivateMethodInitSpec(this, _getLockFilePath);
20
+ this.directory = directory;
21
+ this.lockFileName = lockFileName;
22
+ this.timeout = timeout;
23
+ }
24
+ async acquire() {
25
+ _classPrivateMethodGet(this, _createDirectoryIfNotExist, _createDirectoryIfNotExist2).call(this);
26
+ return new Promise((resolve, reject) => {
27
+ _lockfile.default.lock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this), this.timeout, err => {
28
+ if (err) {
29
+ reject(err);
30
+ } else {
31
+ resolve();
32
+ }
33
+ });
34
+ });
35
+ }
36
+ async release() {
37
+ return new Promise((resolve, reject) => {
38
+ _lockfile.default.unlock(_classPrivateMethodGet(this, _getLockFilePath, _getLockFilePath2).call(this), err => {
39
+ if (err) {
40
+ reject(err);
41
+ } else {
42
+ resolve();
43
+ }
44
+ });
45
+ });
46
+ }
47
+ }
48
+ function _getLockFilePath2() {
49
+ return _path.default.resolve(_path.default.join(this.directory, `/${this.lockFileName}.lock`));
50
+ }
51
+ function _createDirectoryIfNotExist2() {
52
+ if (!(0, _fs.existsSync)(this.directory)) {
53
+ (0, _fs.mkdirSync)(this.directory, {
54
+ recursive: true
55
+ });
56
+ }
57
+ }
58
+ var _default = exports.default = FileMutex;
@@ -1,24 +1,37 @@
1
1
  "use strict";
2
2
 
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
3
4
  Object.defineProperty(exports, "__esModule", {
4
5
  value: true
5
6
  });
6
- exports.createBdd = void 0;
7
- Object.defineProperty(exports, "expect", {
7
+ Object.defineProperty(exports, "createBdd", {
8
8
  enumerable: true,
9
9
  get: function () {
10
- return _test.expect;
10
+ return _bddFramework.createBdd;
11
11
  }
12
12
  });
13
- Object.defineProperty(exports, "test", {
13
+ Object.defineProperty(exports, "expect", {
14
14
  enumerable: true,
15
15
  get: function () {
16
- return _playwrightBdd.test;
16
+ return _test.expect;
17
17
  }
18
18
  });
19
- var _playwrightBdd = require("playwright-bdd");
19
+ exports.test = void 0;
20
+ var _bddFramework = require("../../bdd-framework");
20
21
  var _test = require("@playwright/test");
21
- let createBdd = function () {
22
- return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
23
- };
24
- exports.createBdd = createBdd;
22
+ var _readConfigFile = require("./readConfigFile");
23
+ var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
24
+ var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
25
+ const {
26
+ bddMode
27
+ } = (0, _readConfigFile.generateConfigFromFile)();
28
+ let base = bddMode ? _bddFramework.test : _test.test;
29
+ const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
30
+ const buildInFixturesTest = base.extend({
31
+ ...buildInFixtures
32
+ });
33
+ const userFixtures = (0, _getUserFixtures.default)();
34
+ const userFixturesTest = base.extend({
35
+ ...userFixtures
36
+ });
37
+ const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
@@ -39,12 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
39
39
  featureFilesFolder,
40
40
  stepDefinitionsFolder
41
41
  });
42
- const use = {
42
+ const testOptions = (0, _configUtils.getTestUseOptions)({
43
43
  trace,
44
44
  video,
45
45
  viewport,
46
46
  testIdAttribute
47
- };
47
+ });
48
48
 
49
49
  /**
50
50
  * Playwright configuration object
@@ -65,7 +65,7 @@ function getPlaywrightConfig() {
65
65
  expect: {
66
66
  timeout: expectTimeout
67
67
  },
68
- use,
68
+ use: testOptions,
69
69
  projects: isAuthMode ? [{
70
70
  name: 'setup',
71
71
  testMatch: /.*\.setup\.js/,
@@ -7,12 +7,14 @@ Object.defineProperty(exports, "__esModule", {
7
7
  exports.getBrowsersList = getBrowsersList;
8
8
  exports.getProjects = getProjects;
9
9
  exports.getTestDir = getTestDir;
10
+ exports.getTestUseOptions = getTestUseOptions;
10
11
  var _test = require("@playwright/test");
11
12
  var _path = _interopRequireDefault(require("path"));
12
13
  var _readConfigFile = require("../readConfigFile");
13
- var _playwrightBdd = require("playwright-bdd");
14
+ var _bddFramework = require("../../../bdd-framework");
14
15
  var _logger = require("../../../utils/logger");
15
16
  var _browserTypes = require("../constants/browserTypes");
17
+ var _configFileNameProvider = require("../helpers/configFileNameProvider");
16
18
  var _fileUtils = require("../../../utils/fileUtils");
17
19
  /**
18
20
  ** Playwright project configuration
@@ -146,15 +148,30 @@ function getPathsForFeatureFiles(cwd) {
146
148
  function getTestDir(bddMode, cwd, {
147
149
  stepDefinitionsFolder
148
150
  }) {
149
- return bddMode ? (0, _playwrightBdd.defineBddConfig)({
150
- features: getPathsForFeatureFiles(cwd),
151
- steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
152
- importTestFrom: require.resolve('../fixtures.js'),
151
+ return bddMode ? (0, _bddFramework.defineBddConfig)({
152
+ paths: getPathsForFeatureFiles(cwd),
153
+ import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
153
154
  featuresRoot: _path.default.join(cwd, 'uat'),
154
155
  outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
155
- disableWarnings: {
156
- importTestFrom: true
157
- },
158
156
  publish: true
159
157
  }) : _path.default.join(cwd, 'uat');
158
+ }
159
+ function getTestUseOptions({
160
+ viewport,
161
+ trace,
162
+ video,
163
+ testIdAttribute
164
+ }) {
165
+ let defaultTestuseOptions = {
166
+ viewport,
167
+ testIdAttribute,
168
+ trace: trace ? 'on' : 'off',
169
+ video: video ? {
170
+ mode: 'on',
171
+ size: {
172
+ ...viewport
173
+ }
174
+ } : 'off'
175
+ };
176
+ return defaultTestuseOptions;
160
177
  }
@@ -43,7 +43,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
43
43
  }
44
44
  function runPreprocessing(tagArgs, configPath) {
45
45
  const beforeCommand = 'node';
46
- const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
46
+ const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
47
47
  const beforeArgs = [bddGenPath, '-c', configPath];
48
48
  if (tagArgs) {
49
49
  beforeArgs.push('--tags');
@@ -1 +1 @@
1
- export * from 'playwright-bdd/decorators';
1
+ export * from './bdd-framework/decorators';
@@ -3,7 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- var _decorators = require("playwright-bdd/decorators");
6
+ var _decorators = require("./bdd-framework/decorators");
7
7
  Object.keys(_decorators).forEach(function (key) {
8
8
  if (key === "default" || key === "__esModule") return;
9
9
  if (key in exports && exports[key] === _decorators[key]) return;
@@ -1,21 +1,73 @@
1
1
  /* eslint-disable no-console */
2
2
  import { test as setup, expect } from '@zohodesk/testinglibrary';
3
- import {
4
- performLoginSteps,
5
- getDefaultActor
6
- } from '@zohodesk/testinglibrary/helpers';
3
+ import path from 'path';
4
+ import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
5
+ import { getAuthFileDirectory } from '../../core/playwright';
6
+ import { Logger } from '../../utils/logger';
7
7
 
8
- const user = getDefaultActor();
8
+ const userdata = require('./authUsers.json');
9
9
 
10
- async function verifyPageIsLoaded(page) {
11
- //Implement your validation steps here
12
- //Refer desk_client_app auth.setup.js
13
- return true;
10
+ const authContent = { cookies: [] };
11
+
12
+ const LOGIN_ERR_MESSAGE = 'Need go be logged in';
13
+ // const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
14
+
15
+ function convertCookiesToParse(cookies, authFilePath) {
16
+ try {
17
+ return JSON.parse(cookies);
18
+ } catch (err) {
19
+ Logger.error(err);
20
+ throw new Error(
21
+ ` Error while parsing cookies ${err} \n${path.resolve(
22
+ process.cwd(),
23
+ authFilePath
24
+ )} File is Empty`
25
+ );
26
+ // process.exit()
27
+ }
28
+ }
29
+ const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
30
+ if (!existsSync(authDirectory)) {
31
+ console.log('Creating auth directory for the first time setup...');
32
+ mkdirSync(authDirectory, { recursive: true });
14
33
  }
15
34
 
16
- setup(`${user.edition} - Authentication`, async ({ page }) => {
35
+ userdata.forEach(data => {
36
+ const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
37
+ if (!existsSync(authFile)) {
38
+ console.log('creating auth file..');
39
+ writeFileSync(authFile, JSON.stringify(authContent, null, 2));
40
+ }
41
+ setup(data.description, async ({ page }) => {
42
+ try {
43
+ const cookies = readFileSync(authFile);
44
+ const parsedCookies = convertCookiesToParse(cookies, authFile);
45
+ await page
46
+ .context()
47
+ .addCookies(
48
+ parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
49
+ );
50
+ await page.goto(page.getBaseUrl());
51
+ await page.waitForLoadState();
52
+ if (await page.url().includes(process.env.domain)) {
53
+ await page.waitForSelector(data.locator);
54
+ } else {
55
+ throw new Error(LOGIN_ERR_MESSAGE);
56
+ }
57
+ } catch (err) {
58
+ if (err.message === LOGIN_ERR_MESSAGE) {
59
+ await expect(page.locator('.load-bg')).toBeHidden();
60
+ await page.locator('#login_id').type(data.useremail);
61
+ await page.locator('#nextbtn').click();
62
+ await page.locator('#password').type(data.password);
63
+ await page.locator('#nextbtn').click();
64
+
65
+ await page.waitForLoadState('networkidle');
66
+
67
+ await page.waitForSelector(data.locator);
17
68
 
18
- //Implement performLoginSteps here
19
- const { email, password } = user;
20
- await performLoginSteps({ },verifyPageIsLoaded );
21
- });
69
+ await page.context().storageState({ path: authFile });
70
+ }
71
+ }
72
+ });
73
+ });
@@ -0,0 +1,9 @@
1
+ [
2
+ {
3
+ "useremail": "/ user name /",
4
+ "password": "/ password /",
5
+ "description": "/ description/",
6
+ "filename": "user.json",
7
+ "locator": "/ selector to identify page has been loaded completely /"
8
+ }
9
+ ]
@@ -0,0 +1,21 @@
1
+ {
2
+ "dev": {
3
+ "domain": "https://desk.localzoho.com/agent",
4
+ "orgName": "org-name",
5
+ "deptName": "dept-name",
6
+ "moduleName": "module-name",
7
+ "devURL": "Provide your devURL here"
8
+ },
9
+ "prod": {
10
+ "domain": "https://desk.localzoho.com/agent",
11
+ "orgName": "org-name",
12
+ "deptName": "dept-name",
13
+ "moduleName": "module-name"
14
+ },
15
+ "k8test": {
16
+ "domain": "https://desk.localzoho.com/agent",
17
+ "orgName": "org-name",
18
+ "deptName": "dept-name",
19
+ "moduleName": "module-name"
20
+ }
21
+ }
@@ -10,9 +10,8 @@ var _path = _interopRequireDefault(require("path"));
10
10
  var _logger = require("../utils/logger");
11
11
  function getScriptsToBeAdded() {
12
12
  return {
13
- "uat": "ZDTestingFramework test --mode=dev --headed",
14
- "uat-debug": "ZDTestingFramework test --mode=dev --debug",
15
- "uat-validate": "ZDTestingFramework validate",
13
+ "uat": "ZDTestingFramework test --mode=prod --headed",
14
+ "uat-debug": "ZDTestingFramework test --mode=prod --debug",
16
15
  "uat-report": "ZDTestingFramework report --port=9009",
17
16
  "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
18
17
  };
@@ -72,6 +71,7 @@ function createAuthenticationFile() {
72
71
  });
73
72
  }
74
73
  (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
74
+ (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
75
75
  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
76
76
  } catch (err) {
77
77
  _logger.Logger.error(err);
@@ -84,21 +84,8 @@ function createAuthenticationFile() {
84
84
  function createConfigJson() {
85
85
  const uatFolder = _path.default.resolve(process.cwd(), 'uat');
86
86
  if ((0, _fs.existsSync)(uatFolder)) {
87
- _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
88
- if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
89
- (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
90
- recursive: true
91
- });
92
- }
93
- (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
94
- if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
95
- (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
96
- recursive: true
97
- });
98
- }
99
- (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
100
- (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
101
- (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
87
+ _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
88
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2);
102
89
  } else {
103
90
  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
104
91
  }
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _fileMutex = _interopRequireDefault(require("../../../../../core/playwright/helpers/fileMutex"));
5
+ var _lockfile = _interopRequireDefault(require("lockfile"));
6
+ var _path = _interopRequireDefault(require("path"));
7
+ var _fs = _interopRequireDefault(require("fs"));
8
+ jest.mock('lockfile');
9
+ jest.mock('fs');
10
+ describe('FileMutex', () => {
11
+ const mockDirectory = '/tmp';
12
+ const mockFileName = 'test_user';
13
+ const mockTimeout = {
14
+ wait: 5000,
15
+ retries: 5,
16
+ stale: 60000
17
+ };
18
+ let fileMutex;
19
+ beforeEach(() => {
20
+ fileMutex = new _fileMutex.default(mockDirectory, mockFileName, mockTimeout);
21
+ });
22
+ afterEach(() => {
23
+ jest.clearAllMocks();
24
+ });
25
+ describe('acquire', () => {
26
+ it('should resolve when lockfile.lock succeeds and call getLockFilePath correctly', async () => {
27
+ const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
28
+ _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
29
+ expect(lockPath).toBe(expectedPath);
30
+ expect(options).toEqual(mockTimeout);
31
+ callback(null);
32
+ });
33
+ await expect(fileMutex.acquire()).resolves.toBeUndefined();
34
+ expect(_lockfile.default.lock).toHaveBeenCalledWith(expectedPath, mockTimeout, expect.any(Function));
35
+ });
36
+ it('should reject when lockfile.lock fails', async () => {
37
+ const mockError = new Error('Lock failed');
38
+ _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
39
+ expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
40
+ expect(options).toEqual(mockTimeout);
41
+ callback(mockError);
42
+ });
43
+ await expect(fileMutex.acquire()).rejects.toThrow('Lock failed');
44
+ expect(_lockfile.default.lock).toHaveBeenCalled();
45
+ });
46
+ it('should create the directory if it does not exist and acquire the lock', async () => {
47
+ _fs.default.existsSync.mockReturnValue(false);
48
+ _fs.default.mkdirSync.mockImplementation((dir, options) => {
49
+ expect(dir).toBe(mockDirectory);
50
+ expect(options).toEqual({
51
+ recursive: true
52
+ });
53
+ });
54
+ _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
55
+ expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
56
+ expect(options).toEqual(mockTimeout);
57
+ callback(null);
58
+ });
59
+ await expect(fileMutex.acquire()).resolves.toBeUndefined();
60
+ expect(_fs.default.existsSync).toHaveBeenCalledWith(mockDirectory);
61
+ expect(_fs.default.mkdirSync).toHaveBeenCalledWith(mockDirectory, {
62
+ recursive: true
63
+ });
64
+ expect(_lockfile.default.lock).toHaveBeenCalled();
65
+ });
66
+ it('should not create the directory if it already exists', async () => {
67
+ _fs.default.existsSync.mockReturnValue(true);
68
+ _lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
69
+ callback(null);
70
+ });
71
+ await expect(fileMutex.acquire()).resolves.toBeUndefined();
72
+ expect(_fs.default.mkdirSync).not.toHaveBeenCalled();
73
+ expect(_lockfile.default.lock).toHaveBeenCalled();
74
+ });
75
+ });
76
+ describe('release', () => {
77
+ it('should resolve when lockfile.unlock succeeds and call getLockFilePath correctly', async () => {
78
+ const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
79
+ _lockfile.default.unlock.mockImplementation((path, callback) => {
80
+ callback(null);
81
+ });
82
+ await expect(fileMutex.release()).resolves.toBeUndefined();
83
+ expect(_lockfile.default.unlock).toHaveBeenCalledWith(expectedPath, expect.any(Function));
84
+ });
85
+ it('should reject when lockfile.unlock fails', async () => {
86
+ const mockError = new Error('Unlock failed');
87
+ _lockfile.default.unlock.mockImplementation((path, callback) => {
88
+ callback(mockError);
89
+ });
90
+ await expect(fileMutex.release()).rejects.toThrow('Unlock failed');
91
+ expect(_lockfile.default.unlock).toHaveBeenCalled();
92
+ });
93
+ });
94
+ });