webdriverio 4.10.1 → 4.10.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v4.10.2 (2018-02-02)
+* global changes:
+    * docs improvements
+* bugfixes:
+    * better unknown command detection (#2580)
+
 ## v4.10.1 (2018-01-12)
 * bugfixes:
     * fallback to old JSONWireProtocol commands when running Chromedriver

package/build/lib/cli.js

@@ -57,7 +57,7 @@ var SUPPORTED_FRAMEWORKS = ['mocha', // https://github.com/webdriverio/wdio-moch
 'cucumber' // https://github.com/webdriverio/wdio-cucumber-framework
 ];
 var SUPPORTED_REPORTER = [' dot - https://github.com/webdriverio/wdio-dot-reporter', ' spec - https://github.com/webdriverio/wdio-spec-reporter', ' junit - https://github.com/webdriverio/wdio-junit-reporter', ' allure - https://github.com/webdriverio/wdio-allure-reporter', ' teamcity - https://github.com/sullenor/wdio-teamcity-reporter', ' json - https://github.com/fijijavis/wdio-json-reporter', ' concise - https://github.com/FloValence/wdio-concise-reporter', ' testrail - https://github.com/oxynade/wdio-testrail-reporter', ' mochawesome - https://github.com/fijijavis/wdio-mochawesome-reporter'];
-var SUPPORTED_SERVICES = [' sauce - https://github.com/webdriverio/wdio-sauce-service', ' browserstack - https://github.com/itszero/wdio-browserstack-service', ' testingbot - https://github.com/testingbot/wdio-testingbot-service', ' appium - https://github.com/rhysd/wdio-appium-service', ' firefox-profile - https://github.com/webdriverio/wdio-firefox-profile-service', ' selenium-standalone - https://github.com/webdriverio/wdio-selenium-standalone-service', ' phantomjs - https://github.com/cognitom/wdio-phantomjs-service', ' static-server - https://github.com/LeadPages/wdio-static-server-service', ' visual-regression - https://github.com/zinserjan/wdio-visual-regression-service', ' webpack - https://github.com/leadpages/wdio-webpack-service', ' webpack-dev-server - https://gitlab.com/Vinnl/wdio-webpack-dev-server-service', ' chromedriver - https://github.com/atti187/wdio-chromedriver-service', ' iedriver - https://github.com/atti187/wdio-iedriver-service'];
+var SUPPORTED_SERVICES = [' sauce - https://github.com/webdriverio/wdio-sauce-service', ' browserstack - https://github.com/itszero/wdio-browserstack-service', ' testingbot - https://github.com/testingbot/wdio-testingbot-service', ' appium - https://github.com/rhysd/wdio-appium-service', ' firefox-profile - https://github.com/webdriverio/wdio-firefox-profile-service', ' selenium-standalone - https://github.com/webdriverio/wdio-selenium-standalone-service', ' phantomjs - https://github.com/cognitom/wdio-phantomjs-service', ' static-server - https://github.com/LeadPages/wdio-static-server-service', ' visual-regression - https://github.com/zinserjan/wdio-visual-regression-service', ' webpack - https://github.com/leadpages/wdio-webpack-service', ' webpack-dev-server - https://gitlab.com/Vinnl/wdio-webpack-dev-server-service', ' chromedriver - https://github.com/atti187/wdio-chromedriver-service', ' iedriver - https://github.com/atti187/wdio-iedriver-service', ' docker - https://github.com/stsvilik/wdio-docker-service'];
 
 var VERSION = _package2.default.version;
 var ALLOWED_ARGV = ['host', 'port', 'path', 'user', 'key', 'logLevel', 'coloredLogs', 'screenshotPath', 'baseUrl', 'waitforTimeout', 'framework', 'reporters', 'suite', 'spec', 'cucumberOpts', 'jasmineOpts', 'mochaOpts', 'connectionRetryTimeout', 'connectionRetryCount', 'watch'];

package/build/lib/commands/touchAction.js

@@ -67,12 +67,20 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
             'release'
         ])
 
+        // multi action using x y variables
+        // moveTo location is relative from the starting coordinate
+        browser.touchAction([
+            { action: 'press', x: 20, y: 550 },
+            { action: 'moveTo', x: 0, y: -500},
+            'release'
+        ])
+
         // drag&drop to element
         screen.touchAction([
             'press',
             { action: 'moveTo', selector: '//UIAApplication[1]/UIAElement[2]' },
             'release'
-        ]))
+        ])
     });
 
     :multiTouchAction.js
