@zohodesk/testinglibrary 0.1.8-exp-bdd-v2 → 0.1.8-exp-bdd-v4

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 (81) hide show
  1. package/.eslintrc.js +5 -1
  2. package/build/bdd-framework/cli/commands/env.js +2 -3
  3. package/build/bdd-framework/cli/commands/export.js +1 -2
  4. package/build/bdd-framework/cli/commands/test.js +7 -4
  5. package/build/bdd-framework/cli/options.js +1 -2
  6. package/build/bdd-framework/config/env.js +2 -1
  7. package/build/bdd-framework/config/index.js +1 -2
  8. package/build/bdd-framework/config/lang.js +14 -0
  9. package/build/bdd-framework/cucumber/loadSteps.js +8 -3
  10. package/build/bdd-framework/decorators.js +6 -10
  11. package/build/bdd-framework/gen/fixtures.js +48 -0
  12. package/build/bdd-framework/gen/formatter.js +57 -10
  13. package/build/bdd-framework/gen/i18n.js +6 -2
  14. package/build/bdd-framework/gen/index.js +7 -6
  15. package/build/bdd-framework/gen/testFile.js +105 -39
  16. package/build/bdd-framework/gen/testNode.js +16 -3
  17. package/build/bdd-framework/gen/testPoms.js +18 -8
  18. package/build/bdd-framework/hooks/scenario.js +107 -0
  19. package/build/bdd-framework/hooks/worker.js +83 -0
  20. package/build/bdd-framework/playwright/fixtureParameterNames.js +24 -8
  21. package/build/bdd-framework/playwright/getLocationInFile.js +13 -7
  22. package/build/bdd-framework/playwright/testTypeImpl.js +11 -7
  23. package/build/bdd-framework/playwright/transform.js +6 -2
  24. package/build/bdd-framework/playwright/utils.js +1 -4
  25. package/build/bdd-framework/run/StepInvoker.js +73 -0
  26. package/build/bdd-framework/run/bddFixtures.js +119 -57
  27. package/build/bdd-framework/run/bddWorld.js +24 -36
  28. package/build/bdd-framework/snippets/index.js +3 -2
  29. package/build/bdd-framework/snippets/snippetSyntax.js +3 -1
  30. package/build/bdd-framework/stepDefinitions/createBdd.js +28 -11
  31. package/build/bdd-framework/stepDefinitions/decorators/{poms.js → class.js} +7 -3
  32. package/build/bdd-framework/stepDefinitions/decorators/steps.js +8 -3
  33. package/build/bdd-framework/stepDefinitions/defineStep.js +2 -1
  34. package/build/bdd-framework/utils/exit.js +8 -4
  35. package/build/bdd-framework/utils/index.js +27 -1
  36. package/build/bdd-framework/utils/logger.js +4 -3
  37. package/build/bdd-poc/core-runner/main.js +10 -0
  38. package/build/bdd-poc/core-runner/stepDefinitions.js +0 -1
  39. package/build/bdd-poc/index.js +26 -0
  40. package/build/bdd-poc/test/stepGenerate/stepFileGenerate.js +6 -6
  41. package/build/bdd-poc/test/stepGenerate/stepsnippets.js +1 -2
  42. package/build/bdd-poc/test/testDataMap.js +5 -5
  43. package/build/core/jest/preprocessor/jsPreprocessor.js +2 -3
  44. package/build/core/playwright/builtInFixtures/addTags.js +19 -0
  45. package/build/core/playwright/builtInFixtures/cacheLayer.js +13 -0
  46. package/build/core/playwright/builtInFixtures/context.js +15 -0
  47. package/build/core/playwright/builtInFixtures/index.js +26 -0
  48. package/build/core/playwright/builtInFixtures/page.js +51 -0
  49. package/build/core/playwright/clear-caches.js +29 -0
  50. package/build/core/playwright/custom-commands.js +1 -2
  51. package/build/core/playwright/index.js +12 -93
  52. package/build/core/playwright/readConfigFile.js +12 -6
  53. package/build/core/playwright/report-generator.js +2 -1
  54. package/build/core/playwright/setup/config-creator.js +23 -17
  55. package/build/core/playwright/setup/config-utils.js +43 -11
  56. package/build/core/playwright/setup/custom-reporter.js +109 -0
  57. package/build/core/playwright/tag-processor.js +68 -0
  58. package/build/core/playwright/test-runner.js +40 -36
  59. package/build/decorators.d.ts +1 -1
  60. package/build/decorators.js +2 -16
  61. package/build/index.d.ts +59 -4
  62. package/build/index.js +10 -9
  63. package/build/lib/cli.js +10 -1
  64. package/build/parser/parser.js +0 -1
  65. package/build/setup-folder-structure/helper.js +34 -0
  66. package/build/setup-folder-structure/reportEnhancement/addonScript.html +25 -0
  67. package/build/setup-folder-structure/reportEnhancement/reportAlteration.js +25 -0
  68. package/build/setup-folder-structure/samples/git-ignore.sample.js +8 -4
  69. package/build/setup-folder-structure/samples/uat-config-sample.js +3 -2
  70. package/build/setup-folder-structure/setupProject.js +10 -5
  71. package/build/utils/fileUtils.js +15 -4
  72. package/build/utils/logger.js +1 -2
  73. package/build/utils/stepDefinitionsFormatter.js +1 -2
  74. package/changelog.md +57 -0
  75. package/npm-shrinkwrap.json +1426 -2172
  76. package/package.json +5 -4
  77. package/build/bdd-framework/cucumber/gherkin.d.ts +0 -45
  78. package/build/bdd-framework/gen/poms.js +0 -46
  79. package/build/bdd-framework/stepDefinitions/createDecorators.js +0 -109
  80. package/build/bdd-poc/main.js +0 -10
  81. /package/build/bdd-poc/{runner.js → core-runner/runner.js} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zohodesk/testinglibrary",
