@zohodesk/testinglibrary 2.9.2 → 3.0.2

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 (122) hide show
  1. package/.gitlab-ci.yml +1 -1
  2. package/README.md +27 -1
  3. package/build/core/playwright/fixtures.js +24 -0
  4. package/build/core/playwright/index.js +10 -23
  5. package/build/core/playwright/setup/config-creator.js +3 -3
  6. package/build/core/playwright/setup/config-utils.js +8 -25
  7. package/build/core/playwright/test-runner.js +1 -1
  8. package/build/decorators.d.ts +1 -1
  9. package/build/decorators.js +1 -1
  10. package/build/setup-folder-structure/samples/actors-index.js +2 -0
  11. package/build/setup-folder-structure/samples/auth-setup-sample.js +14 -66
  12. package/build/setup-folder-structure/samples/editions-index.js +3 -0
  13. package/build/setup-folder-structure/samples/free-sample.json +25 -0
  14. package/build/setup-folder-structure/samples/settings.json +7 -0
  15. package/build/setup-folder-structure/setupProject.js +18 -5
  16. package/nobdd/uat/conf/nobdd/uat.config.js +1 -2
  17. package/nobdd/uat.config.js +1 -2
  18. package/package.json +7 -7
  19. package/build/bdd-framework/cli/commands/env.js +0 -42
  20. package/build/bdd-framework/cli/commands/export.js +0 -62
  21. package/build/bdd-framework/cli/commands/test.js +0 -64
  22. package/build/bdd-framework/cli/index.js +0 -11
  23. package/build/bdd-framework/cli/options.js +0 -19
  24. package/build/bdd-framework/cli/worker.js +0 -13
  25. package/build/bdd-framework/config/configDir.js +0 -35
  26. package/build/bdd-framework/config/enrichReporterData.js +0 -23
  27. package/build/bdd-framework/config/env.js +0 -50
  28. package/build/bdd-framework/config/index.js +0 -94
  29. package/build/bdd-framework/config/lang.js +0 -14
  30. package/build/bdd-framework/cucumber/buildStepDefinition.js +0 -43
  31. package/build/bdd-framework/cucumber/createTestStep.js +0 -43
  32. package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +0 -126
  33. package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +0 -72
  34. package/build/bdd-framework/cucumber/formatter/PickleParser.js +0 -25
  35. package/build/bdd-framework/cucumber/formatter/durationHelpers.js +0 -13
  36. package/build/bdd-framework/cucumber/formatter/getColorFns.js +0 -57
  37. package/build/bdd-framework/cucumber/formatter/index.js +0 -16
  38. package/build/bdd-framework/cucumber/formatter/locationHelpers.js +0 -16
  39. package/build/bdd-framework/cucumber/loadConfig.js +0 -17
  40. package/build/bdd-framework/cucumber/loadFeatures.js +0 -70
  41. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +0 -20
  42. package/build/bdd-framework/cucumber/loadSteps.js +0 -47
  43. package/build/bdd-framework/cucumber/resolveFeaturePaths.js +0 -62
  44. package/build/bdd-framework/cucumber/stepArguments.js +0 -21
  45. package/build/bdd-framework/cucumber/types.js +0 -5
  46. package/build/bdd-framework/cucumber/valueChecker.js +0 -23
  47. package/build/bdd-framework/decorators.js +0 -18
  48. package/build/bdd-framework/gen/fixtures.js +0 -48
  49. package/build/bdd-framework/gen/formatter.js +0 -167
  50. package/build/bdd-framework/gen/i18n.js +0 -39
  51. package/build/bdd-framework/gen/index.js +0 -197
  52. package/build/bdd-framework/gen/specialTags.js +0 -70
  53. package/build/bdd-framework/gen/testFile.js +0 -470
  54. package/build/bdd-framework/gen/testMeta.js +0 -60
  55. package/build/bdd-framework/gen/testNode.js +0 -35
  56. package/build/bdd-framework/gen/testPoms.js +0 -133
  57. package/build/bdd-framework/hooks/scenario.js +0 -130
  58. package/build/bdd-framework/hooks/worker.js +0 -89
  59. package/build/bdd-framework/index.js +0 -52
  60. package/build/bdd-framework/playwright/fixtureParameterNames.js +0 -93
  61. package/build/bdd-framework/playwright/getLocationInFile.js +0 -79
  62. package/build/bdd-framework/playwright/loadConfig.js +0 -42
  63. package/build/bdd-framework/playwright/loadUtils.js +0 -33
  64. package/build/bdd-framework/playwright/testTypeImpl.js +0 -79
  65. package/build/bdd-framework/playwright/transform.js +0 -88
  66. package/build/bdd-framework/playwright/types.js +0 -12
  67. package/build/bdd-framework/playwright/utils.js +0 -56
  68. package/build/bdd-framework/reporter/cucumber/base.js +0 -52
  69. package/build/bdd-framework/reporter/cucumber/custom.js +0 -73
  70. package/build/bdd-framework/reporter/cucumber/helper.js +0 -12
  71. package/build/bdd-framework/reporter/cucumber/html.js +0 -40
  72. package/build/bdd-framework/reporter/cucumber/index.js +0 -74
  73. package/build/bdd-framework/reporter/cucumber/json.js +0 -312
  74. package/build/bdd-framework/reporter/cucumber/junit.js +0 -205
  75. package/build/bdd-framework/reporter/cucumber/message.js +0 -20
  76. package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +0 -82
  77. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +0 -197
  78. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +0 -43
  79. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +0 -52
  80. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +0 -105
  81. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +0 -70
  82. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +0 -45
  83. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +0 -27
  84. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +0 -38
  85. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +0 -128
  86. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +0 -154
  87. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +0 -123
  88. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +0 -67
  89. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +0 -114
  90. package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +0 -30
  91. package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwStepUtils.js +0 -70
  92. package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +0 -35
  93. package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +0 -5
  94. package/build/bdd-framework/run/StepInvoker.js +0 -69
  95. package/build/bdd-framework/run/bddData/index.js +0 -59
  96. package/build/bdd-framework/run/bddData/types.js +0 -5
  97. package/build/bdd-framework/run/bddFixtures.js +0 -192
  98. package/build/bdd-framework/run/bddWorld.js +0 -79
  99. package/build/bdd-framework/run/bddWorldInternal.js +0 -11
  100. package/build/bdd-framework/snippets/index.js +0 -132
  101. package/build/bdd-framework/snippets/snippetSyntax.js +0 -43
  102. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +0 -26
  103. package/build/bdd-framework/snippets/snippetSyntaxTs.js +0 -18
  104. package/build/bdd-framework/stepDefinitions/createBdd.js +0 -66
  105. package/build/bdd-framework/stepDefinitions/decorators/class.js +0 -68
  106. package/build/bdd-framework/stepDefinitions/decorators/steps.js +0 -99
  107. package/build/bdd-framework/stepDefinitions/defineStep.js +0 -62
  108. package/build/bdd-framework/stepDefinitions/stepConfig.js +0 -24
  109. package/build/bdd-framework/steps/createBdd.js +0 -78
  110. package/build/bdd-framework/steps/decorators/class.js +0 -68
  111. package/build/bdd-framework/steps/decorators/steps.js +0 -98
  112. package/build/bdd-framework/steps/defineStep.js +0 -62
  113. package/build/bdd-framework/steps/stepConfig.js +0 -24
  114. package/build/bdd-framework/utils/AutofillMap.js +0 -20
  115. package/build/bdd-framework/utils/exit.js +0 -62
  116. package/build/bdd-framework/utils/index.js +0 -93
  117. package/build/bdd-framework/utils/jsStringWrap.js +0 -44
  118. package/build/bdd-framework/utils/logger.js +0 -30
  119. package/build/bdd-framework/utils/stripAnsiEscapes.js +0 -20
  120. package/build/setup-folder-structure/samples/authUsers-sample.json +0 -9
  121. package/build/setup-folder-structure/samples/env-config-sample.json +0 -21
  122. package/npm-shrinkwrap.json +0 -6475
