refactor: rewritting analytics test to be more hermetic and stable

This fixes a few issues with the test:
1. The test accidentally used the real user's `$HOME` directory which led to confusing, non-hermetic failures.
2. The test had timeouts of 5 milliseconds, rather than the presumably intended 5 seconds.
3. `ng update` would always fail because there's no project. Changed to `ng update --help` which still skips the analytics prompt but doesn't require a complicated setup.
4. The test would end after seeing the analytics prompt and wouldn't bother accepting it. I added functionality to send data to stdin to accept the prompt which makes test logic simpler (no need to manually kill all processes or wait for a timeout), though I didn't add any new assertions that the CLI actually tracks / doesn't track correctly.

Refs #23003.

Author: dgp1130

tests/legacy-cli/e2e/tests/misc/ask-analytics-command.ts

@@ -1,49 +1,63 @@
-import { execWithEnv, killAllProcesses, waitForAnyProcessOutputToMatch } from '../../utils/process';
-import { expectToFail } from '../../utils/utils';
+import { promises as fs } from 'fs';
+import { execWithEnv } from '../../utils/process';
+
+const ANALYTICS_PROMPT = /Would you like to share anonymous usage data/;
 
 export default async function () {
-  try {
-    // Execute a command with TTY force enabled
-    execWithEnv('ng', ['version'], {
-      ...process.env,
-      NG_FORCE_TTY: '1',
-    });
+  // CLI should prompt for analytics permissions.
+  await mockHome(async (home) => {
+    const { stdout } = await execWithEnv(
+      'ng',
+      ['version'],
+      {
+        ...process.env,
+        HOME: home,
+        NG_FORCE_TTY: '1',
+      },
+      'y' /* stdin */,
+    );
 
-    // Check if the prompt is shown
-    await waitForAnyProcessOutputToMatch(/Would you like to share anonymous usage data/);
-  } finally {
-    killAllProcesses();
-  }
+    if (!ANALYTICS_PROMPT.test(stdout)) {
+      throw new Error('CLI did not prompt for analytics permission.');
+    }
+  });
 
-  try {
-    // Execute a command with TTY force enabled
-    execWithEnv('ng', ['version'], {
+  // CLI should skip analytics prompt with `NG_CLI_ANALYTICS=false`.
+  await mockHome(async (home) => {
+    const { stdout } = await execWithEnv('ng', ['version'], {
       ...process.env,
+      HOME: home,
       NG_FORCE_TTY: '1',
       NG_CLI_ANALYTICS: 'false',
     });
 
-    // Check if the prompt is shown
-    await expectToFail(() =>
-      waitForAnyProcessOutputToMatch(/Would you like to share anonymous usage data/, 5),
-    );
-  } finally {
-    killAllProcesses();
-  }
+    if (ANALYTICS_PROMPT.test(stdout)) {
+      throw new Error('CLI prompted for analytics permission when it should be forced off.');
+    }
+  });
 
-  // Should not show a prompt when using update
-  try {
-    // Execute a command with TTY force enabled
-    execWithEnv('ng', ['update'], {
+  // CLI should skip analytics prompt during `ng update`.
+  await mockHome(async (home) => {
+    const { stdout } = await execWithEnv('ng', ['update', '--help'], {
       ...process.env,
+      HOME: home,
       NG_FORCE_TTY: '1',
     });
 
-    // Check if the prompt is shown
-    await expectToFail(() =>
-      waitForAnyProcessOutputToMatch(/Would you like to share anonymous usage data/, 5),
-    );
+    if (ANALYTICS_PROMPT.test(stdout)) {
+      throw new Error(
+        'CLI prompted for analytics permission during an update where it should not' + ' have.',
+      );
+    }
+  });
+}
+
+async function mockHome(cb: (home: string) => Promise<void>): Promise<void> {
+  const tempHome = await fs.mkdtemp('angular-cli-e2e-home-');
+
+  try {
+    await cb(tempHome);
   } finally {
-    killAllProcesses();
+    await fs.rm(tempHome, { recursive: true, force: true });
   }
 }

tests/legacy-cli/e2e/utils/process.ts

@@ -11,6 +11,7 @@ interface ExecOptions {
   silent?: boolean;
   waitForMatch?: RegExp;
   env?: { [varname: string]: string };
+  stdin?: string;
 }
 
 let _processes: child_process.ChildProcess[] = [];
@@ -107,6 +108,10 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
         ),
       );
     });
+    childProcess.on('error', (error) => {
+      err.message += `${error}...\n\nSTDOUT:\n${stdout}\n\nSTDERR:\n${stderr}\n`;
+      reject(err);
+    });
 
     if (options.waitForMatch) {
       const match = options.waitForMatch;
@@ -123,6 +128,12 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
         }
       });
     }
+
+    // Provide input to stdin if given.
+    if (options.stdin) {
+      childProcess.stdin.write(options.stdin);
+      childProcess.stdin.end();
+    }
   });
 }
 
@@ -174,8 +185,13 @@ export function silentExec(cmd: string, ...args: string[]) {
   return _exec({ silent: true }, cmd, args);
 }
 
-export function execWithEnv(cmd: string, args: string[], env: { [varname: string]: string }) {
-  return _exec({ env }, cmd, args);
+export function execWithEnv(
+  cmd: string,
+  args: string[],
+  env: { [varname: string]: string },
+  stdin?: string,
+) {
+  return _exec({ env, stdin }, cmd, args);
 }
 
 export function execAndWaitForOutputToMatch(cmd: string, args: string[], match: RegExp) {