@zohodesk/testinglibrary 0.0.5 → 0.0.6

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 (111) hide show
  1. package/.babelrc +19 -0
  2. package/.eslintrc.js +27 -0
  3. package/.prettierrc +6 -0
  4. package/{changelog.md → Changelog.md} +38 -25
  5. package/README.md +17 -17
  6. package/bin/cli.js +2 -2
  7. package/bin/postinstall.js +1 -16
  8. package/build/bdd-framework/cli/commands/env.js +43 -0
  9. package/build/bdd-framework/cli/commands/export.js +48 -0
  10. package/build/bdd-framework/cli/commands/test.js +59 -0
  11. package/build/bdd-framework/cli/index.js +11 -0
  12. package/build/bdd-framework/cli/options.js +20 -0
  13. package/build/bdd-framework/cli/worker.js +13 -0
  14. package/build/bdd-framework/config/dir.js +27 -0
  15. package/build/bdd-framework/config/env.js +49 -0
  16. package/build/bdd-framework/config/index.js +91 -0
  17. package/build/bdd-framework/cucumber/buildStepDefinition.js +43 -0
  18. package/build/bdd-framework/cucumber/gherkin.d.js +5 -0
  19. package/build/bdd-framework/cucumber/gherkin.d.ts +45 -0
  20. package/build/bdd-framework/cucumber/loadConfig.js +17 -0
  21. package/build/bdd-framework/cucumber/loadFeatures.js +39 -0
  22. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +20 -0
  23. package/build/bdd-framework/cucumber/loadSources.js +57 -0
  24. package/build/bdd-framework/cucumber/loadSteps.js +35 -0
  25. package/build/bdd-framework/decorators.js +22 -0
  26. package/build/bdd-framework/gen/formatter.js +88 -0
  27. package/build/bdd-framework/gen/i18n.js +35 -0
  28. package/build/bdd-framework/gen/index.js +160 -0
  29. package/build/bdd-framework/gen/poms.js +46 -0
  30. package/build/bdd-framework/gen/testFile.js +356 -0
  31. package/build/bdd-framework/gen/testNode.js +48 -0
  32. package/build/bdd-framework/gen/testPoms.js +123 -0
  33. package/build/bdd-framework/index.js +45 -0
  34. package/build/bdd-framework/playwright/fixtureParameterNames.js +77 -0
  35. package/build/bdd-framework/playwright/getLocationInFile.js +46 -0
  36. package/build/bdd-framework/playwright/loadConfig.js +42 -0
  37. package/build/bdd-framework/playwright/testTypeImpl.js +41 -0
  38. package/build/bdd-framework/playwright/transform.js +80 -0
  39. package/build/bdd-framework/playwright/types.js +5 -0
  40. package/build/bdd-framework/playwright/utils.js +34 -0
  41. package/build/bdd-framework/run/bddFixtures.js +108 -0
  42. package/build/bdd-framework/run/bddWorld.js +87 -0
  43. package/build/bdd-framework/snippets/index.js +131 -0
  44. package/build/bdd-framework/snippets/snippetSyntax.js +41 -0
  45. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +26 -0
  46. package/build/bdd-framework/snippets/snippetSyntaxTs.js +18 -0
  47. package/build/bdd-framework/stepDefinitions/createBdd.js +49 -0
  48. package/build/bdd-framework/stepDefinitions/createDecorators.js +109 -0
  49. package/build/bdd-framework/stepDefinitions/decorators/poms.js +50 -0
  50. package/build/bdd-framework/stepDefinitions/decorators/steps.js +94 -0
  51. package/build/bdd-framework/stepDefinitions/defineStep.js +61 -0
  52. package/build/bdd-framework/stepDefinitions/stepConfig.js +24 -0
  53. package/build/bdd-framework/utils/index.js +50 -0
  54. package/build/bdd-framework/utils/jsStringWrap.js +44 -0
  55. package/build/bdd-framework/utils/logger.js +29 -0
  56. package/build/core/jest/preprocessor/jsPreprocessor.js +13 -0
  57. package/{src → build}/core/jest/runner/jest-runner.js +46 -44
  58. package/build/core/jest/setup/index.js +9 -0
  59. package/build/core/playwright/codegen.js +55 -0
  60. package/build/core/playwright/custom-commands.js +8 -0
  61. package/build/core/playwright/env-initializer.js +21 -0
  62. package/{src → build}/core/playwright/index.js +112 -82
  63. package/build/core/playwright/readConfigFile.js +69 -0
  64. package/build/core/playwright/report-generator.js +41 -0
  65. package/build/core/playwright/setup/config-creator.js +117 -0
  66. package/build/core/playwright/test-runner.js +132 -0
  67. package/build/decorators.d.ts +1 -0
  68. package/build/decorators.js +16 -0
  69. package/build/index.d.ts +5 -0
  70. package/build/index.js +59 -0
  71. package/build/lib/cli.js +54 -0
  72. package/build/lib/post-install.js +17 -0
  73. package/build/lint/index.js +4 -0
  74. package/build/parser/parser.js +206 -0
  75. package/build/parser/sample.feature +34 -0
  76. package/build/parser/sample.spec.js +37 -0
  77. package/build/parser/verifier.js +130 -0
  78. package/build/setup-folder-structure/samples/auth-setup-sample.js +72 -0
  79. package/build/setup-folder-structure/samples/authUsers-sample.json +9 -0
  80. package/build/setup-folder-structure/samples/env-config-sample.json +21 -0
  81. package/build/setup-folder-structure/samples/git-ignore.sample.js +33 -0
  82. package/build/setup-folder-structure/samples/uat-config-sample.js +35 -0
  83. package/build/setup-folder-structure/setupProject.js +100 -0
  84. package/{src → build}/utils/cliArgsToObject.js +65 -63
  85. package/build/utils/fileUtils.js +53 -0
  86. package/build/utils/getFilePath.js +11 -0
  87. package/build/utils/logger.js +58 -0
  88. package/build/utils/rootPath.js +46 -0
  89. package/build/utils/stepDefinitionsFormatter.js +12 -0
  90. package/jest.config.js +63 -63
  91. package/npm-shrinkwrap.json +8790 -5772
  92. package/package.json +51 -30
  93. package/playwright.config.js +112 -112
  94. package/src/core/jest/preprocessor/jsPreprocessor.js +0 -9
  95. package/src/core/jest/setup/index.js +0 -165
  96. package/src/core/playwright/codegen.js +0 -60
  97. package/src/core/playwright/custom-commands.js +0 -3
  98. package/src/core/playwright/env-initializer.js +0 -24
  99. package/src/core/playwright/readConfigFile.js +0 -63
  100. package/src/core/playwright/report-generator.js +0 -45
  101. package/src/core/playwright/setup/config-creator.js +0 -77
  102. package/src/core/playwright/test-runner.js +0 -67
  103. package/src/index.js +0 -9
  104. package/src/lib/cli.js +0 -42
  105. package/src/setup-folder-structure/env-config-sample.json +0 -17
  106. package/src/setup-folder-structure/setupProject.js +0 -99
  107. package/src/setup-folder-structure/uat-config-sample.js +0 -22
  108. package/src/setup-folder-structure/user-example.json +0 -3
  109. package/src/utils/getFilePath.js +0 -9
  110. package/src/utils/logger.js +0 -28
  111. package/src/utils/rootPath.js +0 -51
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.loadConfig = loadConfig;
8
+ exports.resolveConfigFile = resolveConfigFile;
9
+ var _path = _interopRequireDefault(require("path"));
10
+ var _fs = _interopRequireDefault(require("fs"));
11
+ var _utils = require("./utils");
12
+ var _transform = require("./transform");
13
+ var _utils2 = require("../utils");
14
+ /**
15
+ * Loading Playwright config.
16
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/configLoader.ts
17
+ */
18
+
19
+ async function loadConfig(cliConfigPath) {
20
+ const resolvedConfigFile = resolveConfigFile(cliConfigPath);
21
+ assertConfigFileExists(resolvedConfigFile, cliConfigPath);
22
+ await (0, _transform.requireTransform)().requireOrImport(resolvedConfigFile);
23
+ return {
24
+ resolvedConfigFile
25
+ };
26
+ }
27
+ function resolveConfigFile(cliConfigPath) {
28
+ const {
29
+ resolveConfigFile
30
+ } = (0, _utils.requirePlaywrightModule)('lib/common/configLoader.js');
31
+ const configFileOrDirectory = getConfigFilePath(cliConfigPath);
32
+ return resolveConfigFile(configFileOrDirectory) || '';
33
+ }
34
+ function getConfigFilePath(cliConfigPath) {
35
+ return cliConfigPath ? _path.default.resolve(process.cwd(), cliConfigPath) : process.cwd();
36
+ }
37
+ function assertConfigFileExists(resolvedConfigFile, cliConfigPath) {
38
+ if (!resolvedConfigFile || !_fs.default.existsSync(resolvedConfigFile)) {
39
+ const configFilePath = getConfigFilePath(cliConfigPath);
40
+ (0, _utils2.exitWithMessage)(`Can't find Playwright config file in: ${configFilePath}`);
41
+ }
42
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.getTestImpl = getTestImpl;
7
+ exports.isParentChildTest = isParentChildTest;
8
+ var _test = require("@playwright/test");
9
+ var _utils = require("../utils");
10
+ /**
11
+ * Helpers to deal with Playwright test internal stuff.
12
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/testType.ts
13
+ */
14
+
15
+ const testTypeSymbol = (0, _utils.getSymbolByName)(_test.test, 'testType');
16
+ /**
17
+ * Returns test fixtures using Symbol.
18
+ */
19
+ function getTestFixtures(test) {
20
+ return getTestImpl(test).fixtures;
21
+ }
22
+ function getTestImpl(test) {
23
+ return test[testTypeSymbol];
24
+ }
25
+ /**
26
+ * Returns true if all fixtures of parent test found in child test.
27
+ */
28
+ function isParentChildTest(parent, child) {
29
+ if (parent === child) return false;
30
+ const childLocationsSet = new Set(getTestFixtures(child).map(f => locationToString(f.location)));
31
+ return getTestFixtures(parent).every(f => {
32
+ return childLocationsSet.has(locationToString(f.location));
33
+ });
34
+ }
35
+ function locationToString({
36
+ file,
37
+ line,
38
+ column
39
+ }) {
40
+ return `${file}:${line}:${column}`;
41
+ }
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.installTransform = installTransform;
8
+ exports.requireTransform = requireTransform;
9
+ var _module = _interopRequireDefault(require("module"));
10
+ var _fs = _interopRequireDefault(require("fs"));
11
+ var _path = _interopRequireDefault(require("path"));
12
+ var _utils = require("./utils");
13
+ /* eslint-disable max-params */
14
+ /**
15
+ * Installs require hook to transform ts.
16
+ * Extracted from playwright.
17
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/transform/transform.ts
18
+ */
19
+ function installTransform() {
20
+ const {
21
+ pirates
22
+ } = (0, _utils.requirePlaywrightModule)('lib/utilsBundle.js');
23
+ const {
24
+ resolveHook,
25
+ shouldTransform,
26
+ transformHook
27
+ } = requireTransform();
28
+ let reverted = false;
29
+ const originalResolveFilename = _module.default._resolveFilename;
30
+ function resolveFilename(specifier, parent, ...rest) {
31
+ if (!reverted && parent) {
32
+ const resolved = resolveHook(parent.filename, specifier);
33
+ if (resolved !== undefined) specifier = resolved;
34
+ }
35
+ return originalResolveFilename.call(this, specifier, parent, ...rest);
36
+ }
37
+ _module.default._resolveFilename = resolveFilename;
38
+ const revertPirates = pirates.addHook((code, filename) => {
39
+ if (!shouldTransform(filename)) return code;
40
+ return transformHook(code, filename);
41
+ }, {
42
+ exts: ['.ts', '.tsx', '.js', '.jsx', '.mjs']
43
+ });
44
+ return () => {
45
+ reverted = true;
46
+ _module.default._resolveFilename = originalResolveFilename;
47
+ revertPirates();
48
+ };
49
+ }
50
+ function requireTransform() {
51
+ const transformPathSince1_35 = (0, _utils.getPlaywrightModulePath)('lib/transform/transform.js');
52
+ if (_fs.default.existsSync(transformPathSince1_35)) {
53
+ const {
54
+ resolveHook,
55
+ shouldTransform,
56
+ transformHook,
57
+ requireOrImport
58
+ } = (0, _utils.requirePlaywrightModule)(transformPathSince1_35);
59
+ return {
60
+ resolveHook,
61
+ shouldTransform,
62
+ transformHook,
63
+ requireOrImport
64
+ };
65
+ } else {
66
+ const {
67
+ resolveHook,
68
+ transformHook,
69
+ requireOrImport
70
+ } = (0, _utils.requirePlaywrightModule)('lib/common/transform.js');
71
+ // see: https://github.com/microsoft/playwright/blob/b4ffb848de1b00e9a0abad6dacdccce60cce9bed/packages/playwright-test/src/reporters/base.ts#L524
72
+ const shouldTransform = file => !file.includes(`${_path.default.sep}node_modules${_path.default.sep}`);
73
+ return {
74
+ resolveHook,
75
+ shouldTransform,
76
+ transformHook,
77
+ requireOrImport
78
+ };
79
+ }
80
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.getPlaywrightModulePath = getPlaywrightModulePath;
8
+ exports.requirePlaywrightModule = requirePlaywrightModule;
9
+ var _fs = _interopRequireDefault(require("fs"));
10
+ var _path = _interopRequireDefault(require("path"));
11
+ var _utils = require("../utils");
12
+ // cache playwright root
13
+ let playwrightRoot = '';
14
+ /**
15
+ * Requires Playwright's internal module that is not exported via package.exports.
16
+ */
17
+ function requirePlaywrightModule(modulePath) {
18
+ const absPath = _path.default.isAbsolute(modulePath) ? modulePath : getPlaywrightModulePath(modulePath);
19
+ return require(absPath);
20
+ }
21
+ function getPlaywrightModulePath(relativePath) {
22
+ return _path.default.join(getPlaywrightRoot(), relativePath);
23
+ }
24
+ function getPlaywrightRoot() {
25
+ if (!playwrightRoot) {
26
+ // Since 1.38 all modules moved from @playwright/test to playwright.
27
+ // Here we check existance of 'lib' dir instead of checking version.
28
+ // See: https://github.com/microsoft/playwright/pull/26946
29
+ const playwrightTestRoot = (0, _utils.resolvePackageRoot)('@playwright/test');
30
+ const libDir = _path.default.join(playwrightTestRoot, 'lib');
31
+ playwrightRoot = _fs.default.existsSync(libDir) ? playwrightTestRoot : (0, _utils.resolvePackageRoot)('playwright');
32
+ }
33
+ return playwrightRoot;
34
+ }
@@ -0,0 +1,108 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.isBddAutoInjectFixture = isBddAutoInjectFixture;
7
+ exports.test = void 0;
8
+ var _test = require("@playwright/test");
9
+ var _loadConfig = require("../cucumber/loadConfig");
10
+ var _loadSteps = require("../cucumber/loadSteps");
11
+ var _bddWorld = require("./bddWorld");
12
+ var _config = require("../config");
13
+ var _env = require("../config/env");
14
+ var _steps = require("../stepDefinitions/decorators/steps");
15
+ var _dir = require("../config/dir");
16
+ const test = _test.test.extend({
17
+ $bddWorldBase: async ({
18
+ $tags,
19
+ $test
20
+ }, use, testInfo) => {
21
+ const config = (0, _env.getConfigFromEnv)(testInfo.project.testDir);
22
+ const environment = {
23
+ cwd: (0, _dir.getPlaywrightConfigDir)()
24
+ };
25
+ const {
26
+ runConfiguration
27
+ } = await (0, _loadConfig.loadConfig)({
28
+ provided: (0, _config.extractCucumberConfig)(config)
29
+ }, environment);
30
+ const supportCodeLibrary = await (0, _loadSteps.loadSteps)(runConfiguration, environment);
31
+ (0, _steps.appendDecoratorSteps)(supportCodeLibrary);
32
+ const World = (0, _bddWorld.getWorldConstructor)(supportCodeLibrary);
33
+ const world = new World({
34
+ testInfo,
35
+ supportCodeLibrary,
36
+ $tags,
37
+ $test,
38
+ parameters: runConfiguration.runtime.worldParameters || {},
39
+ log: () => {},
40
+ attach: async () => {}
41
+ });
42
+ await world.init();
43
+ await use(world);
44
+ await world.destroy();
45
+ },
46
+ $bddWorld: async ({
47
+ $bddWorldBase,
48
+ page,
49
+ context,
50
+ browser,
51
+ browserName,
52
+ request
53
+ }, use) => {
54
+ $bddWorldBase.builtinFixtures = {
55
+ page,
56
+ context,
57
+ browser,
58
+ browserName,
59
+ request
60
+ };
61
+ await use($bddWorldBase);
62
+ },
63
+ // below fixtures are used in playwright-style
64
+ // and does not automatically init Playwright builtin fixtures
65
+ Given: ({
66
+ $bddWorldBase
67
+ }, use) => use($bddWorldBase.invokeStep),
68
+ When: ({
69
+ $bddWorldBase
70
+ }, use) => use($bddWorldBase.invokeStep),
71
+ Then: ({
72
+ $bddWorldBase
73
+ }, use) => use($bddWorldBase.invokeStep),
74
+ And: ({
75
+ $bddWorldBase
76
+ }, use) => use($bddWorldBase.invokeStep),
77
+ But: ({
78
+ $bddWorldBase
79
+ }, use) => use($bddWorldBase.invokeStep),
80
+ // below fixtures are used in cucumber-style
81
+ // and automatically init Playwright builtin fixtures
82
+ Given_: ({
83
+ $bddWorld
84
+ }, use) => use($bddWorld.invokeStep),
85
+ When_: ({
86
+ $bddWorld
87
+ }, use) => use($bddWorld.invokeStep),
88
+ Then_: ({
89
+ $bddWorld
90
+ }, use) => use($bddWorld.invokeStep),
91
+ And_: ({
92
+ $bddWorld
93
+ }, use) => use($bddWorld.invokeStep),
94
+ But_: ({
95
+ $bddWorld
96
+ }, use) => use($bddWorld.invokeStep),
97
+ // Init $tags fixture with empty array. Can be owerwritten in test file
98
+ // eslint-disable-next-line
99
+ $tags: ({}, use) => use([]),
100
+ // Init $test fixture with base test, but it will be always overwritten in test file
101
+ // eslint-disable-next-line
102
+ $test: ({}, use) => use(_test.test)
103
+ });
104
+ exports.test = test;
105
+ const BDD_AUTO_INJECT_FIXTURES = ['$testInfo', '$test', '$tags'];
106
+ function isBddAutoInjectFixture(name) {
107
+ return BDD_AUTO_INJECT_FIXTURES.includes(name);
108
+ }
@@ -0,0 +1,87 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.BddWorld = void 0;
7
+ exports.getWorldConstructor = getWorldConstructor;
8
+ var _cucumber = require("@cucumber/cucumber");
9
+ var _loadSteps = require("../cucumber/loadSteps");
10
+ var _getLocationInFile = require("../playwright/getLocationInFile");
11
+ var _testTypeImpl = require("../playwright/testTypeImpl");
12
+ var _defineStep = require("../stepDefinitions/defineStep");
13
+ class BddWorld extends _cucumber.World {
14
+ options;
15
+ builtinFixtures;
16
+ customFixtures;
17
+ constructor(options) {
18
+ super(options);
19
+ this.options = options;
20
+ this.invokeStep = this.invokeStep.bind(this);
21
+ }
22
+ async invokeStep(text, argument, customFixtures) {
23
+ const stepDefinition = (0, _loadSteps.findStepDefinition)(this.options.supportCodeLibrary, text, this.testInfo.file);
24
+ if (!stepDefinition) {
25
+ throw new Error(`Undefined step: "${text}"`);
26
+ }
27
+ // attach custom fixtures to world - the only way to pass them to cucumber step fn
28
+ this.customFixtures = customFixtures;
29
+ const code = (0, _defineStep.getStepCode)(stepDefinition);
30
+ // get location of step call in generated test file
31
+ const location = (0, _getLocationInFile.getLocationInFile)(this.test.info().file);
32
+ const {
33
+ parameters
34
+ } = await stepDefinition.getInvocationParameters({
35
+ hookParameter: {},
36
+ step: {
37
+ text,
38
+ argument
39
+ },
40
+ world: this
41
+ });
42
+ const res = await (0, _testTypeImpl.getTestImpl)(this.test)._step(location, text, () => code.apply(this, parameters));
43
+ delete this.customFixtures;
44
+ return res;
45
+ }
46
+ get page() {
47
+ return this.builtinFixtures.page;
48
+ }
49
+ get context() {
50
+ return this.builtinFixtures.context;
51
+ }
52
+ get browser() {
53
+ return this.builtinFixtures.browser;
54
+ }
55
+ get browserName() {
56
+ return this.builtinFixtures.browserName;
57
+ }
58
+ get request() {
59
+ return this.builtinFixtures.request;
60
+ }
61
+ get testInfo() {
62
+ return this.options.testInfo;
63
+ }
64
+ get tags() {
65
+ return this.options.$tags;
66
+ }
67
+ get test() {
68
+ return this.options.$test;
69
+ }
70
+ async init() {
71
+ // async setup before each test
72
+ }
73
+ async destroy() {
74
+ // async teardown after each test
75
+ }
76
+ }
77
+ exports.BddWorld = BddWorld;
78
+ function getWorldConstructor(supportCodeLibrary) {
79
+ // setWorldConstructor was not called
80
+ if (supportCodeLibrary.World === _cucumber.World) {
81
+ return BddWorld;
82
+ }
83
+ if (!Object.prototype.isPrototypeOf.call(BddWorld, supportCodeLibrary.World)) {
84
+ throw new Error(`CustomWorld should inherit from playwright-bdd World`);
85
+ }
86
+ return supportCodeLibrary.World;
87
+ }
@@ -0,0 +1,131 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.Snippets = void 0;
7
+ var _loadSnippetBuilder = require("../cucumber/loadSnippetBuilder");
8
+ var _utils = require("../utils");
9
+ var _logger = require("../utils/logger");
10
+ var _stepConfig = require("../stepDefinitions/stepConfig");
11
+ /**
12
+ * Generate and show snippets for undefined steps
13
+ */
14
+
15
+ class Snippets {
16
+ files;
17
+ runConfiguration;
18
+ supportCodeLibrary;
19
+ snippetBuilder;
20
+ bddBuiltInSyntax = false;
21
+ constructor(files, runConfiguration, supportCodeLibrary) {
22
+ this.files = files;
23
+ this.runConfiguration = runConfiguration;
24
+ this.supportCodeLibrary = supportCodeLibrary;
25
+ }
26
+ async printSnippetsAndExit() {
27
+ this.snippetBuilder = await this.createSnippetBuilder();
28
+ const snippets = this.getSnippets();
29
+ this.printHeader();
30
+ this.printSnippets(snippets);
31
+ this.printFooter(snippets);
32
+ }
33
+ async createSnippetBuilder() {
34
+ const {
35
+ snippetInterface
36
+ } = this.runConfiguration.formats.options;
37
+ const snippetSyntax = this.getSnippetSyntax();
38
+ return (0, _loadSnippetBuilder.loadSnippetBuilder)(this.supportCodeLibrary, snippetInterface, snippetSyntax);
39
+ }
40
+ getSnippetSyntax() {
41
+ const {
42
+ snippetSyntax
43
+ } = this.runConfiguration.formats.options;
44
+ if (!snippetSyntax && this.isPlaywrightStyle()) {
45
+ this.bddBuiltInSyntax = true;
46
+ return this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
47
+ } else {
48
+ return snippetSyntax;
49
+ }
50
+ }
51
+ getSnippets() {
52
+ const snippetsSet = new Set();
53
+ const snippets = [];
54
+ this.files.forEach(file => {
55
+ file.undefinedSteps.forEach(undefinedStep => {
56
+ const {
57
+ snippet,
58
+ snippetWithLocation
59
+ } = this.getSnippet(file, snippets.length + 1, undefinedStep);
60
+ if (!snippetsSet.has(snippet)) {
61
+ snippetsSet.add(snippet);
62
+ snippets.push(snippetWithLocation);
63
+ }
64
+ });
65
+ });
66
+ return snippets;
67
+ }
68
+ getSnippet(file, index, undefinedStep) {
69
+ const snippet = this.snippetBuilder.build({
70
+ keywordType: undefinedStep.keywordType,
71
+ pickleStep: undefinedStep.pickleStep
72
+ });
73
+ const {
74
+ line,
75
+ column
76
+ } = undefinedStep.step.location;
77
+ const snippetWithLocation = [`// ${index}. Missing step definition for "${file.sourceFile}:${line}:${column}"`, snippet].join('\n');
78
+ return {
79
+ snippet,
80
+ snippetWithLocation
81
+ };
82
+ }
83
+ isTypeScript() {
84
+ const {
85
+ requirePaths,
86
+ importPaths
87
+ } = this.supportCodeLibrary.originalCoordinates;
88
+ return requirePaths.some(p => p.endsWith('.ts')) || importPaths.some(p => p.endsWith('.ts'));
89
+ }
90
+ isPlaywrightStyle() {
91
+ const {
92
+ stepDefinitions
93
+ } = this.supportCodeLibrary;
94
+ return stepDefinitions.length > 0 ? stepDefinitions.some(step => (0, _stepConfig.isPlaywrightStyle)((0, _stepConfig.getStepConfig)(step))) : true;
95
+ }
96
+ isDecorators() {
97
+ const {
98
+ stepDefinitions
99
+ } = this.supportCodeLibrary;
100
+ const decoratorSteps = stepDefinitions.filter(step => (0, _stepConfig.isDecorator)((0, _stepConfig.getStepConfig)(step)));
101
+ return decoratorSteps.length > stepDefinitions.length / 2;
102
+ }
103
+ printHeader() {
104
+ const lines = [`Missing steps found. Use snippets below:`];
105
+ if (this.bddBuiltInSyntax) {
106
+ if (this.isDecorators()) {
107
+ lines.push(`import { Fixture, Given, When, Then } from 'playwright-bdd/decorators';\n`);
108
+ } else {
109
+ lines.push(`import { createBdd } from '@zohodesk/testinglibrary';`, `const { Given, When, Then } = createBdd();\n`);
110
+ }
111
+ } else {
112
+ lines.push(`import { Given, When, Then } from '@cucumber/cucumber';\n`);
113
+ }
114
+ _logger.logger.error(lines.join('\n\n'));
115
+ }
116
+ printSnippets(snippets) {
117
+ _logger.logger.error(snippets.concat(['']).join('\n\n'));
118
+ }
119
+ printFooter(snippets) {
120
+ (0, _utils.exitWithMessage)(`Missing step definitions (${snippets.length}).`, 'Use snippets above to create them.', this.getWarnOnZeroScannedFiles());
121
+ }
122
+ getWarnOnZeroScannedFiles() {
123
+ const {
124
+ requirePaths,
125
+ importPaths
126
+ } = this.supportCodeLibrary.originalCoordinates;
127
+ const scannedFilesCount = requirePaths.length + importPaths.length;
128
+ return scannedFilesCount === 0 && !this.isDecorators() ? `\nNote that 0 step definition files found, check the config.` : '';
129
+ }
130
+ }
131
+ exports.Snippets = Snippets;
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ // todo: custom cucumber parameters
8
+ // See: https://github.com/cucumber/cucumber-expressions#custom-parameter-types
9
+ class _default {
10
+ isTypescript = false;
11
+ build({
12
+ generatedExpressions,
13
+ functionName,
14
+ stepParameterNames
15
+ }) {
16
+ // Always take only first generatedExpression
17
+ // Other expressions are for int/float combinations
18
+ const generatedExpression = generatedExpressions[0];
19
+ const expressionParameters = generatedExpression.parameterNames.map((name, i) => {
20
+ const argName = `arg${i === 0 ? '' : i}`;
21
+ const type = name.startsWith('string') ? 'string' : 'number';
22
+ return this.isTypescript ? `${argName}: ${type}` : argName;
23
+ });
24
+ const stepParameters = stepParameterNames.map(argName => {
25
+ const type = argName === 'dataTable' ? 'DataTable' : 'string';
26
+ return this.isTypescript ? `${argName}: ${type}` : argName;
27
+ });
28
+ const allParameterNames = ['{}', ...expressionParameters, ...stepParameters];
29
+ const functionSignature = `${functionName}('${this.escapeSpecialCharacters(generatedExpression)}', async (${allParameterNames.join(', ')}) => {`;
30
+ return [functionSignature, ` // ...`, '});'].join('\n');
31
+ }
32
+ escapeSpecialCharacters(generatedExpression) {
33
+ let source = generatedExpression.source;
34
+ // double up any backslashes because we're in a javascript string
35
+ source = source.replace(/\\/g, '\\\\');
36
+ // escape any single quotes because that's our quote delimiter
37
+ source = source.replace(/'/g, "\\'");
38
+ return source;
39
+ }
40
+ }
41
+ exports.default = _default;
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ class _default {
8
+ build({
9
+ generatedExpressions,
10
+ functionName
11
+ }) {
12
+ // Always take only first generatedExpression
13
+ // Other expressions are for int/float combinations
14
+ const generatedExpression = generatedExpressions[0];
15
+ return `@${functionName}('${this.escapeSpecialCharacters(generatedExpression)}')`;
16
+ }
17
+ escapeSpecialCharacters(generatedExpression) {
18
+ let source = generatedExpression.source;
19
+ // double up any backslashes because we're in a javascript string
20
+ source = source.replace(/\\/g, '\\\\');
21
+ // escape any single quotes because that's our quote delimiter
22
+ source = source.replace(/'/g, "\\'");
23
+ return source;
24
+ }
25
+ }
26
+ exports.default = _default;
@@ -0,0 +1,18 @@
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 _snippetSyntax = _interopRequireDefault(require("./snippetSyntax"));
9
+ /**
10
+ * Playwright-style snippet syntax for typescript.
11
+ * Important to use separate file as it's simplest way to distinguish between js/ts
12
+ * without hooking into cucumber machinery.
13
+ */
14
+
15
+ class _default extends _snippetSyntax.default {
16
+ isTypescript = true;
17
+ }
18
+ exports.default = _default;
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.createBdd = createBdd;
7
+ exports.extractFixtureNames = extractFixtureNames;
8
+ var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
9
+ var _utils = require("../utils");
10
+ var _bddFixtures = require("../run/bddFixtures");
11
+ var _testTypeImpl = require("../playwright/testTypeImpl");
12
+ var _defineStep = require("./defineStep");
13
+ /**
14
+ * Stuff related to writing steps in Playwright-style.
15
+ */
16
+
17
+ function createBdd(customTest) {
18
+ const hasCustomTest = isCustomTest(customTest);
19
+ const Given = defineStepCtor('Given', hasCustomTest);
20
+ const When = defineStepCtor('When', hasCustomTest);
21
+ const Then = defineStepCtor('Then', hasCustomTest);
22
+ const Step = defineStepCtor('Unknown', hasCustomTest);
23
+ return {
24
+ Given,
25
+ When,
26
+ Then,
27
+ Step
28
+ };
29
+ }
30
+ function defineStepCtor(keyword, hasCustomTest) {
31
+ return (pattern, fn) => {
32
+ (0, _defineStep.defineStep)({
33
+ keyword,
34
+ pattern,
35
+ fn,
36
+ hasCustomTest
37
+ });
38
+ };
39
+ }
40
+ function extractFixtureNames(fn) {
41
+ return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
42
+ }
43
+ function isCustomTest(customTest) {
44
+ const isCustomTest = Boolean(customTest && customTest !== _bddFixtures.test);
45
+ if (isCustomTest && customTest && !(0, _testTypeImpl.isParentChildTest)(_bddFixtures.test, customTest)) {
46
+ (0, _utils.exitWithMessage)(`createBdd() should use test extended from "playwright-bdd"`);
47
+ }
48
+ return isCustomTest;
49
+ }