selenium-webdriver 2.48.2 → 2.53.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "selenium-webdriver",
-  "version": "2.48.2",
+  "version": "2.53.3",
   "description": "The official WebDriver JavaScript bindings from the Selenium project",
   "license": "Apache-2.0",
   "keywords": [
@@ -20,13 +20,13 @@
     "url": "https://github.com/SeleniumHQ/selenium.git"
   },
   "engines": {
-    "node": ">= 0.12.x"
+    "node": ">= 4.2.x"
   },
   "dependencies": {
     "adm-zip": "0.4.4",
     "rimraf": "^2.2.8",
     "tmp": "0.0.24",
-    "ws": "^0.8.0",
+    "ws": "^1.0.1",
     "xml2js": "0.4.4"
   },
   "devDependencies": {
@@ -34,9 +34,10 @@
     "mocha": ">= 1.21.x",
     "multer": "^0.1.7",
     "promises-aplus-tests": "^2.1.0",
-    "serve-index": "^1.6.1"
+    "serve-index": "^1.6.1",
+    "sinon": "^1.17.2"
   },
   "scripts": {
-    "test": "node_modules/.bin/mocha --harmony -t 600000 --recursive test"
+    "test": "mocha --harmony -t 600000 --recursive test"
   }
 }

package/phantomjs.js

@@ -17,13 +17,16 @@
 
 'use strict';
 
-var fs = require('fs'),
-    util = require('util');
+const fs = require('fs');
 
-var webdriver = require('./index'),
-    executors = require('./executors'),
+const executors = require('./executors'),
     http = require('./http'),
     io = require('./io'),
+    capabilities = require('./lib/capabilities'),
+    command = require('./lib/command'),
+    logging = require('./lib/logging'),
+    promise = require('./lib/promise'),
+    webdriver = require('./lib/webdriver'),
     portprober = require('./net/portprober'),
     remote = require('./remote');
 
@@ -33,7 +36,7 @@ var webdriver = require('./index'),
  * @type {string}
  * @const
  */
-var PHANTOMJS_EXE =
+const PHANTOMJS_EXE =
     process.platform === 'win32' ? 'phantomjs.exe' : 'phantomjs';
 
 
@@ -42,7 +45,7 @@ var PHANTOMJS_EXE =
  * @type {string}
  * @const
  */
-var BINARY_PATH_CAPABILITY = 'phantomjs.binary.path';
+const BINARY_PATH_CAPABILITY = 'phantomjs.binary.path';
 
 
 /**
@@ -50,22 +53,14 @@ var BINARY_PATH_CAPABILITY = 'phantomjs.binary.path';
  * @type {string}
  * @const
  */
-var CLI_ARGS_CAPABILITY = 'phantomjs.cli.args';
-
-
-/**
- * Default log file to use if one is not specified through CLI args.
- * @type {string}
- * @const
- */
-var DEFAULT_LOG_FILE = 'phantomjsdriver.log';
+const CLI_ARGS_CAPABILITY = 'phantomjs.cli.args';
 
 
 /**
  * Custom command names supported by PhantomJS.
  * @enum {string}
  */