3
- "version": "0.1.8-exp-bdd-v2",
3
+ "version": "0.1.8-exp-bdd-v4",
4
4
  "description": "",
5
5
  "main": "./build/index.js",
6
6
  "scripts": {
@@ -28,11 +28,11 @@
28
28
  "@testing-library/react-hooks": "7.0.2",
29
29
  "babel-jest": "29.6.2",
30
30
  "babel-plugin-transform-dynamic-import": "2.1.0",
31
- "commander": "11.0.0",
32
31
  "fast-glob": "3.3.1",
33
32
  "jest": "29.6.2",
34
33
  "jest-environment-jsdom": "29.6.2",
35
- "msw": "1.2.3"
34
+ "msw": "1.2.3",
35
+ "playwright": "1.40.1"
36
36
  },
37
37
  "bin": {
38
38
  "ZDTestingFramework": "./bin/cli.js"
@@ -49,6 +49,7 @@
49
49
  "@babel/plugin-transform-runtime": "7.22.15",
50
50
  "@babel/polyfill": "7.12.1",
51
51
  "@babel/preset-env": "7.22.15",
52
- "@babel/runtime": "7.22.15"
52
+ "@babel/runtime": "7.22.15",
53
+ "commander": "^11.0.0"
53
54
  }
54
55
  }
