codeceptjs 3.5.5 → 3.5.7-beta.1

package/docs/webapi/seeInPopup.mustache

@@ -5,4 +5,4 @@ given string.
 I.seeInPopup('Popup text');
 ```
 @param {string} text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeInSource.mustache

@@ -4,4 +4,4 @@ Checks that the current page contains the given string in its raw source code.
 I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 ```
 @param {string} text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeInTitle.mustache

@@ -5,4 +5,4 @@ I.seeInTitle('Home Page');
 ```
 
 @param {string} text text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeNumberOfElements.mustache

@@ -8,4 +8,4 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeNumberOfVisibleElements.mustache

@@ -7,4 +7,4 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeTextEquals.mustache

@@ -6,4 +6,4 @@ I.seeTextEquals('text', 'h1');
 
 @param {string} text element value to check.
 @param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeTitleEquals.mustache

@@ -5,4 +5,4 @@ I.seeTitleEquals('Test title.');
 ```
 
 @param {string} text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/selectOption.mustache

@@ -18,4 +18,4 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 ```
 @param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
 @param {string|Array<*>} option visible text or value of option.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/setCookie.mustache

@@ -13,4 +13,4 @@ I.setCookie([
 ```
 
 @param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/setGeoLocation.mustache

@@ -9,4 +9,4 @@ I.setGeoLocation(121.21, 11.56, 10);
 @param {number} latitude to set.
 @param {number} longitude to set
 @param {number=} altitude (optional, null by default) to set
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/switchTo.mustache

@@ -6,4 +6,4 @@ I.switchTo(); // switch back to main page
 ```
 
 @param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/switchToNextTab.mustache

@@ -7,4 +7,4 @@ I.switchToNextTab(2);
 
 @param {number} [num] (optional) number of tabs to switch forward, default: 1.
 @param {number | null} [sec] (optional) time in seconds to wait.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/switchToPreviousTab.mustache

@@ -7,4 +7,4 @@ I.switchToPreviousTab(2);
 
 @param {number} [num] (optional) number of tabs to switch backward, default: 1.
 @param {number?} [sec] (optional) time in seconds to wait.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/type.mustache

@@ -18,4 +18,4 @@ I.type(secret('123456'));
 
 @param {string|string[]} key or array of keys to type.
 @param {?number} [delay=null] (optional) delay in ms between key presses
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/uncheckOption.mustache

@@ -10,4 +10,4 @@ I.uncheckOption('agree', '//form');
 ```
 @param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/wait.mustache

