selenium-webdriver 3.3.0 → 4.0.0-alpha.1

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} */(webdriver.WebDriver.createSession(
-        executor, caps, opt_flow, this, () => 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;

package/test/firefox/extension_test.js

@@ -1,96 +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.
-
-'use strict';
-
-var AdmZip = require('adm-zip'),
-    assert = require('assert'),
-    crypto = require('crypto'),
-    fs = require('fs'),
-    path = require('path');
-
-var extension = require('../../firefox/extension'),
-    io = require('../../io'),
-    it = require('../../testing').it;
-
-
-var JETPACK_EXTENSION = path.join(__dirname,
-    '../../lib/test/data/firefox/jetpack-sample.xpi');
-var NORMAL_EXTENSION = path.join(__dirname,
-    '../../lib/test/data/firefox/sample.xpi');
-
-var JETPACK_EXTENSION_ID = 'jid1-EaXX7k0wwiZR7w@jetpack';
-var NORMAL_EXTENSION_ID = 'sample@seleniumhq.org';
-
-
-describe('extension', function() {
-  it('can install a jetpack xpi file', function() {
-    return io.tmpDir().then(function(dir) {
-      return extension.install(JETPACK_EXTENSION, dir).then(function(id) {
-        assert.equal(JETPACK_EXTENSION_ID, id);
-        var file = path.join(dir, id + '.xpi');
-        assert.ok(fs.existsSync(file), 'no such file: ' + file);
-        assert.ok(!fs.statSync(file).isDirectory());
-
-        var copiedSha1 = crypto.createHash('sha1')
-            .update(fs.readFileSync(file))
-            .digest('hex');
-
-        var goldenSha1 = crypto.createHash('sha1')
-            .update(fs.readFileSync(JETPACK_EXTENSION))
-            .digest('hex');
-
-        assert.equal(copiedSha1, goldenSha1);
-      });
-    });
-  });
-
-  it('can install a normal xpi file', function() {
-    return io.tmpDir().then(function(dir) {
-      return extension.install(NORMAL_EXTENSION, dir).then(function(id) {
-        assert.equal(NORMAL_EXTENSION_ID, id);
-
-        var file = path.join(dir, NORMAL_EXTENSION_ID);
-        assert.ok(fs.statSync(file).isDirectory());
-
-        assert.ok(fs.existsSync(path.join(file, 'chrome.manifest')));
-        assert.ok(fs.existsSync(path.join(file, 'content/overlay.xul')));
-        assert.ok(fs.existsSync(path.join(file, 'content/overlay.js')));
-        assert.ok(fs.existsSync(path.join(file, 'install.rdf')));
-      });
-    });
-  });
-
-  it('can install an extension from a directory', function() {
-    return io.tmpDir().then(function(srcDir) {
-      var buf = fs.readFileSync(NORMAL_EXTENSION);
-      new AdmZip(buf).extractAllTo(srcDir, true);
-      return io.tmpDir().then(function(dstDir) {
-        return extension.install(srcDir, dstDir).then(function(id) {
-          assert.equal(NORMAL_EXTENSION_ID, id);
-
-          var dir = path.join(dstDir, NORMAL_EXTENSION_ID);
-
-          assert.ok(fs.existsSync(path.join(dir, 'chrome.manifest')));
-          assert.ok(fs.existsSync(path.join(dir, 'content/overlay.xul')));
-          assert.ok(fs.existsSync(path.join(dir, 'content/overlay.js')));
-          assert.ok(fs.existsSync(path.join(dir, 'install.rdf')));
-        });
-      });
-    });
-  });
-});

package/test/firefox/firefox_test.js

@@ -1,226 +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.
-
-'use strict';
-
-var path = require('path');
-
-var firefox = require('../../firefox'),
-    io = require('../../io'),
-    test = require('../../lib/test'),
-    assert = require('../../testing/assert'),
-    Context = require('../../firefox').Context,
-    error = require('../..').error;
-
-var {consume} = require('../../lib/promise');
-
-
-var JETPACK_EXTENSION = path.join(__dirname,
-    '../../lib/test/data/firefox/jetpack-sample.xpi');
-var NORMAL_EXTENSION = path.join(__dirname,
-    '../../lib/test/data/firefox/sample.xpi');
-
-
-test.suite(function(env) {
-  describe('firefox', function() {
-    describe('Options', function() {
-      var driver;
-
-      test.beforeEach(function() {
-        driver = null;
-      });
-
-      test.afterEach(function() {
-        if (driver) {
-          return driver.quit();
-        }
-      });
-
-      /**
-       * Runs a test that requires Firefox Developer Edition. The test will be
-       * skipped if dev cannot be found on the current system.
-       */
-      function runWithFirefoxDev(options, testFn) {
-        return firefox.Channel.AURORA.locate().then(exe => {
-          options.setBinary(exe);
-          driver = env.builder()
-              .setFirefoxOptions(options)
-              .build();
-          return driver.call(testFn);
-        }, err => {
-          console.warn(
-              'Skipping test: could not find Firefox Dev Edition: ' + err);
-        });
-      }
-
-      describe('can start Firefox with custom preferences', function() {
-        function runTest(opt_dir) {
-          return consume(function*() {
-            let profile = new firefox.Profile(opt_dir);
-            profile.setPreference('general.useragent.override', 'foo;bar');
-
-            let options = new firefox.Options().setProfile(profile);
-
-            driver = env.builder().
-                setFirefoxOptions(options).
-                build();
-
-            yield driver.get('data:text/html,<html><div>content</div></html>');
-
-            var userAgent = yield driver.executeScript(
-                'return window.navigator.userAgent');
-            assert(userAgent).equalTo('foo;bar');
-          });
-        }
-
-        test.it('profile created from scratch', function() {
-          return runTest();
-        });
-
-        test.it('profile created from template', function() {
-          return io.tmpDir().then(runTest);
-        });
-      });
-
-      test.it('can start Firefox with a jetpack extension', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(JETPACK_EXTENSION);
-
-        let options = new firefox.Options().setProfile(profile);
-
-        return runWithFirefoxDev(options, function*() {
-          yield loadJetpackPage(driver,
-              'data:text/html;charset=UTF-8,<html><div>content</div></html>');
-
-          let text =
-              yield driver.findElement({id: 'jetpack-sample-banner'}).getText();
-          assert(text).equalTo('Hello, world!');
-        });
-      });
-
-      test.it('can start Firefox with a normal extension', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(NORMAL_EXTENSION);
-
-        let options = new firefox.Options().setProfile(profile);
-
-        return runWithFirefoxDev(options, function*() {
-          yield driver.get('data:text/html,<html><div>content</div></html>');
-
-          let footer =
-              yield driver.findElement({id: 'sample-extension-footer'});
-          let text = yield footer.getText();
-          assert(text).equalTo('Goodbye');
-        });
-      });
-
-      test.it('can start Firefox with multiple extensions', function() {
-        let profile = new firefox.Profile();
-        profile.addExtension(JETPACK_EXTENSION);
-        profile.addExtension(NORMAL_EXTENSION);
-
-        let options = new firefox.Options().setProfile(profile);
-
-        return runWithFirefoxDev(options, function*() {
-          yield loadJetpackPage(driver,
-              'data:text/html;charset=UTF-8,<html><div>content</div></html>');
-
-          let banner =
-              yield driver.findElement({id: 'jetpack-sample-banner'}).getText();
-          assert(banner).equalTo('Hello, world!');
-
-          let footer =
-              yield driver.findElement({id: 'sample-extension-footer'})
-                  .getText();
-          assert(footer).equalTo('Goodbye');
-        });
-      });
-
-      function loadJetpackPage(driver, url) {
-        // On linux the jetpack extension does not always run the first time
-        // we load a page. If this happens, just reload the page (a simple
-        // refresh doesn't appear to work).
-        return driver.wait(function() {
-          driver.get(url);
-          return driver.findElements({id: 'jetpack-sample-banner'})
-              .then(found => found.length > 0);
-        }, 3000);
-      }
-    });
-
-    describe('binary management', function() {
-      var driver1, driver2;
-
-      test.ignore(env.isRemote).
-      it('can start multiple sessions with single binary instance', function*() {
-        var options = new firefox.Options().setBinary(new firefox.Binary);
-        env.builder().setFirefoxOptions(options);
-        driver1 = yield env.builder().build();
-        driver2 = yield env.builder().build();
-        // Ok if this doesn't fail.
-      });
-
-      test.afterEach(function*() {
-        if (driver1) {
-          yield driver1.quit();
-        }
-
-        if (driver2) {
-          yield driver2.quit();
-        }
-      });
-    });
-
-    describe('context switching', function() {
-      var driver;
-
-      test.beforeEach(function*() {
-        driver = yield env.builder().build();
-      });
-
-      test.afterEach(function() {
-        if (driver) {
-          return driver.quit();
-        }
-      });
-
-      test.ignore(() => !env.isMarionette).
-      it('can get context', function() {
-        return assert(driver.getContext()).equalTo(Context.CONTENT);
-      });
-
-      test.ignore(() => !env.isMarionette).
-      it('can set context', function*() {
-        yield driver.setContext(Context.CHROME);
-        let ctxt = yield driver.getContext();
-        assert(ctxt).equalTo(Context.CHROME);
-
-        yield driver.setContext(Context.CONTENT);
-        ctxt = yield driver.getContext();
-        assert(ctxt).equalTo(Context.CONTENT);
-      });
-
-      test.ignore(() => !env.isMarionette).
-      it('throws on unknown context', function() {
-        return driver.setContext("foo").then(assert.fail, function(e) {
-          assert(e).instanceOf(error.InvalidArgumentError);
-        });
-      });
-    });
-
-  });
-}, {browsers: ['firefox']});