test: isolate yarn global cache in test sandbox

Author: jbedard

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

@@ -8,28 +8,51 @@ import { getGlobalVariable, setGlobalVariable } from '../utils/env';
 export default async function () {
   const tempRoot: string = getGlobalVariable('tmp-root');
   const npmModulesPrefix = join(tempRoot, 'npm-global');
+  const yarnModulesPrefix = join(tempRoot, 'yarn-global');
   const npmRegistry: string = getGlobalVariable('package-registry');
   const npmrc = join(tempRoot, '.npmrc');
+  const yarnrc = join(tempRoot, '.yarnrc');
+  const npmCacheFolder = join(tempRoot, 'npm-cache-folder');
+  const yarnCacheFolder = join(tempRoot, 'yarn-cache-folder');
 
-  // Configure npm to use the sandboxed npm globals and rc file
-  // From this point onward all npm transactions use the "global" npm cache
-  // isolated within this e2e test invocation.
+  // Change the npm+yarn userconfig to the sandboxed npmrc to override the default ~
   process.env.NPM_CONFIG_USERCONFIG = npmrc;
-  process.env.NPM_CONFIG_PREFIX = npmModulesPrefix;
+
+  // The npm+yarn registry URL
   process.env.NPM_CONFIG_REGISTRY = npmRegistry;
 
+  // Configure npm+yarn to use a sandboxed bin directory
+  // From this point onward all yarn/npm bin files/symlinks are put into the prefix directories
+  process.env.NPM_CONFIG_PREFIX = npmModulesPrefix;
+  process.env.YARN_CONFIG_PREFIX = yarnModulesPrefix;
+
+  // Package cache diretories
+  process.env.NPM_CONFIG_CACHE = npmCacheFolder;
+  process.env.YARN_CACHE_FOLDER = yarnCacheFolder;
+
   // Snapshot builds may contain versions that are not yet released (e.g., RC phase main branch).
   // In this case peer dependency ranges may not resolve causing npm 7+ to fail during tests.
   // To support this case, legacy peer dependency mode is enabled for snapshot builds.
   if (getGlobalVariable('argv')['ng-snapshots']) {
     process.env['NPM_CONFIG_legacy_peer_deps'] = 'true';
   }
 
-  // Configure the registry and prefix used within the test sandbox
-  await writeFile(npmrc, `registry=${npmRegistry}\nprefix=${npmModulesPrefix}`);
+  // Configure the registry and prefix used within the test sandbox via rc files
+  await writeFile(
+    npmrc,
+    `registry=${npmRegistry}\nprefix=${npmModulesPrefix}\ncache=${npmCacheFolder}`,
+  );
+  await writeFile(
+    yarnrc,
+    `registry ${npmRegistry}\nprefix ${yarnModulesPrefix}\ncache-folder ${yarnCacheFolder}`,
+  );
   await mkdir(npmModulesPrefix);
+  await mkdir(yarnModulesPrefix);
+  await mkdir(yarnCacheFolder);
 
   setGlobalVariable('npm-global', npmModulesPrefix);
+  setGlobalVariable('yarn-global', yarnModulesPrefix);
 
-  console.log(`  Using "${npmModulesPrefix}" as e2e test global npm cache.`);
+  console.log(`  Using "${npmModulesPrefix}" as e2e test global npm bin dir.`);
+  console.log(`  Using "${yarnModulesPrefix}" as e2e test global yarn bin dir.`);
 }

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

@@ -16,7 +16,7 @@ interface ExecOptions {
   cwd?: string;
 }
 
-const NPM_CONFIG_RE = /^npm_config_/i;
+const NPM_CONFIG_RE = /^(npm_config_|yarn_)/i;
 
 let _processes: child_process.ChildProcess[] = [];
 
@@ -41,6 +41,7 @@ function _exec(options: ExecOptions, cmd: string, args: string[]): Promise<Proce
   // 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('yarn-global'), 'bin'),
     join(getGlobalVariable('npm-global'), process.platform.startsWith('win') ? '' : 'bin'),
     env.PATH || process.env['PATH'],
   ].join(delimiter);