test: abstract skip functionality to common

The tap skipping output is so prevalent yet obscure in nature that we
ought to move it into it's own function in test/common.js

Re-do of 52bae22 for v4.x

Ref: #6697
PR-URL: #7114
Reviewed-By: Myles Borins <myles.borins@gmail.com>

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-at-max.js

@@ -8,10 +8,9 @@ const assert = require('assert');
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-ascii.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-base64.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-binary.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-hex.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-utf8.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-2.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max.js

@@ -4,10 +4,9 @@ const common = require('../../common');
 const binding = require('./build/Release/binding');
 const assert = require('assert');
 
-const skipMessage =
- '1..0 # Skipped: intensive toString tests due to memory confinements';
+const skipMessage = 'intensive toString tests due to memory confinements';
 if (!common.enoughTestMem) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
@@ -20,13 +19,13 @@ try {
 } catch (e) {
  // If the exception is not due to memory confinement then rethrow it.
  if (e.message !== 'Invalid array buffer length') throw (e);
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 
 // Ensure we have enough memory available for future allocations to succeed.
 if (!binding.ensureAllocation(2 * kStringMaxLength)) {
- console.log(skipMessage);
+ common.skip(skipMessage);
  return;
 }
 

test/common.js

@@ -459,6 +459,10 @@ exports.fail = function(msg) {
  assert.fail(null, null, msg);
 };
 
+exports.skip = function(msg) {
+ console.log(`1..0 # Skipped: ${msg}`);
+};
+
 // Returns true if the exit code "exitCode" and/or signal name "signal"
 // represent the exit code and/or signal name of a node process that aborted,
 // false otherwise.

test/disabled/tls_server.js

@@ -13,7 +13,7 @@ var certPem = fs.readFileSync(common.fixturesDir + '/cert.pem');
 try {
  var credentials = crypto.createCredentials({key: keyPem, cert: certPem});
 } catch (e) {
- console.log('1..0 # Skipped: node compiled without OpenSSL.');
+ common.skip('node compiled without OpenSSL.');
  return;
 }
 var i = 0;

test/internet/test-dgram-broadcast-multi-process.js

@@ -16,7 +16,7 @@ const messages = [
 ];
 
 if (common.inFreeBSDJail) {
- console.log('1..0 # Skipped: in a FreeBSD jail');
+ common.skip('in a FreeBSD jail');
  return;
 }
 

test/internet/test-dgram-multicast-multi-process.js

@@ -17,7 +17,7 @@ const listeners = 3;
 
 // Skip test in FreeBSD jails.
 if (common.inFreeBSDJail) {
- console.log('1..0 # Skipped: In a FreeBSD jail');
+ common.skip('In a FreeBSD jail');
  return;
 }
 

test/internet/test-dns-ipv6.js

@@ -11,7 +11,7 @@ let running = false;
 const queue = [];
 
 if (!common.hasIPv6) {
- console.log('1..0 # Skipped: this test, no IPv6 support');
+ common.skip('this test, no IPv6 support');
  return;
 }
 

test/internet/test-http-https-default-ports.js

@@ -3,7 +3,7 @@ var common = require('../common');
 var assert = require('assert');
 
 if (!common.hasCrypto) {
- console.log('1..0 # Skipped: missing crypto');
+ common.skip('missing crypto');
  return;
 }
 var https = require('https');

test/internet/test-tls-connnect-cnnic.js

@@ -10,7 +10,7 @@
 
 var common = require('../common');
 if (!common.hasCrypto) {
- console.log('1..0 # Skipped: missing crypto');
+ common.skip('missing crypto');
  return;
 }
 

test/internet/test-tls-connnect-melissadata.js

@@ -4,7 +4,7 @@
 
 var common = require('../common');
 if (!common.hasCrypto) {
- console.log('1..0 # Skipped: missing crypto');
+ common.skip('missing crypto');
  return;
 }
 

test/internet/test-tls-reuse-host-from-socket.js

@@ -3,7 +3,7 @@ var common = require('../common');
 var assert = require('assert');
 
 if (!common.hasCrypto) {
- console.log('1..0 # Skipped: missing crypto');
+ common.skip('missing crypto');
  return;
 }
 var tls = require('tls');

test/parallel/test-buffer.js

@@ -1273,7 +1273,7 @@ if (common.hasCrypto) {
  crypto.createHash('sha1').update(b2).digest('hex')
  );
 } else {
- console.log('1..0 # Skipped: missing crypto');
+ common.skip('missing crypto');
 }
 
 // Test Compare

test/parallel/test-child-process-fork-dgram.js

@@ -19,7 +19,7 @@ var assert = require('assert');
 var common = require('../common');
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: Sending dgram sockets to child processes is ' +
+ common.skip('Sending dgram sockets to child processes is ' +
  'not supported');
  return;
 }

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

@@ -5,12 +5,12 @@ var cluster = require('cluster');
 var net = require('net');
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: not reliable on Windows.');
+ common.skip('not reliable on Windows.');
  return;
 }
 
 if (process.getuid() === 0) {
- console.log('1..0 # Skipped: Test is not supposed to be run as root.');
+ common.skip('Test is not supposed to be run as root.');
  return;
 }
 

test/parallel/test-cluster-dgram-1.js

@@ -9,7 +9,7 @@ var dgram = require('dgram');
 
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: dgram clustering is currently not supported ' +
+ common.skip('dgram clustering is currently not supported ' +
  'on windows.');
  return;
 }

test/parallel/test-cluster-dgram-2.js

@@ -8,7 +8,7 @@ var dgram = require('dgram');
 
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: dgram clustering is currently not supported ' +
+ common.skip('dgram clustering is currently not supported ' +
  'on windows.');
  return;
 }

test/parallel/test-cluster-dgram-reuse.js

@@ -5,7 +5,7 @@ const cluster = require('cluster');
 const dgram = require('dgram');
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: dgram clustering is currently not supported ' +
+ common.skip('dgram clustering is currently not supported ' +
  'on windows.');
  return;
 }

test/parallel/test-cluster-disconnect-handles.js

@@ -10,7 +10,7 @@ const net = require('net');
 const Protocol = require('_debugger').Protocol;
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: SCHED_RR not reliable on Windows');
+ common.skip('SCHED_RR not reliable on Windows');
  return;
 }
 

test/parallel/test-cluster-disconnect-race.js

@@ -9,7 +9,7 @@ const net = require('net');
 const cluster = require('cluster');
 
 if (common.isWindows) {
- console.log('1..0 # Skipped: This test does not apply to Windows.');
+ common.skip('This test does not apply to Windows.');
  return;
 }