@zohodesk/testinglibrary 2.9.2 → 3.0.1

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 (125) 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/helpers/fileMutex.js +10 -12
  5. package/build/core/playwright/index.js +10 -23
  6. package/build/core/playwright/setup/config-creator.js +3 -3
  7. package/build/core/playwright/setup/config-utils.js +8 -25
  8. package/build/core/playwright/tagProcessor.js +18 -28
  9. package/build/core/playwright/test-runner.js +1 -1
  10. package/build/decorators.d.ts +1 -1
  11. package/build/decorators.js +1 -1
  12. package/build/setup-folder-structure/samples/actors-index.js +2 -0
  13. package/build/setup-folder-structure/samples/auth-setup-sample.js +14 -66
  14. package/build/setup-folder-structure/samples/editions-index.js +3 -0
  15. package/build/setup-folder-structure/samples/free-sample.json +25 -0
  16. package/build/setup-folder-structure/samples/settings.json +7 -0
  17. package/build/setup-folder-structure/setupProject.js +18 -5
  18. package/nobdd/uat/conf/nobdd/uat.config.js +1 -2
  19. package/nobdd/uat.config.js +1 -2
  20. package/package.json +7 -7
  21. package/build/bdd-framework/cli/commands/env.js +0 -42
  22. package/build/bdd-framework/cli/commands/export.js +0 -62
  23. package/build/bdd-framework/cli/commands/test.js +0 -64
  24. package/build/bdd-framework/cli/index.js +0 -11
  25. package/build/bdd-framework/cli/options.js +0 -19
  26. package/build/bdd-framework/cli/worker.js +0 -13
  27. package/build/bdd-framework/config/configDir.js +0 -35
  28. package/build/bdd-framework/config/enrichReporterData.js +0 -23
  29. package/build/bdd-framework/config/env.js +0 -50
  30. package/build/bdd-framework/config/index.js +0 -94
  31. package/build/bdd-framework/config/lang.js +0 -14
  32. package/build/bdd-framework/cucumber/buildStepDefinition.js +0 -43
  33. package/build/bdd-framework/cucumber/createTestStep.js +0 -43
  34. package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +0 -126
  35. package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +0 -72
  36. package/build/bdd-framework/cucumber/formatter/PickleParser.js +0 -25
  37. package/build/bdd-framework/cucumber/formatter/durationHelpers.js +0 -13
  38. package/build/bdd-framework/cucumber/formatter/getColorFns.js +0 -57
  39. package/build/bdd-framework/cucumber/formatter/index.js +0 -16
  40. package/build/bdd-framework/cucumber/formatter/locationHelpers.js +0 -16
  41. package/build/bdd-framework/cucumber/loadConfig.js +0 -17
  42. package/build/bdd-framework/cucumber/loadFeatures.js +0 -70
  43. package/build/bdd-framework/cucumber/loadSnippetBuilder.js +0 -20
  44. package/build/bdd-framework/cucumber/loadSteps.js +0 -47
  45. package/build/bdd-framework/cucumber/resolveFeaturePaths.js +0 -62
  46. package/build/bdd-framework/cucumber/stepArguments.js +0 -21
  47. package/build/bdd-framework/cucumber/types.js +0 -5
  48. package/build/bdd-framework/cucumber/valueChecker.js +0 -23
  49. package/build/bdd-framework/decorators.js +0 -18
  50. package/build/bdd-framework/gen/fixtures.js +0 -48
  51. package/build/bdd-framework/gen/formatter.js +0 -167
  52. package/build/bdd-framework/gen/i18n.js +0 -39
  53. package/build/bdd-framework/gen/index.js +0 -197
  54. package/build/bdd-framework/gen/specialTags.js +0 -70
  55. package/build/bdd-framework/gen/testFile.js +0 -470
  56. package/build/bdd-framework/gen/testMeta.js +0 -60
  57. package/build/bdd-framework/gen/testNode.js +0 -35
  58. package/build/bdd-framework/gen/testPoms.js +0 -133
  59. package/build/bdd-framework/hooks/scenario.js +0 -130
  60. package/build/bdd-framework/hooks/worker.js +0 -89
  61. package/build/bdd-framework/index.js +0 -52
  62. package/build/bdd-framework/playwright/fixtureParameterNames.js +0 -93
  63. package/build/bdd-framework/playwright/getLocationInFile.js +0 -79
  64. package/build/bdd-framework/playwright/loadConfig.js +0 -42
  65. package/build/bdd-framework/playwright/loadUtils.js +0 -33
  66. package/build/bdd-framework/playwright/testTypeImpl.js +0 -79
  67. package/build/bdd-framework/playwright/transform.js +0 -88
  68. package/build/bdd-framework/playwright/types.js +0 -12
  69. package/build/bdd-framework/playwright/utils.js +0 -56
  70. package/build/bdd-framework/reporter/cucumber/base.js +0 -52
  71. package/build/bdd-framework/reporter/cucumber/custom.js +0 -73
  72. package/build/bdd-framework/reporter/cucumber/helper.js +0 -12
  73. package/build/bdd-framework/reporter/cucumber/html.js +0 -40
  74. package/build/bdd-framework/reporter/cucumber/index.js +0 -74
  75. package/build/bdd-framework/reporter/cucumber/json.js +0 -312
  76. package/build/bdd-framework/reporter/cucumber/junit.js +0 -205
  77. package/build/bdd-framework/reporter/cucumber/message.js +0 -20
  78. package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +0 -82
  79. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +0 -197
  80. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +0 -43
  81. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +0 -52
  82. package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +0 -105
  83. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +0 -70
  84. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +0 -45
  85. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +0 -27
  86. package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +0 -38
  87. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +0 -128
  88. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +0 -154
  89. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +0 -123
  90. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +0 -67
  91. package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +0 -114
  92. package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +0 -30
  93. package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwStepUtils.js +0 -70
  94. package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +0 -35
  95. package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +0 -5
  96. package/build/bdd-framework/run/StepInvoker.js +0 -69
  97. package/build/bdd-framework/run/bddData/index.js +0 -59
  98. package/build/bdd-framework/run/bddData/types.js +0 -5
  99. package/build/bdd-framework/run/bddFixtures.js +0 -192
  100. package/build/bdd-framework/run/bddWorld.js +0 -79
  101. package/build/bdd-framework/run/bddWorldInternal.js +0 -11
  102. package/build/bdd-framework/snippets/index.js +0 -132
  103. package/build/bdd-framework/snippets/snippetSyntax.js +0 -43
  104. package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +0 -26
  105. package/build/bdd-framework/snippets/snippetSyntaxTs.js +0 -18
  106. package/build/bdd-framework/stepDefinitions/createBdd.js +0 -66
  107. package/build/bdd-framework/stepDefinitions/decorators/class.js +0 -68
  108. package/build/bdd-framework/stepDefinitions/decorators/steps.js +0 -99
  109. package/build/bdd-framework/stepDefinitions/defineStep.js +0 -62
  110. package/build/bdd-framework/stepDefinitions/stepConfig.js +0 -24
  111. package/build/bdd-framework/steps/createBdd.js +0 -78
  112. package/build/bdd-framework/steps/decorators/class.js +0 -68
  113. package/build/bdd-framework/steps/decorators/steps.js +0 -98
  114. package/build/bdd-framework/steps/defineStep.js +0 -62
  115. package/build/bdd-framework/steps/stepConfig.js +0 -24
  116. package/build/bdd-framework/utils/AutofillMap.js +0 -20
  117. package/build/bdd-framework/utils/exit.js +0 -62
  118. package/build/bdd-framework/utils/index.js +0 -93
  119. package/build/bdd-framework/utils/jsStringWrap.js +0 -44
  120. package/build/bdd-framework/utils/logger.js +0 -30
  121. package/build/bdd-framework/utils/stripAnsiEscapes.js +0 -20
  122. package/build/setup-folder-structure/samples/authUsers-sample.json +0 -9
  123. package/build/setup-folder-structure/samples/env-config-sample.json +0 -21
  124. package/nobdd/src/App.js +0 -7
  125. package/npm-shrinkwrap.json +0 -6475
