fix(launcher): allow afterLaunch to run async scripts

Author: hankduan

Diff for: docs/referenceConf.js

@@ -184,8 +184,7 @@ exports.config = {
   // A callback function called once all tests have finished running and
   // the WebDriver instance has been shut down. It is passed the exit code
   // (0 if the tests passed). This is called only once before the program
-  // exits (after onCleanUp). The program will exit after this event loop,
-  // so this must perform only synchronous operations.
+  // exits (after onCleanUp).
   afterLaunch: function() {},
 
   // The params object will be passed directly to the Protractor instance,

Diff for: lib/launcher.js

@@ -7,7 +7,8 @@
 var child = require('child_process'),
     ConfigParser = require('./configParser'),
     TaskScheduler = require('./taskScheduler'),
-    helper = require('./util');
+    helper = require('./util'),
+    q = require('q');
 
 var launcherPrefix = '[launcher]';
 var RUNNERS_FAILED_EXIT_CODE = 100;
@@ -133,13 +134,23 @@ var init = function(configFile, additionalConfig) {
   };
 
   var cleanUpAndExit = function(exitCode) {
-    helper.runFilenameOrFn_(config.configDir, config.afterLaunch, [exitCode]);
-    process.exit(exitCode);
+    return helper.runFilenameOrFn_(
+        config.configDir, config.afterLaunch, [exitCode]).
+          then(function(returned) {
+            if (typeof returned === 'number') {
+              process.exit(returned);
+            } else {
+              process.exit(exitCode);
+            }
+          }, function(err) {
+            log_('Error:', err);
+            process.exit(1);
+          });
   };
 
   helper.runFilenameOrFn_(config.configDir, config.beforeLaunch).then(function() {
     // Don't start new process if there is only 1 task.
-    var totalTasks = scheduler.numTasksRemaining(); 
+    var totalTasks = scheduler.numTasksOutstanding(); 
     if (totalTasks === 1) {
       var Runner = require('./runner');
       var task = scheduler.nextTask();
@@ -158,13 +169,17 @@ var init = function(configFile, additionalConfig) {
         throw new Error('Cannot run in debug mode with ' + 
           'multiCapabilities, count > 1, or sharding');
       }
+      var deferred = q.defer();
       for (var i = 0; i < scheduler.maxConcurrentTasks(); ++i) {
         var createNextRunnerFork = function() {
           var task = scheduler.nextTask();
           if (task) {
             var done = function() {
               task.done();
               createNextRunnerFork();
+              if (scheduler.numTasksOutstanding() === 0) {
+                deferred.fulfill();
+              }
             };
             var runnerFork = new RunnerFork(task);
             runnerFork.addEventHandlers(done);
@@ -175,21 +190,26 @@ var init = function(configFile, additionalConfig) {
       }
       log_('Running ' + scheduler.countActiveTasks() + ' instances of WebDriver');
 
+      deferred.promise.then(function() {
+        reporter.reportSummary();
+        var exitCode = 0;
+        if (runnerErrorCount > 0) {
+          exitCode = RUNNERS_FAILED_EXIT_CODE;
+        }
+        return cleanUpAndExit(exitCode);
+      });
+
       process.on('exit', function(code) {
-        if (code) {
+
+        if (code && code != RUNNERS_FAILED_EXIT_CODE) {
           log_('Process exited with error code ' + code);
-          cleanUpAndExit(code);
-        } else if (runnerErrorCount > 0) {
-          reporter.reportSummary();
-          cleanUpAndExit(RUNNERS_FAILED_EXIT_CODE);
-        } else {
-          if (scheduler.numTasksRemaining() > 0) {
-            throw new Error('BUG: launcher exited with ' + 
-                scheduler.numTasksRemaining() + ' tasks remaining');
-          }
-          reporter.reportSummary();
-          cleanUpAndExit(0);
+        } else if (!code && 
+            scheduler.numTasksOutstanding() > 0) {
+              code = 1;
+              log_('BUG: launcher exited with ' + 
+                scheduler.numTasksOutstanding() + ' tasks remaining');
         }
+        process.exit(code);
       });
     }
   }).done();

Diff for: lib/runner.js

@@ -107,14 +107,15 @@ Runner.prototype.loadDriverProvider_ = function() {
  * @param {int} Standard unix exit code
  */
 Runner.prototype.exit_ = function(exitCode) {
-  helper.runFilenameOrFn_(this.config_.configDir, this.config_.onCleanUp, [exitCode]).
-      then(function(returned) {
-        if (typeof returned === 'number') {
-          return returned;
-        } else {
-          return exitCode;
-        }
-      });
+  return helper.runFilenameOrFn_(
+      this.config_.configDir, this.config_.onCleanUp, [exitCode]).
+        then(function(returned) {
+          if (typeof returned === 'number') {
+            return returned;
+          } else {
+            return exitCode;
+          }
+        });
 };
 
 

Diff for: lib/taskScheduler.js

@@ -130,14 +130,14 @@ TaskScheduler.prototype.nextTask = function() {
 };
 
 /**
- * Get the number of tasks left to run.
+ * Get the number of tasks left to run or are currently running.
  *
  * @return {number}
  */
-TaskScheduler.prototype.numTasksRemaining = function() {
+TaskScheduler.prototype.numTasksOutstanding = function() {
   var count = 0; 
   this.taskQueues.forEach(function(queue) {
-    count += (queue.specLists.length - queue.specsIndex);
+    count += queue.numRunningInstances + (queue.specLists.length - queue.specsIndex);
   });
   return count; 
 };

Diff for: spec/unit/taskScheduler_test.js

@@ -20,7 +20,8 @@ describe('the task scheduler', function() {
     expect(task.capability.browserName).toEqual('chrome');
     expect(task.specs.length).toEqual(2);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should schedule single capability tests with sharding', function() {
@@ -46,7 +47,9 @@ describe('the task scheduler', function() {
     expect(task2.capability.browserName).toEqual('chrome');
     expect(task2.specs.length).toEqual(1);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task1.done();
+    task2.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should schedule single capability tests with count', function() {
@@ -71,7 +74,9 @@ describe('the task scheduler', function() {
     expect(task2.capability.browserName).toEqual('chrome');
     expect(task2.specs.length).toEqual(2);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task1.done();
+    task2.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should schedule multiCapabilities tests', function() {
@@ -97,7 +102,9 @@ describe('the task scheduler', function() {
     expect(task2.capability.browserName).toEqual('firefox');
     expect(task2.specs.length).toEqual(2);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task1.done();
+    task2.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should obey maxInstances', function() {
@@ -121,14 +128,16 @@ describe('the task scheduler', function() {
 
     var task2 = scheduler.nextTask();
     expect(task2).toBeNull();
-    expect(scheduler.numTasksRemaining()).toEqual(1);
-    
+
     task1.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(1);
+    
     var task3 = scheduler.nextTask();
     expect(task3.capability.browserName).toEqual('chrome');
     expect(task3.specs.length).toEqual(1);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task3.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should allow capability-specific specs', function() {
@@ -149,7 +158,8 @@ describe('the task scheduler', function() {
     expect(task.capability.browserName).toEqual('chrome');
     expect(task.specs.length).toEqual(3);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should handle multiCapabilities with mixture of features', function() {
@@ -202,7 +212,7 @@ describe('the task scheduler', function() {
     expect(task6.specs.length).toEqual(1);
     task6.done();
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should default to chrome when no capability is defined', function() {
@@ -219,7 +229,8 @@ describe('the task scheduler', function() {
     expect(task.capability.browserName).toEqual('chrome');
     expect(task.specs.length).toEqual(2);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
   it('should exclude capability-specific specs', function() {
@@ -240,7 +251,8 @@ describe('the task scheduler', function() {
     expect(task.capability.browserName).toEqual('chrome');
     expect(task.specs.length).toEqual(1);
 
-    expect(scheduler.numTasksRemaining()).toEqual(0);
+    task.done();
+    expect(scheduler.numTasksOutstanding()).toEqual(0);
   });
 
 });