test: wrap assert.fail when passed to callback

Currently there are many instances where assert.fail is directly passed
to a callback for error handling. Unfortunately this will swallow the
error as it is the third argument of assert.fail that sets the message
not the first.

This commit adds a new function to test/common.js that simply wraps
assert.fail and calls it with the provided message.

Tip of the hat to @Trott for pointing me in the direction of this.

PR-URL: #3453
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Rich Trott <[email protected]>

Author: Myles Borins

test/common.js

@@ -442,3 +442,7 @@ exports.fileExists = function(pathname) {
     return false;
   }
 };
+
+exports.fail = function(msg) {
+  assert.fail(null, null, msg);
+};

test/parallel/test-child-process-recv-handle.js

@@ -24,7 +24,7 @@ function master() {
   });
   proc.stdout.on('data', function(data) {
     assert.equal(data, 'ok\r\n');
-    net.createServer(assert.fail).listen(common.PORT, function() {
+    net.createServer(common.fail).listen(common.PORT, function() {
       handle = this._handle;
       proc.send('one');
       proc.send('two', handle);

test/parallel/test-child-process-spawn-typeerror.js

@@ -13,7 +13,7 @@ const empty = common.fixturesDir + '/empty.js';
 
 assert.throws(function() {
   var child = spawn(invalidcmd, 'this is not an array');
-  child.on('error', assert.fail);
+  child.on('error', common.fail);
 }, TypeError);
 
 // verify that valid argument combinations do not throw

test/parallel/test-cluster-bind-privileged-port.js

@@ -20,8 +20,8 @@ if (cluster.isMaster) {
   }));
 }
 else {
-  var s = net.createServer(assert.fail);
-  s.listen(42, assert.fail.bind(null, 'listen should have failed'));
+  var s = net.createServer(common.fail);
+  s.listen(42, common.fail.bind(null, 'listen should have failed'));
   s.on('error', common.mustCall(function(err) {
     assert.equal(err.code, 'EACCES');
     process.disconnect();

test/parallel/test-cluster-bind-twice.js

@@ -68,7 +68,7 @@ if (!id) {
 else if (id === 'one') {
   if (cluster.isMaster) return startWorker();
 
-  var server = http.createServer(assert.fail).listen(common.PORT, function() {
+  var server = http.createServer(common.fail).listen(common.PORT, function() {
     process.send('READY');
   });
 
@@ -84,12 +84,12 @@ else if (id === 'two') {
     assert(ok);
   });
 
-  var server = http.createServer(assert.fail);
+  var server = http.createServer(common.fail);
   process.on('message', function(m) {
     if (typeof m === 'object') return; // ignore system messages
     if (m === 'QUIT') process.exit();
     assert.equal(m, 'START');
-    server.listen(common.PORT, assert.fail);
+    server.listen(common.PORT, common.fail);
     server.on('error', function(e) {
       assert.equal(e.code, 'EADDRINUSE');
       process.send(e.code);

test/parallel/test-cluster-eaddrinuse.js

@@ -12,7 +12,7 @@ var net = require('net');
 var id = '' + process.argv[2];
 
 if (id === 'undefined') {
-  var server = net.createServer(assert.fail);
+  var server = net.createServer(common.fail);
   server.listen(common.PORT, function() {
     var worker = fork(__filename, ['worker']);
     worker.on('message', function(msg) {
@@ -24,14 +24,14 @@ if (id === 'undefined') {
   });
 }
 else if (id === 'worker') {
-  var server = net.createServer(assert.fail);
-  server.listen(common.PORT, assert.fail);
+  var server = net.createServer(common.fail);
+  server.listen(common.PORT, common.fail);
   server.on('error', common.mustCall(function(e) {
     assert(e.code, 'EADDRINUSE');
     process.send('stop-listening');
     process.once('message', function(msg) {
       if (msg !== 'stopped-listening') return;
-      server = net.createServer(assert.fail);
+      server = net.createServer(common.fail);
       server.listen(common.PORT, common.mustCall(function() {
         server.close();
       }));

test/parallel/test-cluster-net-listen.js

@@ -17,5 +17,5 @@ if (cluster.isMaster) {
 }
 else {
   // listen() without port should not trigger a libuv assert
-  net.createServer(assert.fail).listen(process.exit);
+  net.createServer(common.fail).listen(process.exit);
 }

test/parallel/test-cluster-rr-ref.js

@@ -10,7 +10,7 @@ if (cluster.isMaster) {
     if (msg === 'done') this.kill();
   });
 } else {
-  const server = net.createServer(assert.fail);
+  const server = net.createServer(common.fail);
   server.listen(common.PORT, function() {
     server.unref();
     server.ref();

test/parallel/test-cluster-setup-master-argv.js

@@ -3,7 +3,7 @@ var common = require('../common');
 var assert = require('assert');
 var cluster = require('cluster');
 
-setTimeout(assert.fail.bind(assert, 'setup not emitted'), 1000).unref();
+setTimeout(common.fail.bind(assert, 'setup not emitted'), 1000).unref();
 
 cluster.on('setup', function() {
   var clusterArgs = cluster.settings.args;

test/parallel/test-cluster-shared-handle-bind-error.js

@@ -8,7 +8,7 @@ if (cluster.isMaster) {
   // Master opens and binds the socket and shares it with the worker.
   cluster.schedulingPolicy = cluster.SCHED_NONE;
   // Hog the TCP port so that when the worker tries to bind, it'll fail.
-  net.createServer(assert.fail).listen(common.PORT, function() {
+  net.createServer(common.fail).listen(common.PORT, function() {
     var server = this;
     var worker = cluster.fork();
     worker.on('exit', common.mustCall(function(exitCode) {
@@ -18,8 +18,8 @@ if (cluster.isMaster) {
   });
 }
 else {
-  var s = net.createServer(assert.fail);
-  s.listen(common.PORT, assert.fail.bind(null, 'listen should have failed'));
+  var s = net.createServer(common.fail);
+  s.listen(common.PORT, common.fail.bind(null, 'listen should have failed'));
   s.on('error', common.mustCall(function(err) {
     assert.equal(err.code, 'EADDRINUSE');
     process.disconnect();