@zohodesk/testinglibrary 0.0.5-exp.9 → 0.0.6

package/.babelrc

@@ -12,5 +12,8 @@
   ],
   "plugins": [
       ["@babel/plugin-transform-runtime"]
+  ],
+  "ignore": [
+    "./src/setup-folder-structure/samples"
   ]
 }

package/.eslintrc.js

@@ -0,0 +1,27 @@
+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]
+  }
+}

package/.prettierrc

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

package/{changelog.md → Changelog.md}

@@ -2,21 +2,18 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
-# 0.0.5-exp.8
+# 0.0.6
 
-- Additional pages support added as config
+## Provided Initial Support for cucumber feature files
 
-# 0.0.5-exp.5
+    - Playwright-bdd and cucumber added as dependencies
+    - Added config bddMode which toggles the feature files processing
+    - Added expect timeout and test timeout as an option
+    - Decorators support for given, when and then. Typescript support needed to use this feature
 
-- Added expect timeout and test timeout as an option
+## Internal Library change
 
-# 0.0.5-exp.2
-
-- Provided Initial Support for cucumber feature files
-  - Playwright-bdd and cucumber
-- Added config bddMode which toggles the feature files processing
-- Internal Library change
-  - Provided support for import/export statements
+    - Provided support for import/export statements
 
 # 0.0.5
 

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

@@ -6,17 +6,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.envCommand = void 0;
 exports.getOwnVersion = getOwnVersion;
-var _fs = _interopRequireDefault(require("fs"));
 var _commander = require("commander");
 var _options = require("../options");
 var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _utils = require("../../utils");
 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 => {
-  _logger.logger.log(`Playwright-bdd environment info:\n`);
-  _logger.logger.log(`platform: ${process.platform}`);
-  _logger.logger.log(`node: ${process.version}`);
+  logger.log(`Playwright-bdd environment info:\n`);
+  logger.log(`platform: ${process.platform}`);
+  logger.log(`node: ${process.version}`);
   showPackageVersion('playwright-bdd');
   showPackageVersion('@playwright/test');
   showPackageVersion('@cucumber/cucumber');
@@ -25,20 +27,17 @@ const envCommand = new _commander.Command('env').description('Prints environment
 exports.envCommand = envCommand;
 function showPackageVersion(packageName) {
   const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
-  _logger.logger.log(`${packageName}: v${version}`);
+  logger.log(`${packageName}: v${version}`);
 }
-
 /**
  * Getting own version by relative path instead of using getPackageVersion(),
  * to aneble using directly from /dist in tests.
  */
 function getOwnVersion() {
-  // const packageJsonPath = path.resolve(__dirname, '..', '..', '..', `package.json`);
-  // const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-  return '5.2.0';
+  return '5.3.0';
 }
 function showPlaywrightConfigPath(cliConfigPath) {
   const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
   const relPath = _path.default.relative(process.cwd(), resolvedConfigFile);
-  _logger.logger.log(`Playwright config file: ${relPath}`);
+  logger.log(`Playwright config file: ${relPath}`);
 }

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

@@ -13,13 +13,14 @@ var _logger = require("../../utils/logger");
 var _env = require("../../config/env");
 var _test = require("./test");
 var _gen = require("../../gen");
-// filter by project?
-
+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 {
     resolvedConfigFile
   } = await (0, _loadConfig.loadConfig)(opts.config);
-  _logger.logger.log(`List of all steps found by config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}\n`);
+  logger.log(`List of all steps found by config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}\n`);
   const configs = Object.values((0, _env.getEnvConfigs)());
   (0, _test.assertConfigsCount)(configs);
   await showStepsForConfigs(configs);
@@ -34,7 +35,7 @@ async function showStepsForConfigs(configs) {
     stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
   });
   await Promise.all(tasks);
-  steps.forEach(stepText => _logger.logger.log(stepText));
+  steps.forEach(stepText => logger.log(stepText));
 }
 function getStepText({
   pattern,

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

@@ -36,16 +36,6 @@ function assertConfigsCount(configs) {
     (0, _utils.exitWithMessage)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
   }
 }
-async function runInWorker(config) {
-  const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
-    workerData: {
-      config
-    }
-  });
-
-  // todo: check if worker exited with error?
-  await (0, _events.once)(worker, 'exit');
-}
 async function generateFilesForConfigs(configs, cliConfig) {
   // run first config in main thread and other in workers (to have fresh require cache)
   // See: https://github.com/vitalets/playwright-bdd/issues/32
@@ -57,4 +47,13 @@ async function generateFilesForConfigs(configs, cliConfig) {
     return index === 0 ? new _gen.TestFilesGenerator(finalConfig).generate() : runInWorker(finalConfig);
   });
   return Promise.all(tasks);
+}
+async function runInWorker(config) {
+  const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
+    workerData: {
+      config
+    }
+  });
+  // todo: check if worker exited with error?
+  await (0, _events.once)(worker, 'exit');
 }

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

