test: migrate message tests to use assertSnapshot

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

Author: MoLow

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

@@ -70,7 +70,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 [];
@@ -83,7 +83,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 renamed to 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/2100bytes.out renamed to test/fixtures/console/2100bytes.snapshot

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

test/message/console.js renamed to test/fixtures/console/console.js

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

test/message/console.out renamed to test/fixtures/console/console.snapshot

@@ -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/console_low_stack_space.js renamed to test/fixtures/console/console_low_stack_space.js

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