test: reject promise when output doesn't match waitForMatch

alan-agius4 · dgp1130 · commit 269fb87ae171 · 2022-05-03T12:16:33.000-07:00
Previously, when the process output didn't match, the promise was always resolved.
diff --git a/tests/legacy-cli/e2e/tests/misc/completion.ts b/tests/legacy-cli/e2e/tests/misc/completion.ts
@@ -2,49 +2,61 @@ import { execAndWaitForOutputToMatch } from '../../utils/process';
 
 export default async function () {
   // ng build
-  await execAndWaitForOutputToMatch('ng', ['--get-yargs-completions', 'b', ''], /test-project/);
-  await execAndWaitForOutputToMatch('ng', ['--get-yargs-completions', 'build', ''], /test-project/);
-  await execAndWaitForOutputToMatch('ng', ['--get-yargs-completions', 'build', '--a'], /--aot/);
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'build', '--configuration'],
+    ['--get-yargs-completions', 'ng', 'b', ''],
+    /test-project/,
+  );
+  await execAndWaitForOutputToMatch(
+    'ng',
+    ['--get-yargs-completions', 'ng', 'build', ''],
+    /test-project/,
+  );
+  await execAndWaitForOutputToMatch(
+    'ng',
+    ['--get-yargs-completions', 'ng', 'build', '--a'],
+    /--aot/,
+  );
+  await execAndWaitForOutputToMatch(
+    'ng',
+    ['--get-yargs-completions', 'ng', 'build', '--configuration'],
     /production/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'b', '--configuration'],
+    ['--get-yargs-completions', 'ng', 'b', '--configuration'],
     /production/,
   );
 
   // ng run
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', ''],
-    /test-project\:build\:development/,
+    ['--get-yargs-completions', 'ng', 'run', ''],
+    /test-project\\:build\\:development/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', ''],
-    /test-project\:build/,
+    ['--get-yargs-completions', 'ng', 'run', ''],
+    /test-project\\:build/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', ''],
-    /test-project\:test/,
+    ['--get-yargs-completions', 'ng', 'run', ''],
+    /test-project\\:test/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', 'test-project:build'],
-    /test-project\:build\:development/,
+    ['--get-yargs-completions', 'ng', 'run', 'test-project:build'],
+    /test-project\\:build\\:development/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', 'test-project:'],
-    /test-project\:test/,
+    ['--get-yargs-completions', 'ng', 'run', 'test-project:'],
+    /test-project\\:test/,
   );
   await execAndWaitForOutputToMatch(
     'ng',
-    ['--get-yargs-completions', 'run', 'test-project:build'],
+    ['--get-yargs-completions', 'ng', 'run', 'test-project:build'],
     // does not include 'test-project:serve'
     /^((?!:serve).)*$/,
   );
diff --git a/tests/legacy-cli/e2e/utils/process.ts b/tests/legacy-cli/e2e/utils/process.ts
@@ -1,29 +1,26 @@
 import * as ansiColors from 'ansi-colors';
-import { SpawnOptions } from "child_process";
+import { SpawnOptions } from 'child_process';
 import * as child_process from 'child_process';
-import { concat, defer, EMPTY, from} from 'rxjs';
-import {repeat, takeLast} from 'rxjs/operators';
-import {getGlobalVariable} from './env';
-import {catchError} from 'rxjs/operators';
+import { concat, defer, EMPTY, from } from 'rxjs';
+import { repeat, takeLast } from 'rxjs/operators';
+import { getGlobalVariable } from './env';
+import { catchError } from 'rxjs/operators';
 const treeKill = require('tree-kill');
 
-
 interface ExecOptions {
   silent?: boolean;
   waitForMatch?: RegExp;
   env?: { [varname: string]: string };
 }
 
-
 let _processes: child_process.ChildProcess[] = [];
 
 export type ProcessOutput = {
   stdout: string;
   stderr: string;
 };
 