@@ -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
- }
@@ -1,94 +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.defaults = void 0;
8
- exports.defineBddConfig = defineBddConfig;
9
- exports.extractCucumberConfig = extractCucumberConfig;
10
- var _path = _interopRequireDefault(require("path"));
11
- var _env = require("./env");
12
- var _configDir = require("./configDir");
13
- var _utils = require("../utils");
14
- /**
15
- * BDD Config.
16
- */
17
-
18
- const defaults = exports.defaults = {
19
- outputDir: '.features-gen',
20
- verbose: false,
21
- examplesTitleFormat: 'Example #<_index_>',
22
- publishQuiet: true,
23
- quotes: 'double'
24
- };
25
- function defineBddConfig(inputConfig) {
26
- const isMainProcess = !process.env.TEST_WORKER_INDEX;
27
- const configDir = (0, _configDir.getPlaywrightConfigDir)({
28
- resolveAndSave: isMainProcess
29
- });
30
- const config = getConfig(configDir, inputConfig);
31
- // In main process store config in env to be accessible by workers
32
- if (isMainProcess) {
33
- (0, _env.saveConfigToEnv)(config);
34
- }
35
- return config.outputDir;
36
- }
37
- function getConfig(configDir, inputConfig) {
38
- const config = Object.assign({}, defaults, inputConfig);
39
- const featuresRoot = config.featuresRoot ? _path.default.resolve(configDir, config.featuresRoot) : configDir;
40
- return {
41
- ...config,
42
- // important to resolve outputDir as it is used as unique key for input configs
43
- outputDir: _path.default.resolve(configDir, config.outputDir),
44
- importTestFrom: resolveImportTestFrom(configDir, config.importTestFrom),
45
- featuresRoot
46
- };
47
- }
48
- function extractCucumberConfig(config) {
49
- // todo: find more strict way to omit own config fields
50
- // see: https://bobbyhadz.com/blog/typescript-object-remove-property
51
- const omitProps = {
52
- outputDir: true,
53
- importTestFrom: true,
54
- verbose: true,
55
- skip: true,
56
- examplesTitleFormat: true,
57
- quotes: true,
58
- tags: true,
59
- featuresRoot: true,
60
- enrichReporterData: true
61
- };
62
- const keys = Object.keys(omitProps);
63
- const cucumberConfig = {
64
- ...config
65
- };
66
- keys.forEach(key => delete cucumberConfig[key]);
67
- stripPublishQuiet(cucumberConfig);
68
- return cucumberConfig;
69
- }
70
- function resolveImportTestFrom(configDir, importTestFrom) {
71
- if (importTestFrom) {
72
- const {
73
- file,
74
- varName
75
- } = typeof importTestFrom === 'string' ? {
76
- file: importTestFrom
77
- } : importTestFrom;
78
- return {
79
- file: _path.default.resolve(configDir, file),
80
- varName
81
- };
82
- }
83
- }
84
- function stripPublishQuiet(cucumberConfig) {
85
- const cucumberVersion = (0, _utils.getPackageVersion)('@cucumber/cucumber');
86
- // Playwright-bdd supports Cucumber from v9+
87
- // publishQuiet was deprecated in Cucumber 9.4.0.
88
- // See: https://github.com/cucumber/cucumber-js/pull/2311
89
- // Remove publishQuite from Cucumber config to hide deprecation warning.
90
- // See: https://github.com/vitalets/playwright-bdd/pull/47
91
- if (!/^9\.[0123]\./.test(cucumberVersion)) {
92
- delete cucumberConfig.publishQuiet;
93
- }
94
- }
@@ -1,14 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.LANG_EN = void 0;
7
- exports.isEnglish = isEnglish;
8
- /**
9
- * Helpers for Cucumber language option.
10
- */
11
- const LANG_EN = exports.LANG_EN = 'en';
12
- function isEnglish(lang) {
13
- return !lang || lang === LANG_EN;
14
- }
@@ -1,43 +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.buildStepDefinition = buildStepDefinition;
8
- var _messages = require("@cucumber/messages");
9
- var _cucumberExpressions = require("@cucumber/cucumber-expressions");
10
- var _step_definition = _interopRequireDefault(require("@cucumber/cucumber/lib/models/step_definition"));
11
- /**
12
- * Extracted from cucumber SupportCodeLibraryBuilder.
13
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/support_code_library_builder/index.ts
14
- */
15
-
16
- const newId = _messages.IdGenerator.uuid();
17
- function buildStepDefinition({
18
- keyword,
19
- pattern,
20
- code,
21
- line,
22
- options,
23
- uri
24
- }, supportCodeLibrary) {
25
- // todo: handle error.undefinedParameterTypeName as it's done in cucumber?
26
- const expression = typeof pattern === 'string' ? new _cucumberExpressions.CucumberExpression(pattern, supportCodeLibrary.parameterTypeRegistry) : new _cucumberExpressions.RegularExpression(pattern, supportCodeLibrary.parameterTypeRegistry);
27
- // skip wrapping code as it is not needed for decorator steps
28
- // const wrappedCode = this.wrapCode({
29
- // code,
30
- // wrapperOptions: options.wrapperOptions,
31
- // })
32
- return new _step_definition.default({
33
- code,
34
- expression,
35
- id: newId(),
36
- line,
37
- options,
38
- keyword,
39
- pattern,
40
- unwrappedCode: code,
41
- uri
42
- });
43
- }
@@ -1,43 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.createTestStep = createTestStep;
7
- /**
8
- * Creates partial TestStep for usage in reporter.
9
- * It is partial, b/c final pickleStepId will be known only in reporter.
10
- *
11
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/runtime/assemble_test_cases.ts#L93
12
- */
13
- function createTestStep(stepDefinition, stepText) {
14
- const result = stepDefinition.expression.match(stepText);
15
- if (!result) {
16
- // this should not happen as stepDefinition is already matched
17
- throw Error(`Step definition didn't match step "${stepText}"`);
18
- }
19
- const stepMatchArguments = result.map(arg => {
20
- return {
21
- group: mapArgumentGroup(arg.group),
22
- parameterTypeName: arg.parameterType.name
23
- };
24
- });
25
- return {
26
- // id will be generated in reporter, no need to generate it here
27
- id: '',
28
- // looks like it's useless to store stepDefinitionIds here
29
- // b/c they will be different in reporter
30
- // stepDefinitionIds: [stepDefinition.id],
31
- stepMatchArgumentsLists: [{
32
- stepMatchArguments
33
- }]
34
- };
35
- }
36
- function mapArgumentGroup(group) {
37
- var _group$children;
38
- return {
39
- start: group.start,
40
- value: group.value,
41
- children: (_group$children = group.children) === null || _group$children === void 0 ? void 0 : _group$children.map(child => mapArgumentGroup(child))
42
- };
43
- }
@@ -1,126 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var messages = _interopRequireWildcard(require("@cucumber/messages"));
8
- var _valueChecker = require("../valueChecker");
9
- function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
10
- function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
11
- /**
12
- * Groups Cucumber messages for easier access.
13
- * Based on Cucumber, with some changes due to strictNullChecks errors.
14
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/helpers/event_data_collector.ts
15
- */
16
-
17
- class EventDataCollector {
18
- gherkinDocumentMap = {};
19
- pickleMap = {};
20
- testCaseMap = {};
21
- testCaseAttemptDataMap = {};
22
- undefinedParameterTypes = [];
23
- constructor(eventBroadcaster) {
24
- eventBroadcaster.on('envelope', this.parseEnvelope.bind(this));
25
- }
26
- /**
27
- * @public
28
- */
29
- getGherkinDocument(uri) {
30
- return this.gherkinDocumentMap[uri];
31
- }
32
- /**
33
- * @public
34
- */
35
- getPickle(pickleId) {
36
- return this.pickleMap[pickleId];
37
- }
38
- getTestCaseAttempts() {
39
- return Object.keys(this.testCaseAttemptDataMap).map(testCaseStartedId => {
40
- return this.getTestCaseAttempt(testCaseStartedId);
41
- });
42
- }
43
- getTestCaseAttempt(testCaseStartedId) {
44
- const testCaseAttemptData = this.testCaseAttemptDataMap[testCaseStartedId];
45
- const testCase = this.testCaseMap[testCaseAttemptData.testCaseId];
46
- const pickle = this.pickleMap[testCase.pickleId];
47
- return {
48
- gherkinDocument: this.gherkinDocumentMap[pickle.uri],
49
- pickle,
50
- testCase,
51
- attempt: testCaseAttemptData.attempt,
52
- willBeRetried: testCaseAttemptData.willBeRetried,
53
- stepAttachments: testCaseAttemptData.stepAttachments,
54
- stepResults: testCaseAttemptData.stepResults,
55
- worstTestStepResult: testCaseAttemptData.worstTestStepResult
56
- };
57
- }
58
- parseEnvelope(envelope) {
59
- var _envelope$gherkinDocu;
60
- if ((0, _valueChecker.doesHaveValue)((_envelope$gherkinDocu = envelope.gherkinDocument) === null || _envelope$gherkinDocu === void 0 ? void 0 : _envelope$gherkinDocu.uri)) {
61
- this.gherkinDocumentMap[envelope.gherkinDocument.uri] = envelope.gherkinDocument;
62
- } else if ((0, _valueChecker.doesHaveValue)(envelope.pickle)) {
63
- this.pickleMap[envelope.pickle.id] = envelope.pickle;
64
- } else if ((0, _valueChecker.doesHaveValue)(envelope.undefinedParameterType)) {
65
- this.undefinedParameterTypes.push(envelope.undefinedParameterType);
66
- } else if ((0, _valueChecker.doesHaveValue)(envelope.testCase)) {
67
- this.testCaseMap[envelope.testCase.id] = envelope.testCase;
68
- } else if ((0, _valueChecker.doesHaveValue)(envelope.testCaseStarted)) {
69
- this.initTestCaseAttempt(envelope.testCaseStarted);
70
- } else if ((0, _valueChecker.doesHaveValue)(envelope.attachment)) {
71
- this.storeAttachment(envelope.attachment);
72
- } else if ((0, _valueChecker.doesHaveValue)(envelope.testStepFinished)) {
73
- this.storeTestStepResult(envelope.testStepFinished);
74
- } else if ((0, _valueChecker.doesHaveValue)(envelope.testCaseFinished)) {
75
- this.storeTestCaseResult(envelope.testCaseFinished);
76
- }
77
- }
78
- initTestCaseAttempt(testCaseStarted) {
79
- this.testCaseAttemptDataMap[testCaseStarted.id] = {
80
- attempt: testCaseStarted.attempt,
81
- willBeRetried: false,
82
- testCaseId: testCaseStarted.testCaseId,
83
- stepAttachments: {},
84
- stepResults: {},
85
- worstTestStepResult: {
86
- duration: {
87
- seconds: 0,
88
- nanos: 0
89
- },
90
- status: messages.TestStepResultStatus.UNKNOWN
91
- }
92
- };
93
- }
94
- storeAttachment(attachment) {
95
- const {
96
- testCaseStartedId,
97
- testStepId
98
- } = attachment;
99
- // TODO: we shouldn't have to check if these properties have values - they are non-nullable
100
- if ((0, _valueChecker.doesHaveValue)(testCaseStartedId) && (0, _valueChecker.doesHaveValue)(testStepId)) {
101
- const {
102
- stepAttachments
103
- } = this.testCaseAttemptDataMap[testCaseStartedId];
104
- if ((0, _valueChecker.doesNotHaveValue)(stepAttachments[testStepId])) {
105
- stepAttachments[testStepId] = [];
106
- }
107
- stepAttachments[testStepId].push(attachment);
108
- }
109
- }
110
- storeTestStepResult({
111
- testCaseStartedId,
112
- testStepId,
113
- testStepResult
114
- }) {
115
- this.testCaseAttemptDataMap[testCaseStartedId].stepResults[testStepId] = testStepResult;
116
- }
117
- storeTestCaseResult({
118
- testCaseStartedId,
119
- willBeRetried
120
- }) {
121
- const stepResults = Object.values(this.testCaseAttemptDataMap[testCaseStartedId].stepResults);
122
- this.testCaseAttemptDataMap[testCaseStartedId].worstTestStepResult = messages.getWorstTestStepResult(stepResults);
123
- this.testCaseAttemptDataMap[testCaseStartedId].willBeRetried = willBeRetried;
124
- }
125
- }
126
- exports.default = EventDataCollector;