@@ -1,45 +0,0 @@
1
- /**
2
- * Copied from @cucumber/cucumber/lib/api/gherkin.d.ts
3
- * Fixes error:
4
- * Return type of exported function has or is using name 'PickleWithDocument'
5
- * from external module "../node_modules/@cucumber/cucumber/lib/api/gherkin"
6
- * but cannot be named
7
- */
8
- import {
9
- Envelope,
10
- GherkinDocument,
11
- IdGenerator,
12
- Location,
13
- ParseError,
14
- Pickle,
15
- } from '@cucumber/messages';
16
- import { ISourcesCoordinates } from '@cucumber/cucumber/lib/api/types';
17
- import { ILogger } from '@cucumber/cucumber/lib/logger';
18
-
19
- declare module '@cucumber/cucumber/lib/api/gherkin' {
20
- export interface PickleWithDocument {
21
- gherkinDocument: GherkinDocument;
22
- location: Location;
23
- pickle: Pickle;
24
- }
25
- export function getFilteredPicklesAndErrors({
26
- newId,
27
- cwd,
28
- logger,
29
- unexpandedFeaturePaths,
30
- featurePaths,
31
- coordinates,
32
- onEnvelope,
33
- }: {
34
- newId: IdGenerator.NewId;
35
- cwd: string;
36
- logger: ILogger;
37
- unexpandedFeaturePaths: string[];
38
- featurePaths: string[];
39
- coordinates: ISourcesCoordinates;
40
- onEnvelope?: (envelope: Envelope) => void;
41
- }): Promise<{
42
- filteredPickles: PickleWithDocument[];
43
- parseErrors: ParseError[];
44
- }>;
45
- }
@@ -1,46 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.POMS = void 0;
7
- exports.buildFixtureTag = buildFixtureTag;
8
- var _createDecorators = require("../stepDefinitions/createDecorators");
9
- /**
10
- * Handle POMs graph for decorator steps.
11
- */
12
-
13
- const FIXTURE_TAG_PREFIX = '@fixture:';
14
- class POMS {
15
- usedPoms = new Map();
16
- add(pomNode) {
17
- if (pomNode) this.usedPoms.set(pomNode, null);
18
- }
19
- addByFixtureName(fixtureName) {
20
- const pomNode = (0, _createDecorators.getPomNodeByFixtureName)(fixtureName);
21
- if (pomNode) this.add(pomNode);
22
- }
23
- addByTag(tag) {
24
- const fixtureName = extractFixtureName(tag);
25
- if (fixtureName) this.addByFixtureName(fixtureName);
26
- }
27
- resolveFixtureNames(pomNode) {
28
- const resolvedFixtureNames = this.usedPoms.get(pomNode);
29
- if (resolvedFixtureNames) return resolvedFixtureNames;
30
- const fixtureNames = [...pomNode.children].map(child => this.resolveFixtureNames(child)).flat();
31
- if (this.usedPoms.has(pomNode)) {
32
- // if nothing returned from children, use own fixtureName,
33
- // otherwise use what returned from child
34
- if (!fixtureNames.length) fixtureNames.push(pomNode.fixtureName);
35
- this.usedPoms.set(pomNode, fixtureNames);
36
- }
37
- return fixtureNames;
38
- }
39
- }
40
- exports.POMS = POMS;
41
- function extractFixtureName(tag) {
42
- return tag.startsWith(FIXTURE_TAG_PREFIX) ? tag.replace(FIXTURE_TAG_PREFIX, '') : '';
43
- }
44
- function buildFixtureTag(fixtureName) {
45
- return `${FIXTURE_TAG_PREFIX}${fixtureName}`;
46
- }
@@ -1,109 +0,0 @@
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
-
69
- function getPomNodeByFixtureName(fixtureName) {
70
- for (const pomNode of pomGraph.values()) {
71
- if (pomNode.fixtureName === fixtureName) return pomNode;
72
- }
73
- }
74
- function createPomNode(Ctor, fixtureName) {
75
- const pomNode = {
76
- fixtureName,
77
- children: new Set()
78
- };
79
- pomGraph.set(Ctor, pomNode);
80
- getDecoratedSteps(Ctor).forEach(stepConfig => {
81
- stepConfig.pomNode = pomNode;
82
- decoratedSteps.add(stepConfig);
83
- });
84
- const parentCtor = Object.getPrototypeOf(Ctor);
85
- if (!parentCtor) return;
86
- const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
87
- parentPomNode === null || parentPomNode === void 0 || parentPomNode.children.add(pomNode);
88
- return pomNode;
89
- }
90
- function getDecoratedSteps(Ctor) {
91
- if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return [];
92
- const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
93
- return Object.keys(propertyDescriptors)
94
- // filter out getters / setters
95
- .filter(methodName => typeof propertyDescriptors[methodName].value === 'function').map(methodName => {
96
- return propertyDescriptors[methodName].value[decoratedStepSymbol];
97
- }).filter(Boolean);
98
- }
99
- function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
100
- // there should be exatcly one suitable fixture in fixturesArg
101
- const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
102
- if (fixtureNames.length === 0) {
103
- throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
104
- }
105
- if (fixtureNames.length > 1) {
106
- throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
107
- }
108
- return fixturesArg[fixtureNames[0]];
109
- }
@@ -1,10 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.cucumberBDDtoTestFile = cucumberBDDtoTestFile;
7
- var _stepFileGenerate = require("./test/stepGenerate/stepFileGenerate");
8
- async function cucumberBDDtoTestFile() {
9
- await (0, _stepFileGenerate.generateSpecFiles)();
10
- }