@zohodesk/testinglibrary 0.1.9-exp-actors → 0.1.12-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 (241) hide show
  1. package/.babelrc +4 -2
  2. package/.claude/settings.local.json +14 -0
  3. package/.gitlab-ci.yml +206 -0
  4. package/README.md +264 -1
  5. package/build/common/data-generator/steps/DataGenerator.spec.js +19 -0
  6. package/build/common/data-generator/steps/DataGeneratorStepsHelper.js +21 -0
  7. package/build/common/multi-actor/steps/multiActorHandling.spec.js +26 -0
  8. package/build/common/searchFake/helpers/rpcRequestHelper.js +52 -0
  9. package/build/common/searchFake/steps/searchFake.spec.js +85 -0
  10. package/build/core/dataGenerator/DataGenerator.js +161 -0
  11. package/build/core/dataGenerator/DataGeneratorError.js +60 -0
  12. package/build/core/dataGenerator/DataGeneratorHelper.js +121 -0
  13. package/build/core/dataGenerator/authenticator/Authenticator.js +37 -0
  14. package/build/core/dataGenerator/authenticator/CookieAuthenticator.js +48 -0
  15. package/build/core/dataGenerator/authenticator/JWTauthenticator.js +59 -0
  16. package/build/core/dataGenerator/authenticator/OAuthAuthenticator.js +26 -0
  17. package/build/core/dataGenerator/authenticator/OrgOAuthAuthenticator.js +26 -0
  18. package/build/core/dataGenerator/authenticator/cookieAuthConfig.js +11 -0
  19. package/build/core/jest/preprocessor/jsPreprocessor.js +2 -7
  20. package/build/core/jest/setup/index.js +1 -7
  21. package/build/core/playwright/builtInFixtures/actorContext.js +78 -0
  22. package/build/core/playwright/builtInFixtures/caseTimeout.js +20 -0
  23. package/build/core/playwright/builtInFixtures/context.js +34 -16
  24. package/build/core/playwright/builtInFixtures/executionContext.js +17 -0
  25. package/build/core/playwright/builtInFixtures/i18N.js +8 -0
  26. package/build/core/playwright/builtInFixtures/index.js +7 -1
  27. package/build/core/playwright/builtInFixtures/page.js +22 -84
  28. package/build/core/playwright/clear-caches.js +17 -5
  29. package/build/core/playwright/codegen.js +4 -21
  30. package/build/core/playwright/configuration/Configuration.js +25 -0
  31. package/build/core/playwright/configuration/ConfigurationHelper.js +45 -0
  32. package/build/core/playwright/configuration/UserArgs.js +12 -0
  33. package/build/core/playwright/constants/configConstants.js +17 -0
  34. package/build/core/playwright/constants/failureTagConstants.js +17 -0
  35. package/build/core/playwright/constants/fileMutexConfig.js +9 -0
  36. package/build/core/playwright/constants/reporterConstants.js +20 -0
  37. package/build/core/playwright/constants/retryConstants.js +8 -0
  38. package/build/core/playwright/custom-commands.js +1 -1
  39. package/build/core/playwright/env-initializer.js +26 -7
  40. package/build/core/playwright/fixtures.js +24 -0
  41. package/build/core/playwright/helpers/additionalProfiles.js +25 -0
  42. package/build/core/playwright/helpers/auth/accountLogin.js +4 -1
  43. package/build/core/playwright/helpers/auth/checkAuthCookies.js +20 -19
  44. package/build/core/playwright/helpers/auth/getUsers.js +57 -49
  45. package/build/core/playwright/helpers/auth/index.js +14 -1
  46. package/build/core/playwright/helpers/auth/loginDefaultStepsHelper.js +62 -0
  47. package/build/core/playwright/helpers/auth/loginSteps.js +40 -22
  48. package/build/core/playwright/helpers/browserTimeoutFactor.js +16 -0
  49. package/build/core/playwright/helpers/caseTimeoutResolver.js +37 -0
  50. package/build/core/playwright/helpers/checkAuthDirectory.js +27 -0
  51. package/build/core/playwright/helpers/configFileNameProvider.js +21 -7
  52. package/build/core/playwright/helpers/configPathResolver.js +38 -0
  53. package/build/core/playwright/helpers/contextFailureHandler.js +81 -0
  54. package/build/core/playwright/helpers/customFixturesHelper.js +58 -0
  55. package/build/core/playwright/helpers/failureTagClassifier.js +197 -0
  56. package/build/core/playwright/helpers/fileMutex.js +71 -0
  57. package/build/core/playwright/helpers/logCollector.js +147 -0
  58. package/build/core/playwright/helpers/parseUserArgs.js +2 -3
  59. package/build/core/playwright/helpers/runtimeLogAnnotator.js +140 -0
  60. package/build/core/playwright/helpers/runtimeLogPath.js +61 -0
  61. package/build/core/playwright/helpers/runtimeLogReader.js +54 -0
  62. package/build/core/playwright/helpers/thirdPartyLib.js +13 -0
  63. package/build/core/playwright/index.js +8 -88
  64. package/build/core/playwright/patterns/casePatterns.js +9 -0
  65. package/build/core/playwright/patterns/codePatterns.js +9 -0
  66. package/build/core/playwright/patterns/environmentPatterns.js +15 -0
  67. package/build/core/playwright/patterns/index.js +33 -0
  68. package/build/core/playwright/patterns/logCollectorIgnorePatterns.js +15 -0
  69. package/build/core/playwright/patterns/toolPatterns.js +26 -0
  70. package/build/core/playwright/readConfigFile.js +49 -16
  71. package/build/core/playwright/reporter/PlaywrightReporter.js +58 -0
  72. package/build/core/playwright/reporter/Reporter.js +65 -0
  73. package/build/core/playwright/reporter/ShardReporter.js +58 -0
  74. package/build/core/playwright/reporter/UnitReporter.js +27 -0
  75. package/build/core/playwright/reporter/helpers/mergeAbortedTests.js +78 -0
  76. package/build/core/playwright/runner/Runner.js +22 -0
  77. package/build/core/playwright/runner/RunnerHelper.js +43 -0
  78. package/build/core/playwright/runner/RunnerTypes.js +17 -0
  79. package/build/core/playwright/runner/SpawnRunner.js +93 -0
  80. package/build/core/playwright/setup/Project.js +35 -0
  81. package/build/core/playwright/setup/ProjectConfiguration.js +66 -0
  82. package/build/core/playwright/setup/config-creator.js +58 -40
  83. package/build/core/playwright/setup/config-utils.js +68 -37
  84. package/build/core/playwright/setup/custom-reporter.js +137 -14
  85. package/build/core/playwright/setup/merge-config.js +32 -0
  86. package/build/core/playwright/setup/qc-custom-reporter.js +342 -0
  87. package/build/core/playwright/spawnInheritChild.js +71 -0
  88. package/build/core/playwright/tagProcessor.js +69 -0
  89. package/build/core/playwright/test-runner.js +44 -97
  90. package/build/core/playwright/types.js +4 -1
  91. package/build/core/playwright/validateFeature.js +28 -0
  92. package/build/decorators.d.ts +1 -1
  93. package/build/decorators.js +1 -1
  94. package/build/index.d.ts +2 -22
  95. package/build/index.js +12 -2
  96. package/build/lib/cli.js +42 -7
  97. package/build/setup-folder-structure/helper.js +2 -0
  98. package/build/setup-folder-structure/samples/accountLogin-sample.js +19 -0
  99. package/build/setup-folder-structure/samples/actors-index.js +2 -0
  100. package/build/setup-folder-structure/samples/auth-setup-sample.js +10 -66
  101. package/build/setup-folder-structure/samples/editions-index.js +3 -0
  102. package/build/setup-folder-structure/samples/free-sample.json +25 -0
  103. package/build/setup-folder-structure/samples/settings.json +7 -0
  104. package/build/setup-folder-structure/samples/testSetup-sample.js +14 -0
  105. package/build/setup-folder-structure/samples/uat-config-sample.js +7 -2
  106. package/build/setup-folder-structure/setupProject.js +23 -5
  107. package/build/test/core/dataGenerator/__tests__/DataGenerator.test.js +311 -0
  108. package/build/test/core/dataGenerator/__tests__/DataGeneratorHelper.test.js +204 -0
  109. package/build/test/core/dataGenerator/__tests__/DataGeneratorResolution.test.js +126 -0
  110. package/build/test/core/dataGenerator/authenticator/__tests__/Authenticator.test.js +88 -0
  111. package/build/test/core/dataGenerator/authenticator/__tests__/JWTauthenticator.test.js +136 -0
  112. package/build/test/core/dataGenerator/authenticator/__tests__/OAuthAuthenticator.test.js +39 -0
  113. package/build/test/core/dataGenerator/authenticator/__tests__/OrgOAuthAuthenticator.test.js +39 -0
  114. package/build/test/core/playwright/__tests__/spawnInheritChild.test.js +148 -0
  115. package/build/test/core/playwright/__tests__/tagProcessor.test.js +94 -0
  116. package/build/test/core/playwright/__tests__/validateFeature.test.js +72 -0
  117. package/build/test/core/playwright/buildInFixtures/__tests__/caseTimeout.test.js +96 -0
  118. package/build/test/core/playwright/buildInFixtures/__tests__/executionContext.test.js +27 -0
  119. package/build/test/core/playwright/configuration/__tests__/Configuration.test.js +53 -0
  120. package/build/test/core/playwright/helpers/__tests__/additionalProfiles.test.js +45 -0
  121. package/build/test/core/playwright/helpers/__tests__/configFileNameProvider.test.js +75 -0
  122. package/build/test/core/playwright/helpers/__tests__/configPathResolver.test.js +55 -0
  123. package/build/test/core/playwright/helpers/__tests__/customFixturesHelper.test.js +51 -0
  124. package/build/test/core/playwright/helpers/__tests__/failureTagClassifier.test.js +604 -0
  125. package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js +79 -0
  126. package/build/test/core/playwright/helpers/__tests__/getUsers_ListOfActors.test.js +83 -0
  127. package/build/test/core/playwright/helpers/__tests__/logCollector.test.js +163 -0
  128. package/build/test/core/playwright/helpers/__tests__/runtimeLogReader.test.js +112 -0
  129. package/build/test/core/playwright/helpers/auth/__tests__/checkAuthCookies.test.js +92 -0
  130. package/build/test/core/playwright/runner/__tests__/RunnerHelper.test.js +19 -0
  131. package/build/test/core/playwright/runner/__tests__/SpawnRunner.test.js +30 -0
  132. package/build/utils/cliArgsToObject.js +3 -0
  133. package/build/utils/commonUtils.js +20 -0
  134. package/build/utils/fileUtils.js +43 -1
  135. package/build/utils/logger.js +1 -30
  136. package/changelog.md +23 -0
  137. package/docs/CODE-REVIEW-AGENT.md +399 -0
  138. package/docs/code-review-instructions.md +157 -0
  139. package/jest.config.js +29 -11
  140. package/npm-shrinkwrap.json +14994 -4793
  141. package/package.json +39 -28
  142. package/playwright.config.js +13 -57
  143. package/unit_reports/unit-report.html +277 -0
  144. package/build/bdd-framework/cli/commands/env.js +0 -42
  145. package/build/bdd-framework/cli/commands/export.js +0 -47
  146. package/build/bdd-framework/cli/commands/test.js +0 -64
  147. package/build/bdd-framework/cli/index.js +0 -11
  148. package/build/bdd-framework/cli/options.js +0 -19
  149. package/build/bdd-framework/cli/worker.js +0 -13
  150. package/build/bdd-framework/config/configDir.js +0 -35
  151. package/build/bdd-framework/config/enrichReporterData.js +0 -23
  152. package/build/bdd-framework/config/env.js +0 -50
  153. package/build/bdd-framework/config/index.js +0 -94
  154. package/build/bdd-framework/config/lang.js +0 -14
  155. package/build/bdd-framework/cucumber/buildStepDefinition.js +0 -43
  156. package/build/bdd-framework/cucumber/createTestStep.js +0 -43
  157. package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +0 -126
  158. package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +0 -72
  159. package/build/bdd-framework/cucumber/formatter/PickleParser.js +0 -25
  160. package/build/bdd-framework/cucumber/formatter/durationHelpers.js +0 -13
  161. package/build/bdd-framework/cucumber/formatter/getColorFns.js +0 -57
  162. package/build/bdd-framework/cucumber/formatter/index.js +0 -16
  163. package/build/bdd-framework/cucumber/formatter/locationHelpers.js +0 -16
  164. package/build/bdd-framework/cucumber/loadConfig.js +0 -17
  165. package/build/bdd-framework/cucumber/loadFeatures.js +0 -70
  166. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +0 -20
  167. package/build/bdd-framework/cucumber/loadSteps.js +0 -47
  168. package/build/bdd-framework/cucumber/resolveFeaturePaths.js +0 -62
  169. package/build/bdd-framework/cucumber/stepArguments.js +0 -21
  170. package/build/bdd-framework/cucumber/types.js +0 -5
  171. package/build/bdd-framework/cucumber/valueChecker.js +0 -23
  172. package/build/bdd-framework/decorators.js +0 -18
  173. package/build/bdd-framework/gen/fixtures.js +0 -48
  174. package/build/bdd-framework/gen/formatter.js +0 -123
  175. package/build/bdd-framework/gen/i18n.js +0 -39
  176. package/build/bdd-framework/gen/index.js +0 -185
  177. package/build/bdd-framework/gen/testFile.js +0 -465
  178. package/build/bdd-framework/gen/testMeta.js +0 -60
  179. package/build/bdd-framework/gen/testNode.js +0 -60
  180. package/build/bdd-framework/gen/testPoms.js +0 -133
  181. package/build/bdd-framework/hooks/scenario.js +0 -130
  182. package/build/bdd-framework/hooks/worker.js +0 -89
  183. package/build/bdd-framework/index.js +0 -52
  184. package/build/bdd-framework/playwright/fixtureParameterNames.js +0 -93
  185. package/build/bdd-framework/playwright/getLocationInFile.js +0 -79
  186. package/build/bdd-framework/playwright/loadConfig.js +0 -42
  187. package/build/bdd-framework/playwright/loadUtils.js +0 -33
  188. package/build/bdd-framework/playwright/testTypeImpl.js +0 -61
  189. package/build/bdd-framework/playwright/transform.js +0 -88
  190. package/build/bdd-framework/playwright/types.js +0 -5
  191. package/build/bdd-framework/playwright/utils.js +0 -34
  192. package/build/bdd-framework/reporter/cucumber/base.js +0 -57
  193. package/build/bdd-framework/reporter/cucumber/custom.js +0 -73
  194. package/build/bdd-framework/reporter/cucumber/helper.js +0 -12
  195. package/build/bdd-framework/reporter/cucumber/html.js +0 -35
  196. package/build/bdd-framework/reporter/cucumber/index.js +0 -74
  197. package/build/bdd-framework/reporter/cucumber/json.js +0 -312
  198. package/build/bdd-framework/reporter/cucumber/junit.js +0 -205
  199. package/build/bdd-framework/reporter/cucumber/message.js +0 -20
  200. package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +0 -64
  201. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +0 -196
  202. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +0 -43
  203. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +0 -52
  204. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +0 -105
  205. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +0 -70
  206. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +0 -45
  207. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +0 -27
  208. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +0 -38
  209. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +0 -128
  210. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +0 -126
  211. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +0 -102
  212. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +0 -50
  213. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +0 -88
  214. package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +0 -30
  215. package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwUtils.js +0 -51
  216. package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +0 -35
  217. package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +0 -5
  218. package/build/bdd-framework/run/StepInvoker.js +0 -68
  219. package/build/bdd-framework/run/bddDataAttachment.js +0 -46
  220. package/build/bdd-framework/run/bddFixtures.js +0 -191
  221. package/build/bdd-framework/run/bddWorld.js +0 -79
  222. package/build/bdd-framework/run/bddWorldInternal.js +0 -15
  223. package/build/bdd-framework/snippets/index.js +0 -132
  224. package/build/bdd-framework/snippets/snippetSyntax.js +0 -43
  225. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +0 -26
  226. package/build/bdd-framework/snippets/snippetSyntaxTs.js +0 -18
  227. package/build/bdd-framework/stepDefinitions/createBdd.js +0 -66
  228. package/build/bdd-framework/stepDefinitions/decorators/class.js +0 -68
  229. package/build/bdd-framework/stepDefinitions/decorators/steps.js +0 -99
  230. package/build/bdd-framework/stepDefinitions/defineStep.js +0 -62
  231. package/build/bdd-framework/stepDefinitions/stepConfig.js +0 -24
  232. package/build/bdd-framework/utils/AutofillMap.js +0 -20
  233. package/build/bdd-framework/utils/exit.js +0 -62
  234. package/build/bdd-framework/utils/index.js +0 -93
  235. package/build/bdd-framework/utils/jsStringWrap.js +0 -44
  236. package/build/bdd-framework/utils/logger.js +0 -30
  237. package/build/bdd-framework/utils/stripAnsiEscapes.js +0 -20
  238. package/build/core/playwright/report-generator.js +0 -42
  239. package/build/core/playwright/tag-processor.js +0 -68
  240. package/build/setup-folder-structure/samples/authUsers-sample.json +0 -9
  241. package/build/setup-folder-structure/samples/env-config-sample.json +0 -21
