selenium-webdriver 3.0.1 → 3.5.0

package/safari.js

@@ -68,7 +68,7 @@ class ServiceBuilder extends remote.DriverService.Builder {
 
 
 const OPTIONS_CAPABILITY_KEY = 'safari.options';
-
+const TECHNOLOGY_PREVIEW_OPTIONS_KEY = 'technologyPreview';
 
 /**
  * Configuration options specific to the {@link Driver SafariDriver}.
@@ -89,16 +89,17 @@ class Options {
    * Extracts the SafariDriver specific options from the given capabilities
    * object.
    * @param {!Capabilities} capabilities The capabilities object.
-   * @return {!Options} The ChromeDriver options.
+   * @return {!Options} The SafariDriver options.
    */
   static fromCapabilities(capabilities) {
     var options = new Options();
-
     var o = capabilities.get(OPTIONS_CAPABILITY_KEY);
+
     if (o instanceof Options) {
       options = o;
     } else if (o) {
       options.setCleanSession(o.cleanSession);
+      options.setTechnologyPreview(o[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
     }
 
     if (capabilities.has(Capability.PROXY)) {
@@ -148,6 +149,22 @@ class Options {
     return this;
   }
 
+  /**
+   * Instruct the SafariDriver to use the Safari Technology Preview if true.
+   * Otherwise, use the release version of Safari. Defaults to using the release version of Safari.
+   *
+   * @param {boolean} useTechnologyPreview
+   * @return {!Options} A self reference.
+   */
+  setTechnologyPreview(useTechnologyPreview) {
+    if (!this.options_) {
+      this.options_ = {};
+    }
+
+    this.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY] = !!useTechnologyPreview;
+    return this;
+  }
+
   /**
    * Converts this options instance to a {@link Capabilities} object.
    * @param {Capabilities=} opt_capabilities The capabilities to
@@ -179,6 +196,23 @@ class Options {
   }
 }
 
+/**
+ * @param  {(Options|Object<string, *>)=} o The options object
+ * @return {boolean}
+ */
+function useTechnologyPreview(o) {
+  if (o instanceof Options) {
+    return !!(o.options_ && o.options_[TECHNOLOGY_PREVIEW_OPTIONS_KEY]);
+  }
+
+  if (o && typeof o === 'object') {
+    return !!o[TECHNOLOGY_PREVIEW_OPTIONS_KEY];
+  }
+
+  return false;
+}
+
+const SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE = '/Applications/Safari Technology Preview.app/Contents/MacOS/safaridriver';
 
 /**
  * A WebDriver client for Safari. This class should never be instantiated
@@ -200,19 +234,24 @@ class Driver extends webdriver.WebDriver {
    * @return {!Driver} A new driver instance.
    */
   static createSession(opt_config, opt_flow) {
-    let caps;
+    let caps, exe;
+
     if (opt_config instanceof Options) {
       caps = opt_config.toCapabilities();
     } else {
-      caps = opt_config || Capabilities.safari()
+      caps = opt_config || Capabilities.safari();
+    }
+
+    if (useTechnologyPreview(caps.get(OPTIONS_CAPABILITY_KEY))) {
+      exe = SAFARIDRIVER_TECHNOLOGY_PREVIEW_EXE;
     }
 
-    let service = new ServiceBuilder().build();
+    let service = new ServiceBuilder(exe).build();
     let executor = new http.Executor(
         service.start().then(url => new http.HttpClient(url)));
 
-    return /** @type {!Driver} */(webdriver.WebDriver.createSession(
-        executor, caps, opt_flow, this, () => service.kill()));
+    return /** @type {!Driver} */(super.createSession(
+        executor, caps, opt_flow, () => service.kill()));
   }
 }
 

package/test/firefox/extension_test.js

@@ -17,24 +17,27 @@
 
 'use strict';
 
-var AdmZip = require('adm-zip'),
-    assert = require('assert'),
+var assert = require('assert'),
     crypto = require('crypto'),
     fs = require('fs'),
     path = require('path');
 
 var extension = require('../../firefox/extension'),
     io = require('../../io'),
+    zip = require('../../io/zip'),
     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');
+  '../../lib/test/data/firefox/sample.xpi');
+var WEBEXTENSION_EXTENSION = path.join(__dirname,
+  '../../lib/test/data/firefox/webextension.xpi');
 
 var JETPACK_EXTENSION_ID = 'jid1-EaXX7k0wwiZR7w@jetpack';
 var NORMAL_EXTENSION_ID = 'sample@seleniumhq.org';
+var WEBEXTENSION_EXTENSION_ID = 'webextensions-selenium-example@example.com';
 
 
 describe('extension', function() {
@@ -75,22 +78,43 @@ describe('extension', function() {
     });
   });
 
+  it('can install a webextension xpi file', function() {
+    return io.tmpDir().then(function(dir) {
+      return extension.install(WEBEXTENSION_EXTENSION, dir).then(function(id) {
+        assert.equal(WEBEXTENSION_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(WEBEXTENSION_EXTENSION))
+          .digest('hex');
+
+        assert.equal(copiedSha1, goldenSha1);
+      });
+    });
+  });
+
   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')));
-        });
-      });
+      return zip.unzip(NORMAL_EXTENSION, srcDir)
+          .then(() => io.tmpDir())
+          .then(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

@@ -26,23 +26,27 @@ var firefox = require('../../firefox'),
     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');
+var WEBEXTENSION_EXTENSION = path.join(__dirname,
+  '../../lib/test/data/firefox/webextension.xpi');
 
 
 test.suite(function(env) {
   describe('firefox', function() {
     describe('Options', function() {
-      var driver;
+      let driver;
 
-      test.beforeEach(function() {
+      beforeEach(function() {
         driver = null;
       });
 
-      test.afterEach(function() {
+      afterEach(function() {
         if (driver) {
           return driver.quit();
         }
@@ -53,9 +57,7 @@ test.suite(function(env) {
        * skipped if dev cannot be found on the current system.
        */
       function runWithFirefoxDev(options, testFn) {
-        let binary = new firefox.Binary();
-        binary.useDevEdition();
-        return binary.locate().then(exe => {
+        return firefox.Channel.AURORA.locate().then(exe => {
           options.setBinary(exe);
           driver = env.builder()
               .setFirefoxOptions(options)
@@ -67,21 +69,33 @@ test.suite(function(env) {
         });
       }
 
-      test.it('can start Firefox with custom preferences', function*() {
-        var profile = new firefox.Profile();
-        profile.setPreference('general.useragent.override', 'foo;bar');
+      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');
 
-        var options = new firefox.Options().setProfile(profile);
+            let options = new firefox.Options().setProfile(profile);
 
-        driver = env.builder().
-            setFirefoxOptions(options).
-            build();
+            driver = env.builder().
+                setFirefoxOptions(options).
+                build();
 
-        yield driver.get('data:text/html,<html><div>content</div></html>');
+            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();
+        });
 
-        var userAgent = yield driver.executeScript(
-            'return window.navigator.userAgent');
-        assert(userAgent).equalTo('foo;bar');
+        test.it('profile created from template', function() {
+          return io.tmpDir().then(runTest);
+        });
       });
 
       test.it('can start Firefox with a jetpack extension', function() {
@@ -116,6 +130,22 @@ test.suite(function(env) {
         });
       });
 
+      test.it('can start Firefox with a webextension extension', function() {
+        let profile = new firefox.Profile();
+        profile.addExtension(WEBEXTENSION_EXTENSION);
+
+        let options = new firefox.Options().setProfile(profile);
+
+        return runWithFirefoxDev(options, function*() {
+          yield driver.get(test.Pages.echoPage);
+
+          let footer =
+            yield driver.findElement({id: 'webextensions-selenium-example'});
+          let text = yield footer.getText();
+          assert(text).equalTo('Content injected by webextensions-selenium-example');
+        });
+      });
+
       test.it('can start Firefox with multiple extensions', function() {
         let profile = new firefox.Profile();
         profile.addExtension(JETPACK_EXTENSION);
@@ -138,6 +168,26 @@ test.suite(function(env) {
         });
       });
 
+      test.it('can be used alongside preset capabilities', function*() {
+        let binary = yield firefox.Channel.AURORA.locate();
+
+        let profile = new firefox.Profile();
+        profile.addExtension(JETPACK_EXTENSION);
+        profile.setPreference('general.useragent.override', 'foo;bar');
+
+        driver = yield env.builder()
+            .withCapabilities({'moz:firefoxOptions': {binary}})
+            .setFirefoxOptions(new firefox.Options().setProfile(profile))
+            .build();
+
+        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!');
+      });
+
       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
@@ -186,13 +236,11 @@ test.suite(function(env) {
         }
       });
 
-      test.ignore(() => !env.isMarionette).
-      it('can get context', function() {
+      test.it('can get context', function() {
         return assert(driver.getContext()).equalTo(Context.CONTENT);
       });
 
-      test.ignore(() => !env.isMarionette).
-      it('can set context', function*() {
+      test.it('can set context', function*() {
         yield driver.setContext(Context.CHROME);
         let ctxt = yield driver.getContext();
         assert(ctxt).equalTo(Context.CHROME);
@@ -202,8 +250,7 @@ test.suite(function(env) {
         assert(ctxt).equalTo(Context.CONTENT);
       });
 
-      test.ignore(() => !env.isMarionette).
-      it('throws on unknown context', function() {
+      test.it('throws on unknown context', function() {
         return driver.setContext("foo").then(assert.fail, function(e) {
           assert(e).instanceOf(error.InvalidArgumentError);
         });

package/test/firefox/profile_test.js

@@ -17,8 +17,7 @@
 
 'use strict';
 
-var AdmZip = require('adm-zip'),
-    assert = require('assert'),
+var assert = require('assert'),
     fs = require('fs'),
     path = require('path');
 
@@ -33,10 +32,12 @@ 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 WEBEXTENSION_EXTENSION = path.join(__dirname,
+  '../../lib/test/data/firefox/webextension.xpi');
 
 var JETPACK_EXTENSION_ID = 'jid1-EaXX7k0wwiZR7w@jetpack.xpi';
 var NORMAL_EXTENSION_ID = 'sample@seleniumhq.org';
-var WEBDRIVER_EXTENSION_ID = 'fxdriver@googlecode.com';
+var WEBEXTENSION_EXTENSION_ID = 'webextensions-selenium-example@example.com';
 
 
 
@@ -57,13 +58,6 @@ describe('Profile', function() {
       assert.equal('http://www.example.com',
           profile.getPreference('browser.newtab.url'));
     });
-
-    it('throws if setting a frozen preference', function() {
-      var profile = new Profile();
-      assert.throws(function() {
-        profile.setPreference('app.update.auto', true);
-      });
-    });
   });
 
   describe('writeToDisk', function() {
@@ -104,20 +98,6 @@ describe('Profile', function() {
     });
 
     describe('user.js', function() {
-
-      it('writes defaults', function() {
-        return new Profile().writeToDisk().then(function(dir) {
-          return loadUserPrefs(path.join(dir, 'user.js'));
-        }).then(function(prefs) {
-          // Just check a few.
-          assert.equal(false, prefs['app.update.auto']);
-          assert.equal(true, prefs['browser.EULA.override']);
-          assert.equal(false, prefs['extensions.update.enabled']);
-          assert.equal('about:blank', prefs['browser.newtab.url']);
-          assert.equal(30, prefs['dom.max_script_run_time']);
-        });
-      });
-
       it('merges template user.js into preferences', function() {
         return io.tmpDir().then(function(dir) {
           fs.writeFileSync(path.join(dir, 'user.js'), [
@@ -133,19 +113,6 @@ describe('Profile', function() {
           assert.equal(1234, prefs['dom.max_script_run_time']);
         });
       });
-
-      it('ignores frozen preferences when merging template user.js',
-        function() {
-          return io.tmpDir().then(function(dir) {
-            fs.writeFileSync(path.join(dir, 'user.js'),
-                'user_pref("app.update.auto", true)');
-            return new Profile(dir).writeToDisk();
-          }).then(function(profile) {
-            return loadUserPrefs(path.join(profile, 'user.js'));
-          }).then(function(prefs) {
-            assert.equal(false, prefs['app.update.auto']);
-          });
-        });
     });
 
     describe('extensions', function() {
@@ -153,33 +120,21 @@ describe('Profile', function() {
         var profile = new Profile();
         profile.addExtension(JETPACK_EXTENSION);
         profile.addExtension(NORMAL_EXTENSION);
+        profile.addExtension(WEBEXTENSION_EXTENSION);
 
         return profile.writeToDisk().then(function(dir) {
           dir = path.join(dir, 'extensions');
-          assert.ok(fs.existsSync(path.join(dir, JETPACK_EXTENSION_ID)));
-          assert.ok(fs.existsSync(path.join(dir, NORMAL_EXTENSION_ID)));
-          assert.ok(fs.existsSync(path.join(dir, WEBDRIVER_EXTENSION_ID)));
+          assertExists(JETPACK_EXTENSION_ID);
+          assertExists(NORMAL_EXTENSION_ID);
+          assertExists(WEBEXTENSION_EXTENSION_ID + '.xpi');
+
+          function assertExists(file) {
+            assert.ok(
+                fs.existsSync(path.join(dir, file)),
+                `expected ${file} to exist`);
+          }
         });
       });
     });
   });
-
-  describe('encode', function() {
-    it('excludes the bundled WebDriver extension', function() {
-      return new Profile().encode().then(function(data) {
-        return decode(data);
-      }).then(function(dir) {
-        assert.ok(fs.existsSync(path.join(dir, 'user.js')));
-        assert.ok(fs.existsSync(path.join(dir, 'extensions')));
-        return loadUserPrefs(path.join(dir, 'user.js'));
-      }).then(function(prefs) {
-        // Just check a few.
-        assert.equal(false, prefs['app.update.auto']);
-        assert.equal(true, prefs['browser.EULA.override']);
-        assert.equal(false, prefs['extensions.update.enabled']);
-        assert.equal('about:blank', prefs['browser.newtab.url']);
-        assert.equal(30, prefs['dom.max_script_run_time']);
-      });
-    });
-  });
 });

package/test/http/http_test.js

@@ -44,6 +44,14 @@ describe('HttpClient', function() {
       res.writeHead(200, {'content-type': 'text/plain'});
       res.end('hello, world!');
 
+    } else if (req.method == 'GET' && req.url == '/chunked') {
+      res.writeHead(200, {
+        'content-type': 'text/html; charset=utf-8',
+        'transfer-encoding': 'chunked'
+      });
+      res.write('<!DOCTYPE html>');
+      setTimeout(() => res.end('<h1>Hello, world!</h1>'), 20);
+
     } else if (req.method == 'GET' && req.url == '/badredirect') {
       res.writeHead(303, {});
       res.end();
@@ -121,6 +129,16 @@ describe('HttpClient', function() {
     });
   });
 
+  it('handles chunked responses', function() {
+    let request = new HttpRequest('GET', '/chunked');
+
+    let client = new HttpClient(server.url());
+    return client.send(request).then(response => {
+      assert.equal(200, response.status);
+      assert.equal(response.body, '<!DOCTYPE html><h1>Hello, world!</h1>');
+    });
+  });
+
   it('can use basic auth', function() {
     var parsed = url.parse(server.url());
     parsed.auth = 'genie:bottle';

package/test/{io_test.js → io/io_test.js}

@@ -22,7 +22,7 @@ var assert = require('assert'),
     path = require('path'),
     tmp = require('tmp');
 
-var io = require('../io');
+var io = require('../../io');
 
 
 describe('io', function() {
@@ -318,4 +318,43 @@ describe('io', function() {
                 (e) => assert.equal('ENOENT', e.code));
     });
   });
+
+  describe('mkdirp', function() {
+    it('recursively creates entire directory path', function() {
+      return io.tmpDir().then(root => {
+        let dst = path.join(root, 'foo/bar/baz');
+        return io.mkdirp(dst).then(d => {
+          assert.strictEqual(d, dst);
+          return io.stat(d).then(stats => {
+            assert.ok(stats.isDirectory());
+          });
+        });
+      });
+    });
+
+    it('does nothing if the directory already exists', function() {
+      return io.tmpDir()
+          .then(dir => io.mkdirp(dir).then(d => assert.strictEqual(d, dir)));
+    });
+  });
+
+  describe('walkDir', function() {
+    it('walk directory', function() {
+      return io.tmpDir().then(dir => {
+        fs.writeFileSync(path.join(dir, 'file1'), 'hello');
+        fs.mkdirSync(path.join(dir, 'sub'));
+        fs.mkdirSync(path.join(dir, 'sub/folder'));
+        fs.writeFileSync(path.join(dir, 'sub/folder/file2'), 'goodbye');
+
+        return io.walkDir(dir).then(seen => {
+          assert.deepStrictEqual(
+              seen,
+              [{path: 'file1', dir: false},
+               {path: 'sub', dir: true},
+               {path: 'sub/folder', dir: true},
+               {path: 'sub/folder/file2', dir: false}]);
+        });
+      });
+    });
+  })
 });