feat(runner): Add support for async onCleanUp functions

If the onCleanUp function returns a promise, the process will allow it to resolve before exiting. This is useful for performing async operations like writing to a file or calling an API at the end of a test run.

Author: bclinkinbeard

lib/runner.js

@@ -140,8 +140,12 @@ Runner.prototype.loadDriverProvider_ = function() {
  */
 Runner.prototype.exit_ = function(exitCode) {
   if (typeof this.config_.onCleanUp === 'function') {
-    this.config_.onCleanUp(exitCode);
+    var val = this.config_.onCleanUp(exitCode);
+    if (typeof val === 'number' || q.isPromiseAlike(val)) {
+      return val;
+    }
   }
+  return exitCode;
 };
 
 
@@ -277,8 +281,7 @@ Runner.prototype.run = function() {
   }).then(function() {
     var passed = testResult.failedCount === 0;
     var exitCode = passed ? 0 : 1;
-    self.exit_(exitCode);
-    return exitCode;
+    return q.when(self.exit_(exitCode));
   });
 };
 

scripts/test.js

@@ -7,6 +7,9 @@ var scripts = [
   'node lib/cli.js spec/basicConf.js',
   'node lib/cli.js spec/multiConf.js',
   'node lib/cli.js spec/altRootConf.js',
+  'node lib/cli.js spec/onCleanUpAsyncReturnValueConf.js',
+  'node lib/cli.js spec/onCleanUpNoReturnValueConf.js',
+  'node lib/cli.js spec/onCleanUpSyncReturnValueConf.js',
   'node lib/cli.js spec/onPrepareConf.js',
   'node lib/cli.js spec/onPrepareFileConf.js',
   'node lib/cli.js spec/onPreparePromiseConf.js',

spec/onCleanUp/onCleanUp_spec.js

@@ -0,0 +1,5 @@
+describe('onCleanUp function in the config', function() {
+  it('should not be affected by tests', function() {
+    expect(true).toBe(true);
+  });
+});

spec/onCleanUpAsyncReturnValueConf.js

@@ -0,0 +1,23 @@
+var env = require('./environment.js');
+var q = require('q');
+
+// The main suite of Protractor tests.
+exports.config = {
+  seleniumAddress: env.seleniumAddress,
+
+  specs: [
+    'onCleanUp/*_spec.js'
+  ],
+
+  capabilities: env.capabilities,
+
+  baseUrl: env.baseUrl,
+
+  onCleanUp: function(exitCode) {
+    var deferred = q.defer();
+    setTimeout(function () {
+      deferred.resolve(exitCode);
+    }, 500);
+    return deferred.promise;
+  }
+};

spec/onCleanUpNoReturnValueConf.js

@@ -0,0 +1,18 @@
+var env = require('./environment.js');
+
+// The main suite of Protractor tests.
+exports.config = {
+  seleniumAddress: env.seleniumAddress,
+
+  specs: [
+    'onCleanUp/*_spec.js'
+  ],
+
+  capabilities: env.capabilities,
+
+  baseUrl: env.baseUrl,
+
+  onCleanUp: function(exitCode) {
+    // no return
+  }
+};

spec/onCleanUpSyncReturnValueConf.js

@@ -0,0 +1,18 @@
+var env = require('./environment.js');
+
+// The main suite of Protractor tests.
+exports.config = {
+  seleniumAddress: env.seleniumAddress,
+
+  specs: [
+    'onCleanUp/*_spec.js'
+  ],
+
+  capabilities: env.capabilities,
+
+  baseUrl: env.baseUrl,
+
+  onCleanUp: function(exitCode) {
+    return exitCode;
+  }
+};