selenium-webdriver 3.6.0 → 4.0.0-alpha.1

package/test/firefox_test.js

@@ -0,0 +1,251 @@
+// 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';
+
+const assert = require('assert');
+const path = require('path');
+
+const error = require('../lib/error');
+const firefox = require('../firefox');
+const io = require('../io');
+const {Browser} = require('../');
+const {Context} = require('../firefox');
+const {Pages, suite, ignore} = require('../lib/test');
+
+
+const WEBEXTENSION_EXTENSION =
+    path.join(__dirname, '../lib/test/data/firefox/webextension.xpi');
+
+const WEBEXTENSION_EXTENSION_ID =
+    'webextensions-selenium-example@example.com.xpi';
+
+
+suite(function(env) {
+  describe('firefox', function() {
+    let driver;
+
+    beforeEach(function() {
+      driver = null;
+    });
+
+    afterEach(function() {
+      return driver && 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(async (exe) => {
+        options = options || new firefox.Options();
+        options.setBinary(exe);
+        driver = await env.builder()
+            .setFirefoxOptions(options)
+            .build();
+        return testFn();
+      }, err => {
+        console.warn(
+            'Skipping test: could not find Firefox Dev Edition: ' + err);
+      });
+    }
+
+    describe('Options', function() {
+      let profileWithWebExtension;
+      let profileWithUserPrefs;
+
+      before(async function createProfileWithWebExtension() {
+        profileWithWebExtension = await io.tmpDir();
+        let extensionsDir = path.join(profileWithWebExtension, 'extensions');
+        await io.mkdir(extensionsDir);
+        await io.write(
+            path.join(extensionsDir, WEBEXTENSION_EXTENSION_ID),
+            await io.read(WEBEXTENSION_EXTENSION));
+      });
+
+      before(async function createProfileWithUserPrefs() {
+        profileWithUserPrefs = await io.tmpDir();
+        await io.write(
+            path.join(profileWithUserPrefs, 'user.js'),
+            'user_pref("general.useragent.override", "foo;bar");\n');
+      });
+
+      describe('setProfile', function() {
+        it('use profile with custom prefs', async function() {
+          let options = new firefox.Options;
+          options.setProfile(profileWithUserPrefs);
+
+          driver = env.builder().setFirefoxOptions(options).build();
+
+          await driver.get(Pages.echoPage);
+          await verifyUserAgentWasChanged();
+        });
+
+        it('use profile with extension', function() {
+          let options = new firefox.Options;
+          options.setProfile(profileWithWebExtension);
+
+          return runWithFirefoxDev(options, async function() {
+            await driver.get(Pages.echoPage);
+            await verifyWebExtensionWasInstalled();
+          });
+        });
+      });
+
+      describe('setPreference', function() {
+        it('throws if key is not a string', function() {
+          let options = new firefox.Options;
+          assert.throws(() => options.setPreference(1, 2), TypeError);
+          options.setPreference('1', 2);  // OK if no throw.
+        });
+
+        it('throws if value is an invalid type', function() {
+          let options = new firefox.Options;
+          options.setPreference('a', 1);
+          options.setPreference('b', '2');
+          options.setPreference('c', true);
+
+          assert.throws(() => options.setPreference('d', null), TypeError);
+          assert.throws(() => options.setPreference('d', undefined), TypeError);
+          assert.throws(() => options.setPreference('d', {}), TypeError);
+        });
+
+        it('can start Firefox with custom preferences', async function() {
+          let options = new firefox.Options();
+          options.setPreference('general.useragent.override', 'foo;bar');
+
+          driver = env.builder().setFirefoxOptions(options).build();
+
+          await driver.get(Pages.echoPage);
+          await verifyUserAgentWasChanged();
+        });
+
+        it('can add extra prefs on top of an existing profile', async function() {
+          let options = new firefox.Options()
+              .setPreference('general.useragent.override', 'foo;bar')
+              .setProfile(profileWithWebExtension);
+
+          return runWithFirefoxDev(options, async function() {
+            await driver.get(Pages.echoPage);
+            await verifyWebExtensionWasInstalled();
+            await verifyUserAgentWasChanged();
+          });
+        });
+      });
+
+      describe('addExtensions', function() {
+        it('can add extension to brand new profile', async function() {
+          let options = new firefox.Options();
+          options.addExtensions(WEBEXTENSION_EXTENSION);
+
+          return runWithFirefoxDev(options, async function() {
+            await driver.get(Pages.echoPage);
+            await verifyWebExtensionWasInstalled();
+          });
+        });
+
+        it('can add extension to custom profile', function() {
+          let options = new firefox.Options()
+              .addExtensions(WEBEXTENSION_EXTENSION)
+              .setProfile(profileWithUserPrefs);
+
+          return runWithFirefoxDev(options, async function() {
+            await driver.get(Pages.echoPage);
+            await verifyWebExtensionWasInstalled();
+            await verifyUserAgentWasChanged();
+          });
+        });
+
+        it('can addExtensions and setPreference', function() {
+          let options = new firefox.Options()
+              .addExtensions(WEBEXTENSION_EXTENSION)
+              .setPreference('general.useragent.override', 'foo;bar')
+
+          return runWithFirefoxDev(options, async function() {
+            await driver.get(Pages.echoPage);
+            await verifyWebExtensionWasInstalled();
+            await verifyUserAgentWasChanged();
+          });
+        });
+      });
+    });
+
+    describe('context switching', function() {
+      beforeEach(async function() {
+        driver = await env.builder().build();
+      });
+
+      it('can get context', async function() {
+        assert.equal(await driver.getContext(), Context.CONTENT);
+      });
+
+      it('can set context', async function() {
+        await driver.setContext(Context.CHROME);
+        let ctxt = await driver.getContext();
+        assert.equal(ctxt, Context.CHROME);
+
+        await driver.setContext(Context.CONTENT);
+        ctxt = await driver.getContext();
+        assert.equal(ctxt, Context.CONTENT);
+      });
+
+      it('throws on unknown context', function() {
+        return driver.setContext("foo").then(assert.fail, function(e) {
+          assert(e instanceof error.InvalidArgumentError);
+        });
+      });
+    });
+
+    it('addons can be installed and uninstalled at runtime', function() {
+      return runWithFirefoxDev(null, async function() {
+        await driver.get(Pages.echoPage);
+        await verifyWebExtensionNotInstalled();
+
+        let id = await driver.installAddon(WEBEXTENSION_EXTENSION);
+        await driver.sleep(1000);  // Give extension time to install (yuck).
+
+        await driver.get(Pages.echoPage);
+        await verifyWebExtensionWasInstalled();
+
+        await driver.uninstallAddon(id);
+        await driver.get(Pages.echoPage);
+        await verifyWebExtensionNotInstalled();
+      });
+    });
+
+    async function verifyUserAgentWasChanged() {
+      let userAgent =
+          await driver.executeScript('return window.navigator.userAgent');
+      assert.equal(userAgent, 'foo;bar');
+    }
+
+    async function verifyWebExtensionNotInstalled() {
+      let found =
+          await driver.findElements({id: 'webextensions-selenium-example'});
+      assert.equal(found.length, 0);
+    }
+
+    async function verifyWebExtensionWasInstalled() {
+      let footer =
+          await driver.findElement({id: 'webextensions-selenium-example'});
+      let text = await footer.getText();
+      assert.equal(
+          text, 'Content injected by webextensions-selenium-example');
+    }
+  });
+}, {browsers: [Browser.FIREFOX]});

package/test/http/http_test.js

@@ -27,7 +27,6 @@ var HttpClient = require('../../http').HttpClient,
     Server = require('../../lib/test/httpserver').Server;
 
 describe('HttpClient', function() {
-  this.timeout(4 * 1000);
 
   var server = new Server(function(req, res) {
     let parsedUrl = url.parse(req.url);

package/test/http/util_test.js

@@ -132,7 +132,7 @@ describe('selenium-webdriver/http/util', function() {
       return util.waitForServer(baseUrl, 200, cancel)
           .then(
               () => { throw Error('Did not expect to succeed!'); },
-              (e) => assert.ok(e instanceof promise.CancellationError));
+              (e) => assert.ok(e instanceof util.CancellationError));
     });
   });
 
@@ -172,7 +172,7 @@ describe('selenium-webdriver/http/util', function() {
       return util.waitForUrl(baseUrl, 200, cancel)
           .then(
               () => { throw Error('Did not expect to succeed!'); },
-              (e) => assert.ok(e instanceof promise.CancellationError));
+              (e) => assert.ok(e instanceof util.CancellationError));
     });
   });
 });

