@zohodesk/testinglibrary 0.4.3-experimental → 0.4.4-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 (125) hide show
  1. package/.gitlab-ci.yml +44 -0
  2. package/README.md +5 -21
  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/configuration/Configuration.js +3 -0
  105. package/build/core/playwright/configuration/ConfigurationHelper.js +2 -9
  106. package/build/core/playwright/env-initializer.js +0 -1
  107. package/build/core/playwright/helpers/auth/getUsers.js +54 -33
  108. package/build/core/playwright/helpers/configFileNameProvider.js +9 -3
  109. package/build/core/playwright/index.js +23 -10
  110. package/build/core/playwright/readConfigFile.js +22 -22
  111. package/build/core/playwright/setup/config-creator.js +9 -8
  112. package/build/core/playwright/setup/config-utils.js +25 -8
  113. package/build/core/playwright/test-runner.js +7 -5
  114. package/build/core/playwright/validateFeature.js +58 -0
  115. package/build/decorators.d.ts +1 -1
  116. package/build/decorators.js +1 -1
  117. package/build/lib/cli.js +6 -0
  118. package/build/test/core/playwright/__tests__/validateFeature.test.js +64 -0
  119. package/build/test/core/playwright/helpers/__tests__/configFileNameProvider.test.js +34 -0
  120. package/build/utils/cliArgsToObject.js +3 -0
  121. package/jest.config.js +8 -8
  122. package/npm-shrinkwrap.json +2179 -5830
  123. package/package.json +7 -7
  124. package/playwright.config.js +1 -1
  125. package/build/core/playwright/fixtures.js +0 -24