@@ -80,7 +88,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
         // drag&drop with two fingers 200px down
         browser.touchAction([
             [{action: 'press', x:  10, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release'],
-            [{action: 'press', x: 100, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release']]
+            [{action: 'press', x: 100, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release']
         ])
     })
  * </example>

package/build/lib/helpers/utilities.js

@@ -62,7 +62,7 @@ function isUnknownCommand(err) {
     /**
      * when running browser driver directly
      */
-    if (err.message.match(/Invalid Command Method/) || err.message.match(/did not match a known command/) || err.message.match(/unknown command/) || err.message.match(/Driver info: driver\.version: unknown/) || err.message.match(/did not map to a valid resource/)) {
+    if (err.message.match(/Invalid Command Method/) || err.message.match(/did not match a known command/) || err.message.match(/unknown command/) || err.message.match(/Driver info: driver\.version: unknown/) || err.message.match(/Method has not yet been implemented/) || err.message.match(/did not map to a valid resource/)) {
         return true;
     }
 

package/build/lib/helpers/wdio.conf.ejs

@@ -273,13 +273,13 @@ exports.config = {
     // beforeHook: function () {
     // },
     /**
-     * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
+     * Hook that gets executed _after_ a hook within the suite ends (e.g. runs after calling
      * afterEach in Mocha)
      */
     // afterHook: function () {
     // },
     /**
-     * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
+     * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) ends.
      * @param {Object} test test details
      */
     // afterTest: function (test) {

package/build/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webdriverio",
   "description": "A Node.js bindings implementation for the W3C WebDriver protocol",
-  "version": "4.10.1",
+  "version": "4.10.2",
   "homepage": "http://webdriver.io",
   "author": "Camilo Tapia <camilo.tapia@gmail.com>",
   "repository": {

package/docs/guide/getstarted/configuration.md

@@ -122,7 +122,7 @@ Type: `Boolean`<br>
 Default: *true*
 
 ### bail
-If you only want to run your tests until a specific amount of tests have failed use bail (default is 0 - don't bail, run all tests).
+If you only want to run your tests until a specific amount of tests have failed use bail (default is 0 - don't bail, run all tests). _Note_: Please be aware that when using a third party test runner such as Mocha, additional configuration might be required.
 
 Type: `Number`<br>
 Default: *0* (don't bail, run all tests)

package/docs/guide/reporters/allure.md

@@ -60,7 +60,7 @@ Apply and restart the Jenkins server. All assets should now be served correctly.
 Install the [Allure command-line tool](https://www.npmjs.com/package/allure-commandline), and process the results directory:
 
 ```sh
-$ allure generate [allure_output_dir] && allure report open
+$ allure generate [allure_output_dir] && allure open
 ```
 
 This will generate a report (by default in `./allure-report`), and open it in your browser:

package/docs/guide/reporters/dot.md

@@ -8,7 +8,7 @@ title: WebdriverIO - Dot Reporter
 Dot Reporter
 ============
 
-The dot reporter is the default reporter for the WDIO test runner. It's therefor a dependency of WebdriverIO and doesn't need to get downloaded. To use the dot reporter just add `'dot'` to the `reporters` array:
+The dot reporter is the default reporter for the WDIO test runner. It's therefore a dependency of WebdriverIO and doesn't need to get downloaded. To use the dot reporter just add `'dot'` to the `reporters` array:
 
 ```js
 // wdio.conf.js

package/docs/guide/services/docker.md

@@ -0,0 +1,145 @@
+name: docker
+category: services
+tags: guide
+index: 13
+title: WebdriverIO - Docker Service
+---
+
+Docker Service
+===========================
+
+This service allows user to seamlessly run test for/using a containerized application by utilizing a popular [Docker](https://www.docker.com/) service.
+Currently it supports two modes of operation:
+- using Docker to host Selenium (similar to Selenium Standalone Service)
+- using Docker to run your containerized application
+
+## Installation
+
+The easiest way is to keep `wdio-docker-service` as a devDependency in your `package.json`.
+
+```json
+{
+  "devDependencies": {
+    "wdio-docker-service": "~1.x"
+  }
+}
+```
+
+You can simply do it by:
+
+```bash
+npm install wdio-docker-service --save-dev
+```
+
+## Configuration
+
+By default, Google Chrome, Firefox and PhantomJS are available when installed on the host system. In order to use the service you need to add docker to your service array:
+
+```js
+// wdio.conf.js
+exports.config = {
+  // ...
+  services: ['docker'],
+  // ...
+  // Options are set here as well
+  dockerLogs: './logs',
+  dockerOptions: { 
+    image: 'selenium/standalone-chrome',
+    healthCheck: 'http://localhost:4444',
+    options: { 
+      p: ['4444:4444'],
+      shmSize: '2g'
+    }    
+  }
+  //...
+};
+```
+
+## Options
+
+### dockerOptions
+Various options required to run docker container
+
+Type: `Object`
+
+Default: `{ 
+    options: {
+        rm: true,
+        cidfile: [path to cidfile]
+    }
+}`
+
+Example:
+
+```javascript
+dockerOptions: {
+    image: 'selenium/standalone-chrome',
+    healthCheck: 'http://localhost:4444',
+    options: {
+        p: ['4444:4444'],
+        shmSize: '2g'
+    }
+}
+```
+
+### dockerOptions.image
+Docker container name tag. Could be local or from Docker HUB.
+
+Type: `String`
+
+Required: `true`
+
+### dockerOptions.healthCheck
+Url to an app exposed by your container. Normally this is a localhost url.
+If healthCheck is not provided, Webdriver will start running tests immediately after Docker container is executed, which
+maybe too early considering that it takes time for web service to start inside a Docker container.
+
+Type: `String`
+
+Example: `http://localhost:4444`
+
+### dockerOptions.options
+Map of options used by `docker run` command. For more details on `run` command click [here](https://docs.docker.com/edge/engine/reference/commandline/run/).
+
+Any single-letter option will be converted to `-[option]` (i.e. `d: true` -> `-d`). 
+
+Any option of two-character or more will
+be converted to `--[option]` (i.e. `rm: true` -> `--rm`). 
+
+For options that may be used more than once 
+(i.e. `-e`,`-add-host`, `--expose`, etc.), please use array notation (i.e. `e: ["NODE_ENV=development", "FOO=bar"]`).
+
+Type: `Object`
+
+Example:
+
+```javascript
+options: {
+    e: ['NODE_ENV=development', 'PROXY=http://myproxy:80']
+    p: ['4444:4444', '5900:5900'],
+    shmSize: '2g'
+}
+```
+
+### dockerOptions.args
+Any arguments you may want to pass into container. Corresponds to `[ARG...]` in Docker run CLI.
+
+Type: `String`
+
+### dockerOptions.command
+Any command you may want to pass into container. Corresponds to `[COMMAND]` in Docker run CLI.
+
+Type: `String`
+
+### onDockerReady
+A callback method which is called when Docker application is ready. Readiness is determined by ability to ping `healthCheck` url.
+
+Type: `Function`
+
+### dockerLogs
+Path to where logs from docker container should be stored
+
+Type: `String`
+
+## Testing Use Cases / Recipes
+Please visit our [Wiki](https://github.com/stsvilik/wdio-docker-service/wiki) for more details.

package/docs/guide/testrunner/configurationfile.md

@@ -279,7 +279,7 @@ exports.config = {
     beforeHook: function () {
     },
     /**
-     * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
+     * Hook that gets executed _after_ a hook within the suite ends (e.g. runs after calling
      * afterEach in Mocha)
      */
     afterHook: function () {
@@ -307,7 +307,7 @@ exports.config = {
     afterCommand: function (commandName, args, result, error) {
     },
     /**
-     * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) starts.
+     * Function to be executed after a test (in Mocha/Jasmine) or a step (in Cucumber) ends.
      * @param {Object} test test details
      */
     afterTest: function (test) {

package/docs/guide/testrunner/organizesuite.md

@@ -140,3 +140,5 @@ _**Note:** This will_ not _override the `--spec` flag for running a single spec.
 ## Stop testing after failure
 
 With the `bail` option you can specify when WebdriverIO should stop the test run after test failures. This can be helpful when you have a big test suite and want to avoid long test runs when you already know that your build will break. The option expects a number that specifies after how many spec failures it should stop the whole test run. The default is `0` meaning that it always runs all tests specs it can find.
+
+Please see http://webdriver.io/guide/getstarted/configuration.html#bail for additional information on the bail configuration.

package/docs/guide/testrunner/reporters.md

@@ -56,6 +56,7 @@ You can register event handler for several events which get triggered during the
 
 ```txt
 'start'
+'runner:start'
 'suite:start'
 'hook:start'
 'hook:end'
@@ -65,6 +66,7 @@ You can register event handler for several events which get triggered during the
 'test:fail'
 'test:pending'
 'suite:end'
+'runner:end'
 'end'
 ```
 

package/docs/guide.md

@@ -43,9 +43,10 @@ $ curl -L https://github.com/mozilla/geckodriver/releases/download/v0.16.0/gecko
 
 Note: Other geckodriver releases are available [here](https://github.com/mozilla/geckodriver/releases).
 
+** 4. Start selenium standalone server**
+
 Start the server by executing the following:
 
-** 4. Start selenium standalone server**
 ```sh
 $ java -jar -Dwebdriver.gecko.driver=./geckodriver selenium-server-standalone-3.5.3.jar
 ```

package/lib/commands/touchAction.js

@@ -49,12 +49,20 @@
             'release'
         ])
 
+        // multi action using x y variables
+        // moveTo location is relative from the starting coordinate
+        browser.touchAction([
+            { action: 'press', x: 20, y: 550 },
+            { action: 'moveTo', x: 0, y: -500},
+            'release'
+        ])
+
         // drag&drop to element
         screen.touchAction([
             'press',
             { action: 'moveTo', selector: '//UIAApplication[1]/UIAElement[2]' },
             'release'
-        ]))
+        ])
     });
 
     :multiTouchAction.js
@@ -62,7 +70,7 @@
         // drag&drop with two fingers 200px down
         browser.touchAction([
             [{action: 'press', x:  10, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release'],
-            [{action: 'press', x: 100, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release']]
+            [{action: 'press', x: 100, y: 10}, { action: 'moveTo', x: 0, y: 200 }, 'release']
         ])
     })
  * </example>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webdriverio",
   "description": "A Node.js bindings implementation for the W3C WebDriver protocol",
-  "version": "4.10.1",
+  "version": "4.10.2",
   "homepage": "http://webdriver.io",
   "author": "Camilo Tapia <camilo.tapia@gmail.com>",
   "repository": {