@@ -1,185 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.TestFilesGenerator = void 0;
8
- var _promises = _interopRequireDefault(require("fs/promises"));
9
- var _path = _interopRequireDefault(require("path"));
10
- var _fastGlob = _interopRequireDefault(require("fast-glob"));
11
- var _testFile = require("./testFile");
12
- var _loadConfig = require("../cucumber/loadConfig");
13
- var _loadFeatures = require("../cucumber/loadFeatures");
14
- var _loadSteps = require("../cucumber/loadSteps");
15
- var _config = require("../config");
16
- var _snippets = require("../snippets");
17
- var _steps = require("../stepDefinitions/decorators/steps");
18
- var _transform = require("../playwright/transform");
19
- var _configDir = require("../config/configDir");
20
- var _logger = require("../utils/logger");
21
- var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
22
- var _exit = require("../utils/exit");
23
- var _createBdd = require("../stepDefinitions/createBdd");
24
- var _resolveFeaturePaths = require("../cucumber/resolveFeaturePaths");
25
- /**
26
- * Generate playwright test files from Gherkin documents.
27
- */
28
-
29
- class TestFilesGenerator {
30
- config;
31
- // all these props are exist
32
- runConfiguration;
33
- featuresLoader = new _loadFeatures.FeaturesLoader();
34
- supportCodeLibrary;
35
- files = [];
36
- tagsExpression;
37
- logger;
38
- constructor(config) {
39
- this.config = config;
40
- this.logger = new _logger.Logger({
41
- verbose: config.verbose
42
- });
43
- if (config.tags) {
44
- this.tagsExpression = (0, _tagExpressions.default)(config.tags);
45
- }
46
- }
47
- async generate() {
48
- await (0, _exit.withExitHandler)(async () => {
49
- await this.loadCucumberConfig();
50
- await Promise.all([this.loadFeatures(), this.loadSteps()]);
51
- this.buildFiles();
52
- await this.checkUndefinedSteps();
53
- this.checkImportTestFrom();
54
- await this.clearOutputDir();
55
- await this.saveFiles();
56
- });
57
- }
58
- async extractSteps() {
59
- await this.loadCucumberConfig();
60
- await this.loadSteps();
61
- return this.supportCodeLibrary.stepDefinitions;
62
- }
63
- async loadCucumberConfig() {
64
- const environment = {
65
- cwd: (0, _configDir.getPlaywrightConfigDir)()
66
- };
67
- const {
68
- runConfiguration
69
- } = await (0, _loadConfig.loadConfig)({
70
- provided: (0, _config.extractCucumberConfig)(this.config)
71
- }, environment);
72
- this.runConfiguration = runConfiguration;
73
- this.warnForTsNodeRegister();
74
- }
75
- async loadFeatures() {
76
- const cwd = (0, _configDir.getPlaywrightConfigDir)();
77
- const {
78
- paths,
79
- defaultDialect
80
- } = this.runConfiguration.sources;
81
- this.logger.log(`Loading features from: ${paths.join(', ')}`);
82
- const {
83
- featurePaths
84
- } = await (0, _resolveFeaturePaths.resovleFeaturePaths)(this.runConfiguration, {
85
- cwd
86
- });
87
- await this.featuresLoader.load(featurePaths, {
88
- relativeTo: cwd,
89
- defaultDialect
90
- });
91
- this.handleParseErrors();
92
- this.logger.log(`Loaded features: ${this.featuresLoader.getDocumentsCount()}`);
93
- }
94
- async loadSteps() {
95
- const {
96
- requirePaths,
97
- importPaths
98
- } = this.runConfiguration.support;
99
- this.logger.log(`Loading steps from: ${requirePaths.concat(importPaths).join(', ')}`);
100
- const environment = {
101
- cwd: (0, _configDir.getPlaywrightConfigDir)()
102
- };
103
- this.supportCodeLibrary = await (0, _loadSteps.loadSteps)(this.runConfiguration, environment);
104
- await this.loadDecoratorSteps();
105
- this.logger.log(`Loaded steps: ${this.supportCodeLibrary.stepDefinitions.length}`);
106
- }
107
- async loadDecoratorSteps() {
108
- const {
109
- importTestFrom
110
- } = this.config;
111
- if (importTestFrom) {
112
- // require importTestFrom for case when it is not required by step definitions
113
- // possible re-require but it's not a problem as it is cached by Node.js
114
- await (0, _transform.requireTransform)().requireOrImport(importTestFrom.file);
115
- (0, _steps.appendDecoratorSteps)(this.supportCodeLibrary);
116
- }
117
- }
118
- buildFiles() {
119
- this.files = this.featuresLoader.getDocumentsWithPickles().map(gherkinDocument => {
120
- return new _testFile.TestFile({
121
- gherkinDocument,
122
- supportCodeLibrary: this.supportCodeLibrary,
123
- // doc.uri is always relative to cwd (coming after cucumber handling)
124
- // see: https://github.com/cucumber/cucumber-js/blob/main/src/api/gherkin.ts#L51
125
- outputPath: this.getSpecPathByFeaturePath(gherkinDocument.uri),
126
- config: this.config,
127
- tagsExpression: this.tagsExpression
128
- }).build();
129
- }).filter(file => file.testCount > 0);
130
- }
131
- getSpecPathByFeaturePath(relFeaturePath) {
132
- const configDir = (0, _configDir.getPlaywrightConfigDir)();
133
- const absFeaturePath = _path.default.resolve(configDir, relFeaturePath);
134
- const relOutputPath = _path.default.relative(this.config.featuresRoot, absFeaturePath);
135
- if (relOutputPath.startsWith('..')) {
136
- (0, _exit.exit)(`All feature files should be located underneath featuresRoot.`, `Please change featuresRoot or paths in configuration.\n`, `featureFile: ${absFeaturePath}\n`, `featuresRoot: ${this.config.featuresRoot}\n`);
137
- }
138
- const absOutputPath = _path.default.resolve(this.config.outputDir, relOutputPath);
139
- return `${absOutputPath}.spec.js`;
140
- }
141
- async checkUndefinedSteps() {
142
- const undefinedSteps = this.files.reduce((sum, file) => sum + file.undefinedSteps.length, 0);
143
- if (undefinedSteps > 0) {
144
- const snippets = new _snippets.Snippets(this.files, this.runConfiguration, this.supportCodeLibrary);
145
- await snippets.print();
146
- (0, _exit.exit)();
147
- }
148
- }
149
- checkImportTestFrom() {
150
- if (_createBdd.hasCustomTest && !this.config.importTestFrom) {
151
- (0, _exit.exit)(`When using custom "test" function in createBdd() you should`, `set "importTestFrom" config option that points to file exporting custom test.`);
152
- }
153
- }
154
- async saveFiles() {
155
- this.files.forEach(file => {
156
- file.save();
157
- this.logger.log(`Generated: ${_path.default.relative(process.cwd(), file.outputPath)}`);
158
- });
159
- this.logger.log(`Generated files: ${this.files.length}`);
160
- }
161
- async clearOutputDir() {
162
- const pattern = `${_fastGlob.default.convertPathToPattern(this.config.outputDir)}/**/*.spec.js`;
163
- const testFiles = await (0, _fastGlob.default)(pattern);
164
- this.logger.log(`Clearing output dir: ${testFiles.length} file(s)`);
165
- const tasks = testFiles.map(testFile => _promises.default.rm(testFile));
166
- await Promise.all(tasks);
167
- }
168
- warnForTsNodeRegister() {
169
- if ((0, _loadSteps.hasTsNodeRegister)(this.runConfiguration)) {
170
- this.logger.warn(`WARNING: usage of requireModule: ['ts-node/register'] is not recommended for playwright-bdd.`, `Remove this option from defineBddConfig() and`, `Playwright's built-in loader will be used to compile TypeScript step definitions.`);
171
- }
172
- }
173
- handleParseErrors() {
174
- const {
175
- parseErrors
176
- } = this.featuresLoader;
177
- if (parseErrors.length) {
178
- const message = parseErrors.map(parseError => {
179
- return `Parse error in "${parseError.source.uri}" ${parseError.message}`;
180
- }).join('\n');
181
- (0, _exit.exit)(message);
182
- }
183
- }
184
- }
185
- exports.TestFilesGenerator = TestFilesGenerator;
@@ -1,465 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.TestFile = void 0;
8
- var _fs = _interopRequireDefault(require("fs"));
9
- var _path = _interopRequireDefault(require("path"));
10
- var _formatter = require("./formatter");
11
- var _i18n = require("./i18n");
12
- var _loadSteps = require("../cucumber/loadSteps");
13
- var _index = require("@cucumber/cucumber/lib/formatter/helpers/index");
14
- var _utils = require("../utils");
15
- var _testPoms = require("./testPoms");
16
- var _testNode = require("./testNode");
17
- var _stepConfig = require("../stepDefinitions/stepConfig");
18
- var _exit = require("../utils/exit");
19
- var _fixtures = require("./fixtures");
20
- var _scenario = require("../hooks/scenario");
21
- var _worker = require("../hooks/worker");
22
- var _lang = require("../config/lang");
23
- var _testMeta = require("./testMeta");
24
- /**
25
- * Generate Playwright test file for feature.
26
- */
27
-
28
- class TestFile {
29
- options;
30
- lines = [];
31
- i18nKeywordsMap;
32
- formatter;
33
- testMetaBuilder;
34
- hasCucumberStyle = false;
35
- hasCustomTest = false;
36
- undefinedSteps = [];
37
- featureUri;
38
- constructor(options) {
39
- this.options = options;
40
- this.formatter = new _formatter.Formatter(options.config);
41
- this.testMetaBuilder = new _testMeta.TestMetaBuilder();
42
- this.featureUri = this.getFeatureUri();
43
- }
44
- get gherkinDocument() {
45
- return this.options.gherkinDocument;
46
- }
47
- get pickles() {
48
- return this.gherkinDocument.pickles;
49
- }
50
- get content() {
51
- return this.lines.join('\n');
52
- }
53
- get language() {
54
- var _this$gherkinDocument;
55
- return ((_this$gherkinDocument = this.gherkinDocument.feature) === null || _this$gherkinDocument === void 0 ? void 0 : _this$gherkinDocument.language) || _lang.LANG_EN;
56
- }
57
- get isEnglish() {
58
- return (0, _lang.isEnglish)(this.language);
59
- }
60
- get config() {
61
- return this.options.config;
62
- }
63
- get outputPath() {
64
- return this.options.outputPath;
65
- }
66
- get testCount() {
67
- return this.testMetaBuilder.testCount;
68
- }
69
- build() {
70
- this.loadI18nKeywords();
71
- this.lines = [...this.getFileHeader(),
72
- // prettier-ignore
73
- ...this.getRootSuite(), ...this.getTechnicalSection()];
74
- return this;
75
- }
76
- save() {
77
- const dir = _path.default.dirname(this.outputPath);
78
- if (!_fs.default.existsSync(dir)) {
79
- _fs.default.mkdirSync(dir, {
80
- recursive: true
81
- });
82
- }
83
- _fs.default.writeFileSync(this.outputPath, this.content);
84
- }
85
- getFileHeader() {
86
- const importTestFrom = this.getRelativeImportTestFrom();
87
- return this.formatter.fileHeader(this.featureUri, importTestFrom);
88
- }
89
- loadI18nKeywords() {
90
- if (!this.isEnglish) {
91
- this.i18nKeywordsMap = (0, _i18n.getKeywordsMap)(this.language);
92
- }
93
- }
94
- getFeatureUri() {
95
- const {
96
- uri
97
- } = this.gherkinDocument;
98
- if (!uri) {
99
- var _this$gherkinDocument2;
100
- throw new Error(`Document without uri: ${(_this$gherkinDocument2 = this.gherkinDocument.feature) === null || _this$gherkinDocument2 === void 0 ? void 0 : _this$gherkinDocument2.name}`);
101
- }
102
- return uri;
103
- }
104
- getRelativeImportTestFrom() {
105
- const {
106
- importTestFrom
107
- } = this.config;
108
- if (!importTestFrom) {
109
- return;
110
- }
111
- const {
112
- file,
113
- varName
114
- } = importTestFrom;
115
- const dir = _path.default.dirname(this.outputPath);
116
- return {
117
- file: _path.default.relative(dir, file),
118
- varName
119
- };
120
- }
121
- getTechnicalSection() {
122
- return this.formatter.technicalSection(this.testMetaBuilder, this.featureUri, [...(!this.isEnglish ? this.formatter.langFixture(this.language) : []), ...((0, _scenario.hasScenarioHooks)() || this.hasCucumberStyle ? this.formatter.bddWorldFixtures() : []), ...this.formatter.scenarioHookFixtures((0, _scenario.getScenarioHooksFixtures)()), ...this.formatter.workerHookFixtures((0, _worker.getWorkerHooksFixtures)())]);
123
- }
124
- getRootSuite() {
125
- const {
126
- feature
127
- } = this.gherkinDocument;
128
- if (!feature) {
129
- throw new Error(`Document without feature.`);
130
- }
131
- return this.getSuite(feature);
132
- }
133
- /**
134
- * Generate test.describe suite for root Feature or Rule
135
- */
136
- getSuite(feature, parent) {
137
- const node = new _testNode.TestNode(feature, parent);
138
- if (node.isSkipped()) {
139
- return this.formatter.suite(node, []);
140
- }
141
- const lines = [];
142
- feature.children.forEach(child => lines.push(...this.getSuiteChild(child, node)));
143
- return this.formatter.suite(node, lines);
144
- }
145
- getSuiteChild(child, parent) {
146
- if ('rule' in child && child.rule) {
147
- return this.getSuite(child.rule, parent);
148
- }
149
- if (child.background) {
150
- return this.getBeforeEach(child.background, parent);
151
- }
152
- if (child.scenario) {
153
- return this.getScenarioLines(child.scenario, parent);
154
- }
155
- throw new Error(`Empty child: ${JSON.stringify(child)}`);
156
- }
157
- getScenarioLines(scenario, parent) {
158
- return this.isOutline(scenario) ? this.getOutlineSuite(scenario, parent) : this.getTest(scenario, parent);
159
- }
160
- /**
161
- * Generate test.beforeEach for Background
162
- */
163
- getBeforeEach(bg, parent) {
164
- const node = new _testNode.TestNode({
165
- name: 'background',
166
- tags: []
167
- }, parent);
168
- const {
169
- fixtures,
170
- lines
171
- } = this.getSteps(bg, node.tags);
172
- return this.formatter.beforeEach(fixtures, lines);
173
- }
174
- /**
175
- * Generate test.describe suite for Scenario Outline
176
- */
177
- getOutlineSuite(scenario, parent) {
178
- const node = new _testNode.TestNode(scenario, parent);
179
- if (node.isSkipped()) {
180
- return this.formatter.suite(node, []);
181
- }
182
- const lines = [];
183
- let exampleIndex = 0;
184
- scenario.examples.forEach(examples => {
185
- const titleFormat = this.getExamplesTitleFormat(scenario, examples);
186
- examples.tableBody.forEach(exampleRow => {
187
- const testTitle = this.getOutlineTestTitle(titleFormat, examples, exampleRow, ++exampleIndex);
188
- const testLines = this.getOutlineTest(scenario, examples, exampleRow, testTitle, node);
189
- lines.push(...testLines);
190
- });
191
- });
192
- return this.formatter.suite(node, lines);
193
- }
194
- /**
195
- * Generate test from Examples row of Scenario Outline
196
- */
197
- // eslint-disable-next-line max-params
198
- getOutlineTest(scenario, examples, exampleRow, title, parent) {
199
- const node = new _testNode.TestNode({
200
- name: title,
201
- tags: examples.tags
202
- }, parent);
203
- if (this.skipByTagsExpression(node)) {
204
- return [];
205
- }
206
- const pickle = this.findPickle(scenario, exampleRow);
207
- this.testMetaBuilder.registerTest(node, pickle);
208
- if (node.isSkipped()) {
209
- return this.formatter.test(node, new Set(), []);
210
- }
211
- const {
212
- fixtures,
213
- lines
214
- } = this.getSteps(scenario, node.tags, exampleRow.id);
215
- return this.formatter.test(node, fixtures, lines);
216
- }
217
- /**
218
- * Generate test from Scenario
219
- */
220
- getTest(scenario, parent) {
221
- const node = new _testNode.TestNode(scenario, parent);
222
- if (this.skipByTagsExpression(node)) {
223
- return [];
224
- }
225
- const pickle = this.findPickle(scenario);
226
- this.testMetaBuilder.registerTest(node, pickle);
227
- if (node.isSkipped()) {
228
- return this.formatter.test(node, new Set(), []);
229
- }
230
- const {
231
- fixtures,
232
- lines
233
- } = this.getSteps(scenario, node.tags);
234
- return this.formatter.test(node, fixtures, lines);
235
- }
236
- /**
237
- * Generate test steps
238
- */
239
- getSteps(scenario, tags, outlineExampleRowId) {
240
- const testFixtureNames = new Set();
241
- const testPoms = new _testPoms.TestPoms(scenario.name || 'Background');
242
- const decoratorSteps = [];
243
- let previousKeywordType = undefined;
244
- const lines = scenario.steps.map((step, index) => {
245
- const {
246
- keyword,
247
- keywordType,
248
- fixtureNames: stepFixtureNames,
249
- line,
250
- pickleStep,
251
- stepConfig
252
- } = this.getStep(step, previousKeywordType, outlineExampleRowId);
253
- previousKeywordType = keywordType;
254
- testFixtureNames.add(keyword);
255
- stepFixtureNames.forEach(fixtureName => testFixtureNames.add(fixtureName));
256
- if ((0, _stepConfig.isDecorator)(stepConfig)) {
257
- testPoms.addByStep(stepConfig.pomNode);
258
- decoratorSteps.push({
259
- index,
260
- keyword,
261
- pickleStep,
262
- pomNode: stepConfig.pomNode
263
- });
264
- }
265
- return line;
266
- });
267
- // decorator steps handled in second pass to guess fixtures
268
- if (decoratorSteps.length) {
269
- testFixtureNames.forEach(fixtureName => testPoms.addByFixtureName(fixtureName));
270
- tags === null || tags === void 0 || tags.forEach(tag => testPoms.addByTag(tag));
271
- testPoms.resolveFixtures();
272
- decoratorSteps.forEach(step => {
273
- const {
274
- line,
275
- fixtureName
276
- } = this.getDecoratorStep(step, testPoms);
277
- lines[step.index] = line;
278
- testFixtureNames.add(fixtureName);
279
- });
280
- }
281
- return {
282
- fixtures: testFixtureNames,
283
- lines
284
- };
285
- }
286
- /**
287
- * Generate step for Given, When, Then
288
- */
289
- // eslint-disable-next-line max-statements, complexity
290
- getStep(step, previousKeywordType, outlineExampleRowId) {
291
- const pickleStep = this.findPickleStep(step, outlineExampleRowId);
292
- const stepDefinition = (0, _loadSteps.findStepDefinition)(this.options.supportCodeLibrary, pickleStep.text, this.featureUri);
293
- const keywordType = (0, _index.getStepKeywordType)({
294
- keyword: step.keyword,
295
- language: this.language,
296
- previousKeywordType
297
- });
298
- const enKeyword = this.getStepEnglishKeyword(step);
299
- if (!stepDefinition) {
300
- this.undefinedSteps.push({
301
- keywordType,
302
- step,
303
- pickleStep
304
- });
305
- return this.getMissingStep(enKeyword, keywordType, pickleStep);
306
- }
307
- // for cucumber-style stepConfig is undefined
308
- const stepConfig = (0, _stepConfig.getStepConfig)(stepDefinition);
309
- if (stepConfig !== null && stepConfig !== void 0 && stepConfig.hasCustomTest) {
310
- this.hasCustomTest = true;
311
- }
312
- if (!(0, _stepConfig.isPlaywrightStyle)(stepConfig)) {
313
- this.hasCucumberStyle = true;
314
- }
315
- const fixtureNames = this.getStepFixtureNames(stepDefinition);
316
- const line = (0, _stepConfig.isDecorator)(stepConfig) ? '' : this.formatter.step(enKeyword, pickleStep.text, pickleStep.argument, fixtureNames);
317
- return {
318
- keyword: enKeyword,
319
- keywordType,
320
- fixtureNames,
321
- line,
322
- pickleStep,
323
- stepConfig
324
- };
325
- }
326
- getMissingStep(keyword, keywordType, pickleStep) {
327
- return {
328
- keyword,
329
- keywordType,
330
- fixtureNames: [],
331
- line: this.formatter.missingStep(keyword, pickleStep.text),
332
- pickleStep,
333
- stepConfig: undefined
334
- };
335
- }
336
- /**
337
- * Returns pickle for scenario.
338
- * Pickle is executable entity including background and steps with example values.
339
- */
340
- findPickle(scenario, exampleRow) {
341
- const pickle = this.pickles.find(pickle => {
342
- const hasScenarioId = pickle.astNodeIds.includes(scenario.id);
343
- const hasExampleRowId = !exampleRow || pickle.astNodeIds.includes(exampleRow.id);
344
- return hasScenarioId && hasExampleRowId;
345
- });
346
- if (!pickle) {
347
- throw new Error(`Pickle not found for scenario: ${scenario.name}`);
348
- }
349
- return pickle;
350
- }
351
- /**
352
- * Returns pickleStep for ast step.
353
- * PickleStep contains step text with inserted example values.
354
- *
355
- * Note:
356
- * When searching for pickleStep iterate all pickles in a file
357
- * b/c for background steps there is no own pickle.
358
- * This can be optimized: pass optional 'pickle' parameter
359
- * and search only inside it if it exists.
360
- * But this increases code complexity, and performance impact seems to be minimal
361
- * b/c number of pickles inside feature file is not very big.
362
- */
363
- findPickleStep(step, exampleRowId) {
364
- for (const pickle of this.pickles) {
365
- const pickleStep = pickle.steps.find(({
366
- astNodeIds
367
- }) => {
368
- const hasStepId = astNodeIds.includes(step.id);
369
- const hasRowId = !exampleRowId || astNodeIds.includes(exampleRowId);
370
- return hasStepId && hasRowId;
371
- });
372
- if (pickleStep) {
373
- return pickleStep;
374
- }
375
- }
376
- throw new Error(`Pickle step not found for step: ${step.text}`);
377
- }
378
- getStepEnglishKeyword(step) {
379
- const nativeKeyword = step.keyword.trim();
380
- const enKeyword = nativeKeyword === '*' ? 'And' : this.getEnglishKeyword(nativeKeyword);
381
- if (!enKeyword) {
382
- throw new Error(`Keyword not found: ${nativeKeyword}`);
383
- }
384
- return enKeyword;
385
- }
386
- getStepFixtureNames(stepDefinition) {
387
- const stepConfig = (0, _stepConfig.getStepConfig)(stepDefinition);
388
- if ((0, _stepConfig.isPlaywrightStyle)(stepConfig)) {
389
- // for decorator steps fixtureNames are defined later in second pass
390
- return (0, _stepConfig.isDecorator)(stepConfig) ? [] : (0, _fixtures.extractFixtureNames)(stepConfig.fn);
391
- } else {
392
- return (0, _fixtures.extractFixtureNamesFromFnBodyMemo)(stepDefinition.code);
393
- }
394
- }
395
- getDecoratorStep(step, testPoms) {
396
- const {
397
- keyword,
398
- pickleStep,
399
- pomNode
400
- } = step;
401
- const resolvedFixtures = testPoms.getResolvedFixtures(pomNode);
402
- if (resolvedFixtures.length !== 1) {
403
- const suggestedTags = resolvedFixtures.filter(f => !f.byTag).map(f => (0, _testPoms.buildFixtureTag)(f.name)).join(', ');
404
- const suggestedTagsStr = suggestedTags.length ? ` or set one of the following tags: ${suggestedTags}` : '.';
405
- (0, _exit.exit)(`Can't guess fixture for decorator step "${pickleStep.text}" in file: ${this.featureUri}.`, `Please refactor your Page Object classes${suggestedTagsStr}`);
406
- }
407
- const fixtureName = resolvedFixtures[0].name;
408
- return {
409
- fixtureName,
410
- line: this.formatter.step(keyword, pickleStep.text, pickleStep.argument, [fixtureName])
411
- };
412
- }
413
- getOutlineTestTitle(titleFormat, examples, exampleRow, exampleIndex) {
414
- const params = {
415
- _index_: exampleIndex
416
- };
417
- exampleRow.cells.forEach((cell, index) => {
418
- var _examples$tableHeader;
419
- const colName = (_examples$tableHeader = examples.tableHeader) === null || _examples$tableHeader === void 0 || (_examples$tableHeader = _examples$tableHeader.cells[index]) === null || _examples$tableHeader === void 0 ? void 0 : _examples$tableHeader.value;
420
- if (colName) {
421
- params[colName] = cell.value;
422
- }
423
- });
424
- return (0, _utils.template)(titleFormat, params);
425
- }
426
- getExamplesTitleFormat(scenario, examples) {
427
- return this.getExamplesTitleFormatFromComment(examples) || this.getExamplesTitleFormatFromScenarioName(scenario, examples) || this.config.examplesTitleFormat;
428
- }
429
- getExamplesTitleFormatFromComment(examples) {
430
- var _comment$text;
431
- const {
432
- line
433
- } = examples.location;
434
- const titleFormatCommentLine = line - 1;
435
- const comment = this.gherkinDocument.comments.find(c => {
436
- return c.location.line === titleFormatCommentLine;
437
- });
438
- const commentText = comment === null || comment === void 0 || (_comment$text = comment.text) === null || _comment$text === void 0 ? void 0 : _comment$text.trim();
439
- const prefix = '# title-format:';
440
- return commentText !== null && commentText !== void 0 && commentText.startsWith(prefix) ? commentText.replace(prefix, '').trim() : '';
441
- }
442
- getExamplesTitleFormatFromScenarioName(scenario, examples) {
443
- var _examples$tableHeader2;
444
- const columnsInScenarioName = (0, _utils.extractTemplateParams)(scenario.name);
445
- const hasColumnsFromExamples = columnsInScenarioName.length && ((_examples$tableHeader2 = examples.tableHeader) === null || _examples$tableHeader2 === void 0 || (_examples$tableHeader2 = _examples$tableHeader2.cells) === null || _examples$tableHeader2 === void 0 ? void 0 : _examples$tableHeader2.some(cell => {
446
- return cell.value && columnsInScenarioName.includes(cell.value);
447
- }));
448
- return hasColumnsFromExamples ? scenario.name : '';
449
- }
450
- skipByTagsExpression(node) {
451
- // see: https://github.com/cucumber/tag-expressions/tree/main/javascript
452
- const {
453
- tagsExpression
454
- } = this.options;
455
- return tagsExpression && !tagsExpression.evaluate(node.tags);
456
- }
457
- isOutline(scenario) {
458
- const keyword = this.getEnglishKeyword(scenario.keyword);
459
- return keyword === 'ScenarioOutline' || keyword === 'Scenario Outline' || keyword === 'Scenario Template';
460
- }
461
- getEnglishKeyword(keyword) {
462
- return this.i18nKeywordsMap ? this.i18nKeywordsMap.get(keyword) : keyword;
463
- }
464
- }
465
- exports.TestFile = TestFile;