@@ -11,7 +11,6 @@ var _commander = require("commander");
  */
 
 const 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.
  */

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

@@ -25,7 +25,6 @@ const defaults = {
 exports.defaults = defaults;
 function defineBddConfig(inputConfig) {
   const config = getConfig(inputConfig);
-
   // In main process store config in env to be accessible by workers
   if (!process.env.TEST_WORKER_INDEX) {
     (0, _env.saveConfigToEnv)(config);

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

@@ -24,13 +24,11 @@ function buildStepDefinition({
 }, supportCodeLibrary) {
   // todo: handle error.undefinedParameterTypeName as it's done in cucumber?
   const expression = typeof pattern === 'string' ? new _cucumberExpressions.CucumberExpression(pattern, supportCodeLibrary.parameterTypeRegistry) : new _cucumberExpressions.RegularExpression(pattern, supportCodeLibrary.parameterTypeRegistry);
-
   // skip wrapping code as it is not needed for decorator steps
   // const wrappedCode = this.wrapCode({
   //   code,
   //   wrapperOptions: options.wrapperOptions,
   // })
-
   return new _step_definition.default({
     code,
     expression,

package/build/bdd-framework/cucumber/gherkin.d.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

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

@@ -13,7 +13,6 @@ 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
  */
-/// <reference path="./gherkin.d.ts" />
 
 /**
  * Load and parse features, produce a filtered and ordered test plan and/or parse errors.

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

@@ -15,7 +15,6 @@ async function loadSteps(runConfiguration, environment = {}) {
   let lib = cache.get(cacheKey);
   if (!lib) {
     // use Playwright's built-in hook to compile TypeScript steps
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
     const uninstall = !hasTsNodeRegister(runConfiguration) ? (0, _transform.installTransform)() : () => {};
     lib = (0, _api.loadSupport)(runConfiguration, environment).finally(() => uninstall());
     cache.set(cacheKey, lib);
@@ -26,13 +25,8 @@ 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, _utils.exitWithMessage)([`Several step definitions found for text: ${stepText} (${file})`, ...matchedSteps.map(s => `- ${s.pattern}`)].join('\n'));
-  }
+  if (matchedSteps.length === 0) return;
+  if (matchedSteps.length > 1) (0, _utils.exitWithMessage)([`Several step definitions found for text: ${stepText} (${file})`, ...matchedSteps.map(s => `- ${s.pattern}`)].join('\n'));
   // todo: check stepDefinition.keyword with PickleStepType
   return matchedSteps[0];
 }

package/build/bdd-framework/decorators.js

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

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

@@ -11,6 +11,7 @@ var _jsStringWrap = require("../utils/jsStringWrap");
 
 const TAGS_FIXTURE_TEST_KEY_SEPARATOR = '|';
 class Formatter {
+  config;
   constructor(config) {
     this.config = config;
   }
@@ -19,7 +20,6 @@ class Formatter {
     let varName = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.varName) || '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)};`, ''];
   }
@@ -37,7 +37,6 @@ class Formatter {
     // prettier-ignore
     return [`test${this.getSubFn(node)}(${this.quoted(node.title)}, async ({ ${fixturesStr} }) => {`, ...children.map(indent), `});`, ''];
   }
-
   // eslint-disable-next-line max-params
   step(keyword, text, argument, fixtureNames = []) {
     const fixtures = fixtureNames.length ? `{ ${fixtureNames.join(', ')} }` : '';
@@ -50,9 +49,7 @@ class Formatter {
     return `// missing step: ${keyword}(${this.quoted(text)});`;
   }
   useFixtures(fixtures) {
-    return fixtures.length > 0 ? ['// == technical section ==',
-    // prettier-ignore
-    '', 'test.use({', ...fixtures.map(indent), '});'] : [];
+    return fixtures.length > 0 ? ['// == technical section ==', '', 'test.use({', ...fixtures.map(indent), '});'] : [];
   }
   testFixture() {
     return ['$test: ({}, use) => use(test),'];
@@ -73,13 +70,12 @@ class Formatter {
     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, {
       quotes: this.config.quotes

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

@@ -10,14 +10,11 @@ var _gherkin = require("@cucumber/gherkin");
  * See: https://github.com/cucumber/cucumber-js/blob/main/src/cli/i18n.ts
  */
 
-// todo: cache targetMap
-
 function getKeywordsMap(language) {
   const origMap = _gherkin.dialects[language];
   if (!origMap) {
     throw new Error(`Language not found: ${language}`);
   }
-  ;
   const targetMap = new Map();
   const enKeywords = Object.keys(origMap);
   enKeywords.forEach(enKeyword => handleKeyword(enKeyword, origMap, targetMap));
@@ -26,16 +23,10 @@ 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

@@ -15,7 +15,7 @@ var _loadSteps = require("../cucumber/loadSteps");
 var _config = require("../config");
 var _utils = require("../utils");
 var _snippets = require("../snippets");
-var _createDecorators = require("../stepDefinitions/createDecorators");
+var _steps = require("../stepDefinitions/decorators/steps");
 var _transform = require("../playwright/transform");
 var _dir = require("../config/dir");
 var _logger = require("../utils/logger");
@@ -24,17 +24,20 @@ var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"
  * Generate playwright test files from Gherkin documents.
  */
 
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-
 class TestFilesGenerator {
+  config;
   // all these props are exist
   runConfiguration;
   features;
   supportCodeLibrary;
   files = [];
   tagsExpression;
+  logger;
   constructor(config) {
     this.config = config;
+    this.logger = new _logger.Logger({
+      verbose: config.verbose
+    });
     if (config.tags) this.tagsExpression = (0, _tagExpressions.default)(config.tags);
   }
   async generate() {
@@ -67,14 +70,22 @@ class TestFilesGenerator {
     const environment = {
       cwd: (0, _dir.getPlaywrightConfigDir)()
     };
+    this.logger.log(`Loading features from: ${this.runConfiguration.sources.paths.join(', ')}`);
     this.features = await (0, _loadFeatures.loadFeatures)(this.runConfiguration, environment);
+    this.logger.log(`Loaded features: ${this.features.size}`);
   }
   async loadSteps() {
+    const {
+      requirePaths,
+      importPaths
+    } = this.runConfiguration.support;
+    this.logger.log(`Loading steps from: ${requirePaths.concat(importPaths).join(', ')}`);
     const environment = {
       cwd: (0, _dir.getPlaywrightConfigDir)()
     };
     this.supportCodeLibrary = await (0, _loadSteps.loadSteps)(this.runConfiguration, environment);
     await this.loadDecoratorSteps();
+    this.logger.log(`Loaded steps: ${this.supportCodeLibrary.stepDefinitions.length}`);
   }
   async loadDecoratorSteps() {
     const {
@@ -84,7 +95,7 @@ class TestFilesGenerator {
       // require importTestFrom for case when it is not required by step definitions
       // possible re-require but it's not a problem as it is cached by Node.js
       await (0, _transform.requireTransform)().requireOrImport(importTestFrom.file);
-      (0, _createDecorators.appendDecoratorSteps)(this.supportCodeLibrary);
+      (0, _steps.appendDecoratorSteps)(this.supportCodeLibrary);
     }
   }
   buildFiles() {
@@ -103,8 +114,7 @@ class TestFilesGenerator {
     const configDir = (0, _dir.getPlaywrightConfigDir)();
     // doc.uri is always relative to cwd (coming after cucumber handling)
     // see: https://github.com/cucumber/cucumber-js/blob/main/src/api/gherkin.ts#L51
-    // Check here if anything is not working
-    const relFeaturePath = doc.uri !== null ? doc.uri : null;
+    const relFeaturePath = doc.uri;
     const absFeaturePath = _path.default.resolve(configDir, relFeaturePath);
     const relOutputPath = _path.default.relative(this.config.featuresRoot, absFeaturePath);
     if (relOutputPath.startsWith('..')) {
@@ -130,20 +140,20 @@ class TestFilesGenerator {
   async saveFiles() {
     this.files.forEach(file => {
       file.save();
-      if (this.config.verbose) {
-        _logger.logger.log(`Generated: ${_path.default.relative(process.cwd(), file.outputPath)}`);
-      }
+      this.logger.log(`Generated: ${_path.default.relative(process.cwd(), file.outputPath)}`);
     });
-    if (this.config.verbose) _logger.logger.log(`Generated files: ${this.files.length}`);
+    this.logger.log(`Generated files: ${this.files.length}`);
   }
   async clearOutputDir() {
-    const testFiles = await (0, _fastGlob.default)(_path.default.join(this.config.outputDir, '**', '*.spec.js'));
+    const pattern = `${_fastGlob.default.convertPathToPattern(this.config.outputDir)}/**/*.spec.js`;
+    const testFiles = await (0, _fastGlob.default)(pattern);
+    this.logger.log(`Clearing output dir: ${testFiles.length} file(s)`);
     const tasks = testFiles.map(testFile => _promises.default.rm(testFile));
     await Promise.all(tasks);
   }
   warnForTsNodeRegister() {
     if ((0, _loadSteps.hasTsNodeRegister)(this.runConfiguration)) {
-      _logger.logger.log(`WARNING: usage of requireModule: ['ts-node/register'] is not recommended for playwright-bdd.`, `Remove this option from defineBddConfig() and`, `Playwright's built-in loader will be used to compile TypeScript step definitions.`);
+      this.logger.warn(`WARNING: usage of requireModule: ['ts-node/register'] is not recommended for playwright-bdd.`, `Remove this option from defineBddConfig() and`, `Playwright's built-in loader will be used to compile TypeScript step definitions.`);
     }
   }
 }

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

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.POMS = void 0;
 exports.buildFixtureTag = buildFixtureTag;
 var _createDecorators = require("../stepDefinitions/createDecorators");
-var _defineStep = require("../stepDefinitions/defineStep");
 /**
  * Handle POMs graph for decorator steps.
  */