@@ -5,4 +5,4 @@ I.wait(2); // wait 2 secs
 ```
 
 @param {number} sec number of second to wait.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForClickable.mustache

@@ -8,4 +8,4 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForDetached.mustache

@@ -7,4 +7,4 @@ I.waitForDetached('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForElement.mustache

@@ -8,4 +8,4 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForEnabled.mustache

@@ -3,4 +3,4 @@ Element can be located by CSS or XPath.
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForFunction.mustache

@@ -14,4 +14,4 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 @param {string|function} fn to be executed in browser context.
 @param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
 @param {number} [sec] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForInvisible.mustache

@@ -7,4 +7,4 @@ I.waitForInvisible('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForText.mustache

@@ -10,4 +10,4 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 @param {string }text to wait for.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
 @param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForValue.mustache

@@ -7,4 +7,4 @@ I.waitForValue('//input', "GoodValue");
 @param {LocatorOrString} field input field.
 @param {string }value expected value.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitForVisible.mustache

@@ -7,4 +7,4 @@ I.waitForVisible('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitInUrl.mustache

@@ -6,4 +6,4 @@ I.waitInUrl('/info', 2);
 
 @param {string} urlPart value to check.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -7,4 +7,4 @@ I.waitNumberOfVisibleElements('a', 3);
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} num number of elements.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitToHide.mustache

@@ -7,4 +7,4 @@ I.waitToHide('#popup');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/waitUrlEquals.mustache

@@ -7,4 +7,4 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 @param {string} urlPart value to check.
 @param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/lib/ai.js

@@ -16,6 +16,8 @@ const htmlConfig = {
   html: {},
 };
 
+const aiInstance = null;
+
 class AiAssistant {
   constructor() {
     this.config = config.get('ai', defaultConfig);
@@ -26,7 +28,10 @@ class AiAssistant {
 
     this.isEnabled = !!process.env.OPENAI_API_KEY;
 
-    if (!this.isEnabled) return;
+    if (!this.isEnabled) {
+      debug('No OpenAI API key provided. AI assistant is disabled.');
+      return;
+    }
 
     const configuration = new Configuration({
       apiKey: process.env.OPENAI_API_KEY,
@@ -35,13 +40,17 @@ class AiAssistant {
     this.openai = new OpenAIApi(configuration);
   }
 
-  setHtmlContext(html) {
+  static getInstance() {
+    return aiInstance || new AiAssistant();
+  }
+
+  async setHtmlContext(html) {
     let processedHTML = html;
 
     if (this.htmlConfig.simplify) {
       processedHTML = removeNonInteractiveElements(processedHTML, this.htmlConfig);
     }
-    if (this.htmlConfig.minify) processedHTML = minifyHtml(processedHTML);
+    if (this.htmlConfig.minify) processedHTML = await minifyHtml(processedHTML);
     if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0];
 
     debug(processedHTML);

package/lib/cli.js

@@ -106,7 +106,9 @@ class Cli extends Base {
           }
           currentMetaStep = metaSteps;
           output.stepShift = 3 + 2 * shift;
-          output.step(step);
+          if (step.helper.constructor.name !== 'ExpectHelper') {
+            output.step(step);
+          }
         });
 
         event.dispatcher.on(event.step.finished, () => {

package/lib/codecept.js

@@ -89,6 +89,9 @@ class Codecept {
       global.When = stepDefinitions.When;
       global.Then = stepDefinitions.Then;
       global.DefineParameterType = stepDefinitions.defineParameterType;
+
+      // debug mode
+      global.debugMode = false;
     }
   }
 

package/lib/command/dryRun.js

@@ -20,7 +20,8 @@ module.exports = async function (test, options) {
   if (config.plugins) {
     // disable all plugins by default, they can be enabled with -p option
     for (const plugin in config.plugins) {
-      config.plugins[plugin].enabled = false;
+      // if `-p all` is passed, then enabling all plugins, otherwise plugins could be enabled by `-p customLocator,commentStep,tryTo`
+      config.plugins[plugin].enabled = options.plugins === 'all';
     }
   }
 

package/lib/command/info.js

@@ -37,3 +37,27 @@ module.exports = async function (path) {
   output.print('Please copy environment info when you report issues on GitHub: https://github.com/Codeception/CodeceptJS/issues');
   output.print('***************************************');
 };
+
+module.exports.getMachineInfo = async () => {
+  const info = {
+    nodeInfo: await envinfo.helpers.getNodeInfo(),
+    osInfo: await envinfo.helpers.getOSInfo(),
+    cpuInfo: await envinfo.helpers.getCPUInfo(),
+    chromeInfo: await envinfo.helpers.getChromeInfo(),
+    edgeInfo: await envinfo.helpers.getEdgeInfo(),
+    firefoxInfo: await envinfo.helpers.getFirefoxInfo(),
+    safariInfo: await envinfo.helpers.getSafariInfo(),
+  };
+
+  output.print('***************************************');
+  for (const [key, value] of Object.entries(info)) {
+    if (Array.isArray(value)) {
+      output.print(`${key}:  ${value[1]}`);
+    } else {
+      output.print(`${key}:  ${JSON.stringify(value, null, ' ')}`);
+    }
+  }
+  output.print('If you need more detailed info, just run this: npx codeceptjs info');
+  output.print('***************************************');
+  return info;
+};

package/lib/command/run-workers.js

@@ -40,8 +40,9 @@ module.exports = async function (workerCount, selectedRuns, options) {
 
   try {
     if (options.verbose) {
-      const getInfo = require('./info');
-      await getInfo();
+      global.debugMode = true;
+      const { getMachineInfo } = require('./info');
+      await getMachineInfo();
     }
     await workers.bootstrapAll();
     await workers.run();

package/lib/command/run.js

@@ -30,8 +30,9 @@ module.exports = async function (test, options) {
     codecept.loadTests(test);
 
     if (options.verbose) {
-      const getInfo = require('./info');
-      await getInfo();
+      global.debugMode = true;
+      const { getMachineInfo } = require('./info');
+      await getMachineInfo();
     }
 
     await codecept.run();

package/lib/data/context.js

@@ -23,6 +23,7 @@ module.exports = function (context) {
               .inject({ current: dataRow.data }));
           }
         });
+        maskSecretInTitle(scenarios);
         return new DataScenarioConfig(scenarios);
       },
       only: {
@@ -42,6 +43,7 @@ module.exports = function (context) {
                 .inject({ current: dataRow.data }));
             }
           });
+          maskSecretInTitle(scenarios);
           return new DataScenarioConfig(scenarios);
         },
       },
@@ -71,12 +73,6 @@ function replaceTitle(title, dataRow) {
   // it should be printed
   if (Object.prototype.toString.call(dataRow.data) === (Object()).toString()
     && dataRow.data.toString() !== (Object()).toString()) {
-    Object.entries(dataRow.data).forEach(entry => {
-      const [key, value] = entry;
-      if (value instanceof Secret) {
-        dataRow.data[key] = value.getMasked();
-      }
-    });
     return `${title} | ${dataRow.data}`;
   }
 
@@ -119,3 +115,15 @@ function detectDataType(dataTable) {
 
   throw new Error('Invalid data type. Data accepts either: DataTable || generator || Array || function');
 }
+
+function maskSecretInTitle(scenarios) {
+  scenarios.forEach(scenario => {
+    const res = [];
+
+    scenario.test.title.split(',').forEach(item => {
+      res.push(item.replace(/{"_secret":"(.*)"}/, '"*****"'));
+    });
+
+    scenario.test.title = res.join(',');
+  });
+}

package/lib/helper/ApiDataFactory.js

@@ -309,7 +309,8 @@ class ApiDataFactory extends Helper {
       } catch (e) {
         modulePath = path.join(global.codecept_dir, modulePath);
       }
-      const builder = require(modulePath);
+      // check if the new syntax `export default new Factory()` is used and loads the builder, otherwise loads the module that used old syntax `module.exports = new Factory()`.
+      const builder = require(modulePath).default || require(modulePath);
       return builder.build(data, options);
     } catch (err) {
       throw new Error(`Couldn't load factory file from ${modulePath}, check that