package/.gitlab-ci.yml CHANGED
@@ -1,4 +1,4 @@
1
- image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
1
+ image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
2
2
 
3
3
  workflow:
4
4
  rules:
package/README.md CHANGED
@@ -26,13 +26,39 @@
26
26
  ### Bug fix
27
27
  - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution.
28
28
 
29
- ### v0.2.9 - 24-10-2024
29
+
30
+ ## Version History
31
+
32
+ ### v0.2.9 - 25-10-2024
30
33
 
31
34
  #### Feature
32
35
  - Added support for scenario level tag support
33
36
  - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
34
37
  - Mode based configuration implementations
35
38
  - @only option enabled in dev pipeline
39
+ - Latest setup related configuration changed for init option
40
+
41
+ ### v0.3.0 - 25-10-2024
42
+
43
+ #### Features
44
+ - Added support for scenario level tag support
45
+ - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
46
+ - Below package versions are updated in this release.
47
+ - playwright - 1.48.0,
48
+ - playwright-bdd - 7.5.0,
49
+ - @playwright/test - 1.48.0,
50
+ - @cucumber/cucumber - 11.0.1
51
+ - From this version, We adopt the playwright-bdd as library instead of modified source
52
+ - Published on 11-11-2024
53
+
54
+ #### Deprecations
55
+ - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
56
+ - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
57
+
58
+ ### v0.3.1 - 13-11-2024
59
+
60
+ #### Issue Fix
61
+ - Adding bddmode to get the fixtures.
36
62
 
