codeceptjs 3.3.7 → 3.4.0-beta.1

package/lib/scenario.js

@@ -1,7 +1,8 @@
+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) {
@@ -124,17 +125,31 @@ 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;
 
-    if (isAsyncFunction(fn)) {
-      fn.call(this, getInjectedArguments(fn)).then(() => {
+    promiseRetry(async (retry) => {
+      try {
+        recorder.startUnlessRunning();
+        await fn.call(this, getInjectedArguments(fn));
+        await recorder.promise();
+      } catch (err) {
+        retry(err);
+      } finally {
+        recorder.stop();
+        recorder.start();
+      }
+    }, { retries })
+      .then(() => {
         recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
         recorder.add(`finish ${hookName} hook`, () => done());
         recorder.catch();
@@ -146,22 +161,6 @@ module.exports.injected = function (fn, suite, hookName) {
         });
         recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, e));
       });
-      return;
-    }
-
-    try {
-      fn.call(this, getInjectedArguments(fn));
-      recorder.add('fire hook.passed', () => event.emit(event.hook.passed, suite));
-      recorder.add(`finish ${hookName} hook`, () => done());
-      recorder.catch();
-    } catch (err) {
-      recorder.throw(err);
-      recorder.catch((e) => {
-        const err = (recorder.getAsyncErr() === null) ? e : recorder.getAsyncErr();
-        errHandler(err);
-      });
-      recorder.add('fire hook.failed', () => event.emit(event.hook.failed, suite, err));
-    }
   };
 };
 

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.7",
+  "version": "3.4.0-beta.1",
   "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,7 +128,7 @@
     "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",
@@ -139,11 +136,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,22 @@ declare namespace CodeceptJS {
     path?: string,
   };
 
+  type RetryConfig = {
+    grep: string;
+    Feature: number;
+    Scenario: number;
+    Before: number;
+    After: number;
+    BeforeSuite: number;
+    AfterSuite: number;
+  };
+
+  type TimeoutConfig = {
+    grep: string;
+    Feature: number;
+    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 +188,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;
     /**

package/typings/promiseBasedTypes.d.ts

@@ -42,8 +42,8 @@ declare namespace CodeceptJS {
      * ```js
      * // tests/factories/posts.js
      *
-     * const Factory = require('rosie').Factory;
-     * const faker = require('@faker-js/faker');
+     * const { Factory } = require('rosie');
+     * const { faker } = require('@faker-js/faker');
      *
      * module.exports = new Factory()
      *    // no need to set id, it will be set by REST API
@@ -190,10 +190,10 @@ declare namespace CodeceptJS {
          * I.have('user', { }, { age: 33, height: 55 })
          * ```
          * @param factory - factory to use
-         * @param params - predefined parameters
-         * @param options - options for programmatically generate the attributes
+         * @param [params] - predefined parameters
+         * @param [options] - options for programmatically generate the attributes
          */
-        have(factory: any, params: any, options: any): Promise<any>;
+        have(factory: any, params?: any, options?: any): Promise<any>;
         /**
          * Generates bunch of records and saves multiple API requests to store them.
          *
@@ -208,7 +208,7 @@ declare namespace CodeceptJS {
          * I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
          * ```
          */
-        haveMultiple(factory: any, times: any, params: any, options: any): Promise<any>;
+        haveMultiple(factory: any, times: any, params?: any, options?: any): Promise<any>;
         /**
          * Executes request to create a record in API.
          * Can be replaced from a in custom helper.
@@ -1153,10 +1153,10 @@ declare namespace CodeceptJS {
          */
         seeFile(name: string): Promise<any>;
         /**
-         * Waits for file to be present in current directory.
+         * Waits for the file to be present in the current directory.
          *
          * ```js
-         * I.handleDownloads();
+         * I.handleDownloads('downloads/largeFilesName.txt');
          * I.click('Download large File');
          * I.amInPath('output/downloads');
          * I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file
@@ -1337,8 +1337,8 @@ declare namespace CodeceptJS {
      * ```js
      * // tests/factories/users.js
      *
-     * const Factory = require('rosie').Factory;
-     * const faker = require('@faker-js/faker');
+     * const { Factory } = require('rosie').Factory;
+     * const { faker } = require('@faker-js/faker');
      *
      * // Used with a constructor function passed to Factory, so that the final build
      * // object matches the necessary pattern to be sent as the variables object.
@@ -3271,9 +3271,9 @@ declare namespace CodeceptJS {
          * I.waitForFile('avatar.jpg', 5);
          *
          * ```
-         * @param [fileName] - set filename for downloaded file
+         * @param fileName - set filename for downloaded file
          */
-        handleDownloads(fileName?: string): Promise<void>;
+        handleDownloads(fileName: string): Promise<void>;
         /**
          * Perform a click on a link or a button, given by a locator.
          * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.