test: skip instead of fail when mem constrained

The current implementation of tests for strings with length at or
exceeding kStringMaxLength allocate a temporary buffer inside a try
block to skip the test if there is insufficient memory. This commit adds
an invocation of the garbage collector after the temporary buffer is
allocated so that memory is freed for later allocations.

Change the corresponding catch block to rethrow the original exception
instead of asserting the exception message to provide more information
about the exception.

Add an additional check before trying to allocate memory to immediately
skip the test on machines with insufficient total memory.

PR-URL: #3697
Reviewed-By: Trevor Norris <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>

test/common.js

@@ -20,6 +20,8 @@ exports.isLinuxPPCBE = (process.platform === 'linux') &&
 exports.isSunOS = process.platform === 'sunos';
 exports.isFreeBSD = process.platform === 'freebsd';
 
+exports.enoughTestMem = os.totalmem() > 0x20000000; /* 512MB */
+
 function rimrafSync(p) {
   try {
     var st = fs.lstatSync(p);

test/parallel/test-stringbytes-external-at-max.js

@@ -1,22 +1,32 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
 // v8 fails silently if string length > v8::String::kMaxLength
 // 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';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength);
-
 const maxString = buf.toString('binary');
 assert.equal(maxString.length, kStringMaxLength);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 1);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength + 1);
-
 assert.throws(function() {
   buf.toString('ascii');
 }, /toString failed/);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 1);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength + 1);
-
 assert.throws(function() {
   buf.toString('base64');
 }, /toString failed/);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 1);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength + 1);
-
 assert.throws(function() {
   buf.toString('binary');
 }, /toString failed/);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 1);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength + 1);
-
 assert.throws(function() {
   buf.toString('hex');
 }, /toString failed/);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 1);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf = new Buffer(kStringMaxLength + 1);
-
 assert.throws(function() {
   buf.toString();
 }, /toString failed|Invalid array buffer length/);

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

@@ -1,22 +1,32 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength + 2);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf2 = new Buffer(kStringMaxLength + 2);
-
-const maxString = buf2.toString('utf16le');
+const maxString = buf.toString('utf16le');
 assert.equal(maxString.length, (kStringMaxLength + 2) / 2);

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

@@ -1,23 +1,33 @@
 'use strict';
+// Flags: --expose-gc
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
+const skipMessage =
+  '1..0 # Skipped: intensive toString tests due to memory confinements';
+if (!common.enoughTestMem) {
+  console.log(skipMessage);
+  return;
+}
+assert(typeof gc === 'function', 'Run this test with --expose-gc');
+
 // v8 fails silently if string length > v8::String::kMaxLength
 // v8::String::kMaxLength defined in v8.h
 const kStringMaxLength = process.binding('buffer').kStringMaxLength;
 
 try {
-  new Buffer(kStringMaxLength * 3);
+  var buf = new Buffer(kStringMaxLength * 2 + 2);
+  // Try to allocate memory first then force gc so future allocations succeed.
+  new Buffer(2 * kStringMaxLength);
+  gc();
 } catch(e) {
-  assert.equal(e.message, 'Invalid array buffer length');
-  console.log(
-      '1..0 # Skipped: intensive toString tests due to memory confinements');
+  // If the exception is not due to memory confinement then rethrow it.
+  if (e.message !== 'Invalid array buffer length') throw (e);
+  console.log(skipMessage);
   return;
 }
 
-const buf0 = new Buffer(kStringMaxLength * 2 + 2);
-
 assert.throws(function() {
-  buf0.toString('utf16le');
+  buf.toString('utf16le');
 }, /toString failed/);