selenium-webdriver 3.1.0 → 3.6.0

package/example/headless.js

@@ -0,0 +1,55 @@
+// 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 An example of running Chrome or Firefox in headless mode.
+ *
+ * To run with Chrome, ensure you have Chrome 59+ installed and that
+ * chromedriver 2.30+ is present on your system PATH:
+ * <https://sites.google.com/a/chromium.org/chromedriver/downloads>
+ *
+ *     SELENIUM_BROWSER=chrome node selenium-webdriver/example/headless.js
+ *
+ * To run with Firefox, ensure you have Firefox 57+ installed and that
+ * geckodriver 0.19.0+ is present on your system PATH:
+ * <https://github.com/mozilla/geckodriver/releases>
+ *
+ *     SELENIUM_BROWSER=firefox node selenium-webdriver/example/headless.js
+ */
+
+const chrome = require('../chrome');
+const firefox = require('../firefox');
+const {Builder, By, Key, until} = require('..');
+
+const width = 640;
+const height = 480;
+
+let driver = new Builder()
+    .forBrowser('chrome')
+    .setChromeOptions(
+        new chrome.Options().headless().windowSize({width, height}))
+    .setFirefoxOptions(
+        new firefox.Options().headless().windowSize({width, height}))
+    .build();
+
+driver.get('http://www.google.com/ncr')
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
+    .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
+    .then(
+        _ => driver.quit(),
+        e => driver.quit().then(() => { throw e; }));

package/example/logging.js

@@ -21,7 +21,7 @@
 
 'use strict';
 
-const {Builder, By, logging, until} = require('..');
+const {Builder, By, Key, logging, until} = require('..');
 
 logging.installConsoleHandler();
 logging.getLogger('webdriver.http').setLevel(logging.Level.ALL);
@@ -29,7 +29,7 @@ logging.getLogger('webdriver.http').setLevel(logging.Level.ALL);
 var driver = new Builder().forBrowser('firefox').build();
 
 driver.get('http://www.google.com/ncr')
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
+    .then(_ =>
+        driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN))
     .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
     .then(_ => driver.quit());

package/example/parallel_flows.js