-
-function  _exec(options: ExecOptions, cmd: string, args: string[]): Promise<ProcessOutput> {
+function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<ProcessOutput> {
   // Create a separate instance to prevent unintended global changes to the color configuration
   // Create function is not defined in the typings. See: https://github.com/doowb/ansi-colors/pull/44
   const colors = (ansiColors as typeof ansiColors & { create: () => typeof ansiColors }).create();
@@ -33,24 +30,24 @@ function  _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proc
   const cwd = process.cwd();
   const env = options.env;
   console.log(
-    `==========================================================================================`
+    `==========================================================================================`,
   );
 
-  args = args.filter(x => x !== undefined);
+  args = args.filter((x) => x !== undefined);
   const flags = [
     options.silent && 'silent',
-    options.waitForMatch && `matching(${options.waitForMatch})`
+    options.waitForMatch && `matching(${options.waitForMatch})`,
   ]
-    .filter(x => !!x)  // Remove false and undefined.
+    .filter((x) => !!x) // Remove false and undefined.
     .join(', ')
-    .replace(/^(.+)$/, ' [$1]');  // Proper formatting.
+    .replace(/^(.+)$/, ' [$1]'); // Proper formatting.
 
-  console.log(colors.blue(`Running \`${cmd} ${args.map(x => `"${x}"`).join(' ')}\`${flags}...`));
+  console.log(colors.blue(`Running \`${cmd} ${args.map((x) => `"${x}"`).join(' ')}\`${flags}...`));
   console.log(colors.blue(`CWD: ${cwd}`));
   console.log(colors.blue(`ENV: ${JSON.stringify(env)}`));
   const spawnOptions: SpawnOptions = {
     cwd,
-    ...env ? { env } : {},
+    ...(env ? { env } : {}),
   };
 
   if (process.platform.startsWith('win')) {
@@ -65,56 +62,74 @@ function  _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proc
     if (options.silent) {
       return;
     }
-    data.toString('utf-8')
+    data
+      .toString('utf-8')
       .split(/[\n\r]+/)
-      .filter(line => line !== '')
-      .forEach(line => console.log('  ' + line));
+      .filter((line) => line !== '')
+      .forEach((line) => console.log('  ' + line));
   });
   childProcess.stderr.on('data', (data: Buffer) => {
     stderr += data.toString('utf-8');
     if (options.silent) {
       return;
     }
-    data.toString('utf-8')
+    data
+      .toString('utf-8')
       .split(/[\n\r]+/)
-      .filter(line => line !== '')
-      .forEach(line => console.error(colors.yellow('  ' + line)));
+      .filter((line) => line !== '')
+      .forEach((line) => console.error(colors.yellow('  ' + line)));
   });
 
   _processes.push(childProcess);
 
   // Create the error here so the stack shows who called this function.
-  const err = new Error(`Running "${cmd} ${args.join(' ')}" returned error code `);
+
   return new Promise((resolve, reject) => {
+    let matched = false;
+
     childProcess.on('exit', (error: any) => {
-      _processes = _processes.filter(p => p !== childProcess);
+      _processes = _processes.filter((p) => p !== childProcess);
+
+      if (options.waitForMatch && !matched) {
+        error = `Output didn't match '${options.waitForMatch}'.`;
+      }
 
       if (!error) {
         resolve({ stdout, stderr });
-      } else {
-        err.message += `${error}...\n\nSTDOUT:\n${stdout}\n\nSTDERR:\n${stderr}\n`;
-        reject(err);
+        return;
       }
+
+      reject(
+        new Error(
+          `Running "${cmd} ${args.join(
+            ' ',
+          )}" returned error. ${error}...\n\nSTDOUT:\n${stdout}\n\nSTDERR:\n${stderr}\n`,
+        ),
+      );
     });
 
     if (options.waitForMatch) {
       const match = options.waitForMatch;
       childProcess.stdout.on('data', (data: Buffer) => {
         if (data.toString().match(match)) {
           resolve({ stdout, stderr });
+          matched = true;
         }
       });
       childProcess.stderr.on('data', (data: Buffer) => {
         if (data.toString().match(match)) {
           resolve({ stdout, stderr });
+          matched = true;
         }
       });
     }
   });
 }
 
