Native support for the SafariDriver in WebDriverJS

Author: jleyba

Rakefile

@@ -577,6 +577,7 @@ namespace :node do
     "//cpp:noblur",
     "//cpp:noblur64",
     "//javascript/firefox-driver:webdriver",
+    "//javascript/safari-driver:client",
     "//javascript/webdriver:asserts_lib",
     "//javascript/webdriver:webdriver_lib",
     "//javascript/webdriver:unit_test_lib"
@@ -595,6 +596,7 @@ namespace :node do
         " --resource=build/cpp/amd64/libnoblur64.so:firefox/amd64/libnoblur64.so" <<
         " --resource=build/cpp/i386/libnoblur.so:firefox/i386/libnoblur.so" <<
         " --resource=build/javascript/firefox-driver/webdriver.xpi:firefox/webdriver.xpi" <<
+        " --resource=build/javascript/safari-driver/client.js:safari/client.js" <<
         " --resource=third_party/closure/LICENSE:goog/LICENSE" <<
         " --resource=common/src/web/:test/data/" <<
         " --exclude_resource=common/src/web/Bin" <<

javascript/node/selenium-webdriver/CHANGES.md

@@ -12,6 +12,7 @@ major version release (i.e. 1.0.0).
 
 * Added native support for Internet Explorer - the Java Selenium server is no
     longer required.