-var Command = {
+const Command = {
   EXECUTE_PHANTOM_SCRIPT: 'executePhantomScript'
 };
 
@@ -96,24 +91,20 @@ function findExecutable(opt_exe) {
 
 /**
  * Maps WebDriver logging level name to those recognised by PhantomJS.
- * @type {!Object.<string, string>}
- * @const
+ * @const {!Map<string, string>}
  */
-var WEBDRIVER_TO_PHANTOMJS_LEVEL = (function() {
-  var map = {};
-  map[webdriver.logging.Level.ALL.name] = 'DEBUG';
-  map[webdriver.logging.Level.DEBUG.name] = 'DEBUG';
-  map[webdriver.logging.Level.INFO.name] = 'INFO';
-  map[webdriver.logging.Level.WARNING.name] = 'WARN';
-  map[webdriver.logging.Level.SEVERE.name] = 'ERROR';
-  return map;
-})();
+const WEBDRIVER_TO_PHANTOMJS_LEVEL = new Map([
+    [logging.Level.ALL.name, 'DEBUG'],
+    [logging.Level.DEBUG.name, 'DEBUG'],
+    [logging.Level.INFO.name, 'INFO'],
+    [logging.Level.WARNING.name, 'WARN'],
+    [logging.Level.SEVERE.name, 'ERROR']]);
 
 
 /**
  * Creates a command executor with support for PhantomJS' custom commands.
- * @param {!webdriver.promise.Promise<string>} url The server's URL.
- * @return {!webdriver.CommandExecutor} The new command executor.
+ * @param {!promise.Promise<string>} url The server's URL.
+ * @return {!command.Executor} The new command executor.
  */
 function createExecutor(url) {
   return new executors.DeferredExecutor(url.then(function(url) {
@@ -130,134 +121,140 @@ function createExecutor(url) {
 
 /**
  * Creates a new WebDriver client for PhantomJS.
- *
- * @param {webdriver.Capabilities=} opt_capabilities The desired capabilities.
- * @param {webdriver.promise.ControlFlow=} opt_flow The control flow to use, or
- *     {@code null} to use the currently active flow.
- * @constructor
- * @extends {webdriver.WebDriver}
  */
-var Driver = function(opt_capabilities, opt_flow) {
-  var capabilities = opt_capabilities || webdriver.Capabilities.phantomjs();
-  var exe = findExecutable(capabilities.get(BINARY_PATH_CAPABILITY));
-  var args = ['--webdriver-logfile=' + DEFAULT_LOG_FILE];
-
-  var logPrefs = capabilities.get(webdriver.Capability.LOGGING_PREFS);
-  if (logPrefs instanceof webdriver.logging.Preferences) {
-    logPrefs = logPrefs.toJSON();
-  }
+class Driver extends webdriver.WebDriver {
+  /**
+   * @param {capabilities.Capabilities=} opt_capabilities The desired
+   *     capabilities.
+   * @param {promise.ControlFlow=} opt_flow The control flow to use,
+   *     or {@code null} to use the currently active flow.
+   * @param {string=} opt_logFile Path to the log file for the phantomjs
+   *     executable's output. For convenience, this may be set at runtime with
+   *     the `SELENIUM_PHANTOMJS_LOG` environment variable.
+   */
+  constructor(opt_capabilities, opt_flow, opt_logFile) {
+    // TODO: add an Options class for consistency with the other driver types.
+
+    var caps = opt_capabilities || capabilities.Capabilities.phantomjs();
+    var exe = findExecutable(caps.get(BINARY_PATH_CAPABILITY));
+    var args = [];
+
+    var logPrefs = caps.get(capabilities.Capability.LOGGING_PREFS);
+    if (logPrefs instanceof logging.Preferences) {
+      logPrefs = logPrefs.toJSON();
+    }
 
-  if (logPrefs && logPrefs[webdriver.logging.Type.DRIVER]) {
-    var level = WEBDRIVER_TO_PHANTOMJS_LEVEL[
-        logPrefs[webdriver.logging.Type.DRIVER]];
-    if (level) {
-      args.push('--webdriver-loglevel=' + level);
+    if (logPrefs && logPrefs[logging.Type.DRIVER]) {
+      let level = WEBDRIVER_TO_PHANTOMJS_LEVEL.get(
+          logPrefs[logging.Type.DRIVER]);
+      if (level) {
+        args.push('--webdriver-loglevel=' + level);
+      }
     }
-  }
 
-  var proxy = capabilities.get(webdriver.Capability.PROXY);
-  if (proxy) {
-    switch (proxy.proxyType) {
-      case 'manual':
-        if (proxy.httpProxy) {
-          args.push(
-              '--proxy-type=http',
-              '--proxy=http://' + proxy.httpProxy);
-        }
-        break;
-      case 'pac':
-        throw Error('PhantomJS does not support Proxy PAC files');
-      case 'system':
-        args.push('--proxy-type=system');
-        break;
-      case 'direct':
-        args.push('--proxy-type=none');
-        break;
+    opt_logFile = process.env['SELENIUM_PHANTOMJS_LOG'] || opt_logFile;
+    if (typeof opt_logFile === 'string') {
+      args.push('--webdriver-logfile=' + opt_logFile);
     }
-  }
-  args = args.concat(capabilities.get(CLI_ARGS_CAPABILITY) || []);
-
-  var port = portprober.findFreePort();
-  var service = new remote.DriverService(exe, {
-    port: port,
-    args: webdriver.promise.when(port, function(port) {
-      args.push('--webdriver=' + port);
-      return args;
-    })
-  });
-
-  var executor = createExecutor(service.start());
-  var driver = webdriver.WebDriver.createSession(
-      executor, capabilities, opt_flow);
-
-  webdriver.WebDriver.call(
-      this, driver.getSession(), executor, driver.controlFlow());
-
-  var boundQuit = this.quit.bind(this);
-
-  /** @override */
-  this.quit = function() {
-    return boundQuit().thenFinally(service.kill.bind(service));
-  };
-};
-util.inherits(Driver, webdriver.WebDriver);
 
+    var proxy = caps.get(capabilities.Capability.PROXY);
+    if (proxy) {
+      switch (proxy.proxyType) {
+        case 'manual':
+          if (proxy.httpProxy) {
+            args.push(
+                '--proxy-type=http',
+                '--proxy=http://' + proxy.httpProxy);
+          }
+          break;
+        case 'pac':
+          throw Error('PhantomJS does not support Proxy PAC files');
+        case 'system':
+          args.push('--proxy-type=system');
+          break;
+        case 'direct':
+          args.push('--proxy-type=none');
+          break;
+      }
+    }
+    args = args.concat(caps.get(CLI_ARGS_CAPABILITY) || []);
 
-/**
- * This function is a no-op as file detectors are not supported by this
- * implementation.
- * @override
- */
-Driver.prototype.setFileDetector = function() {
-};
+    var port = portprober.findFreePort();
+    var service = new remote.DriverService(exe, {
+      port: port,
+      args: promise.when(port, function(port) {
+        args.push('--webdriver=' + port);
+        return args;
+      })
+    });
 
+    var executor = createExecutor(service.start());
+    var driver = webdriver.WebDriver.createSession(executor, caps, opt_flow);
 
-/**
- * Executes a PhantomJS fragment. This method is similar to
- * {@link #executeScript}, except it exposes the
- * <a href="http://phantomjs.org/api/">PhantomJS API</a> to the injected
- * script.
- *
- * <p>The injected script will execute in the context of PhantomJS's
- * {@code page} variable. If a page has not been loaded before calling this
- * method, one will be created.</p>
- *
- * <p>Be sure to wrap callback definitions in a try/catch block, as failures
- * may cause future WebDriver calls to fail.</p>
- *
- * <p>Certain callbacks are used by GhostDriver (the PhantomJS WebDriver
- * implementation) and overriding these may cause the script to fail. It is
- * recommended that you check for existing callbacks before defining your own.
- * </p>
- *
- * As with {@link #executeScript}, the injected script may be defined as
- * a string for an anonymous function body (e.g. "return 123;"), or as a
- * function. If a function is provided, it will be decompiled to its original
- * source. Note that injecting functions is provided as a convenience to
- * simplify defining complex scripts. Care must be taken that the function
- * only references variables that will be defined in the page's scope and
- * that the function does not override {@code Function.prototype.toString}
- * (overriding toString() will interfere with how the function is
- * decompiled.
- *
- * @param {(string|!Function)} script The script to execute.
- * @param {...*} var_args The arguments to pass to the script.
- * @return {!webdriver.promise.Promise<T>} A promise that resolve to the
- *     script's return value.
- * @template T
- */
-Driver.prototype.executePhantomJS = function(script, args) {
-  if (typeof script === 'function') {
-    script = 'return (' + script + ').apply(this, arguments);';
+    super(driver.getSession(), executor, driver.controlFlow());
+
+    var boundQuit = this.quit.bind(this);
+
+    /** @override */
+    this.quit = function() {
+      return boundQuit().thenFinally(service.kill.bind(service));
+    };
   }
-  var args = arguments.length > 1
-      ? Array.prototype.slice.call(arguments, 1) : [];
-  return this.schedule(
-      new webdriver.Command(Command.EXECUTE_PHANTOM_SCRIPT)
-          .setParameter('script', script)
-          .setParameter('args', args),
-      'Driver.executePhantomJS()');
-};
+
+  /**
+   * This function is a no-op as file detectors are not supported by this
+   * implementation.
+   * @override
+   */
+  setFileDetector() {}
+
+  /**
+   * Executes a PhantomJS fragment. This method is similar to
+   * {@link #executeScript}, except it exposes the
+   * <a href="http://phantomjs.org/api/">PhantomJS API</a> to the injected
+   * script.
+   *
+   * <p>The injected script will execute in the context of PhantomJS's
+   * {@code page} variable. If a page has not been loaded before calling this
+   * method, one will be created.</p>
+   *
+   * <p>Be sure to wrap callback definitions in a try/catch block, as failures
+   * may cause future WebDriver calls to fail.</p>
+   *
+   * <p>Certain callbacks are used by GhostDriver (the PhantomJS WebDriver
+   * implementation) and overriding these may cause the script to fail. It is
+   * recommended that you check for existing callbacks before defining your own.
+   * </p>
+   *
+   * As with {@link #executeScript}, the injected script may be defined as
+   * a string for an anonymous function body (e.g. "return 123;"), or as a
+   * function. If a function is provided, it will be decompiled to its original
+   * source. Note that injecting functions is provided as a convenience to
+   * simplify defining complex scripts. Care must be taken that the function
+   * only references variables that will be defined in the page's scope and
+   * that the function does not override {@code Function.prototype.toString}
+   * (overriding toString() will interfere with how the function is
+   * decompiled.
+   *
+   * @param {(string|!Function)} script The script to execute.
+   * @param {...*} var_args The arguments to pass to the script.
+   * @return {!promise.Promise<T>} A promise that resolve to the
+   *     script's return value.
+   * @template T
+   */
+  executePhantomJS(script, var_args) {
+    if (typeof script === 'function') {
+      script = 'return (' + script + ').apply(this, arguments);';
+    }
+    var args = arguments.length > 1
+        ? Array.prototype.slice.call(arguments, 1) : [];
+    return this.schedule(
+        new command.Command(Command.EXECUTE_PHANTOM_SCRIPT)
+            .setParameter('script', script)
+            .setParameter('args', args),
+        'Driver.executePhantomJS()');
+  }
+}
 
 
 // PUBLIC API

package/proxy.js

@@ -31,6 +31,8 @@
 
 var util = require('util');
 
+var ProxyConfig = require('./lib/capabilities').ProxyConfig;
+
 
 
 // PUBLIC API
@@ -38,7 +40,7 @@ var util = require('util');
 
 /**
  * Configures WebDriver to bypass all browser proxies.
- * @return {!webdriver.ProxyConfig} A new proxy configuration object.
+ * @return {!ProxyConfig} A new proxy configuration object.
  */
 exports.direct = function() {
   return {proxyType: 'direct'};
@@ -64,17 +66,19 @@ exports.direct = function() {
  *          https: (string|undefined),
  *          bypass: (string|!Array.<string>|undefined)}} options Proxy
  *     configuration options.
- * @return {!webdriver.ProxyConfig} A new proxy configuration object.
+ * @return {!ProxyConfig} A new proxy configuration object.
  */
 exports.manual = function(options) {
-  return {
+  // TODO(jleyba): Figure out why the Closure compiler does not think this is
+  // a ProxyConfig record without the cast.
+  return /** @type {!ProxyConfig} */({
     proxyType: 'manual',
     ftpProxy: options.ftp,
     httpProxy: options.http,
     sslProxy: options.https,
     noProxy: util.isArray(options.bypass) ?
         options.bypass.join(',') : options.bypass
-  };
+  });
 };
 
 
@@ -82,7 +86,7 @@ exports.manual = function(options) {
  * Configures WebDriver to configure the browser proxy using the PAC file at
  * the given URL.
  * @param {string} url URL for the PAC proxy to use.
- * @return {!webdriver.ProxyConfig} A new proxy configuration object.
+ * @return {!ProxyConfig} A new proxy configuration object.
  */
 exports.pac = function(url) {
   return {
@@ -94,7 +98,7 @@ exports.pac = function(url) {
 
 /**
  * Configures WebDriver to use the current system's proxy.
- * @return {!webdriver.ProxyConfig} A new proxy configuration object.
+ * @return {!ProxyConfig} A new proxy configuration object.
  */
 exports.system = function() {
   return {proxyType: 'system'};