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

package/.eslintrc.js

@@ -22,6 +22,10 @@ module.exports = {
     "sourceType": "module"
   },
   "rules": {
-    "indent": ["error", 2]
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-empty-pattern": "off",
+    "comma-dangle": ["error", "never"],
+    "curly": ["error"],
+    "brace-style": "error"
   }
 }

package/build/bdd-framework/cli/commands/env.js

@@ -15,7 +15,7 @@ var _loadConfig = require("../../playwright/loadConfig");
 const logger = new _logger.Logger({
   verbose: true
 });
-const envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
+const envCommand = exports.envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
   logger.log(`Playwright-bdd environment info:\n`);
   logger.log(`platform: ${process.platform}`);
   logger.log(`node: ${process.version}`);
@@ -24,7 +24,6 @@ const envCommand = new _commander.Command('env').description('Prints environment
   showPackageVersion('@cucumber/cucumber');
   showPlaywrightConfigPath(opts.config);
 });
-exports.envCommand = envCommand;
 function showPackageVersion(packageName) {
   const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
   logger.log(`${packageName}: v${version}`);
@@ -34,7 +33,7 @@ function showPackageVersion(packageName) {
  * to aneble using directly from /dist in tests.
  */
 function getOwnVersion() {
-  return '5.4.0';
+  return '5.6.0';
 }
 function showPlaywrightConfigPath(cliConfigPath) {
   const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);

package/build/bdd-framework/cli/commands/export.js

@@ -16,7 +16,7 @@ var _gen = require("../../gen");
 const logger = new _logger.Logger({
   verbose: true
 });
-const exportCommand = new _commander.Command('export').description('Prints all step definitions').addOption(_options.configOption).action(async opts => {
+const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints all step definitions').addOption(_options.configOption).action(async opts => {
   const {
     resolvedConfigFile
   } = await (0, _loadConfig.loadConfig)(opts.config);
@@ -25,7 +25,6 @@ const exportCommand = new _commander.Command('export').description('Prints all s
   (0, _test.assertConfigsCount)(configs);
   await showStepsForConfigs(configs);
 });
-exports.exportCommand = exportCommand;
 async function showStepsForConfigs(configs) {
   // here we don't need workers (as in test command) because if some step files
   // are already in node cache, we collected them.

package/build/bdd-framework/cli/commands/test.js

@@ -17,13 +17,12 @@ var _config = require("../../config");
 var _options = require("../options");
 var _exit = require("../../utils/exit");
 const GEN_WORKER_PATH = _path.default.resolve(__dirname, '..', 'worker.js');
-const 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 => {
+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 => {
   await (0, _loadConfig.loadConfig)(opts.config);
   const configs = readConfigsFromEnv();
   mergeCliOptions(configs, opts);
   await generateFilesForConfigs(configs);
 });
-exports.testCommand = testCommand;
 function readConfigsFromEnv() {
   const configs = Object.values((0, _env.getEnvConfigs)());
   assertConfigsCount(configs);
@@ -31,8 +30,12 @@ function readConfigsFromEnv() {
 }
 function mergeCliOptions(configs, opts) {
   configs.forEach(config => {
-    if ('tags' in opts) config.tags = opts.tags;
-    if ('verbose' in opts) config.verbose = Boolean(opts.verbose);
+    if ('tags' in opts) {
+      config.tags = opts.tags;
+    }
+    if ('verbose' in opts) {
+      config.verbose = Boolean(opts.verbose);
+    }
   });
 }
 function assertConfigsCount(configs) {

package/build/bdd-framework/cli/options.js

@@ -10,11 +10,10 @@ var _commander = require("commander");
  * Config option moved to separate file as it used in test run.
  */
 
-const configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
+const configOption = exports.configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
 /**
  * Helper used in test run to detect config location.
  */
-exports.configOption = configOption;
 function getCliConfigPath() {
   return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');
 }

package/build/bdd-framework/config/env.js

@@ -34,7 +34,8 @@ function getConfigFromEnv(outputDir) {
   outputDir = _path.default.resolve(outputDir);
   const config = envConfigs[outputDir];
   if (!config) {
-    (0, _exit.exit)(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
+    // exit(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
+    return {};
   }
   return config;
 }

package/build/bdd-framework/config/index.js

@@ -15,14 +15,13 @@ var _utils = require("../utils");
  * BDD Config.
  */
 
-const defaults = {
+const defaults = exports.defaults = {
   outputDir: '.features-gen',
   verbose: false,
   examplesTitleFormat: 'Example #<_index_>',
   publishQuiet: true,
   quotes: 'double'
 };
-exports.defaults = defaults;
 function defineBddConfig(inputConfig) {
   const config = getConfig(inputConfig);
   // In main process store config in env to be accessible by workers

package/build/bdd-framework/config/lang.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.LANG_EN = void 0;
+exports.isEnglish = isEnglish;
+/**
+ * Helpers for Cucumber language option.
+ */
+const LANG_EN = exports.LANG_EN = 'en';
+function isEnglish(lang) {
+  return !lang || lang === LANG_EN;
+}

package/build/bdd-framework/cucumber/loadSteps.js

@@ -25,9 +25,14 @@ function findStepDefinition(supportCodeLibrary, stepText, file) {
   const matchedSteps = supportCodeLibrary.stepDefinitions.filter(step => {
     return step.matchesStepName(stepText);
   });
-  if (matchedSteps.length === 0) return;
-  if (matchedSteps.length > 1) (0, _exit.exit)([`Several step definitions found for text: ${stepText} (${file})`, ...matchedSteps.map(s => `- ${s.pattern}`)].join('\n'));
-  // todo: check stepDefinition.keyword with PickleStepType
+  if (matchedSteps.length === 0) {
+    return;
+  }
+  if (matchedSteps.length > 1) {
+    (0, _exit.exit)([`Multiple step definitions matched for text: "${stepText}" (${file})`,
+    // todo: print location of every step definition (as in cucumber)
+    ...matchedSteps.map(s => `  ${s.pattern}`)].join('\n'));
+  }
   return matchedSteps[0];
 }
 function hasTsNodeRegister(runConfiguration) {

package/build/bdd-framework/decorators.js

@@ -6,17 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "Fixture", {
   enumerable: true,
   get: function () {
-    return _poms.Fixture;
+    return _class.Fixture;
   }
 });
 exports.When = exports.Then = exports.Step = exports.Given = void 0;
-var _poms = require("./stepDefinitions/decorators/poms");
+var _class = require("./stepDefinitions/decorators/class");
 var _steps = require("./stepDefinitions/decorators/steps");
-const Given = (0, _steps.createStepDecorator)('Given');
-exports.Given = Given;
-const When = (0, _steps.createStepDecorator)('When');
-exports.When = When;
-const Then = (0, _steps.createStepDecorator)('Then');
-exports.Then = Then;
-const Step = (0, _steps.createStepDecorator)('Unknown');
-exports.Step = Step;
+const Given = exports.Given = (0, _steps.createStepDecorator)('Given');
+const When = exports.When = (0, _steps.createStepDecorator)('When');
+const Then = exports.Then = (0, _steps.createStepDecorator)('Then');
+const Step = exports.Step = (0, _steps.createStepDecorator)('Unknown');

package/build/bdd-framework/gen/fixtures.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractFixtureNames = extractFixtureNames;
+exports.extractFixtureNamesFromFnBodyMemo = extractFixtureNamesFromFnBodyMemo;
+var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
+var _bddFixtures = require("../run/bddFixtures");
+var _exit = require("../utils/exit");
+const bodyFixturesSymbol = Symbol('bodyFixtures');
+/**
+ * This function is used for playwright-style steps and decorators.
+ * It extracts fixtures names from first parameter of function
+ * using Playwright's helper.
+ */
+function extractFixtureNames(fn) {
+  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
+}
+/**
+ * This function is used for cucumber-style steps.
+ * It looks for `this.useFixture('xxx')` entries in function body
+ * and extracts fixtures names from it.
+ */
+function extractFixtureNamesFromFnBodyMemo(fn) {
+  if (typeof fn !== 'function') {
+    return [];
+  }
+  const fnWithFixtures = fn;
+  if (!fnWithFixtures[bodyFixturesSymbol]) {
+    fnWithFixtures[bodyFixturesSymbol] = extractFixtureNamesFromFnBody(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
+  }
+  return fnWithFixtures[bodyFixturesSymbol];
+}
+function extractFixtureNamesFromFnBody(fn) {
+  const matches = fn.toString().matchAll(/this\.useFixture\((.+)\)/gi) || [];
+  return [...matches].map(match => getFixtureName(match[1]));
+}
+function getFixtureName(arg) {
+  if (!/^['"`]/.test(arg)) {
+    // todo: log file location with incorrect useFixture
+    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
+  }
+  if (arg.startsWith('`') && arg.includes('${')) {
+    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
+  }
+  return arg.replace(/['"`]/g, '');
+}

package/build/bdd-framework/gen/formatter.js

@@ -18,14 +18,20 @@ class Formatter {
   fileHeader(uri, importTestFrom) {
     const file = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.file) || '@zohodesk/testinglibrary';
     let varName = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.varName) || 'test';
-    if (varName !== 'test') varName = `${varName} as test`;
+    if (varName !== 'test') {
+      varName = `${varName} as test`;
+    }
     return [`/** Generated from: ${uri} */`,
+    // prettier-ignore
     // this.quoted() is not possible for 'import from' as backticks not parsed
     `import { ${varName} } from ${JSON.stringify(file)};`, ''];
   }
   suite(node, children) {
-    // prettier-ignore
-    return [`test.describe${this.getSubFn(node)}(${this.quoted(node.title)}, () => {`, '', ...children.map(indent), `});`, ''];
+    const firstLine = `test.describe${this.getSubFn(node)}(${this.quoted(node.title)}, () => {`;
+    if (!children.length) {
+      return [`${firstLine}});`, ''];
+    }
+    return [firstLine, '', ...children.map(indent), `});`, ''];
   }
   beforeEach(fixtures, children) {
     const fixturesStr = [...fixtures].join(', ');
@@ -34,8 +40,12 @@ class Formatter {
   }
   test(node, fixtures, children) {
     const fixturesStr = [...fixtures].join(', ');
-    // prettier-ignore
-    return [`test${this.getSubFn(node)}(${this.quoted(node.title)}, async ({ ${fixturesStr} }) => {`, ...children.map(indent), `});`, ''];
+    const title = this.quoted([node.title, ...node.tags].join(' '));
+    const firstLine = `test${this.getSubFn(node)}(${title}, async ({ ${fixturesStr} }) => {`;
+    if (!children.length) {
+      return [`${firstLine}});`, ''];
+    }
+    return [firstLine, ...children.map(indent), `});`, ''];
   }
   // eslint-disable-next-line max-params
   step(keyword, text, argument, fixtureNames = []) {
@@ -49,25 +59,62 @@ class Formatter {
     return `// missing step: ${keyword}(${this.quoted(text)});`;
   }
   useFixtures(fixtures) {
-    return fixtures.length > 0 ? ['// == technical section ==', '', 'test.use({', ...fixtures.map(indent), '});'] : [];
+    return fixtures.length > 0 ? ['// == technical section ==',
+    // prettier-ignore
+    '', 'test.use({', ...fixtures.map(indent), '});'] : [];
   }
   testFixture() {
     return ['$test: ({}, use) => use(test),'];
   }
+  bddWorldFixtures() {
+    const fixturesObj = {
+      page: null,
+      context: null,
+      browser: null,
+      browserName: null,
+      request: null
+    };
+    const fixtures = Object.keys(fixturesObj).join(', ');
+    return [`$bddWorldFixtures: ({ ${fixtures} }, use) => use({ ${fixtures} }),`];
+  }
   tagsFixture(testNodes) {
     const lines = testNodes.filter(node => node.tags.length).map(node => {
       // remove first parent as it is the same for all tests: root suite
-      const key = node.titlePath.slice(1).join(TAGS_FIXTURE_TEST_KEY_SEPARATOR);
+      const key = `${node.titlePath.slice(1).join(TAGS_FIXTURE_TEST_KEY_SEPARATOR)} ${node.tags.join(" ")}`;
       return `${JSON.stringify(key)}: ${JSON.stringify(node.tags)},`;
     });
     return lines.length > 0 ? ['$tags: ({}, use, testInfo) => use({', ...lines.map(indent),
     // .slice(2) -> b/c we remove filename and root suite title
     `}[testInfo.titlePath.slice(2).join(${JSON.stringify(TAGS_FIXTURE_TEST_KEY_SEPARATOR)})] || []),`] : [];
   }
+  scenarioHookFixtures(fixtureNames) {
+    if (!fixtureNames.length) {
+      return [];
+    }
+    const fixtures = fixtureNames.join(', ');
+    return [`$scenarioHookFixtures: ({ ${fixtures} }, use) => use({ ${fixtures} }),`];
+  }
+  workerHookFixtures(fixtureNames) {
+    if (!fixtureNames.length) {
+      return [];
+    }
+    const fixtures = fixtureNames.join(', ');
+    const scope = this.quoted('worker');
+    return [`$workerHookFixtures: [({ ${fixtures} }, use) => use({ ${fixtures} }), { scope: ${scope} }],`];
+  }
+  langFixture(lang) {
+    return [`$lang: ({}, use) => use(${this.quoted(lang)}),`];
+  }
   getSubFn(node) {
-    if (node.flags.only) return '.only';
-    if (node.flags.skip) return '.skip';
-    if (node.flags.fixme) return '.fixme';
+    if (node.flags.only) {
+      return '.only';
+    }
+    if (node.flags.skip) {
+      return '.skip';
+    }
+    if (node.flags.fixme) {
+      return '.fixme';
+    }
     return '';
   }
   /**

package/build/bdd-framework/gen/i18n.js

@@ -23,10 +23,14 @@ function getKeywordsMap(language) {
 function handleKeyword(enKeyword, origMap, targetMap) {
   const nativeKeywords = origMap[enKeyword];
   // Array.isArray converts to any[]
-  if (typeof nativeKeywords === 'string') return;
+  if (typeof nativeKeywords === 'string') {
+    return;
+  }
   nativeKeywords.forEach(nativeKeyword => {
     nativeKeyword = nativeKeyword.trim();
-    if (!nativeKeyword || nativeKeyword === '*') return;
+    if (!nativeKeyword || nativeKeyword === '*') {
+      return;
+    }
     targetMap.set(nativeKeyword, capitalizeFirstLetter(enKeyword));
   });
 }

package/build/bdd-framework/gen/index.js

@@ -20,6 +20,7 @@ var _dir = require("../config/dir");
 var _logger = require("../utils/logger");
 var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
 var _exit = require("../utils/exit");
+var _createBdd = require("../stepDefinitions/createBdd");
 /**
  * Generate playwright test files from Gherkin documents.
  */
@@ -38,7 +39,9 @@ class TestFilesGenerator {
     this.logger = new _logger.Logger({
       verbose: config.verbose
     });
-    if (config.tags) this.tagsExpression = (0, _tagExpressions.default)(config.tags);
+    if (config.tags) {
+      this.tagsExpression = (0, _tagExpressions.default)(config.tags);
+    }
   }
   async generate() {
     await (0, _exit.withExitHandler)(async () => {
@@ -46,7 +49,7 @@ class TestFilesGenerator {
       await Promise.all([this.loadFeatures(), this.loadSteps()]);
       this.buildFiles();
       await this.checkUndefinedSteps();
-      this.checkImportCustomTest();
+      this.checkImportTestFrom();
       await this.clearOutputDir();
       await this.saveFiles();
     });
@@ -133,10 +136,8 @@ class TestFilesGenerator {
       (0, _exit.exit)();
     }
   }
-  checkImportCustomTest() {
-    if (this.config.importTestFrom) return;
-    const hasCustomTest = this.files.some(file => file.hasCustomTest);
-    if (hasCustomTest) {
+  checkImportTestFrom() {
+    if (_createBdd.hasCustomTest && !this.config.importTestFrom) {
       (0, _exit.exit)(`When using custom "test" function in createBdd() you should`, `set "importTestFrom" config option that points to file exporting custom test.`);
     }
   }