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 <[email protected]>

Author: Fishrock123

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;