@zohodesk/testinglibrary 0.1.6 → 0.1.7-exp.2

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

@@ -6,58 +6,46 @@ 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;
-  builtinFixtures;
-  customFixtures;
+  stepFixtures = {};
   constructor(options) {
     super(options);
     this.options = options;
-    this.invokeStep = this.invokeStep.bind(this);
   }
-  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;
+  /**
+     * 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];
   }
   get page() {
-    return this.builtinFixtures.page;
+    return this.options.$bddWorldFixtures.page;
   }
   get context() {
-    return this.builtinFixtures.context;
+    return this.options.$bddWorldFixtures.context;
   }
   get browser() {
-    return this.builtinFixtures.browser;
+    return this.options.$bddWorldFixtures.browser;
   }
   get browserName() {
-    return this.builtinFixtures.browserName;
+    return this.options.$bddWorldFixtures.browserName;
   }
   get request() {
-    return this.builtinFixtures.request;
+    return this.options.$bddWorldFixtures.request;
   }
   get testInfo() {
     return this.options.testInfo;

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

@@ -4,6 +4,7 @@ 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");
@@ -43,7 +44,8 @@ class Snippets {
     } = this.runConfiguration.formats.options;
     if (!snippetSyntax && this.isPlaywrightStyle()) {
       this.bddBuiltInSyntax = true;
-      return this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
+      const filePath = this.isDecorators() ? require.resolve('./snippetSyntaxDecorators.js') : this.isTypeScript() ? require.resolve('./snippetSyntaxTs.js') : require.resolve('./snippetSyntax.js');
+      return (0, _url.pathToFileURL)(filePath).toString();
     } else {
       return snippetSyntax;
     }

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

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

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

@@ -4,27 +4,42 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createBdd = createBdd;
-exports.extractFixtureNames = extractFixtureNames;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
+exports.hasCustomTest = void 0;
 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.
  */
 
+// 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) {
-  const hasCustomTest = isCustomTest(customTest);
+  if (!hasCustomTest) {
+    exports.hasCustomTest = 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
+    Step,
+    Before,
+    After,
+    BeforeAll,
+    AfterAll
   };
 }
 function defineStepCtor(keyword, hasCustomTest) {
@@ -37,13 +52,15 @@ function defineStepCtor(keyword, hasCustomTest) {
     });
   };
 }
-function extractFixtureNames(fn) {
-  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-}
 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"`);
+  if (!customTest || customTest === _bddFixtures.test) {
+    return false;
+  }
+  assertTestHasBddFixtures(customTest);
+  return true;
+}
+function assertTestHasBddFixtures(customTest) {
+  if (!(0, _testTypeImpl.isTestContainsSubtest)(customTest, _bddFixtures.test)) {
+    (0, _exit.exit)(`createBdd() should use 'test' extended from "playwright-bdd"`);
   }
-  return isCustomTest;
 }

package/build/bdd-framework/stepDefinitions/decorators/{poms.js → class.js}