37
63
  ### v0.2.9.1 - 14-11-2024
38
64
 
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ var _test = require("@playwright/test");
5
+ var _playwrightBdd = require("playwright-bdd");
6
+ var _readConfigFile = require("./readConfigFile");
7
+ var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
8
+ var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
9
+ const {
10
+ bddMode
11
+ } = (0, _readConfigFile.generateConfigFromFile)();
12
+ let base = bddMode ? _playwrightBdd.test : _test.test;
13
+ const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
14
+ const buildInFixturesTest = base.extend({
15
+ ...buildInFixtures
16
+ });
17
+ const userFixtures = (0, _getUserFixtures.default)();
18
+ const userFixturesTest = base.extend({
19
+ ...userFixtures
20
+ });
21
+ const test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
22
+ module.exports = {
23
+ test
24
+ };
@@ -1,37 +1,24 @@
1
1
  "use strict";
2
2
 
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
3
  Object.defineProperty(exports, "__esModule", {
5
4
  value: true
6
5
  });
7
- Object.defineProperty(exports, "createBdd", {
6
+ exports.createBdd = void 0;
7
+ Object.defineProperty(exports, "expect", {
8
8
  enumerable: true,
9
9
  get: function () {
10
- return _bddFramework.createBdd;
10
+ return _test.expect;
11
11
  }
12
12
  });
13
- Object.defineProperty(exports, "expect", {
13
+ Object.defineProperty(exports, "test", {
14
14
  enumerable: true,
15
15
  get: function () {
16
- return _test.expect;
16
+ return _playwrightBdd.test;
17
17
  }
18
18
  });
19
- exports.test = void 0;
20
- var _bddFramework = require("../../bdd-framework");
19
+ var _playwrightBdd = require("playwright-bdd");
21
20
  var _test = require("@playwright/test");
22
- var _readConfigFile = require("./readConfigFile");
23
- var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
24
- var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
25
- const {
26
- bddMode
27
- } = (0, _readConfigFile.generateConfigFromFile)();
28
- let base = bddMode ? _bddFramework.test : _test.test;
29
- const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
30
- const buildInFixturesTest = base.extend({
31
- ...buildInFixtures
32
- });
33
- const userFixtures = (0, _getUserFixtures.default)();
34
- const userFixturesTest = base.extend({
35
- ...userFixtures
36
- });
37
- const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);
21
+ let createBdd = function () {
22
+ return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
23
+ };
24
+ exports.createBdd = createBdd;
@@ -39,12 +39,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
39
39
  featureFilesFolder,
40
40
  stepDefinitionsFolder
41
41
  });
42
- const testOptions = (0, _configUtils.getTestUseOptions)({
42
+ const use = {
43
43
  trace,
44
44
  video,
45
45
  viewport,
46
46
  testIdAttribute
47
- });
47
+ };
48
48
 
49
49
  /**
50
50
  * Playwright configuration object
@@ -65,7 +65,7 @@ function getPlaywrightConfig() {
65
65
  expect: {
66
66
  timeout: expectTimeout
67
67
  },
68
- use: testOptions,
68
+ use,
69
69
  projects: isAuthMode ? [{
70
70
  name: 'setup',
71
71
  testMatch: /.*\.setup\.js/,
@@ -7,14 +7,12 @@ Object.defineProperty(exports, "__esModule", {
7
7
  exports.getBrowsersList = getBrowsersList;
8
8
  exports.getProjects = getProjects;
9
9
  exports.getTestDir = getTestDir;
10
- exports.getTestUseOptions = getTestUseOptions;
11
10
  var _test = require("@playwright/test");
12
11
  var _path = _interopRequireDefault(require("path"));
13
12
  var _readConfigFile = require("../readConfigFile");
14
- var _bddFramework = require("../../../bdd-framework");
13
+ var _playwrightBdd = require("playwright-bdd");
15
14
  var _logger = require("../../../utils/logger");
16
15
  var _browserTypes = require("../constants/browserTypes");
17
- var _configFileNameProvider = require("../helpers/configFileNameProvider");
18
16
  var _fileUtils = require("../../../utils/fileUtils");
19
17
  /**
20
18
  ** Playwright project configuration
@@ -148,30 +146,15 @@ function getPathsForFeatureFiles(cwd) {
148
146
  function getTestDir(bddMode, cwd, {
149
147
  stepDefinitionsFolder
150
148
  }) {
151
- return bddMode ? (0, _bddFramework.defineBddConfig)({
152
- paths: getPathsForFeatureFiles(cwd),
153
- import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
149
+ return bddMode ? (0, _playwrightBdd.defineBddConfig)({
150
+ features: getPathsForFeatureFiles(cwd),
151
+ steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
152
+ importTestFrom: require.resolve('../fixtures.js'),
154
153
  featuresRoot: _path.default.join(cwd, 'uat'),
155
154
  outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
155
+ disableWarnings: {
156
+ importTestFrom: true
157
+ },
156
158
  publish: true
157
159
  }) : _path.default.join(cwd, 'uat');
158
- }
159
- function getTestUseOptions({
160
- viewport,
161
- trace,
162
- video,
163
- testIdAttribute
164
- }) {
165
- let defaultTestuseOptions = {
166
- viewport,
167
- testIdAttribute,
168
- trace: trace ? 'on' : 'off',
169
- video: video ? {
170
- mode: 'on',
171
- size: {
172
- ...viewport
173
- }
174
- } : 'off'
175
- };
176
- return defaultTestuseOptions;
177
160
  }
@@ -43,7 +43,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
43
43
  }
44
44
  function runPreprocessing(tagArgs, configPath) {
45
45
  const beforeCommand = 'node';
46
- const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
46
+ const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
47
47
  const beforeArgs = [bddGenPath, '-c', configPath];
48
48
  if (tagArgs) {
49
49
  beforeArgs.push('--tags');
@@ -1 +1 @@
1
- export * from './bdd-framework/decorators';
1
+ export * from 'playwright-bdd/decorators';
@@ -3,7 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- var _decorators = require("./bdd-framework/decorators");
6
+ var _decorators = require("playwright-bdd/decorators");
7
7
  Object.keys(_decorators).forEach(function (key) {
8
8
  if (key === "default" || key === "__esModule") return;
9
9
  if (key in exports && exports[key] === _decorators[key]) return;
@@ -0,0 +1,2 @@
1
+ const editions = require('./editions/index');
2
+ module.exports = { editions }
@@ -1,73 +1,21 @@
1
1
  /* eslint-disable no-console */
2
2
  import { test as setup, expect } from '@zohodesk/testinglibrary';
3
- import path from 'path';
4
- import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
5
- import { getAuthFileDirectory } from '../../core/playwright';
6
- import { Logger } from '../../utils/logger';
3
+ import {
4
+ performLoginSteps,
5
+ getDefaultActor
6
+ } from '@zohodesk/testinglibrary/helpers';
7
7
 
8
- const userdata = require('./authUsers.json');
8
+ const user = getDefaultActor();
9
9
 
10
- const authContent = { cookies: [] };
11
-
12
- const LOGIN_ERR_MESSAGE = 'Need go be logged in';
13
- // const AUTH_ERR_MESSAGE = `Founded Path - ${path.resolve(process.cwd(),'uat','playwright','.auth')} \n Find if file is Properly Created. Cookies Cannot Be Read .. `
14
-
15
- function convertCookiesToParse(cookies, authFilePath) {
16
- try {
17
- return JSON.parse(cookies);
18
- } catch (err) {
19
- Logger.error(err);
20
- throw new Error(
21
- ` Error while parsing cookies ${err} \n${path.resolve(
22
- process.cwd(),
23
- authFilePath
24
- )} File is Empty`
25
- );
26
- // process.exit()
27
- }
28
- }
29
- const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
30
- if (!existsSync(authDirectory)) {
31
- console.log('Creating auth directory for the first time setup...');
32
- mkdirSync(authDirectory, { recursive: true });
10
+ async function verifyPageIsLoaded(page) {
11
+ //Implement your validation steps here
12
+ //Refer desk_client_app auth.setup.js
13
+ return true;
33
14
  }
34
15
 
35
- userdata.forEach(data => {
36
- const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
37
- if (!existsSync(authFile)) {
38
- console.log('creating auth file..');
39
- writeFileSync(authFile, JSON.stringify(authContent, null, 2));
40
- }
41
- setup(data.description, async ({ page }) => {
42
- try {
43
- const cookies = readFileSync(authFile);
44
- const parsedCookies = convertCookiesToParse(cookies, authFile);
45
- await page
46
- .context()
47
- .addCookies(
48
- parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
49
- );
50
- await page.goto(page.getBaseUrl());
51
- await page.waitForLoadState();
52
- if (await page.url().includes(process.env.domain)) {
53
- await page.waitForSelector(data.locator);
54
- } else {
55
- throw new Error(LOGIN_ERR_MESSAGE);
56
- }
57
- } catch (err) {
58
- if (err.message === LOGIN_ERR_MESSAGE) {
59
- await expect(page.locator('.load-bg')).toBeHidden();
60
- await page.locator('#login_id').type(data.useremail);
61
- await page.locator('#nextbtn').click();
62
- await page.locator('#password').type(data.password);
63
- await page.locator('#nextbtn').click();
64
-
65
- await page.waitForLoadState('networkidle');
66
-
67
- await page.waitForSelector(data.locator);
16
+ setup(`${user.edition} - Authentication`, async ({ page }) => {
68
17
 
69
- await page.context().storageState({ path: authFile });
70
- }
71
- }
72
- });
73
- });
18
+ //Implement performLoginSteps here
19
+ const { email, password } = user;
20
+ await performLoginSteps({ },verifyPageIsLoaded );
21
+ });
@@ -0,0 +1,3 @@
1
+ const free = require('./free.json');
2
+ const editions = { free};
3
+ module.exports = editions;
@@ -0,0 +1,25 @@
1
+ [
2
+ {
3
+ "id": "1",
4
+ "edition": "free",
5
+ "orgName": "orgFree",
6
+ "profiles": [
7
+ {
8
+ "profile": "admin",
9
+ "email": "admin+free@zohotest.com",
10
+ "password": "password@0987"
11
+ },
12
+ {
13
+ "profile": "agent",
14
+ "email": "agent@zohotest.com",
15
+ "password": "password@12345"
16
+ },
17
+ {
18
+ "profile": "lightagent",
19
+ "email": "lightagent@zohotest.com",
20
+ "password": "password@12345"
21
+ }
22
+ ]
23
+ }
24
+ ]
25
+
@@ -0,0 +1,7 @@
1
+ {
2
+ "environment": "dev",
3
+ "edition": "enterprise",
4
+ "profile": "admin",
5
+ "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
6
+ "devUrl" : ""
7
+ }
@@ -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,7 +72,6 @@ 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
76
  } catch (err) {
77
77
  _logger.Logger.error(err);
@@ -84,8 +84,21 @@ function createAuthenticationFile() {
84
84
  function createConfigJson() {
85
85
  const uatFolder = _path.default.resolve(process.cwd(), 'uat');
86
86
  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);
87
+ _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
88
+ if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
89
+ (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
90
+ recursive: true
91
+ });
92
+ }
93
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
94
+ if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
95
+ (0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
96
+ recursive: true
97
+ });
98
+ }
99
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
100
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
101
+ (0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
89
102
  } else {
90
103
  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
91
104
  }
