test: use local yarn instead of depending on global npm

Author: jbedard

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

@@ -1,22 +1,27 @@
 import { mkdir, writeFile } from 'fs/promises';
 import { join } from 'path';
-import { getGlobalVariable } from '../utils/env';
+import { getGlobalVariable, setGlobalVariable } from '../utils/env';
+import { globalYarn } from '../utils/process';
 
 /**
  * Configure npm to use a unique sandboxed environment.
  */
 export default async function () {
   const tempRoot: string = getGlobalVariable('tmp-root');
   const npmModulesPrefix = join(tempRoot, 'npm-global');
+  const yarnModuleCache = join(tempRoot, 'yarn-cache-folder');
+  const yarnModulesPrefix = join(tempRoot, 'yarn-global');
   const npmRegistry: string = getGlobalVariable('package-registry');
   const npmrc = join(tempRoot, '.npmrc');
+  const yarnrc = join(tempRoot, '.yarnrc');
 
   // 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.
   process.env.NPM_CONFIG_USERCONFIG = npmrc;
   process.env.NPM_CONFIG_PREFIX = npmModulesPrefix;
   process.env.NPM_CONFIG_REGISTRY = npmRegistry;
+  process.env.YARN_CACHE_FOLDER = yarnModuleCache;
 
   // 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.
@@ -25,9 +30,18 @@ export default async function () {
     process.env['NPM_CONFIG_legacy_peer_deps'] = 'true';
   }
 
-  // Configure the registry and prefix used within the test sandbox
+  // Configure the registry and create the prefix directories
   await writeFile(npmrc, `registry=${npmRegistry}\nprefix=${npmModulesPrefix}`);
+  await writeFile(
+    yarnrc,
+    `registry ${npmRegistry}\nprefix ${yarnModulesPrefix}\ncache-folder ${yarnModuleCache}`,
+  );
   await mkdir(npmModulesPrefix);
+  await mkdir(yarnModulesPrefix);
+  await mkdir(yarnModuleCache);
+
+  setGlobalVariable('npm-global', npmModulesPrefix);
+  setGlobalVariable('yarn-global', yarnModulesPrefix);
 
   console.log(`  Using "${npmModulesPrefix}" as e2e test global npm cache.`);
 }

tests/legacy-cli/e2e/setup/010-local-publish.ts

@@ -1,15 +1,13 @@
 import { getGlobalVariable } from '../utils/env';
-import { execWithEnv, extractNpmEnv } from '../utils/process';
+import { globalYarn, extractNpmEnv } from '../utils/process';
 import { isPrereleaseCli } from '../utils/project';
 
 export default async function () {
   const testRegistry: string = getGlobalVariable('package-registry');
-  await execWithEnv(
-    'npm',
+  await globalYarn(
     [
       'run',
       'admin',
-      '--',
       'publish',
       '--no-versionCheck',
       '--no-branchCheck',
@@ -18,10 +16,12 @@ export default async function () {
       isPrereleaseCli() ? 'next' : 'latest',
     ],
     {
-      ...extractNpmEnv(),
-      // Also set an auth token value for the local test registry which is required by npm 7+
-      // even though it is never actually used.
-      'NPM_CONFIG__AUTH': 'e2e-testing',
+      env: {
+        ...extractNpmEnv(),
+        // Also set an auth token value for the local test registry which is required by npm 7+
+        // even though it is never actually used.
+        'NPM_CONFIG__AUTH': 'e2e-testing',
+      },
     },
   );
 }

tests/legacy-cli/e2e/setup/100-global-cli.ts

@@ -1,5 +1,5 @@
 import { getGlobalVariable } from '../utils/env';
-import { silentNpm } from '../utils/process';
+import { globalYarn } from '../utils/process';
 
 const NPM_VERSION = '7.24.0';
 const YARN_VERSION = '1.22.18';
@@ -13,12 +13,12 @@ export default async function () {
   const testRegistry: string = getGlobalVariable('package-registry');
 
   // Install global Angular CLI being tested, npm+yarn used by e2e tests.
-  await silentNpm(
-    'install',
-    '--global',
+  await globalYarn([
+    'global',
+    'add',
     `--registry=${testRegistry}`,
     '@angular/cli',
     `npm@${NPM_VERSION}`,
     `yarn@${YARN_VERSION}`,
-  );
+  ]);
 }

tests/legacy-cli/e2e/tests/commands/completion/completion-prompt.ts

@@ -7,6 +7,7 @@ import {
   execAndCaptureError,
   execAndWaitForOutputToMatch,
   execWithEnv,
+  globalYarn,
   silentNpm,
 } from '../../../utils/process';
 
@@ -393,7 +394,7 @@ source <(ng completion script)
   await mockHome(async (home) => {
     try {
       // Temporarily uninstall the global CLI binary from the system.
-      await silentNpm(['uninstall', '--global', '@angular/cli', `--registry=${testRegistry}`]);
+      await globalYarn(['global', 'remove', '@angular/cli', `--registry=${testRegistry}`]);
 
       // Setup a fake project directory with a local install of the CLI.
       const projectDir = path.join(home, 'project');
@@ -425,7 +426,7 @@ source <(ng completion script)
       }
     } finally {
       // Reinstall global CLI for remainder of the tests.
-      await silentNpm(['install', '--global', '@angular/cli', `--registry=${testRegistry}`]);
+      await globalYarn(['global', 'add', '@angular/cli', `--registry=${testRegistry}`]);
     }
   });
 }

