codeceptjs 3.3.8-beta.1 → 3.4.0

package/lib/cli.js

@@ -40,7 +40,7 @@ class Cli extends Base {
 
     runner.on('fail', (test) => {
       if (test.ctx.currentTest) {
-        this.loadedTests.push(test.ctx.currentTest.id);
+        this.loadedTests.push(test.ctx.currentTest.uid);
       }
       if (showSteps && test.steps) {
         return output.scenario.failed(test);
@@ -57,7 +57,7 @@ class Cli extends Base {
       } else {
         skipTestConfig(test, null);
       }
-      this.loadedTests.push(test.id);
+      this.loadedTests.push(test.uid);
       cursor.CR();
       output.test.skipped(test);
     });
@@ -111,7 +111,7 @@ class Cli extends Base {
       let skippedCount = 0;
       const grep = runner._grep;
       for (const test of suite.tests) {
-        if (!test.state && !this.loadedTests.includes(test.id)) {
+        if (!test.state && !this.loadedTests.includes(test.uid)) {
           if (matchTest(grep, test.title)) {
             if (!test.opts) {
               test.opts = {};

package/lib/codecept.js

@@ -67,8 +67,8 @@ class Codecept {
     global.output_dir = fsPath.resolve(dir, this.config.output);
 
     if (!this.config.noGlobals) {
+      global.Helper = global.codecept_helper = require('@codeceptjs/helper');
       global.actor = global.codecept_actor = require('./actor');
-      global.Helper = global.codecept_helper = require('./helper');
       global.pause = require('./pause');
       global.within = require('./within');
       global.session = require('./session');
@@ -98,6 +98,7 @@ class Codecept {
     runHook(require('./listener/artifacts'));
     runHook(require('./listener/config'));
     runHook(require('./listener/helpers'));
+    runHook(require('./listener/retry'));
     runHook(require('./listener/timeout'));
     runHook(require('./listener/exit'));
 

package/lib/command/generate.js

@@ -128,7 +128,9 @@ module.exports.pageObject = function (genPath, opts) {
     const name = lcfirst(result.name) + ucfirst(kind);
     let data = readConfig(configFile);
     config.include[name] = result.filename;
-    data = data.replace(/include[\s\S][^\}]*/i, `include: ${JSON.stringify(config.include).slice(0, -1)}`);
+    const currentInclude = `${data.match(/include:[\s\S][^\}]*/i)[0]}\n ${name}:${JSON.stringify(config.include[name])}`;
+
+    data = data.replace(/include:[\s\S][^\}]*/i, `${currentInclude}`);
 
     fs.writeFileSync(configFile, beautify(data), 'utf-8');
 

package/lib/command/gherkin/snippets.js

@@ -1,6 +1,7 @@
 const escapeStringRegexp = require('escape-string-regexp');
 const fs = require('fs');
-const { Parser } = require('gherkin');
+const Gherkin = require('@cucumber/gherkin');
+const Messages = require('@cucumber/messages');
 const glob = require('glob');
 const fsPath = require('path');
 
@@ -9,7 +10,10 @@ const Codecept = require('../../codecept');
 const output = require('../../output');
 const { matchStep } = require('../../interfaces/bdd');
 
-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 = function (genPath, options) {
@@ -85,8 +89,8 @@ module.exports = function (genPath, options) {
   const parseFile = (file) => {
     const ast = parser.parse(fs.readFileSync(file).toString());
     for (const child of ast.feature.children) {
-      if (child.type === 'ScenarioOutline') continue; // skip scenario outline
-      parseSteps(child.steps).map((step) => {
+      if (child.scenario.keyword === 'Scenario Outline') continue; // skip scenario outline
+      parseSteps(child.scenario.steps).map((step) => {
         return Object.assign(step, { file: file.replace(global.codecept_dir, '').slice(1) });
       }).map((step) => newSteps.set(`${step.type}(${step})`, step));
     }

package/lib/command/init.js

@@ -126,13 +126,6 @@ module.exports = function (initPath) {
       default: './output',
       message: 'Where should logs, screenshots, and reports to be stored?',
     },
-    {
-      name: 'promise',
-      type: 'confirm',
-      default: false,
-      message: 'Would you prefer to use promise-based typings for all I.* commands? http://bit.ly/3XIMq6n',
-      when: (answers) => answers.typescript,
-    },
     {
       name: 'translation',
       type: 'list',
@@ -155,7 +148,6 @@ module.exports = function (initPath) {
     config.tests = result.tests;
     if (isTypeScript) {
       config.tests = `${config.tests.replace(/\.js$/, `.${extension}`)}`;
-      config.fullPromiseBased = result.promise;
     }
 
     // create a directory tests if it is included in tests path

package/lib/command/run-workers.js

@@ -1,16 +1,10 @@
 // For Node version >=10.5.0, have to use experimental flag
-const { satisfyNodeVersion } = require('./utils');
 const { tryOrDefault } = require('../utils');
 const output = require('../output');
 const event = require('../event');
 const Workers = require('../workers');
 
 module.exports = async function (workerCount, options) {
-  satisfyNodeVersion(
-    '>=11.7.0',
-    'Required minimum Node version of 11.7.0 to work with "run-workers"',
-  );
-
   process.env.profile = options.profile;
 
   const { config: testConfig, override = '' } = options;
@@ -46,6 +40,9 @@ module.exports = async function (workerCount, options) {
   try {
     await workers.bootstrapAll();
     await workers.run();
+  } catch (err) {
+    output.error(err);
+    process.exit(1);
   } finally {
     await workers.teardownAll();
   }

package/lib/command/utils.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const path = require('path');
-const semver = require('semver');
 const util = require('util');
 const mkdirp = require('mkdirp');
 
@@ -71,15 +70,6 @@ function safeFileWrite(file, contents) {
 
 module.exports.safeFileWrite = safeFileWrite;
 
-module.exports.satisfyNodeVersion = (
-  version,
-  failureMessage = `Required Node version: ${version}`,
-) => {
-  if (!semver.satisfies(process.version, version)) {
-    fail(failureMessage);
-  }
-};
-
 module.exports.captureStream = (stream) => {
   let oldStream;
   let buffer = '';

package/lib/command/workers/runTests.js

@@ -68,7 +68,7 @@ function filterTests() {
   mocha.loadFiles();
 
   for (const suite of mocha.suite.suites) {
-    suite.tests = suite.tests.filter(test => tests.indexOf(test.id) >= 0);
+    suite.tests = suite.tests.filter(test => tests.indexOf(test.uid) >= 0);
   }
 }
 
@@ -124,7 +124,7 @@ function initializeListeners() {
     return {
       opts: test.opts || {},
       tags: test.tags || [],
-      id: test.id,
+      uid: test.uid,
       workerIndex,
       retries: test._retries,
       title: test.title,

package/lib/config.js

@@ -79,7 +79,11 @@ class Config {
     configFile = path.resolve(configFile || '.');
 
     if (!fileExists(configFile)) {
-      throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`);
+      configFile = configFile.replace('.js', '.ts');
+
+      if (!fileExists(configFile)) {
+        throw new Error(`Config file ${configFile} does not exist. Execute 'codeceptjs init' to create config`);
+      }
     }
 
     // is config file

package/lib/helper/ApiDataFactory.js

@@ -1,6 +1,6 @@
 const path = require('path');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const REST = require('./REST');
 
 /**
@@ -46,8 +46,8 @@ const REST = require('./REST');
  * ```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
@@ -230,7 +230,7 @@ class ApiDataFactory extends Helper {
   }
 
   _after() {
-    if (!this.config.cleanup) {
+    if (!this.config.cleanup || this.config.cleanup === false) {
       return Promise.resolve();
     }
     const promises = [];
@@ -244,7 +244,6 @@ class ApiDataFactory extends Helper {
         promises.push(this._requestDelete(factoryName, createdItems[id]));
       }
     }
-
     return Promise.all(promises);
   }
 
@@ -262,8 +261,8 @@ class ApiDataFactory extends Helper {
    * ```
    *
    * @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
    * @returns {Promise<*>}
    */
   have(factory, params, options) {
@@ -288,8 +287,8 @@ class ApiDataFactory extends Helper {
    *
    * @param {*} factory
    * @param {*} times
-   * @param {*} params
-   * @param {*} options
+   * @param {*} [params]
+   * @param {*} [options]
    */
   haveMultiple(factory, times, params, options) {
     const promises = [];
@@ -379,7 +378,9 @@ Current file error: ${err.message}`);
 
     if (!request) {
       const method = Object.keys(this.factories[factory].delete)[0];
+
       const url = this.factories[factory].delete[method].replace('{id}', id);
+
       request = {
         method,
         url,
@@ -388,6 +389,10 @@ Current file error: ${err.message}`);
 
     request.baseURL = this.config.endpoint;
 
+    if (request.url.match(/^undefined/)) {
+      return this.debugSection('Please configure the delete request in your ApiDataFactory helper', 'delete: () => ({ method: \'DELETE\',  url: \'/api/users\' })');
+    }
+
     return this.restHelper._executeRequest(request).then(() => {
       const idx = this.created[factory].indexOf(id);
       this.debugSection('Deleted Id', `Id: ${id}`);

package/lib/helper/Appium.js

@@ -1,5 +1,4 @@
 let webdriverio;
-let wdioV4;
 
 const fs = require('fs');
 const axios = require('axios').default;
@@ -131,6 +130,7 @@ class Appium extends Webdriver {
    * @augments WebDriver
    */
 
+  // @ts-ignore
   constructor(config) {
     super(config);
 
@@ -138,7 +138,6 @@ class Appium extends Webdriver {
     this.axios = axios.create();
 
     webdriverio = require('webdriverio');
-    (!webdriverio.VERSION || webdriverio.VERSION.indexOf('4') !== 0) ? wdioV4 = false : wdioV4 = true;
   }
 
   _validateConfig(config) {
@@ -516,10 +515,6 @@ class Appium extends Webdriver {
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, supportedPlatform.android);
 
-    if (wdioV4) {
-      return this.browser.removeApp(bundleId);
-    }
-
     return this.axios({
       method: 'post',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/appium/device/remove_app`,
@@ -610,19 +605,13 @@ class Appium extends Webdriver {
    */
   async seeOrientationIs(orientation) {
     onlyForApps.call(this);
-    let currentOrientation;
-
-    if (wdioV4) {
-      const res = await this.browser.orientation();
-      currentOrientation = res;
-    }
 
     const res = await this.axios({
       method: 'get',
       url: `${this._buildAppiumEndpoint()}/session/${this.browser.sessionId}/orientation`,
     });
 
-    currentOrientation = res.data.value;
+    const currentOrientation = res.data.value;
     return truth('orientation', `to be ${orientation}`).assert(currentOrientation === orientation);
   }
 
@@ -640,9 +629,6 @@ class Appium extends Webdriver {
    */
   async setOrientation(orientation) {
     onlyForApps.call(this);
-    if (wdioV4) {
-      return this.browser.setOrientation(orientation);
-    }
 
     return this.axios({
       method: 'post',
@@ -916,9 +902,6 @@ class Appium extends Webdriver {
    */
   async sendDeviceKeyEvent(keyValue) {
     onlyForApps.call(this, supportedPlatform.android);
-    if (wdioV4) {
-      return this.browser.sendKeyEvent(keyValue);
-    }
     return this.browser.pressKeyCode(keyValue);
   }
 

package/lib/helper/FileSystem.js

@@ -2,7 +2,7 @@ const assert = require('assert');
 const path = require('path');
 const fs = require('fs');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const { fileExists } = require('../utils');
 const { fileIncludes } = require('../assert/include');
 const { fileEquals } = require('../assert/equal');
@@ -71,10 +71,10 @@ class FileSystem extends Helper {
   }
 
   /**
-   * 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

package/lib/helper/GraphQL.js

@@ -1,5 +1,5 @@
 const axios = require('axios').default;
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.

package/lib/helper/GraphQLDataFactory.js

@@ -1,6 +1,6 @@
 const path = require('path');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const GraphQL = require('./GraphQL');
 
 /**
@@ -46,8 +46,8 @@ const GraphQL = require('./GraphQL');
  * ```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.

package/lib/helper/JSONResponse.js

@@ -2,7 +2,7 @@ const assert = require('assert');
 const chai = require('chai');
 const joi = require('joi');
 const chaiDeepMatch = require('chai-deep-match');
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 
 chai.use(chaiDeepMatch);
 

package/lib/helper/Mochawesome.js

@@ -2,7 +2,7 @@ let addMochawesomeContext;
 let currentTest;
 let currentSuite;
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const { clearString } = require('../utils');
 
 class Mochawesome extends Helper {

package/lib/helper/Nightmare.js

@@ -2,7 +2,7 @@ const path = require('path');
 
 const urlResolve = require('url').resolve;
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const { includes: stringIncludes } = require('../assert/include');
 const { urlEquals } = require('../assert/equal');
 const { equals } = require('../assert/equal');

package/lib/helper/Playwright.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const fs = require('fs');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const Locator = require('../locator');
 const recorder = require('../recorder');
 const stringIncludes = require('../assert/include').includes;
@@ -66,6 +66,7 @@ const pathSeparator = path.sep;
  * @prop {boolean} [video=false] - enables video recording for failed tests; videos are saved into `output/videos` folder
  * @prop {boolean} [keepVideoForPassedTests=false] - save videos for passed tests; videos are saved into `output/videos` folder
  * @prop {boolean} [trace=false] - record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
+ * @prop {boolean} [keepTraceForPassedTests=false] - save trace for passed tests.
  * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
  * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
  * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to 'session'.
@@ -1259,7 +1260,7 @@ class Playwright extends Helper {
    *
    * ```
    *
-   * @param {string} [fileName] set filename for downloaded file
+   * @param {string} fileName set filename for downloaded file
    * @return {Promise<void>}
    */
   async handleDownloads(fileName) {
@@ -2981,7 +2982,7 @@ async function refreshContextSession() {
 
 async function saveVideoForPage(page, name) {
   if (!page.video()) return null;
-  const fileName = `${global.output_dir}${pathSeparator}videos${pathSeparator}${Date.now()}_${clearString(name).slice(0, 245)}.webm`;
+  const fileName = `${`${global.output_dir}${pathSeparator}videos${pathSeparator}${Date.now()}_${clearString(name)}`.slice(0, 245)}.webm`;
   page.video().saveAs(fileName).then(() => {
     if (!page) return;
     page.video().delete().catch(e => {});

package/lib/helper/Protractor.js

@@ -6,7 +6,7 @@ let ProtractorExpectedConditions;
 
 const path = require('path');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
 const { empty } = require('../assert/empty');

package/lib/helper/Puppeteer.js

@@ -3,7 +3,7 @@ const fs = require('fs');
 const fsExtra = require('fs-extra');
 const path = require('path');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const Locator = require('../locator');
 const recorder = require('../recorder');
 const stringIncludes = require('../assert/include').includes;

package/lib/helper/REST.js

@@ -1,7 +1,7 @@
 const axios = require('axios').default;
+const Helper = require('@codeceptjs/helper');
 const Secret = require('../secret');
 
-const Helper = require('../helper');
 const { beautify } = require('../utils');
 
 /**

package/lib/helper/TestCafe.js

@@ -6,6 +6,7 @@ const qrcode = require('qrcode-terminal');
 const createTestCafe = require('testcafe');
 const { Selector, ClientFunction } = require('testcafe');
 
+const Helper = require('@codeceptjs/helper');
 const ElementNotFound = require('./errors/ElementNotFound');
 const testControllerHolder = require('./testcafe/testControllerHolder');
 const {
@@ -22,7 +23,6 @@ const {
   xpathLocator,
 } = require('../utils');
 const Locator = require('../locator');
-const Helper = require('../helper');
 
 /**
  * Client Functions
@@ -545,8 +545,8 @@ class TestCafe extends Helper {
 
     // TODO As far as I understand the testcafe docs this should do a multi-select
     // but it does not work
-    const clickOpts = { ctrl: option.length > 1 };
-    await this.t.click(el, clickOpts).catch(mapError);
+    // const clickOpts = { ctrl: option.length > 1 };
+    await this.t.click(el).catch(mapError);
 
     for (const key of option) {
       const opt = key;
@@ -555,7 +555,7 @@ class TestCafe extends Helper {
       try {
         optEl = el.child('option').withText(opt);
         if (await optEl.count) {
-          await this.t.click(optEl, clickOpts).catch(mapError);
+          await this.t.click(optEl).catch(mapError);
           continue;
         }
         // eslint-disable-next-line no-empty
@@ -566,7 +566,7 @@ class TestCafe extends Helper {
         const sel = `[value="${opt}"]`;
         optEl = el.find(sel);
         if (await optEl.count) {
-          await this.t.click(optEl, clickOpts).catch(mapError);
+          await this.t.click(optEl).catch(mapError);
         }
         // eslint-disable-next-line no-empty
       } catch (err) {