123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829 |
- // Licensed to the Software Freedom Conservancy (SFC) under one
- // or more contributor license agreements. See the NOTICE file
- // distributed with this work for additional information
- // regarding copyright ownership. The SFC licenses this file
- // to you under the Apache License, Version 2.0 (the
- // "License"); you may not use this file except in compliance
- // with the License. You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing,
- // software distributed under the License is distributed on an
- // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- // KIND, either express or implied. See the License for the
- // specific language governing permissions and limitations
- // under the License.
- /**
- * @fileoverview Defines a {@linkplain Driver WebDriver} client for the Chrome
- * web browser. Before using this module, you must download the latest
- * [ChromeDriver release] and ensure it can be found on your system [PATH].
- *
- * There are three primary classes exported by this module:
- *
- * 1. {@linkplain ServiceBuilder}: configures the
- * {@link selenium-webdriver/remote.DriverService remote.DriverService}
- * that manages the [ChromeDriver] child process.
- *
- * 2. {@linkplain Options}: defines configuration options for each new Chrome
- * session, such as which {@linkplain Options#setProxy proxy} to use,
- * what {@linkplain Options#addExtensions extensions} to install, or
- * what {@linkplain Options#addArguments command-line switches} to use when
- * starting the browser.
- *
- * 3. {@linkplain Driver}: the WebDriver client; each new instance will control
- * a unique browser session with a clean user profile (unless otherwise
- * configured through the {@link Options} class).
- *
- * __Headless Chrome__ <a id="headless"></a>
- *
- * To start Chrome in headless mode, simply call
- * {@linkplain Options#headless Options.headless()}. Note, starting in headless
- * mode currently also disables GPU acceleration.
- *
- * let chrome = require('selenium-webdriver/chrome');
- * let {Builder} = require('selenium-webdriver');
- *
- * let driver = new Builder()
- * .forBrowser('chrome')
- * .setChromeOptions(new chrome.Options().headless())
- * .build();
- *
- * __Customizing the ChromeDriver Server__ <a id="custom-server"></a>
- *
- * By default, every Chrome session will use a single driver service, which is
- * started the first time a {@link Driver} instance is created and terminated
- * when this process exits. The default service will inherit its environment
- * from the current process and direct all output to /dev/null. You may obtain
- * a handle to this default service using
- * {@link #getDefaultService getDefaultService()} and change its configuration
- * with {@link #setDefaultService setDefaultService()}.
- *
- * You may also create a {@link Driver} with its own driver service. This is
- * useful if you need to capture the server's log output for a specific session:
- *
- * let chrome = require('selenium-webdriver/chrome');
- *
- * let service = new chrome.ServiceBuilder()
- * .loggingTo('/my/log/file.txt')
- * .enableVerboseLogging()
- * .build();
- *
- * let options = new chrome.Options();
- * // configure browser options ...
- *
- * let driver = chrome.Driver.createSession(options, service);
- *
- * Users should only instantiate the {@link Driver} class directly when they
- * need a custom driver service configuration (as shown above). For normal
- * operation, users should start Chrome using the
- * {@link selenium-webdriver.Builder}.
- *
- * __Working with Android__ <a id="android"></a>
- *
- * The [ChromeDriver][android] supports running tests on the Chrome browser as
- * well as [WebView apps][webview] starting in Android 4.4 (KitKat). In order to
- * work with Android, you must first start the adb
- *
- * adb start-server
- *
- * By default, adb will start on port 5037. You may change this port, but this
- * will require configuring a [custom server](#custom-server) that will connect
- * to adb on the {@linkplain ServiceBuilder#setAdbPort correct port}:
- *
- * let service = new chrome.ServiceBuilder()
- * .setAdbPort(1234)
- * build();
- * // etc.
- *
- * The ChromeDriver may be configured to launch Chrome on Android using
- * {@link Options#androidChrome()}:
- *
- * let driver = new Builder()
- * .forBrowser('chrome')
- * .setChromeOptions(new chrome.Options().androidChrome())
- * .build();
- *
- * Alternatively, you can configure the ChromeDriver to launch an app with a
- * Chrome-WebView by setting the {@linkplain Options#androidActivity
- * androidActivity} option:
- *
- * let driver = new Builder()
- * .forBrowser('chrome')
- * .setChromeOptions(new chrome.Options()
- * .androidPackage('com.example')
- * .androidActivity('com.example.Activity'))
- * .build();
- *
- * [Refer to the ChromeDriver site] for more information on using the
- * [ChromeDriver with Android][android].
- *
- * [ChromeDriver]: https://sites.google.com/a/chromium.org/chromedriver/
- * [ChromeDriver release]: http://chromedriver.storage.googleapis.com/index.html
- * [PATH]: http://en.wikipedia.org/wiki/PATH_%28variable%29
- * [android]: https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android
- * [webview]: https://developer.chrome.com/multidevice/webview/overview
- */
- 'use strict';
- const fs = require('fs');
- const util = require('util');
- const http = require('./http');
- const io = require('./io');
- const {Capabilities, Capability} = require('./lib/capabilities');
- const command = require('./lib/command');
- const logging = require('./lib/logging');
- const promise = require('./lib/promise');
- const Symbols = require('./lib/symbols');
- const webdriver = require('./lib/webdriver');
- const portprober = require('./net/portprober');
- const remote = require('./remote');
- /**
- * Name of the ChromeDriver executable.
- * @type {string}
- * @const
- */
- const CHROMEDRIVER_EXE =
- process.platform === 'win32' ? 'chromedriver.exe' : 'chromedriver';
- /**
- * Custom command names supported by ChromeDriver.
- * @enum {string}
- */
- const Command = {
- LAUNCH_APP: 'launchApp',
- GET_NETWORK_CONDITIONS: 'getNetworkConditions',
- SET_NETWORK_CONDITIONS: 'setNetworkConditions'
- };
- /**
- * Creates a command executor with support for ChromeDriver's custom commands.
- * @param {!Promise<string>} url The server's URL.
- * @return {!command.Executor} The new command executor.
- */
- function createExecutor(url) {
- let client = url.then(url => new http.HttpClient(url));
- let executor = new http.Executor(client);
- configureExecutor(executor);
- return executor;
- }
- /**
- * Configures the given executor with Chrome-specific commands.
- * @param {!http.Executor} executor the executor to configure.
- */
- function configureExecutor(executor) {
- executor.defineCommand(
- Command.LAUNCH_APP,
- 'POST',
- '/session/:sessionId/chromium/launch_app');
- executor.defineCommand(
- Command.GET_NETWORK_CONDITIONS,
- 'GET',
- '/session/:sessionId/chromium/network_conditions');
- executor.defineCommand(
- Command.SET_NETWORK_CONDITIONS,
- 'POST',
- '/session/:sessionId/chromium/network_conditions');
- }
- /**
- * Creates {@link selenium-webdriver/remote.DriverService} instances that manage
- * a [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/)
- * server in a child process.
- */
- class ServiceBuilder extends remote.DriverService.Builder {
- /**
- * @param {string=} opt_exe Path to the server executable to use. If omitted,
- * the builder will attempt to locate the chromedriver on the current
- * PATH.
- * @throws {Error} If provided executable does not exist, or the chromedriver
- * cannot be found on the PATH.
- */
- constructor(opt_exe) {
- let exe = opt_exe || io.findInPath(CHROMEDRIVER_EXE, true);
- if (!exe) {
- throw Error(
- 'The ChromeDriver could not be found on the current PATH. Please ' +
- 'download the latest version of the ChromeDriver from ' +
- 'http://chromedriver.storage.googleapis.com/index.html and ensure ' +
- 'it can be found on your PATH.');
- }
- super(exe);
- this.setLoopback(true); // Required
- }
- /**
- * Sets which port adb is listening to. _The ChromeDriver will connect to adb
- * if an {@linkplain Options#androidPackage Android session} is requested, but
- * adb **must** be started beforehand._
- *
- * @param {number} port Which port adb is running on.
- * @return {!ServiceBuilder} A self reference.
- */
- setAdbPort(port) {
- return this.addArguments('--adb-port=' + port);
- }
- /**
- * Sets the path of the log file the driver should log to. If a log file is
- * not specified, the driver will log to stderr.
- * @param {string} path Path of the log file to use.
- * @return {!ServiceBuilder} A self reference.
- */
- loggingTo(path) {
- return this.addArguments('--log-path=' + path);
- }
- /**
- * Enables verbose logging.
- * @return {!ServiceBuilder} A self reference.
- */
- enableVerboseLogging() {
- return this.addArguments('--verbose');
- }
- /**
- * Sets the number of threads the driver should use to manage HTTP requests.
- * By default, the driver will use 4 threads.
- * @param {number} n The number of threads to use.
- * @return {!ServiceBuilder} A self reference.
- */
- setNumHttpThreads(n) {
- return this.addArguments('--http-threads=' + n);
- }
- /**
- * @override
- */
- setPath(path) {
- super.setPath(path);
- return this.addArguments('--url-base=' + path);
- }
- }
- /** @type {remote.DriverService} */
- let defaultService = null;
- /**
- * Sets the default service to use for new ChromeDriver instances.
- * @param {!remote.DriverService} service The service to use.
- * @throws {Error} If the default service is currently running.
- */
- function setDefaultService(service) {
- if (defaultService && defaultService.isRunning()) {
- throw Error(
- 'The previously configured ChromeDriver service is still running. ' +
- 'You must shut it down before you may adjust its configuration.');
- }
- defaultService = service;
- }
- /**
- * Returns the default ChromeDriver service. If such a service has not been
- * configured, one will be constructed using the default configuration for
- * a ChromeDriver executable found on the system PATH.
- * @return {!remote.DriverService} The default ChromeDriver service.
- */
- function getDefaultService() {
- if (!defaultService) {
- defaultService = new ServiceBuilder().build();
- }
- return defaultService;
- }
- const OPTIONS_CAPABILITY_KEY = 'chromeOptions';
- /**
- * Class for managing ChromeDriver specific options.
- */
- class Options {
- constructor() {
- /** @private {!Object} */
- this.options_ = {};
- /** @private {!Array<(string|!Buffer)>} */
- this.extensions_ = [];
- /** @private {?logging.Preferences} */
- this.logPrefs_ = null;
- /** @private {?./lib/capabilities.ProxyConfig} */
- this.proxy_ = null;
- }
- /**
- * Extracts the ChromeDriver specific options from the given capabilities
- * object.
- * @param {!Capabilities} caps The capabilities object.
- * @return {!Options} The ChromeDriver options.
- */
- static fromCapabilities(caps) {
- let options = new Options();
- let o = caps.get(OPTIONS_CAPABILITY_KEY);
- if (o instanceof Options) {
- options = o;
- } else if (o) {
- options.
- addArguments(o.args || []).
- addExtensions(o.extensions || []).
- detachDriver(o.detach).
- excludeSwitches(o.excludeSwitches || []).
- setChromeBinaryPath(o.binary).
- setChromeLogFile(o.logPath).
- setChromeMinidumpPath(o.minidumpPath).
- setLocalState(o.localState).
- setMobileEmulation(o.mobileEmulation).
- setUserPreferences(o.prefs).
- setPerfLoggingPrefs(o.perfLoggingPrefs);
- }
- if (caps.has(Capability.PROXY)) {
- options.setProxy(caps.get(Capability.PROXY));
- }
- if (caps.has(Capability.LOGGING_PREFS)) {
- options.setLoggingPrefs(
- caps.get(Capability.LOGGING_PREFS));
- }
- return options;
- }
- /**
- * Add additional command line arguments to use when launching the Chrome
- * browser. Each argument may be specified with or without the "--" prefix
- * (e.g. "--foo" and "foo"). Arguments with an associated value should be
- * delimited by an "=": "foo=bar".
- *
- * @param {...(string|!Array<string>)} args The arguments to add.
- * @return {!Options} A self reference.
- */
- addArguments(...args) {
- let newArgs = (this.options_.args || []).concat(...args);
- if (newArgs.length) {
- this.options_.args = newArgs;
- }
- return this;
- }
- /**
- * Configures the chromedriver to start Chrome in headless mode.
- *
- * > __NOTE:__ Resizing the browser window in headless mode is only supported
- * > in Chrome 60. Users are encouraged to set an initial window size with
- * > the {@link #windowSize windowSize({width, height})} option.
- *
- * @return {!Options} A self reference.
- */
- headless() {
- // TODO(jleyba): Remove `disable-gpu` once head Chrome no longer requires
- // that to be set.
- return this.addArguments('headless', 'disable-gpu');
- }
- /**
- * Sets the initial window size.
- *
- * @param {{width: number, height: number}} size The desired window size.
- * @return {!Options} A self reference.
- * @throws {TypeError} if width or height is unspecified, not a number, or
- * less than or equal to 0.
- */
- windowSize({width, height}) {
- function checkArg(arg) {
- if (typeof arg !== 'number' || arg <= 0) {
- throw TypeError('Arguments must be {width, height} with numbers > 0');
- }
- }
- checkArg(width);
- checkArg(height);
- return this.addArguments(`window-size=${width},${height}`);
- }
- /**
- * List of Chrome command line switches to exclude that ChromeDriver by default
- * passes when starting Chrome. Do not prefix switches with "--".
- *
- * @param {...(string|!Array<string>)} args The switches to exclude.
- * @return {!Options} A self reference.
- */
- excludeSwitches(...args) {
- let switches = (this.options_.excludeSwitches || []).concat(...args);
- if (switches.length) {
- this.options_.excludeSwitches = switches;
- }
- return this;
- }
- /**
- * Add additional extensions to install when launching Chrome. Each extension
- * should be specified as the path to the packed CRX file, or a Buffer for an
- * extension.
- * @param {...(string|!Buffer|!Array<(string|!Buffer)>)} args The
- * extensions to add.
- * @return {!Options} A self reference.
- */
- addExtensions(...args) {
- this.extensions_ = this.extensions_.concat(...args);
- return this;
- }
- /**
- * Sets the path to the Chrome binary to use. On Mac OS X, this path should
- * reference the actual Chrome executable, not just the application binary
- * (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").
- *
- * The binary path be absolute or relative to the chromedriver server
- * executable, but it must exist on the machine that will launch Chrome.
- *
- * @param {string} path The path to the Chrome binary to use.
- * @return {!Options} A self reference.
- */
- setChromeBinaryPath(path) {
- this.options_.binary = path;
- return this;
- }
- /**
- * Sets whether to leave the started Chrome browser running if the controlling
- * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is
- * called.
- * @param {boolean} detach Whether to leave the browser running if the
- * chromedriver service is killed before the session.
- * @return {!Options} A self reference.
- */
- detachDriver(detach) {
- this.options_.detach = detach;
- return this;
- }
- /**
- * Sets the user preferences for Chrome's user profile. See the "Preferences"
- * file in Chrome's user data directory for examples.
- * @param {!Object} prefs Dictionary of user preferences to use.
- * @return {!Options} A self reference.
- */
- setUserPreferences(prefs) {
- this.options_.prefs = prefs;
- return this;
- }
- /**
- * Sets the logging preferences for the new session.
- * @param {!logging.Preferences} prefs The logging preferences.
- * @return {!Options} A self reference.
- */
- setLoggingPrefs(prefs) {
- this.logPrefs_ = prefs;
- return this;
- }
- /**
- * Sets the performance logging preferences. Options include:
- *
- * - `enableNetwork`: Whether or not to collect events from Network domain.
- * - `enablePage`: Whether or not to collect events from Page domain.
- * - `enableTimeline`: Whether or not to collect events from Timeline domain.
- * Note: when tracing is enabled, Timeline domain is implicitly disabled,
- * unless `enableTimeline` is explicitly set to true.
- * - `tracingCategories`: A comma-separated string of Chrome tracing
- * categories for which trace events should be collected. An unspecified
- * or empty string disables tracing.
- * - `bufferUsageReportingInterval`: The requested number of milliseconds
- * between DevTools trace buffer usage events. For example, if 1000, then
- * once per second, DevTools will report how full the trace buffer is. If
- * a report indicates the buffer usage is 100%, a warning will be issued.
- *
- * @param {{enableNetwork: boolean,
- * enablePage: boolean,
- * enableTimeline: boolean,
- * tracingCategories: string,
- * bufferUsageReportingInterval: number}} prefs The performance
- * logging preferences.
- * @return {!Options} A self reference.
- */
- setPerfLoggingPrefs(prefs) {
- this.options_.perfLoggingPrefs = prefs;
- return this;
- }
- /**
- * Sets preferences for the "Local State" file in Chrome's user data
- * directory.
- * @param {!Object} state Dictionary of local state preferences.
- * @return {!Options} A self reference.
- */
- setLocalState(state) {
- this.options_.localState = state;
- return this;
- }
- /**
- * Sets the name of the activity hosting a Chrome-based Android WebView. This
- * option must be set to connect to an [Android WebView](
- * https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android)
- *
- * @param {string} name The activity name.
- * @return {!Options} A self reference.
- */
- androidActivity(name) {
- this.options_.androidActivity = name;
- return this;
- }
- /**
- * Sets the device serial number to connect to via ADB. If not specified, the
- * ChromeDriver will select an unused device at random. An error will be
- * returned if all devices already have active sessions.
- *
- * @param {string} serial The device serial number to connect to.
- * @return {!Options} A self reference.
- */
- androidDeviceSerial(serial) {
- this.options_.androidDeviceSerial = serial;
- return this;
- }
- /**
- * Configures the ChromeDriver to launch Chrome on Android via adb. This
- * function is shorthand for
- * {@link #androidPackage options.androidPackage('com.android.chrome')}.
- * @return {!Options} A self reference.
- */
- androidChrome() {
- return this.androidPackage('com.android.chrome');
- }
- /**
- * Sets the package name of the Chrome or WebView app.
- *
- * @param {?string} pkg The package to connect to, or `null` to disable Android
- * and switch back to using desktop Chrome.
- * @return {!Options} A self reference.
- */
- androidPackage(pkg) {
- this.options_.androidPackage = pkg;
- return this;
- }
- /**
- * Sets the process name of the Activity hosting the WebView (as given by
- * `ps`). If not specified, the process name is assumed to be the same as
- * {@link #androidPackage}.
- *
- * @param {string} processName The main activity name.
- * @return {!Options} A self reference.
- */
- androidProcess(processName) {
- this.options_.androidProcess = processName;
- return this;
- }
- /**
- * Sets whether to connect to an already-running instead of the specified
- * {@linkplain #androidProcess app} instead of launching the app with a clean
- * data directory.
- *
- * @param {boolean} useRunning Whether to connect to a running instance.
- * @return {!Options} A self reference.
- */
- androidUseRunningApp(useRunning) {
- this.options_.androidUseRunningApp = useRunning;
- return this;
- }
- /**
- * Sets the path to Chrome's log file. This path should exist on the machine
- * that will launch Chrome.
- * @param {string} path Path to the log file to use.
- * @return {!Options} A self reference.
- */
- setChromeLogFile(path) {
- this.options_.logPath = path;
- return this;
- }
- /**
- * Sets the directory to store Chrome minidumps in. This option is only
- * supported when ChromeDriver is running on Linux.
- * @param {string} path The directory path.
- * @return {!Options} A self reference.
- */
- setChromeMinidumpPath(path) {
- this.options_.minidumpPath = path;
- return this;
- }
- /**
- * Configures Chrome to emulate a mobile device. For more information, refer
- * to the ChromeDriver project page on [mobile emulation][em]. Configuration
- * options include:
- *
- * - `deviceName`: The name of a pre-configured [emulated device][devem]
- * - `width`: screen width, in pixels
- * - `height`: screen height, in pixels
- * - `pixelRatio`: screen pixel ratio
- *
- * __Example 1: Using a Pre-configured Device__
- *
- * let options = new chrome.Options().setMobileEmulation(
- * {deviceName: 'Google Nexus 5'});
- *
- * let driver = chrome.Driver.createSession(options);
- *
- * __Example 2: Using Custom Screen Configuration__
- *
- * let options = new chrome.Options().setMobileEmulation({
- * width: 360,
- * height: 640,
- * pixelRatio: 3.0
- * });
- *
- * let driver = chrome.Driver.createSession(options);
- *
- *
- * [em]: https://sites.google.com/a/chromium.org/chromedriver/mobile-emulation
- * [devem]: https://developer.chrome.com/devtools/docs/device-mode
- *
- * @param {?({deviceName: string}|
- * {width: number, height: number, pixelRatio: number})} config The
- * mobile emulation configuration, or `null` to disable emulation.
- * @return {!Options} A self reference.
- */
- setMobileEmulation(config) {
- this.options_.mobileEmulation = config;
- return this;
- }
- /**
- * Sets the proxy settings for the new session.
- * @param {./lib/capabilities.ProxyConfig} proxy The proxy configuration to
- * use.
- * @return {!Options} A self reference.
- */
- setProxy(proxy) {
- this.proxy_ = proxy;
- return this;
- }
- /**
- * Converts this options instance to a {@link Capabilities} object.
- * @param {Capabilities=} opt_capabilities The capabilities to merge
- * these options into, if any.
- * @return {!Capabilities} The capabilities.
- */
- toCapabilities(opt_capabilities) {
- let caps = opt_capabilities || Capabilities.chrome();
- caps.
- set(Capability.PROXY, this.proxy_).
- set(Capability.LOGGING_PREFS, this.logPrefs_).
- set(OPTIONS_CAPABILITY_KEY, this);
- return caps;
- }
- /**
- * Converts this instance to its JSON wire protocol representation. Note this
- * function is an implementation not intended for general use.
- * @return {!Object} The JSON wire protocol representation of this instance.
- */
- [Symbols.serialize]() {
- let json = {};
- for (let key in this.options_) {
- if (this.options_[key] != null) {
- json[key] = this.options_[key];
- }
- }
- if (this.extensions_.length) {
- json.extensions = this.extensions_.map(function(extension) {
- if (Buffer.isBuffer(extension)) {
- return extension.toString('base64');
- }
- return io.read(/** @type {string} */(extension))
- .then(buffer => buffer.toString('base64'));
- });
- }
- return json;
- }
- }
- /**
- * Creates a new WebDriver client for Chrome.
- */
- class Driver extends webdriver.WebDriver {
- /**
- * Creates a new session with the ChromeDriver.
- *
- * @param {(Capabilities|Options)=} opt_config The configuration options.
- * @param {(remote.DriverService|http.Executor)=} opt_serviceExecutor Either
- * a DriverService to use for the remote end, or a preconfigured executor
- * for an externally managed endpoint. If neither is provided, the
- * {@linkplain ##getDefaultService default service} will be used by
- * default.
- * @param {promise.ControlFlow=} opt_flow The control flow to use, or `null`
- * to use the currently active flow.
- * @return {!Driver} A new driver instance.
- */
- static createSession(opt_config, opt_serviceExecutor, opt_flow) {
- let executor;
- if (opt_serviceExecutor instanceof http.Executor) {
- executor = opt_serviceExecutor;
- configureExecutor(executor);
- } else {
- let service = opt_serviceExecutor || getDefaultService();
- executor = createExecutor(service.start());
- }
- let caps =
- opt_config instanceof Options ? opt_config.toCapabilities() :
- (opt_config || Capabilities.chrome());
- return /** @type {!Driver} */(
- super.createSession(executor, caps, opt_flow));
- }
- /**
- * This function is a no-op as file detectors are not supported by this
- * implementation.
- * @override
- */
- setFileDetector() {}
- /**
- * Schedules a command to launch Chrome App with given ID.
- * @param {string} id ID of the App to launch.
- * @return {!promise.Thenable<void>} A promise that will be resolved
- * when app is launched.
- */
- launchApp(id) {
- return this.schedule(
- new command.Command(Command.LAUNCH_APP).setParameter('id', id),
- 'Driver.launchApp()');
- }
- /**
- * Schedules a command to get Chrome network emulation settings.
- * @return {!promise.Thenable<T>} A promise that will be resolved
- * when network emulation settings are retrievied.
- */
- getNetworkConditions() {
- return this.schedule(
- new command.Command(Command.GET_NETWORK_CONDITIONS),
- 'Driver.getNetworkConditions()');
- }
- /**
- * Schedules a command to set Chrome network emulation settings.
- *
- * __Sample Usage:__
- *
- * driver.setNetworkConditions({
- * offline: false,
- * latency: 5, // Additional latency (ms).
- * download_throughput: 500 * 1024, // Maximal aggregated download throughput.
- * upload_throughput: 500 * 1024 // Maximal aggregated upload throughput.
- * });
- *
- * @param {Object} spec Defines the network conditions to set
- * @return {!promise.Thenable<void>} A promise that will be resolved
- * when network emulation settings are set.
- */
- setNetworkConditions(spec) {
- if (!spec || typeof spec !== 'object') {
- throw TypeError('setNetworkConditions called with non-network-conditions parameter');
- }
- return this.schedule(
- new command.Command(Command.SET_NETWORK_CONDITIONS).setParameter('network_conditions', spec),
- 'Driver.setNetworkConditions(' + JSON.stringify(spec) + ')');
- }
- }
- // PUBLIC API
- exports.Driver = Driver;
- exports.Options = Options;
- exports.ServiceBuilder = ServiceBuilder;
- exports.getDefaultService = getDefaultService;
- exports.setDefaultService = setDefaultService;
|