tests/legacy-cli/e2e/tests/commands/completion/completion.ts

@@ -6,6 +6,7 @@ import {
   execAndCaptureError,
   execAndWaitForOutputToMatch,
   execWithEnv,
+  globalYarn,
   silentNpm,
 } from '../../../utils/process';
 
@@ -358,7 +359,7 @@ source <(ng completion script)
   await mockHome(async (home) => {
     try {
       // Temporarily uninstall the global CLI binary from the system.
-      await silentNpm(['uninstall', '--global', '@angular/cli', `--registry=${testRegistry}`]);
+      await globalYarn(['global', 'remove', '@angular/cli', `--registry=${testRegistry}`]);
 
       // Setup a fake project directory with a local install of the CLI.
       const projectDir = path.join(home, 'project');
@@ -381,7 +382,7 @@ source <(ng completion script)
       }
     } finally {
       // Reinstall global CLI for remainder of the tests.
-      await silentNpm(['install', '--global', '@angular/cli', `--registry=${testRegistry}`]);
+      await globalYarn(['global', 'add', '@angular/cli', `--registry=${testRegistry}`]);
     }
   });
 }

tests/legacy-cli/e2e/tests/misc/npm-7.ts

@@ -3,7 +3,7 @@ import { execSync } from 'child_process';
 import { valid as validSemVer } from 'semver';
 import { rimraf } from '../../utils/fs';
 import { getActivePackageManager } from '../../utils/packages';
-import { execWithEnv, ng, npm } from '../../utils/process';
+import { execWithEnv, globalYarn, ng } from '../../utils/process';
 import { isPrereleaseCli } from '../../utils/project';
 import { expectToFail } from '../../utils/utils';
 
@@ -46,7 +46,7 @@ export default async function () {
 
   try {
     // Install version >=7.5.6
-    await npm('install', '--global', 'npm@>=7.5.6');
+    await globalYarn(['global', 'add', 'npm@>=7.5.6']);
 
     // Ensure `ng update` does not show npm warning
     const { stderr: stderrUpdate1 } = await ng('update', ...extraArgs);
@@ -55,7 +55,7 @@ export default async function () {
     }
 
     // Install version <7.5.6
-    await npm('install', '--global', 'npm@7.4.0');
+    await globalYarn(['global', 'add', 'npm@7.4.0']);
 
     // Ensure `ng add` shows npm warning
     const { stderr: stderrAdd } = await execWithEnv(
@@ -115,6 +115,6 @@ export default async function () {
     process.chdir(currentDirectory);
 
     // Reset version back to initial version
-    await npm('install', '--global', `npm@${initialVersion}`);
+    await globalYarn(['global', 'add', `npm@${initialVersion}`]);
   }
 }

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[] = [];
 
@@ -322,6 +322,23 @@ export function silentYarn(...args: string[]) {
   return _exec({ silent: true }, 'yarn', args);
 }
 
+const YARN = join(__dirname, '../../../../.yarn/releases/yarn-1.22.17.cjs');
+
+export function globalYarn(
+  args: string[],
+  { silent, env }: Pick<ExecOptions, 'silent' | 'env'> = {},
+) {
+  // Use the yarn global cache when executing yarn
+  const npmPrefix = process.env.NPM_CONFIG_PREFIX;
+  try {
+    process.env.NPM_CONFIG_PREFIX = getGlobalVariable('yarn-global');
+
+    return _exec({ silent: silent ?? false /*TODO: true*/, env }, 'node', [YARN, ...args]);
+  } finally {
+    process.env.NPM_CONFIG_PREFIX = npmPrefix;
+  }
+}
+
 export function npm(...args: string[]) {
   return _exec({}, 'npm', args);
 }
@@ -361,12 +378,14 @@ export async function launchTestProcess(entry: string, ...args: any[]) {
   // 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
+  // Ensure the custom npm and yarn global bin is on the PATH
   // https://docs.npmjs.com/cli/v8/configuring-npm/folders#executables
+  paths.unshift(join(getGlobalVariable('yarn-global'), 'bin'));
+  paths.unshift(join(getGlobalVariable('yarn-global'))); // TODO: which one on windows?
   if (process.platform.startsWith('win')) {
-    paths.unshift(env.NPM_CONFIG_PREFIX!);
+    paths.unshift(getGlobalVariable('npm-global'));
   } else {
-    paths.unshift(join(env.NPM_CONFIG_PREFIX!, 'bin'));
+    paths.unshift(join(getGlobalVariable('npm-global'), 'bin'));
   }
 
   env.PATH = paths.join(delimiter);