test: migrate message tests to use assertSnapshot

PR-URL: #47498
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

Author: MoLow

test/common/assertSnapshot.js

@@ -8,14 +8,18 @@ const assert = require('node:assert/strict');
 conststackFramesRegexp=/(\s+)((.+?)\s+\()?(?:\(?(.+?):(\d+)(?::(\d+))?)\)?(\s+\{)?(\n|$)/g;
 constwindowNewlineRegexp=/\r/g;
 
-functionreplaceStackTrace(str){
-returnstr.replace(stackFramesRegexp,'$1*$7\n');
+functionreplaceStackTrace(str,replacement='$1*$7\n'){
+returnstr.replace(stackFramesRegexp,replacement);
 }
 
 functionreplaceWindowsLineEndings(str){
 returnstr.replace(windowNewlineRegexp,'');
 }
 
+functionreplaceWindowsPaths(str){
+returnstr.replaceAll(path.win32.sep,path.posix.sep);
+}
+
 functiontransform(...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>}
+ */
 asyncfunctionspawnAndAssert(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.
 constflags=common.parseTestFlags(filename);
-const{ stdout }=awaitcommon.spawnPromisified(process.execPath,[...flags,filename]);
-awaitassertSnapshot(transform(stdout),filename);
+const{ stdout, stderr}=awaitcommon.spawnPromisified(process.execPath,[...flags,filename]);
+awaitassertSnapshot(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);
 constsource=buffer.toString('utf8',0,bytesRead);
 
-constflagStart=source.indexOf('// Flags: --')+10;
+constflagStart=source.search(/\/\/Flags:\s+--/)+10;
 
 if(flagStart===9){
 return[];
@@ -82,7 +82,8 @@ function parseTestFlags(filename = process.argv[1]) {
 returnsource
 .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.jstest/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 test/fixtures/console/2100bytes.snapshottest/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 test/fixtures/console/console.jstest/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 test/fixtures/console/console.snapshottest/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 …tures/console/console_low_stack_space.jstest/message/console_low_stack_space.js renamed to test/fixtures/console/console_low_stack_space.js 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');