@zohodesk/testinglibrary 0.4.36-experimental → 0.4.38-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 (131) hide show
  1. package/.gitlab-ci.yml +2 -2
  2. package/README.md +54 -1
  3. package/build/core/playwright/builtInFixtures/page.js +32 -16
  4. package/build/core/playwright/clear-caches.js +7 -0
  5. package/build/core/playwright/fixtures.js +24 -0
  6. package/build/core/playwright/helpers/auth/loginSteps.js +3 -0
  7. package/build/core/playwright/index.js +10 -23
  8. package/build/core/playwright/runner/SpawnRunner.js +2 -2
  9. package/build/core/playwright/setup/config-creator.js +13 -8
  10. package/build/core/playwright/setup/config-utils.js +8 -25
  11. package/build/core/playwright/tagProcessor.js +5 -7
  12. package/build/core/playwright/test-runner.js +2 -2
  13. package/build/decorators.d.ts +1 -1
  14. package/build/decorators.js +1 -1
  15. package/build/setup-folder-structure/samples/accountLogin-sample.js +19 -0
  16. package/build/setup-folder-structure/samples/actors-index.js +2 -0
  17. package/build/setup-folder-structure/samples/auth-setup-sample.js +10 -68
  18. package/build/setup-folder-structure/samples/editions-index.js +3 -0
  19. package/build/setup-folder-structure/samples/free-sample.json +25 -0
  20. package/build/setup-folder-structure/samples/settings.json +7 -0
  21. package/build/setup-folder-structure/samples/testSetup-sample.js +14 -0
  22. package/build/setup-folder-structure/samples/uat-config-sample.js +3 -1
  23. package/build/setup-folder-structure/setupProject.js +22 -5
  24. package/build/test/core/playwright/__tests__/tagProcessor.test.js +18 -19
  25. package/package.json +11 -10
  26. package/playwright.config.js +0 -48
  27. package/build/bdd-framework/cli/commands/env.js +0 -42
  28. package/build/bdd-framework/cli/commands/export.js +0 -62
  29. package/build/bdd-framework/cli/commands/test.js +0 -64
  30. package/build/bdd-framework/cli/index.js +0 -11
  31. package/build/bdd-framework/cli/options.js +0 -19
  32. package/build/bdd-framework/cli/worker.js +0 -13
  33. package/build/bdd-framework/config/configDir.js +0 -35
  34. package/build/bdd-framework/config/enrichReporterData.js +0 -23
  35. package/build/bdd-framework/config/env.js +0 -50
  36. package/build/bdd-framework/config/index.js +0 -94
  37. package/build/bdd-framework/config/lang.js +0 -14
  38. package/build/bdd-framework/cucumber/buildStepDefinition.js +0 -43
  39. package/build/bdd-framework/cucumber/createTestStep.js +0 -43
  40. package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +0 -126
  41. package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +0 -72
  42. package/build/bdd-framework/cucumber/formatter/PickleParser.js +0 -25
  43. package/build/bdd-framework/cucumber/formatter/durationHelpers.js +0 -13
  44. package/build/bdd-framework/cucumber/formatter/getColorFns.js +0 -57
  45. package/build/bdd-framework/cucumber/formatter/index.js +0 -16
  46. package/build/bdd-framework/cucumber/formatter/locationHelpers.js +0 -16
  47. package/build/bdd-framework/cucumber/loadConfig.js +0 -17
  48. package/build/bdd-framework/cucumber/loadFeatures.js +0 -70
  49. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +0 -20
  50. package/build/bdd-framework/cucumber/loadSteps.js +0 -47
  51. package/build/bdd-framework/cucumber/resolveFeaturePaths.js +0 -62
  52. package/build/bdd-framework/cucumber/stepArguments.js +0 -21
  53. package/build/bdd-framework/cucumber/types.js +0 -5
  54. package/build/bdd-framework/cucumber/valueChecker.js +0 -23
  55. package/build/bdd-framework/decorators.js +0 -18
  56. package/build/bdd-framework/gen/fixtures.js +0 -48
  57. package/build/bdd-framework/gen/formatter.js +0 -167
  58. package/build/bdd-framework/gen/i18n.js +0 -39
  59. package/build/bdd-framework/gen/index.js +0 -197
  60. package/build/bdd-framework/gen/specialTags.js +0 -70
  61. package/build/bdd-framework/gen/testFile.js +0 -470
  62. package/build/bdd-framework/gen/testMeta.js +0 -60
  63. package/build/bdd-framework/gen/testNode.js +0 -35
  64. package/build/bdd-framework/gen/testPoms.js +0 -133
  65. package/build/bdd-framework/hooks/scenario.js +0 -130
  66. package/build/bdd-framework/hooks/worker.js +0 -89
  67. package/build/bdd-framework/index.js +0 -52
  68. package/build/bdd-framework/playwright/fixtureParameterNames.js +0 -93
  69. package/build/bdd-framework/playwright/getLocationInFile.js +0 -79
  70. package/build/bdd-framework/playwright/loadConfig.js +0 -42
  71. package/build/bdd-framework/playwright/loadUtils.js +0 -33
  72. package/build/bdd-framework/playwright/testTypeImpl.js +0 -79
  73. package/build/bdd-framework/playwright/transform.js +0 -88
  74. package/build/bdd-framework/playwright/types.js +0 -12
  75. package/build/bdd-framework/playwright/utils.js +0 -56
  76. package/build/bdd-framework/reporter/cucumber/base.js +0 -52
  77. package/build/bdd-framework/reporter/cucumber/custom.js +0 -73
  78. package/build/bdd-framework/reporter/cucumber/helper.js +0 -12
  79. package/build/bdd-framework/reporter/cucumber/html.js +0 -40
  80. package/build/bdd-framework/reporter/cucumber/index.js +0 -74
  81. package/build/bdd-framework/reporter/cucumber/json.js +0 -312
  82. package/build/bdd-framework/reporter/cucumber/junit.js +0 -205
  83. package/build/bdd-framework/reporter/cucumber/message.js +0 -20
  84. package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +0 -82
  85. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +0 -197
  86. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +0 -43
  87. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +0 -52
  88. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +0 -105
  89. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +0 -70
  90. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +0 -45
  91. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +0 -27
  92. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +0 -38
  93. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +0 -128
  94. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +0 -154
  95. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +0 -123
  96. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +0 -67
  97. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +0 -114
  98. package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +0 -30
  99. package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwStepUtils.js +0 -70
  100. package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +0 -35
  101. package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +0 -5
  102. package/build/bdd-framework/run/StepInvoker.js +0 -69
  103. package/build/bdd-framework/run/bddData/index.js +0 -59
  104. package/build/bdd-framework/run/bddData/types.js +0 -5
  105. package/build/bdd-framework/run/bddFixtures.js +0 -192
  106. package/build/bdd-framework/run/bddWorld.js +0 -79
  107. package/build/bdd-framework/run/bddWorldInternal.js +0 -11
  108. package/build/bdd-framework/snippets/index.js +0 -132
  109. package/build/bdd-framework/snippets/snippetSyntax.js +0 -43
  110. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +0 -26
  111. package/build/bdd-framework/snippets/snippetSyntaxTs.js +0 -18
  112. package/build/bdd-framework/stepDefinitions/createBdd.js +0 -66
  113. package/build/bdd-framework/stepDefinitions/decorators/class.js +0 -68
  114. package/build/bdd-framework/stepDefinitions/decorators/steps.js +0 -99
  115. package/build/bdd-framework/stepDefinitions/defineStep.js +0 -62
  116. package/build/bdd-framework/stepDefinitions/stepConfig.js +0 -24
  117. package/build/bdd-framework/steps/createBdd.js +0 -78
  118. package/build/bdd-framework/steps/decorators/class.js +0 -68
  119. package/build/bdd-framework/steps/decorators/steps.js +0 -98
  120. package/build/bdd-framework/steps/defineStep.js +0 -62
  121. package/build/bdd-framework/steps/stepConfig.js +0 -24
  122. package/build/bdd-framework/utils/AutofillMap.js +0 -20
  123. package/build/bdd-framework/utils/exit.js +0 -62
  124. package/build/bdd-framework/utils/index.js +0 -93
  125. package/build/bdd-framework/utils/jsStringWrap.js +0 -44
  126. package/build/bdd-framework/utils/logger.js +0 -30
  127. package/build/bdd-framework/utils/stripAnsiEscapes.js +0 -20
  128. package/build/setup-folder-structure/samples/authUsers-sample.json +0 -9
  129. package/build/setup-folder-structure/samples/env-config-sample.json +0 -21
  130. package/npm-shrinkwrap.json +0 -6684
  131. package/unit_reports/unit-report.html +0 -260
