codeceptjs 3.3.5-beta.6 → 3.3.6

package/lib/helper/WebDriver.js

@@ -44,11 +44,11 @@ let version;
  * @prop {string} browser browser in which to perform testing.
  * @prop {string} [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
  * @prop {string} [host=localhost] - WebDriver host to connect.
- * @prop {string} [port=4444] - WebDriver port to connect.
+ * @prop {number} [port=4444] - WebDriver port to connect.
  * @prop {string} [protocol=http] - protocol for WebDriver server.
  * @prop {string} [path=/wd/hub] - path to WebDriver server,
  * @prop {boolean} [restart=true] - restart browser between tests.
- * @prop {boolean} [smartWait=false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+ * @prop {boolean|number} [smartWait=false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
  * @prop {boolean} [disableScreenshots=false] - don't save screenshots on failure.
  * @prop {boolean} [fullPageScreenshots=false] (optional - 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.
@@ -916,7 +916,7 @@ class WebDriver extends Helper {
    * {{ react }}
    */
   async click(locator, context = null) {
-    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && !this.browser.isW3C ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findClickable.call(this, locator, locateFn);
@@ -1126,7 +1126,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async checkOption(field, context = null) {
-    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && !this.browser.isW3C ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -1145,7 +1145,7 @@ class WebDriver extends Helper {
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
-    const clickMethod = this.browser.isMobile && this.browser.capabilities.platformName !== 'android' ? 'touchClick' : 'elementClick';
+    const clickMethod = this.browser.isMobile && !this.browser.isW3C ? 'touchClick' : 'elementClick';
     const locateFn = prepareLocateFn.call(this, context);
 
     const res = await findCheckable.call(this, field, locateFn);
@@ -1632,7 +1632,7 @@ class WebDriver extends Helper {
       assertElementExists(res);
       const elem = usingFirstElement(res);
       const elementId = getElementId(elem);
-      if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') return this.browser.touchScroll(offsetX, offsetY, elementId);
+      if (this.browser.isMobile && !this.browser.isW3C) return this.browser.touchScroll(offsetX, offsetY, elementId);
       const location = await elem.getLocation();
       assertElementExists(location, 'Failed to receive', 'location');
       /* eslint-disable prefer-arrow-callback */
@@ -1640,7 +1640,7 @@ class WebDriver extends Helper {
       /* eslint-enable */
     }
 
-    if (this.browser.isMobile && this.browser.capabilities.platformName !== 'android') return this.browser.touchScroll(locator, offsetX, offsetY);
+    if (this.browser.isMobile && !this.browser.isW3C) return this.browser.touchScroll(locator, offsetX, offsetY);
 
     /* eslint-disable prefer-arrow-callback, comma-dangle */
     return this.browser.execute(function (x, y) { return window.scrollTo(x, y); }, offsetX, offsetY);

package/lib/plugin/wdio.js

@@ -85,6 +85,8 @@ let restartsSession;
  *
  */
 module.exports = (config) => {
+  // Keep initial configs to pass as options to wdio services
+  const wdioOptions = { ...config };
   const webDriver = container.helpers('WebDriver');
   if (webDriver) {
     config = Object.assign(webDriver.options, config);
@@ -108,7 +110,9 @@ module.exports = (config) => {
         if (version.indexOf('5') === 0) {
           launchers.push(new Launcher(config));
         } else {
-          const options = { logPath: global.output_dir, installArgs: seleniumInstallArgs, args: seleniumArgs };
+          const options = {
+            logPath: global.output_dir, installArgs: seleniumInstallArgs, args: seleniumArgs, ...wdioOptions,
+          };
           launchers.push(new Launcher(options, [config.capabilities], config));
         }
       }
@@ -215,7 +219,12 @@ module.exports = (config) => {
     if (launcher.onPrepare) {
       event.dispatcher.on(event.all.before, () => {
         recorder.add(`launcher ${name} start`, async () => {
-          await launcher.onPrepare(config, config.capabilities);
+          // browserstack-service expects capabilities as array
+          if (launcher.constructor.name === 'BrowserstackLauncherService') {
+            await launcher.onPrepare(config, [config.capabilities]);
+          } else {
+            await launcher.onPrepare(config, config.capabilities);
+          }
           output.debug(`Started ${name}`);
         });
       });

package/lib/utils.js

@@ -132,6 +132,9 @@ module.exports.clearString = function (str) {
   if (!str) return '';
   /* Replace forbidden symbols in string
    */
+  if (str.endsWith('.')) {
+    str = str.slice(0, -1);
+  }
   return str
     .replace(/ /g, '_')
     .replace(/"/g, "'")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.3.5-beta.6",
+  "version": "3.3.6",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -87,6 +87,7 @@
     "requireg": "^0.2.2",
     "resq": "^1.10.2",
     "sprintf-js": "^1.1.1",
+    "semver": "^6.3.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
@@ -127,7 +128,6 @@
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
     "runok": "^0.9.2",
-    "semver": "^6.3.0",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.7.0",
     "testcafe": "^1.18.3",

package/typings/index.d.ts

@@ -32,20 +32,20 @@ declare namespace CodeceptJS {
      * ```
      */
     tests: string;
-    /** 
-     * Where to store failure screenshots, artifacts, etc 
-     * 
+    /**
+     * Where to store failure screenshots, artifacts, etc
+     *
      * ```js
      * output: './output'
      * ```
      */
     output: string;
-    /** 
+    /**
      * Pattern to filter tests by name.
      * This option is useful if you plan to use multiple configs for different environments.
-     * 
+     *
      * To execute only tests with @firefox tag
-     * 
+     *
      * ```js
      * grep: '@firefox'
      * ```
@@ -64,11 +64,11 @@ declare namespace CodeceptJS {
      * ```
     */
     helpers?: {
-      /** 
-       * Run web tests controlling browsers via Playwright engine. 
+      /**
+       * Run web tests controlling browsers via Playwright engine.
+       *
+       * https://codecept.io/helpers/playwright
        *
-       * https://codecept.io/helpers/playwright 
-       * 
        * Available commands:
        * ```js
        * I.amOnPage('/');
@@ -77,11 +77,11 @@ declare namespace CodeceptJS {
        * ```
        */
       Playwright?: PlaywrightConfig;
-      /** 
-       * Run web tests controlling browsers via Puppeteer engine. 
-       * 
-       * https://codecept.io/helpers/puppeteer 
-       * 
+      /**
+       * Run web tests controlling browsers via Puppeteer engine.
+       *
+       * https://codecept.io/helpers/puppeteer
+       *
        * Available commands:
        * ```js
        * I.amOnPage('/');
@@ -91,24 +91,24 @@ declare namespace CodeceptJS {
        */
       Puppeteer?: PuppeteerConfig;
 
-      /** 
-       * Run web tests controlling browsers via WebDriver engine. 
-       * 
+      /**
+       * Run web tests controlling browsers via WebDriver engine.
+       *
        * Available commands:
        * ```js
        * I.amOnPage('/');
        * I.click('Open');
        * I.see('Welcome');
        * ```
-       * 
-       * https://codecept.io/helpers/webdriver 
+       *
+       * https://codecept.io/helpers/webdriver
        */
       WebDriver?: WebDriverConfig;
-      /** 
-       * Execute REST API requests for API testing or to assist web testing. 
-       * 
-       * https://codecept.io/helpers/REST 
-       * 
+      /**
+       * Execute REST API requests for API testing or to assist web testing.
+       *
+       * https://codecept.io/helpers/REST
+       *
        * Available commands:
        * ```js
        * I.sendGetRequest('/');
@@ -116,30 +116,30 @@ declare namespace CodeceptJS {
        */
       REST?: RESTConfig;
 
-      /** 
+      /**
        * Use JSON assertions for API testing.
        * Can be paired with REST or GraphQL helpers.
-       * 
-       * https://codecept.io/helpers/JSONResponse 
-       * 
+       *
+       * https://codecept.io/helpers/JSONResponse
+       *
        * Available commands:
        * ```js
        * I.seeResponseContainsJson({ user: { email: 'jon@doe.com' } });
        * ```
        */
-      JSONResponse?: any;      
+      JSONResponse?: any;
 
       [key: string]: any;
     },
-    /** 
-     * Enable CodeceptJS plugins. 
-     * 
+    /**
+     * Enable CodeceptJS plugins.
+     *
      * https://codecept.io/plugins/
-     * 
+     *
      * Plugins listen to test events and extend functionality of CodeceptJS.
-     * 
+     *
      * Example:
-     * 
+     *
      * ```js
      * plugins: {
      *   autoDelay: {
@@ -195,7 +195,7 @@ declare namespace CodeceptJS {
     mocha?: any;
     /**
      * [Execute code before](https://codecept.io/bootstrap/) tests are run.
-     * 
+     *
      * Can be either JS module file or async function:
      *
      * ```js
@@ -206,10 +206,10 @@ declare namespace CodeceptJS {
      * bootstrap: 'bootstrap.js',
      * ```
     */
-    bootstrap?: () => Promise<void> | boolean | string;
+    bootstrap?: (() => Promise<void>) | boolean | string;
     /**
-     * [Execute code after tests](https://codecept.io/bootstrap/) finished. 
-     * 
+     * [Execute code after tests](https://codecept.io/bootstrap/) finished.
+     *
      * Can be either JS module file or async function:
      *
      * ```js
@@ -220,16 +220,16 @@ declare namespace CodeceptJS {
      * teardown: 'teardown.js',
      * ```
     */
-    teardown?: () => Promise<void> | boolean | string;
+    teardown?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
-     * 
+     *
      */
-    bootstrapAll?: () => Promise<void> | boolean | string;
+    bootstrapAll?: (() => Promise<void>) | boolean | string;
     /**
      * [Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)
     */
-    teardownAll?: () => Promise<void> | boolean | string;
+    teardownAll?: (() => Promise<void>) | boolean | string;
     /** Enable [localized test commands](https://codecept.io/translation/) */
     translation?: string;
     /**
@@ -243,8 +243,8 @@ declare namespace CodeceptJS {
     require?: Array<string>;
 
     /**
-     * Enable [BDD features](https://codecept.io/bdd/#configuration). 
-     * 
+     * Enable [BDD features](https://codecept.io/bdd/#configuration).
+     *
      * Sample configuration:
      * ```js
      * gherkin: {