@@ -13,14 +13,13 @@ function getPrimaryCookiePath() {
13
13
  */
14
14
  module.exports = {
15
15
  headless: false,
16
- retries:1,
17
16
  openReportOn: 'never',
18
17
  browsers: ['Chrome'],
19
18
  isAuthMode: true,
20
19
  authFilePath: getPrimaryCookiePath(),
21
20
  trace: 'retain-on-failure',
22
21
  video: 'retain-on-failure',
23
- retries:1,
22
+ retries:2,
24
23
  bddMode: false,
25
24
  expectTimeout: 10 * 1000,
26
25
  testTimeout: 60 * 1000,
@@ -13,14 +13,13 @@ function getPrimaryCookiePath() {
13
13
  */
14
14
  module.exports = {
15
15
  headless: false,
16
- retries:1,
17
16
  openReportOn: 'never',
18
17
  browsers: ['Chrome'],
19
18
  isAuthMode: true,
20
19
  authFilePath: getPrimaryCookiePath(),
21
20
  trace: 'retain-on-failure',
22
21
  video: 'retain-on-failure',
23
- retries:1,
22
+ retries:2,
24
23
  bddMode: false,
25
24
  expectTimeout: 10 * 1000,
26
25
  testTimeout: 60 * 1000,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zohodesk/testinglibrary",
3
- "version": "2.9.2",
3
+ "version": "3.0.2",
4
4
  "description": "",
5
5
  "main": "./build/index.js",
6
6
  "scripts": {
@@ -22,8 +22,8 @@
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.0.1",
26
+ "@playwright/test": "1.48.0",
27
27
  "@testing-library/jest-dom": "5.11.9",
28
28
  "@testing-library/react": "11.2.7",
29
29
  "@testing-library/react-hooks": "7.0.2",
@@ -34,8 +34,9 @@
34
34
  "jest-environment-jsdom": "29.6.2",
35
35
  "lockfile": "^1.0.4",
36
36
  "msw": "1.2.3",
37
- "playwright": "1.42.1",
38
- "supports-color": "8.1.1"
37
+ "playwright": "1.48.0",
38
+ "supports-color": "8.1.1",
39
+ "playwright-bdd": "7.5.0"
39
40
  },
40
41
  "bin": {
41
42
  "ZDTestingFramework": "./bin/cli.js"
@@ -54,7 +55,6 @@
54
55
  "@babel/preset-env": "7.22.15",
55
56
  "@babel/runtime": "7.22.15",
56
57
  "commander": "^11.0.0",
57
- "jest-html-reporter": "^3.10.2",
58
- "typescript": "^5.4.2"
58
+ "jest-html-reporter": "^3.10.2"
59
59
  }
60
60
  }
@@ -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();