@@ -23,18 +23,16 @@
  * (see <https://github.com/SeleniumHQ/selenium/issues/2969>).
  */
 
-var webdriver = require('..'),
-    By = webdriver.By,
-    until = webdriver.until;
+const {Builder, By, Key, promise, until} = require('..');
 
 for (var i = 0; i < 3; i++) {
   (function(n) {
-    var flow = new webdriver.promise.ControlFlow()
+    var flow = new promise.ControlFlow()
         .on('uncaughtException', function(e) {
           console.log('uncaughtException in flow %d: %s', n, e);
         });
 
-    var driver = new webdriver.Builder().
+    var driver = new Builder().
         forBrowser('firefox').
         setControlFlow(flow).  // Comment out this line to see the difference.
         build();
@@ -44,8 +42,7 @@ for (var i = 0; i < 3; i++) {
     driver.manage().window().setPosition(300 * i, 400 * i);
 
     driver.get('http://www.google.com');
-    driver.findElement(By.name('q')).sendKeys('webdriver');
-    driver.findElement(By.name('btnG')).click();
+    driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
     driver.wait(until.titleIs('webdriver - Google Search'), 1000);
 
     driver.quit();

package/firefox/binary.js

@@ -203,6 +203,8 @@ function installNoFocusLibs(profileDir) {
  * `PATH`.
  *
  * @final
+ * @deprecated This class will be removed in 4.0. Use the binary management
+ *     functions available on the {@link ./index.Options firefox.Options} class.
  */
 class Binary {
   /**
@@ -242,6 +244,7 @@ class Binary {
    * Add arguments to the command line used to start Firefox.
    * @param {...(string|!Array.<string>)} var_args Either the arguments to add
    *     as varargs, or the arguments as an array.
+   * @deprecated Use {@link ./index.Options#addArguments}.
    */
   addArguments(var_args) {
     for (var i = 0; i < arguments.length; i++) {

package/firefox/extension.js

@@ -19,12 +19,12 @@
 
 'use strict';
 
-const AdmZip = require('adm-zip'),
-    fs = require('fs'),
+const fs = require('fs'),
     path = require('path'),
     xml = require('xml2js');
 
 const io = require('../io');
+const zip = require('../io/zip');
 
 
 /**
@@ -56,11 +56,7 @@ function install(extension, dir) {
       if (!details.unpack) {
         return io.copy(extension, dst + '.xpi').then(() => details.id);
       } else {
-        return Promise.resolve().then(function() {
-          // TODO: find an async library for inflating a zip archive.
-          new AdmZip(extension).extractAllTo(dst, true);
-          return details.id;
-        });
+        return zip.unzip(extension, dst).then(() => details.id);
       }
     } else {
       return io.copyDir(extension, dst).then(() => details.id);
@@ -79,105 +75,146 @@ var AddonDetails;
 var RdfRoot;
 
 
-
 /**
  * Extracts the details needed to install an add-on.
  * @param {string} addonPath Path to the extension directory.
  * @return {!Promise<!AddonDetails>} A promise for the add-on details.
  */
 function getDetails(addonPath) {
-  return readManifest(addonPath).then(function(doc) {
-    var em = getNamespaceId(doc, 'http://www.mozilla.org/2004/em-rdf#');
-    var rdf = getNamespaceId(
-        doc, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');
-
-    var description = doc[rdf + 'RDF'][rdf + 'Description'][0];
-    var details = {
-      id: getNodeText(description, em + 'id'),
-      name: getNodeText(description, em + 'name'),
-      version: getNodeText(description, em + 'version'),
-      unpack: getNodeText(description, em + 'unpack') || false
-    };
-
-    if (typeof details.unpack === 'string') {
-      details.unpack = details.unpack.toLowerCase() === 'true';
+  return io.stat(addonPath).then((stats) => {
+    if (stats.isDirectory()) {
+      return parseDirectory(addonPath);
+    } else if (addonPath.slice(-4) === '.xpi') {
+      return parseXpiFile(addonPath);
+    } else {
+      throw Error('Add-on path is not an xpi or a directory: ' + addonPath);
     }
+  });
 
-    if (!details.id) {
-      throw new AddonFormatError('Could not find add-on ID for ' + addonPath);
-    }
+  /**
+   * Parse an install.rdf for a Firefox add-on.
+   * @param {string} rdf The contents of install.rdf for the add-on.
+   * @return {!Promise<!AddonDetails>} A promise for the add-on details.
+   */
+  function parseInstallRdf(rdf) {
+    return parseXml(rdf).then(function(doc) {
+      var em = getNamespaceId(doc, 'http://www.mozilla.org/2004/em-rdf#');
+      var rdf = getNamespaceId(
+          doc, 'http://www.w3.org/1999/02/22-rdf-syntax-ns#');
+
+      var description = doc[rdf + 'RDF'][rdf + 'Description'][0];
+      var details = {
+        id: getNodeText(description, em + 'id'),
+        name: getNodeText(description, em + 'name'),
+        version: getNodeText(description, em + 'version'),
+        unpack: getNodeText(description, em + 'unpack') || false
+      };
+
+      if (typeof details.unpack === 'string') {
+        details.unpack = details.unpack.toLowerCase() === 'true';
+      }
 
-    return details;
-  });
+      if (!details.id) {
+        throw new AddonFormatError('Could not find add-on ID for ' + addonPath);
+      }
 
-  function getNodeText(node, name) {
-    return node[name] && node[name][0] || '';
-  }
+      return details;
+    });
 
-  function getNamespaceId(doc, url) {
-    var keys = Object.keys(doc);
-    if (keys.length !== 1) {
-      throw new AddonFormatError('Malformed manifest for add-on ' + addonPath);
+    function parseXml(text) {
+      return new Promise((resolve, reject) => {
+        xml.parseString(text, (err, data) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(data);
+          }
+        });
+      });
     }
 
-    var namespaces = /** @type {!RdfRoot} */(doc[keys[0]]).$;
-    var id = '';
-    Object.keys(namespaces).some(function(ns) {
-      if (namespaces[ns] !== url) {
-        return false;
-      }
+    function getNodeText(node, name) {
+      return node[name] && node[name][0] || '';
+    }
 
-      if (ns.indexOf(':') != -1) {
-        id = ns.split(':')[1] + ':';
+    function getNamespaceId(doc, url) {
+      var keys = Object.keys(doc);
+      if (keys.length !== 1) {
+        throw new AddonFormatError('Malformed manifest for add-on ' + addonPath);
       }
-      return true;
-    });
-    return id;
-  }
-}
 
+      var namespaces = /** @type {!RdfRoot} */(doc[keys[0]]).$;
+      var id = '';
+      Object.keys(namespaces).some(function(ns) {
+        if (namespaces[ns] !== url) {
+          return false;
+        }
 
-/**
- * Reads the manifest for a Firefox add-on.
- * @param {string} addonPath Path to a Firefox add-on as a xpi or an extension.
- * @return {!Promise<!Object>} A promise for the parsed manifest.
- */
-function readManifest(addonPath) {
-  var manifest;
+        if (ns.indexOf(':') != -1) {
+          id = ns.split(':')[1] + ':';
+        }
+        return true;
+      });
+      return id;
+    }
+  }
+
+  /**
+   * Parse a manifest for a Firefox WebExtension.
+   * @param {{
+   *   name: string,
+   *   version: string,
+   *   applications: {gecko:{id:string}}
+   * }} json JSON representation of the manifest.
+   * @return {!AddonDetails} The add-on details.
+   */
+  function parseManifestJson({name, version, applications}) {
+    if (!(applications && applications.gecko && applications.gecko.id)) {
+      throw new AddonFormatError('Could not find add-on ID for ' + addonPath);
+    }
 
-  if (addonPath.slice(-4) === '.xpi') {
-    manifest = new Promise((resolve, reject) => {
-      let zip = new AdmZip(addonPath);
+    return {id: applications.gecko.id, name, version, unpack: false};
+  }
 
-      if (!zip.getEntry('install.rdf')) {
-        reject(new AddonFormatError(
-            'Could not find install.rdf in ' + addonPath));
-        return;
+  function parseXpiFile(filePath) {
+    return zip.load(filePath).then(archive => {
+      if (archive.has('install.rdf')) {
+        return archive.getFile('install.rdf')
+            .then(buf => parseInstallRdf(buf.toString('utf8')));
       }
 
-      zip.readAsTextAsync('install.rdf', resolve);
-    });
-  } else {
-    manifest = io.stat(addonPath).then(function(stats) {
-      if (!stats.isDirectory()) {
-        throw Error(
-            'Add-on path is neither a xpi nor a directory: ' + addonPath);
+      if (archive.has('manifest.json')) {
+        return archive.getFile('manifest.json')
+            .then(buf => JSON.parse(buf.toString('utf8')))
+            .then(parseManifestJson);
       }
-      return io.read(path.join(addonPath, 'install.rdf'));
+
+      throw new AddonFormatError(
+          `Couldn't find install.rdf or manifest.json in ${filePath}`);
     });
   }
 
-  return manifest.then(function(content) {
-    return new Promise((resolve, reject) => {
-      xml.parseString(content, (err, data) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve(data);
-        }
-      });
-    });
-  });
+  function parseDirectory(dirPath) {
+    const rdfPath = path.join(dirPath, 'install.rdf');
+    const jsonPath = path.join(dirPath, 'manifest.json');
+    return io.exists(rdfPath)
+        .then(rdfExists => {
+          if (rdfExists) {
+            return io.read(rdfPath)
+                .then(buf => parseInstallRdf(buf.toString('utf8')));
+          }
+          return io.exists(jsonPath)
+              .then(jsonExists => {
+                if (jsonExists) {
+                  return io.read(jsonPath)
+                      .then(buf => JSON.parse(buf.toString('utf8')))
+                      .then(parseManifestJson);
+                }
+                throw new AddonFormatError(
+                    `Couldn't find install.rdf or manifest.json in ${dirPath}`);
+              });
+        })
+  }
 }