@@ -10,8 +10,9 @@ var _path = _interopRequireDefault(require("path"));
10
10
  var _logger = require("../utils/logger");
11
11
  function getScriptsToBeAdded() {
12
12
  return {
13
- "uat": "ZDTestingFramework test --mode=prod --headed",
14
- "uat-debug": "ZDTestingFramework test --mode=prod --debug",
13
+ "uat": "ZDTestingFramework test --mode=dev --headed",
14
+ "uat-debug": "ZDTestingFramework test --mode=dev --debug",
15
+ "uat-validate": "ZDTestingFramework validate",
15
16
  "uat-report": "ZDTestingFramework report --port=9009",
16
17
  "codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
17
18
  };
@@ -71,8 +72,11 @@ function createAuthenticationFile() {
71
72
  });
72
73
  }
73
74
  (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
74
- (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
75
75
  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
76
+ (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'accountLogin.js'), getSetupFileAsString('accountLogin-sample.js'), null, 2);
77
+ _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating login script File ....');
78
+ (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'testSetup.js'), getSetupFileAsString('testSetup-sample.js'), null, 2);
79
+ _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating testSetup File ....');
76
80
  } catch (err) {
77
81
  _logger.Logger.error(err);
78
82
  _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
@@ -84,8 +88,21 @@ function createAuthenticationFile() {
84
88
  function createConfigJson() {
85
89
  const uatFolder = _path.default.resolve(process.cwd(), 'uat');
86
90
  if ((0, _fs.existsSync)(uatFolder)) {
87
- _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating env-config file inside UAT Folder');
88
- (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, './env-config.json'), getSetupFileAsString('env-config-sample.json'), null, 2);
91
+ _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
92
+ if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
93
+ (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
94
+ recursive: true
95
+ });
96
+ }
97
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
98
+ if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
99
+ (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
100
+ recursive: true
101
+ });
102
+ }
103
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
104
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
105
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
89
106
  } else {
90
107
  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
91
108
  }
