@zohodesk/testinglibrary 0.1.1 → 0.1.3

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

@@ -34,7 +34,7 @@ function showPackageVersion(packageName) {
  * to aneble using directly from /dist in tests.
  */
 function getOwnVersion() {
-  return '5.3.0';
+  return '5.4.0';
 }
 function showPlaywrightConfigPath(cliConfigPath) {
   const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);

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

@@ -11,40 +11,40 @@ var _events = require("events");
 var _path = _interopRequireDefault(require("path"));
 var _commander = require("commander");
 var _gen = require("../../gen");
-var _utils = require("../../utils");
 var _loadConfig = require("../../playwright/loadConfig");
 var _env = require("../../config/env");
 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 => {
   await (0, _loadConfig.loadConfig)(opts.config);
-  const configs = Object.values((0, _env.getEnvConfigs)());
-  assertConfigsCount(configs);
-  const cliOptions = buildCliOptions(opts);
-  await generateFilesForConfigs(configs, cliOptions);
+  const configs = readConfigsFromEnv();
+  mergeCliOptions(configs, opts);
+  await generateFilesForConfigs(configs);
 });
 exports.testCommand = testCommand;
-function buildCliOptions(opts) {
-  const config = {};
-  if ('tags' in opts) config.tags = opts.tags;
-  if ('verbose' in opts) config.verbose = Boolean(opts.verbose);
-  return config;
+function readConfigsFromEnv() {
+  const configs = Object.values((0, _env.getEnvConfigs)());
+  assertConfigsCount(configs);
+  return configs;
+}
+function mergeCliOptions(configs, opts) {
+  configs.forEach(config => {
+    if ('tags' in opts) config.tags = opts.tags;
+    if ('verbose' in opts) config.verbose = Boolean(opts.verbose);
+  });
 }
 function assertConfigsCount(configs) {
   if (configs.length === 0) {
-    (0, _utils.exitWithMessage)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
+    (0, _exit.exit)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
   }
 }
-async function generateFilesForConfigs(configs, cliConfig) {
+async function generateFilesForConfigs(configs) {
   // run first config in main thread and other in workers (to have fresh require cache)
   // See: https://github.com/vitalets/playwright-bdd/issues/32
   const tasks = configs.map((config, index) => {
-    const finalConfig = {
-      ...config,
-      ...cliConfig
-    };
-    return index === 0 ? new _gen.TestFilesGenerator(finalConfig).generate() : runInWorker(finalConfig);
+    return index === 0 ? new _gen.TestFilesGenerator(config).generate() : runInWorker(config);
   });
   return Promise.all(tasks);
 }
@@ -54,6 +54,6 @@ async function runInWorker(config) {
       config
     }
   });
-  // todo: check if worker exited with error?
-  await (0, _events.once)(worker, 'exit');
+  const [exitCode] = await (0, _events.once)(worker, 'exit');
+  if (exitCode) (0, _exit.exit)();
 }

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

@@ -8,7 +8,7 @@ exports.getConfigFromEnv = getConfigFromEnv;
 exports.getEnvConfigs = getEnvConfigs;
 exports.saveConfigToEnv = saveConfigToEnv;
 var _path = _interopRequireDefault(require("path"));
-var _utils = require("../utils");
+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.
@@ -22,7 +22,7 @@ function saveConfigToEnv(config) {
     // Throw error only if different calls of defineBddConfig() use the same outputDir.
     // See: https://github.com/vitalets/playwright-bdd/issues/39#issuecomment-1653805368
     if (!isSameConfigs(config, existingConfig)) {
-      (0, _utils.exitWithMessage)(`When using several calls of defineBddConfig()`, `please manually provide different "outputDir" option.`);
+      (0, _exit.exit)(`When using several calls of defineBddConfig()`, `please manually provide different "outputDir" option.`);
     }
     return;
   }