@@ -8,7 +8,7 @@ exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
 var _steps = require("./steps");
 var _exit = require("../../utils/exit");
 /**
- * POM classes marked with @Fixture
+ * Class level @Fixture decorator.
  */
 
 /**
@@ -51,7 +51,9 @@ function ensureUniqueFixtureName({
 }
 function linkParentWithPomNode(Ctor, pomNode) {
   const parentCtor = Object.getPrototypeOf(Ctor);
-  if (!parentCtor) return;
+  if (!parentCtor) {
+    return;
+  }
   // 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, '');
@@ -59,6 +61,8 @@ function linkParentWithPomNode(Ctor, pomNode) {
 }
 function getPomNodeByFixtureName(fixtureName) {
   for (const pomNode of pomGraph.values()) {
-    if (pomNode.fixtureName === fixtureName) return pomNode;
+    if (pomNode.fixtureName === fixtureName) {
+      return pomNode;
+    }
   }
 }

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

@@ -36,11 +36,15 @@ function createStepDecorator(keyword) {
   };
 }
 function linkStepsWithPomNode(Ctor, pomNode) {
-  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return;
+  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) {
+    return;
+  }
   const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
   return Object.values(propertyDescriptors).forEach(descriptor => {
     const stepConfig = getStepConfigFromMethod(descriptor);
-    if (!stepConfig) return;
+    if (!stepConfig) {
+      return;
+    }
     stepConfig.pomNode = pomNode;
     decoratedSteps.add(stepConfig);
   });
@@ -65,7 +69,9 @@ function appendDecoratorSteps(supportCodeLibrary) {
       pattern,
       code,
       line: 0,
+      // not used in playwright-bdd
       options: {},
+      // not used in playwright-bdd
       uri: '' // not used in playwright-bdd
     }, supportCodeLibrary);
     supportCodeLibrary.stepDefinitions.push(stepDefinition);

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

@@ -34,7 +34,8 @@ function defineStep(stepConfig) {
 }
 function buildCucumberStepCode(stepConfig) {
   const code = function (...args) {
-    const fixturesArg = Object.assign({}, this.customFixtures, {
+    // build the first argument (fixtures) for step fn
+    const fixturesArg = Object.assign({}, this.stepFixtures, {
       $testInfo: this.testInfo,
       $test: this.test,
       $tags: this.tags

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

@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 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,
+ * When calling process.exit() in worker thread used for test-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.
+ * This esnured by wrapping code with withExitHandler().
  *
- * On the other hand, when running in main thread, especially inside Playwright,
+ * On the other hand, when running in the 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.
  *
@@ -35,6 +35,10 @@ async function withExitHandler(fn) {
     return await fn();
   } catch (e) {
     if (e instanceof ExitError) {
+      if (e.message) {
+        // eslint-disable-next-line no-console
+        console.error(e.message);
+      }
       process.exitCode = 1;
     } else {
       throw e;
@@ -44,7 +48,13 @@ async function withExitHandler(fn) {
 function exit(...messages) {
   messages = messages.filter(Boolean);
   if (_worker_threads.isMainThread) {
-    if (messages.length) _logger.logger.error('Error:', ...messages);
+    // use console.error() here instead of logger.error() to have less stack
+    // for flushing messages to stderr.
+
+    if (messages.length) {
+      // eslint-disable-next-line no-console, max-depth
+      console.error('Error:', ...messages);
+    }
     process.exit(1);
   } else {
     throw new ExitError(messages.join(' '));

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

@@ -4,6 +4,8 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.callWithTimeout = callWithTimeout;
+exports.extractTemplateParams = extractTemplateParams;
 exports.getPackageVersion = getPackageVersion;
 exports.getSymbolByName = getSymbolByName;
 exports.removeDuplicates = removeDuplicates;
@@ -11,7 +13,12 @@ exports.resolvePackageRoot = resolvePackageRoot;
 exports.template = template;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
-// See: https://stackoverflow.com/questions/50453640/how-can-i-get-the-value-of-a-symbol-property
+var _util = require("util");
+const setTimeoutPromise = (0, _util.promisify)(setTimeout);
+/**
+ * Returns Symbol by name.
+ * 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);
   const symbol = ownKeys.find(key => key.toString() === `Symbol(${name})`);
@@ -29,6 +36,13 @@ function template(t, params = {}) {
     return params[key] !== undefined ? String(params[key]) : match;
   });
 }
+/**
+ * Extracts all template params from string.
+ * Params defined as <param>.
+ */
+function extractTemplateParams(t) {
+  return [...t.matchAll(/<(.+?)>/g)].map(m => m[1]);
+}
 function removeDuplicates(arr) {
   return [...new Set(arr)];
 }
