test: improve output of child process utilities

joyeecheung · targos · commit 99566aea979e · 2024-10-02T07:57:47.000+02:00
- Display command and options when it fails - Keep the caller line at the top of the stack trace. PR-URL: #54622 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
diff --git a/test/common/child_process.js b/test/common/child_process.js
@@ -60,13 +60,14 @@ function checkOutput(str, check) {
 return { passed: true };
 }
 
-function expectSyncExit(child, {
+function expectSyncExit(caller, spawnArgs, {
 status,
 signal,
 stderr: stderrCheck,
 stdout: stdoutCheck,
 trim = false,
 }) {
+ const child = spawnSync(...spawnArgs);
 const failures = [];
 let stderrStr, stdoutStr;
 if (status !== undefined && child.status !== status) {
@@ -83,7 +84,18 @@ function expectSyncExit(child, {
 console.error(`${tag} --- stdout ---`);
 console.error(stdoutStr === undefined ? child.stdout.toString() : stdoutStr);
 console.error(`${tag} status = ${child.status}, signal = ${child.signal}`);
- throw new Error(`${failures.join('\n')}`);
+
+ const error = new Error(`${failures.join('\n')}`);
+ if (spawnArgs[2]) {
+ error.options = spawnArgs[2];
+ }
+ let command = spawnArgs[0];
+ if (Array.isArray(spawnArgs[1])) {
+ command += ' ' + spawnArgs[1].join(' ');
+ }
+ error.command = command;
+ Error.captureStackTrace(error, caller);
+ throw error;
 }
 
 // If status and signal are not matching expectations, fail early.
@@ -114,21 +126,19 @@ function expectSyncExit(child, {
 function spawnSyncAndExit(...args) {
 const spawnArgs = args.slice(0, args.length - 1);
 const expectations = args[args.length - 1];
- const child = spawnSync(...spawnArgs);
- return expectSyncExit(child, expectations);
+ return expectSyncExit(spawnSyncAndExit, spawnArgs, expectations);
 }
 
 function spawnSyncAndExitWithoutError(...args) {
- return expectSyncExit(spawnSync(...args), {
+ return expectSyncExit(spawnSyncAndExitWithoutError, [...args], {
 status: 0,
 signal: null,
 });
 }
 
 function spawnSyncAndAssert(...args) {
 const expectations = args.pop();
- const child = spawnSync(...args);
- return expectSyncExit(child, {
+ return expectSyncExit(spawnSyncAndAssert, [...args], {
 status: 0,
 signal: null,
 ...expectations,

-Original file line number
+Diff line change
 return{passed: true};
+}
 -functionexpectSyncExit(child,{
 +functionexpectSyncExit(caller,spawnArgs,{
  status,
  signal,
 stderr: stderrCheck,
 stdout: stdoutCheck,
  trim =false,
 }){
 +constchild=spawnSync(...spawnArgs);
 constfailures=[];
 letstderrStr,stdoutStr;
 if(status!==undefined&&child.status!==status){
 console.error(`${tag} --- stdout ---`);
 console.error(stdoutStr===undefined ? child.stdout.toString() : stdoutStr);
 console.error(`${tag} status = ${child.status}, signal = ${child.signal}`);
 -thrownewError(`${failures.join('\n')}`);
++
 +consterror=newError(`${failures.join('\n')}`);
 +if(spawnArgs[2]){
 +error.options=spawnArgs[2];
 +}
 +letcommand=spawnArgs[0];
 +if(Array.isArray(spawnArgs[1])){
 +command+=' '+spawnArgs[1].join(' ');
 +}
 +error.command=command;
 +Error.captureStackTrace(error,caller);
 +throwerror;
+}
 // If status and signal are not matching expectations, fail early.
 functionspawnSyncAndExit(...args){
 constspawnArgs=args.slice(0,args.length-1);
 constexpectations=args[args.length-1];
 -constchild=spawnSync(...spawnArgs);
 -returnexpectSyncExit(child,expectations);
 +returnexpectSyncExit(spawnSyncAndExit,spawnArgs,expectations);
+}
 functionspawnSyncAndExitWithoutError(...args){
 -returnexpectSyncExit(spawnSync(...args),{
 +returnexpectSyncExit(spawnSyncAndExitWithoutError,[...args],{
 status: 0,
 signal: null,
 });
+}
 functionspawnSyncAndAssert(...args){
 constexpectations=args.pop();
 -constchild=spawnSync(...args);
 -returnexpectSyncExit(child,{
 +returnexpectSyncExit(spawnSyncAndAssert,[...args],{
 status: 0,
 signal: null,
  ...expectations,