@zohodesk/testinglibrary 0.1.7 → 0.1.8-exp-bdd

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

@@ -7,33 +7,27 @@ Object.defineProperty(exports, "__esModule", {
 exports.getLocationInFile = getLocationInFile;
 var _url = _interopRequireDefault(require("url"));
 var _utils = require("./utils");
-/**
- * Inspects stacktrace and finds call location in provided file.
- * This function is based on Playwright's getLocationByStacktrace().
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/transform.ts#L229
+/**
+ * Inspects stacktrace and finds call location in provided file.
+ * This function is based on Playwright's getLocationByStacktrace().
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/transform.ts#L229
  */
 function getLocationInFile(filePath) {
-  const filePathUrl = _url.default.pathToFileURL(filePath).toString();
   const {
     sourceMapSupport
   } = (0, _utils.requirePlaywrightModule)('lib/utilsBundle.js');
   const oldPrepareStackTrace = Error.prepareStackTrace;
   Error.prepareStackTrace = (error, stackFrames) => {
-    const frameInFile = stackFrames.find(frame => {
-      const frameFile = frame.getFileName();
-      return frameFile === filePath || frameFile === filePathUrl;
-    });
-    if (!frameInFile) {
-      return {
-        file: '',
-        line: 0,
-        column: 0
-      };
-    }
+    const frameInFile = stackFrames.find(frame => frame.getFileName() === filePath);
+    if (!frameInFile) return {
+      file: '',
+      line: 0,
+      column: 0
+    };
     const frame = sourceMapSupport.wrapCallSite(frameInFile);
     const fileName = frame.getFileName();
     // Node error stacks for modules use file:// urls instead of paths.
-    const file = fileName !== null && fileName !== void 0 && fileName.startsWith('file://') ? _url.default.fileURLToPath(fileName) : fileName;
+    const file = fileName && fileName.startsWith('file://') ? _url.default.fileURLToPath(fileName) : fileName;
     return {
       file,
       line: frame.getLineNumber(),

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

@@ -11,9 +11,9 @@ var _fs = _interopRequireDefault(require("fs"));
 var _utils = require("./utils");
 var _transform = require("./transform");
 var _exit = require("../utils/exit");
-/**
- * Loading Playwright config.
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/configLoader.ts
+/**
+ * Loading Playwright config.
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/configLoader.ts
  */
 
 async function loadConfig(cliConfigPath) {

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

@@ -3,18 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isTestContainsSubtest = isTestContainsSubtest;
+exports.isParentChildTest = isParentChildTest;
 exports.runStepWithCustomLocation = runStepWithCustomLocation;
 var _test = require("@playwright/test");
 var _utils = require("../utils");
-/**
- * Helpers to deal with Playwright test internal stuff.
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/testType.ts
+/**
+ * Helpers to deal with Playwright test internal stuff.
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/common/testType.ts
  */
 
 const testTypeSymbol = (0, _utils.getSymbolByName)(_test.test, 'testType');
-/**
- * Returns test fixtures using Symbol.
+/**
+ * Returns test fixtures using Symbol.
  */
 function getTestFixtures(test) {
   return getTestImpl(test).fixtures;
@@ -22,8 +22,8 @@ function getTestFixtures(test) {
 function getTestImpl(test) {
   return test[testTypeSymbol];
 }
-/**
- * Run step with location pointing to Given, When, Then call.
+/**
+ * Run step with location pointing to Given, When, Then call.
  */
 // eslint-disable-next-line max-params
 async function runStepWithCustomLocation(test, stepText, location, body) {
@@ -38,18 +38,14 @@ async function runStepWithCustomLocation(test, stepText, location, body) {
     return await body();
   });
 }
-/**
- * Returns true if test contains all fixtures of subtest.
- * - test was extended from subtest
- * - test is a result of mergeTests(subtest, ...)
+/**
+ * Returns true if all fixtures of parent test found in child test.
  */
-function isTestContainsSubtest(test, subtest) {
-  if (test === subtest) {
-    return true;
-  }
-  const testFixtures = new Set(getTestFixtures(test).map(f => locationToString(f.location)));
-  return getTestFixtures(subtest).every(f => {
-    return testFixtures.has(locationToString(f.location));
+function isParentChildTest(parent, child) {
+  if (parent === child) return false;
+  const childLocationsSet = new Set(getTestFixtures(child).map(f => locationToString(f.location)));
+  return getTestFixtures(parent).every(f => {
+    return childLocationsSet.has(locationToString(f.location));
   });
 }
 function locationToString({

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

@@ -11,10 +11,10 @@ var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _utils = require("./utils");
 /* eslint-disable max-params */
-/**
- * Installs require hook to transform ts.
- * Extracted from playwright.
- * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/transform/transform.ts
+/**
+ * Installs require hook to transform ts.
+ * Extracted from playwright.
+ * See: https://github.com/microsoft/playwright/blob/main/packages/playwright-test/src/transform/transform.ts
  */
 function installTransform() {
   const {
@@ -30,17 +30,13 @@ function installTransform() {
   function resolveFilename(specifier, parent, ...rest) {
     if (!reverted && parent) {
       const resolved = resolveHook(parent.filename, specifier);
-      if (resolved !== undefined) {
-        specifier = resolved;
-      }
+      if (resolved !== undefined) specifier = resolved;
     }
     return originalResolveFilename.call(this, specifier, parent, ...rest);
   }
   _module.default._resolveFilename = resolveFilename;
   const revertPirates = pirates.addHook((code, filename) => {
-    if (!shouldTransform(filename)) {
-      return code;
-    }
+    if (!shouldTransform(filename)) return code;
     return transformHook(code, filename);
   }, {
     exts: ['.ts', '.tsx', '.js', '.jsx', '.mjs']

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

@@ -11,8 +11,8 @@ var _path = _interopRequireDefault(require("path"));
 var _utils = require("../utils");
 // cache playwright root
 let playwrightRoot = '';
-/**
- * Requires Playwright's internal module that is not exported via package.exports.
+/**
+ * Requires Playwright's internal module that is not exported via package.exports.
  */
 function requirePlaywrightModule(modulePath) {
   const absPath = _path.default.isAbsolute(modulePath) ? modulePath : getPlaywrightModulePath(modulePath);
@@ -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/bddFixtures.js

@@ -13,15 +13,12 @@ var _config = require("../config");
 var _env = require("../config/env");
 var _steps = require("../stepDefinitions/decorators/steps");
 var _dir = require("../config/dir");
-var _scenario = require("../hooks/scenario");
-var _worker = require("../hooks/worker");
-var _StepInvoker = require("./StepInvoker");
 const test = exports.test = _test.test.extend({
-  // load cucumber once per worker (auto-fixture)
-  // todo: maybe remove caching in cucumber/loadConfig.ts and cucumber/loadSteps.ts
-  // as we call it once per worker. Check generation phase.
-  $cucumber: [async ({}, use, workerInfo) => {
-    const config = (0, _env.getConfigFromEnv)(workerInfo.project.testDir);
+  $bddWorldBase: async ({
+    $tags,
+    $test
+  }, use, testInfo) => {
+    const config = (0, _env.getConfigFromEnv)(testInfo.project.testDir);
     const environment = {
       cwd: (0, _dir.getPlaywrightConfigDir)()
     };
@@ -33,37 +30,11 @@ const test = exports.test = _test.test.extend({
     const supportCodeLibrary = await (0, _loadSteps.loadSteps)(runConfiguration, environment);
     (0, _steps.appendDecoratorSteps)(supportCodeLibrary);
     const World = (0, _bddWorld.getWorldConstructor)(supportCodeLibrary);
-    await use({
-      runConfiguration,
-      supportCodeLibrary,
-      World
-    });
-  }, {
-    auto: true,
-    scope: 'worker'
-  }],
-  $lang: ({}, use) => use(''),
-  // init $bddWorldFixtures with empty object, will be owerwritten in test file for cucumber-style
-  $bddWorldFixtures: ({}, use) => use({}),
-  $bddWorld: async ({
-    $tags,
-    $test,
-    $bddWorldFixtures,
-    $cucumber,
-    $lang
-  }, use, testInfo) => {
-    const {
-      runConfiguration,
-      supportCodeLibrary,
-      World
-    } = $cucumber;
     const world = new World({
       testInfo,
       supportCodeLibrary,
       $tags,
       $test,
-      $bddWorldFixtures,
-      lang: $lang,
       parameters: runConfiguration.runtime.worldParameters || {},
       log: () => {},
       attach: async () => {}
@@ -72,97 +43,63 @@ const test = exports.test = _test.test.extend({
     await use(world);
     await world.destroy();
   },
+  $bddWorld: async ({
+    $bddWorldBase,
+    page,
+    context,
+    browser,
+    browserName,
+    request
+  }, use) => {
+    $bddWorldBase.builtinFixtures = {
+      page,
+      context,
+      browser,
+      browserName,
+      request
+    };
+    await use($bddWorldBase);
+  },
+  // below fixtures are used in playwright-style
+  // and does not automatically init Playwright builtin fixtures
   Given: ({
-    $bddWorld
-  }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'Given').invoke),
+    $bddWorldBase
+  }, use) => use($bddWorldBase.invokeStep),
   When: ({
-    $bddWorld
-  }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'When').invoke),
+    $bddWorldBase
+  }, use) => use($bddWorldBase.invokeStep),
   Then: ({
-    $bddWorld
-  }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'Then').invoke),
+    $bddWorldBase
+  }, use) => use($bddWorldBase.invokeStep),
   And: ({
-    $bddWorld
-  }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'And').invoke),
+    $bddWorldBase
+  }, use) => use($bddWorldBase.invokeStep),
   But: ({
+    $bddWorldBase
+  }, use) => use($bddWorldBase.invokeStep),
+  // below fixtures are used in cucumber-style
+  // and automatically init Playwright builtin fixtures
+  Given_: ({
+    $bddWorld
+  }, use) => use($bddWorld.invokeStep),
+  When_: ({
+    $bddWorld
+  }, use) => use($bddWorld.invokeStep),
+  Then_: ({
     $bddWorld
-  }, use) => use(new _StepInvoker.StepInvoker($bddWorld, 'But').invoke),
-  // init $tags with empty array, can be owerwritten in test file
+  }, use) => use($bddWorld.invokeStep),
+  And_: ({
+    $bddWorld
+  }, use) => use($bddWorld.invokeStep),
+  But_: ({
+    $bddWorld
+  }, use) => use($bddWorld.invokeStep),
+  // Init $tags fixture with empty array. Can be owerwritten in test file
+  // eslint-disable-next-line
   $tags: ({}, use) => use([]),
-  // init $test with base test, but it will be always overwritten in test file
-  $test: ({}, use) => use(_test.test),
-  // can be owerwritten in test file if there are scenario hooks
-  $scenarioHookFixtures: ({}, use) => use({}),
-  $before: [
-  // Unused dependencies are important:
-  // 1. $beforeAll / $afterAll: in pw < 1.39 worker-scoped auto-fixtures were called after test-scoped
-  // 2. $after: to call after hooks in case of errors in before hooks
-  async ({
-    $scenarioHookFixtures,
-    $bddWorld,
-    $tags,
-    $beforeAll,
-    $afterAll,
-    $after
-  }, use, $testInfo) => {
-    await (0, _scenario.runScenarioHooks)('before', {
-      $bddWorld,
-      $tags,
-      $testInfo,
-      ...$scenarioHookFixtures
-    });
-    await use();
-  }, {
-    auto: true
-  }],
-  $after: [async ({
-    $scenarioHookFixtures,
-    $bddWorld,
-    $tags
-  }, use, $testInfo) => {
-    await use();
-    await (0, _scenario.runScenarioHooks)('after', {
-      $bddWorld,
-      $tags,
-      $testInfo,
-      ...$scenarioHookFixtures
-    });
-  }, {
-    auto: true
-  }],
-  // can be owerwritten in test file if there are worker hooks
-  $workerHookFixtures: [({}, use) => use({}), {
-    scope: 'worker'
-  }],
-  $beforeAll: [
-  // Important unused dependencies:
-  // 1. $afterAll: in pw < 1.39 worker-scoped auto-fixtures are called in incorrect order
-  // 2. $cucumber: to load hooks before this fixtures
-  async ({
-    $workerHookFixtures,
-    $cucumber
-  }, use, $workerInfo) => {
-    await (0, _worker.runWorkerHooks)('beforeAll', {
-      $workerInfo,
-      ...$workerHookFixtures
-    });
-    await use();
-  }, {
-    auto: true,
-    scope: 'worker'
-  }],
-  $afterAll: [async ({
-    $workerHookFixtures
-  }, use, $workerInfo) => {
-    await use();
-    await (0, _worker.runWorkerHooks)('afterAll', {
-      $workerInfo,
-      ...$workerHookFixtures
-    });
-  }, {
-    auto: true,
-    scope: 'worker'
-  }]
+  // Init $test fixture with base test, but it will be always overwritten in test file
+  // eslint-disable-next-line
+  $test: ({}, use) => use(_test.test)
 });
 const BDD_AUTO_INJECT_FIXTURES = ['$testInfo', '$test', '$tags'];
 function isBddAutoInjectFixture(name) {

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

@@ -6,46 +6,58 @@ Object.defineProperty(exports, "__esModule", {
 exports.BddWorld = void 0;
 exports.getWorldConstructor = getWorldConstructor;
 var _cucumber = require("@cucumber/cucumber");
+var _loadSteps = require("../cucumber/loadSteps");
+var _getLocationInFile = require("../playwright/getLocationInFile");
+var _testTypeImpl = require("../playwright/testTypeImpl");
+var _defineStep = require("../stepDefinitions/defineStep");
 class BddWorld extends _cucumber.World {
   options;
-  stepFixtures = {};
+  builtinFixtures;
+  customFixtures;
   constructor(options) {
     super(options);
     this.options = options;
+    this.invokeStep = this.invokeStep.bind(this);
   }
-  /**
-     * Use particular fixture in cucumber-style steps.
-     *
-     * Note: TS does not support partial generic inference,
-     * that's why we can't use this.useFixture<typeof test>('xxx');
-     * The solution is to pass TestType as a generic to BddWorld
-     * and call useFixture without explicit generic params.
-     * Finally, it looks even better as there is no need to pass `typeof test`
-     * in every `this.useFixture` call.
-     *
-     * The downside - it's impossible to pass fixtures type directly to `this.useFixture`
-     * like it's done in @Fixture decorator.
-     *
-     * See: https://stackoverflow.com/questions/45509621/specify-only-first-type-argument
-     * See: https://github.com/Microsoft/TypeScript/pull/26349
-     */
-  useFixture(fixtureName) {
-    return this.stepFixtures[fixtureName];
+  async invokeStep(text, argument, customFixtures) {
+    const stepDefinition = (0, _loadSteps.findStepDefinition)(this.options.supportCodeLibrary, text, this.testInfo.file);
+    if (!stepDefinition) {
+      throw new Error(`Undefined step: "${text}"`);
+    }
+    // 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.
+    // This call must be exactly here to have correct call stack.
+    const location = (0, _getLocationInFile.getLocationInFile)(this.test.info().file);
+    const {
+      parameters
+    } = await stepDefinition.getInvocationParameters({
+      hookParameter: {},
+      step: {
+        text,
+        argument
+      },
+      world: this
+    });
+    const res = await (0, _testTypeImpl.runStepWithCustomLocation)(this.test, text, location, () => code.apply(this, parameters));
+    delete this.customFixtures;
+    return res;
   }
   get page() {
-    return this.options.$bddWorldFixtures.page;
+    return this.builtinFixtures.page;
   }
   get context() {
-    return this.options.$bddWorldFixtures.context;
+    return this.builtinFixtures.context;
   }
   get browser() {
-    return this.options.$bddWorldFixtures.browser;
+    return this.builtinFixtures.browser;
   }
   get browserName() {
-    return this.options.$bddWorldFixtures.browserName;
+    return this.builtinFixtures.browserName;
   }
   get request() {
-    return this.options.$bddWorldFixtures.request;
+    return this.builtinFixtures.request;
   }
   get testInfo() {
     return this.options.testInfo;

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

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Snippets = void 0;
-var _url = require("url");
 var _loadSnippetBuilder = require("../cucumber/loadSnippetBuilder");
 var _logger = require("../utils/logger");
 var _stepConfig = require("../stepDefinitions/stepConfig");
-/**
- * Generate and show snippets for undefined steps
+/**
+ * Generate and show snippets for undefined steps
  */
 
 class Snippets {
@@ -44,8 +43,7 @@ class Snippets {
     } = this.runConfiguration.formats.options;
     if (!snippetSyntax && this.isPlaywrightStyle()) {
       this.bddBuiltInSyntax = true;
-      const filePath = this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
-      return (0, _url.pathToFileURL)(filePath).toString();
+      return this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
     } else {
       return snippetSyntax;
     }

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

@@ -27,9 +27,7 @@ class _default {
     });
     const allParameterNames = ['{}', ...expressionParameters, ...stepParameters];
     const functionSignature = `${functionName}('${this.escapeSpecialCharacters(generatedExpression)}', async (${allParameterNames.join(', ')}) => {`;
-    return [functionSignature,
-    // prettier-ignore
-    `  // ...`, '});'].join('\n');
+    return [functionSignature, `  // ...`, '});'].join('\n');
   }
   escapeSpecialCharacters(generatedExpression) {
     let source = generatedExpression.source;

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

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _snippetSyntax = _interopRequireDefault(require("./snippetSyntax"));
-/**
- * Playwright-style snippet syntax for typescript.
- * Important to use separate file as it's simplest way to distinguish between js/ts
- * without hooking into cucumber machinery.
+/**
+ * Playwright-style snippet syntax for typescript.
+ * Important to use separate file as it's simplest way to distinguish between js/ts
+ * without hooking into cucumber machinery.
  */
 
 class _default extends _snippetSyntax.default {

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

@@ -4,42 +4,27 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createBdd = createBdd;
-exports.hasCustomTest = void 0;
+exports.extractFixtureNames = extractFixtureNames;
+var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
 var _bddFixtures = require("../run/bddFixtures");
 var _testTypeImpl = require("../playwright/testTypeImpl");
 var _defineStep = require("./defineStep");
 var _exit = require("../utils/exit");
-var _scenario = require("../hooks/scenario");
-var _worker = require("../hooks/worker");
-/**
- * Stuff related to writing steps in Playwright-style.
+/**
+ * Stuff related to writing steps in Playwright-style.
  */
 
-// Global flag showing that custom test was passed.
-// Used when checking 'importTestFrom' config option.
-// todo: https://github.com/vitalets/playwright-bdd/issues/46
-let hasCustomTest = exports.hasCustomTest = false;
 function createBdd(customTest) {
-  if (!hasCustomTest) {
-    exports.hasCustomTest = hasCustomTest = isCustomTest(customTest);
-  }
+  const hasCustomTest = isCustomTest(customTest);
   const Given = defineStepCtor('Given', hasCustomTest);
   const When = defineStepCtor('When', hasCustomTest);
   const Then = defineStepCtor('Then', hasCustomTest);
   const Step = defineStepCtor('Unknown', hasCustomTest);
-  const Before = (0, _scenario.scenarioHookFactory)('before');
-  const After = (0, _scenario.scenarioHookFactory)('after');
-  const BeforeAll = (0, _worker.workerHookFactory)('beforeAll');
-  const AfterAll = (0, _worker.workerHookFactory)('afterAll');
   return {
     Given,
     When,
     Then,
-    Step,
-    Before,
-    After,
-    BeforeAll,
-    AfterAll
+    Step
   };
 }
 function defineStepCtor(keyword, hasCustomTest) {
@@ -52,15 +37,13 @@ function defineStepCtor(keyword, hasCustomTest) {
     });
   };
 }
-function isCustomTest(customTest) {
-  if (!customTest || customTest === _bddFixtures.test) {
-    return false;
-  }
-  assertTestHasBddFixtures(customTest);
-  return true;
+function extractFixtureNames(fn) {
+  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
 }
-function assertTestHasBddFixtures(customTest) {
-  if (!(0, _testTypeImpl.isTestContainsSubtest)(customTest, _bddFixtures.test)) {
-    (0, _exit.exit)(`createBdd() should use 'test' extended from "playwright-bdd"`);
+function isCustomTest(customTest) {
+  const isCustomTest = Boolean(customTest && customTest !== _bddFixtures.test);
+  if (isCustomTest && customTest && !(0, _testTypeImpl.isParentChildTest)(_bddFixtures.test, customTest)) {
+    (0, _exit.exit)(`createBdd() should use test extended from "@zohodesk/testinglibrary"`);
   }
+  return isCustomTest;
 }