package/lib/helper/Appium.js

@@ -22,7 +22,7 @@ const vendorPrefix = {
 };
 
 /**
- *  Appium helper extends [Webriver](http://codecept.io/helpers/WebDriver/) helper.
+ *  Appium helper extends [Webdriver](http://codecept.io/helpers/WebDriver/) helper.
  *  It supports all browser methods and also includes special methods for mobile apps testing.
  *  You can use this helper to test Web on desktop and mobile devices and mobile apps.
  *
@@ -31,7 +31,7 @@ const vendorPrefix = {
  * Appium is an open source test automation framework for use with native, hybrid and mobile web apps that implements the WebDriver protocol.
  * It allows you to run Selenium tests on mobile devices and also test native, hybrid and mobile web apps.
  *
- * Download and install [Appium](http://appium.io/)
+ * Download and install [Appium](https://appium.io/docs/en/2.1/)
  *
  * ```sh
  * npm install -g appium
@@ -43,7 +43,7 @@ const vendorPrefix = {
  *
  * This helper should be configured in codecept.conf.ts or codecept.conf.js
  *
- * * `appiumV2`: set this to true if you want to run tests with Appiumv2. See more how to setup [here](https://codecept.io/mobile/#setting-up)
+ * * `appiumV2`: set this to true if you want to run tests with AppiumV2. See more how to setup [here](https://codecept.io/mobile/#setting-up)
  * * `app`: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackage
  * * `host`: (default: 'localhost') Appium host
  * * `port`: (default: '4723') Appium port
@@ -117,7 +117,7 @@ const vendorPrefix = {
  * }
  * ```
  *
- * Example Android App using Appiumv2 on BrowserStack:
+ * Example Android App using AppiumV2 on BrowserStack:
  *
  * ```js
  * {
@@ -154,7 +154,7 @@ const vendorPrefix = {
  * }
  * ```
  *
- * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md>
+ * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/packages/appium/docs/en/guides/caps.md>
  *
  * ## Access From Helpers
  *
@@ -273,6 +273,8 @@ class Appium extends Webdriver {
       if (!key.startsWith(vendorPrefix.appium)) {
         if (key !== 'platformName') {
           _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        } else {
+          _convertedCaps[`${key}`] = value;
         }
       } else {
         _convertedCaps[`${key}`] = value;