@@ -2,7 +2,6 @@
2
2
 
3
3
  var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
4
  var _tagProcessor = _interopRequireDefault(require("../../../../../src/core/playwright/tagProcessor"));
5
- var _Configuration = _interopRequireDefault(require("../../../../../src/core/playwright/configuration/Configuration.js"));
6
5
  var _logger = require("../../../../utils/logger");
7
6
  jest.mock('../../../../utils/logger');
8
7
  describe('TagProcessor', () => {
@@ -12,83 +11,83 @@ describe('TagProcessor', () => {
12
11
  });
13
12
  test('should return tagArgs if no edition is provided', () => {
14
13
  const tagProcessor = new _tagProcessor.default(editionOrder);
15
- const userArgs = new _Configuration.default({
14
+ const userArgs = {
16
15
  tags: 'tag1',
17
16
  edition: null
18
- });
17
+ };
19
18
  const result = tagProcessor.processTags(userArgs);
20
19
  expect(result).toBe('tag1');
21
20
  });
22
21
  test('should handle a single edition with <= operator', () => {
23
22
  const tagProcessor = new _tagProcessor.default(editionOrder);
24
- const userArgs = new _Configuration.default({
23
+ const userArgs = {
25
24
  tags: 'tag1',
26
25
  edition: '<=edition2'
27
- });
26
+ };
28
27
  const result = tagProcessor.processTags(userArgs);
29
28
  expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
30
29
  });
31
30
  test('should handle a single edition with >= operator', () => {
32
31
  const tagProcessor = new _tagProcessor.default(editionOrder);
33
- const userArgs = new _Configuration.default({
32
+ const userArgs = {
34
33
  tags: 'tag1',
35
34
  edition: '>=edition2'
36
- });
35
+ };
37
36
  const result = tagProcessor.processTags(userArgs);
38
37
  expect(result).toBe('tag1 and not (@edition_edition1)');
39
38
  });
40
39
  test('should handle a single edition with < operator', () => {
41
40
  const tagProcessor = new _tagProcessor.default(editionOrder);
42
- const userArgs = new _Configuration.default({
41
+ const userArgs = {
43
42
  tags: 'tag1',
44
43
  edition: '<edition3'
45
- });
44
+ };
46
45
  const result = tagProcessor.processTags(userArgs);
47
46
  expect(result).toBe('tag1 and not (@edition_edition3 or @edition_edition4)');
48
47
  });
49
48
  test('should handle a single edition with > operator', () => {
50
49
  const tagProcessor = new _tagProcessor.default(editionOrder);
51
- const userArgs = new _Configuration.default({
50
+ const userArgs = {
52
51
  tags: 'tag1',
53
52
  edition: '>edition1'
54
- });
53
+ };
55
54
  const result = tagProcessor.processTags(userArgs);
56
55
  expect(result).toBe('tag1 and not (@edition_edition1)');
57
56
  });
58
57
  test('should handle a single edition with no operator', () => {
59
58
  const tagProcessor = new _tagProcessor.default(editionOrder);
60
- const userArgs = new _Configuration.default({
59
+ const userArgs = {
61
60
  tags: 'tag1',
62
61
  edition: 'edition2'
63
- });
62
+ };
64
63
  const result = tagProcessor.processTags(userArgs);
65
64
  expect(result).toBe('tag1 and not (@edition_edition1 or @edition_edition3 or @edition_edition4)');
66
65
  });
67
66
  test('should log a message if edition is not found', () => {
68
67
  const tagProcessor = new _tagProcessor.default(editionOrder);
69
- const userArgs = new _Configuration.default({
68
+ const userArgs = {
70
69
  tags: 'tag1',
71
70
  edition: 'nonexistentEdition'
72
- });
71
+ };
73
72
  const result = tagProcessor.processTags(userArgs);
74
73
  expect(result).toBe('tag1');
75
74
  expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.INFO_TYPE, expect.stringContaining('No matching editions for nonexistentEdition found.'));
76
75
  });
77
76
  test('should handle multiple editions', () => {
78
77
  const tagProcessor = new _tagProcessor.default(editionOrder);
79
- const userArgs = new _Configuration.default({
78
+ const userArgs = {
80
79
  tags: 'tag1',
81
80
  edition: 'edition1,edition3'
82
- });
81
+ };
83
82
  const result = tagProcessor.processTags(userArgs);
84
83
  expect(result).toBe('tag1 and not (@edition_edition2 or @edition_edition4)');
85
84
  });
86
85
  test('should build tags correctly when tags are empty', () => {
87
86
  const tagProcessor = new _tagProcessor.default(editionOrder);
88
- const userArgs = new _Configuration.default({
87
+ const userArgs = {
89
88
  tags: '',
90
89
  edition: 'edition1'
91
- });
90
+ };
92
91
  const result = tagProcessor.processTags(userArgs);
93
92
  expect(result).toBe('not (@edition_edition2 or @edition_edition3 or @edition_edition4)');
94
93
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zohodesk/testinglibrary",
3
- "version": "0.4.36-experimental",
3
+ "version": "0.4.38-experimental",
4
4
  "description": "",
5
5
  "main": "./build/index.js",
6
6
  "scripts": {
@@ -22,8 +22,9 @@
22
22
  "license": "ISC",
23
23
  "dependencies": {
24
24
  "@babel/preset-react": "7.22.5",
25
- "@cucumber/cucumber": "9.2.0",
26
- "@playwright/test": "1.42.1",
25
+ "@cucumber/cucumber": "11.2.0",
26
+ "@playwright/test": "1.49.1",
27
+ "@reportportal/agent-js-playwright": "5.1.11",
27
28
  "@testing-library/jest-dom": "5.11.9",
28
29
  "@testing-library/react": "11.2.7",
29
30
  "@testing-library/react-hooks": "7.0.2",
@@ -33,17 +34,18 @@
33
34
  "jest": "29.6.2",
34
35
  "jest-environment-jsdom": "29.6.2",
35
36
  "msw": "1.2.3",
36
- "playwright": "1.42.1",
37
- "proper-lockfile": "4.1.2",
38
- "supports-color": "8.1.1"
37
+ "playwright": "1.49.1",
38
+ "supports-color": "8.1.1",
39
+ "playwright-bdd": "8.0.1",
40
+ "proper-lockfile": "4.1.2"
39
41
  },
40
42
  "bin": {
41
43
  "ZDTestingFramework": "./bin/cli.js"
42
44
  },
43
45
  "peerDependencies": {
46
+ "eslint": "*",
44
47
  "react": "*",
45
- "react-dom": "*",
46
- "eslint": "*"
48
+ "react-dom": "*"
47
49
  },
48
50
  "devDependencies": {
49
51
  "@babel/cli": "7.22.15",
@@ -54,7 +56,6 @@
54
56
  "@babel/preset-env": "7.22.15",
55
57
  "@babel/runtime": "7.22.15",
56
58
  "commander": "11.0.0",
57
- "jest-html-reporter": "3.10.2",
58
- "typescript": "5.4.2"
59
+ "jest-html-reporter": "3.10.2"
59
60
  }
60
61
  }
@@ -3,45 +3,23 @@ const { defineConfig, devices } = require('@playwright/test');
3
3
  const path = require('path');
4
4
  const numCPUs = require('os').cpus().length;
5
5
 
6
- /**
7
- * Read environment variables from file.
8
- * https://github.com/motdotla/dotenv
9
- */
10
- // require('dotenv').config();
11
-
12
- /**
13
- * @see https://playwright.dev/docs/test-configuration
14
- */
15
6
  export default defineConfig({
16
7
  testDir: path.join(path.resolve(process.cwd()), 'uat'),
17
8
  outputDir: path.join(process.cwd(), 'uat', 'test-results'),
18
- /* Run tests in files in parallel */
19
9
  fullyParallel: true,
20
- /* Fail the build on CI if you accidentally left test.only in the source code. */
21
- //forbidOnly: !!process.env.CI,
22
- /* Retry on CI only */
23
10
  retries: process.env.CI ? 2 : 0,
24
- /* Reporter to use. See https://playwright.dev/docs/test-reporters */
25
11
  reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', 'playwright-report'), open: "always" }]],
26
12
  timeout: 60 * 1000,
27
13
  expect: {
28
14
  timeout: 5 * 1000,
29
15
  },
30
-
31
- /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
32
16
  use: {
33
- /* Base URL to use in actions like `await page.goto('/')`. */
34
- //baseURL: process.env.domain,
35
-
36
- /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
37
17
  trace: 'on',
38
18
  video: {
39
19
  mode: 'on',
40
20
  size: { width: 640, height: 480 }
41
21
  }
42
22
  },
43
-
44
- /* Configure projects for major browsers */
45
23
  projects: [
46
24
  { name: 'setup', testMatch: /.*\.setup\.js/ },
47
25
  {
@@ -79,32 +57,6 @@ export default defineConfig({
79
57
  dependencies: ['setup'],
80
58
  },
81
59
 
82
- /* Test against mobile viewports. */
83
- // {
84
- // name: 'Mobile Chrome',
85
- // use: { ...devices['Pixel 5'] },
86
- // },
87
- // {
88
- // name: 'Mobile Safari',
89
- // use: { ...devices['iPhone 12'] },
90
- // },
91
-
92
- /* Test against branded browsers. */
93
- // {
94
- // name: 'Microsoft Edge',
95
- // use: { ...devices['Desktop Edge'], channel: 'msedge' },
96
- // },
97
- // {
98
- // name: 'Google Chrome',
99
- // use: { ...devices['Desktop Chrome'], channel: 'chrome' },
100
- // },
101
60
  ],
102
-
103
- /* Run your local dev server before starting the tests */
104
- // webServer: {
105
- // command: 'npm run start',
106
- // url: 'http://127.0.0.1:3000',
107
- // reuseExistingServer: !process.env.CI,
108
- // },
109
61
  });
110
62
 
@@ -1,42 +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.envCommand = void 0;
8
- exports.getOwnVersion = getOwnVersion;
9
- var _commander = require("commander");
10
- var _options = require("../options");
11
- var _path = _interopRequireDefault(require("path"));
12
- var _logger = require("../../utils/logger");
13
- var _utils = require("../../utils");
14
- var _loadConfig = require("../../playwright/loadConfig");
15
- const logger = new _logger.Logger({
16
- verbose: true
17
- });
18
- const envCommand = exports.envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
19
- logger.log(`Playwright-bdd environment info:\n`);
20
- logger.log(`platform: ${process.platform}`);
21
- logger.log(`node: ${process.version}`);
22
- showPackageVersion('playwright-bdd');
23
- showPackageVersion('@playwright/test');
24
- showPackageVersion('@cucumber/cucumber');
25
- showPlaywrightConfigPath(opts.config);
26
- });
27
- function showPackageVersion(packageName) {
28
- const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
29
- logger.log(`${packageName}: v${version}`);
30
- }
31
- /**
32
- * Getting own version by relative path instead of using getPackageVersion(),
33
- * to aneble using directly from /dist in tests.
34
- */
35
- function getOwnVersion() {
36
- return '6.1.1';
37
- }
38
- function showPlaywrightConfigPath(cliConfigPath) {
39
- const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
40
- const relPath = _path.default.relative(process.cwd(), resolvedConfigFile);
41
- logger.log(`Playwright config file: ${relPath}`);
42
- }
@@ -1,62 +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.exportCommand = void 0;
8
- var _path = _interopRequireDefault(require("path"));
9
- var _commander = require("commander");
10
- var _options = require("../options");
11
- var _loadConfig = require("../../playwright/loadConfig");
12
- var _logger = require("../../utils/logger");
13
- var _env = require("../../config/env");
14
- var _test = require("./test");
15
- var _gen = require("../../gen");
16
- const logger = new _logger.Logger({
17
- verbose: true
18
- });
19
- const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints step definitions').addOption(_options.configOption).option('--unused-steps', 'Output only unused steps').action(async opts => {
20
- const {
21
- resolvedConfigFile
22
- } = await (0, _loadConfig.loadConfig)(opts.config);
23
- logger.log(`Using config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}`);
24
- const configs = Object.values((0, _env.getEnvConfigs)());
25
- (0, _test.assertConfigsCount)(configs);
26
- if (opts.unusedSteps) {
27
- await showUnusedStepsForConfigs(configs);
28
- } else {
29
- await showStepsForConfigs(configs);
30
- }
31
- });
32
- async function showStepsForConfigs(configs) {
33
- // here we don't need workers (as in test command) because if some step files
34
- // are already in node cache, we collected them.
35
- const steps = new Set();
36
- const tasks = configs.map(async config => {
37
- const stepDefinitions = await new _gen.TestFilesGenerator(config).extractSteps();
38
- stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
39
- });
40
- await Promise.all(tasks);
41
- logger.log(`List of all steps (${steps.size}):`);
42
- steps.forEach(stepText => logger.log(stepText));
43
- }
44
- async function showUnusedStepsForConfigs(configs) {
45
- const steps = new Set();
46
- const tasks = configs.map(async config => {
47
- const stepDefinitions = await new _gen.TestFilesGenerator(config).extractUnusedSteps();
48
- stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
49
- });
50
- await Promise.all(tasks);
51
- logger.log(`List of unused steps (${steps.size}):`);
52
- steps.forEach(stepText => logger.log(stepText));
53
- }
54
- function getStepText({
55
- pattern,
56
- keyword
57
- }) {
58
- // for Unknown return When as it looks the most suitable
59
- const keywordText = keyword === 'Unknown' ? 'When' : keyword;
60
- const patternText = typeof pattern === 'string' ? pattern : pattern.source;
61
- return `${keywordText} ${patternText}`;
62
- }
@@ -1,64 +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.assertConfigsCount = assertConfigsCount;
8
- exports.testCommand = void 0;
9
- var _worker_threads = require("worker_threads");
10
- var _events = require("events");
11
- var _path = _interopRequireDefault(require("path"));
12
- var _commander = require("commander");
13
- var _gen = require("../../gen");
14
- var _loadConfig = require("../../playwright/loadConfig");
15
- var _env = require("../../config/env");
16
- var _config = require("../../config");
17
- var _options = require("../options");
18
- var _exit = require("../../utils/exit");
19
- const GEN_WORKER_PATH = _path.default.resolve(__dirname, '..', 'worker.js');
20
- const testCommand = exports.testCommand = new _commander.Command('test').description('Generate Playwright test files from Gherkin documents').addOption(_options.configOption).option('--tags <expression>', `Tags expression to filter scenarios for generation`).option('--verbose', `Verbose mode (default: ${Boolean(_config.defaults.verbose)})`).action(async opts => {
21
- await (0, _loadConfig.loadConfig)(opts.config);
22
- const configs = readConfigsFromEnv();
23
- mergeCliOptions(configs, opts);
24
- await generateFilesForConfigs(configs);
25
- });
26
- function readConfigsFromEnv() {
27
- const configs = Object.values((0, _env.getEnvConfigs)());
28
- assertConfigsCount(configs);
29
- return configs;
30
- }
31
- function mergeCliOptions(configs, opts) {
32
- configs.forEach(config => {
33
- if ('tags' in opts) {
34
- config.tags = opts.tags;
35
- }
36
- if ('verbose' in opts) {
37
- config.verbose = Boolean(opts.verbose);
38
- }
39
- });
40
- }
41
- function assertConfigsCount(configs) {
42
- if (configs.length === 0) {
43
- (0, _exit.exit)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
44
- }
45
- }
46
- async function generateFilesForConfigs(configs) {
47
- // run first config in main thread and other in workers (to have fresh require cache)
48
- // See: https://github.com/vitalets/playwright-bdd/issues/32
49
- const tasks = configs.map((config, index) => {
50
- return index === 0 ? new _gen.TestFilesGenerator(config).generate() : runInWorker(config);
51
- });
52
- return Promise.all(tasks);
53
- }
54
- async function runInWorker(config) {
55
- const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
56
- workerData: {
57
- config
58
- }
59
- });
60
- const [exitCode] = await (0, _events.once)(worker, 'exit');
61
- if (exitCode) {
62
- (0, _exit.exit)();
63
- }
64
- }
@@ -1,11 +0,0 @@
1
- #!/usr/bin/env node
2
- "use strict";
3
-
4
- var _commander = require("commander");
5
- var _test = require("./commands/test");
6
- var _env = require("./commands/env");
7
- var _export = require("./commands/export");
8
- const program = new _commander.Command();
9
- program.name('bddgen').description(`Playwright-bdd CLI v${(0, _env.getOwnVersion)()}`).addCommand(_test.testCommand, {
10
- isDefault: true
11
- }).addCommand(_export.exportCommand).addCommand(_env.envCommand).addHelpCommand(false).parse();
@@ -1,19 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.configOption = void 0;
7
- exports.getCliConfigPath = getCliConfigPath;
8
- var _commander = require("commander");
9
- /**
10
- * Config option moved to separate file as it used in test run.
11
- */
12
-
13
- const configOption = exports.configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
14
- /**
15
- * Helper used in test run to detect config location.
16
- */
17
- function getCliConfigPath() {
18
- return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');
19
- }
@@ -1,13 +0,0 @@
1
- "use strict";
2
-
3
- var _worker_threads = require("worker_threads");
4
- var _gen = require("../gen");
5
- /**
6
- * Worker to generate test files with fresh require/import cache
7
- * See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
8
- */
9
-
10
- async function main() {
11
- await new _gen.TestFilesGenerator(_worker_threads.workerData.config).generate();
12
- }
13
- main();
@@ -1,35 +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.getPlaywrightConfigDir = getPlaywrightConfigDir;
8
- var _path = _interopRequireDefault(require("path"));
9
- var _loadConfig = require("../playwright/loadConfig");
10
- var _options = require("../cli/options");
11
- /**
12
- * Store playwright config dir in env to provide access to it in workers.
13
- * Important that in workers there is different process.argv, that's why we save it to env.
14
- * Config dir is needed to resolve all paths (features, step definitions).
15
- */
16
-
17
- /**
18
- * Returns Playwright config dir considering cli --config option.
19
- */
20
- function getPlaywrightConfigDir({
21
- resolveAndSave = false
22
- } = {}) {
23
- let configDir = process.env.PLAYWRIGHT_BDD_CONFIG_DIR;
24
- if (!configDir) {
25
- if (resolveAndSave) {
26
- const cliConfigPath = (0, _options.getCliConfigPath)();
27
- const playwrightConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
28
- configDir = playwrightConfigFile ? _path.default.dirname(playwrightConfigFile) : process.cwd();
29
- process.env.PLAYWRIGHT_BDD_CONFIG_DIR = configDir;
30
- } else {
31
- throw new Error(`Something went wrong: PLAYWRIGHT_BDD_CONFIG_DIR is not set.`);
32
- }
33
- }
34
- return configDir;
35
- }
@@ -1,23 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.enableEnrichReporterData = enableEnrichReporterData;
7
- exports.getEnrichReporterData = getEnrichReporterData;
8
- function enableEnrichReporterData() {
9
- process.env.PLAYWRIGHT_BDD_ENRICH_REPORTER_DATA = '1';
10
- }
11
- function getEnrichReporterData(config) {
12
- const enrichReporterDataFromEnv = Boolean(process.env.PLAYWRIGHT_BDD_ENRICH_REPORTER_DATA);
13
- if (config.enrichReporterData === true) {
14
- return true;
15
- }
16
- if (config.enrichReporterData === false) {
17
- if (enrichReporterDataFromEnv) {
18
- throw new Error([`Cucumber reports can't work with enrichReporterData = false in bdd config.`, `Please, set enrichReporterData = true OR remove it from config`, `to let it be auto-configured.`].join(' '));
19
- }
20
- return false;
21
- }
22
- return enrichReporterDataFromEnv;
23
- }
@@ -1,50 +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.getConfigFromEnv = getConfigFromEnv;
8
- exports.getEnvConfigs = getEnvConfigs;
9
- exports.saveConfigToEnv = saveConfigToEnv;
10
- var _path = _interopRequireDefault(require("path"));
11
- var _exit = require("../utils/exit");
12
- /**
13
- * Storing configs in env var PLAYWRIGHT_BDD_CONFIGS as JSON-stringified values.
14
- * For passing configs to playwright workers and bddgen.
15
- */
16
-
17
- function saveConfigToEnv(config) {
18
- const envConfigs = getEnvConfigs();
19
- const existingConfig = envConfigs[config.outputDir];
20
- if (existingConfig) {
21
- // Playwright config can be evaluated several times.
22
- // Throw error only if different calls of defineBddConfig() use the same outputDir.
23
- // See: https://github.com/vitalets/playwright-bdd/issues/39#issuecomment-1653805368
24
- if (!isSameConfigs(config, existingConfig)) {
25
- (0, _exit.exit)(`When using several calls of defineBddConfig()`, `please manually provide different "outputDir" option.`);
26
- }
27
- return;
28
- }
29
- envConfigs[config.outputDir] = config;
30
- saveEnvConfigs(envConfigs);
31
- }
32
- function getConfigFromEnv(outputDir) {
33
- const envConfigs = getEnvConfigs();
34
- outputDir = _path.default.resolve(outputDir);
35
- const config = envConfigs[outputDir];
36
- if (!config) {
37
- // exit(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
38
- return {};
39
- }
40
- return config;
41
- }
42
- function getEnvConfigs() {
43
- return JSON.parse(process.env.PLAYWRIGHT_BDD_CONFIGS || '{}');
44
- }
45
- function saveEnvConfigs(envConfigs) {
46
- process.env.PLAYWRIGHT_BDD_CONFIGS = JSON.stringify(envConfigs);
47
- }
48
- function isSameConfigs(config1, config2) {
49
- return JSON.stringify(config1) === JSON.stringify(config2);
50
- }