@@ -41,4 +55,16 @@ function getPackageVersion(packageName) {
   const packageJsonPath = _path.default.join(packageRoot, 'package.json');
   const packageJson = JSON.parse(_fs.default.readFileSync(packageJsonPath, 'utf8'));
   return packageJson.version || '';
+}
+async function callWithTimeout(fn, timeout, timeoutMsg) {
+  if (!timeout) {
+    return fn();
+  }
+  const ac = new AbortController();
+  return Promise.race([fn(), setTimeoutPromise(timeout, null, {
+    ref: false,
+    signal: ac.signal
+  }).then(() => {
+    throw new Error(timeoutMsg || `Function timeout (${timeout} ms)`);
+  })]).finally(() => ac.abort());
 }

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

@@ -13,7 +13,9 @@ class Logger {
     this.options = options;
   }
   log(...args) {
-    if (this.options.verbose) console.log(...args);
+    if (this.options.verbose) {
+      console.log(...args);
+    }
   }
   warn(...args) {
     // using log() to output warnings to stdout, not stderr

package/build/core/playwright/builtInFixtures/addTags.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  addTags: [async ({
+    $tags
+  }, use, testInfo) => {
+    testInfo.annotations.push({
+      type: 'tags',
+      description: $tags.join(', ')
+    });
+    await use();
+  }, {
+    auto: true
+  }]
+};

package/build/core/playwright/builtInFixtures/cacheLayer.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const cacheMap = new Map();
+var _default = exports.default = {
+  cacheLayer: async ({}, use) => {
+    await use(cacheMap);
+  }
+};

package/build/core/playwright/builtInFixtures/context.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  context: async ({
+    context
+  }, use) => {
+    // eslint-disable-next-line no-undef
+    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
+    await use(context);
+  }
+};

package/build/core/playwright/builtInFixtures/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _page = _interopRequireDefault(require("./page"));
+var _context = _interopRequireDefault(require("./context"));
+var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
+var _addTags = _interopRequireDefault(require("./addTags"));
+function getBuiltInFixtures(bddMode) {
+  let builtInFixtures = {
+    ..._page.default,
+    ..._context.default,
+    ..._cacheLayer.default
+  };
+  if (bddMode) {
+    builtInFixtures = {
+      ...builtInFixtures,
+      ..._addTags.default
+    };
+  }
+  return builtInFixtures;
+}
+var _default = exports.default = getBuiltInFixtures;

package/build/core/playwright/builtInFixtures/page.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+// function test(descrition, callback) {
+//   return test(descrition, ({ page }) => {
+//     const { locator, ...custompage } = page
+//     callback({ page: custompage })
+//   })
+// }
+// class FilteredPage {
+//   constructor(page) {
+//     this.page = page;
+//     this.allowedMethods = ['getByText', 'getByTitle'];
+//     this.context = page.context;
+//   }
+//   goto(...args) {
+//     return this.page['goto'](...args);
+//   }
+//   getByRole(...args) {
+//     return this.page['getByRole'](...args);
+//   }
+// }
+// function FilteredPage(page) {
+//   return {
+//     getByRole: () => {
+//       throw new Error('You cannnot use getByRole property')
+//     }
+//   }
+// }
+var _default = exports.default = {
+  page: async ({
+    page
+  }, use) => {
+    page.getBaseUrl = function () {
+      if (process.env.mode === 'dev') {
+        return `${process.env.domain}?devURL=${process.env.devUrl}`;
+      }
+      return `${process.env.domain}`;
+    };
+    page.getCustomPageUrl = function (url) {
+      if (process.env.mode === 'dev') {
+        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
+      }
+      return `${process.env.domain}/${url}`;
+    };
+    await use(page);
+  }
+};

package/build/core/playwright/index.js

@@ -1,5 +1,6 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -20,91 +21,16 @@ exports.test = void 0;
 var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
 var _readConfigFile = require("./readConfigFile");
