@zohodesk/testinglibrary 0.1.8-exp-bdd-v1 → 0.1.8-exp.1

package/.babelrc

@@ -1,19 +1,19 @@
-{
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "targets": {
-          "node": "14"
-        },
-        "exclude": ["@babel/plugin-transform-destructuring"]
-      }
-    ]
-  ],
-  "plugins": [
-      ["@babel/plugin-transform-runtime"]
-  ],
-  "ignore": [
-    "./src/setup-folder-structure/samples"
-  ]
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "14"
+        },
+        "exclude": ["@babel/plugin-transform-destructuring"]
+      }
+    ]
+  ],
+  "plugins": [
+      ["@babel/plugin-transform-runtime"]
+  ],
+  "ignore": [
+    "./src/setup-folder-structure/samples"
+  ]
 }

package/.eslintrc.js

@@ -1,27 +1,31 @@
-module.exports = {
-  "env": {
-    "node": true,
-    "es2021": true
-  },
-  "extends": "eslint:recommended",
-  "overrides": [
-    {
-      "env": {
-        "node": true
-      },
-      "files": [
-        ".eslintrc.{js,cjs}"
-      ],
-      "parserOptions": {
-        "sourceType": "script"
-      }
-    }
-  ],
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "rules": {
-    "indent": ["error", 2]
-  }
-}
+module.exports = {
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": "eslint:recommended",
+  "overrides": [
+    {
+      "env": {
+        "node": true
+      },
+      "files": [
+        ".eslintrc.{js,cjs}"
+      ],
+      "parserOptions": {
+        "sourceType": "script"
+      }
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-empty-pattern": "off",
+    "comma-dangle": ["error", "never"],
+    "curly": ["error"],
+    "brace-style": "error"
+  }
+}

package/.prettierrc

@@ -1,6 +1,6 @@
-{
-  "trailingComma": "none",
-  "singleQuote": true,
-  "arrowParens": "avoid",
-  "jsxSingleQuote": true
+{
+  "trailingComma": "none",
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "jsxSingleQuote": true
 }

package/README.md

@@ -1,18 +1,18 @@
-# Testing Framework
-
-## Framework that abstracts the configuration for playwright and Jest
-
-     - Playwright
-     - Jest
-
-## Cli
-
-## Feature Supported
-   
-  ### Run TestCase
-
-    - npm run test
-  ### Generate Report
-
-     - npm run report
+# Testing Framework
+
+## Framework that abstracts the configuration for playwright and Jest
+
+     - Playwright
+     - Jest
+
+## Cli
+
+## Feature Supported
+   
+  ### Run TestCase
+
+    - npm run test
+  ### Generate Report
+
+     - npm run report
     

package/bin/cli.js

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
+#!/usr/bin/env node
+
 require('../build/lib/cli');

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

@@ -28,12 +28,12 @@ function showPackageVersion(packageName) {
   const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
   logger.log(`${packageName}: v${version}`);
 }
-/**
- * Getting own version by relative path instead of using getPackageVersion(),
- * to aneble using directly from /dist in tests.
+/**
+ * Getting own version by relative path instead of using getPackageVersion(),
+ * 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/test.js

@@ -30,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

@@ -6,13 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 exports.configOption = void 0;
 exports.getCliConfigPath = getCliConfigPath;
 var _commander = require("commander");
-/**
- * Config option moved to separate file as it used in test run.
+/**
+ * Config option moved to separate file as it used in test run.
  */
 
 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.
+/**
+ * Helper used in test run to detect config location.
  */
 function getCliConfigPath() {
   return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');

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

@@ -2,9 +2,9 @@
 
 var _worker_threads = require("worker_threads");
 var _gen = require("../gen");
-/**
- * Worker to generate test files with fresh require/import cache
- * See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
+/**
+ * Worker to generate test files with fresh require/import cache
+ * See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
  */
 
 async function main() {

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

@@ -8,14 +8,14 @@ exports.getPlaywrightConfigDir = getPlaywrightConfigDir;
 var _path = _interopRequireDefault(require("path"));
 var _loadConfig = require("../playwright/loadConfig");
 var _options = require("../cli/options");
-/**
- * Store playwright config dir in env to provide access to it in workers.
- * Important that in workers there is different process.argv, that's why we save it to env.
- * Config dir is needed to resolve all paths.
+/**
+ * Store playwright config dir in env to provide access to it in workers.
+ * Important that in workers there is different process.argv, that's why we save it to env.
+ * Config dir is needed to resolve all paths.
  */
 
-/**
- * Resolve playwright config dir considering cli flags.
+/**
+ * Resolve playwright config dir considering cli flags.
  */
 function getPlaywrightConfigDir() {
   if (!process.env.PLAYWRIGHT_BDD_CONFIG_DIR) {

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

@@ -9,9 +9,9 @@ exports.getEnvConfigs = getEnvConfigs;
 exports.saveConfigToEnv = saveConfigToEnv;
 var _path = _interopRequireDefault(require("path"));
 var _exit = require("../utils/exit");
-/**
- * Storing configs in env var PLAYWRIGHT_BDD_CONFIGS as JSON-stringified values.
- * For passing configs to playwright workers and bddgen.
+/**
+ * Storing configs in env var PLAYWRIGHT_BDD_CONFIGS as JSON-stringified values.
+ * For passing configs to playwright workers and bddgen.
  */
 
 function saveConfigToEnv(config) {
@@ -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

@@ -11,8 +11,8 @@ var _path = _interopRequireDefault(require("path"));
 var _env = require("./env");
 var _dir = require("./dir");
 var _utils = require("../utils");
-/**
- * BDD Config.
+/**
+ * BDD Config.
  */
 
 const defaults = exports.defaults = {

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/buildStepDefinition.js

@@ -8,9 +8,9 @@ exports.buildStepDefinition = buildStepDefinition;
 var _messages = require("@cucumber/messages");
 var _cucumberExpressions = require("@cucumber/cucumber-expressions");
 var _step_definition = _interopRequireDefault(require("@cucumber/cucumber/lib/models/step_definition"));
-/**
- * Extracted from cucumber SupportCodeLibraryBuilder.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/support_code_library_builder/index.ts
+/**
+ * Extracted from cucumber SupportCodeLibraryBuilder.
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/support_code_library_builder/index.ts
  */
 
 const newId = _messages.IdGenerator.uuid();

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

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.loadSnippetBuilder = loadSnippetBuilder;
 var _cucumber = require("@cucumber/cucumber");
-/**
- * Loads snippet builder
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/builder.ts
+/**
+ * Loads snippet builder
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/builder.ts
  */
 
 async function loadSnippetBuilder(supportCodeLibrary, snippetInterface, snippetSyntax) {

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

@@ -9,17 +9,17 @@ var _messages = require("@cucumber/messages");
 var _environment = require("@cucumber/cucumber/lib/api/environment");
 var _gherkin = require("@cucumber/cucumber/lib/api/gherkin");
 var _console_logger = require("@cucumber/cucumber/lib/api/console_logger");
-/**
- * Copied from original load_sources, but returns full Pickles.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/api/load_sources.ts
+/**
+ * Copied from original load_sources, but returns full Pickles.
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/api/load_sources.ts
  */
 
-/**
- * Load and parse features, produce a filtered and ordered test plan and/or parse errors.
- *
- * @public
- * @param coordinates - Coordinates required to find features
- * @param environment - Project environment.
+/**
+ * Load and parse features, produce a filtered and ordered test plan and/or parse errors.
+ *
+ * @public
+ * @param coordinates - Coordinates required to find features
+ * @param environment - Project environment.
  */
 async function loadSources(coordinates, environment = {}) {
   const {

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,11 +6,11 @@ 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 = exports.Given = (0, _steps.createStepDecorator)('Given');
 const When = exports.When = (0, _steps.createStepDecorator)('When');

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

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.Formatter = void 0;
 var _jsStringWrap = require("../utils/jsStringWrap");
-/**
- * Helper to format Playwright test file.
+/**
+ * Helper to format Playwright test file.
  */
 
 const TAGS_FIXTURE_TEST_KEY_SEPARATOR = '|';
@@ -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,32 +59,69 @@ 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 '';
   }
-  /**
-     * Apply this function only to string literals (mostly titles here).
-     * Objects and arrays are handled with JSON.strinigfy,
-     * b/c object keys can't be in backtiks.
-     * See: https://stackoverflow.com/questions/33194138/template-string-as-object-property-name
+  /**
+     * Apply this function only to string literals (mostly titles here).
+     * Objects and arrays are handled with JSON.strinigfy,
+     * b/c object keys can't be in backtiks.
+     * See: https://stackoverflow.com/questions/33194138/template-string-as-object-property-name
      */
   quoted(str) {
     return (0, _jsStringWrap.jsStringWrap)(str, {

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

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getKeywordsMap = getKeywordsMap;
 var _gherkin = require("@cucumber/gherkin");
-/**
- * Get i18n keywords.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/cli/i18n.ts
+/**
+ * Get i18n keywords.
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/cli/i18n.ts
  */
 
 function getKeywordsMap(language) {
@@ -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,8 +20,9 @@ var _dir = require("../config/dir");
 var _logger = require("../utils/logger");
 var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
 var _exit = require("../utils/exit");
-/**
- * Generate playwright test files from Gherkin documents.
+var _createBdd = require("../stepDefinitions/createBdd");
+/**
+ * Generate playwright test files from Gherkin documents.
  */
 
 class TestFilesGenerator {
@@ -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.`);
     }
   }