codeceptjs 3.5.0 → 3.5.1-2.beta.7

package/lib/command/workers/runTests.js

@@ -132,9 +132,48 @@ function initializeListeners() {
       duration: test.duration || 0,
       err,
       parent,
+      steps: test.steps && test.steps.length > 0 ? simplifyStepsInTestObject(test.steps, err) : [],
     };
   }
 
+  function simplifyStepsInTestObject(steps, err) {
+    steps = [...steps];
+    const _steps = [];
+
+    for (step of steps) {
+      const _args = [];
+
+      if (step.args) {
+        for (const arg of step.args) {
+          // check if arg is a JOI object
+          if (arg && arg.$_root) {
+            _args.push(JSON.stringify(arg).slice(0, 300));
+          // check if arg is a function
+          } else if (arg && typeof arg === 'function') {
+            _args.push(arg.name);
+          } else {
+            _args.push(arg);
+          }
+        }
+      }
+
+      _steps.push({
+        actor: step.actor,
+        name: step.name,
+        status: step.status,
+        args: _args,
+        startedAt: step.startedAt,
+        startTime: step.startTime,
+        endTime: step.endTime,
+        finishedAt: step.finishedAt,
+        duration: step.duration,
+        err,
+      });
+    }
+
+    return _steps;
+  }
+
   function simplifyStep(step, err = null) {
     step = { ...step };
 

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/event.js

@@ -91,6 +91,8 @@ module.exports = {
   bddStep: {
     before: 'bddStep.before',
     after: 'bddStep.after',
+    started: 'bddStep.started',
+    finished: 'bddStep.finished',
   },
   /**
    * @type {object}
@@ -125,10 +127,12 @@ module.exports = {
    * @inner
    * @property {'workers.before'} before
    * @property {'workers.after'} after
+   * @property {'workers.result'} result
    */
   workers: {
     before: 'workers.before',
     after: 'workers.after',
+    result: 'workers.result',
   },
 
   /**

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,44 @@ const vendorPrefix = {
  * }
  * ```
  *
- * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md>
+ * Example Android App using AppiumV2 on BrowserStack:
+ *
+ * ```js
+ * {
+ * helpers: {
+ *   Appium: {
+ *         appiumV2: true,
+ *         host: "hub-cloud.browserstack.com",
+ *         port: 4444,
+ *         user: process.env.BROWSERSTACK_USER,
+ *         key: process.env.BROWSERSTACK_KEY,
+ *         app: `bs://c700ce60cf1gjhgjh3ae8ed9770ghjg5a55b8e022f13c5827cg`,
+ *         browser: '',
+ *         desiredCapabilities: {
+ *             'appPackage': data.packageName,
+ *             'deviceName': process.env.DEVICE || 'Google Pixel 3',
+ *             'platformName': process.env.PLATFORM || 'android',
+ *             'platformVersion': process.env.OS_VERSION || '10.0',
+ *             'automationName': process.env.ENGINE || 'UIAutomator2',
+ *             'newCommandTimeout': 300000,
+ *             'androidDeviceReadyTimeout': 300000,
+ *             'androidInstallTimeout': 90000,
+ *             'appWaitDuration': 300000,
+ *             'autoGrantPermissions': true,
+ *             'gpsEnabled': true,
+ *             'isHeadless': false,
+ *             'noReset': false,
+ *             'noSign': true,
+ *             'bstack:options' : {
+ *                 "appiumVersion" : "2.0.1",
+ *             },
+ *         }
+ *   }
+ * }
+ * }
+ * ```
+ *
+ * Additional configuration params can be used from <https://github.com/appium/appium/blob/master/packages/appium/docs/en/guides/caps.md>
  *
  * ## Access From Helpers
  *
@@ -146,6 +183,11 @@ class Appium extends Webdriver {
     this.axios = axios.create();
 
     webdriverio = require('webdriverio');
+    if (!config.appiumV2) {
+      console.log('The Appium core team does not maintain Appium 1.x anymore since the 1st of January 2022. Please migrating to Appium 2.x by adding appiumV2: true to your config.');
+      console.log('More info: https://bit.ly/appium-v2-migration');
+      console.log('This Appium 1.x support will be removed in next major release.');
+    }
   }
 
   _validateConfig(config) {
@@ -234,7 +276,11 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        if (key !== 'platformName' && key !== 'bstack:options') {
+          _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
+        } else {
+          _convertedCaps[`${key}`] = value;
+        }
       } else {
         _convertedCaps[`${key}`] = value;
       }
@@ -322,7 +368,7 @@ class Appium extends Webdriver {
       if (context.web) return this.switchToWeb(context.web);
       if (context.webview) return this.switchToWeb(context.webview);
     }
-    return this._switchToContext(context);
+    return this.switchToContext(context);
   }
 
   _withinEnd() {
@@ -377,8 +423,8 @@ class Appium extends Webdriver {
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
     recorder.session.start('iOS-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from iOS session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from iOS session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -419,8 +465,8 @@ class Appium extends Webdriver {
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
     recorder.session.start('Android-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from Android session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from Android session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -788,7 +834,7 @@ class Appium extends Webdriver {
    *
    * @param {*} context the context to switch to
    */
-  async _switchToContext(context) {
+  async switchToContext(context) {
     return this.browser.switchContext(context);
   }
 
@@ -812,11 +858,11 @@ class Appium extends Webdriver {
     this.isWeb = true;
     this.defaultContext = 'body';
 
-    if (context) return this._switchToContext(context);
+    if (context) return this.switchToContext(context);
     const contexts = await this.grabAllContexts();
     this.debugSection('Contexts', contexts.toString());
     for (const idx in contexts) {
-      if (contexts[idx].match(/^WEBVIEW/)) return this._switchToContext(contexts[idx]);
+      if (contexts[idx].match(/^WEBVIEW/)) return this.switchToContext(contexts[idx]);
     }
 
     throw new Error('No WEBVIEW could be guessed, please specify one in params');
@@ -839,8 +885,8 @@ class Appium extends Webdriver {
     this.isWeb = false;
     this.defaultContext = '//*';
 
-    if (context) return this._switchToContext(context);
-    return this._switchToContext('NATIVE_APP');
+    if (context) return this.switchToContext(context);
+    return this.switchToContext('NATIVE_APP');
   }
 
   /**
@@ -875,11 +921,12 @@ class Appium extends Webdriver {
    * I.setNetworkConnection(4) // airplane mode off, wifi off, data on
    * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
    * ```
-   * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
-   *
-   * @return {Promise<{}>}
+   * See corresponding [webdriverio reference](https://webdriver.io/docs/api/chromium/#setnetworkconnection).
    *
    * Appium: support only Android
+   *
+   * @param {number} value The network connection mode bitmask
+   * @return {Promise<number>}
    */
   async setNetworkConnection(value) {
     onlyForApps.call(this, supportedPlatform.android);
@@ -1377,10 +1424,10 @@ class Appium extends Webdriver {
    *
    * @return {Promise<void>}
    *
-   * Appium: support only iOS
+   * Appium: support both Android and iOS
    */
   async closeApp() {
-    onlyForApps.call(this, 'iOS');
+    onlyForApps.call(this);
     return this.browser.closeApp();
   }
 
@@ -1433,8 +1480,9 @@ class Appium extends Webdriver {
    *
    */
   async dontSeeInField(field, value) {
-    if (this.isWeb) return super.dontSeeInField(field, value);
-    return super.dontSeeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.dontSeeInField(field, _value);
+    return super.dontSeeInField(parseLocator.call(this, field), _value);
   }
 
   /**
@@ -1565,8 +1613,9 @@ class Appium extends Webdriver {
    *
    */
   async seeInField(field, value) {
-    if (this.isWeb) return super.seeInField(field, value);
-    return super.seeInField(parseLocator.call(this, field), value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    if (this.isWeb) return super.seeInField(field, _value);
+    return super.seeInField(parseLocator.call(this, field), _value);
   }
 
   /**