package/test/io/zip_test.js

@@ -27,19 +27,18 @@ const zip = require('../../io/zip');
 const {InvalidArgumentError} = require('../../lib/error');
 
 
-const SAMPLE_XPI_PATH =
-    path.join(__dirname, '../../lib/test/data/firefox/sample.xpi');
+const XPI_PATH =
+    path.join(__dirname, '../../lib/test/data/firefox/webextension.xpi');
 
 describe('io/zip', function() {
   describe('unzip', function() {
     it('creates destination dir if necessary', function() {
       return io.tmpDir()
-          .then(dir => zip.unzip(SAMPLE_XPI_PATH, dir))
+          .then(dir => zip.unzip(XPI_PATH, dir))
           .then(dir => {
-            assertExists(path.join(dir, 'chrome.manifest'));
-            assertExists(path.join(dir, 'content/overlay.js'));
-            assertExists(path.join(dir, 'content/overlay.xul'));
-            assertExists(path.join(dir, 'install.rdf'));
+            assertExists(path.join(dir, 'inject.js'));
+            assertExists(path.join(dir, 'manifest.json'));
+            assertExists(path.join(dir, 'META-INF/manifest.mf'));
           });
     });
   });

package/test/lib/error_test.js

@@ -40,16 +40,17 @@ describe('error', function() {
     test('unknown error', error.WebDriverError);
     test('element not interactable', error.ElementNotInteractableError);
     test('element not selectable', error.ElementNotSelectableError);
-    test('element not visible', error.ElementNotVisibleError);
+    test('insecure certificate', error.InsecureCertificateError);
     test('invalid argument', error.InvalidArgumentError);
     test('invalid cookie domain', error.InvalidCookieDomainError);
-    test('invalid element coordinates', error.InvalidElementCoordinatesError);
+    test('invalid coordinates', error.InvalidCoordinatesError);
     test('invalid element state', error.InvalidElementStateError);
     test('invalid selector', error.InvalidSelectorError);
     test('invalid session id', error.NoSuchSessionError);
     test('javascript error', error.JavascriptError);
     test('move target out of bounds', error.MoveTargetOutOfBoundsError);
     test('no such alert', error.NoSuchAlertError);
+    test('no such cookie', error.NoSuchCookieError);
     test('no such element', error.NoSuchElementError);
     test('no such frame', error.NoSuchFrameError);
     test('no such window', error.NoSuchWindowError);
@@ -92,8 +93,9 @@ describe('error', function() {
     });
 
     test(error.WebDriverError, 'unknown error');
+    test(error.ElementClickInterceptedError, 'element click intercepted');
     test(error.ElementNotSelectableError, 'element not selectable');
-    test(error.ElementNotVisibleError, 'element not visible');
+    test(error.InsecureCertificateError, 'insecure certificate');
     test(error.InvalidArgumentError, 'invalid argument');
     test(error.InvalidCookieDomainError, 'invalid cookie domain');
     test(error.InvalidElementStateError, 'invalid element state');
@@ -102,6 +104,7 @@ describe('error', function() {
     test(error.JavascriptError, 'javascript error');
     test(error.MoveTargetOutOfBoundsError, 'move target out of bounds');
     test(error.NoSuchAlertError, 'no such alert');
+    test(error.NoSuchCookieError, 'no such cookie');
     test(error.NoSuchElementError, 'no such element');
     test(error.NoSuchFrameError, 'no such frame');
     test(error.NoSuchWindowError, 'no such window');
@@ -163,17 +166,19 @@ describe('error', function() {
     });
 
     test('unknown error', error.WebDriverError);
+    test('element click intercepted', error.ElementClickInterceptedError);
     test('element not selectable', error.ElementNotSelectableError);
-    test('element not visible', error.ElementNotVisibleError);
+    test('insecure certificate', error.InsecureCertificateError);
     test('invalid argument', error.InvalidArgumentError);
     test('invalid cookie domain', error.InvalidCookieDomainError);
-    test('invalid element coordinates', error.InvalidElementCoordinatesError);
+    test('invalid coordinates', error.InvalidCoordinatesError);
     test('invalid element state', error.InvalidElementStateError);
     test('invalid selector', error.InvalidSelectorError);
     test('invalid session id', error.NoSuchSessionError);
     test('javascript error', error.JavascriptError);
     test('move target out of bounds', error.MoveTargetOutOfBoundsError);
     test('no such alert', error.NoSuchAlertError);
+    test('no such cookie', error.NoSuchCookieError);
     test('no such element', error.NoSuchElementError);
     test('no such frame', error.NoSuchFrameError);
     test('no such window', error.NoSuchWindowError);
@@ -218,6 +223,24 @@ describe('error', function() {
             });
       });
     }
+
+    describe('remote stack trace decoding', function() {
+      test('stacktrace');
+      test('stackTrace');
+
+      function test(key) {
+        it(`encoded as "${key}"`, function() {
+          let data = {error: 'unknown command', message: 'oops'};
+          data[key] = 'some-stacktrace';
+          assert.throws(
+              () => error.throwDecodedError(data),
+              (e) => {
+                assert.strictEqual(e.remoteStacktrace, 'some-stacktrace');
+                return true;
+              });
+        });
+      }
+    });
   });
 
   describe('checkLegacyResponse', function() {
@@ -226,12 +249,12 @@ describe('error', function() {
       assert.strictEqual(resp, error.checkLegacyResponse(resp));
     });
 
+    test('NO_SUCH_SESSION', error.NoSuchSessionError);
     test('NO_SUCH_ELEMENT', error.NoSuchElementError);
     test('NO_SUCH_FRAME', error.NoSuchFrameError);
     test('UNKNOWN_COMMAND', error.UnsupportedOperationError);
     test('UNSUPPORTED_OPERATION', error.UnsupportedOperationError);
     test('STALE_ELEMENT_REFERENCE', error.StaleElementReferenceError);
-    test('ELEMENT_NOT_VISIBLE', error.ElementNotVisibleError);
     test('INVALID_ELEMENT_STATE', error.InvalidElementStateError);
     test('UNKNOWN_ERROR', error.WebDriverError);
     test('ELEMENT_NOT_SELECTABLE', error.ElementNotSelectableError);
@@ -244,12 +267,16 @@ describe('error', function() {
     test('UNEXPECTED_ALERT_OPEN', error.UnexpectedAlertOpenError);
     test('NO_SUCH_ALERT', error.NoSuchAlertError);
     test('SCRIPT_TIMEOUT', error.ScriptTimeoutError);
-    test('INVALID_ELEMENT_COORDINATES', error.InvalidElementCoordinatesError);
+    test('INVALID_ELEMENT_COORDINATES', error.InvalidCoordinatesError);
     test('INVALID_SELECTOR_ERROR', error.InvalidSelectorError);
     test('SESSION_NOT_CREATED', error.SessionNotCreatedError);
     test('MOVE_TARGET_OUT_OF_BOUNDS', error.MoveTargetOutOfBoundsError);
     test('INVALID_XPATH_SELECTOR', error.InvalidSelectorError);
     test('INVALID_XPATH_SELECTOR_RETURN_TYPE', error.InvalidSelectorError);
+    test('ELEMENT_NOT_INTERACTABLE', error.ElementNotInteractableError);
+    test('INVALID_ARGUMENT', error.InvalidArgumentError);
+    test('UNABLE_TO_CAPTURE_SCREEN', error.UnableToCaptureScreenError);
+    test('ELEMENT_CLICK_INTERCEPTED', error.ElementClickInterceptedError);
     test('METHOD_NOT_ALLOWED', error.UnsupportedOperationError);
 
     describe('UnexpectedAlertOpenError', function() {

package/test/lib/http_test.js

@@ -118,7 +118,7 @@ describe('http', function() {
         });
       });
 
-      it('rejects commands missing URL parameters', function() {
+      it('rejects commands missing URL parameters', async function() {
         let command =
             new Command(CommandName.FIND_CHILD_ELEMENT).
                 setParameter('sessionId', 's123').
@@ -126,12 +126,13 @@ describe('http', function() {
                 setParameter('using', 'id').
                 setParameter('value', 'foo');
 
-        assert.throws(
-            () => executor.execute(command),
-            function(err) {
-              return err instanceof error.InvalidArgumentError
-                  && 'Missing required parameter: id' === err.message;
-            });
+        try {
+          await executor.execute(command);
+          return Promise.reject(Error('should have thrown'));
+        } catch (err) {
+          assert.strictEqual(err.constructor, error.InvalidArgumentError);
+          assert.equal(err.message, 'Missing required parameter: id');
+        }
         assert.ok(!send.called);
       });
 
@@ -153,14 +154,6 @@ describe('http', function() {
         beforeEach(() => executor = new http.Executor(client));
 
         describe('in legacy mode', function() {
-          test(CommandName.GET_WINDOW_SIZE, {sessionId:'s123'}, false,
-               'GET', '/session/s123/window/current/size');
-
-          test(CommandName.SET_WINDOW_SIZE,
-               {sessionId:'s123', width: 1, height: 1}, false,
-               'POST', '/session/s123/window/current/size',
-               {width: 1, height: 1});
-
           test(CommandName.MAXIMIZE_WINDOW, {sessionId:'s123'}, false,
                'POST', '/session/s123/window/current/maximize');
 
@@ -171,14 +164,6 @@ describe('http', function() {
         });
 
         describe('in W3C mode', function() {
-          test(CommandName.GET_WINDOW_SIZE,
-               {sessionId:'s123'}, true,
-               'GET', '/session/s123/window/size');
-
-          test(CommandName.SET_WINDOW_SIZE,
-               {sessionId:'s123', width: 1, height: 1}, true,
-               'POST', '/session/s123/window/size', {width: 1, height: 1});
-
           test(CommandName.MAXIMIZE_WINDOW, {sessionId:'s123'}, true,
                'POST', '/session/s123/window/maximize');
 
@@ -366,111 +351,6 @@ describe('http', function() {
         });
       });
 
-      describe('extracts Session from DESCRIBE_SESSION response', function() {
-        let command;
-
-        beforeEach(function() {
-          executor = new http.Executor(client);
-          command = new Command(CommandName.DESCRIBE_SESSION)
-              .setParameter('sessionId', 'foo');
-        });
-
-        describe('fails if server returns invalid response', function() {
-          describe('(empty response)', function() {
-            test(true);
-            test(false);
-
-            function test(w3c) {
-              it('w3c === ' + w3c, function() {
-                send.returns(Promise.resolve(new http.Response(200, {}, '')));
-                executor.w3c = w3c;
-                return executor.execute(command).then(
-                    () => assert.fail('expected to fail'),
-                    (e) => {
-                      if (!e.message.startsWith('Unable to parse')) {
-                        throw e;
-                      }
-                    });
-              });
-            }
-          });
-
-          describe('(no session ID)', function() {
-            test(true);
-            test(false);
-
-            function test(w3c) {
-              it('w3c === ' + w3c, function() {
-                let resp = {value:{name: 'Bob'}};
-                send.returns(Promise.resolve(
-                    new http.Response(200, {}, JSON.stringify(resp))));
-                executor.w3c = w3c;
-                return executor.execute(command).then(
-                    () => assert.fail('expected to fail'),
-                    (e) => {
-                      if (!e.message.startsWith('Unable to parse')) {
-                        throw e;
-                      }
-                    });
-              });
-            }
-          });
-        });
-
-        it('handles legacy response', function() {
-          var rawResponse = {sessionId: 's123', status: 0, value: {name: 'Bob'}};
-
-          send.returns(Promise.resolve(
-              new http.Response(200, {}, JSON.stringify(rawResponse))));
-
-          assert.ok(!executor.w3c);
-          return executor.execute(command).then(function(response) {
-            assert.ok(response instanceof Session);
-            assert.equal(response.getId(), 's123');
-
-            let caps = response.getCapabilities();
-            assert.ok(caps instanceof Capabilities);
-            assert.equal(caps.get('name'), 'Bob');
-
-            assert.ok(!executor.w3c);
-          });
-        });
-
-        it('does not auto-upgrade on W3C response', function() {
-          var rawResponse = {value: {sessionId: 's123', value: {name: 'Bob'}}};
-
-          send.returns(Promise.resolve(
-              new http.Response(200, {}, JSON.stringify(rawResponse))));
-
-          assert.ok(!executor.w3c);
-          return executor.execute(command).then(function(response) {
-            assert.ok(response instanceof Session);
-            assert.equal(response.getId(), 's123');
-
-            let caps = response.getCapabilities();
-            assert.ok(caps instanceof Capabilities);
-            assert.equal(caps.get('name'), 'Bob');
-
-            assert.ok(!executor.w3c);
-          });
-        });
-
-        it('if w3c, does not downgrade on legacy response', function() {
-          var rawResponse = {sessionId: 's123', status: 0, value: null};
-
-          send.returns(Promise.resolve(
-              new http.Response(200, {}, JSON.stringify(rawResponse))));
-
-          executor.w3c = true;
-          return executor.execute(command).then(function(response) {
-            assert.ok(response instanceof Session);
-            assert.equal(response.getId(), 's123');
-            assert.equal(response.getCapabilities().size, 0);
-            assert.ok(executor.w3c, 'should never downgrade');
-          });
-        });
-      });
-
       it('handles JSON null', function() {
         var command = new Command(CommandName.GET_CURRENT_URL)
             .setParameter('sessionId', 's123');