test: migrate message tests to use assertSnapshot

PR-URL: nodejs#47498
Reviewed-By: Geoffrey Booth <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>

test/common/assertSnapshot.js

@@ -8,14 +8,18 @@ const assert = require('node:assert/strict');
 const stackFramesRegexp = /(\s+)((.+?)\s+\()?(?:\(?(.+?):(\d+)(?::(\d+))?)\)?(\s+\{)?(\n|$)/g;
 const windowNewlineRegexp = /\r/g;
 
-function replaceStackTrace(str) {
-  return str.replace(stackFramesRegexp, '$1*$7\n');
+function replaceStackTrace(str, replacement = '$1*$7\n') {
+  return str.replace(stackFramesRegexp, replacement);
 }
 
 function replaceWindowsLineEndings(str) {
   return str.replace(windowNewlineRegexp, '');
 }
 
+function replaceWindowsPaths(str) {
+  return str.replaceAll(path.win32.sep, path.posix.sep);
+}
+
 function transform(...args) {
   return (str) => args.reduce((acc, fn) => fn(acc), str);
 }
@@ -35,19 +39,32 @@ async function assertSnapshot(actual, filename = process.argv[1]) {
   }
 }
 
+/**
+ * Spawn a process and assert its output against a snapshot.
+ * if you want to automatically update the snapshot, run tests with NODE_REGENERATE_SNAPSHOTS=1
+ * transform is a function that takes the output and returns a string that will be compared against the snapshot
+ * this is useful for normalizing output such as stack traces
+ * there are some predefined transforms in this file such as replaceStackTrace and replaceWindowsLineEndings
+ * both of which can be used as an example for writing your own
+ * compose multiple transforms by passing them as arguments to the transform function:
+ * assertSnapshot.transform(assertSnapshot.replaceStackTrace, assertSnapshot.replaceWindowsLineEndings)
+ *
+ * @param {string} filename
+ * @param {function(string): string} [transform]
+ * @returns {Promise<void>}
+ */
 async function spawnAndAssert(filename, transform = (x) => x) {
-  // TODO: Add an option to this function to alternatively or additionally compare stderr.
-  // For now, tests that want to check stderr or both stdout and stderr can use spawnPromisified.
   const flags = common.parseTestFlags(filename);
-  const { stdout } = await common.spawnPromisified(process.execPath, [...flags, filename]);
-  await assertSnapshot(transform(stdout), filename);
+  const { stdout, stderr } = await common.spawnPromisified(process.execPath, [...flags, filename]);
+  await assertSnapshot(transform(`${stdout}${stderr}`), filename);
 }
 
 module.exports = {
   assertSnapshot,
   getSnapshotPath,
   replaceStackTrace,
   replaceWindowsLineEndings,
+  replaceWindowsPaths,
   spawnAndAssert,
   transform,
 };

test/common/index.js

@@ -69,7 +69,7 @@ function parseTestFlags(filename = process.argv[1]) {
   fs.closeSync(fd);
   const source = buffer.toString('utf8', 0, bytesRead);
 
-  const flagStart = source.indexOf('// Flags: --') + 10;
+  const flagStart = source.search(/\/\/ Flags:\s+--/) + 10;
 
   if (flagStart === 9) {
     return [];
@@ -82,7 +82,8 @@ function parseTestFlags(filename = process.argv[1]) {
   return source
     .substring(flagStart, flagEnd)
     .replace(/_/g, '-')
-    .split(' ');
+    .split(/\s+/)
+    .filter(Boolean);
 }
 
 // Check for flags. Skip this for workers (both, the `cluster` module and

test/message/2100bytes.js → test/fixtures/console/2100bytes.js

@@ -20,7 +20,7 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 'use strict';
-require('../common');
+require('../../common');
 
 console.log([
   '_______________________________________________50',

test/message/console.js → test/fixtures/console/console.js

@@ -1,5 +1,5 @@
 'use strict';
 
-require('../common');
+require('../../common');
 
 console.trace('foo');

test/message/console.out → test/fixtures/console/console.snapshot

@@ -1,5 +1,5 @@
 Trace: foo
-    at Object.<anonymous> (*console.js:*:*)
+    at *
     at *
     at *
     at *

test/message/console_low_stack_space.js → test/fixtures/console/console_low_stack_space.js

@@ -7,7 +7,7 @@ Object.defineProperty(global, 'console', {
   value: {},
 });
 
-require('../common');
+require('../../common');
 
 // This test checks that, if Node cannot put together the `console` object
 // because it is low on stack space while doing so, it can succeed later

test/message/hello_world.js → test/fixtures/console/hello_world.js

@@ -20,6 +20,6 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 'use strict';
-require('../common');
+require('../../common');
 
 console.log('hello world');

test/message/stack_overflow.js → test/fixtures/console/stack_overflow.js

@@ -20,7 +20,7 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 'use strict';
-require('../common');
+require('../../common');
 
 Error.stackTraceLimit = 0;
 

test/message/stack_overflow.out → test/fixtures/console/stack_overflow.snapshot

@@ -1,5 +1,5 @@
 before
-*test*message*stack_overflow.js:*
+*test*fixtures*console*stack_overflow.js:*
 JSON.stringify(array);
      ^
 

test/message/async_error_eval_cjs.js → test/fixtures/errors/async_error_eval_cjs.js

@@ -1,9 +1,9 @@
 'use strict';
 
-require('../common');
+require('../../common');
 const { spawnSync } = require('child_process');
 
-const four = require('../common/fixtures')
+const four = require('../../common/fixtures')
   .readSync('async-error.js')
   .toString()
   .split('\n')

test/message/async_error_eval_cjs.out → test/fixtures/errors/async_error_eval_cjs.snapshot

@@ -3,4 +3,5 @@ Error: test
     at two ([eval]:15:9)
     at async three ([eval]:18:3)
     at async four ([eval]:22:3)
-    at async main ([eval]:28:5)
+    at async main ([eval]:28:5)
+

test/message/async_error_eval_esm.js → test/fixtures/errors/async_error_eval_esm.js

@@ -1,9 +1,9 @@
 'use strict';
 
-require('../common');
+require('../../common');
 const { spawnSync } = require('child_process');
 
-const four = require('../common/fixtures')
+const four = require('../../common/fixtures')
   .readSync('async-error.js')
   .toString()
   .split('\n')

test/message/async_error_eval_esm.out → test/fixtures/errors/async_error_eval_esm.snapshot

@@ -4,3 +4,4 @@ Error: test
     at async three (file:*/[eval1]:18:3)
     at async four (file:*/[eval1]:22:3)
     at async main (file:*/[eval1]:28:5)
+

test/message/async_error_microtask_main.js → test/fixtures/errors/async_error_microtask_main.js

@@ -1,6 +1,6 @@
 'use strict';
-require('../common');
-const four = require('../fixtures/async-error');
+require('../../common');
+const four = require('../async-error');
 
 async function main() {
   try {

test/message/async_error_sync_esm.out → test/fixtures/errors/async_error_microtask_main.snapshot

@@ -3,4 +3,4 @@ Error: test
     at two (*fixtures*async-error.js:17:9)
     at async three (*fixtures*async-error.js:20:3)
     at async four (*fixtures*async-error.js:24:3)
-    at async main (*message*async_error_sync_esm.mjs:6:5)
+    at async main (*async_error_microtask_main.js:7:5)

test/message/async_error_nexttick_main.js → test/fixtures/errors/async_error_nexttick_main.js

@@ -1,6 +1,6 @@
 'use strict';
-require('../common');
-const four = require('../fixtures/async-error');
+require('../../common');
+const four = require('../async-error');
 
 async function main() {
   try {

test/message/async_error_nexttick_main.out → test/fixtures/errors/async_error_nexttick_main.snapshot

@@ -1,7 +1,7 @@
 Error: test
     at one (*fixtures*async-error.js:4:9)
     at two (*fixtures*async-error.js:17:9)
-    at process.processTicksAndRejections (node:internal/process/task_queues:*:*)
+    at process.processTicksAndRejections (node:internal*process*task_queues:95:5)
     at async three (*fixtures*async-error.js:20:3)
     at async four (*fixtures*async-error.js:24:3)
-    at async main (*message*async_error_nexttick_main.js:7:5)
+    at async main (*async_error_nexttick_main.js:7:5)

test/message/async_error_sync_esm.mjs → test/fixtures/errors/async_error_sync_esm.mjs

@@ -1,5 +1,5 @@
-import '../common/index.mjs';
-import four from '../fixtures/async-error.js';
+import '../../common/index.mjs';
+import four from '../async-error.js';
 
 async function main() {
   try {

test/message/async_error_sync_main.out → test/fixtures/errors/async_error_sync_esm.snapshot

@@ -3,4 +3,4 @@ Error: test
     at two (*fixtures*async-error.js:17:9)
     at async three (*fixtures*async-error.js:20:3)
     at async four (*fixtures*async-error.js:24:3)
-    at async main (*message*async_error_sync_main.js:7:5)
+    at async main (file:*/async_error_sync_esm.mjs:6:5)

test/message/async_error_sync_main.js → test/fixtures/errors/async_error_sync_main.js

@@ -1,6 +1,6 @@
 'use strict';
-require('../common');
-const four = require('../fixtures/async-error');
+require('../../common');
+const four = require('../async-error');
 
 async function main() {
   try {

test/message/async_error_microtask_main.out → test/fixtures/errors/async_error_sync_main.snapshot

@@ -3,4 +3,4 @@ Error: test
     at two (*fixtures*async-error.js:17:9)
     at async three (*fixtures*async-error.js:20:3)
     at async four (*fixtures*async-error.js:24:3)
-    at async main (*message*async_error_microtask_main.js:7:5)
+    at async main (*async_error_sync_main.js:7:5)

test/message/error_aggregateTwoErrors.js → test/fixtures/errors/error_aggregateTwoErrors.js

@@ -1,7 +1,7 @@
 // Flags: --expose-internals
 'use strict';
 
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 1;
 
 const { aggregateTwoErrors } = require('internal/errors');

test/message/error_aggregateTwoErrors.out → test/fixtures/errors/error_aggregateTwoErrors.snapshot

@@ -1,15 +1,16 @@
 *error_aggregateTwoErrors.js:*
 throw aggregateTwoErrors(err, originalError);
 ^
+
 [AggregateError: original] {
   code: 'ERR0',
   [errors]: [
     Error: original
-        at Object.<anonymous> (*test*message*error_aggregateTwoErrors.js:*:*) {
+        at Object.<anonymous> (*error_aggregateTwoErrors.js:*:*) {
       code: 'ERR0'
     },
     Error: second error
-        at Object.<anonymous> (*test*message*error_aggregateTwoErrors.js:*:*) {
+        at Object.<anonymous> (*error_aggregateTwoErrors.js:*:*) {
       code: 'ERR1'
     }
   ]

test/message/error_exit.js → test/fixtures/errors/error_exit.js

@@ -20,7 +20,7 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 1;
 
 const assert = require('assert');

test/message/error_exit.out → test/fixtures/errors/error_exit.snapshot

@@ -7,7 +7,7 @@ AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:
 
 1 !== 2
 
-    at Object.<anonymous> (*test*message*error_exit.js:*:*) {
+    at Object.<anonymous> (*error_exit.js:*:*) {
   generatedMessage: true,
   code: 'ERR_ASSERTION',
   actual: 1,

test/message/error_with_nul.js → test/fixtures/errors/error_with_nul.js

@@ -1,5 +1,5 @@
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 2;
 
 function test() {

test/message/events_unhandled_error_common_trace.js → test/fixtures/errors/events_unhandled_error_common_trace.js

@@ -1,5 +1,5 @@
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 2;
 
 const EventEmitter = require('events');

test/message/events_unhandled_error_common_trace.out → test/fixtures/errors/events_unhandled_error_common_trace.snapshot

@@ -1,5 +1,5 @@
 node:events:*
-      throw er; // Unhandled 'error' event
+      throw er; * Unhandled 'error' event
       ^
 
 Error: foo:bar

test/message/events_unhandled_error_nexttick.js → test/fixtures/errors/events_unhandled_error_nexttick.js

@@ -1,5 +1,5 @@
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 1;
 
 const EventEmitter = require('events');

test/message/events_unhandled_error_nexttick.out → test/fixtures/errors/events_unhandled_error_nexttick.snapshot

@@ -1,5 +1,5 @@
 node:events:*
-      throw er; // Unhandled 'error' event
+      throw er; * Unhandled 'error' event
       ^
 
 Error

test/message/events_unhandled_error_sameline.js → test/fixtures/errors/events_unhandled_error_sameline.js

@@ -1,5 +1,5 @@
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 1;
 
 const EventEmitter = require('events');

test/message/events_unhandled_error_sameline.out → test/fixtures/errors/events_unhandled_error_sameline.snapshot

@@ -1,5 +1,5 @@
 node:events:*
-      throw er; // Unhandled 'error' event
+      throw er; * Unhandled 'error' event
       ^
 
 Error

test/message/events_unhandled_error_subclass.js → test/fixtures/errors/events_unhandled_error_subclass.js

@@ -1,5 +1,5 @@
 'use strict';
-require('../common');
+require('../../common');
 Error.stackTraceLimit = 1;
 
 const EventEmitter = require('events');

test/message/events_unhandled_error_subclass.out → test/fixtures/errors/events_unhandled_error_subclass.snapshot

@@ -1,5 +1,5 @@
 node:events:*
-      throw er; // Unhandled 'error' event
+      throw er; * Unhandled 'error' event
       ^
 
 Error

test/message/promise_always_throw_unhandled.js → test/fixtures/errors/promise_always_throw_unhandled.js

@@ -1,7 +1,7 @@
 // Flags: --unhandled-rejections=strict
 'use strict';
 
-require('../common');
+require('../../common');
 
 // Check that the process will exit on the first unhandled rejection in case the
 // unhandled rejections mode is set to `'strict'`.

test/message/promise_always_throw_unhandled.out → test/fixtures/errors/promise_always_throw_unhandled.snapshot

@@ -1,10 +1,11 @@
 *promise_always_throw_unhandled.js:*
   throw new Error('One');
         ^
+
 Error: One
-    at *promise_always_throw_unhandled.js:*:*
+    at *
     at new Promise (<anonymous>)
-    at Object.<anonymous> (*promise_always_throw_unhandled.js:*:*)
+    at *
     at *
     at *
     at *

test/message/throw_custom_error.js → test/fixtures/errors/throw_custom_error.js

@@ -20,7 +20,7 @@
 // USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 'use strict';
-require('../common');
+require('../../common');
 
 // Custom error throwing
 // eslint-disable-next-line no-throw-literal

test/message/throw_custom_error.out → test/fixtures/errors/throw_custom_error.snapshot

@@ -1,4 +1,5 @@
-*test*message*throw_custom_error.js:*
+
+*throw_custom_error.js:*
 throw ({ name: 'MyCustomError', message: 'This is a custom message' });
 ^
 { name: 'MyCustomError', message: 'This is a custom message' }

test/message/throw_in_line_with_tabs.js → test/fixtures/errors/throw_in_line_with_tabs.js

@@ -21,7 +21,7 @@
 
 /* eslint-disable indent, no-tabs */
 'use strict';
-require('../common');
+require('../../common');
 
 console.error('before');
 

test/message/throw_in_line_with_tabs.out → test/fixtures/errors/throw_in_line_with_tabs.snapshot

@@ -1,5 +1,6 @@
 before
-*test*message*throw_in_line_with_tabs.js:*
+
+*throw_in_line_with_tabs.js:*
 	throw ({ foo: 'bar' });
 	^
 { foo: 'bar' }