selenium-webdriver 3.5.0 → 4.0.0-alpha.4

package/example/firefox_channels.js

@@ -27,28 +27,37 @@
 
 'use strict';
 
-const {Builder, By, promise, until} = require('..');
+const {Builder, By, Key, promise, until} = require('..');
 const {Channel, Options} = require('../firefox');
 
 let i = 0;
 function resposition(driver) {
-  return driver.manage().window().setSize(600, 400)
-      .then(_ => driver.manage().window().setPosition(300 * (i++), 0));
+  return driver.manage().window().setRect({
+    width: 600,
+    height: 400,
+    x: 300 * (i++),
+    y: 0
+  });
 }
 
-function doSearch(driver) {
-  // Start on the base about page.
-  return driver.get('about:')
+async function doSearch(driver) {
+  try {
+    // Start on the base about page.
+    await driver.get('about:')
     // Reposition so users can see the three windows.
-    .then(_ => resposition(driver))
+    await resposition(driver);
     // Pause so users can see the magic.
-    .then(_ => promise.delayed(750))
+    await promise.delayed(750);
     // Now do the rest.
-    .then(_ => driver.get('http://www.google.com/ncr'))
-    .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-    .then(_ => driver.findElement(By.name('btnG')).click())
-    .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000))
-    .then(_ => driver.quit());
+    await driver.get('http://www.google.com/ncr');
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
+    await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
+    console.log('Success!');
+  } catch (ex) {
+    console.log('An error occured! ' + ex);
+  } finally {
+    await driver.quit();
+  }
 }
 
 function createDriver(channel) {
@@ -56,17 +65,12 @@ function createDriver(channel) {
   return new Builder().forBrowser('firefox').setFirefoxOptions(options).build();
 }
 
-// NOTE: disabling the promise manager so searches all run concurrently.
-// For more on the promise manager and its pending deprecation, see
-// https://github.com/SeleniumHQ/selenium/issues/2969
-promise.USE_PROMISE_MANAGER = false;
-
 Promise.all([
   doSearch(createDriver(Channel.RELEASE)),
   doSearch(createDriver(Channel.AURORA)),  // Developer Edition.
   doSearch(createDriver(Channel.NIGHTLY)),
 ]).then(_ => {
-  console.log('Success!');
+  console.log('All done!');
 }, err => {
   console.error('An error occured! ' + err);
   setTimeout(() => {throw err}, 0);

package/example/google_search.js

@@ -37,14 +37,14 @@
  *     node selenium-webdriver/example/google_search.js
  */
 
-const {Builder, By, until} = require('..');
+const {Builder, By, Key, until} = require('..');
 
 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/google_search_test.js

@@ -18,44 +18,55 @@
 /**
  * @fileoverview An example test that may be run using Mocha.
  *
+ * This example uses the `selenium-webdriver/testing.suite` function, which will
+ * automatically run tests against every available WebDriver browser on the
+ * current system. Alternatively, you may use the `SELENIUM_BROWSER`
+ * environment variable to narrow the scope at runtime.
+ *
  * Usage:
  *
+ *     # Automatically determine which browsers to run against.
  *     mocha -t 10000 selenium-webdriver/example/google_search_test.js
  *
- * You can change which browser is started with the SELENIUM_BROWSER environment
- * variable:
- *
+ *     # Configure tests to only run against Google Chrome.
  *     SELENIUM_BROWSER=chrome \
  *         mocha -t 10000 selenium-webdriver/example/google_search_test.js
  */
 
-const {Builder, By, until} = require('..');
-const test = require('../testing');
+const assert = require('assert');
 
-test.describe('Google Search', function() {
-  let driver;
+const {Browser, By, Key, until} = require('..');
+const {ignore, suite} = require('../testing');
 
-  test.before(function *() {
-    driver = yield new Builder().forBrowser('firefox').build();
-  });
+suite(function(env) {
+  describe('Google Search', function() {
+    let driver;
 
-  // You can write tests either using traditional promises.
-  it('works with promises', function() {
-    return driver.get('http://www.google.com/ncr')
-        .then(_ => driver.findElement(By.name('q')).sendKeys('webdriver'))
-        .then(_ => driver.findElement(By.name('btnG')).click())
-        .then(_ => driver.wait(until.titleIs('webdriver - Google Search'), 1000));
-  });
+    before(async function() {
+      // env.builder() returns a Builder instance preconfigured for the
+      // envrionment's target browser (you may still define browser specific
+      // options if necessary (i.e. firefox.Options or chrome.Options)).
+      driver = await env.builder().build();
+    });
 
-  // Or you can define the test as a generator function. The test will wait for
-  // any yielded promises to resolve before invoking the next step in the
-  // generator.
-  test.it('works with generators', function*() {
-    yield driver.get('http://www.google.com/ncr');
-    yield driver.findElement(By.name('q')).sendKeys('webdriver');
-    yield driver.findElement(By.name('btnG')).click();
-    yield driver.wait(until.titleIs('webdriver - Google Search'), 1000);
-  });
+    it('demo', async function() {
+      await driver.get('https://www.google.com/ncr');
+      await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
+      await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
+    });
+
+    // The ignore function returns wrappers around describe & it that will
+    // suppress tests if the provided predicate returns true. You may provide
+    // any synchronous predicate. The env.browsers(...) function generates a
+    // predicate that will suppress tests if the  env targets one of the
+    // specified browsers.
+    //
+    // This example is always configured to skip Chrome.
+    ignore(env.browsers(Browser.CHROME)).it('demo 2', async function() {
+      await driver.get('https://www.google.com/ncr');
+      await driver.wait(until.urlIs('https://www.google.com/'), 1500);
+    });
 
-  test.after(() => driver.quit());
+    after(() => driver && driver.quit());
+  });
 });

package/example/{chrome_headless.js → headless.js}

@@ -16,18 +16,24 @@
 // under the License.
 
 /**
- * @fileoverview An example of running Chrome in headless mode.
+ * @fileoverview An example of running Chrome or Firefox in headless mode.
  *
- * Before running this script, ensure you have Chrome 59+ installed and that
+ * 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>
  *
- * Usage:
- *   node selenium-webdriver/example/chrome_headless.js
+ *     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 {Builder, By, until} = require('..');
+const firefox = require('../firefox');
+const {Builder, By, Key, until} = require('..');
 
 const width = 640;
 const height = 480;
@@ -36,11 +42,13 @@ 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'))
-    .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/logging.js

@@ -21,15 +21,48 @@
 
 'use strict';
 
-const {Builder, By, logging, until} = require('..');
+const chrome = require('../chrome');
+const firefox = require('../firefox');
+const edge = require('../edge');
+const {Builder, By, Key, logging, until} = require('..');
 
 logging.installConsoleHandler();
 logging.getLogger('webdriver.http').setLevel(logging.Level.ALL);
 
-var driver = new Builder().forBrowser('firefox').build();
+(async function() {
+  let driver;
+  try {
+    driver = await new Builder()
+        // Default to using Firefox. This can be overridden at runtime by
+        // setting the SELENIUM_BROWSER environment variable:
+        //
+        //   SELENIUM_BROWSER=chrome node selenium-webdriver/example/logging.js
+        .forBrowser('firefox')
+        // Configure the service for each browser to enable verbose logging and
+        // to inherit the stdio settings from the current process. The builder
+        // will only start the service if needed for the selected browser.
+        .setChromeService(
+            new chrome.ServiceBuilder()
+                .enableVerboseLogging()
+                .setStdio('inherit'))
+        .setEdgeService(
+            process.platform === 'win32'
+                ? new edge.ServiceBuilder()
+                    .enableVerboseLogging()
+                    .setStdio('inherit')
+                : null)
+        .setFirefoxService(
+            new firefox.ServiceBuilder()
+                .enableVerboseLogging()
+                .setStdio('inherit'))
+        .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.wait(until.titleIs('webdriver - Google Search'), 1000))
-    .then(_ => driver.quit());
+    await driver.get('http://www.google.com/ncr');
+    await driver.findElement(By.name('q')).sendKeys('webdriver', Key.RETURN);
+    await driver.wait(until.titleIs('webdriver - Google Search'), 1000);
+  } finally {
+    if (driver) {
+      await driver.quit();
+    }
+  }
+})();