selenium-webdriver 3.6.0 → 4.0.0-alpha.1

package/opera.js

@@ -1,405 +0,0 @@
-// 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
- * Opera web browser (v26+). Before using this module, you must download the
- * latest OperaDriver
- * [release](https://github.com/operasoftware/operachromiumdriver/releases) and
- * ensure it can be found on your system
- * [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
- *
- * There are three primary classes exported by this module:
- *
- * 1. {@linkplain ServiceBuilder}: configures the
- *     {@link selenium-webdriver/remote.DriverService remote.DriverService}
- *     that manages the
- *     [OperaDriver](https://github.com/operasoftware/operachromiumdriver)
- *     child process.
- *
- * 2. {@linkplain Options}: defines configuration options for each new Opera
- *     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).
- *
- * By default, every Opera 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:
- *
- *     var opera = require('selenium-webdriver/opera');
- *
- *     var service = new opera.ServiceBuilder()
- *         .loggingTo('/my/log/file.txt')
- *         .enableVerboseLogging()
- *         .build();
- *
- *     var options = new opera.Options();
- *     // configure browser options ...
- *
- *     var driver = opera.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 Opera using the
- * {@link selenium-webdriver.Builder}.
- */
-
-'use strict';
-
-const fs = require('fs');
-
-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');
-
-
-/**
- * Name of the OperaDriver executable.
- * @type {string}
- * @const
- */
-const OPERADRIVER_EXE =
-    process.platform === 'win32' ? 'operadriver.exe' : 'operadriver';
-
-
-/**
- * Creates {@link remote.DriverService} instances that manages an
- * [OperaDriver](https://github.com/operasoftware/operachromiumdriver)
- * 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 operadriver on the current
-   *     PATH.
-   * @throws {Error} If provided executable does not exist, or the operadriver
-   *     cannot be found on the PATH.
-   */
-  constructor(opt_exe) {
-    let exe = opt_exe || io.findInPath(OPERADRIVER_EXE, true);
-    if (!exe) {
-      throw Error(
-          'The OperaDriver could not be found on the current PATH. Please ' +
-          'download the latest version of the OperaDriver from ' +
-          'https://github.com/operasoftware/operachromiumdriver/releases and ' +
-          'ensure it can be found on your PATH.');
-    }
-
-    super(exe);
-    this.setLoopback(true);
-  }
-
-  /**
-   * 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');
-  }
-
-  /**
-   * Silence sthe drivers output.
-   * @return {!ServiceBuilder} A self reference.
-   */
-  silent() {
-    return this.addArguments('--silent');
-  }
-}
-
-
-
-/** @type {remote.DriverService} */
-var defaultService = null;
-
-
-/**
- * Sets the default service to use for new OperaDriver 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 OperaDriver service is still running. ' +
-        'You must shut it down before you may adjust its configuration.');
-  }
-  defaultService = service;
-}
-
-
-/**
- * Returns the default OperaDriver service. If such a service has not been
- * configured, one will be constructed using the default configuration for
- * a OperaDriver executable found on the system PATH.
- * @return {!remote.DriverService} The default OperaDriver service.
- */
-function getDefaultService() {
-  if (!defaultService) {
-    defaultService = new ServiceBuilder().build();
-  }
-  return defaultService;
-}
-
-
-/**
- * @type {string}
- * @const
- */
-var OPTIONS_CAPABILITY_KEY = 'chromeOptions';
-
-
-/**
- * Class for managing {@linkplain Driver OperaDriver} specific options.
- */
-class Options {
-  constructor() {
-    /** @private {!Array.<string>} */
-    this.args_ = [];
-
-    /** @private {?string} */
-    this.binary_ = null;
-
-    /** @private {!Array.<(string|!Buffer)>} */
-    this.extensions_ = [];
-
-    /** @private {./lib/logging.Preferences} */
-    this.logPrefs_ = null;
-
-    /** @private {?capabilities.ProxyConfig} */
-    this.proxy_ = null;
-  }
-
-  /**
-   * Extracts the OperaDriver specific options from the given capabilities
-   * object.
-   * @param {!capabilities.Capabilities} caps The capabilities object.
-   * @return {!Options} The OperaDriver options.
-   */
-  static fromCapabilities(caps) {
-    var options;
-    var o = caps.get(OPTIONS_CAPABILITY_KEY);
-    if (o instanceof Options) {
-      options = o;
-    } else if (o) {
-      options = new Options()
-          .addArguments(o.args || [])
-          .addExtensions(o.extensions || [])
-          .setOperaBinaryPath(o.binary);
-    } else {
-      options = new Options;
-    }
-
-    if (caps.has(capabilities.Capability.PROXY)) {
-      options.setProxy(caps.get(capabilities.Capability.PROXY));
-    }
-
-    if (caps.has(capabilities.Capability.LOGGING_PREFS)) {
-      options.setLoggingPrefs(
-          caps.get(capabilities.Capability.LOGGING_PREFS));
-    }
-
-    return options;
-  }
-
-  /**
-   * Add additional command line arguments to use when launching the Opera
-   * 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>)} var_args The arguments to add.
-   * @return {!Options} A self reference.
-   */
-  addArguments(var_args) {
-    this.args_ = this.args_.concat.apply(this.args_, arguments);
-    return this;
-  }
-
-  /**
-   * Add additional extensions to install when launching Opera. 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)>)} var_args The
-   *     extensions to add.
-   * @return {!Options} A self reference.
-   */
-  addExtensions(var_args) {
-    this.extensions_ = this.extensions_.concat.apply(
-        this.extensions_, arguments);
-    return this;
-  }
-
-  /**
-   * Sets the path to the Opera binary to use. On Mac OS X, this path should
-   * reference the actual Opera executable, not just the application binary. The
-   * binary path be absolute or relative to the operadriver server executable, but
-   * it must exist on the machine that will launch Opera.
-   *
-   * @param {string} path The path to the Opera binary to use.
-   * @return {!Options} A self reference.
-   */
-  setOperaBinaryPath(path) {
-    this.binary_ = path;
-    return this;
-  }
-
-  /**
-   * Sets the logging preferences for the new session.
-   * @param {!./lib/logging.Preferences} prefs The logging preferences.
-   * @return {!Options} A self reference.
-   */
-  setLoggingPrefs(prefs) {
-    this.logPrefs_ = prefs;
-    return this;
-  }
-
-  /**
-   * 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;
-  }
-
-  /**
-   * 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.opera();
-    caps.
-        set(capabilities.Capability.PROXY, this.proxy_).
-        set(capabilities.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]() {
-    var json = {
-      args: this.args_,
-      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'));
-      })
-    };
-    if (this.binary_) {
-      json.binary = this.binary_;
-    }
-    return json;
-  }
-}
-
-
-/**
- * Creates a new WebDriver client for Opera.
- */
-class Driver extends webdriver.WebDriver {
-  /**
-   * Creates a new session for Opera.
-   *
-   * @param {(capabilities.Capabilities|Options)=} opt_config The configuration
-   *     options.
-   * @param {remote.DriverService=} opt_service The session to use; will use
-   *     the {@link getDefaultService default service} by default.
-   * @param {promise.ControlFlow=} opt_flow The control flow to use,
-   *     or {@code null} to use the currently active flow.
-   * @return {!Driver} A new driver instance.
-   */
-  static createSession(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.opera());
-
-    // On Linux, the OperaDriver does not look for Opera on the PATH, so we
-    // must explicitly find it. See: operachromiumdriver #9.
-    if (process.platform === 'linux') {
-      var options = Options.fromCapabilities(caps);
-      if (!options.binary_) {
-        let exe = io.findInPath('opera', true);
-        if (!exe) {
-          throw Error(
-              'The opera executable could not be found on the current PATH');
-        }
-        options.setOperaBinaryPath(exe);
-      }
-      caps = options.toCapabilities(caps);
-    }
-
-    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() {}
-}
-
-
-// PUBLIC API
-
-
-exports.Driver = Driver;
-exports.Options = Options;
-exports.ServiceBuilder = ServiceBuilder;
-exports.getDefaultService = getDefaultService;
-exports.setDefaultService = setDefaultService;

package/phantomjs.js

@@ -1,282 +0,0 @@
-// 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
- * PhantomJS web browser. By default, it is expected that the PhantomJS
- * executable can be located on your
- * [PATH](https://en.wikipedia.org/wiki/PATH_(variable))
- *
- *  __Using a Custom PhantomJS Binary__
- *
- * If you have PhantomJS.exe placed somewhere other than the root of your
- * working directory, you can build a custom Capability and attach the
- * executable's location to the Capability
- *
- * For example, if you're using the
- * [phantomjs-prebuilt](https://www.npmjs.com/package/phantomjs-prebuilt) module
- * from npm:
- *
- *     //setup custom phantomJS capability
- *     var phantomjs_exe = require('phantomjs-prebuilt').path;
- *     var customPhantom = selenium.Capabilities.phantomjs();
- *     customPhantom.set("phantomjs.binary.path", phantomjs_exe);
- *     //build custom phantomJS driver
- *     var driver = new selenium.Builder().
- *            withCapabilities(customPhantom).
- *            build();
- *
- */
-
-'use strict';
-
-const fs = require('fs');
-
-const 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');
-
-
-/**
- * Name of the PhantomJS executable.
- * @type {string}
- * @const
- */
-const PHANTOMJS_EXE =
-    process.platform === 'win32' ? 'phantomjs.exe' : 'phantomjs';
-
-
-/**
- * Capability that designates the location of the PhantomJS executable to use.
- * @type {string}
- * @const
- */
-const BINARY_PATH_CAPABILITY = 'phantomjs.binary.path';
-
-
-/**
- * Capability that designates the CLI arguments to pass to PhantomJS.
- * @type {string}
- * @const
- */
-const CLI_ARGS_CAPABILITY = 'phantomjs.cli.args';
-
-
-/**
- * Custom command names supported by PhantomJS.
- * @enum {string}
- */
-const Command = {
-  EXECUTE_PHANTOM_SCRIPT: 'executePhantomScript'
-};
-
-
-/**
- * Finds the PhantomJS executable.
- * @param {string=} opt_exe Path to the executable to use.
- * @return {string} The located executable.
- * @throws {Error} If the executable cannot be found on the PATH, or if the
- *     provided executable path does not exist.
- */
-function findExecutable(opt_exe) {
-  var exe = opt_exe || io.findInPath(PHANTOMJS_EXE, true);
-  if (!exe) {
-    throw Error(
-        'The PhantomJS executable could not be found on the current PATH. ' +
-        'Please download the latest version from ' +
-        'http://phantomjs.org/download.html and ensure it can be found on ' +
-        'your PATH. For more information, see ' +
-        'https://github.com/ariya/phantomjs/wiki');
-  }
-  if (!fs.existsSync(exe)) {
-    throw Error('File does not exist: ' + exe);
-  }
-  return exe;
-}
-
-
-/**
- * Maps WebDriver logging level name to those recognised by PhantomJS.
- * @const {!Map<string, string>}
- */
-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 {!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);
-
-  executor.defineCommand(
-      Command.EXECUTE_PHANTOM_SCRIPT,
-      'POST', '/session/:sessionId/phantom/execute');
-
-  return executor;
-}
-
-/**
- * Creates a new WebDriver client for PhantomJS.
- */
-class Driver extends webdriver.WebDriver {
-  /**
-   * Creates a new PhantomJS session.
-   *
-   * @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.
-   * @return {!Driver} A new driver reference.
-   */
-  static createSession(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[logging.Type.DRIVER]) {
-      let level = WEBDRIVER_TO_PHANTOMJS_LEVEL.get(
-          logPrefs[logging.Type.DRIVER]);
-      if (level) {
-        args.push('--webdriver-loglevel=' + level);
-      }
-    }
-
-    opt_logFile = process.env['SELENIUM_PHANTOMJS_LOG'] || opt_logFile;
-    if (typeof opt_logFile === 'string') {
-      args.push('--webdriver-logfile=' + opt_logFile);
-    }
-
-    var proxy = caps.get(capabilities.Capability.PROXY);
-    if (proxy) {
-      switch (proxy.proxyType) {
-        case 'manual':
-          if (proxy.httpProxy) {
-            args.push(
-                '--proxy-type=http',
-                '--proxy=' + proxy.httpProxy);
-            console.log(args);
-          }
-          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) || []);
-
-    var port = portprober.findFreePort();
-    var service = new remote.DriverService(exe, {
-      port: port,
-      args: Promise.resolve(port).then(function(port) {
-        args.push('--webdriver=' + port);
-        return args;
-      })
-    });
-
-    var executor = createExecutor(service.start());
-    return /** @type {!Driver} */(super.createSession(
-        executor, caps, opt_flow, () => service.kill()));
-  }
-
-  /**
-   * 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.Thenable<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
-
-exports.Driver = Driver;