[docs] Add info about Chrome-specific features #1513

AlexanderMoskovkin · 2017-06-02T11:43:15Z

/cc @lexkazakov @DevExpress/testcafe

testcafe-build-bot · 2017-06-02T11:48:14Z

❌ Tests for the commit 77107b7 have failed. See details.

alcazaco

lgtm

testcafe-build-bot · 2017-06-02T13:05:19Z

✅ Tests for the commit dca7232 have passed. See details.

AndreyBelym

lgtm

AndreyBelym · 2017-06-02T13:08:34Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+        * **cdpPort=\<int\>** - an open port used for the Chrome Debugging Protocol.
+* **cmdArgs** - command line [arguments](../command-line-interface.html#starting-browser-with-arguments) that are passed to the chrome.
+
+> The CDP requires an open port to work. TestCafe automatically selects an open port, but you can define a custom port.


IMHO 'free port' is more suitable here.

testcafe-build-bot · 2017-06-02T13:23:19Z

✅ Tests for the commit ca37961 have passed. See details.

inikulin · 2017-06-02T14:24:33Z

docs/articles/documentation/using-testcafe/command-line-interface.md

@@ -99,6 +100,25 @@ You can also use the [--qr-code](#--qr-code) option to display QR-codes that rep
 Scan the QR-codes by using the device on which you are going to test your application.
 As a result, the browsers will be connected to TestCafe and tests will start.

+### Using Chrome-specific Features


This should be referenced in "Local Browsers" section

inikulin · 2017-06-02T14:26:16Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+testcafe "chrome:headless" tests/sample-fixture.js
+```
+
+You can specify a custom port for CDP:


Why I need to do that? Can we point to the CDP docs or smthg for those who don't familiar with protocol?

It's not about CDP, it's about a network configuration on your machine, e.g. available ports numbers are whitelisted in your firewall.

This basically justifies my request: I have no idea what's it for.

We should write something like We use Chrome Debugging Protocol to enable this features. It's required an available port to work with it. You can set the port via ... If the custom port is not specified, then TestCafe automatically assigns a free port. And provide with some proof link

inikulin · 2017-06-02T14:26:47Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+testcafe "chrome:headless:cdpPort=9223" tests/sample-fixture.js
+```
+
+Note that headless mode is available for Mac and Linux in Chrome 59. You need a [Canary build](https://www.google.com/chrome/browser/canary.html) to enable headless mode on Windows. Specify a path to installation location, if you install a portable version of Chrome:


We have a special decoration styles for notes

Let's break this into 2 parts:

The headless mode is available for Mac and Linux in Chrome 59. You need a Canary build to enable headless mode on Windows.

Specify a path to installation location, if you install a portable version of Chrome:

inikulin · 2017-06-02T14:28:06Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+
+You can run test in Chrome's built-in [device emulator](https://developers.google.com/web/tools/chrome-devtools/device-mode/):
+
+```sh


For two separate examples we need two separate code blocks, otherwise it looks like I need to run both commands to make this functionality work.

inikulin · 2017-06-02T14:29:03Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+Options:
+
+* **pathToBrowser** - specifies a path to a portable browser. The path to browser is not required, if it is installed in a system.
+* **headless** - Chrome runs in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome).


enables "headless mode"

inikulin · 2017-06-02T14:30:27Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+* **emulation** - allows you to run tests in Chrome [device emulator](https://developers.google.com/web/tools/chrome-devtools/device-mode/).
+* **chrome arguments** - options separated by `;`.  The following arguments are available:
+    * **device parameters**:
+        * **device=\<string\>** - the emulated device;


Where can I find the list of available device names?

You can look for them in DevTools. Open DevTools -> ⠇->Settings -> Devices

It was a rhetoric question

device=<string> - the emulated device (see the full list of supported devices in DevTools -> ⠇->Settings -> Devices);

inikulin · 2017-06-02T14:31:06Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+        * **mobile=\<bool\>** - whether to emulate a mobile device;
+        * **orientation=\<vertical|horizontal\>** - the device orientation;
+        * **userAgent=\<string\>** - the user agent string;
+        * **touch=\<bool\>** - whether the touch support is enabled.


"enables touch support"

enables or disables touch support

inikulin · 2017-06-02T14:32:28Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+        * **cdpPort=\<int\>** - a free port used for the Chrome Debugging Protocol.
+* **cmdArgs** - command line [arguments](../command-line-interface.html#starting-browser-with-arguments) that are passed to the chrome.
+
+> The CDP requires a free port to work. TestCafe automatically selects a free port, but you can define a custom port.


"If the custom port is not specified, then TestCafe automatically assigns a free port."

inikulin · 2017-06-02T14:33:24Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+* **chrome arguments** - options separated by `;`.  The following arguments are available:
+    * **device parameters**:
+        * **device=\<string\>** - the emulated device;
+        * **width=\<number\>** - the device screen width in pixels;


Can we have a table (like we use in other API descriptions) with property type and defaults values, instead of this notation?

inikulin · 2017-06-02T14:34:18Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+        * **userAgent=\<string\>** - the user agent string;
+        * **touch=\<bool\>** - whether the touch support is enabled.
+    * **CDP arguments**:
+        * **cdpPort=\<int\>** - a free port used for the Chrome Debugging Protocol.


Why int here? Can I specify `-13371337" as a port number?

I'm sure it's obvious what ints we do mean :)

Nope, first of all it's inconsistent: we use "Number" everywhere (there is no such thing as "int" in JS). Also, we usually specify valid range for port number

cdpPort=<number> - a free port (0-65535) used for the Chrome Debugging Protocol.

testcafe-build-bot · 2017-06-05T15:20:46Z

❌ Tests for the commit cc563cc have failed. See details.

testcafe-build-bot · 2017-06-07T08:33:23Z

✅ Tests for the commit 107c5b6 have passed. See details.

testcafe-build-bot · 2017-06-07T08:42:07Z

✅ Tests for the commit 107c5b6 have passed. See details.

AlexanderMoskovkin · 2017-06-07T08:42:47Z

FPR
/cc @lexkazakov @DevExpress/testcafe

alcazaco

needs improvements

alcazaco · 2017-06-07T08:51:46Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

-`height` *(optional)*       | Number  | The device screen height in pixels. | No default value. If the device height is not set specify the emulated device name the `device` property.
-`scaleFactor` *(optional)*  | Number  | Device scale factor value. | `1`
-`mobile` *(optional)*       | Boolean | Whether to emulate a mobile device. | `true` if a mobile device is set via the device property. Otherwise `false`.
+`device` *(optional)*       | String  | The emulated device name (see the full list of supported devices in DevTools -> ⠇->Settings -> Devices). | No default value. If the device name is not set specify the custom device parameters.


Specify the custom device parameters, if the device name is not set.

alcazaco · 2017-06-07T08:52:44Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

-`scaleFactor` *(optional)*  | Number  | Device scale factor value. | `1`
-`mobile` *(optional)*       | Boolean | Whether to emulate a mobile device. | `true` if a mobile device is set via the device property. Otherwise `false`.
+`device` *(optional)*       | String  | The emulated device name (see the full list of supported devices in DevTools -> ⠇->Settings -> Devices). | No default value. If the device name is not set specify the custom device parameters.
+`width` *(optional)*        | Number  | The device screen width in pixels. | No default value. If the device width is not set specify the emulated device name via the `device` property.


Specify the emulated device name using the device property, if the device width is not set.

alcazaco · 2017-06-07T08:53:48Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

-`mobile` *(optional)*       | Boolean | Whether to emulate a mobile device. | `true` if a mobile device is set via the device property. Otherwise `false`.
+`device` *(optional)*       | String  | The emulated device name (see the full list of supported devices in DevTools -> ⠇->Settings -> Devices). | No default value. If the device name is not set specify the custom device parameters.
+`width` *(optional)*        | Number  | The device screen width in pixels. | No default value. If the device width is not set specify the emulated device name via the `device` property.
+`height` *(optional)*       | Number  | The device screen height in pixels. | No default value. If the device height is not set specify the emulated device name via the `device` property.


Specify the emulated device name using the device property, if the device height is not set.

alcazaco · 2017-06-07T08:54:52Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+`device` *(optional)*       | String  | The emulated device name (see the full list of supported devices in DevTools -> ⠇->Settings -> Devices). | No default value. If the device name is not set specify the custom device parameters.
+`width` *(optional)*        | Number  | The device screen width in pixels. | No default value. If the device width is not set specify the emulated device name via the `device` property.
+`height` *(optional)*       | Number  | The device screen height in pixels. | No default value. If the device height is not set specify the emulated device name via the `device` property.
+`scaleFactor` *(optional)*  | Number  | Device scale factor value. | Depends on chosen `device` or your system parameters.


Depends on a chosen device or your system parameters.

alcazaco · 2017-06-07T09:12:24Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+`width` *(optional)*        | Number  | The device screen width in pixels. | No default value. If the device width is not set specify the emulated device name via the `device` property.
+`height` *(optional)*       | Number  | The device screen height in pixels. | No default value. If the device height is not set specify the emulated device name via the `device` property.
+`scaleFactor` *(optional)*  | Number  | Device scale factor value. | Depends on chosen `device` or your system parameters.
+`mobile` *(optional)*       | Boolean | Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more. | `true` if a mobile device is set via the `device` property. Otherwise `false`.


Whether to emulate a mobile device. This includes the viewport meta tag, overlay scrollbars, text autosizing and more. | true if a mobile device is set via the device property. Otherwise false.

alcazaco · 2017-06-07T09:15:01Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

-`userAgent` *(optional)*    | String  | The user agent string | Default browser's user agent string
-`touch` *(optional)*        | Boolean | Enables or disables touch support | `true` if a touch-supported device is set via the device property. Otherwise `false`.
+`userAgent` *(optional)*    | String  | The user agent string | The user agent string of the selected `device` or the browser.
+`touch` *(optional)*        | Boolean | Enables or disables touch event emulation. | `true` if a touch-supported device is set via the `device` property or your system supports touch events. Otherwise `false`.


Enables or disables the touch event emulation. | true if a touch-supported device is set via the device property or your system supports touch events. Otherwise false.

testcafe-build-bot · 2017-06-07T10:30:26Z

✅ Tests for the commit 9c9aa5a have passed. See details.

AlexanderMoskovkin · 2017-06-07T10:34:41Z

FPR

AlexanderMoskovkin · 2017-06-07T11:22:31Z

/cc @lexkazakov @DevExpress/testcafe

alcazaco

lgtm

AlexanderMoskovkin · 2017-06-13T09:07:14Z

docs/articles/documentation/using-testcafe/common-concepts/browser-support.md

+```sh
+testcafe "chrome:path/to/chrome:headless" tests/sample-fixture.js
+```
+


In the headless mode the browser's viewport size is 1280x800 by default. You can change it via the (ResizeWindow)[../../test-api/actions/resize-window.html] command or via Device Emulation Mode parameters.

/cc @lexkazakov

In headless mode the browser's viewport size is 1280x800 by default. You can change it via the (ResizeWindow)[../../test-api/actions/resize-window.html] command or via Device Emulation Mode parameters.

testcafe-build-bot · 2017-06-13T10:17:53Z

✅ Tests for the commit c2a089a have passed. See details.

* [docs] Add info about Chrome-specific features * use node v7 * open port -> free port * Reworked * Update cdp arguments description * Fix tests * Small update * One more small update * Remarks * Add viewport size in headless mode info

[docs] Add info about Chrome-specific features

77107b7

alcazaco approved these changes Jun 2, 2017

View reviewed changes

use node v7

dca7232

AndreyBelym approved these changes Jun 2, 2017

View reviewed changes

open port -> free port

ca37961

miherlosev approved these changes Jun 2, 2017

View reviewed changes

inikulin suggested changes Jun 2, 2017

View reviewed changes

Reworked

cc563cc

AlexanderMoskovkin added 4 commits June 7, 2017 11:20

Update cdp arguments description

243370d

Fix tests

75619a9

Small update

7f465e2

One more small update

107c5b6

alcazaco suggested changes Jun 7, 2017

View reviewed changes

Remarks

9c9aa5a

alcazaco approved these changes Jun 7, 2017

View reviewed changes

AlexanderMoskovkin commented Jun 13, 2017

View reviewed changes

helen-dikareva approved these changes Jun 13, 2017

View reviewed changes

Add viewport size in headless mode info

c2a089a

AlexanderMoskovkin merged commit 5c81d34 into DevExpress:master Jun 13, 2017

AlexanderMoskovkin deleted the docs-chrome-features branch August 15, 2017 14:42


		You can run test in Chrome's built-in [device emulator](https://developers.google.com/web/tools/chrome-devtools/device-mode/):

		```sh

[docs] Add info about Chrome-specific features #1513

[docs] Add info about Chrome-specific features #1513

Conversation

AlexanderMoskovkin commented Jun 2, 2017

testcafe-build-bot commented Jun 2, 2017

alcazaco left a comment

Choose a reason for hiding this comment

testcafe-build-bot commented Jun 2, 2017

AndreyBelym left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

testcafe-build-bot commented Jun 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

testcafe-build-bot commented Jun 5, 2017

testcafe-build-bot commented Jun 7, 2017

testcafe-build-bot commented Jun 7, 2017

AlexanderMoskovkin commented Jun 7, 2017

alcazaco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

testcafe-build-bot commented Jun 7, 2017

AlexanderMoskovkin commented Jun 7, 2017

AlexanderMoskovkin commented Jun 7, 2017

alcazaco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

testcafe-build-bot commented Jun 13, 2017