aboutsummaryrefslogtreecommitdiff
path: root/node_modules/selenium-webdriver/edge.js
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-11-03 01:33:53 +0100
committerFlorian Dold <florian.dold@gmail.com>2016-11-03 01:33:53 +0100
commitd1291f67551c58168af43698a359cb5ddfd266b0 (patch)
tree55a13ed29fe1915e3f42f1b1b7038dafa2e975a7 /node_modules/selenium-webdriver/edge.js
parentd0a0695fb5d34996850723f7d4b1b59c3df909c2 (diff)
downloadwallet-core-d1291f67551c58168af43698a359cb5ddfd266b0.tar.xz
node_modules
Diffstat (limited to 'node_modules/selenium-webdriver/edge.js')
-rw-r--r--node_modules/selenium-webdriver/edge.js305
1 files changed, 305 insertions, 0 deletions
diff --git a/node_modules/selenium-webdriver/edge.js b/node_modules/selenium-webdriver/edge.js
new file mode 100644
index 000000000..9685a2c21
--- /dev/null
+++ b/node_modules/selenium-webdriver/edge.js
@@ -0,0 +1,305 @@
+// 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
+ * Microsoft's Edge web browser. Before using this module,
+ * you must download and install the latest
+ * [MicrosoftEdgeDriver](http://go.microsoft.com/fwlink/?LinkId=619687) server.
+ * Ensure that the MicrosoftEdgeDriver is on your
+ * [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
+ *
+ * There are three primary classes exported by this module:
+ *
+ * 1. {@linkplain ServiceBuilder}: configures the
+ * {@link ./remote.DriverService remote.DriverService}
+ * that manages the [MicrosoftEdgeDriver] child process.
+ *
+ * 2. {@linkplain Options}: defines configuration options for each new
+ * MicrosoftEdgeDriver session, such as which
+ * {@linkplain Options#setProxy proxy} to use when starting the browser.
+ *
+ * 3. {@linkplain Driver}: the WebDriver client; each new instance will control
+ * a unique browser session.
+ *
+ * __Customizing the MicrosoftEdgeDriver Server__ <a id="custom-server"></a>
+ *
+ * By default, every MicrosoftEdge 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.
+ * 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:
+ *
+ * var edge = require('selenium-webdriver/edge');
+ *
+ * var service = new edge.ServiceBuilder()
+ * .setPort(55555)
+ * .build();
+ *
+ * var options = new edge.Options();
+ * // configure browser options ...
+ *
+ * var driver = new edge.Driver(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 MicrosoftEdge using the
+ * {@link ./builder.Builder selenium-webdriver.Builder}.
+ *
+ * [MicrosoftEdgeDriver]: https://msdn.microsoft.com/en-us/library/mt188085(v=vs.85).aspx
+ */
+
+'use strict';
+
+const fs = require('fs'),
+ util = require('util');
+
+const http = require('./http'),
+ io = require('./io'),
+ capabilities = require('./lib/capabilities'),
+ promise = require('./lib/promise'),
+ Symbols = require('./lib/symbols'),
+ webdriver = require('./lib/webdriver'),
+ portprober = require('./net/portprober'),
+ remote = require('./remote');
+
+const EDGEDRIVER_EXE = 'MicrosoftWebDriver.exe';
+
+
+/**
+ * Option keys.
+ * @enum {string}
+ */
+const CAPABILITY_KEY = {
+ PAGE_LOAD_STRATEGY: 'pageLoadStrategy'
+};
+
+
+/**
+ * Class for managing MicrosoftEdgeDriver specific options.
+ */
+class Options {
+ constructor() {
+ /** @private {!Object} */
+ this.options_ = {};
+
+ /** @private {?capabilities.ProxyConfig} */
+ this.proxy_ = null;
+ }
+
+ /**
+ * Extracts the MicrosoftEdgeDriver specific options from the given
+ * capabilities object.
+ * @param {!capabilities.Capabilities} caps The capabilities object.
+ * @return {!Options} The MicrosoftEdgeDriver options.
+ */
+ static fromCapabilities(caps) {
+ var options = new Options();
+ var map = options.options_;
+
+ Object.keys(CAPABILITY_KEY).forEach(function(key) {
+ key = CAPABILITY_KEY[key];
+ if (caps.has(key)) {
+ map[key] = caps.get(key);
+ }
+ });
+
+ if (caps.has(capabilities.Capability.PROXY)) {
+ options.setProxy(caps.get(capabilities.Capability.PROXY));
+ }
+
+ return options;
+ }
+
+ /**
+ * Sets the proxy settings for the new session.
+ * @param {capabilities.ProxyConfig} proxy The proxy configuration to use.
+ * @return {!Options} A self reference.
+ */
+ setProxy(proxy) {
+ this.proxy_ = proxy;
+ return this;
+ }
+
+ /**
+ * Sets the page load strategy for Edge.
+ * Supported values are "normal", "eager", and "none";
+ *
+ * @param {string} pageLoadStrategy The page load strategy to use.
+ * @return {!Options} A self reference.
+ */
+ setPageLoadStrategy(pageLoadStrategy) {
+ this.options_[CAPABILITY_KEY.PAGE_LOAD_STRATEGY] =
+ pageLoadStrategy.toLowerCase();
+ return this;
+ }
+
+ /**
+ * Converts this options instance to a {@link capabilities.Capabilities}
+ * object.
+ * @param {capabilities.Capabilities=} opt_capabilities The capabilities to
+ * merge these options into, if any.
+ * @return {!capabilities.Capabilities} The capabilities.
+ */
+ toCapabilities(opt_capabilities) {
+ var caps = opt_capabilities || capabilities.Capabilities.edge();
+ if (this.proxy_) {
+ caps.set(capabilities.Capability.PROXY, this.proxy_);
+ }
+ Object.keys(this.options_).forEach(function(key) {
+ caps.set(key, this.options_[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 {{pageLoadStrategy: (string|undefined)}}
+ * The JSON wire protocol representation of this instance.
+ */
+ [Symbols.serialize]() {
+ var json = {};
+ for (var key in this.options_) {
+ if (this.options_[key] != null) {
+ json[key] = this.options_[key];
+ }
+ }
+ return json;
+ }
+}
+
+
+/**
+ * Creates {@link remote.DriverService} instances that manage a
+ * MicrosoftEdgeDriver 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 MicrosoftEdgeDriver on the current
+ * PATH.
+ * @throws {Error} If provided executable does not exist, or the
+ * MicrosoftEdgeDriver cannot be found on the PATH.
+ */
+ constructor(opt_exe) {
+ let exe = opt_exe || io.findInPath(EDGEDRIVER_EXE, true);
+ if (!exe) {
+ throw Error(
+ 'The ' + EDGEDRIVER_EXE + ' could not be found on the current PATH. ' +
+ 'Please download the latest version of the MicrosoftEdgeDriver from ' +
+ 'https://www.microsoft.com/en-us/download/details.aspx?id=48212 and ' +
+ 'ensure it can be found on your PATH.');
+ }
+
+ super(exe);
+
+ // Binding to the loopback address will fail if not running with
+ // administrator privileges. Since we cannot test for that in script
+ // (or can we?), force the DriverService to use "localhost".
+ this.setHostname('localhost');
+ }
+}
+
+
+/** @type {remote.DriverService} */
+var defaultService = null;
+
+
+/**
+ * Sets the default service to use for new MicrosoftEdgeDriver 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 EdgeDriver service is still running. ' +
+ 'You must shut it down before you may adjust its configuration.');
+ }
+ defaultService = service;
+}
+
+
+/**
+ * Returns the default MicrosoftEdgeDriver service. If such a service has
+ * not been configured, one will be constructed using the default configuration
+ * for an MicrosoftEdgeDriver executable found on the system PATH.
+ * @return {!remote.DriverService} The default MicrosoftEdgeDriver service.
+ */
+function getDefaultService() {
+ if (!defaultService) {
+ defaultService = new ServiceBuilder().build();
+ }
+ return defaultService;
+}
+
+
+/**
+ * Creates a new WebDriver client for Microsoft's Edge.
+ */
+class Driver extends webdriver.WebDriver {
+ /**
+ * @param {(capabilities.Capabilities|Options)=} opt_config The configuration
+ * options.
+ * @param {remote.DriverService=} opt_service The session to use; will use
+ * the {@linkplain #getDefaultService default service} by default.
+ * @param {promise.ControlFlow=} opt_flow The control flow to use, or
+ * {@code null} to use the currently active flow.
+ */
+ constructor(opt_config, opt_service, opt_flow) {
+ var service = opt_service || getDefaultService();
+ var client = service.start().then(url => new http.HttpClient(url));
+ var executor = new http.Executor(client);
+
+ var caps =
+ opt_config instanceof Options ? opt_config.toCapabilities() :
+ (opt_config || capabilities.Capabilities.edge());
+
+ var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
+ super(driver.getSession(), executor, driver.controlFlow());
+
+ var boundQuit = this.quit.bind(this);
+
+ /** @override */
+ this.quit = function() {
+ return boundQuit().finally(service.kill.bind(service));
+ };
+ }
+
+ /**
+ * This function is a no-op as file detectors are not supported by this
+ * implementation.
+ * @override
+ */
+ setFileDetector() {}
+}
+
+
+// PUBLIC API
+
+
+exports.Driver = Driver;
+exports.Options = Options;
+exports.ServiceBuilder = ServiceBuilder;
+exports.getDefaultService = getDefaultService;
+exports.setDefaultService = setDefaultService;