@zohodesk/testinglibrary 0.1.9 → 0.2.0

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

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

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

@@ -16,14 +16,18 @@ var _gen = require("../../gen");
 const logger = new _logger.Logger({
   verbose: true
 });
-const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints all step definitions').addOption(_options.configOption).action(async opts => {
+const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints step definitions').addOption(_options.configOption).option('--unused-steps', 'Output only unused steps').action(async opts => {
   const {
     resolvedConfigFile
   } = await (0, _loadConfig.loadConfig)(opts.config);
-  logger.log(`List of all steps found by config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}\n`);
+  logger.log(`Using config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}`);
   const configs = Object.values((0, _env.getEnvConfigs)());
   (0, _test.assertConfigsCount)(configs);
-  await showStepsForConfigs(configs);
+  if (opts.unusedSteps) {
+    await showUnusedStepsForConfigs(configs);
+  } else {
+    await showStepsForConfigs(configs);
+  }
 });
 async function showStepsForConfigs(configs) {
   // here we don't need workers (as in test command) because if some step files
@@ -34,6 +38,17 @@ async function showStepsForConfigs(configs) {
     stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
   });
   await Promise.all(tasks);
+  logger.log(`List of all steps (${steps.size}):`);
+  steps.forEach(stepText => logger.log(stepText));
+}
+async function showUnusedStepsForConfigs(configs) {
+  const steps = new Set();
+  const tasks = configs.map(async config => {
+    const stepDefinitions = await new _gen.TestFilesGenerator(config).extractUnusedSteps();
+    stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
+  });
+  await Promise.all(tasks);
+  logger.log(`List of unused steps (${steps.size}):`);
   steps.forEach(stepText => logger.log(stepText));
 }
 function getStepText({

package/build/bdd-framework/decorators.js

@@ -10,8 +10,8 @@ Object.defineProperty(exports, "Fixture", {
   }
 });
 exports.When = exports.Then = exports.Step = exports.Given = void 0;
-var _class = require("./stepDefinitions/decorators/class");
-var _steps = require("./stepDefinitions/decorators/steps");
+var _class = require("./steps/decorators/class");
+var _steps = require("./steps/decorators/steps");
 const Given = exports.Given = (0, _steps.createStepDecorator)('Given');
 const When = exports.When = (0, _steps.createStepDecorator)('When');
 const Then = exports.Then = (0, _steps.createStepDecorator)('Then');

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

@@ -6,10 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.Formatter = void 0;
 var _jsStringWrap = require("../utils/jsStringWrap");
 var _utils = require("../utils");
+var _utils2 = require("../playwright/utils");
 /**
  * Helper to format Playwright test file.
  */
 
+const supportsTags = _utils2.playwrightVersion >= '1.42.0';
 class Formatter {
   config;
   constructor(config) {
@@ -27,12 +29,14 @@ class Formatter {
     // this.quoted() is not possible for 'import from' as backticks not parsed
     `import { ${varName} } from ${JSON.stringify(importTestFromFile)};`, ''];
   }
-  suite(node, children) {
-    const firstLine = `test.describe${this.getSubFn(node)}(${this.quoted(node.title)}, () => {`;
+  describe(node, children) {
+    const firstLine = `test.${this.getFunction('describe', node)}(${this.quoted(node.title)}, () => {`;
     if (!children.length) {
       return [`${firstLine}});`, ''];
     }
-    return [firstLine, '', ...children.map(indent), `});`, ''];
+    return [firstLine,
+    // prettier-ignore
+    ...this.describeConfigure(node).map(indent), '', ...children.map(indent), `});`, ''];
   }
   beforeEach(fixtures, children) {
     const fixturesStr = [...fixtures].join(', ');
@@ -42,11 +46,19 @@ class Formatter {
   test(node, fixtures, children) {
     const fixturesStr = [...fixtures].join(', ');
     const title = this.quoted(node.title);
-    const firstLine = `test${this.getSubFn(node)}(${title}, async ({ ${fixturesStr} }) => {`;
+    const tags = this.testTags(node);
+    const firstLine = `${this.getFunction('test', node)}(${title}, ${tags}async ({ ${fixturesStr} }) => {`;
     if (!children.length) {
       return [`${firstLine}});`, ''];
     }
-    return [firstLine, ...children.map(indent), `});`, ''];
+    const lines = [firstLine,
+    // prettier-ignore
+    ...children.map(indent), `});`, ''];
+    // wrap test into anonymous describe in case of retries / timeout tags
+    const specialTagsConfigure = this.describeConfigure(node);
+    return specialTagsConfigure.length ? ['test.describe(() => {',
+    // prettier-ignore
+    ...specialTagsConfigure.map(indent), '', ...lines.map(indent), `});`, ''] : lines;
   }
   // eslint-disable-next-line max-params
   step(keyword, text, argument, fixtureNames = []) {
@@ -93,17 +105,49 @@ class Formatter {
   langFixture(lang) {
     return [`$lang: ({}, use) => use(${this.quoted(lang)}),`];
   }
-  getSubFn(node) {
-    if (node.flags.only) {
-      return '.only';
+  // eslint-disable-next-line complexity
+  getFunction(baseFn, node) {
+    if (node.specialTags.only) {
+      return `${baseFn}.only`;
+    }
+    // describe.fail is not supported
+    if (baseFn === 'test' && node.specialTags.fail) {
+      return `${baseFn}.fail`;
+    }
+    if (node.specialTags.skip) {
+      return `${baseFn}.skip`;
+    }
+    if (node.specialTags.fixme) {
+      return `${baseFn}.fixme`;
+    }
+    return baseFn;
+  }
+  describeConfigure(node) {
+    const options = {};
+    const {
+      retries,
+      timeout,
+      mode
+    } = node.specialTags;
+    if (retries !== undefined) {
+      options.retries = retries;
     }
-    if (node.flags.skip) {
-      return '.skip';
+    if (timeout !== undefined) {
+      options.timeout = timeout;
     }
-    if (node.flags.fixme) {
-      return '.fixme';
+    if (mode !== undefined) {
+      options.mode = mode;
     }
-    return '';
+    return Object.keys(options).length ? [`test.describe.configure(${JSON.stringify(options)});`] : [];
+  }
+  testTags(node) {
+    return supportsTags && node.tags.length ? `{ tag: [${node.tags.map(tag => this.quoted(tag)).join(', ')}] }, ` : '';
+  }
+  testTimeout(node) {
+    const {
+      timeout
+    } = node.specialTags;
+    return timeout !== undefined ? [`test.setTimeout(${timeout});`] : [];
   }
   /**
      * Apply this function only to string literals (mostly titles here).

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

@@ -14,13 +14,13 @@ var _loadFeatures = require("../cucumber/loadFeatures");
 var _loadSteps = require("../cucumber/loadSteps");
 var _config = require("../config");
 var _snippets = require("../snippets");
-var _steps = require("../stepDefinitions/decorators/steps");
+var _steps = require("../steps/decorators/steps");
 var _transform = require("../playwright/transform");
 var _configDir = require("../config/configDir");
 var _logger = require("../utils/logger");
 var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
 var _exit = require("../utils/exit");
-var _createBdd = require("../stepDefinitions/createBdd");
+var _createBdd = require("../steps/createBdd");
 var _resolveFeaturePaths = require("../cucumber/resolveFeaturePaths");
 /**
  * Generate playwright test files from Gherkin documents.
@@ -60,6 +60,16 @@ class TestFilesGenerator {
     await this.loadSteps();
     return this.supportCodeLibrary.stepDefinitions;
   }
+  // todo: combine with extractSteps
+  async extractUnusedSteps() {
+    await this.loadCucumberConfig();
+    await Promise.all([this.loadFeatures(), this.loadSteps()]);
+    this.buildFiles();
+    return this.supportCodeLibrary.stepDefinitions.filter(stepDefinition => {
+      const isUsed = this.files.some(file => file.usedStepDefinitions.has(stepDefinition));
+      return !isUsed;
+    });
+  }
   async loadCucumberConfig() {
     const environment = {
       cwd: (0, _configDir.getPlaywrightConfigDir)()
@@ -75,20 +85,22 @@ class TestFilesGenerator {
   async loadFeatures() {
     const cwd = (0, _configDir.getPlaywrightConfigDir)();
     const {
-      paths,
       defaultDialect
     } = this.runConfiguration.sources;
-    this.logger.log(`Loading features from: ${paths.join(', ')}`);
     const {
       featurePaths
     } = await (0, _resolveFeaturePaths.resovleFeaturePaths)(this.runConfiguration, {
       cwd
     });
-    await this.featuresLoader.load(featurePaths, {
-      relativeTo: cwd,
-      defaultDialect
-    });
-    this.handleParseErrors();
+    this.logger.log(`Loading features from paths (${featurePaths.length}):`);
+    featurePaths.forEach(featurePath => this.logger.log(featurePath));
+    if (featurePaths.length) {
+      await this.featuresLoader.load(featurePaths, {
+        relativeTo: cwd,
+        defaultDialect
+      });
+      this.handleParseErrors();
+    }
     this.logger.log(`Loaded features: ${this.featuresLoader.getDocumentsCount()}`);
   }
   async loadSteps() {

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

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SpecialTags = void 0;
+/**
+ * Special tags.
+ */
+class SpecialTags {
+  ownTags;
+  allTags;
+  only;
+  skip;
+  fixme;
+  fail;
+  retries;
+  timeout;
+  mode;
+  constructor(ownTags, allTags) {
+    this.ownTags = ownTags;
+    this.allTags = allTags;
+    this.extractFlags();
+    this.extractRetries();
+    this.extractTimeout();
+    this.extractMode();
+  }
+  extractFlags() {
+    // order is important
+    const flags = ['only', 'fail', 'skip', 'fixme'];
+    for (const flag of flags) {
+      if (this.ownTags.includes(`@${flag}`)) {
+        this[flag] = true;
+        return;
+      }
+    }
+    // describe.fail is not supported, so mark all nested tests as failed instead
+    if (this.allTags.includes(`@fail`)) {
+      this.fail = true;
+    }
+  }
+  extractRetries() {
+    for (const tag of this.ownTags.reverse()) {
+      const match = tag.match(/@retries:(\d+)/i);
+      if (match) {
+        this.retries = Number(match[1]);
+        return;
+      }
+    }
+  }
+  extractTimeout() {
+    for (const tag of this.ownTags.reverse()) {
+      const match = tag.match(/@timeout:(\d+)/i);
+      if (match) {
+        this.timeout = Number(match[1]);
+        return;
+      }
+    }
+  }
+  extractMode() {
+    for (const tag of this.ownTags.reverse()) {
+      const match = tag.match(/@mode:(default|parallel|serial)/i);
+      if (match) {
+        this.mode = match[1];
+        return;
+      }
+    }
+  }
+}
+exports.SpecialTags = SpecialTags;

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

@@ -14,7 +14,7 @@ var _index = require("@cucumber/cucumber/lib/formatter/helpers/index");
 var _utils = require("../utils");
 var _testPoms = require("./testPoms");
 var _testNode = require("./testNode");
-var _stepConfig = require("../stepDefinitions/stepConfig");
+var _stepConfig = require("../steps/stepConfig");
 var _exit = require("../utils/exit");
 var _fixtures = require("./fixtures");
 var _scenario = require("../hooks/scenario");
@@ -35,6 +35,7 @@ class TestFile {
   hasCustomTest = false;
   undefinedSteps = [];
   featureUri;
+  usedStepDefinitions = new Set();
   constructor(options) {
     this.options = options;
     this.formatter = new _formatter.Formatter(options.config);
@@ -67,6 +68,9 @@ class TestFile {
     return this.testMetaBuilder.testCount;
   }
   build() {
+    if (!this.pickles.length) {
+      return this;
+    }
     this.loadI18nKeywords();
     this.lines = [...this.getFileHeader(),
     // prettier-ignore
@@ -136,11 +140,11 @@ class TestFile {
   getSuite(feature, parent) {
     const node = new _testNode.TestNode(feature, parent);
     if (node.isSkipped()) {
-      return this.formatter.suite(node, []);
+      return this.formatter.describe(node, []);
     }
     const lines = [];
     feature.children.forEach(child => lines.push(...this.getSuiteChild(child, node)));
-    return this.formatter.suite(node, lines);
+    return this.formatter.describe(node, lines);
   }
   getSuiteChild(child, parent) {
     if ('rule' in child && child.rule) {
@@ -177,7 +181,7 @@ class TestFile {
   getOutlineSuite(scenario, parent) {
     const node = new _testNode.TestNode(scenario, parent);
     if (node.isSkipped()) {
-      return this.formatter.suite(node, []);
+      return this.formatter.describe(node, []);
     }
     const lines = [];
     let exampleIndex = 0;
@@ -189,7 +193,7 @@ class TestFile {
         lines.push(...testLines);
       });
     });
-    return this.formatter.suite(node, lines);
+    return this.formatter.describe(node, lines);
   }
   /**
      * Generate test from Examples row of Scenario Outline
@@ -304,6 +308,7 @@ class TestFile {
       });
       return this.getMissingStep(enKeyword, keywordType, pickleStep);
     }
+    this.usedStepDefinitions.add(stepDefinition);
     // for cucumber-style stepConfig is undefined
     const stepConfig = (0, _stepConfig.getStepConfig)(stepDefinition);
     if (stepConfig !== null && stepConfig !== void 0 && stepConfig.hasCustomTest) {

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

@@ -5,56 +5,31 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TestNode = void 0;
 var _utils = require("../utils");
+var _specialTags = require("./specialTags");
 /**
  * Universal TestNode class representing test or suite in a test file.
  * Holds parent-child links.
  * Allows to inherit tags and titles path.
  */
 
-const SPECIAL_TAGS = ['@only', '@skip', '@fixme'];
 class TestNode {
   title;
   titlePath;
   ownTags;
   tags;
-  flags = {};
+  specialTags;
   constructor(gherkinNode, parent) {
     this.title = gherkinNode.name;
     this.titlePath = ((parent === null || parent === void 0 ? void 0 : parent.titlePath) || []).concat([this.title]);
     this.ownTags = (0, _utils.removeDuplicates)(getTagNames(gherkinNode.tags));
     this.tags = (0, _utils.removeDuplicates)(((parent === null || parent === void 0 ? void 0 : parent.tags) || []).concat(this.ownTags));
-    this.initFlags();
+    this.specialTags = new _specialTags.SpecialTags(this.ownTags, this.tags);
   }
   isSkipped() {
-    return this.flags.skip || this.flags.fixme;
-  }
-  initFlags() {
-    this.ownTags.forEach(tag => {
-      if (isSpecialTag(tag)) {
-        this.setFlag(tag);
-      }
-    });
-  }
-  // eslint-disable-next-line complexity
-  setFlag(tag) {
-    // in case of several special tags, @only takes precendence
-    if (tag === '@only') {
-      this.flags = {
-        only: true
-      };
-    }
-    if (tag === '@skip' && !this.flags.only) {
-      this.flags.skip = true;
-    }
-    if (tag === '@fixme' && !this.flags.only) {
-      this.flags.fixme = true;
-    }
+    return this.specialTags.skip || this.specialTags.fixme;
   }
 }
 exports.TestNode = TestNode;
 function getTagNames(tags) {
   return tags.map(tag => tag.name);
-}
-function isSpecialTag(tag) {
-  return SPECIAL_TAGS.includes(tag);
 }

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

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TestPoms = void 0;
 exports.buildFixtureTag = buildFixtureTag;
-var _class = require("../stepDefinitions/decorators/class");
+var _class = require("../steps/decorators/class");
 var _exit = require("../utils/exit");
 /**
  * Track PomNodes used in the particular test.

package/build/bdd-framework/index.js

@@ -46,7 +46,7 @@ Object.defineProperty(exports, "test", {
   }
 });
 var _config = require("./config");
-var _createBdd = require("./stepDefinitions/createBdd");
+var _createBdd = require("./steps/createBdd");
 var _bddFixtures = require("./run/bddFixtures");
 var _bddWorld = require("./run/bddWorld");
 var _helper = require("./reporter/cucumber/helper");

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

@@ -7,6 +7,7 @@ exports.isTestContainsSubtest = isTestContainsSubtest;
 exports.runStepWithCustomLocation = runStepWithCustomLocation;
 var _test = require("@playwright/test");
 var _utils = require("../utils");
+var _utils2 = 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
@@ -27,16 +28,33 @@ function getTestImpl(test) {
  */
 // 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();
-  });
+  // Since PW 1.43 testInfo._runAsStep was replaced with a more complex logic.
+  // To run step with a custom location, we hijack testInfo._addStep()
+  // so that it appends location for the bdd step calls.
+  // Finally we call test.step(), that internally invokes testInfo._addStep().
+  // See: https://github.com/microsoft/playwright/issues/30160
+  // See: https://github.com/microsoft/playwright/blob/release-1.43/packages/playwright/src/common/testType.ts#L262
+  // See: https://github.com/microsoft/playwright/blob/release-1.43/packages/playwright/src/worker/testInfo.ts#L247
+  if (_utils2.playwrightVersion >= '1.39.0') {
+    const testInfo = test.info();
+    // here we rely on that testInfo._addStep is called synchronously in test.step()
+    const origAddStep = testInfo._addStep;
+    testInfo._addStep = function (data) {
+      data.location = location;
+      testInfo._addStep = origAddStep;
+      return origAddStep.call(this, data);
+    };
+    return test.step(stepText, body);
+  } else {
+    const testInfo = test.info();
+    return testInfo._runAsStep({
+      category: 'test.step',
+      title: stepText,
+      location
+    }, async () => {
+      return await body();
+    });
+  }
 }
 /**
  * Returns true if test contains all fixtures of subtest.

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

@@ -2,4 +2,11 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+Object.defineProperty(exports, "PlaywrightLocation", {
+  enumerable: true,
+  get: function () {
+    return _reporter.Location;
+  }
+});
+var _reporter = require("@playwright/test/reporter");

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

@@ -5,12 +5,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPlaywrightModulePath = getPlaywrightModulePath;
+exports.playwrightVersion = void 0;
 exports.requirePlaywrightModule = requirePlaywrightModule;
+exports.updateAnnotation = updateAnnotation;
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _utils = require("../utils");
 // cache playwright root
 let playwrightRoot = '';
+const playwrightVersion = exports.playwrightVersion = (0, _utils.getPackageVersion)('@playwright/test');
 /**
  * Requires Playwright's internal module that is not exported via package.exports.
  */
@@ -31,4 +34,23 @@ function getPlaywrightRoot() {
     playwrightRoot = _fs.default.existsSync(libDir) ? playwrightTestRoot : (0, _utils.resolvePackageRoot)('playwright');
   }
   return playwrightRoot;
+}
+/**
+ * Create or update annotation with provided type.
+ */
+function updateAnnotation(testInfo, annotation, {
+  create = false
+} = {}) {
+  const {
+    annotations
+  } = testInfo;
+  const index = annotations.findIndex(a => a.type === annotation.type);
+  if (index === -1 && !create) {
+    throw new Error(`Annotation "${annotation.type}" is not found.`);
+  }
+  if (index === -1) {
+    annotations.push(annotation);
+  } else {
+    annotations[index] = annotation;
+  }
 }

package/build/bdd-framework/reporter/cucumber/base.js

@@ -7,14 +7,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
-var _stream = require("stream");
+var _promises = require("node:stream/promises");
 /**
  * Base reporter for Cucumber reporters.
  * Reference: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/index.ts
  */
 
-// Import pipeline from the 'stream' module
-
 class BaseReporter {
   internalOptions;
   outputStream = process.stdout;
@@ -34,10 +32,7 @@ class BaseReporter {
   async finished() {
     if (!isStdout(this.outputStream)) {
       this.outputStream.end();
-      await new Promise((resolve, reject) => {
-        this.outputStream.on('finish', resolve);
-        this.outputStream.on('error', reject);
-      });
+      await (0, _promises.finished)(this.outputStream);
     }
   }
   setOutputStream(outputFile) {

package/build/bdd-framework/reporter/cucumber/html.js

@@ -5,10 +5,18 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _promises = require("node:stream/promises");
 var _htmlFormatter = _interopRequireDefault(require("@cucumber/html-formatter"));
 var _utils = require("../../utils");
 var _path = _interopRequireDefault(require("path"));
 var _base = _interopRequireDefault(require("./base"));
+/**
+ * Cucumber html reporter.
+ * Based on: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/html_formatter.ts
+ * See: https://github.com/cucumber/html-formatter
+ * See: https://github.com/cucumber/react-components
+ */
+
 class HtmlReporter extends _base.default {
   userOptions;
   htmlStream;
@@ -25,10 +33,7 @@ class HtmlReporter extends _base.default {
   }
   async finished() {
     this.htmlStream.end();
-    await new Promise((resolve, reject) => {
-      this.htmlStream.on('finish', resolve);
-      this.htmlStream.on('error', reject);
-    });
+    await (0, _promises.finished)(this.htmlStream);
     await super.finished();
   }
 }