@@ -34,7 +34,7 @@ function getConfigFromEnv(outputDir) {
   outputDir = _path.default.resolve(outputDir);
   const config = envConfigs[outputDir];
   if (!config) {
-    (0, _utils.exitWithMessage)(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
+    (0, _exit.exit)(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
   }
   return config;
 }

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

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.loadFeatures = loadFeatures;
 var _loadSources = require("./loadSources");
-var _utils = require("../utils");
+var _exit = require("../utils/exit");
 async function loadFeatures(runConfiguration, environment) {
   const {
     filteredPickles,
@@ -34,6 +34,6 @@ function handleParseErrors(parseErrors) {
     const message = parseErrors.map(parseError => {
       return `Parse error in "${parseError.source.uri}" ${parseError.message}`;
     }).join('\n');
-    (0, _utils.exitWithMessage)(message);
+    (0, _exit.exit)(message);
   }
 }

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

@@ -7,8 +7,8 @@ exports.findStepDefinition = findStepDefinition;
 exports.hasTsNodeRegister = hasTsNodeRegister;
 exports.loadSteps = loadSteps;
 var _api = require("@cucumber/cucumber/api");
-var _utils = require("../utils");
 var _transform = require("../playwright/transform");
+var _exit = require("../utils/exit");
 const cache = new Map();
 async function loadSteps(runConfiguration, environment = {}) {
   const cacheKey = JSON.stringify(runConfiguration);
@@ -26,7 +26,7 @@ function findStepDefinition(supportCodeLibrary, stepText, file) {
     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 > 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
   return matchedSteps[0];
 }

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

@@ -13,13 +13,13 @@ var _loadConfig = require("../cucumber/loadConfig");
 var _loadFeatures = require("../cucumber/loadFeatures");
 var _loadSteps = require("../cucumber/loadSteps");
 var _config = require("../config");
-var _utils = require("../utils");
 var _snippets = require("../snippets");
 var _steps = require("../stepDefinitions/decorators/steps");
 var _transform = require("../playwright/transform");
 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.
  */
@@ -41,13 +41,15 @@ class TestFilesGenerator {
     if (config.tags) this.tagsExpression = (0, _tagExpressions.default)(config.tags);
   }
   async generate() {
-    await this.loadCucumberConfig();
-    await Promise.all([this.loadFeatures(), this.loadSteps()]);
-    this.buildFiles();
-    await this.checkUndefinedSteps();
-    this.checkImportCustomTest();
-    await this.clearOutputDir();
-    await this.saveFiles();
+    await (0, _exit.withExitHandler)(async () => {
+      await this.loadCucumberConfig();
+      await Promise.all([this.loadFeatures(), this.loadSteps()]);
+      this.buildFiles();
+      await this.checkUndefinedSteps();
+      this.checkImportCustomTest();
+      await this.clearOutputDir();
+      await this.saveFiles();
+    });
   }
   async extractSteps() {
     await this.loadCucumberConfig();
@@ -118,7 +120,7 @@ class TestFilesGenerator {
     const absFeaturePath = _path.default.resolve(configDir, relFeaturePath);
     const relOutputPath = _path.default.relative(this.config.featuresRoot, absFeaturePath);
     if (relOutputPath.startsWith('..')) {
-      (0, _utils.exitWithMessage)(`All feature files should be located underneath featuresRoot.`, `Please change featuresRoot or paths in configuration.\n`, `featureFile: ${absFeaturePath}\n`, `featuresRoot: ${this.config.featuresRoot}\n`);
+      (0, _exit.exit)(`All feature files should be located underneath featuresRoot.`, `Please change featuresRoot or paths in configuration.\n`, `featureFile: ${absFeaturePath}\n`, `featuresRoot: ${this.config.featuresRoot}\n`);
     }
     const absOutputPath = _path.default.resolve(this.config.outputDir, relOutputPath);
     return `${absOutputPath}.spec.js`;
@@ -127,14 +129,15 @@ class TestFilesGenerator {
     const undefinedSteps = this.files.reduce((sum, file) => sum + file.undefinedSteps.length, 0);
     if (undefinedSteps > 0) {
       const snippets = new _snippets.Snippets(this.files, this.runConfiguration, this.supportCodeLibrary);
-      await snippets.printSnippetsAndExit();
+      await snippets.print();
+      (0, _exit.exit)();
     }
   }
   checkImportCustomTest() {
     if (this.config.importTestFrom) return;
     const hasCustomTest = this.files.some(file => file.hasCustomTest);
     if (hasCustomTest) {
-      (0, _utils.exitWithMessage)(`When using custom "test" function in createBdd() you should`, `set "importTestFrom" config option that points to file exporting custom test.`);
+      (0, _exit.exit)(`When using custom "test" function in createBdd() you should`, `set "importTestFrom" config option that points to file exporting custom test.`);
     }
   }
   async saveFiles() {

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

@@ -16,6 +16,7 @@ var _utils = require("../utils");
 var _testPoms = require("./testPoms");
 var _testNode = require("./testNode");
 var _stepConfig = require("../stepDefinitions/stepConfig");
+var _exit = require("../utils/exit");
 /**
  * Generate test code.
  */
@@ -116,7 +117,7 @@ class TestFile {
     throw new Error(`Empty child: ${JSON.stringify(child)}`);
   }
   getScenarioLines(scenario, parent) {
-    return isOutline(scenario) ? this.getOutlineSuite(scenario, parent) : this.getTest(scenario, parent);
+    return this.isOutline(scenario) ? this.getOutlineSuite(scenario, parent) : this.getTest(scenario, parent);
   }
   /**
      * Generate test.beforeEach for Background
@@ -293,12 +294,7 @@ class TestFile {
   }
   getStepKeyword(step) {
     const origKeyword = step.keyword.trim();
-    let enKeyword;
-    if (origKeyword === '*') {
-      enKeyword = 'And';
-    } else {
-      enKeyword = this.i18nKeywordsMap ? this.i18nKeywordsMap.get(origKeyword) : origKeyword;
-    }
+    const enKeyword = origKeyword === '*' ? 'And' : this.getEnglishKeyword(origKeyword);
     if (!enKeyword) throw new Error(`Keyword not found: ${origKeyword}`);
     return enKeyword;
   }
@@ -312,7 +308,7 @@ class TestFile {
     if (resolvedFixtures.length !== 1) {
       const suggestedTags = resolvedFixtures.filter(f => !f.byTag).map(f => (0, _testPoms.buildFixtureTag)(f.name)).join(', ');
       const suggestedTagsStr = suggestedTags.length ? ` or set one of the following tags: ${suggestedTags}` : '.';
-      (0, _utils.exitWithMessage)(`Can't guess fixture for decorator step "${pickleStep.text}" in file: ${this.sourceFile}.`, `Please refactor your Page Object classes${suggestedTagsStr}`);
+      (0, _exit.exit)(`Can't guess fixture for decorator step "${pickleStep.text}" in file: ${this.sourceFile}.`, `Please refactor your Page Object classes${suggestedTagsStr}`);
     }
     const fixtureName = resolvedFixtures[0].name;
     return {
@@ -349,8 +345,12 @@ class TestFile {
     // see: https://github.com/cucumber/tag-expressions/tree/main/javascript
     return ((_this$options$tagsExp = this.options.tagsExpression) === null || _this$options$tagsExp === void 0 ? void 0 : _this$options$tagsExp.evaluate(node.tags)) === false;
   }
+  isOutline(scenario) {
+    const keyword = this.getEnglishKeyword(scenario.keyword);
+    return keyword === 'ScenarioOutline' || keyword === 'Scenario Outline' || keyword === 'Scenario Template';
+  }
+  getEnglishKeyword(keyword) {
+    return this.i18nKeywordsMap ? this.i18nKeywordsMap.get(keyword) : keyword;
+  }
 }
-exports.TestFile = TestFile;
-function isOutline(scenario) {
-  return scenario.keyword === 'Scenario Outline' || scenario.keyword === 'Scenario Template';
-}
+exports.TestFile = TestFile;

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

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.TestPoms = void 0;
 exports.buildFixtureTag = buildFixtureTag;
 var _poms = require("../stepDefinitions/decorators/poms");
-var _utils = require("../utils");
+var _exit = require("../utils/exit");
 /**
  * Track PomNodes used in the particular test.
  * To select correct fixture for decorator steps.
@@ -110,7 +110,7 @@ class TestPoms {
     if (!usedPom.byTag) return;
     const childFixturesBySteps = childFixtures.filter(f => !f.byTag);
     if (childFixturesBySteps.length) {
-      (0, _utils.exitWithMessage)(`Scenario "${this.title}" contains ${childFixturesBySteps.length} step(s)`, `not compatible with required fixture "${pomNode.fixtureName}"`);
+      (0, _exit.exit)(`Scenario "${this.title}" contains ${childFixturesBySteps.length} step(s)`, `not compatible with required fixture "${pomNode.fixtureName}"`);
     }
   }
 }

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

@@ -10,7 +10,7 @@ var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _utils = require("./utils");
 var _transform = require("./transform");
-var _utils2 = require("../utils");
+var _exit = require("../utils/exit");
 /**
  * Loading Playwright config.
  * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/configLoader.ts
@@ -37,6 +37,6 @@ function getConfigFilePath(cliConfigPath) {
 function assertConfigFileExists(resolvedConfigFile, cliConfigPath) {
   if (!resolvedConfigFile || !_fs.default.existsSync(resolvedConfigFile)) {
     const configFilePath = getConfigFilePath(cliConfigPath);
-    (0, _utils2.exitWithMessage)(`Can't find Playwright config file in: ${configFilePath}`);
+    (0, _exit.exit)(`Can't find Playwright config file in: ${configFilePath}`);
   }
 }

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

@@ -3,8 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getTestImpl = getTestImpl;
 exports.isParentChildTest = isParentChildTest;
+exports.runStepWithCustomLocation = runStepWithCustomLocation;
 var _test = require("@playwright/test");
 var _utils = require("../utils");
 /**
@@ -22,6 +22,22 @@ function getTestFixtures(test) {
 function getTestImpl(test) {
   return test[testTypeSymbol];
 }
+/**
+ * Run step with location pointing to Given, When, Then call.
+ */
+// eslint-disable-next-line max-params
+async function runStepWithCustomLocation(test, stepText, location, body) {
+  const testInfo = test.info();
+  // See: https://github.com/microsoft/playwright/blob/main/packages/playwright/src/common/testType.ts#L221
+  // @ts-expect-error _runAsStep is hidden from public
+  return testInfo._runAsStep({
+    category: 'test.step',
+    title: stepText,
+    location
+  }, async () => {
+    return await body();
+  });
+}
 /**
  * Returns true if all fixtures of parent test found in child test.
  */

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

@@ -28,7 +28,10 @@ function getPlaywrightRoot() {
     // See: https://github.com/microsoft/playwright/pull/26946
     const playwrightTestRoot = (0, _utils.resolvePackageRoot)('@playwright/test');
     const libDir = _path.default.join(playwrightTestRoot, 'lib');
-    playwrightRoot = _fs.default.existsSync(libDir) ? playwrightTestRoot : (0, _utils.resolvePackageRoot)('playwright');
+
+    // Recently added functionality in playwright
+    const playwrightDir = _path.default.join(playwrightTestRoot, 'node_modules', 'playwright');
+    playwrightRoot = _fs.default.existsSync(libDir) ? playwrightTestRoot : playwrightDir;
   }
   return playwrightRoot;
 }

package/build/bdd-framework/run/bddWorld.js

@@ -27,7 +27,8 @@ class BddWorld extends _cucumber.World {
     // attach custom fixtures to world - the only way to pass them to cucumber step fn
     this.customFixtures = customFixtures;
     const code = (0, _defineStep.getStepCode)(stepDefinition);
-    // get location of step call in generated test file
+    // Get location of step call in generated test file.
+    // This call must be exactly here to have correct call stack.
     const location = (0, _getLocationInFile.getLocationInFile)(this.test.info().file);
     const {
       parameters
@@ -39,7 +40,7 @@ class BddWorld extends _cucumber.World {
       },
       world: this
     });
-    const res = await (0, _testTypeImpl.getTestImpl)(this.test)._step(location, text, () => code.apply(this, parameters));
+    const res = await (0, _testTypeImpl.runStepWithCustomLocation)(this.test, text, location, () => code.apply(this, parameters));
     delete this.customFixtures;
     return res;
   }

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

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.Snippets = void 0;
 var _loadSnippetBuilder = require("../cucumber/loadSnippetBuilder");
-var _utils = require("../utils");
 var _logger = require("../utils/logger");
 var _stepConfig = require("../stepDefinitions/stepConfig");
 /**
@@ -23,13 +22,15 @@ class Snippets {
     this.runConfiguration = runConfiguration;
     this.supportCodeLibrary = supportCodeLibrary;
   }
-  async printSnippetsAndExit() {
+  async print() {
     this.snippetBuilder = await this.createSnippetBuilder();
     const snippets = this.getSnippets();
     this.printHeader();
     this.printSnippets(snippets);
     this.printFooter(snippets);
+    // exit();
   }
+
   async createSnippetBuilder() {
     const {
       snippetInterface
@@ -117,15 +118,18 @@ class Snippets {
     _logger.logger.error(snippets.concat(['']).join('\n\n'));
   }
   printFooter(snippets) {
-    (0, _utils.exitWithMessage)(`Missing step definitions (${snippets.length}).`, 'Use snippets above to create them.', this.getWarnOnZeroScannedFiles());
+    _logger.logger.error(`Missing step definitions (${snippets.length}).`, `Use snippets above to create them.`);
+    this.printWarningOnZeroScannedFiles();
   }
-  getWarnOnZeroScannedFiles() {
+  printWarningOnZeroScannedFiles() {
     const {
       requirePaths,
       importPaths
     } = this.supportCodeLibrary.originalCoordinates;
     const scannedFilesCount = requirePaths.length + importPaths.length;
-    return scannedFilesCount === 0 && !this.isDecorators() ? `\nNote that 0 step definition files found, check the config.` : '';
+    if (scannedFilesCount === 0 && !this.isDecorators()) {
+      _logger.logger.error(`Note that 0 step definition files found, check the config.`);
+    }
   }
 }
 exports.Snippets = Snippets;

package/build/bdd-framework/stepDefinitions/createBdd.js

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 exports.createBdd = createBdd;
 exports.extractFixtureNames = extractFixtureNames;
 var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _utils = require("../utils");
 var _bddFixtures = require("../run/bddFixtures");
 var _testTypeImpl = require("../playwright/testTypeImpl");
 var _defineStep = require("./defineStep");
+var _exit = require("../utils/exit");
 /**
  * Stuff related to writing steps in Playwright-style.
  */
@@ -43,7 +43,7 @@ function extractFixtureNames(fn) {
 function isCustomTest(customTest) {
   const isCustomTest = Boolean(customTest && customTest !== _bddFixtures.test);
   if (isCustomTest && customTest && !(0, _testTypeImpl.isParentChildTest)(_bddFixtures.test, customTest)) {
-    (0, _utils.exitWithMessage)(`createBdd() should use test extended from "playwright-bdd"`);
+    (0, _exit.exit)(`createBdd() should use test extended from "@zohodesk/testinglibrary"`);
   }
   return isCustomTest;
 }

package/build/bdd-framework/stepDefinitions/decorators/poms.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.Fixture = Fixture;
 exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
 var _steps = require("./steps");
+var _exit = require("../../utils/exit");
 /**
  * POM classes marked with @Fixture
  */
@@ -20,25 +21,38 @@ const pomGraph = new Map();
  */
 function Fixture(fixtureName) {
   // context parameter is required for decorator by TS even though it's not used
-  // eslint-disable-next-line no-unused-vars
-  return (Ctor, _context) => {
+  return Ctor => {
     createPomNode(Ctor, fixtureName);
   };
 }
 function createPomNode(Ctor, fixtureName) {
   const pomNode = {
     fixtureName,
+    className: Ctor.name,
     children: new Set()
   };
+  ensureUniqueFixtureName(pomNode);
   pomGraph.set(Ctor, pomNode);
   (0, _steps.linkStepsWithPomNode)(Ctor, pomNode);
   linkParentWithPomNode(Ctor, pomNode);
   return pomNode;
 }
+function ensureUniqueFixtureName({
+  fixtureName,
+  className
+}) {
+  if (!fixtureName) {
+    return;
+  }
+  const existingPom = getPomNodeByFixtureName(fixtureName);
+  if (existingPom) {
+    (0, _exit.exit)(`Duplicate fixture name "${fixtureName}"`, `defined for classes: ${existingPom.className}, ${className}`);
+  }
+}
 function linkParentWithPomNode(Ctor, pomNode) {
   const parentCtor = Object.getPrototypeOf(Ctor);
   if (!parentCtor) return;
-  // if parentCtor is not in pomGraph, add it as well
+  // if parentCtor is not in pomGraph, add it.
   // Case: parent class is not marked with @Fixture, but has decorator steps (base class)
   const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
   parentPomNode.children.add(pomNode);

package/build/bdd-framework/stepDefinitions/defineStep.js

@@ -7,7 +7,7 @@ exports.buildCucumberStepCode = buildCucumberStepCode;
 exports.defineStep = defineStep;
 exports.getStepCode = getStepCode;
 var _cucumber = require("@cucumber/cucumber");
-var _utils = require("../utils");
+var _exit = require("../utils/exit");
 /**
  * Defines step by config.
  * Calls cucumber's Given(), When(), Then() under the hood.
@@ -26,7 +26,7 @@ function defineStep(stepConfig) {
     // and skip/delay registering cucumber steps until cucumber is loaded
     const isMissingCucumber = /Cucumber that isn't running/i.test(e.message);
     if (isMissingCucumber) {
-      (0, _utils.exitWithMessage)(`Option "importTestFrom" should point to separate file without step definitions`, `(e.g. without calls of Given, When, Then)`);
+      (0, _exit.exit)(`Option "importTestFrom" should point to a separate file without step definitions`, `(e.g. without calls of Given, When, Then)`);
     } else {
       throw e;
     }

package/build/bdd-framework/utils/exit.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.exit = exit;
+exports.withExitHandler = withExitHandler;
+var _logger = require("./logger");
+var _worker_threads = require("worker_threads");
+/**
+ * Exit utils.
+ *
+ * When calling process.exit() in worker thread used for file generation,
+ * logs are not flushed (https://github.com/vitalets/playwright-bdd/issues/59).
+ * That's why instead of process.exit we throw ExitError
+ * that just sets process.exitCode = 1 and allow program to exit normally.
+ *
+ * On the other hand, when running in main thread, especially inside Playwright,
+ * thrown error is captured by Playwright and show with additional messages (e.g. no tests found).
+ * That's why in main thread we to call process.exit() to show only needed error.
+ *
+ * Relevant discussions:
+ * - https://github.com/nodejs/node/issues/6379
+ * - https://github.com/nodejs/node-v0.x-archive/issues/3737
+ * - https://github.com/cucumber/cucumber-js/pull/123
+ */
+
+class ExitError extends Error {
+  get stack() {
+    return '';
+  }
+}
+async function withExitHandler(fn) {
+  try {
+    return await fn();
+  } catch (e) {
+    if (e instanceof ExitError) {
+      process.exitCode = 1;
+    } else {
+      throw e;
+    }
+  }
+}
+function exit(...messages) {
+  messages = messages.filter(Boolean);
+  if (_worker_threads.isMainThread) {
+    if (messages.length) _logger.logger.error('Error:', ...messages);
+    process.exit(1);
+  } else {
+    throw new ExitError(messages.join(' '));
+  }
+}

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

@@ -4,7 +4,6 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.exitWithMessage = exitWithMessage;
 exports.getPackageVersion = getPackageVersion;
 exports.getSymbolByName = getSymbolByName;
 exports.removeDuplicates = removeDuplicates;
@@ -12,11 +11,6 @@ exports.resolvePackageRoot = resolvePackageRoot;
 exports.template = template;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
-var _logger = require("./logger");
-function exitWithMessage(...messages) {
-  _logger.logger.error('ERROR:', ...messages.filter(Boolean));
-  process.exit(1);
-}
 // See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
 function getSymbolByName(target, name) {
   const ownKeys = Reflect.ownKeys(target);

package/build/core/playwright/readConfigFile.js

@@ -36,9 +36,20 @@ function getDefaultConfig() {
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
   let defaultConfig = getDefaultConfig();
+  let configurationObj = {};
+  Object.keys(userConfiguration).forEach(configKey => {
+    let configValue = userConfiguration[configKey];
+    if (configValue && configValue !== null) {
+      configurationObj[configKey] = configValue;
+    } else if (defaultConfig[configKey]) {
+      configurationObj[configKey] = defaultConfig[configKey];
+    } else {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `key - ${configKey} is not yet supported in uat configuration. This will not be used while creating playwright configuration`);
+    }
+  });
   return {
     ...defaultConfig,
-    ...userConfiguration
+    ...configurationObj
   };
 }
 

package/build/core/playwright/setup/config-creator.js

@@ -20,7 +20,9 @@ const {
   expectTimeout,
   testTimeout,
   authFilePath,
-  viewport
+  viewport,
+  featureFilesFolder,
+  stepDefinitionsFolder
 } = (0, _readConfigFile.generateConfigFromFile)();
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -30,7 +32,10 @@ const projects = (0, _configUtils.getProjects)({
   testTimeout,
   viewport
 });
-const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd());
+const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
+  featureFilesFolder,
+  stepDefinitionsFolder
+});
 function getPlaywrightConfig() {
   return {
     testDir,

package/build/core/playwright/setup/config-utils.js

@@ -98,10 +98,12 @@ function getProjects({
     viewport
   })).filter(Boolean);
 }
-function getTestDir(bddMode, cwd) {
+function getTestDir(bddMode, cwd, {
+  stepDefinitionsFolder
+}) {
   return bddMode ? (0, _bddFramework.defineBddConfig)({
     paths: [_path.default.join(cwd, 'uat', '**', '*.feature')],
-    import: [_path.default.join(cwd, 'uat', '**', 'steps', '*.spec.js')],
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
     publish: true

package/build/core/playwright/test-runner.js

@@ -73,6 +73,14 @@ function runPlaywright(command, args) {
         resolve();
       }
     });
+    process.on('exit', () => {
+      //childProcessForRunningPlaywright.kill();
+      reject('Terminating Playwright Process...');
+    });
+    process.on('SIGINT', () => {
+      //childProcessForRunningPlaywright.kill();
+      reject('Cleaning up...');
+    });
   });
 }
 function main() {
@@ -97,7 +105,7 @@ function main() {
   }
   Promise.all(promises).then(() => runPlaywright(command, args)).catch(err => {
     _logger.Logger.log(_logger.Logger.FAILURE_TYPE, err);
-    process.exit(1);
+    process.exit();
   });
 }
 var _default = main;

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -36,7 +36,8 @@ module.exports = {
   authFilePath: 'uat/playwright/.auth/user.json',
   trace: true,
   video: true,
+  bddMode: true,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
-  viewport: null
+  viewport: { width: 1280, height: 720 }
 }

package/{Changelog.md → changelog.md}

@@ -2,6 +2,16 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.1.3
+
+- uat config sample file updated with `bddMode` and `viewport` values
+- user configuration issue fix when the value is undefined
+
+# 0.1.2
+
+- Bdd version updated to `5.4.0`
+- Playwright version updated to `1.39.0`
+
 # 0.1.1
 
 - Fixed post install script error

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.0-exp.4",
+  "version": "0.1.1-exp.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2577,13 +2577,22 @@
       "integrity": "sha512-Aq58f5HiWdyDlFffbbSjAlv596h/cOnt2DO1w3DOC7OJ5EHs0hd/nycJfiu9RJbT6Yk6F1knnRRXNSpxoIVZ9Q=="
     },
     "@playwright/test": {
-      "version": "1.37.1",
-      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.37.1.tgz",
-      "integrity": "sha512-bq9zTli3vWJo8S3LwB91U0qDNQDpEXnw7knhxLM0nwDvexQAwx9tO8iKDZSqqneVq+URd/WIoz+BALMqUTgdSg==",
+      "version": "1.39.0",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.39.0.tgz",
+      "integrity": "sha512-3u1iFqgzl7zr004bGPYiN/5EZpRUSFddQBra8Rqll5N0/vfpqlP9I9EXqAoGacuAbX6c9Ulg/Cjqglp5VkK6UQ==",
       "requires": {
-        "@types/node": "*",
-        "fsevents": "2.3.2",
-        "playwright-core": "1.37.1"
+        "playwright": "1.39.0"
+      },
+      "dependencies": {
+        "playwright": {
+          "version": "1.39.0",
+          "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.39.0.tgz",
+          "integrity": "sha512-naE5QT11uC/Oiq0BwZ50gDmy8c8WLPRTEWuSSFVG2egBka/1qMoSqYQcROMT9zLwJ86oPofcTH2jBY/5wWOgIw==",
+          "requires": {
+            "fsevents": "2.3.2",
+            "playwright-core": "1.39.0"
+          }
+        }
       }
     },
     "@sinclair/typebox": {
@@ -6715,9 +6724,9 @@
       }
     },
     "playwright-core": {
-      "version": "1.37.1",
-      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.37.1.tgz",
-      "integrity": "sha512-17EuQxlSIYCmEMwzMqusJ2ztDgJePjrbttaefgdsiqeLWidjYz9BxXaTaZWxH1J95SHGk6tjE+dwgWILJoUZfA=="
+      "version": "1.39.0",
+      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.39.0.tgz",
+      "integrity": "sha512-+k4pdZgs1qiM+OUkSjx96YiKsXsmb59evFoqv8SKO067qBA+Z2s/dCzJij/ZhdQcs2zlTAgRKfeiiLm8PQ2qvw=="
     },
     "pretty-format": {
       "version": "29.7.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@babel/preset-react": "7.22.5",
     "@cucumber/cucumber": "9.2.0",
-    "@playwright/test": "1.37.1",
+    "@playwright/test": "1.39.0",
     "@testing-library/jest-dom": "5.11.9",
     "@testing-library/react": "11.2.7",
     "@testing-library/react-hooks": "7.0.2",