Add support for file uploads to webdriverjs

Author: jleyba

javascript/node/selenium-webdriver/CHANGES.md

@@ -55,6 +55,9 @@
     necessary, so they have been made no-ops.
 * `WebDriver.wait()` may now be used to wait for a promise to resolve, with
     an optional timeout. Refer to the API documentation for more information.
+* Added support for copying files to a remote Selenium via `sendKeys` to test
+    file uploads. Refer to the API documentation for more information. Sample
+    usage included in `test/upload_test.js`
 * FIXED: 8380: `firefox.Driver` will delete its temporary profile on `quit`.
 * FIXED: 8306: Stack overflow in promise callbacks eliminated.
 * FIXED: 8221: Added support for defining custom command mappings. Includes

javascript/node/selenium-webdriver/chrome.js

@@ -502,6 +502,15 @@ var Driver = function(opt_config, opt_service, opt_flow) {
 util.inherits(Driver, webdriver.WebDriver);
 
 
+/**
+ * This function is a no-op as file detectors are not supported by this
+ * implementation.
+ * @override
+ */
+Driver.prototype.setFileDetector = function() {
+};
+
+
 // PUBLIC API
 
 

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

@@ -199,6 +199,15 @@ var Driver = function(opt_config, opt_flow) {
 util.inherits(Driver, webdriver.WebDriver);
 
 
+/**
+ * This function is a no-op as file detectors are not supported by this
+ * implementation.
+ * @override
+ */
+Driver.prototype.setFileDetector = function() {
+};
+
+
 /** @override */
 Driver.prototype.quit = function() {
   return this.call(function() {

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

@@ -184,7 +184,7 @@ function suite(fn, opt_options) {
 
         if (!!serverJar && !remoteUrl) {
           if (!(serverToUse = seleniumServer)) {
-            serverToUse = seleniumServer = new remote.SeleniumServer();
+            serverToUse = seleniumServer = new remote.SeleniumServer(serverJar);
           }
 
           testing.before(function() {

javascript/node/selenium-webdriver/phantomjs.js

@@ -214,6 +214,15 @@ var Driver = function(opt_capabilities, opt_flow) {
 util.inherits(Driver, webdriver.WebDriver);
 
 
+/**
+ * This function is a no-op as file detectors are not supported by this
+ * implementation.
+ * @override
+ */
+Driver.prototype.setFileDetector = function() {
+};
+
+
 /**
  * Executes a PhantomJS fragment. This method is similar to
  * {@link #executeScript}, except it exposes the

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

@@ -14,11 +14,15 @@
 
 'use strict';
 
-var path = require('path'),
+var AdmZip = require('adm-zip'),
+    fs = require('fs'),
+    path = require('path'),
     url = require('url'),
     util = require('util');
 
-var promise = require('../').promise,
+var _base = require('../_base'),
+    webdriver = require('../'),
+    promise = require('../').promise,
     httpUtil = require('../http/util'),
     exec = require('../io/exec'),
     net = require('../net'),
@@ -305,7 +309,40 @@ util.inherits(SeleniumServer, DriverService);
 SeleniumServer.Options;
 
 
+
+/**
+ * @constructor
+ * @extends {webdriver.FileDetector}
+ * @final
+ */
+var FileDetector = function() {};
+util.inherits(_base.require('webdriver.FileDetector'), FileDetector);
+
+
+/** @override */
+FileDetector.prototype.handleFile = function(driver, filePath) {
+  return promise.checkedNodeCall(fs.stat, filePath).then(function(stats) {
+    if (stats.isDirectory()) {
+      throw TypeError('Uploading directories is not supported: ' + filePath);
+    }
+
+    var zip = new AdmZip();
+    zip.addLocalFile(filePath);
+
+    var command = new webdriver.Command(webdriver.CommandName.UPLOAD_FILE)
+        .setParameter('file', zip.toBuffer().toString('base64'));
+    return driver.schedule(command,
+        'remote.FileDetector.handleFile(' + filePath + ')');
+  }, function(err) {
+    if (err.code === 'ENOENT') {
+      return filePath;  // Not a file; return original input.
+    }
+    throw err;
+  });
+};
+
 // PUBLIC API
 
 exports.DriverService = DriverService;
+exports.FileDetector = FileDetector;
 exports.SeleniumServer = SeleniumServer;

javascript/node/selenium-webdriver/test/upload_test.js

@@ -0,0 +1,77 @@
+// Copyright 2015 Selenium committers
+// Copyright 2015 Software Freedom Conservancy
+//
+// Licensed 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';
+
+var fs = require('fs');
+
+var Browser = require('..').Browser,
+    By = require('..').By,
+    until = require('..').until,
+    io = require('../io'),
+    remote = require('../remote'),
+    assert = require('../testing/assert'),
+    test = require('../lib/test'),
+    Pages = test.Pages;
+
+test.suite(function(env) {
+  var LOREM_IPSUM_TEXT = 'lorem ipsum dolor sit amet';
+  var FILE_HTML = '<!DOCTYPE html><div>' + LOREM_IPSUM_TEXT + '</div>';
+
+  var fp;
+  test.before(function() {
+    return fp = io.tmpFile().then(function(fp) {
+      fs.writeFileSync(fp, FILE_HTML);
+      return fp;
+    });
+  })
+
+  var driver;
+  test.before(function() {
+    driver = env.builder().build();
+  });
+
+  test.after(function() {
+    driver.quit();
+  });
+
+  test.ignore(env.browsers(
+      Browser.IPAD, Browser.IPHONE,
+      Browser.OPERA, Browser.SAFARI)).
+  it('can upload files', function() {
+    driver.setFileDetector(new remote.FileDetector);
+
+    driver.get(Pages.uploadPage);
+
+    var fp = driver.call(function() {
+      return io.tmpFile().then(function(fp) {
+        fs.writeFileSync(fp, FILE_HTML);
+        return fp;
+      });
+    });
+
+    driver.findElement(By.id('upload')).sendKeys(fp);
+    driver.findElement(By.id('go')).submit();
+
+    // Uploading files across a network may take a while, even if they're small.
+    var label = driver.findElement(By.id('upload_label'));
+    driver.wait(until.elementIsNotVisible(label),
+        10 * 1000, 'File took longer than 10 seconds to upload!');
+
+    driver.switchTo().frame('upload_target');
+    assert(driver.findElement(By.css('body')).getText())
+        .equalTo(LOREM_IPSUM_TEXT);
+  });
+});

javascript/webdriver/command.js

@@ -216,7 +216,10 @@ webdriver.CommandName = {
 
   GET_AVAILABLE_LOG_TYPES: 'getAvailableLogTypes',
   GET_LOG: 'getLog',
-  GET_SESSION_LOGS: 'getSessionLogs'
+  GET_SESSION_LOGS: 'getSessionLogs',
+
+  // Non-standard commands used by the standalone Selenium server.
+  UPLOAD_FILE: 'uploadFile'
 };
 
 

javascript/webdriver/http/http.js

@@ -318,6 +318,7 @@ webdriver.http.Executor.COMMAND_MAP_ = (function() {
       put(webdriver.CommandName.GET_AVAILABLE_LOG_TYPES,
           get('/session/:sessionId/log/types')).
       put(webdriver.CommandName.GET_SESSION_LOGS, post('/logs')).
+      put(webdriver.CommandName.UPLOAD_FILE, post('/session/:sessionId/file')).
       build();
 
   /** @constructor */

javascript/webdriver/test/webdriver_test.js

@@ -24,6 +24,7 @@ goog.require('webdriver.Capabilities');
 goog.require('webdriver.Command');
 goog.require('webdriver.CommandExecutor');
 goog.require('webdriver.CommandName');
+goog.require('webdriver.FileDetector');
 goog.require('webdriver.WebDriver');
 goog.require('webdriver.Serializable');
 goog.require('webdriver.Session');
@@ -1945,6 +1946,29 @@ function testSendKeysConvertsVarArgsIntoStrings_promisedArgs() {
   return waitForIdle();
 }
 
+
+function testSendKeysWithAFileDetector() {
+  var testHelper = new TestHelper().
+      expect(CName.FIND_ELEMENT, {'using':'id', 'value':'foo'}).
+          andReturnSuccess({'ELEMENT':'one'}).
+      expect(CName.SEND_KEYS_TO_ELEMENT, {'id':{'ELEMENT':'one'},
+                                          'value':['modified/path']}).
+          andReturnSuccess().
+      replayAll();
+
+  var driver = testHelper.createDriver();
+
+  var mockDetector = mockControl.createStrictMock(webdriver.FileDetector);
+  mockDetector.handleFile(driver, 'original/path').
+      $returns(webdriver.promise.fulfilled('modified/path'));
+  mockDetector.$replay();
+
+  driver.setFileDetector(mockDetector);
+
+  var element = driver.findElement(By.id('foo'));
+  element.sendKeys('original/', 'path');
+}
+
 function testElementEquality_isReflexive() {
   var a = new webdriver.WebElement(STUB_DRIVER, 'foo');
   return webdriver.WebElement.equals(a, a).then(assertTrue);