@@ -33,12 +33,17 @@ function getDefaultActorConf() {
33
33
  const {
34
34
  uatDirectory
35
35
  } = (0, _readConfigFile.generateConfigFromFile)();
36
- const defaultSettingFile = `conf/${getRunMode()}/settings.json`;
37
- const filePath = _path.default.join(uatDirectory, defaultSettingFile);
38
- if (!(0, _fs.existsSync)(filePath)) {
39
- throw new Error(`${defaultSettingFile} is missing.`);
36
+ const modeSettingsFile = `conf/${getRunMode()}/settings.json`;
37
+ const filePath = _path.default.join(uatDirectory, modeSettingsFile);
38
+ try {
39
+ if (!(0, _fs.existsSync)(filePath)) {
40
+ const defaultSettingsFile = _path.default.join(uatDirectory, `conf/default/settings.json`);
41
+ return require(defaultSettingsFile);
42
+ }
43
+ return require(filePath);
44
+ } catch (error) {
45
+ throw new Error(`${defaultSettingFile} ${filePath} both files are missing.`);
40
46
  }
41
- return require(filePath);
42
47
  }
43
48
  function getDefaultActor() {
44
49
  const {
@@ -47,51 +52,67 @@ function getDefaultActor() {
47
52
  } = getDefaultActorConf();
48
53
  return getUserForSelectedEditionAndProfile(edition, profile);
49
54
  }
50
- function getListOfActors() {
55
+ function getListOfActors(betaFeature) {
51
56
  const {
52
57
  uatDirectory
53
58
  } = (0, _readConfigFile.generateConfigFromFile)();
54
59
  const mode = getRunMode();
55
- const configFile = `conf/${mode}/actors/index`;
56
- const filePath = _path.default.join(uatDirectory, configFile);
57
- if (!(0, _fs.existsSync)(filePath + '.js')) {
58
- throw new Error(`${configFile}.js is missing.`);
60
+ let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
61
+ if (!(0, _fs.existsSync)(configFile)) {
62
+ configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
63
+ }
64
+ if (betaFeature) {
65
+ configFile = _path.default.join(uatDirectory, `conf/default/actors/beta/${betaFeature}/index.js`);
66
+ }
67
+ try {
68
+ return require(configFile);
69
+ } catch (error) {
70
+ throw new Error(`Error loading actor configuration from ${configFile}`);
59
71
  }
60
- return require(filePath);
61
72
  }
62
73
  function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
74
+ const actorsData = getListOfActors(betaFeature);
75
+ if (!actorsData || !actorsData.editions) {
76
+ throw new Error("The actors data is missing.");
77
+ }
63
78
  const {
64
79
  editions: userdata,
65
80
  beta: betaPortals
66
- } = getListOfActors();
81
+ } = actorsData;
67
82
  const defaultConf = getDefaultActorConf();
68
83
  const edition = preferedEdition || defaultConf.edition;
69
84
  const profile = preferredProfile || defaultConf.profile;
70
85
  let selectedProfile = {};
71
- if (betaFeature && betaFeature !== null) {
72
- if (!betaPortals.hasOwnProperty(betaFeature)) {
73
- throw new Error(`There is no "${betaFeature}" beta feature configured.`);
74
- }
75
- const betaEdition = betaPortals[betaFeature].find(portal => portal.edition === edition);
76
- if (!betaEdition) {
77
- throw new Error(`There is no "${edition}" edition configured in "${betaFeature}" beta feature.`);
78
- }
79
- const {
80
- profiles: betaProfiles,
81
- ...betaEditionData
82
- } = betaEdition;
83
- selectedProfile = betaProfiles.find(user => user.profile === profile);
84
- if (!selectedProfile) {
85
- throw new Error(`There is no "${profile}" configured in edition of "${edition}" in "${betaFeature}" beta features.`);
86
- }
87
- return {
88
- ...betaEditionData,
89
- ...selectedProfile
90
- };
91
- }
86
+ // if (betaFeature && betaFeature !== null) {
87
+ // if (!betaPortals.hasOwnProperty(betaFeature)) {
88
+ // throw new Error(`There is no "${betaFeature}" beta feature configured.`);
89
+ // }
90
+
91
+ // const betaEdition = betaPortals[betaFeature][edition].find(
92
+ // portal => portal.edition === edition
93
+ // );
94
+ // if (!betaEdition) {
95
+ // throw new Error(
96
+ // `There is no "${edition}" edition configured in "${betaFeature}" beta feature.`
97
+ // );
98
+ // }
99
+
100
+ // const { profiles: betaProfiles, ...betaEditionData } = betaEdition;
101
+ // selectedProfile = betaProfiles.find(user => user.profile === profile);
102
+ // if (!selectedProfile) {
103
+ // throw new Error(
104
+ // `There is no "${profile}" configured in edition of "${edition}" in "${betaFeature}" beta features.`
105
+ // );
106
+ // }
107
+ // return {
108
+ // ...betaEditionData,
109
+ // ...selectedProfile
110
+ // };
111
+ // }
92
112
 
93
113
  // 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
94
114
  // For this we need to get the data from ci environment.
115
+
95
116
  let testingPortal = null;
96
117
  if (!userdata.hasOwnProperty(edition)) {
97
118
  throw new Error(`There is no "${edition}" edition configured.`);
@@ -9,8 +9,14 @@ exports.getReportFileName = getReportFileName;
9
9
  exports.getUATFileName = getUATFileName;
10
10
  var _path = _interopRequireDefault(require("path"));
11
11
  var _fs = _interopRequireDefault(require("fs"));
12
- function getUATFileName() {
13
- return 'uat.config.js';
12
+ var _auth = require("./auth");
13
+ function getUATFileName(mode) {
14
+ mode = mode || (0, _auth.getRunMode)();
15
+ const uatConfFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/uat.config.js`);
16
+ if (_fs.default.existsSync(uatConfFilePath)) {
17
+ return uatConfFilePath;
18
+ }
19
+ return _path.default.resolve(process.cwd(), `uat.config.js`);
14
20
  }
15
21
  function getEnvConfigFilePath(mode) {
16
22
  const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);
@@ -18,7 +24,7 @@ function getEnvConfigFilePath(mode) {
18
24
  if (_fs.default.existsSync(confFilePath)) {
19
25
  return `uat/conf/${mode}/settings.json`;
20
26
  }
21
- return `uat/env-config.json`;
27
+ return `uat/conf/default/settings.json`;
22
28
  }
23
29
  function getReportFileName() {
24
30
  return `test-summary.json`;
@@ -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);
@@ -13,13 +13,17 @@ var _path = _interopRequireDefault(require("path"));
13
13
  var _logger = require("../../utils/logger");
14
14
  var _configFileNameProvider = require("./helpers/configFileNameProvider");
15
15
  var _mergeObjects = require("./helpers/mergeObjects");
16
- var _Configuration = require("./configuration/Configuration");
16
+ var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
17
+ var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
18
+ var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
17
19
  let cachedConfig = null;
18
20
  function getDefaultConfig() {
19
21
  return {
20
22
  uatDirectory: _path.default.join(process.cwd(), 'uat'),
21
23
  headless: false,
22
24
  browsers: ['Chrome'],
25
+ forbidOnly: false,
26
+ retries: 0,
23
27
  trace: false,
24
28
  video: false,
25
29
  isAuthMode: false,
@@ -34,26 +38,18 @@ function getDefaultConfig() {
34
38
  height: 720
35
39
  },
36
40
  debug: false,
37
- mode: process.env.mode || 'dev',
41
+ testIdAttribute: 'data-testid',
38
42
  additionalPages: {},
39
43
  featureFilesFolder: 'feature-files',
40
44
  stepDefinitionsFolder: 'steps',
41
- testIdAttribute: 'data-testid',
42
45
  testSetup: {},
43
46
  editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
44
47
  };
45
48
  }
46
- function checkForDeprecatedKeys(configKey) {
47
- let deprecatedConfigInUatConfigFile = ['mode'];
48
- if (deprecatedConfigInUatConfigFile.includes(configKey)) {
49
- _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
50
- }
51
- }
52
49
  function combineDefaultConfigWithUserConfig(userConfiguration) {
53
50
  let defaultConfig = getDefaultConfig();
54
51
  let configurationObj = {};
55
52
  Object.keys(userConfiguration).forEach(configKey => {
56
- checkForDeprecatedKeys(configKey);
57
53
  let configValue = userConfiguration[configKey];
58
54
  if (configValue !== null && configValue !== undefined) {
59
55
  configurationObj[configKey] = configValue;
@@ -112,22 +108,26 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
112
108
  *
113
109
  * @returns {UserConfig}
114
110
  */
111
+
112
+ function getConfigFilePath() {
113
+ return _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
114
+ }
115
115
  function generateConfigFromFile() {
116
- if (cachedConfig !== null) {
117
- return cachedConfig; // If cached, return the cached configuration
118
- }
119
- const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
120
- if ((0, _fs.existsSync)(filePath)) {
121
- /** @type {UserConfig} */
122
- const config = require(filePath);
123
- const modifiedConfiguration = combineDefaultConfigWithUserConfig(config);
124
- cachedConfig = modifiedConfiguration;
125
- return modifiedConfiguration;
116
+ if (cachedConfig === null) {
117
+ // Getting the default config's from framework
118
+ const uatConfig = new _Configuration.default(getDefaultConfig());
119
+ // overriding the application config's from project
120
+ const appConfig = new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)());
121
+ const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
122
+ // overriding the user config's from CLI
123
+ uatConfig.addAll(appConfig);
124
+ uatConfig.addAll(userArgConfig);
125
+ cachedConfig = uatConfig.getAll();
126
126
  }
127
- return {};
127
+ return cachedConfig;
128
128
  }
129
129
  function isUserConfigFileAvailable() {
130
- const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
130
+ const filePath = getConfigFilePath();
131
131
  if ((0, _fs.existsSync)(filePath)) {
132
132
  return true;
133
133
  }
@@ -9,6 +9,7 @@ var _test = require("@playwright/test");
9
9
  var _path = _interopRequireDefault(require("path"));
10
10
  var _readConfigFile = require("../readConfigFile");
11
11
  var _configUtils = require("./config-utils");
12
+ const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
12
13
  const {
13
14
  browsers,
14
15
  trace,
@@ -25,7 +26,7 @@ const {
25
26
  stepDefinitionsFolder,
26
27
  testIdAttribute,
27
28
  globalTimeout
28
- } = (0, _readConfigFile.generateConfigFromFile)();
29
+ } = uatConfig;
29
30
  const projects = (0, _configUtils.getProjects)({
30
31
  browsers,
31
32
  isAuthMode,
@@ -38,12 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
38
39
  featureFilesFolder,
39
40
  stepDefinitionsFolder
40
41
  });
41
- const use = {
42
+ const testOptions = (0, _configUtils.getTestUseOptions)({
42
43
  trace,
43
44
  video,
44
45
  viewport,
45
46
  testIdAttribute
46
- };
47
+ });
47
48
 
48
49
  /**
49
50
  * Playwright configuration object
@@ -51,13 +52,11 @@ const use = {
51
52
  * @returns {import('@playwright/test').PlaywrightTestConfig}
52
53
  */
53
54
  function getPlaywrightConfig() {
54
- return {
55
+ const playwrightConfig = {
55
56
  testDir,
56
57
  globalTimeout: globalTimeout || 3600000,
57
58
  outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
58
59
  fullyParallel: true,
59
- forbidOnly: !!process.env.CI,
60
- retries: process.env.CI ? 2 : 0,
61
60
  reporter: [['html', {
62
61
  outputFolder: reportPath,
63
62
  open: openReportOn
@@ -66,7 +65,7 @@ function getPlaywrightConfig() {
66
65
  expect: {
67
66
  timeout: expectTimeout
68
67
  },
69
- use,
68
+ use: testOptions,
70
69
  projects: isAuthMode ? [{
71
70
  name: 'setup',
72
71
  testMatch: /.*\.setup\.js/,
@@ -76,7 +75,9 @@ function getPlaywrightConfig() {
76
75
  name: 'cleanup',
77
76
  testMatch: /.*\.teardown\.js/,
78
77
  testDir: _path.default.join(process.cwd(), 'uat')
79
- }, ...projects] : [...projects]
78
+ }, ...projects] : [...projects],
79
+ ...uatConfig
80
80
  };
81
+ return playwrightConfig;
81
82
  }
82
83
  var _default = exports.default = (0, _test.defineConfig)(getPlaywrightConfig());
@@ -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
  }
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  value: true
6
6
  });
7
7
  exports.default = void 0;
8
+ exports.runPreprocessing = runPreprocessing;
8
9
  var _child_process = require("child_process");
9
10
  var _path = _interopRequireDefault(require("path"));
10
11
  var _customCommands = require("./custom-commands");
@@ -42,7 +43,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
42
43
  }
43
44
  function runPreprocessing(tagArgs, configPath) {
44
45
  const beforeCommand = 'node';
45
- const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
46
+ const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
46
47
  const beforeArgs = [bddGenPath, '-c', configPath];
47
48
  if (tagArgs) {
48
49
  beforeArgs.push('--tags');
@@ -57,7 +58,7 @@ function runPreprocessing(tagArgs, configPath) {
57
58
  });
58
59
  childProcessForPreprocessing.on('error', data => {
59
60
  _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
60
- reject();
61
+ reject(data);
61
62
  });
62
63
  childProcessForPreprocessing.on('exit', code => {
63
64
  if (code === 0) {
@@ -103,15 +104,16 @@ function main() {
103
104
  const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
104
105
 
105
106
  // overriding the application config's from project
106
- uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)()));
107
107
 
108
- // overriding the user config's from CLI
109
108
  const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
109
+ const mode = userArgConfig.get("mode");
110
+ uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)(mode)));
111
+
112
+ // overriding the user config's from CLI
110
113
  uatConfig.addAll(userArgConfig);
111
114
  const {
112
115
  isAuthMode,
113
116
  editionOrder,
114
- mode,
115
117
  debug,
116
118
  bddMode = false,
117
119
  headless = false
@@ -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 _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
9
+ var _readConfigFile = require("./readConfigFile");
10
+ var _tagProcessor = require("./tag-processor");
11
+ var _testRunner = require("./test-runner");
12
+ var _logger = require("../../utils/logger");
13
+ // @cucumber/gherkins need to be includ in package.json
14
+
15
+ // const getFeatureFiles = (dir) => {
16
+ // let featureFiles = [];
17
+ // const files = fs.readdirSync(dir, { withFileTypes: true });
18
+ // files.forEach(file => {
19
+ // const fullPath = path.join(dir, file.name);
20
+ // if (file.isDirectory()) {
21
+ // featureFiles = featureFiles.concat(getFeatureFiles(fullPath));
22
+ // } else if (file.isFile() && fullPath.endsWith('.feature')) {
23
+ // featureFiles.push(fullPath);
24
+ // }
25
+ // });
26
+ // return featureFiles;
27
+ // };
28
+
29
+ //const validateFeatureFiles = () => {
30
+ // const featuresDir = path.join(process.cwd(), 'uat/modules');
31
+ // const parser = new Parser();
32
+ // const featureFiles = getFeatureFiles(featuresDir);
33
+ // featureFiles.forEach( filePath => {
34
+ // const featureFileContent = fs.readFileSync(filePath, 'utf-8');
35
+ // try {
36
+ // parser.parse(featureFileContent);
37
+ // console.log(`${filePath}: Feature file is valid!`);
38
+ // } catch (error) {
39
+ // console.error(`${filePath}: Feature file is invalid - ${error.message}`);
40
+ // }
41
+ // })
42
+ //}
43
+
44
+ const validateFeatureFiles = () => {
45
+ const userArgsObject = (0, _parseUserArgs.default)();
46
+ const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
47
+ const {
48
+ editionOrder
49
+ } = uatConfig;
50
+ const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
51
+ const tagArgs = (0, _tagProcessor.tagProcessor)(userArgsObject, editionOrder);
52
+ (0, _testRunner.runPreprocessing)(tagArgs, configPath).then(() => {
53
+ _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
54
+ }).catch(error => {
55
+ _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${error}`);
56
+ });
57
+ };
58
+ var _default = exports.default = validateFeatureFiles;
@@ -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;
package/build/lib/cli.js CHANGED
@@ -10,6 +10,7 @@ var _parser = require("../parser/parser");
10
10
  var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
11
11
  var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
12
12
  var _parseUserArgs = _interopRequireDefault(require("../core/playwright/helpers/parseUserArgs"));
13
+ var _validateFeature = _interopRequireDefault(require("../core/playwright/validateFeature"));
13
14
  // import createJestRunner from '../core/jest/runner/jest-runner';
14
15
 
15
16
  const [,, option, ...otherOptions] = process.argv;
@@ -21,6 +22,11 @@ switch (option) {
21
22
  //createJestRunner();
22
23
  break;
23
24
  }
25
+ case 'validate':
26
+ {
27
+ (0, _validateFeature.default)();
28
+ break;
29
+ }
24
30
  case 're-run-failed':
25
31
  {
26
32
  _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Failed Tests..');
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _validateFeature = _interopRequireDefault(require("../../../../core/playwright/validateFeature"));
5
+ var _parseUserArgs = _interopRequireDefault(require("../../../../core/playwright/helpers/parseUserArgs"));
6
+ var _readConfigFile = require("../../../../core/playwright/readConfigFile");
7
+ var _tagProcessor = require("../../../../core/playwright/tag-processor");
8
+ var _testRunner = require("../../../../core/playwright/test-runner");
9
+ var _logger = require("../../../../utils/logger");
10
+ jest.mock('../../../../core/playwright/helpers/parseUserArgs', () => ({
11
+ __esModule: true,
12
+ default: jest.fn()
13
+ }));
14
+ jest.mock('../../../../core/playwright/readConfigFile');
15
+ jest.mock('../../../../core/playwright/tag-processor');
16
+ jest.mock('../../../../core/playwright/test-runner');
17
+ jest.mock('../../../../utils/logger', () => ({
18
+ __esModule: true,
19
+ Logger: {
20
+ log: jest.fn(),
21
+ SUCCESS_TYPE: 'success',
22
+ FAILURE_TYPE: 'failure'
23
+ }
24
+ }));
25
+ describe('validateFeatureFiles', () => {
26
+ beforeEach(() => {
27
+ jest.clearAllMocks();
28
+ });
29
+ test('runPreprocessing with correct arguments and log success', async () => {
30
+ const mockUserArgs = {
31
+ mode: 'dev'
32
+ };
33
+ _parseUserArgs.default.mockReturnValue(mockUserArgs);
34
+ const mockConfig = {
35
+ editionOrder: ["beta", "enterprice"]
36
+ };
37
+ _readConfigFile.generateConfigFromFile.mockReturnValue(mockConfig);
38
+ _readConfigFile.isUserConfigFileAvailable.mockReturnValue(true);
39
+ const mockTagArgs = ['@beta_admin'];
40
+ _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
41
+ _testRunner.runPreprocessing.mockResolvedValueOnce();
42
+ await (0, _validateFeature.default)();
43
+ expect(_parseUserArgs.default).toHaveBeenCalled();
44
+ expect(_readConfigFile.generateConfigFromFile).toHaveBeenCalled();
45
+ expect(_readConfigFile.isUserConfigFileAvailable).toHaveBeenCalled();
46
+ expect(_tagProcessor.tagProcessor).toHaveBeenCalledWith(mockUserArgs, ["beta", "enterprice"]);
47
+ expect(_testRunner.runPreprocessing).toHaveBeenCalledWith(mockTagArgs, expect.stringContaining('config-creator.js'));
48
+ expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
49
+ });
50
+ test('runPreprocessing with playwright conf', async () => {
51
+ const mockTagArgs = ['@beta_admin'];
52
+ _tagProcessor.tagProcessor.mockReturnValue(mockTagArgs);
53
+ _readConfigFile.isUserConfigFileAvailable.mockReturnValue(false);
54
+ _testRunner.runPreprocessing.mockResolvedValueOnce();
55
+ await (0, _validateFeature.default)();
56
+ expect(_testRunner.runPreprocessing).toHaveBeenCalledWith(mockTagArgs, expect.stringContaining('playwright.config.js'));
57
+ });
58
+ test('error when runPreprocessing fails', async () => {
59
+ const mockError = new Error('Test error');
60
+ _testRunner.runPreprocessing.mockRejectedValueOnce(mockError);
61
+ await await (0, _validateFeature.default)();
62
+ expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${mockError}`);
63
+ });
64
+ });
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _fs = require("fs");
5
+ var _path = _interopRequireDefault(require("path"));
6
+ var _configFileNameProvider = require("../../../../../core/playwright/helpers/configFileNameProvider");
7
+ jest.mock('fs');
8
+ jest.mock('path');
9
+ const mockCwd = '/mock/current/directory';
10
+ _path.default.resolve = jest.fn();
11
+ process.cwd = jest.fn(() => mockCwd);
12
+ describe('getUATFileName', () => {
13
+ beforeEach(() => {
14
+ jest.clearAllMocks();
15
+ });
16
+ test('return the pipeline matched config files for pipeline matched files exists', () => {
17
+ const mode = 'cd';
18
+ const mockPath = `${mockCwd}/uat/conf/${mode}/uat.config.js`;
19
+ _fs.existsSync.mockReturnValue(true);
20
+ _path.default.resolve.mockImplementation((...args) => args.join('/'));
21
+ const result = (0, _configFileNameProvider.getUATFileName)(mode);
22
+ expect(_fs.existsSync).toHaveBeenCalledWith(mockPath);
23
+ expect(result).toBe(mockPath);
24
+ });
25
+ test('return the default config files for pipeline matched files not exists', () => {
26
+ const mode = 'ci';
27
+ const defaultPath = `${mockCwd}/uat.config.js`;
28
+ _fs.existsSync.mockReturnValue(false);
29
+ _path.default.resolve.mockImplementation((...args) => args.join('/'));
30
+ const result = (0, _configFileNameProvider.getUATFileName)(mode);
31
+ expect(_fs.existsSync).toHaveBeenCalledWith(`${mockCwd}/uat/conf/${mode}/uat.config.js`);
32
+ expect(result).toBe(defaultPath);
33
+ });
34
+ });
@@ -36,6 +36,9 @@ function cliArgsToObject(cliArgs, isKeyNeedToBeAdded) {
36
36
  value = true;
37
37
  }
38
38
  processEnv[key] = value;
39
+ if (!isNaN(parseInt(value))) {
40
+ processEnv[key] = parseInt(value);
41
+ }
39
42
  }
40
43
  });
41
44
  return processEnv;