@zohodesk/testinglibrary 0.1.8-exp-bdd-v3 → 0.1.8-exp-bdd

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 (72) hide show
  1. package/build/bdd-framework/cli/commands/env.js +42 -0
  2. package/build/bdd-framework/cli/commands/export.js +47 -0
  3. package/build/bdd-framework/cli/commands/test.js +60 -0
  4. package/build/bdd-framework/cli/index.js +11 -0
  5. package/build/bdd-framework/cli/options.js +19 -0
  6. package/build/bdd-framework/cli/worker.js +13 -0
  7. package/build/bdd-framework/config/dir.js +27 -0
  8. package/build/bdd-framework/config/env.js +49 -0
  9. package/build/bdd-framework/config/index.js +90 -0
  10. package/build/bdd-framework/cucumber/buildStepDefinition.js +43 -0
  11. package/build/bdd-framework/cucumber/gherkin.d.js +5 -0
  12. package/build/bdd-framework/cucumber/gherkin.d.ts +45 -0
  13. package/build/bdd-framework/cucumber/loadConfig.js +17 -0
  14. package/build/bdd-framework/cucumber/loadFeatures.js +39 -0
  15. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +20 -0
  16. package/build/bdd-framework/cucumber/loadSources.js +57 -0
  17. package/build/bdd-framework/cucumber/loadSteps.js +35 -0
  18. package/build/bdd-framework/decorators.js +18 -0
  19. package/build/bdd-framework/gen/formatter.js +88 -0
  20. package/build/bdd-framework/gen/i18n.js +35 -0
  21. package/build/bdd-framework/gen/index.js +163 -0
  22. package/build/bdd-framework/gen/poms.js +46 -0
  23. package/build/bdd-framework/gen/testFile.js +356 -0
  24. package/build/bdd-framework/gen/testNode.js +48 -0
  25. package/build/bdd-framework/gen/testPoms.js +123 -0
  26. package/build/bdd-framework/index.js +45 -0
  27. package/build/bdd-framework/playwright/fixtureParameterNames.js +77 -0
  28. package/build/bdd-framework/playwright/getLocationInFile.js +46 -0
  29. package/build/bdd-framework/playwright/loadConfig.js +42 -0
  30. package/build/bdd-framework/playwright/testTypeImpl.js +57 -0
  31. package/build/bdd-framework/playwright/transform.js +80 -0
  32. package/build/bdd-framework/playwright/types.js +5 -0
  33. package/build/bdd-framework/playwright/utils.js +37 -0
  34. package/build/bdd-framework/run/bddFixtures.js +107 -0
  35. package/build/bdd-framework/run/bddWorld.js +88 -0
  36. package/build/bdd-framework/snippets/index.js +134 -0
  37. package/build/bdd-framework/snippets/snippetSyntax.js +41 -0
  38. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +26 -0
  39. package/build/bdd-framework/snippets/snippetSyntaxTs.js +18 -0
  40. package/build/bdd-framework/stepDefinitions/createBdd.js +49 -0
  41. package/build/bdd-framework/stepDefinitions/createDecorators.js +108 -0
  42. package/build/bdd-framework/stepDefinitions/decorators/poms.js +64 -0
  43. package/build/bdd-framework/stepDefinitions/decorators/steps.js +93 -0
  44. package/build/bdd-framework/stepDefinitions/defineStep.js +61 -0
  45. package/build/bdd-framework/stepDefinitions/stepConfig.js +24 -0
  46. package/build/bdd-framework/utils/exit.js +54 -0
  47. package/build/bdd-framework/utils/index.js +44 -0
  48. package/build/bdd-framework/utils/jsStringWrap.js +44 -0
  49. package/build/bdd-framework/utils/logger.js +28 -0
  50. package/build/bdd-poc/core-runner/exportMethods.js +6 -12
  51. package/build/bdd-poc/core-runner/stepDefinitions.js +3 -1
  52. package/build/bdd-poc/test/cucumber/featureFileParer.js +5 -4
  53. package/build/bdd-poc/test/stepGenerate/stepFileGenerate.js +9 -8
  54. package/build/bdd-poc/test/stepGenerate/stepsnippets.js +1 -2
  55. package/build/bdd-poc/test/testDataMap.js +2 -2
  56. package/build/bdd-poc/test/testStructure.js +4 -3
  57. package/build/core/jest/preprocessor/jsPreprocessor.js +2 -3
  58. package/build/core/playwright/custom-commands.js +1 -2
  59. package/build/core/playwright/index.js +18 -8
  60. package/build/core/playwright/readConfigFile.js +1 -2
  61. package/build/core/playwright/setup/config-creator.js +7 -10
  62. package/build/core/playwright/setup/config-utils.js +13 -14
  63. package/build/core/playwright/test-runner.js +28 -36
  64. package/build/decorators.d.ts +1 -1
  65. package/build/decorators.js +16 -2
  66. package/build/index.js +14 -10
  67. package/build/parser/parser.js +0 -1
  68. package/build/utils/logger.js +1 -2
  69. package/build/utils/stepDefinitionsFormatter.js +1 -2
  70. package/npm-shrinkwrap.json +570 -4
  71. package/package.json +3 -3
  72. package/build/bdd-poc/runner.js +0 -19
