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

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

package/lib/helper/WebDriver.js

@@ -4,12 +4,12 @@ const assert = require('assert');
 const path = require('path');
 const fs = require('fs');
 
-const Helper = require('../helper');
+const Helper = require('@codeceptjs/helper');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
 const { debug } = require('../output');
-const empty = require('../assert/empty').empty;
-const truth = require('../assert/truth').truth;
+const { empty } = require('../assert/empty');
+const { truth } = require('../assert/truth');
 const {
   xpathLocator,
   fileExists,
@@ -31,8 +31,6 @@ const Locator = require('../locator');
 const SHADOW = 'shadow';
 const webRoot = 'body';
 
-let version;
-
 /**
  * ## Configuration
  *
@@ -266,7 +264,7 @@ const config = {};
  * ```js
  * plugins: {
  *    wdio: {
-  *       enabled: true,
+ *       enabled: true,
  *        services: ['sauce'],
  *        user: ... ,// saucelabs username
  *        key: ... // saucelabs api key
@@ -294,7 +292,7 @@ const config = {};
  * ```js
  * plugins: {
  *    wdio: {
-  *       enabled: true,
+ *       enabled: true,
  *        services: ['browserstack'],
  *        user: ... ,// browserstack username
  *        key: ... // browserstack api key
@@ -386,16 +384,6 @@ class WebDriver extends Helper {
     super(config);
     webdriverio = require('webdriverio');
 
-    try {
-      version = JSON.parse(fs.readFileSync(path.join(require.resolve('webdriverio'), '/../../', 'package.json')).toString()).version;
-    } catch (err) {
-      this.debug('Can\'t detect webdriverio version, assuming webdriverio v6 is used');
-    }
-
-    if (isWebDriver5()) {
-      console.log('DEPRECATION NOTICE:');
-      console.log('You are using webdriverio v5. It is recommended to update to webdriverio@6.\nSupport of webdriverio v5 is deprecated and will be removed in CodeceptJS 3.0\n');
-    }
     // set defaults
     this.root = webRoot;
     this.isWeb = true;
@@ -661,23 +649,23 @@ class WebDriver extends Helper {
   }
 
   /**
-  * Use [webdriverio](https://webdriver.io/docs/api.html) API inside a test.
-  *
-  * First argument is a description of an action.
-  * Second argument is async function that gets this helper as parameter.
-  *
-  * { [`browser`](https://webdriver.io/docs/api.html)) } object from WebDriver API is available.
-  *
-  * ```js
-  * I.useWebDriverTo('open multiple windows', async ({ browser }) {
-  *    // create new window
-  *    await browser.newWindow('https://webdriver.io');
-  * });
-  * ```
-  *
-  * @param {string} description used to show in logs.
-  * @param {function} fn async functuion that executed with WebDriver helper as argument
-  */
+   * Use [webdriverio](https://webdriver.io/docs/api.html) API inside a test.
+   *
+   * First argument is a description of an action.
+   * Second argument is async function that gets this helper as parameter.
+   *
+   * { [`browser`](https://webdriver.io/docs/api.html)) } object from WebDriver API is available.
+   *
+   * ```js
+   * I.useWebDriverTo('open multiple windows', async ({ browser }) {
+   *    // create new window
+   *    await browser.newWindow('https://webdriver.io');
+   * });
+   * ```
+   *
+   * @param {string} description used to show in logs.
+   * @param {function} fn async functuion that executed with WebDriver helper as argument
+   */
   useWebDriverTo(description, fn) {
     return this._useTo(...arguments);
   }
@@ -1654,7 +1642,6 @@ class WebDriver extends Helper {
     const res = await this._locate(withStrictLocator(locator), true);
     assertElementExists(res, locator);
     const elem = usingFirstElement(res);
-    if (isWebDriver5()) return elem.moveTo(xOffset, yOffset);
     return elem.moveTo({ xOffset, yOffset });
   }
 
@@ -2043,19 +2030,7 @@ class WebDriver extends Helper {
    */
   async waitForEnabled(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
-        if (!res || res.length === 0) {
-          return false;
-        }
-        const selected = await forEachAsync(res, async el => this.browser.isElementEnabled(getElementId(el)));
-        if (Array.isArray(selected)) {
-          return selected.filter(val => val === true).length > 0;
-        }
-        return selected;
-      }, aSec * 1000, `element (${new Locator(locator)}) still not enabled after ${aSec} sec`);
-    }
+
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       if (!res || res.length === 0) {
@@ -2077,12 +2052,7 @@ class WebDriver extends Helper {
    */
   async waitForElement(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
-        return res && res.length;
-      }, aSec * 1000, `element (${(new Locator(locator))}) still not present on page after ${aSec} sec`);
-    }
+
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       return res && res.length;
@@ -2111,20 +2081,7 @@ class WebDriver extends Helper {
     const client = this.browser;
     const aSec = sec || this.options.waitForTimeoutInSeconds;
     let currUrl = '';
-    if (isWebDriver5()) {
-      return client
-        .waitUntil(function () {
-          return this.getUrl().then((res) => {
-            currUrl = decodeUrl(res);
-            return currUrl.indexOf(urlPart) > -1;
-          });
-        }, aSec * 1000).catch((e) => {
-          if (e.message.indexOf('timeout')) {
-            throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`);
-          }
-          throw e;
-        });
-    }
+
     return client
       .waitUntil(function () {
         return this.getUrl().then((res) => {
@@ -2169,20 +2126,6 @@ class WebDriver extends Helper {
   async waitForText(text, sec = null, context = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
     const _context = context || this.root;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(
-        async () => {
-          const res = await this.$$(withStrictLocator.call(this, _context));
-          if (!res || res.length === 0) return false;
-          const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)));
-          if (Array.isArray(selected)) {
-            return selected.filter(part => part.indexOf(text) >= 0).length > 0;
-          }
-          return selected.indexOf(text) >= 0;
-        }, aSec * 1000,
-        `element (${_context}) is not in DOM or there is no element(${_context}) with text "${text}" after ${aSec} sec`,
-      );
-    }
 
     return this.browser.waitUntil(
       async () => {
@@ -2206,20 +2149,7 @@ class WebDriver extends Helper {
   async waitForValue(field, value, sec = null) {
     const client = this.browser;
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return client.waitUntil(
-        async () => {
-          const res = await findFields.call(this, field);
-          if (!res || res.length === 0) return false;
-          const selected = await forEachAsync(res, async el => el.getValue());
-          if (Array.isArray(selected)) {
-            return selected.filter(part => part.indexOf(value) >= 0).length > 0;
-          }
-          return selected.indexOf(value) >= 0;
-        }, aSec * 1000,
-        `element (${field}) is not in DOM or there is no element(${field}) with value "${value}" after ${aSec} sec`,
-      );
-    }
+
     return client.waitUntil(
       async () => {
         const res = await findFields.call(this, field);
@@ -2242,17 +2172,7 @@ class WebDriver extends Helper {
    */
   async waitForVisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
-        if (!res || res.length === 0) return false;
-        const selected = await forEachAsync(res, async el => el.isDisplayed());
-        if (Array.isArray(selected)) {
-          return selected.filter(val => val === true).length > 0;
-        }
-        return selected;
-      }, aSec * 1000, `element (${new Locator(locator)}) still not visible after ${aSec} sec`);
-    }
+
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       if (!res || res.length === 0) return false;
@@ -2269,17 +2189,7 @@ class WebDriver extends Helper {
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
-        if (!res || res.length === 0) return false;
-        let selected = await forEachAsync(res, async el => el.isDisplayed());
 
-        if (!Array.isArray(selected)) selected = [selected];
-        selected = selected.filter(val => val === true);
-        return selected.length === num;
-      }, aSec * 1000, `The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec`);
-    }
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       if (!res || res.length === 0) return false;
@@ -2296,14 +2206,7 @@ class WebDriver extends Helper {
    */
   async waitForInvisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
-        if (!res || res.length === 0) return true;
-        const selected = await forEachAsync(res, async el => el.isDisplayed());
-        return !selected.length;
-      }, aSec * 1000, `element (${new Locator(locator)}) still visible after ${aSec} sec`);
-    }
+
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       if (!res || res.length === 0) return true;
@@ -2324,15 +2227,7 @@ class WebDriver extends Helper {
    */
   async waitForDetached(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => {
-        const res = await this._res(locator);
-        if (!res || res.length === 0) {
-          return true;
-        }
-        return false;
-      }, aSec * 1000, `element (${new Locator(locator)}) still on page after ${aSec} sec`);
-    }
+
     return this.browser.waitUntil(async () => {
       const res = await this._res(locator);
       if (!res || res.length === 0) {
@@ -2356,9 +2251,7 @@ class WebDriver extends Helper {
     }
 
     const aSec = sec || this.options.waitForTimeoutInSeconds;
-    if (isWebDriver5()) {
-      return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), aSec * 1000, '');
-    }
+
     return this.browser.waitUntil(async () => this.browser.execute(fn, ...args), { timeout: aSec * 1000, timeoutMsg: '' });
   }
 
@@ -2388,18 +2281,6 @@ class WebDriver extends Helper {
     let target;
     const current = await this.browser.getWindowHandle();
 
-    if (isWebDriver5()) {
-      await this.browser.waitUntil(async () => {
-        await this.browser.getWindowHandles().then((handles) => {
-          if (handles.indexOf(current) + num + 1 <= handles.length) {
-            target = handles[handles.indexOf(current) + num];
-          }
-        });
-        return target;
-      }, aSec * 1000, `There is no ability to switch to next tab with offset ${num}`);
-      return this.browser.switchToWindow(target);
-    }
-
     await this.browser.waitUntil(async () => {
       await this.browser.getWindowHandles().then((handles) => {
         if (handles.indexOf(current) + num + 1 <= handles.length) {
@@ -2419,18 +2300,6 @@ class WebDriver extends Helper {
     const current = await this.browser.getWindowHandle();
     let target;
 
-    if (isWebDriver5()) {
-      await this.browser.waitUntil(async () => {
-        await this.browser.getWindowHandles().then((handles) => {
-          if (handles.indexOf(current) - num > -1) {
-            target = handles[handles.indexOf(current) - num];
-          }
-        });
-        return target;
-      }, aSec * 1000, `There is no ability to switch to previous tab with offset ${num}`);
-      return this.browser.switchToWindow(target);
-    }
-
     await this.browser.waitUntil(async () => {
       await this.browser.getWindowHandles().then((handles) => {
         if (handles.indexOf(current) - num > -1) {
@@ -3018,8 +2887,4 @@ function prepareLocateFn(context) {
   };
 }
 
-function isWebDriver5() {
-  return version && version.indexOf('5') === 0;
-}
-
 module.exports = WebDriver;

package/lib/helper.js

@@ -1,4 +1,2 @@
 // helper class was moved out from this repository to allow extending from base class
-// without loading full CodeceptJS package
-if (!global.codeceptjs) global.codeceptjs = require('./index');
 module.exports = require('@codeceptjs/helper');

package/lib/interfaces/bdd.js

@@ -1,4 +1,4 @@
-const { CucumberExpression, ParameterTypeRegistry, ParameterType } = require('cucumber-expressions');
+const { CucumberExpression, ParameterTypeRegistry, ParameterType } = require('@cucumber/cucumber-expressions');
 const Config = require('../config');
 
 let steps = {};

package/lib/interfaces/featureConfig.js

@@ -19,6 +19,7 @@ class FeatureConfig {
    * Set timeout for this suite
    * @param {number} timeout
    * @returns {this}
+   * @deprecated
    */
   timeout(timeout) {
     console.log(`Feature('${this.suite.title}').timeout(${timeout}) is deprecated!`);