@zohodesk/testinglibrary 0.1.8-exp.5 → 0.1.8-stb-bdd-v2

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,31 +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, { "SwitchCase": 1 }],
-    "no-empty-pattern": "off",
-    "comma-dangle": ["error", "never"],
-    "curly": ["error"],
-    "brace-style": "error"
-  }
-}
+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,9 +28,9 @@ 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.6.0';

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) {

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

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.LANG_EN = void 0;
 exports.isEnglish = isEnglish;
-/**
- * Helpers for Cucumber language option.
+/**
+ * Helpers for Cucumber language option.
  */
 const LANG_EN = exports.LANG_EN = 'en';
 function isEnglish(lang) {

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/gen/fixtures.js

@@ -9,18 +9,18 @@ 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.
+/**
+ * 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.
+/**
+ * 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') {

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 = '|';
@@ -117,11 +117,11 @@ class Formatter {
     }
     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) {

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

@@ -21,8 +21,8 @@ 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.
+/**
+ * Generate playwright test files from Gherkin documents.
  */
 
 class TestFilesGenerator {

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

@@ -20,8 +20,8 @@ var _fixtures = require("./fixtures");
 var _scenario = require("../hooks/scenario");
 var _worker = require("../hooks/worker");
 var _lang = require("../config/lang");
-/**
- * Generate test code.
+/**
+ * Generate test code.
  */
 
 class TestFile {
@@ -116,8 +116,8 @@ class TestFile {
     }
     return this.getSuite(feature);
   }
-  /**
-     * Generate test.describe suite for root Feature or Rule
+  /**
+     * Generate test.describe suite for root Feature or Rule
      */
   getSuite(feature, parent) {
     const node = new _testNode.TestNode(feature, parent);
@@ -143,8 +143,8 @@ class TestFile {
   getScenarioLines(scenario, parent) {
     return this.isOutline(scenario) ? this.getOutlineSuite(scenario, parent) : this.getTest(scenario, parent);
   }
-  /**
-     * Generate test.beforeEach for Background
+  /**
+     * Generate test.beforeEach for Background
      */
   getBeforeEach(bg, parent) {
     const node = new _testNode.TestNode({
@@ -157,8 +157,8 @@ class TestFile {
     } = this.getSteps(bg, node.tags);
     return this.formatter.beforeEach(fixtures, lines);
   }
-  /**
-     * Generate test.describe suite for Scenario Outline
+  /**
+     * Generate test.describe suite for Scenario Outline
      */
   getOutlineSuite(scenario, parent) {
     const node = new _testNode.TestNode(scenario, parent);
@@ -177,8 +177,8 @@ class TestFile {
     });
     return this.formatter.suite(node, lines);
   }
-  /**
-     * Generate test from Examples row of Scenario Outline
+  /**
+     * Generate test from Examples row of Scenario Outline
      */
   // eslint-disable-next-line max-params
   getOutlineTest(scenario, examples, exampleRow, title, parent) {
@@ -199,8 +199,8 @@ class TestFile {
     } = this.getSteps(scenario, node.tags, exampleRow.id);
     return this.formatter.test(node, fixtures, lines);
   }
-  /**
-     * Generate test from Scenario
+  /**
+     * Generate test from Scenario
      */
   getTest(scenario, parent) {
     const node = new _testNode.TestNode(scenario, parent);
@@ -217,8 +217,8 @@ class TestFile {
     } = this.getSteps(scenario, node.tags);
     return this.formatter.test(node, fixtures, lines);
   }
-  /**
-     * Generate test steps
+  /**
+     * Generate test steps
      */
   getSteps(scenario, tags, outlineExampleRowId) {
     const testFixtureNames = new Set();
@@ -267,8 +267,8 @@ class TestFile {
       lines
     };
   }
-  /**
-     * Generate step for Given, When, Then
+  /**
+     * Generate step for Given, When, Then
      */
   // eslint-disable-next-line max-statements, complexity
   getStep(step, previousKeywordType, outlineExampleRowId) {

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

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TestNode = void 0;
 var _utils = require("../utils");
-/**
- * Universal TestNode class of parent-child relations in test file structure.
- * Holds tags and titles path.
+/**
+ * Universal TestNode class of parent-child relations in test file structure.
+ * Holds tags and titles path.
  */
 
 const SPECIAL_TAGS = ['@only', '@skip', '@fixme'];

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

@@ -7,27 +7,27 @@ exports.TestPoms = void 0;
 exports.buildFixtureTag = buildFixtureTag;
 var _class = require("../stepDefinitions/decorators/class");
 var _exit = require("../utils/exit");
-/**
- * Track PomNodes used in the particular test.
- * To select correct fixture for decorator steps.
- *
- * Idea: try to use the deepest child fixture for parent steps.
- *
- * Example inheritance tree:
- *      A
- *     / \
- *    B   C
- *   / \   \
- *  D   E   F
- *
- * If test uses steps from classes A and D:
- * -> resolved fixture will be D, even for steps from A.
- *
- * If test uses steps from classes A, D and C:
- * -> error, b/c A has 2 possible fixtures.
- *
- * If test uses steps from classes A and C, but @fixture tag is D:
- * -> error, b/c A has 2 possible fixtures.
+/**
+ * Track PomNodes used in the particular test.
+ * To select correct fixture for decorator steps.
+ *
+ * Idea: try to use the deepest child fixture for parent steps.
+ *
+ * Example inheritance tree:
+ *      A
+ *     / \
+ *    B   C
+ *   / \   \
+ *  D   E   F
+ *
+ * If test uses steps from classes A and D:
+ * -> resolved fixture will be D, even for steps from A.
+ *
+ * If test uses steps from classes A, D and C:
+ * -> error, b/c A has 2 possible fixtures.
+ *
+ * If test uses steps from classes A and C, but @fixture tag is D:
+ * -> error, b/c A has 2 possible fixtures.
  */
 
 const FIXTURE_TAG_PREFIX = '@fixture:';
@@ -58,18 +58,18 @@ class TestPoms {
       });
     }
   }
-  /**
-     * Resolve all used pomNodes to fixtures.
-     * This is needed to handle @fixture: tagged pomNodes
-     * that does not have steps in the test, but should be considered.
+  /**
+     * Resolve all used pomNodes to fixtures.
+     * This is needed to handle @fixture: tagged pomNodes
+     * that does not have steps in the test, but should be considered.
      */
   resolveFixtures() {
     this.usedPoms.forEach((_, pomNode) => {
       this.getResolvedFixtures(pomNode);
     });
   }
-  /**
-     * Returns fixtures suitable for particular pomNode (actually for step)
+  /**
+     * Returns fixtures suitable for particular pomNode (actually for step)
      */
   getResolvedFixtures(pomNode) {
     const usedPom = this.usedPoms.get(pomNode);
@@ -109,10 +109,10 @@ class TestPoms {
       });
     }
   }
-  /**
-     * For scenarios with @fixture:xxx tags verify that there are no steps from fixtures,
-     * deeper than xxx.
-     * @fixture:xxx tag provides maximum fixture that can be used in the scenario.
+  /**
+     * For scenarios with @fixture:xxx tags verify that there are no steps from fixtures,
+     * deeper than xxx.
+     * @fixture:xxx tag provides maximum fixture that can be used in the scenario.
      */
   verifyChildFixtures(pomNode, usedPom, childFixtures) {
     if (!usedPom.byTag) {

package/build/bdd-framework/hooks/scenario.js

@@ -11,16 +11,16 @@ exports.scenarioHookFactory = scenarioHookFactory;
 var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
 var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
 var _utils = require("../utils");
-/**
- * Scenario level hooks: Before / After.
- *
- * before(async ({ page }) => {})
+/**
+ * Scenario level hooks: Before / After.
+ *
+ * before(async ({ page }) => {})
  */
 
 const scenarioHooks = [];
 let scenarioHooksFixtures;
-/**
- * Returns Before() / After() functions.
+/**
+ * Returns Before() / After() functions.
  */
 function scenarioHookFactory(type) {
   return (...args) => {

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

@@ -8,14 +8,14 @@ exports.runWorkerHooks = runWorkerHooks;
 exports.workerHookFactory = workerHookFactory;
 var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
 var _utils = require("../utils");
-/**
- * Worker-level hooks: BeforeAll / AfterAll.
+/**
+ * Worker-level hooks: BeforeAll / AfterAll.
  */
 
 const workerHooks = [];
 let workerHooksFixtures;
-/**
- * Returns BeforeAll() / AfterAll() functions.
+/**
+ * Returns BeforeAll() / AfterAll() functions.
  */
 function workerHookFactory(type) {
   return (...args) => {

package/build/bdd-framework/playwright/fixtureParameterNames.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.fixtureParameterNames = fixtureParameterNames;
-/**
- * Extracted from playwright.
- * https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/fixtures.ts#L226
+/**
+ * Extracted from playwright.
+ * https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/fixtures.ts#L226
  */
 /* eslint-disable max-statements, complexity, max-len, max-depth */
 const signatureSymbol = Symbol('signature');