test: ensure private npm is always on PATH

Author: jbedard

tests/legacy-cli/e2e/setup/002-npm-sandbox.ts

@@ -1,6 +1,6 @@
 import { mkdir, writeFile } from 'fs/promises';
 import { join } from 'path';
-import { getGlobalVariable } from '../utils/env';
+import { getGlobalVariable, setGlobalVariable } from '../utils/env';
 
 /**
  * Configure npm to use a unique sandboxed environment.
@@ -29,5 +29,7 @@ export default async function () {
   await writeFile(npmrc, `registry=${npmRegistry}\nprefix=${npmModulesPrefix}`);
   await mkdir(npmModulesPrefix);
 
+  setGlobalVariable('npm-global', npmModulesPrefix);
+
   console.log(`  Using "${npmModulesPrefix}" as e2e test global npm cache.`);
 }

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

@@ -32,11 +32,18 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
   let stdout = '';
   let stderr = '';
   const cwd = options.cwd ?? process.cwd();
-  const env = options.env;
+  const env = options.env ?? process.env;
   console.log(
     `==========================================================================================`,
   );
 
+  // Ensure the custom npm and yarn global bin is on the PATH
+  // https://docs.npmjs.com/cli/v8/configuring-npm/folders#executables
+  const paths = [
+    join(getGlobalVariable('npm-global'), process.platform.startsWith('win') ? '' : 'bin'),
+    env.PATH || process.env['PATH'],
+  ].join(delimiter);
+
   args = args.filter((x) => x !== undefined);
   const flags = [
     options.silent && 'silent',
@@ -51,7 +58,7 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
 
   const spawnOptions: SpawnOptions = {
     cwd,
-    ...(env ? { env } : {}),
+    env: { ...env, PATH: paths },
   };
 
   if (process.platform.startsWith('win')) {
@@ -146,15 +153,10 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
 export function extractNpmEnv() {
   return Object.keys(process.env)
     .filter((v) => NPM_CONFIG_RE.test(v))
-    .reduce<NodeJS.ProcessEnv>(
-      (vars, n) => {
-        vars[n] = process.env[n];
-        return vars;
-      },
-      {
-        PATH: process.env.PATH,
-      },
-    );
+    .reduce<NodeJS.ProcessEnv>((vars, n) => {
+      vars[n] = process.env[n];
+      return vars;
+    }, {});
 }
 
 export function waitForAnyProcessOutputToMatch(
@@ -364,20 +366,12 @@ export async function launchTestProcess(entry: string, ...args: any[]) {
   };
 
   // Modify the PATH environment variable...
-  let paths = process.env.PATH!.split(delimiter);
+  let paths = (env.PATH || process.env.PATH)!.split(delimiter);
 
   // Only include paths within the sandboxed test environment or external
   // non angular-cli paths such as /usr/bin for generic commands.
   paths = paths.filter((p) => p.startsWith(tempRoot) || !p.includes('angular-cli'));
 
-  // Ensure the custom npm global bin is on the PATH
-  // https://docs.npmjs.com/cli/v8/configuring-npm/folders#executables
-  if (process.platform.startsWith('win')) {
-    paths.unshift(env.NPM_CONFIG_PREFIX!);
-  } else {
-    paths.unshift(join(env.NPM_CONFIG_PREFIX!, 'bin'));
-  }
-
   env.PATH = paths.join(delimiter);
 
   return _exec({ env }, process.execPath, [resolve(__dirname, 'run_test_process'), entry, ...args]);