[js] The FirefoxDriver should clean-up after itself on quit

Fixes issue 8380.

Author: jleyba

javascript/node/selenium-webdriver/CHANGES.md

@@ -3,6 +3,7 @@
 * Promise rejections are now always coerced to Error-like objects (an object
     with a string `message` property). We do not guarantee `instanceof Error`
     since the rejection value may come from another context.
+* FIXED: 8380: `firefox.Driver` will delete its temporary profile on `quit`.
 * FIXED: 8221: Added support for defining custom command mappings. Includes
     support for PhantomJS's `executePhantomJS` (requires PhantomJS 1.9.7 or
     GhostDriver 1.1.0).

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

@@ -24,6 +24,7 @@ var Binary = require('./binary').Binary,
     webdriver = require('..'),
     executors = require('../executors'),
     httpUtil = require('../http/util'),
+    io = require('../io'),
     net = require('../net'),
     portprober = require('../net/portprober');
 
@@ -156,6 +157,10 @@ var Driver = function(opt_config, opt_flow) {
   caps.set('firefox_binary', null);
   caps.set('firefox_profile', null);
 
+  /** @private {?string} */
+  this.profilePath_ = null;
+
+  var self = this;
   var serverUrl = portprober.findFreePort().then(function(port) {
     var prepareProfile;
     if (typeof profile === 'string') {
@@ -170,6 +175,7 @@ var Driver = function(opt_config, opt_flow) {
     }
 
     return prepareProfile.then(function(dir) {
+      self.profilePath_ = dir;
       return binary.launch(dir);
     }).then(function() {
       var serverUrl = url.format({
@@ -193,6 +199,19 @@ var Driver = function(opt_config, opt_flow) {
 util.inherits(Driver, webdriver.WebDriver);
 
 
+/** @override */
+Driver.prototype.quit = function() {
+  return this.call(function() {
+    var self = this;
+    return Driver.super_.prototype.quit.call(this).thenFinally(function() {
+      if (self.profilePath_) {
+        return io.rmDir(self.profilePath_);
+      }
+    });
+  }, this);
+};
+
+
 // PUBLIC API
 
 

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

@@ -15,6 +15,7 @@
 
 var fs = require('fs'),
     path = require('path'),
+    rimraf = require('rimraf'),
     tmp = require('tmp');
 
 var promise = require('..').promise;
@@ -27,6 +28,26 @@ var PATH_SEPARATOR = process.platform === 'win32' ? ';' : ':';
 
 
 
+/**
+ * Recursively removes a directory and all of its contents. This is equivalent
+ * to {@code rm -rf} on a POSIX system.
+ * @param {string} path Path to the directory to remove.
+ * @return {!promise.Promise} A promise to be resolved when the operation has
+ *     completed.
+ */
+exports.rmDir = function(path) {
+  return new promise.Promise(function(fulfill, reject) {
+    rimraf(path, function(err) {
+      if (err) {
+        reject(err);
+      } else {
+        fulfill();
+      }
+    });
+  });
+};
+
+
 /**
  * Copies one file to another.
  * @param {string} src The source file.

javascript/node/selenium-webdriver/package.json

@@ -1,35 +1,36 @@
 {
-    "name": "selenium-webdriver",
-    "version": "2.45.0-dev",
-    "description": "The official WebDriver JavaScript bindings from the Selenium project",
-    "keywords": [
-        "automation",
-        "selenium",
-        "testing",
-        "webdriver",
-        "webdriverjs"
-    ],
-    "homepage": "https://code.google.com/p/selenium/",
-    "bugs": {
-        "url": "https://code.google.com/p/selenium/issues/list"
-    },
-    "main": "./index",
-    "repository": {
-        "type": "git",
-        "url": "https://code.google.com/p/selenium/"
-    },
-    "engines": {
-        "node": ">= 0.8.x"
-    },
-    "dependencies": {
-        "adm-zip": "0.4.4",
-        "tmp": "0.0.24",
-        "xml2js": "0.4.4"
-    },
-    "devDependencies" : {
-        "mocha" : ">= 1.21.x"
-    },
-    "scripts": {
-        "test": "node_modules/.bin/mocha --harmony -t 600000 --recursive test"
-    }
+  "name": "selenium-webdriver",
+  "version": "2.45.0-dev",
+  "description": "The official WebDriver JavaScript bindings from the Selenium project",
+  "keywords": [
+    "automation",
+    "selenium",
+    "testing",
+    "webdriver",
+    "webdriverjs"
+  ],
+  "homepage": "https://code.google.com/p/selenium/",
+  "bugs": {
+    "url": "https://code.google.com/p/selenium/issues/list"
+  },
+  "main": "./index",
+  "repository": {
+    "type": "git",
+    "url": "https://code.google.com/p/selenium/"
+  },
+  "engines": {
+    "node": ">= 0.8.x"
+  },
+  "dependencies": {
+    "adm-zip": "0.4.4",
+    "rimraf": "^2.2.8",
+    "tmp": "0.0.24",
+    "xml2js": "0.4.4"
+  },
+  "devDependencies": {
+    "mocha": ">= 1.21.x"
+  },
+  "scripts": {
+    "test": "node_modules/.bin/mocha --harmony -t 600000 --recursive test"
+  }
 }

javascript/node/selenium-webdriver/test/firefox/firefox_test.js

@@ -18,6 +18,7 @@
 var path = require('path');
 
 var firefox = require('../../firefox'),
+    io = require('../../io'),
     test = require('../../lib/test'),
     assert = require('../../testing/assert');
 
@@ -120,5 +121,36 @@ test.suite(function(env) {
         }, 3000);
       }
     });
+
+    describe('profile management', function() {
+      var driver;
+
+      test.beforeEach(function() {
+        driver = null;
+      });
+
+      test.afterEach(function() {
+        if (driver) {
+          driver.quit();
+        }
+      });
+
+      test.it('deletes the temp profile on quit', function() {
+        driver = env.builder().build();
+
+        var profilePath = driver.call(function() {
+          var path = driver.profilePath_;
+          assert(io.exists(path)).isTrue();
+          return path;
+        });
+
+        return driver.quit().then(function() {
+          driver = null;
+          return profilePath;
+        }).then(function(path) {
+          assert(io.exists(path)).isFalse();
+        });
+      });
+    });
   });
 }, {browsers: ['firefox']});

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

@@ -174,4 +174,26 @@ describe('io', function() {
       });
     });
   });
+
+  describe('rmDir', function() {
+    it('succeeds if the designated directory does not exist', function() {
+      return io.tmpDir().then(function(d) {
+        return io.rmDir(path.join(d, 'i/do/not/exist'));
+      });
+    });
+
+    it('deletes recursively', function() {
+      return io.tmpDir().then(function(dir) {
+        fs.writeFileSync(path.join(dir, 'file1'), 'hello');
+        fs.mkdirSync(path.join(dir, 'sub'));
+        fs.mkdirSync(path.join(dir, 'sub/folder'));
+        fs.writeFileSync(path.join(dir, 'sub/folder/file2'), 'goodbye');
+
+        return io.rmDir(dir).then(function() {
+          assert.ok(!fs.existsSync(dir));
+          assert.ok(!fs.existsSync(path.join(dir, 'sub/folder/file2')));
+        });
+      });
+    });
+  });
 });