-// function test(descrition, callback) {
-//   return test(descrition, ({ page }) => {
-//     const { locator, ...custompage } = page
-//     callback({ page: custompage })
-//   })
-// }
-
-// class FilteredPage {
-//   constructor(page) {
-//     this.page = page;
-//     this.allowedMethods = ['getByText', 'getByTitle'];
-//     this.context = page.context;
-//   }
-
-//   goto(...args) {
-//     return this.page['goto'](...args);
-//   }
-
-//   getByRole(...args) {
-//     return this.page['getByRole'](...args);
-//   }
-// }
-
-// function FilteredPage(page) {
-//   return {
-//     getByRole: () => {
-//       throw new Error('You cannnot use getByRole property')
-//     }
-//   }
-// }
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
 const {
-  additionalPages,
+  additionalPages: userFixtures,
   bddMode
 } = (0, _readConfigFile.generateConfigFromFile)();
 let base = bddMode ? _bddFramework.test : _test.test;
-const cacheMap = new Map();
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
 const test = exports.test = base.extend({
-  page: async ({
-    page
-  }, use) => {
-    // const proxyPage = new Proxy(page, {
-    //   get: function (obj, prop) {
-    //     console.log('Gettig Priop', prop);
-    //     let filterMethod = FilteredPage(page)[prop];
-    //     if (filterMethod) {
-    //       return filterMethod;
-    //     } else {
-    //       return obj[prop] ? obj[prop] : 'property does not exist';
-    //     }
-    //   }
-    // })
-    page.getBaseUrl = function () {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}`;
-    };
-    page.getCustomPageUrl = function (url) {
-      if (process.env.mode === 'dev') {
-        return `${process.env.domain}/${url}?devURL=${process.env.devUrl}`;
-      }
-      return `${process.env.domain}/${url}`;
-    };
-    await use(page);
-
-    //await use(new FilteredPage(page));
-
-    // await use(async (page) => {
-    //   delete page.getByTestId;
-    //   await page;
-    // });
-  },
-  context: async ({
-    context
-  }, use) => {
-    // eslint-disable-next-line no-undef
-    await context.addInitScript(() => window.localStorage.setItem('isDnBannerHide', true));
-    await use(context);
-  },
-  cacheLayer: async ({
-    context
-  }, use) => {
-    await use(cacheMap);
-  },
-  ...additionalPages
+  ...buildInFixtures,
+  ...userFixtures
 });
 const {
   Given,

package/build/core/playwright/report-generator.js

@@ -17,7 +17,8 @@ const {
   reportPath: htmlPath
 } = (0, _readConfigFile.generateConfigFromFile)();
 const args = ['show-report', htmlPath].concat(userArgs);
-function generateReport() {
+async function generateReport() {
+  // await preProcessReport()
   const childProcess = (0, _child_process.spawn)(command, args, {
     stdio: 'inherit'
   });

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

@@ -69,6 +69,11 @@ function getPlaywrightConfig() {
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,
+      testDir: _path.default.join(process.cwd(), 'uat'),
+      teardown: 'cleanup'
+    }, {
+      name: 'cleanup',
+      testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
     }, ...projects] : [...projects]
   };

package/build/core/playwright/setup/custom-reporter.js

@@ -20,6 +20,7 @@ class JSONSummaryReporter {
     this.interrupted = [];
     this.timedOut = [];
     this.flakey = [];
+    this.failedSteps = [];
     this.status = 'unknown';
     this.startedAt = 0;
     this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
@@ -46,6 +47,14 @@ class JSONSummaryReporter {
     // Using the t variable in the push will push a full test name + test description
     const t = title.join(' > ');
     // Set the status
+    const stepTitleList = result.steps.map(step => ({
+      title: step.title,
+      error: step.error,
+      testTitle: t
+    })).filter(step => step.error !== undefined);
+    if (stepTitleList.length > 0) {
+      this.failedSteps = [...this.failedSteps, ...stepTitleList];
+    }
     const status = !['passed', 'skipped'].includes(result.status) && t.includes('@warn') ? 'warned' : result.status;
     // Logic to push the results into the correct array
     if (result.status === 'passed' && result.retry >= 1) {