-export function waitForAnyProcessOutputToMatch(match: RegExp,
-                                               timeout = 30000): Promise<ProcessOutput> {
+export function waitForAnyProcessOutputToMatch(
+  match: RegExp,
+  timeout = 30000,
+): Promise<ProcessOutput> {
   // Race between _all_ processes, and the timeout. First one to resolve/reject wins.
   const timeoutPromise: Promise<ProcessOutput> = new Promise((_resolve, reject) => {
     // Wait for 30 seconds and timeout.
@@ -124,28 +139,30 @@ export function waitForAnyProcessOutputToMatch(match: RegExp,
   });
 
   const matchPromises: Promise<ProcessOutput>[] = _processes.map(
-    childProcess => new Promise(resolve => {
-      let stdout = '';
-      let stderr = '';
-      childProcess.stdout.on('data', (data: Buffer) => {
-        stdout += data.toString();
-        if (data.toString().match(match)) {
-          resolve({ stdout, stderr });
-        }
-      });
-      childProcess.stderr.on('data', (data: Buffer) => {
-        stderr += data.toString();
-        if (data.toString().match(match)) {
-          resolve({ stdout, stderr });
-        }
-      });
-    }));
+    (childProcess) =>
+      new Promise((resolve) => {
+        let stdout = '';
+        let stderr = '';
+        childProcess.stdout.on('data', (data: Buffer) => {
+          stdout += data.toString();
+          if (data.toString().match(match)) {
+            resolve({ stdout, stderr });
+          }
+        });
+        childProcess.stderr.on('data', (data: Buffer) => {
+          stderr += data.toString();
+          if (data.toString().match(match)) {
+            resolve({ stdout, stderr });
+          }
+        });
+      }),
+  );
 
   return Promise.race(matchPromises.concat([timeoutPromise]));
 }
 
 export function killAllProcesses(signal = 'SIGTERM') {
-  _processes.forEach(process => treeKill(process.pid, signal));
+  _processes.forEach((process) => treeKill(process.pid, signal));
   _processes = [];
 }
 
@@ -169,16 +186,14 @@ export function execAndWaitForOutputToMatch(cmd: string, args: string[], match:
     // This seems to be due to host file system differences, see
     // https://nodejs.org/docs/latest/api/fs.html#fs_caveats
     return concat(
-      from(
-        _exec({ waitForMatch: match }, cmd, args)
-      ),
+      from(_exec({ waitForMatch: match }, cmd, args)),
       defer(() => waitForAnyProcessOutputToMatch(match, 2500)).pipe(
         repeat(20),
         catchError(() => EMPTY),
       ),
-    ).pipe(
-      takeLast(1),
-    ).toPromise();
+    )
+      .pipe(takeLast(1))
+      .toPromise();
   } else {
     return _exec({ waitForMatch: match }, cmd, args);
   }
@@ -190,8 +205,7 @@ export function ng(...args: string[]) {
   if (['build', 'serve', 'test', 'e2e', 'extract-i18n'].indexOf(args[0]) != -1) {
     if (args[0] == 'e2e') {
       // Wait 1 second before running any end-to-end test.
-      return new Promise(resolve => setTimeout(resolve, 1000))
-        .then(() => maybeSilentNg(...args));
+      return new Promise((resolve) => setTimeout(resolve, 1000)).then(() => maybeSilentNg(...args));
     }
 
     return maybeSilentNg(...args);
@@ -205,15 +219,15 @@ export function noSilentNg(...args: string[]) {
 }
 
 export function silentNg(...args: string[]) {
-  return _exec({silent: true}, 'ng', args);
+  return _exec({ silent: true }, 'ng', args);
 }
 
 export function silentNpm(...args: string[]) {
-  return _exec({silent: true}, 'npm', args);
+  return _exec({ silent: true }, 'npm', args);
 }
 
 export function silentYarn(...args: string[]) {
-  return _exec({silent: true}, 'yarn', args);
+  return _exec({ silent: true }, 'yarn', args);
 }
 
 export function npm(...args: string[]) {
@@ -229,5 +243,5 @@ export function git(...args: string[]) {
 }
 
 export function silentGit(...args: string[]) {
-  return _exec({silent: true}, 'git', args);
+  return _exec({ silent: true }, 'git', args);
 }
