Fixed nightwatchjs#745 - properly clearing the command queue when an …

…assertion fails

examples/tests/github.js

@@ -3,7 +3,7 @@ module.exports = {
   'Demo test GitHub' : function (client) {
     client
       .url('https://github.com/nightwatchjs/nightwatch')
-      .waitForElementVisible('xbody', 1000)
+      .waitForElementVisible('body', 1000)
       .assert.title('nightwatchjs/nightwatch · GitHub')
       .assert.visible('.container h1 strong a')
       .assert.containsText('.container h1 strong a', 'nightwatch', 'Checking project title is set to nightwatch');

examples/unittests/testUtilsWithChai.js

@@ -14,7 +14,7 @@ module.exports = {
 
   testFormatElapsedTimeMore : function(client) {
     var resultMs = Utils.formatElapsedTime(999);
-    expect(resultMs).to.equal('999msx');
+    expect(resultMs).to.equal('999ms');
   },
 
   testMakeFnAsync : function(client) {

lib/core/assertion.js

@@ -254,7 +254,7 @@ module.exports = new (function() {
     });
 
     if (!passed && abortOnFailure) {
-      client.terminate();
+      client.terminate(true);
     }
   };
 

lib/core/queue.js

@@ -67,6 +67,8 @@ AsyncTree.prototype.scheduleTraverse = function(node) {
 };
 
 AsyncTree.prototype.traverse = function() {
+  this.emit('queue:started');
+
   try {
     this.walkDown(this.currentNode);
   } catch (err) {
@@ -215,6 +217,7 @@ module.exports = new (function() {
         callback(err);
       });
     }
+
     return queue.traverse();
   };
 

lib/index.js

@@ -210,27 +210,38 @@ Nightwatch.prototype.start = function() {
   return this;
 };
 
-Nightwatch.prototype.terminate = function() {
-  var self = this;
+Nightwatch.prototype.terminate = function(deferred) {
   this.terminated = true;
+
+  // in case this was a synchronous command (e.g. assert.ok()) we need to wait for other possible
+  // commands which might have been added afterwards while client is terminated
+  if (deferred) {
+    this.queue.instance().once('queue:started', this.terminateSession.bind(this));
+  } else {
+    this.terminateSession();
+  }
+
+  return this;
+};
+
+Nightwatch.prototype.resetTerminated = function() {
+  this.terminated = false;
+  return this;
+};
+
+Nightwatch.prototype.terminateSession = function() {
   this.queue.reset();
   this.queue.empty();
 
   if (this.options.end_session_on_fail && this.options.start_session) {
     this.api.end(function() {
-      self.finished();
-    });
+      this.finished();
+    }.bind(this));
 
     this.queue.run();
   } else {
     this.finished();
   }
-
-  return this;
-};
-
-Nightwatch.prototype.resetTerminated = function() {
-  this.terminated = false;
   return this;
 };
 
@@ -326,12 +337,12 @@ Nightwatch.prototype.runProtocolAction = function(requestOptions, callback) {
           var firstLine = ' ' + String.fromCharCode(10006) + ' ' +stack.shift();
 
           Utils.showStackTrace(firstLine, stack);
+
           if (ex.name == 'AssertionError') {
             self.results.failed++;
           } else {
             self.addError(ex.message, firstLine);
           }
-
         }
       }
 

lib/runner/testsuite.js

@@ -225,6 +225,10 @@ TestSuite.prototype.printResult = function(startTime) {
   return this.client.print(startTime);
 };
 
+TestSuite.prototype.shouldRetrySuite = function() {
+  return this.suiteMaxRetries > this.suiteRetries && (this.testResults.failed > 0 || this.testResults.errors > 0);
+};
+
 TestSuite.prototype.setTestResult = function() {
   this.testResults = {};
   this.testResults.steps = this.module.keys.slice(0);
@@ -259,11 +263,15 @@ TestSuite.prototype.printRetry = function() {
 };
 
 TestSuite.prototype.retryTestSuiteModule = function() {
+  this.client.resetTerminated();
+  this.clearResult();
   this.suiteRetries +=1;
   this.resetTestCases();
   this.printRetry();
-  this.globalBeforeEach();
-  return this.runTestSuiteModule();
+
+  return this.globalBeforeEach().then(function() {
+    return this.runTestSuiteModule();
+  }.bind(this));
 };
 
 TestSuite.prototype.runTestSuiteModule = function() {
@@ -279,17 +287,19 @@ TestSuite.prototype.runTestSuiteModule = function() {
       return self.client.checkQueue();
     })
     .then(function() {
-      if (self.suiteMaxRetries > self.suiteRetries && (self.testResults.failed > 0 || self.testResults.errors > 0)) {
-        self.globalAfterEach();
-        self.client.resetTerminated();
-        self.clearResult();
-        return self.retryTestSuiteModule();
+      return self.shouldRetrySuite();
+    })
+    .then(function(shouldRetrySuite) {
+      if (shouldRetrySuite) {
+        return self.globalAfterEach().then(function() {
+          return self.retryTestSuiteModule();
+        });
       }
     })
     .catch(function(e) {
-      this.testResults.errors++;
+      self.testResults.errors++;
       throw e;
-    }.bind(this));
+    });
 };
 
 TestSuite.prototype.onTestCaseFinished = function(results, errors, time) {

tests/sampletests/suiteretries/suiteRetriesSample.js

@@ -0,0 +1,37 @@
+var failFirstTime = true;
+
+module.exports = {
+  before: function (client) {
+    client.url('http://localhost')
+  },
+
+  after: function (client) {
+    client.end();
+  },
+
+  demoStep1 : function (client) {
+    client
+      .assert.elementPresent('#weblogin')
+      .perform(function() {
+        client.globals.test.ok('demoStep1 called.');
+      });
+
+  },
+
+  demoStep2 : function (client) {
+    client
+      .elements('css selector', '#weblogin', function() {
+        if (failFirstTime) {
+          failFirstTime = false;
+          client.assert.ok(false);
+        }
+
+        client
+          .assert.elementPresent('#weblogin')
+          .perform(function() {
+            client.globals.test.ok('demoStep2 called.');
+          });
+      });
+  }
+
+};

tests/src/runner/testParallelExecution.js

@@ -113,7 +113,7 @@ module.exports = {
     });
 
     runner.setup({}, function() {
-      test.equals(self.allArgs.length, 20);
+      test.equals(self.allArgs.length, 21);
       test.ok(path.join('sampletests', 'async', 'sample_1') in runner.runningProcesses);
       test.ok(path.join('sampletests', 'before-after', 'sampleSingleTest_2') in runner.runningProcesses);
 
@@ -144,7 +144,7 @@ module.exports = {
 
     runner.setup({}, function() {
       test.ok(!runner.isParallelMode());
-      test.equals(self.allArgs.length, 20);
+      test.equals(self.allArgs.length, 21);
       test.done();
     });
 
@@ -169,7 +169,7 @@ module.exports = {
 
     runner.setup({}, function() {
       test.ok(!runner.isParallelMode());
-      test.equals(self.allArgs.length, 20);
+      test.equals(self.allArgs.length, 21);
       test.done();
     });