codeceptjs 3.3.8-beta.1 → 3.4.0-beta.1

package/lib/interfaces/gherkin.js

@@ -1,4 +1,5 @@
-const { Parser } = require('gherkin');
+const Gherkin = require('@cucumber/gherkin');
+const Messages = require('@cucumber/messages');
 const { Context, Suite, Test } = require('mocha');
 
 const { matchStep } = require('./bdd');
@@ -8,7 +9,10 @@ const Step = require('../step');
 const DataTableArgument = require('../data/dataTableArgument');
 const transform = require('../transform');
 
-const parser = new Parser();
+const uuidFn = Messages.IdGenerator.uuid();
+const builder = new Gherkin.AstBuilder(uuidFn);
+const matcher = new Gherkin.GherkinClassicTokenMatcher();
+const parser = new Gherkin.Parser(builder, matcher);
 parser.stopAtFirstError = false;
 
 module.exports = (text, file) => {
@@ -46,14 +50,20 @@ module.exports = (text, file) => {
         step.metaStep = metaStep;
       };
       const fn = matchStep(step.text);
-      if (step.argument) {
-        step.argument.parse = () => {
-          return new DataTableArgument(step.argument);
-        };
-        fn.params.push(step.argument);
-        if (step.argument.type === 'DataTable') metaStep.comment = `\n${transformTable(step.argument)}`;
-        if (step.argument.content) metaStep.comment = `\n${step.argument.content}`;
+
+      if (step.dataTable) {
+        fn.params.push({
+          ...step.dataTable,
+          parse: () => new DataTableArgument(step.dataTable),
+        });
+        metaStep.comment = `\n${transformTable(step.dataTable)}`;
+      }
+
+      if (step.docString) {
+        fn.params.push(step.docString);
+        metaStep.comment = `\n"""\n${step.docString.content}\n"""`;
       }
+
       step.startTime = Date.now();
       step.match = fn.line;
       event.emit(event.bddStep.before, step);
@@ -74,15 +84,15 @@ module.exports = (text, file) => {
   };
 
   for (const child of ast.feature.children) {
-    if (child.type === 'Background') {
-      suite.beforeEach('Before', scenario.injected(async () => runSteps(child.steps), suite, 'before'));
+    if (child.background) {
+      suite.beforeEach('Before', scenario.injected(async () => runSteps(child.background.steps), suite, 'before'));
       continue;
     }
-    if (child.type === 'ScenarioOutline') {
-      for (const examples of child.examples) {
+    if (child.scenario && child.scenario.keyword === 'Scenario Outline') {
+      for (const examples of child.scenario.examples) {
         const fields = examples.tableHeader.cells.map(c => c.value);
         for (const example of examples.tableBody) {
-          let exampleSteps = [...child.steps];
+          let exampleSteps = [...child.scenario.steps];
           const current = {};
           for (const index in example.cells) {
             const placeholder = fields[index];
@@ -95,8 +105,8 @@ module.exports = (text, file) => {
               return step;
             });
           }
-          const tags = child.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
-          const title = `${child.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
+          const tags = child.scenario.tags.map(t => t.name).concat(examples.tags.map(t => t.name));
+          const title = `${child.scenario.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
           const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
           test.tags = suite.tags.concat(tags);
           test.file = file;
@@ -105,12 +115,15 @@ module.exports = (text, file) => {
       }
       continue;
     }
-    const tags = child.tags.map(t => t.name);
-    const title = `${child.name} ${tags.join(' ')}`.trim();
-    const test = new Test(title, async () => runSteps(child.steps));
-    test.tags = suite.tags.concat(tags);
-    test.file = file;
-    suite.addTest(scenario.test(test));
+
+    if (child.scenario) {
+      const tags = child.scenario.tags.map(t => t.name);
+      const title = `${child.scenario.name} ${tags.join(' ')}`.trim();
+      const test = new Test(title, async () => runSteps(child.scenario.steps));
+      test.tags = suite.tags.concat(tags);
+      test.file = file;
+      suite.addTest(scenario.test(test));
+    }
   }
 
   return suite;
@@ -130,9 +143,9 @@ function addExampleInTable(exampleSteps, placeholders) {
   for (const placeholder in placeholders) {
     steps.map((step) => {
       step = { ...step };
-      if (step.argument && step.argument.type === 'DataTable') {
-        for (const id in step.argument.rows) {
-          const cells = step.argument.rows[id].cells;
+      if (step.dataTable) {
+        for (const id in step.dataTable.rows) {
+          const cells = step.dataTable.rows[id].cells;
           cells.map(c => (c.value = c.value.replace(`<${placeholder}>`, placeholders[placeholder])));
         }
       }

package/lib/listener/exit.js

@@ -6,7 +6,7 @@ module.exports = function () {
   event.dispatcher.on(event.test.failed, (testOrSuite) => {
     // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
     // is a suite and not a test
-    const id = testOrSuite.id || (testOrSuite.ctx && testOrSuite.ctx.test.id) || 'empty';
+    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty';
     failedTests.push(id);
   });
 
@@ -14,7 +14,7 @@ module.exports = function () {
   event.dispatcher.on(event.test.passed, (testOrSuite) => {
     // NOTE When an error happens in one of the hooks (BeforeAll/BeforeEach...) the event object
     // is a suite and not a test
-    const id = testOrSuite.id || (testOrSuite.ctx && testOrSuite.ctx.test.id) || 'empty';
+    const id = testOrSuite.uid || (testOrSuite.ctx && testOrSuite.ctx.test.uid) || 'empty';
     failedTests = failedTests.filter(failed => id !== failed);
   });
 

package/lib/listener/retry.js

@@ -0,0 +1,67 @@
+const event = require('../event');
+const output = require('../output');
+const Config = require('../config');
+const { isNotSet } = require('../utils');
+
+const hooks = ['Before', 'After', 'BeforeSuite', 'AfterSuite'];
+
+module.exports = function () {
+  event.dispatcher.on(event.suite.before, (suite) => {
+    let retryConfig = Config.get('retry');
+    if (!retryConfig) return;
+
+    if (Number.isInteger(+retryConfig)) {
+      // is number
+      const retryNum = +retryConfig;
+      output.log(`Retries: ${retryNum}`);
+      suite.retries(retryNum);
+      return;
+    }
+
+    if (!Array.isArray(retryConfig)) {
+      retryConfig = [retryConfig];
+    }
+
+    for (const config of retryConfig) {
+      if (config.grep) {
+        if (!suite.title.includes(config.grep)) continue;
+      }
+
+      hooks.filter(hook => !!config[hook]).forEach((hook) => {
+        if (isNotSet(suite.opts[`retry${hook}`])) suite.opts[`retry${hook}`] = config[hook];
+      });
+
+      if (config.Feature) {
+        if (isNotSet(suite.retries())) suite.retries(config.Feature);
+      }
+
+      output.log(`Retries: ${JSON.stringify(config)}`);
+    }
+  });
+
+  event.dispatcher.on(event.test.before, (test) => {
+    let retryConfig = Config.get('retry');
+    if (!retryConfig) return;
+
+    if (Number.isInteger(+retryConfig)) {
+      return;
+    }
+
+    if (!Array.isArray(retryConfig)) {
+      retryConfig = [retryConfig];
+    }
+
+    retryConfig = retryConfig.filter(config => !!config.Scenario);
+
+    for (const config of retryConfig) {
+      if (config.grep) {
+        if (!test.fullTitle().includes(config.grep)) continue;
+      }
+
+      if (config.Scenario) {
+        if (isNotSet(test.retries())) test.retries(config.Scenario);
+        output.log(`Retries: ${config.Scenario}`);
+      }
+    }
+  });
+};

package/lib/listener/steps.js

@@ -81,6 +81,6 @@ module.exports = function () {
     if (store.debugMode) return;
     step.finishedAt = +new Date();
     if (step.startedAt) step.duration = step.finishedAt - step.startedAt;
-    debug(`Step '${step}' finished; Duration: ${step.duration}ms`);
+    debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`);
   });
 };

package/lib/listener/timeout.js

@@ -7,7 +7,7 @@ const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER;
 
 module.exports = function () {
   let timeout;
-  let timeoutStack = [];
+  let suiteTimeout = [];
   let currentTest;
   let currentTimeout;
 
@@ -17,21 +17,52 @@ module.exports = function () {
   }
 
   event.dispatcher.on(event.suite.before, (suite) => {
-    timeoutStack = [];
-    const globalTimeout = Config.get('timeout');
-    if (globalTimeout) {
-      if (globalTimeout >= 1000) {
-        console.log(`Warning: Timeout was set to ${globalTimeout}secs.\nGlobal timeout should be specified in seconds.`);
+    suiteTimeout = [];
+    let timeoutConfig = Config.get('timeout');
+
+    if (timeoutConfig) {
+      if (!Number.isNaN(+timeoutConfig)) {
+        checkForSeconds(timeoutConfig);
+        suiteTimeout.push(timeoutConfig);
+      }
+
+      if (!Array.isArray(timeoutConfig)) {
+        timeoutConfig = [timeoutConfig];
+      }
+
+      for (const config of timeoutConfig.filter(c => !!c.Feature)) {
+        if (config.grep) {
+          if (!suite.title.includes(config.grep)) continue;
+        }
+        suiteTimeout.push(config.Feature);
       }
-      timeoutStack.push(globalTimeout);
     }
-    if (suite.totalTimeout) timeoutStack.push(suite.totalTimeout);
-    output.log(`Timeouts: ${timeoutStack}`);
+
+    if (suite.totalTimeout) suiteTimeout.push(suite.totalTimeout);
+    output.log(`Timeouts: ${suiteTimeout}`);
   });
 
   event.dispatcher.on(event.test.before, (test) => {
     currentTest = test;
-    timeout = test.totalTimeout || timeoutStack[timeoutStack.length - 1];
+    let testTimeout = null;
+
+    let timeoutConfig = Config.get('timeout');
+
+    if (typeof timeoutConfig === 'object' || Array.isArray(timeoutConfig)) {
+      if (!Array.isArray(timeoutConfig)) {
+        timeoutConfig = [timeoutConfig];
+      }
+
+      for (const config of timeoutConfig.filter(c => !!c.Scenario)) {
+        console.log('Test Timeout', config, test.title.includes(config.grep));
+        if (config.grep) {
+          if (!test.title.includes(config.grep)) continue;
+        }
+        testTimeout = config.Scenario;
+      }
+    }
+
+    timeout = test.totalTimeout || testTimeout || suiteTimeout[suiteTimeout.length - 1];
     if (!timeout) return;
     currentTimeout = timeout;
     output.debug(`Test Timeout: ${timeout}s`);
@@ -70,3 +101,9 @@ module.exports = function () {
     }
   });
 };
+
+function checkForSeconds(timeout) {
+  if (timeout >= 1000) {
+    console.log(`Warning: Timeout was set to ${timeout}secs.\nGlobal timeout should be specified in seconds.`);
+  }
+}

package/lib/mochaFactory.js

@@ -47,13 +47,13 @@ class MochaFactory {
         let missingFeatureInFile = [];
         const seenTests = [];
         mocha.suite.eachTest(test => {
-          test.id = genTestId(test);
+          test.uid = genTestId(test);
 
           const name = test.fullTitle();
-          if (seenTests.includes(test.id)) {
+          if (seenTests.includes(test.uid)) {
             dupes.push(name);
           }
-          seenTests.push(test.id);
+          seenTests.push(test.uid);
 
           if (name.slice(0, name.indexOf(':')) === '') {
             missingFeatureInFile.push(test.file);

package/lib/plugin/allure.js

@@ -1,324 +1,15 @@
-const Allure = require('allure-js-commons');
-
-const event = require('../event');
-const logger = require('../output');
-const { ansiRegExp } = require('../utils');
-
-const defaultConfig = {
-  outputDir: global.output_dir,
-};
-
-/**
- * Allure reporter
- *
- * ![](https://user-images.githubusercontent.com/220264/45676511-8e052800-bb3a-11e8-8cbb-db5f73de2add.png)
- *
- * Enables Allure reporter.
- *
- * #### Usage
- *
- * To start please install `allure-commandline` package (which requires Java 8)
- *
- * ```
- * npm install -g allure-commandline --save-dev
- * ```
- *
- * Add this plugin to config file:
- *
- * ```js
- * "plugins": {
- *     "allure": {}
- * }
- * ```
- *
- * Run tests with allure plugin enabled:
- *
- * ```
- * npx codeceptjs run --plugins allure
- * ```
- *
- * By default, allure reports are saved to `output` directory.
- * Launch Allure server and see the report like on a screenshot above:
- *
- * ```
- * allure serve output
- * ```
- *
- * #### Configuration
- *
- * * `outputDir` - a directory where allure reports should be stored. Standard output directory is set by default.
- * * `enableScreenshotDiffPlugin` - a boolean flag for add screenshot diff to report.
- *    To attach, tou need to attach three files to the report - "diff.png", "actual.png", "expected.png".
- *    See [Allure Screenshot Plugin](https://github.com/allure-framework/allure2/blob/master/plugins/screen-diff-plugin/README.md)
- *
- * #### Public API
- *
- * There are few public API methods which can be accessed from other plugins.
- *
- * ```js
- * const allure = codeceptjs.container.plugins('allure');
- * ```
- *
- * `allure` object has following methods:
- *
- * * `addAttachment(name, buffer, type)` - add an attachment to current test / suite
- * * `addLabel(name, value)` - adds a label to current test
- * * `addParameter(kind, name, value)` - adds a parameter to current test
- * * `createStep(name, stepFunc)` - create a step, stepFunc could consist an attachment
- * Example of usage:
- * ```js
- *     allure.createStep('New created step', () => {
- *       allure.addAttachment(
- *         'Request params',
- *         '{"clientId":123, "name":"Tom", "age":29}',
- *         'application/json'
- *       );
- *     });
- * ```
- * ![Created Step Image](https://user-images.githubusercontent.com/63167966/139339384-e6e70a62-3638-406d-a224-f32473071428.png)
- * * `severity(value)` - adds severity label
- * * `epic(value)` - adds epic label
- * * `feature(value)` - adds feature label
- * * `story(value)` - adds story label
- * * `issue(value)` - adds issue label
- * * `setDescription(description, type)` - sets a description
- *
- */
-module.exports = (config) => {
-  defaultConfig.outputDir = global.output_dir;
-  config = Object.assign(defaultConfig, config);
-
-  const plugin = {};
-
-  const reporter = new Allure();
-  reporter.setOptions({ targetDir: config.outputDir });
-
-  let currentMetaStep = [];
-  let currentStep;
-
-  reporter.pendingCase = function (testName, timestamp, opts = {}) {
-    reporter.startCase(testName, timestamp);
-
-    if (opts.description) plugin.setDescription(opts.description);
-    if (opts.severity) plugin.severity(opts.severity);
-    if (opts.severity) plugin.addLabel('tag', opts.severity);
-
-    reporter.endCase('pending', { message: opts.message || 'Test ignored' }, timestamp);
-  };
-
-  plugin.addAttachment = (name, buffer, type) => {
-    reporter.addAttachment(name, buffer, type);
-  };
-
-  plugin.setDescription = (description, type) => {
-    const currentTest = reporter.getCurrentTest();
-    if (currentTest) {
-      currentTest.setDescription(description, type);
-    } else {
-      logger.error(`The test is not run. Please use "setDescription" for events:
-      "test.start", "test.before", "test.after", "test.passed", "test.failed", "test.finish"`);
-    }
-  };
-
-  plugin.createStep = (name, stepFunc = () => { }) => {
-    let result;
-    let status = 'passed';
-    reporter.startStep(name);
-    try {
-      result = stepFunc(this.arguments);
-    } catch (error) {
-      status = 'broken';
-      throw error;
-    } finally {
-      if (!!result
-        && (typeof result === 'object' || typeof result === 'function')
-        && typeof result.then === 'function'
-      ) {
-        result.then(() => reporter.endStep('passed'), () => reporter.endStep('broken'));
-      } else {
-        reporter.endStep(status);
-      }
-    }
-    return result;
-  };
-
-  plugin.createAttachment = (name, content, type) => {
-    if (typeof content === 'function') {
-      const attachmentName = name;
-      const buffer = content.apply(this, arguments);
-      return createAttachment(attachmentName, buffer, type);
-    } reporter.addAttachment(name, content, type);
-  };
-
-  plugin.severity = (severity) => {
-    plugin.addLabel('severity', severity);
-  };
-
-  plugin.epic = (epic) => {
-    plugin.addLabel('epic', epic);
-  };
-
-  plugin.feature = (feature) => {
-    plugin.addLabel('feature', feature);
-  };
-
-  plugin.story = (story) => {
-    plugin.addLabel('story', story);
-  };
-
-  plugin.issue = (issue) => {
-    plugin.addLabel('issue', issue);
-  };
-
-  plugin.addLabel = (name, value) => {
-    const currentTest = reporter.getCurrentTest();
-    if (currentTest) {
-      currentTest.addLabel(name, value);
-    } else {
-      logger.error(`The test is not run. Please use "addLabel" for events:
-      "test.start", "test.before", "test.after", "test.passed", "test.failed", "test.finish"`);
-    }
-  };
-
-  plugin.addParameter = (kind, name, value) => {
-    const currentTest = reporter.getCurrentTest();
-    if (currentTest) {
-      currentTest.addParameter(kind, name, value);
-    } else {
-      logger.error(`The test is not run. Please use "addParameter" for events:
-      "test.start", "test.before", "test.after", "test.passed", "test.failed", "test.finish"`);
-    }
-  };
-
-  event.dispatcher.on(event.suite.before, (suite) => {
-    reporter.startSuite(suite.fullTitle());
-  });
-
-  event.dispatcher.on(event.suite.before, (suite) => {
-    for (const test of suite.tests) {
-      if (test.pending) {
-        reporter.pendingCase(test.title, null, test.opts.skipInfo);
-      }
-    }
-  });
-
-  event.dispatcher.on(event.suite.after, () => {
-    reporter.endSuite();
-  });
-
-  event.dispatcher.on(event.test.before, (test) => {
-    reporter.startCase(test.title);
-    if (config.enableScreenshotDiffPlugin) {
-      const currentTest = reporter.getCurrentTest();
-      currentTest.addLabel('testType', 'screenshotDiff');
-    }
-    currentStep = null;
-  });
-
-  event.dispatcher.on(event.test.started, (test) => {
-    const currentTest = reporter.getCurrentTest();
-    for (const tag of test.tags) {
-      currentTest.addLabel('tag', tag);
-    }
-  });
-
-  event.dispatcher.on(event.test.failed, (test, err) => {
-    if (currentStep) reporter.endStep('failed');
-    if (currentMetaStep.length) {
-      currentMetaStep.forEach(() => reporter.endStep('failed'));
-      currentMetaStep = [];
-    }
-
-    err.message = err.message.replace(ansiRegExp(), '');
-    if (reporter.getCurrentTest()) {
-      reporter.endCase('failed', err);
-    } else {
-      // this means before suite failed, we should report this.
-      reporter.startCase(`BeforeSuite of suite ${reporter.getCurrentSuite().name} failed.`);
-      reporter.endCase('failed', err);
-    }
-  });
-
-  event.dispatcher.on(event.test.passed, () => {
-    if (currentStep) reporter.endStep('passed');
-    if (currentMetaStep.length) {
-      currentMetaStep.forEach(() => reporter.endStep('passed'));
-      currentMetaStep = [];
-    }
-    reporter.endCase('passed');
-  });
-
-  event.dispatcher.on(event.test.skipped, (test) => {
-    let loaded = true;
-    if (test.opts.skipInfo.isFastSkipped) {
-      loaded = false;
-      reporter.startSuite(test.parent.fullTitle());
-    }
-    reporter.pendingCase(test.title, null, test.opts.skipInfo);
-    if (!loaded) {
-      reporter.endSuite();
-    }
-  });
-
-  event.dispatcher.on(event.step.started, (step) => {
-    startMetaStep(step.metaStep);
-    if (currentStep !== step) {
-      // In multi-session scenarios, actors' names will be highlighted with ANSI
-      // escape sequences which are invalid XML values
-      step.actor = step.actor.replace(ansiRegExp(), '');
-      reporter.startStep(step.toString());
-      currentStep = step;
-    }
-  });
-
-  event.dispatcher.on(event.step.comment, (step) => {
-    reporter.startStep(step.toString());
-    currentStep = step;
-    reporter.endStep('passed');
-    currentStep = null;
-  });
-
-  event.dispatcher.on(event.step.passed, (step) => {
-    if (currentStep === step) {
-      reporter.endStep('passed');
-      currentStep = null;
-    }
-  });
-
-  event.dispatcher.on(event.step.failed, (step) => {
-    if (currentStep === step) {
-      reporter.endStep('failed');
-      currentStep = null;
-    }
-  });
-
-  let maxLevel;
-  function finishMetastep(level) {
-    const metaStepsToFinish = currentMetaStep.splice(maxLevel - level);
-    metaStepsToFinish.forEach(() => {
-      // only if the current step is of type Step, end it.
-      if (reporter.suites && reporter.suites.length && reporter.suites[0].currentStep && reporter.suites[0].currentStep.constructor.name === 'Step') {
-        reporter.endStep('passed');
-      }
-    });
-  }
-
-  function startMetaStep(metaStep, level = 0) {
-    maxLevel = level;
-    if (!metaStep) {
-      finishMetastep(0);
-      maxLevel--;
-      return;
-    }
-
-    startMetaStep(metaStep.metaStep, level + 1);
-
-    if (metaStep.toString() !== currentMetaStep[maxLevel - level]) {
-      finishMetastep(level);
-      currentMetaStep.push(metaStep.toString());
-      reporter.startStep(metaStep.toString());
-    }
-  }
-
-  return plugin;
+module.exports = () => {
+  console.log('Allure plugin was moved to @codeceptjs/allure-legacy. Please install it and update your config');
+  console.log();
+  console.log('npm install @codeceptjs/allure-legacy --save-dev');
+  console.log();
+  console.log('Then update your config to use it:');
+  console.log();
+  console.log('plugins: {');
+  console.log('  allure: {');
+  console.log('    enabled: true,');
+  console.log('    require: \'@codeceptjs/allure-legacy\',');
+  console.log('  }');
+  console.log('}');
+  console.log();
 };

package/lib/plugin/fakerTransform.js

@@ -1,4 +1,4 @@
-const faker = require('@faker-js/faker');
+const { faker } = require('@faker-js/faker');
 const transform = require('../transform');
 
 /**
@@ -44,7 +44,7 @@ const transform = require('../transform');
 module.exports = function (config) {
   transform.addTransformerBeforeAll('gherkin.examples', (value) => {
     if (typeof value === 'string' && value.length > 0) {
-      return faker.fake(value);
+      return faker.helpers.fake(value);
     }
     return value;
   });

package/lib/recorder.js

@@ -127,7 +127,7 @@ module.exports = {
     },
 
     /**
-     * @param {string} name
+     * @param {string} [name]
      * @inner
      */
     restore(name) {