+* Added native support for Safari
 * Added native support for Opera 26+
 * With the release of [Node 0.12.0](http://blog.nodejs.org/2015/02/06/node-v0-12-0-stable/)
     (finally!), the minimum supported version of Node is now `0.10.x`.

javascript/node/selenium-webdriver/builder.js

@@ -104,6 +104,12 @@ var Builder = function() {
   /** @private {opera.Options} */
   this.operaOptions_ = null;
 
+  /** @private {ie.Options} */
+  this.ieOptions_ = null;
+
+  /** @private {safari.Options} */
+  this.safariOptions_ = null;
+
   /** @private {boolean} */
   this.ignoreEnv_ = false;
 };
@@ -258,10 +264,10 @@ Builder.prototype.setAlertBehavior = function(behavior) {
 
 
 /**
- * Sets Chrome-specific options for drivers created by this builder. Any
- * logging or proxy settings defined on the given options will take precedence
- * over those set through {@link #setLoggingPrefs} and {@link #setProxy},
- * respectively.
+ * Sets Chrome specific {@linkplain selenium-webdriver/chrome.Options options}
+ * for drivers created by this builder. Any logging or proxy settings defined
+ * on the given options will take precedence over those set through
+ * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.
  *
  * @param {!chrome.Options} options The ChromeDriver options to use.
  * @return {!Builder} A self reference.
@@ -273,10 +279,10 @@ Builder.prototype.setChromeOptions = function(options) {
 
 
 /**
- * Sets Firefox-specific options for drivers created by this builder. Any
- * logging or proxy settings defined on the given options will take precedence
- * over those set through {@link #setLoggingPrefs} and {@link #setProxy},
- * respectively.
+ * Sets Firefox specific {@linkplain selenium-webdriver/firefox.Options options}
+ * for drivers created by this builder. Any logging or proxy settings defined
+ * on the given options will take precedence over those set through
+ * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.
  *
  * @param {!firefox.Options} options The FirefoxDriver options to use.
  * @return {!Builder} A self reference.
@@ -288,10 +294,10 @@ Builder.prototype.setFirefoxOptions = function(options) {
 
 
 /**
- * Sets Opera-specific options for drivers created by this builder. Any
- * logging or proxy settings defined on the given options will take precedence
- * over those set through {@link #setLoggingPrefs} and {@link #setProxy},
- * respectively.
+ * Sets Opera specific {@linkplain selenium-webdriver/opera.Options options} for
+ * drivers created by this builder. Any logging or proxy settings defined on the
+ * given options will take precedence over those set through
+ * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.
  *
  * @param {!opera.Options} options The OperaDriver options to use.
  * @return {!Builder} A self reference.
@@ -302,6 +308,36 @@ Builder.prototype.setOperaOptions = function(options) {
 };
 
 
+/**
+ * Sets Internet Explorer specific
+ * {@linkplain selenium-webdriver/ie.Options options} for drivers created by
+ * this builder. Any proxy settings defined on the given options will take
+ * precedence over those set through {@link #setProxy}.
+ *
+ * @param {!ie.Options} options The IEDriver options to use.
+ * @return {!Builder} A self reference.
+ */
+Builder.prototype.setIeOptions = function(options) {
+  this.ieOptions_ = options;
+  return this;
+};
+
+
+/**
+ * Sets Safari specific {@linkplain selenium-webdriver/safari.Options options}
+ * for drivers created by this builder. Any logging settings defined on the
+ * given options will take precedence over those set through
+ * {@link #setLoggingPrefs}.
+ *
+ * @param {!safari.Options} options The Safari options to use.
+ * @return {!Builder} A self reference.
+ */
+Builder.prototype.setSafariOptions = function(options) {
+  this.safariOptions_ = options;
+  return this;
+};
+
+
 /**
  * Sets the control flow that created drivers should execute actions in. If
  * the flow is never set, or is set to {@code null}, it will use the active
@@ -355,9 +391,14 @@ Builder.prototype.build = function() {
   } else if (browser === Browser.FIREFOX && this.firefoxOptions_) {
     capabilities.merge(this.firefoxOptions_.toCapabilities());
 
+  } else if (browser === Browser.INTERNET_EXPLORER && this.ieOptions_) {
+    capabilities.merge(this.ieOptions_.toCapabilities());
+
   } else if (browser === Browser.OPERA && this.operaOptions_) {
     capabilities.merge(this.operaOptions_.toCapabilities());
 
+  } else if (browser === Browser.SAFARI && this.safariOptions_) {
+    capabilities.merge(this.safariOptions_.toCapabilities());
   }
 
   // Check for a remote browser.
@@ -407,6 +448,12 @@ Builder.prototype.build = function() {
       var phantomjs = require('./phantomjs');
       return new phantomjs.Driver(capabilities, this.flow_);
 
+    case Browser.SAFARI:
+      // Requiring 'safari' would create a cycle:
+      // index -> builder -> safari -> index
+      var safari = require('./safari');
+      return new safari.Driver(capabilities, this.flow_);
+
     default:
       throw new Error('Do not know how to build driver: ' + browser
           + '; did you forget to call usingServer(url)?');

javascript/node/selenium-webdriver/io/index.js

@@ -146,6 +146,27 @@ exports.exists = function(path) {
 };
 
 
+/**
+ * Deletes a name from the filesystem and possibly the file it refers to. Has
+ * no effect if the file does not exist.
+ * @param {string} path The path to remove.
+ * @return {!promise.Promise} A promise for when the file has been removed.
+ */
+exports.unlink = function(path) {
+  return new promise.Promise(function(fulfill, reject) {
+    fs.exists(path, function(exists) {
+      if (exists) {
+        fs.unlink(path, function(err) {
+          err && reject(err) || fulfill();
+        });
+      } else {
+        fulfill();
+      }
+    });
+  });
+};
+
+
 /**
  * @return {!promise.Promise.<string>} A promise for the path to a temporary
  *     directory.
@@ -157,12 +178,17 @@ exports.tmpDir = function() {
 
 
 /**
+ * @param {{postfix: string}=} opt_options Temporary file options.
  * @return {!promise.Promise.<string>} A promise for the path to a temporary
  *     file.
  * @see https://www.npmjs.org/package/tmp
  */
-exports.tmpFile = function() {
-  return promise.checkedNodeCall(tmp.file);
+exports.tmpFile = function(opt_options) {
+  // |tmp.file| checks arguments length to detect options rather than doing a
+  // truthy check, so we must only pass options if there are some to pass.
+  return opt_options ?
+      promise.checkedNodeCall(tmp.file, opt_options) :
+      promise.checkedNodeCall(tmp.file);
 };
 
 

javascript/node/selenium-webdriver/lib/test/index.js

@@ -35,7 +35,8 @@ var NATIVE_BROWSERS = [
   webdriver.Browser.FIREFOX,
   webdriver.Browser.IE,
   webdriver.Browser.OPERA,
-  webdriver.Browser.PHANTOM_JS
+  webdriver.Browser.PHANTOM_JS,
+  webdriver.Browser.SAFARI
 ];
 
 
@@ -187,12 +188,18 @@ function suite(fn, opt_options) {
     browsers.forEach(function(browser) {
       testing.describe('[' + browser + ']', function() {
 
-        if (_base.isDevMode() && nativeRun &&
-            browser === webdriver.Browser.FIREFOX) {
-          testing.before(function() {
-            return build.of('//javascript/firefox-driver:webdriver')
-                .onlyOnce().go();
-          });
+        if (_base.isDevMode() && nativeRun) {
+          if (browser === webdriver.Browser.FIREFOX) {
+            testing.before(function() {
+              return build.of('//javascript/firefox-driver:webdriver')
+                  .onlyOnce().go();
+            });
+          } else if (browser === webdriver.Browser.SAFARI) {
+            testing.before(function() {
+              return build.of('//javascript/safari-driver:client')
+                  .onlyOnce().go();
+            });
+          }
         }
 
         var serverToUse = null;

javascript/node/selenium-webdriver/package.json

@@ -25,6 +25,7 @@
     "adm-zip": "0.4.4",
     "rimraf": "^2.2.8",
     "tmp": "0.0.24",
+    "ws": "^0.7.1",
     "xml2js": "0.4.4"
   },
   "devDependencies": {