codeceptjs 3.3.8-beta.1 → 3.4.0

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) {

package/lib/scenario.js

@@ -2,7 +2,7 @@ const promiseRetry = require('promise-retry');
 const event = require('./event');
 const recorder = require('./recorder');
 const assertThrown = require('./assert/throws');
-const { isAsyncFunction } = require('./utils');
+const { ucfirst, isAsyncFunction } = require('./utils');
 const parser = require('./parser');
 
 const injectHook = function (inject, suite) {
@@ -107,7 +107,7 @@ module.exports.test = (test) => {
 /**
  * Injects arguments to function from controller
  */
-module.exports.injected = function (fn, suite, hookName) {  
+module.exports.injected = function (fn, suite, hookName) {
   return function (done) {
     const errHandler = (err) => {
       recorder.session.start('teardown');
@@ -125,35 +125,42 @@ module.exports.injected = function (fn, suite, hookName) {
     if (!fn) throw new Error('fn is not defined');
 
     event.emit(event.hook.started, suite);
+
+    this.test.body = fn.toString();
+
     if (!recorder.isRunning()) {
-      recorder.start();
       recorder.errHandler((err) => {
         errHandler(err);
       });
     }
 
-    this.test.body = fn.toString();
+    const opts = suite.opts || {};
+    const retries = opts[`retry${ucfirst(hookName)}`] || 0;
 
-    recorder.retry(suite.retries());
     promiseRetry(async (retry) => {
       try {
-        await fn.call(this, getInjectedArguments(fn))
+        recorder.startUnlessRunning();
+        await fn.call(this, getInjectedArguments(fn));
+        await recorder.promise();
       } catch (err) {
         retry(err);
+      } finally {
+        recorder.stop();
+        recorder.start();
       }
-    }, { retries: suite.retries() })
-    .then(() => {
-      recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
-      recorder.add(`finish ${hookName} hook`, () => done());
-      recorder.catch();
-    }).catch((e) => {
-      recorder.throw(e);
-      recorder.catch((e) => {
-        const err = (recorder.getAsyncErr() === null) ? e : recorder.getAsyncErr();
-        errHandler(err);
+    }, { retries })
+      .then(() => {
+        recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
+        recorder.add(`finish ${hookName} hook`, () => done());
+        recorder.catch();
+      }).catch((e) => {
+        recorder.throw(e);
+        recorder.catch((e) => {
+          const err = (recorder.getAsyncErr() === null) ? e : recorder.getAsyncErr();
+          errHandler(err);
+        });
+        recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, e));
       });
-      recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, e));
-    });
   };
 };
 

package/lib/utils.js

@@ -449,3 +449,9 @@ module.exports.requireWithFallback = function (...packages) {
 
   throw new Error(`Cannot find modules ${packages.join(',')}`);
 };
+
+module.exports.isNotSet = function (obj) {
+  if (obj === null) return true;
+  if (obj === undefined) return true;
+  return false;
+};

package/lib/workers.js

@@ -1,9 +1,9 @@
 /* eslint-disable max-classes-per-file */
-const { EventEmitter } = require('events');
 const path = require('path');
 const mkdirp = require('mkdirp');
 const { Worker } = require('worker_threads');
 const { Suite, Test, reporters: { Base } } = require('mocha');
+const { EventEmitter } = require('events');
 const ms = require('ms');
 const Codecept = require('./codecept');
 const MochaFactory = require('./mochaFactory');
@@ -107,8 +107,7 @@ const convertToMochaTests = (testGroup) => {
     mocha.files = testGroup;
     mocha.loadFiles();
     mocha.suite.eachTest((test) => {
-      const { id } = test;
-      group.push(id);
+      group.push(test.uid);
     });
     mocha.unloadFiles();
   }
@@ -242,8 +241,7 @@ class Workers extends EventEmitter {
     mocha.suite.eachTest((test) => {
       const i = groupCounter % groups.length;
       if (test) {
-        const { id } = test;
-        groups[i].push(id);
+        groups[i].push(test.uid);
         groupCounter++;
       }
     });
@@ -264,8 +262,7 @@ class Workers extends EventEmitter {
       const i = indexOfSmallestElement(groups);
       suite.tests.forEach((test) => {
         if (test) {
-          const { id } = test;
-          groups[i].push(id);
+          groups[i].push(test.uid);
         }
       });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.8-beta.1",
+  "version": "3.4.0",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -35,7 +35,6 @@
   },
   "repository": "Codeception/codeceptjs",
   "scripts": {
-    "build": "tsc -p ./",
     "json-server": "./node_modules/json-server/bin/index.js test/data/rest/db.json -p 8010 --watch -m test/data/rest/headers.js",
     "json-server:graphql": "node test/data/graphql/index.js",
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.js",
@@ -56,23 +55,23 @@
   "dependencies": {
     "@codeceptjs/configure": "^0.8.0",
     "@codeceptjs/helper": "^1.0.2",
+    "@cucumber/cucumber-expressions": "^16",
+    "@cucumber/gherkin": "^26",
+    "@cucumber/messages": "^21.0.1",
     "acorn": "^7.4.1",
-    "allure-js-commons": "^1.3.2",
     "arrify": "^2.0.1",
-    "axios": "^0.21.4",
+    "axios": "^1.3.3",
     "chai": "^4.3.6",
     "chai-deep-match": "^1.2.1",
     "chalk": "^4.1.2",
     "commander": "^2.20.3",
     "cross-spawn": "^7.0.3",
     "css-to-xpath": "^0.1.0",
-    "cucumber-expressions": "^6.6.2",
     "envinfo": "^7.8.1",
     "escape-string-regexp": "^1.0.3",
     "figures": "^3.2.0",
     "fn-args": "^4.0.0",
     "fs-extra": "^8.1.0",
-    "gherkin": "^5.1.0",
     "glob": "^6.0.1",
     "inquirer": "^6.5.2",
     "joi": "^17.6.0",
@@ -80,21 +79,19 @@
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "mkdirp": "^1.0.4",
-    "mocha": "8.1.3",
-    "mocha-junit-reporter": "1.23.1",
+    "mocha": "^8.2.0",
+    "mocha-junit-reporter": "^1.23.3",
     "ms": "^2.1.3",
     "parse-function": "^5.6.4",
     "promise-retry": "^1.1.1",
-    "requireg": "^0.2.2",
     "resq": "^1.10.2",
-    "semver": "^6.3.0",
     "sprintf-js": "^1.1.1",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
     "@codeceptjs/mock-request": "^0.3.1",
-    "@faker-js/faker": "^5.5.3",
+    "@faker-js/faker": "^7.6.0",
     "@pollyjs/adapter-puppeteer": "^5.1.0",
     "@pollyjs/core": "^5.1.0",
     "@types/inquirer": "^0.0.35",
@@ -118,10 +115,10 @@
     "form-data": "^3.0.1",
     "graphql": "^14.6.0",
     "husky": "^8.0.1",
+    "inquirer-test": "^2.0.1",
     "jsdoc": "^3.6.10",
     "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
-    "mocha-parallel-tests": "^2.3.0",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
     "playwright": "^1.23.2",
@@ -131,19 +128,18 @@
     "runok": "^0.9.2",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.7.0",
-    "testcafe": "^1.18.3",
+    "testcafe": "^2.1.0",
     "ts-morph": "^3.1.3",
     "ts-node": "^10.9.1",
-    "tsd-jsdoc": "https://github.com/englercj/tsd-jsdoc.git",
+    "tsd-jsdoc": "^2.5.0",
     "typedoc": "^0.23.10",
     "typedoc-plugin-markdown": "^3.13.4",
     "typescript": "^4.8.4",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^7.16.14",
+    "webdriverio": "^8.3.8",
     "xml2js": "^0.4.23",
     "xmldom": "^0.1.31",
-    "xpath": "0.0.27",
-    "inquirer-test": "^2.0.1"
+    "xpath": "0.0.27"
   },
   "engines": {
     "node": ">=8.9.1",

package/typings/index.d.ts

@@ -17,6 +17,32 @@ declare namespace CodeceptJS {
     path?: string,
   };
 
+  type RetryConfig = {
+    /** Filter tests by string or regexp pattern */
+    grep: string | RegExp;
+    /** Number of times to repeat scenarios of a Feature */
+    Feature: number;
+    /** Number of times to repeat scenarios */
+    Scenario: number;
+    /** Number of times to repeat Before hook */
+    Before: number;
+    /** Number of times to repeat After hook */
+    After: number;
+    /** Number of times to repeat BeforeSuite hook */
+    BeforeSuite: number;
+    /** Number of times to repeat AfterSuite hook */
+    AfterSuite: number;
+  };
+
+  type TimeoutConfig = {
+    /** Filter tests by string or regexp pattern */
+    grep: string | RegExp;
+    /** Set timeout for a scenarios of a Feature */
+    Feature: number;
+    /** Set timeout for scenarios */
+    Scenario: number;
+  };
+
   type MainConfig = {
     /** Pattern to locate CodeceptJS tests.
      * Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names.
@@ -172,8 +198,57 @@ declare namespace CodeceptJS {
      * ```js
      * timeout: 20,
      * ```
+     *
+     * Can be customized to use different timeouts for a subset of tests:
+     *
+     * ```js
+     * timeout: [
+     *    10,
+     *    {
+     *      grep: '@slow',
+     *      Scenario: 20
+     *    }
+     * ]
+     * ```
      */
-    timeout?: number;
+    timeout?: number | Array<TimeoutConfig> | TimeoutConfig;
+
+    /**
+     * Configure retry strategy for tests
+     *
+     * To retry all tests 3 times:
+     *
+     * ```js
+     * retry: 3
+     * ```
+     *
+     * To retry only Before hook 3 times:
+     *
+     * ```js
+     * retry: {
+     *    Before: 3
+     * }
+     * ```
+     *
+     * To retry tests marked as flaky 3 times, other 1 time:
+     *
+     * ```js
+     * retry: [
+     *   {
+     *     Scenario: 1,
+     *     Before: 1
+     *   },
+     *   {
+     *     grep: '@flaky',
+     *     Scenario: 3
+     *     Before: 3
+     *   }
+     * ]
+     * ```
+     */
+    retry?: number | Array<RetryConfig> | RetryConfig;
+
+
     /** Disable registering global functions (Before, Scenario, etc). Not recommended */
     noGlobals?: boolean;
     /**