Added a bunch of improvements to webdriver playback and scheduler including:

Added support for test results server for scheduled tests
Added external plugin support for scheduler
Added support for remote playback for tests using webdriver
Added option for selecting how an existing window is used for webdriver playback
Added close webdriver session toolbar button
Added toolbar button for selecting a common browser for webdriver playback
Improved webdriver playback
Fixed failing gist creation
Fixed counter in health service
Added more health event logging
Changed to secure urls where possible

Author: samitbadle

ide/main/src/content/debugger.js

@@ -27,6 +27,7 @@ function Debugger(editor) {
     }
 
     this.log.debug("init");
+    this.editor.health.addEvent('debugger', 'initializing');
 
     this.setState(Debugger.STOPPED);
 
@@ -129,6 +130,7 @@ function Debugger(editor) {
       }
       return false;
     };
+    this.editor.health.addEvent('debugger', 'initialized');
   }
 }
 
@@ -189,6 +191,11 @@ Debugger.prototype.doContinue = function (step) {
   this.runner.continueCurrentTest();
 };
 
+Debugger.prototype.closeWebDriverSession = function () {
+  this.init();
+  this.runner.closeSession();
+};
+
 Debugger.prototype.showElement = function (locator) {
   this.init();
   this.runner.showElement(locator);

ide/main/src/content/editor.js

@@ -51,6 +51,7 @@ function Editor(window) {
       self.updateExperimentalFeatures(self.app.getBooleanOption('enableExperimentalFeatures'));
       self.updateVisualEye(self.app.getBooleanOption('visualEye'));
       self.health.showAlerts(self.app.getBooleanOption('showHealthAlerts'));
+      self.updateWebdriverBrowser(self.app.options.webDriverBrowserString);
     },
 
     testSuiteChanged: function (testSuite) {
@@ -202,6 +203,12 @@ function Editor(window) {
     }
   }
 
+  // disable webdriver related toolbar buttons if webdriver playback is disabled
+  if ( !this.app.getBooleanOption('executeUsingWebDriver') ) {
+    document.getElementById("browser-button").disabled = true;
+    document.getElementById("close-webdriver-button").disabled = true;
+  }
+
   this.updateViewTabs();
   this.infoPanel = new Editor.InfoPanel(this);
 
@@ -732,10 +739,10 @@ Editor.prototype.submitDiagInfo = function(){
   };
   window.openDialog("chrome://selenium-ide/content/health/diag-info.xul", "diagInfo", "chrome,modal,resizable", data);
   if (data.data.length > 0) {
-    GitHub.createGist("Selenium IDE diagnostic information", data).done(function(url){
+    GitHub.createGistWithFiles("Selenium IDE diagnostic information", data).then(function(url){
       alert("Gist created with diagnostic information.\nPlease update the issue on https://github.com/SeleniumHQ/selenium/issues with this url.\nURL: " + url);
     }, function(response, success, status){
-      alert("Gist creation failed with status " + status + "\nResponse:-\n" + (response || ''));
+      alert("Gist creation failed with status " + status + " and response:-\n" + (response || ''));
     });
   }
 };
@@ -1030,6 +1037,35 @@ Editor.prototype.populateFormatsPopup = function (e, action, format) {
   }
 };
 
+Editor.prototype.setWebdriverBrowser = function (browser) {
+  this.getOptions().webDriverBrowserString = browser;
+  this.updateWebdriverBrowser(browser);
+};
+
+Editor.prototype.updateWebdriverBrowser = function (browser) {
+  var class_name = "";
+  var tooltip = "";
+  if (browser == "firefox") {
+    class_name = "fx";
+    tooltip = "Webdriver playback in Firefox";
+  } else if (browser == "chrome") {
+    class_name = "gc";
+    tooltip = "Webdriver playback in Google Chrome";
+  } else if (browser == "internet explorer") {
+    class_name = "ie";
+    tooltip = "Webdriver playback in Internet Explorer";
+  } else if (browser == "safari") {
+    class_name = "sa";
+    tooltip = "Webdriver playback in Safari";
+  }
+  if ( !this.app.getBooleanOption('executeUsingWebDriver') ) {
+    tooltip = "Webdriver playback is off. Turn it on in the options.";
+  }
+  var btn = document.getElementById("browser-button");
+  btn.setAttribute('class', class_name);
+  btn.setAttribute('tooltiptext', tooltip);
+};
+
 Editor.prototype.updateViewTabs = function () {
   var editorTab = $('editorTab');
   var tabs = $('viewTabs');

ide/main/src/content/file-utils.js

@@ -30,6 +30,11 @@ var FileUtils = {
   getFile: function(path) {
     var file = Components.classes['@mozilla.org/file/local;1'].createInstance(Components.interfaces.nsILocalFile);
     file.initWithPath(path);
+    if (arguments.length > 1) {
+      for (var i = 1; i < arguments.length; i++) {
+        file.append(arguments[i]);
+      }
+    }
     return file;
   },
 

ide/main/src/content/health/health-service.js

@@ -109,7 +109,8 @@ HealthService.prototype.attach = function(win, component) {
       oldOnError: oldOnError
     };
     var self = this;
-    win.onerror = function SIDEErrorHandler(msg, url, line, column, error) {
+    //TODO maybe use an add event listener to not overwrite any existing handlers?
+    win.onerror = function(msg, url, line, column, error) {
       self.addError(component, "UncaughtException", msg, url, line, column, (error && error.stack ? error.stack : null));
       if (self.alerts) {
         try {
@@ -188,6 +189,8 @@ HealthService.prototype.addException = function(component, event, exception) {
 HealthService.prototype.increaseCounter = function(component, counter) {
   if (!this.stats[component]) {
     this.stats[component] = {};
+  }
+  if (!this.stats[component][counter]) {
     this.stats[component][counter] = 0;
   }
   this.stats[component][counter]++;
@@ -231,7 +234,7 @@ HealthService.prototype.getData = function() {
  * Return the collected data
  */
 HealthService.prototype.getJSON = function(pretty) {
-  return JSON.stringify(this.getData(), null, 2);
+  return JSON.stringify(this.getData(), null, pretty ? 2 : null);
 };
 
 /**

ide/main/src/content/optionsDialog.xul

@@ -92,6 +92,11 @@ limitations under the License.
         <checkbox id="enableExperimentalFeatures" label="&options.enableExperimentalFeatures.label;"/>
         <checkbox id="disableFormatChangeMsg" label="&options.disableFormatChangeMsg.label;"/>
         <checkbox id="recordOnOpen" label="&options.recordOnOpen.description;"/>
+        <hbox>
+          <description>Scheduled tests results server</description>
+          <textbox id="jobResultsServer" multiline="false" flex="1"/>
+        </hbox>
+        <description class="tip">URL of server to send test results for scheduled tests</description>
       </tabpanel>
       <tabpanel id="formats" orient="vertical">
         <hbox flex="1">
@@ -154,9 +159,15 @@ limitations under the License.
         <description class="tip">Changes to this option will be applied after an Selenium IDE restart</description>
         <description class="tip">WebDriver playback is still an experimental feature and may not be very stable. Please use it for testing Selenium IDE to provide us feedback.</description>
         <hbox>
+          <description>WebDriver browser string</description>
           <textbox id="webDriverBrowserString" multiline="false" flex="1"/>
         </hbox>
         <description class="tip">Browser choices: android, chrome, firefox, htmlunit, internet explorer, iPhone, iPad</description>
+        <hbox>
+          <description>Selenium server</description>
+          <textbox id="webDriverServer" multiline="false" flex="1"/>
+        </hbox>
+        <description class="tip">Protocol, host and port where your Selenium server is running, e.g. http://localhost:4444</description>
         <label class="text-link" href="http://blog.reallysimplethoughts.com/?p=561" value="How to use WebDriver playback?" />
       </tabpanel>
     </tabpanels>

ide/main/src/content/preferences.js

@@ -155,6 +155,8 @@ SeleniumIDE.Preferences.DEFAULT_OPTIONS = {
   timeout: "30000",
   executeUsingWebDriver: "false",
   webDriverBrowserString: "firefox",
+  webDriverReuseWindow: "always",
+  webDriverServer: "http://localhost:4444",  // Only protocol, host and port portion
 
   //Scheduler related options
   jobResultsServer: 'http://localhost:3000/api/result',

ide/main/src/content/scheduler/scheduler-selenium.js

@@ -17,6 +17,7 @@
  */
 
 function SeleniumScheduler(editor) {
+  this.editor = editor;
   var jobRunner = new JobRunner(editor);
   this.scheduler = Scheduler.fromData(FileUtils.readJSONStoredFile('scheduler.json', []), function(job) {
     jobRunner.run(job);
@@ -27,8 +28,13 @@ function SeleniumScheduler(editor) {
   this.schedulerMemoryWatcher = new MemoryWatcher(editor, this, jobRunner);
   this.jobRunnerWatchDog = new JobRunnerWatchDog(editor, this, jobRunner);
   //TODO plugins, plugin dependency
+  this.plugins = {};
 }
 
+SeleniumScheduler.prototype.addPlugin = function(id, ctorFn) {
+  this.plugins[id] = ctorFn(this.editor, this, this.jobRunner);
+};
+
 function JobRunner(editor) {
   this.editor = editor;
   this.job = null;
@@ -60,9 +66,11 @@ JobRunner.prototype.run = function(job) {
   if (job.action && job.action.suite && job.action.suite.length > 0) {
     this.editor.app.loadTestCaseWithNewSuite(job.action.suite);
   }
+  var resultsFolder = FileUtils.getStoredTimeStampedFile('job_results');
+  resultsFolder.append(FileUtils.getSafeFilename(job.title));
   //The following code is out of the above if block as it is a feature. Allow scheduling the currently open test suite if no suite is specified in the job
   //TODO check if it really loaded!
-  this.notify('jobStarting', job);
+  this.notify('jobStarting', job, resultsFolder.path);
   this.editor.playTestSuite();
 };
 
@@ -113,20 +121,30 @@ SaveHTMLResults.prototype.getFolder = function() {
 
 function PostResults(editor, seleniumScheduler, jobRunner) {
   this.editor = editor;
-  this.dispatcher = new Dispatcher(null, editor.app.options.jobResultsServer);
+  this.server = "http://localhost:3000/api/result";
+  this.dispatcher = new Dispatcher(null, this.server);
   var self = this;
   if (jobRunner) {
     jobRunner.addObserver({
       jobComplete: function (job, result) {
-        var testSuite = self.editor.app.getTestSuite();
-        var data = {
-          title: job.title,
-          schedule: job.schedule.getData(),
-          scheduledTime: job.nextRun.getTime(),
-          startTime: job.startTime.getTime(),
-          suite: testSuite.result()
-        };
-        self.dispatcher.send(data);
+        var server = self.editor.app.options.jobResultsServer || "";
+        server = server.trim();
+        if (server.length > 0) {  // set server to an empty string to turn off sending results
+          if (server != self.server) {
+            self.server = server;
+            self.dispatcher.setServer(server);
+          }
+          self.editor.health.addEvent('postResults', 'sending results to ' + self.server);
+          var testSuite = self.editor.app.getTestSuite();
+          var data = {
+            title: job.title,
+            schedule: job.schedule.getData(),
+            scheduledTime: job.nextRun.getTime(),
+            startTime: job.startTime.getTime(),
+            suite: testSuite.result()
+          };
+          self.dispatcher.send(data);
+        }
       }
     });
   }

ide/main/src/content/selenium-ide-common.xul

@@ -217,6 +217,8 @@ limitations under the License.
       <menuitem label="&speedSliderFaster.label;" command="cmd_selenium_speed_faster" accesskey="-"/>
       <menuitem label="&speedSliderSlower.label;" command="cmd_selenium_speed_slower" accesskey="+"/>
       <menuitem label="&speedSliderSlowest.label;" command="cmd_selenium_speed_slowest" accesskey="9"/>
+      <menuseparator/>
+      <menuitem label="Close webdriver session" oncommand="window.editor.selDebugger.closeWebDriverSession()"/>
     </menupopup>
   </menu>
   <menu id="optionsMenu" label="&optionsMenu.label;" accesskey="O">
@@ -251,7 +253,7 @@ limitations under the License.
       <menuitem label="&helpSubmitDiagInfo.label;" oncommand="window.editor.submitDiagInfo();"/>
       <menuseparator/>
       <menuitem label="&helpReleaseNotes.label;" oncommand="openTabOrWindow('https://github.com/SeleniumHQ/selenium/wiki/SeIDE-Release-Notes')"/>
-      <menuitem label="&helpBlog.label;" oncommand="openTabOrWindow('http://seleniumhq.wordpress.com/')"/>
+      <menuitem label="&helpBlog.label;" oncommand="openTabOrWindow('https://seleniumhq.wordpress.com/')"/>
       <menuitem label="&helpWebsite.label;" oncommand="openTabOrWindow('http://seleniumhq.org/')"/>
     </menupopup>
   </menu>
@@ -276,6 +278,15 @@ limitations under the License.
       </stack>
     </vbox>
   </stack>
+
+  <toolbarbutton id="browser-button" type="menu-button" label="WebDriver" class="toolbar2 toolbarbutton-1" tooltiptext="Webdriver playback is off. Turn on in the options.">
+    <menupopup id="webdriverPopup">
+      <menuitem label="Firefox" value="firefox" oncommand="window.editor.setWebdriverBrowser(event.target.getAttribute('value'));" />
+      <menuitem label="Google Chrome" value="chrome" oncommand="window.editor.setWebdriverBrowser(event.target.getAttribute('value'));" />
+      <menuitem label="Internet Explorer" value="internet explorer" oncommand="window.editor.setWebdriverBrowser(event.target.getAttribute('value'));" />
+      <menuitem label="Safari" value="safari" oncommand="window.editor.setWebdriverBrowser(event.target.getAttribute('value'));" />
+    </menupopup>
+  </toolbarbutton>
   <toolbarbutton id="schedule-button" type="menu-button" label="Scheduler" class="toolbar2 toolbarbutton-1" tooltiptext="Click to turn scheduler on" command="cmd_selenium_schedule">
     <menupopup id="schedulerPopup">
       <menuitem label="Play test suites periodically" oncommand="window.editor.openSeleniumIDEScheduler(event);" />

ide/main/src/content/selenium-ide.xul

@@ -82,6 +82,9 @@ limitations under the License.
       <toolbarseparator/>
       <toolbarbutton id="rollup-button" label="Rollup" class="icon" tooltiptext="&rollupButton.tooltip;" command="cmd_selenium_rollup"/>
       <toolbarbutton id="reload-button" label="Reload" class="icon" tooltiptext="&reloadExtButton.tooltip;" command="cmd_selenium_reload" hidden="true"/>
+      <toolbarseparator/>
+      <toolbarbutton id="browser-button"/>
+      <toolbarbutton id="close-webdriver-button" label="Close Webdriver" class="toolbar2 toolbarbutton-1" tooltiptext="Close Webdriver session to the Selenium Server" oncommand="window.editor.selDebugger.closeWebDriverSession()"/>
       <toolbarspacer flex="1"/>
       <toolbarbutton id="schedule-button"/>
       <toolbarbutton id="record-button" label="Record" class="icon" tooltiptext="&recordButton.tooltip;" checked="true" command="cmd_selenium_record"/>

ide/main/src/content/selenium-runner.js

@@ -400,7 +400,9 @@ function start(baseURL, handler, useLastWindow) {
   //Samit: use the web driver backed selenium
   if (this.executeUsingWebDriver) {
     var webDriverBrowserString = this.editor.getOptions().webDriverBrowserString;
-    selenium = new WebdriverBackedSelenium(baseURL, webDriverBrowserString);
+    var reuseBrowser = this.editor.getOptions().webDriverReuseWindow;
+    var server = this.editor.getOptions().webDriverServer;
+    selenium = new WebdriverBackedSelenium(baseURL, useLastWindow, webDriverBrowserString, reuseBrowser, server);
   } else {
     selenium = createSelenium(baseURL, useLastWindow);
     selenium.browserbot.selectWindow(null);
@@ -419,6 +421,13 @@ function start(baseURL, handler, useLastWindow) {
   //setState(Debugger.PLAYING);
 }
 
+function closeSession() {
+  //Samit: If we are using the web driver backed selenium, close the session
+  if (this.executeUsingWebDriver && WebdriverBackedSelenium && WebdriverBackedSelenium.closeWebdriverSession) {
+    WebdriverBackedSelenium.closeWebdriverSession();
+  }
+}
+
 function executeCommand(baseURL, command) {
   //if (!stopAndDo("executeCommand", baseURL, command)) return;
   resetCurrentTest();

ide/main/src/content/utils/dispatcher.js

@@ -22,6 +22,12 @@ function Dispatcher(queuePath, server) {
   this.queuePath = queuePath;
 }
 
+
+Dispatcher.prototype.setServer = function(server) {
+  this.server = server;
+};
+
+
 Dispatcher.prototype.send = function(data) {
   return HTTP.post(this.server, data);
   // TODO convert and persist in queue

ide/main/src/content/utils/gist.js

@@ -55,7 +55,7 @@ GitHub.createGistWithFiles = function(description, files) {
   };
   return new Deferred(function(deferred) {
     HTTP.post('https://api.github.com/gists', data, {}, function(response, success, status) {
-      if (status == 201 && response) {
+      if (response && (status == "201")) {
         var result = JSON.parse(response);
         if (result.html_url) {
           deferred.resolve(result.html_url);

ide/main/src/content/utils/http.js

@@ -56,14 +56,15 @@ HTTP.request = function(method, url, data, headers, callback) {
         } else if (httpRequest.status === 500 ) {
           callback(httpRequest.responseText, false, httpRequest.status);
         } else {
+          callback(httpRequest.responseText, false, httpRequest.status);
           //TODO eliminate alert and signal the failure
 //          alert('There was a problem with the request.\nUrl: ' + url + '\nHttp Status: ' + httpRequest.status + "\nResponse: " + httpRequest.responseText);
           LOG.debug('Error: There was a problem with the request.\nUrl: ' + url + '\nHttp Status: ' + httpRequest.status + "\nResponse: " + httpRequest.responseText);
-          callback(null, false, httpRequest.status);
         }
       }
     } catch(e) {
       //TODO eliminate alert and signal the failure, typically when callback is not given and Deferred is not loaded
+      //LOG.error('Error: There was a problem with the request.\nUrl: ' + url + '\nHttp Status: ' + httpRequest.status + "\nResponse: " + httpRequest.responseText);
       alert('Caught Exception in HTTP.request: ' + e);
       throw e;
     }
@@ -114,3 +115,16 @@ HTTP.get = function (url, headers, callback) {
   return this.request('GET', url, null, headers, callback);
 };
 
+/**
+ * Shortcut method to create HTTP DELETE requests. See HTTP.request() for more details.
+ *
+ * @param url
+ * @param {Object.<string, string>} [headers] hash with keys containing header names and values containing its value
+ * @param {function(string, string, string)} [callback] a callback function that takes response, success, status. If callback is not given,
+ * a deferred object is created. If deferred.js is not loaded, an exception occurs.
+ * @returns {Deferred} if a deferred has been created
+ */
+HTTP._delete = function (url, headers, callback) {
+  return this.request('DELETE', url, null, headers, callback);
+};
+