@@ -0,0 +1,88 @@
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
+ // This call must be exactly here to have correct call stack.
32
+ const location = (0, _getLocationInFile.getLocationInFile)(this.test.info().file);
33
+ const {
34
+ parameters
35
+ } = await stepDefinition.getInvocationParameters({
36
+ hookParameter: {},
37
+ step: {
38
+ text,
39
+ argument
40
+ },
41
+ world: this
42
+ });
43
+ const res = await (0, _testTypeImpl.runStepWithCustomLocation)(this.test, text, location, () => code.apply(this, parameters));
44
+ delete this.customFixtures;
45
+ return res;
46
+ }
47
+ get page() {
48
+ return this.builtinFixtures.page;
49
+ }
50
+ get context() {
51
+ return this.builtinFixtures.context;
52
+ }
53
+ get browser() {
54
+ return this.builtinFixtures.browser;
55
+ }
56
+ get browserName() {
57
+ return this.builtinFixtures.browserName;
58
+ }
59
+ get request() {
60
+ return this.builtinFixtures.request;
61
+ }
62
+ get testInfo() {
63
+ return this.options.testInfo;
64
+ }
65
+ get tags() {
66
+ return this.options.$tags;
67
+ }
68
+ get test() {
69
+ return this.options.$test;
70
+ }
71
+ async init() {
72
+ // async setup before each test
73
+ }
74
+ async destroy() {
75
+ // async teardown after each test
76
+ }
77
+ }
78
+ exports.BddWorld = BddWorld;
79
+ function getWorldConstructor(supportCodeLibrary) {
80
+ // setWorldConstructor was not called
81
+ if (supportCodeLibrary.World === _cucumber.World) {
82
+ return BddWorld;
83
+ }
84
+ if (!Object.prototype.isPrototypeOf.call(BddWorld, supportCodeLibrary.World)) {
85
+ throw new Error(`CustomWorld should inherit from playwright-bdd World`);
86
+ }
87
+ return supportCodeLibrary.World;
88
+ }
@@ -0,0 +1,134 @@
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 _logger = require("../utils/logger");
9
+ var _stepConfig = require("../stepDefinitions/stepConfig");
10
+ /**
11
+ * Generate and show snippets for undefined steps
12
+ */
13
+
14
+ class Snippets {
15
+ files;
16
+ runConfiguration;
17
+ supportCodeLibrary;
18
+ snippetBuilder;
19
+ bddBuiltInSyntax = false;
20
+ constructor(files, runConfiguration, supportCodeLibrary) {
21
+ this.files = files;
22
+ this.runConfiguration = runConfiguration;
23
+ this.supportCodeLibrary = supportCodeLibrary;
24
+ }
25
+ async print() {
26
+ this.snippetBuilder = await this.createSnippetBuilder();
27
+ const snippets = this.getSnippets();
28
+ this.printHeader();
29
+ this.printSnippets(snippets);
30
+ this.printFooter(snippets);
31
+ // exit();
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
+ _logger.logger.error(`Missing step definitions (${snippets.length}).`, `Use snippets above to create them.`);
121
+ this.printWarningOnZeroScannedFiles();
122
+ }
123
+ printWarningOnZeroScannedFiles() {
124
+ const {
125
+ requirePaths,
126
+ importPaths
127
+ } = this.supportCodeLibrary.originalCoordinates;
128
+ const scannedFilesCount = requirePaths.length + importPaths.length;
129
+ if (scannedFilesCount === 0 && !this.isDecorators()) {
130
+ _logger.logger.error(`Note that 0 step definition files found, check the config.`);
131
+ }
132
+ }
133
+ }
134
+ 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 _bddFixtures = require("../run/bddFixtures");
10
+ var _testTypeImpl = require("../playwright/testTypeImpl");
11
+ var _defineStep = require("./defineStep");
12
+ var _exit = require("../utils/exit");
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, _exit.exit)(`createBdd() should use test extended from "@zohodesk/testinglibrary"`);
47
+ }
48
+ return isCustomTest;
49
+ }
@@ -0,0 +1,108 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.Fixture = Fixture;
7
+ exports.appendDecoratorSteps = appendDecoratorSteps;
8
+ exports.createStepDecorator = createStepDecorator;
9
+ exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
10
+ var _bddFixtures = require("../run/bddFixtures");
11
+ var _defineStep = require("./defineStep");
12
+ var _buildStepDefinition = require("../cucumber/buildStepDefinition");
13
+ /* eslint-disable no-unused-vars */
14
+ /**
15
+ * Define steps via decorators.
16
+ */
17
+
18
+ const pomGraph = new Map();
19
+ const decoratedStepSymbol = Symbol('decoratedStep');
20
+ const decoratedSteps = new Set();
21
+ function Fixture(fixtureName) {
22
+ // context parameter is required for decorator by TS even though it's not used
23
+ return (Ctor, _context) => {
24
+ createPomNode(Ctor, fixtureName);
25
+ };
26
+ }
27
+ function createStepDecorator(keyword) {
28
+ return pattern => {
29
+ // context parameter is required for decorator by TS even though it's not used
30
+ return (method, _context) => {
31
+ method[decoratedStepSymbol] = {
32
+ keyword,
33
+ pattern,
34
+ fn: method,
35
+ hasCustomTest: true,
36
+ isDecorator: true
37
+ };
38
+ };
39
+ };
40
+ }
41
+ function appendDecoratorSteps(supportCodeLibrary) {
42
+ decoratedSteps.forEach(stepConfig => {
43
+ const {
44
+ keyword,
45
+ pattern,
46
+ fn
47
+ } = stepConfig;
48
+ stepConfig.fn = (fixturesArg, ...args) => {
49
+ const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
50
+ return fn.call(fixture, ...args);
51
+ };
52
+ const code = (0, _defineStep.buildCucumberStepFn)(stepConfig);
53
+ const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
54
+ keyword,
55
+ pattern,
56
+ code,
57
+ line: 0,
58
+ // not used in playwright-bdd
59
+ options: {},
60
+ // not used in playwright-bdd
61
+ uri: '' // not used in playwright-bdd
62
+ }, supportCodeLibrary);
63
+ supportCodeLibrary.stepDefinitions.push(stepDefinition);
64
+ });
65
+ decoratedSteps.clear();
66
+ // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
67
+ }
68
+ function getPomNodeByFixtureName(fixtureName) {
69
+ for (const pomNode of pomGraph.values()) {
70
+ if (pomNode.fixtureName === fixtureName) return pomNode;
71
+ }
72
+ }
73
+ function createPomNode(Ctor, fixtureName) {
74
+ const pomNode = {
75
+ fixtureName,
76
+ children: new Set()
77
+ };
78
+ pomGraph.set(Ctor, pomNode);
79
+ getDecoratedSteps(Ctor).forEach(stepConfig => {
80
+ stepConfig.pomNode = pomNode;
81
+ decoratedSteps.add(stepConfig);
82
+ });
83
+ const parentCtor = Object.getPrototypeOf(Ctor);
84
+ if (!parentCtor) return;
85
+ const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
86
+ parentPomNode === null || parentPomNode === void 0 || parentPomNode.children.add(pomNode);
87
+ return pomNode;
88
+ }
89
+ function getDecoratedSteps(Ctor) {
90
+ if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return [];
91
+ const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
92
+ return Object.keys(propertyDescriptors)
93
+ // filter out getters / setters
94
+ .filter(methodName => typeof propertyDescriptors[methodName].value === 'function').map(methodName => {
95
+ return propertyDescriptors[methodName].value[decoratedStepSymbol];
96
+ }).filter(Boolean);
97
+ }
98
+ function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
99
+ // there should be exatcly one suitable fixture in fixturesArg
100
+ const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
101
+ if (fixtureNames.length === 0) {
102
+ throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
103
+ }
104
+ if (fixtureNames.length > 1) {
105
+ throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
106
+ }
107
+ return fixturesArg[fixtureNames[0]];
108
+ }
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.Fixture = Fixture;
7
+ exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
8
+ var _steps = require("./steps");
9
+ var _exit = require("../../utils/exit");
10
+ /**
11
+ * POM classes marked with @Fixture
12
+ */
13
+
14
+ /**
15
+ * Graph of POM class inheritance.
16
+ * Allows to guess correct fixture by step text.
17
+ */
18
+ const pomGraph = new Map();
19
+ /**
20
+ * @Fixture decorator.
21
+ */
22
+ function Fixture(fixtureName) {
23
+ // context parameter is required for decorator by TS even though it's not used
24
+ return Ctor => {
25
+ createPomNode(Ctor, fixtureName);
26
+ };
27
+ }
28
+ function createPomNode(Ctor, fixtureName) {
29
+ const pomNode = {
30
+ fixtureName,
31
+ className: Ctor.name,
32
+ children: new Set()
33
+ };
34
+ ensureUniqueFixtureName(pomNode);
35
+ pomGraph.set(Ctor, pomNode);
36
+ (0, _steps.linkStepsWithPomNode)(Ctor, pomNode);
37
+ linkParentWithPomNode(Ctor, pomNode);
38
+ return pomNode;
39
+ }
40
+ function ensureUniqueFixtureName({
41
+ fixtureName,
42
+ className
43
+ }) {
44
+ if (!fixtureName) {
45
+ return;
46
+ }
47
+ const existingPom = getPomNodeByFixtureName(fixtureName);
48
+ if (existingPom) {
49
+ (0, _exit.exit)(`Duplicate fixture name "${fixtureName}"`, `defined for classes: ${existingPom.className}, ${className}`);
50
+ }
51
+ }
52
+ function linkParentWithPomNode(Ctor, pomNode) {
53
+ const parentCtor = Object.getPrototypeOf(Ctor);
54
+ if (!parentCtor) return;
55
+ // if parentCtor is not in pomGraph, add it.
56
+ // Case: parent class is not marked with @Fixture, but has decorator steps (base class)
57
+ const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
58
+ parentPomNode.children.add(pomNode);
59
+ }
60
+ function getPomNodeByFixtureName(fixtureName) {
61
+ for (const pomNode of pomGraph.values()) {
62
+ if (pomNode.fixtureName === fixtureName) return pomNode;
63
+ }
64
+ }
@@ -0,0 +1,93 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.appendDecoratorSteps = appendDecoratorSteps;
7
+ exports.createStepDecorator = createStepDecorator;
8
+ exports.linkStepsWithPomNode = linkStepsWithPomNode;
9
+ var _bddFixtures = require("../../run/bddFixtures");
10
+ var _buildStepDefinition = require("../../cucumber/buildStepDefinition");
11
+ var _defineStep = require("../defineStep");
12
+ /**
13
+ * Define steps via decorators.
14
+ */
15
+
16
+ // initially we sotre step data inside method,
17
+ // and then extract it in @Fixture decorator call
18
+ const decoratedStepSymbol = Symbol('decoratedStep');
19
+ // global list of all decorator steps
20
+ const decoratedSteps = new Set();
21
+ /**
22
+ * Creates @Given, @When, @Then decorators.
23
+ */
24
+ function createStepDecorator(keyword) {
25
+ return pattern => {
26
+ // context parameter is required for decorator by TS even though it's not used
27
+ // eslint-disable-next-line no-unused-vars
28
+ return (method, _context) => {
29
+ saveStepConfigToMethod(method, {
30
+ keyword,
31
+ pattern,
32
+ fn: method,
33
+ hasCustomTest: true
34
+ });
35
+ };
36
+ };
37
+ }
38
+ function linkStepsWithPomNode(Ctor, pomNode) {
39
+ if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return;
40
+ const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
41
+ return Object.values(propertyDescriptors).forEach(descriptor => {
42
+ const stepConfig = getStepConfigFromMethod(descriptor);
43
+ if (!stepConfig) return;
44
+ stepConfig.pomNode = pomNode;
45
+ decoratedSteps.add(stepConfig);
46
+ });
47
+ }
48
+ /**
49
+ * Append decorator steps to Cucumber's supportCodeLibrary.
50
+ */
51
+ function appendDecoratorSteps(supportCodeLibrary) {
52
+ decoratedSteps.forEach(stepConfig => {
53
+ const {
54
+ keyword,
55
+ pattern,
56
+ fn
57
+ } = stepConfig;
58
+ stepConfig.fn = (fixturesArg, ...args) => {
59
+ const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
60
+ return fn.call(fixture, ...args);
61
+ };
62
+ const code = (0, _defineStep.buildCucumberStepCode)(stepConfig);
63
+ const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
64
+ keyword,
65
+ pattern,
66
+ code,
67
+ line: 0,
68
+ options: {},
69
+ uri: '' // not used in playwright-bdd
70
+ }, supportCodeLibrary);
71
+ supportCodeLibrary.stepDefinitions.push(stepDefinition);
72
+ });
73
+ decoratedSteps.clear();
74
+ // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
75
+ }
76
+ function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
77
+ // there should be exatcly one suitable fixture in fixturesArg
78
+ const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
79
+ if (fixtureNames.length === 0) {
80
+ throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
81
+ }
82
+ if (fixtureNames.length > 1) {
83
+ throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
84
+ }
85
+ return fixturesArg[fixtureNames[0]];
86
+ }
87
+ function saveStepConfigToMethod(method, stepConfig) {
88
+ method[decoratedStepSymbol] = stepConfig;
89
+ }
90
+ function getStepConfigFromMethod(descriptor) {
91
+ // filter out getters / setters
92
+ return typeof descriptor.value === 'function' ? descriptor.value[decoratedStepSymbol] : undefined;
93
+ }
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.buildCucumberStepCode = buildCucumberStepCode;
7
+ exports.defineStep = defineStep;
8
+ exports.getStepCode = getStepCode;
9
+ var _cucumber = require("@cucumber/cucumber");
10
+ var _exit = require("../utils/exit");
11
+ /**
12
+ * Defines step by config.
13
+ * Calls cucumber's Given(), When(), Then() under the hood.
14
+ */
15
+ function defineStep(stepConfig) {
16
+ const {
17
+ keyword,
18
+ pattern
19
+ } = stepConfig;
20
+ const cucumberDefineStepFn = getCucumberDefineStepFn(keyword);
21
+ const code = buildCucumberStepCode(stepConfig);
22
+ try {
23
+ cucumberDefineStepFn(pattern, code);
24
+ } catch (e) {
25
+ // todo: detect that this is import from test file
26
+ // and skip/delay registering cucumber steps until cucumber is loaded
27
+ const isMissingCucumber = /Cucumber that isn't running/i.test(e.message);
28
+ if (isMissingCucumber) {
29
+ (0, _exit.exit)(`Option "importTestFrom" should point to a separate file without step definitions`, `(e.g. without calls of Given, When, Then)`);
30
+ } else {
31
+ throw e;
32
+ }
33
+ }
34
+ }
35
+ function buildCucumberStepCode(stepConfig) {
36
+ const code = function (...args) {
37
+ const fixturesArg = Object.assign({}, this.customFixtures, {
38
+ $testInfo: this.testInfo,
39
+ $test: this.test,
40
+ $tags: this.tags
41
+ });
42
+ return stepConfig.fn.call(this, fixturesArg, ...args);
43
+ };
44
+ code.stepConfig = stepConfig;
45
+ return code;
46
+ }
47
+ function getStepCode(stepDefinition) {
48
+ return stepDefinition.code;
49
+ }
50
+ function getCucumberDefineStepFn(keyword) {
51
+ switch (keyword) {
52
+ case 'Given':
53
+ return _cucumber.Given;
54
+ case 'When':
55
+ return _cucumber.When;
56
+ case 'Then':
57
+ return _cucumber.Then;
58
+ default:
59
+ return _cucumber.defineStep;
60
+ }
61
+ }