test: remove use of global npm installs

jbedard · jbedard · commit 3d4d936519eb · 2022-05-12T16:59:13.000-07:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -204,10 +204,8 @@ jobs:
       - browser-tools/install-chrome
       - run:
           name: Initialize Environment
-          # npm 7 currently does not properly publish the packages locally
           command: |
             ./.circleci/env.sh
-            sudo npm install --global npm@6
       - run:
           name: Execute CLI E2E Tests
           command: |
@@ -345,7 +343,7 @@ workflows:
             - setup
       - e2e-cli:
           name: e2e-cli
-          nodeversion: '14.15'
+          nodeversion: '14.17'
           post-steps:
             - store_artifacts:
                 path: /tmp/dist
diff --git a/package.json b/package.json
@@ -171,6 +171,7 @@
     "minimatch": "5.0.1",
     "ng-packagr": "14.0.0-rc.0",
     "node-fetch": "^2.2.0",
+    "npm": "6.14.15",
     "npm-package-arg": "9.0.2",
     "open": "8.4.0",
     "ora": "5.4.1",
@@ -219,6 +220,7 @@
     "webpack-subresource-integrity": "5.1.0",
     "yargs": "17.5.0",
     "yargs-parser": "21.0.1",
+    "yarn": "^1.22.18",
     "zone.js": "^0.11.3"
   }
 }
diff --git a/tests/legacy-cli/e2e/setup/100-create-tmp-dir.ts b/tests/legacy-cli/e2e/setup/100-create-tmp-dir.ts
diff --git a/tests/legacy-cli/e2e/setup/100-global-cli.ts b/tests/legacy-cli/e2e/setup/100-global-cli.ts
diff --git a/tests/legacy-cli/e2e/setup/200-install-cli.ts b/tests/legacy-cli/e2e/setup/200-install-cli.ts
@@ -0,0 +1,16 @@
+import { delimiter, join } from 'path';
+import { getGlobalVariable } from '../utils/env';
+import { npm } from '../utils/process';
+
+// Tested packages required on the $PATH
+const TESTED_BIN_PACKAGES = ['@angular/cli', '@angular-devkit/schematics-cli'];
+
+export default async function () {
+  const testRegistry = getGlobalVariable('package-registry');
+
+  // Install the packages being tested
+  await npm('install', `--registry=${testRegistry}`, ...TESTED_BIN_PACKAGES);
+
+  // Ensure the npm .bin for the packages is first on the PATH
+  process.env.PATH = join(process.cwd(), 'node_modules', '.bin') + delimiter + process.env.PATH;
+}
diff --git a/tests/legacy-cli/e2e/tests/misc/npm-7.ts b/tests/legacy-cli/e2e/tests/misc/npm-7.ts
@@ -1,10 +1,13 @@
+import { mkdtempSync, realpathSync } from 'fs';
+import { tmpdir } from 'os';
+import { delimiter, join } from 'path';
+import * as semver from 'semver';
 import { rimraf } from '../../utils/fs';
 import { getActivePackageManager } from '../../utils/packages';
-import { ng, npm } from '../../utils/process';
+import { exec, execAndWaitForOutputToMatch, ng, npm } from '../../utils/process';
 import { isPrereleaseCli } from '../../utils/project';
-import { expectToFail } from '../../utils/utils';
 
-const warningText = 'npm version 7.5.6 or higher is recommended';
+const warningTextRe = /npm version 7\.5\.6 or higher is recommended/;
 
 export default async function () {
   // Only relevant with npm as a package manager
@@ -24,61 +27,60 @@ export default async function () {
     extraArgs.push('--next');
   }
 
+  // Add the npmModuleDir to the PATH so the test-installed npm is used
+  process.env.PATH = join(currentDirectory, 'node_modules', '.bin') + delimiter + process.env.PATH;
+
   try {
-    // Install version >=7.5.6
-    await npm('install', '--global', 'npm@>=7.5.6');
+    // Install and verify npm version >=7.5.6
+    await npm('install', 'npm@>=7.5.6');
+    const { stdout: npm75Version } = await exec('npm', '--version');
+    if (!semver.gte(npm75Version, '7.5.6')) {
+      throw new Error('npm install >=7.5.6 failed');
+    }
 
     // Ensure `ng update` does not show npm warning
     const { stderr: stderrUpdate1 } = await ng('update', ...extraArgs);
-    if (stderrUpdate1.includes(warningText)) {
+    if (stderrUpdate1.match(warningTextRe)) {
       throw new Error('ng update expected to not show npm version warning.');
     }
 
-    // Install version <7.5.6
-    await npm('install', '--global', 'npm@7.4.0');
+    // Install and verify npm version <7.5.6
+    await npm('install', 'npm@7.4.0');
+    const { stdout: npm74Version } = await exec('npm', '--version');
+    if (!semver.eq(npm74Version, '7.4.0')) {
+      throw new Error('npm install =7.4.0 failed');
+    }
 
     // Ensure `ng add` shows npm warning
-    const { stderr: stderrAdd } = await ng('add', '@angular/localize');
-    if (!stderrAdd.includes(warningText)) {
-      throw new Error('ng add expected to show npm version warning.');
-    }
+    await execAndWaitForOutputToMatch('ng', ['add', '@angular/localize'], warningTextRe);
 
     // Ensure `ng update` shows npm warning
-    const { stderr: stderrUpdate2 } = await ng('update', ...extraArgs);
-    if (!stderrUpdate2.includes(warningText)) {
-      throw new Error('ng update expected to show npm version warning.');
-    }
+    await execAndWaitForOutputToMatch('ng', ['update', ...extraArgs], warningTextRe);
 
     // Ensure `ng build` executes successfully
     const { stderr: stderrBuild } = await ng('build', '--configuration=development');
-    if (stderrBuild.includes(warningText)) {
+    if (stderrBuild.match(warningTextRe)) {
       throw new Error('ng build expected to not show npm version warning.');
     }
 
     // Ensure `ng new` shows npm warning
     // Must be outside the project for `ng new`
     process.chdir('..');
-    const { message: stderrNew } = await expectToFail(() => ng('new'));
-    if (!stderrNew.includes(warningText)) {
-      throw new Error('ng new expected to show npm version warning.');
-    }
+    await execAndWaitForOutputToMatch('ng', ['new'], warningTextRe);
 
     // Ensure `ng new --package-manager=npm` shows npm warning
-    const { message: stderrNewNpm } = await expectToFail(() => ng('new', '--package-manager=npm'));
-    if (!stderrNewNpm.includes(warningText)) {
-      throw new Error('ng new expected to show npm version warning.');
-    }
+    await execAndWaitForOutputToMatch('ng', ['new', '--package-manager=npm'], warningTextRe);
 
     // Ensure `ng new --skip-install` executes successfully
     const { stderr: stderrNewSkipInstall } = await ng('new', 'npm-seven-skip', '--skip-install');
-    if (stderrNewSkipInstall.includes(warningText)) {
+    if (stderrNewSkipInstall.match(warningTextRe)) {
       throw new Error('ng new --skip-install expected to not show npm version warning.');
     }
 
     // Ensure `ng new --package-manager=yarn` executes successfully
     // Need an additional npmrc file since yarn does not use the NPM registry environment variable
     const { stderr: stderrNewYarn } = await ng('new', 'npm-seven-yarn', '--package-manager=yarn');
-    if (stderrNewYarn.includes(warningText)) {
+    if (stderrNewYarn.match(warningTextRe)) {
       throw new Error('ng new --package-manager=yarn expected to not show npm version warning.');
     }
   } finally {
@@ -89,7 +91,7 @@ export default async function () {
     // Change directory back
     process.chdir(currentDirectory);
 
-    // Reset version back to 6.x
-    await npm('install', '--global', 'npm@6');
+    // Remove the locally installed npm
+    await npm('uninstall', 'npm');
   }
 }
diff --git a/tests/legacy-cli/e2e/tests/schematics_cli/basic.ts b/tests/legacy-cli/e2e/tests/schematics_cli/basic.ts
@@ -1,18 +1,8 @@
 import * as path from 'path';
-import { getGlobalVariable } from '../../utils/env';
-import { exec, execAndWaitForOutputToMatch, silentNpm } from '../../utils/process';
+import { exec, execAndWaitForOutputToMatch } from '../../utils/process';
 import { rimraf } from '../../utils/fs';
 
 export default async function () {
-  // setup
-  const argv = getGlobalVariable('argv');
-  if (argv.noglobal) {
-    return;
-  }
-
-  await silentNpm('install', '-g', '@angular-devkit/schematics-cli');
-  await exec(process.platform.startsWith('win') ? 'where' : 'which', 'schematics');
-
   const startCwd = process.cwd();
   const schematicPath = path.join(startCwd, 'test-schematic');
 
diff --git a/tests/legacy-cli/e2e/tests/schematics_cli/blank-test.ts b/tests/legacy-cli/e2e/tests/schematics_cli/blank-test.ts
@@ -1,19 +1,8 @@
-import * as fs from 'fs';
 import * as path from 'path';
-import { getGlobalVariable } from '../../utils/env';
 import { exec, silentNpm } from '../../utils/process';
 import { rimraf } from '../../utils/fs';
 
 export default async function () {
-  // setup
-  const argv = getGlobalVariable('argv');
-  if (argv.noglobal) {
-    return;
-  }
-
-  await silentNpm('install', '-g', '@angular-devkit/schematics-cli');
-  await exec(process.platform.startsWith('win') ? 'where' : 'which', 'schematics');
-
   const startCwd = process.cwd();
   const schematicPath = path.join(startCwd, 'test-schematic');
 
diff --git a/tests/legacy-cli/e2e/tests/schematics_cli/schematic-test.ts b/tests/legacy-cli/e2e/tests/schematics_cli/schematic-test.ts
@@ -1,19 +1,8 @@
-import * as fs from 'fs';
 import * as path from 'path';
-import { getGlobalVariable } from '../../utils/env';
 import { exec, silentNpm } from '../../utils/process';
 import { rimraf } from '../../utils/fs';
 
 export default async function () {
-  // setup
-  const argv = getGlobalVariable('argv');
-  if (argv.noglobal) {
-    return;
-  }
-
-  await silentNpm('install', '-g', '@angular-devkit/schematics-cli');
-  await exec(process.platform.startsWith('win') ? 'where' : 'which', 'schematics');
-
   const startCwd = process.cwd();
   const schematicPath = path.join(startCwd, 'test-schematic');
 
diff --git a/tests/legacy-cli/e2e/utils/process.ts b/tests/legacy-cli/e2e/utils/process.ts
@@ -5,8 +5,17 @@ import { concat, defer, EMPTY, from } from 'rxjs';
 import { repeat, takeLast } from 'rxjs/operators';
 import { getGlobalVariable } from './env';
 import { catchError } from 'rxjs/operators';
+import { join } from 'path';
 const treeKill = require('tree-kill');
 
+// The node_modules directory containing non-tested dependencies.
+const NODE_MODULES = join(process.cwd(), 'node_modules');
+
+// Do not depend on any global or test-local npm/yarn.
+// Always use the NPM + Yarn from the e2e node process node_modules.
+const NPM_CLI_JS = join(NODE_MODULES, 'npm/bin/npm-cli.js');
+const YARN_CLI_JS = join(NODE_MODULES, 'yarn/bin/yarn.js');
+
 interface ExecOptions {
   silent?: boolean;
   waitForMatch?: RegExp;
@@ -258,15 +267,15 @@ export function silentNg(...args: string[]) {
 }
 
 export function silentNpm(...args: string[]) {
-  return _exec({ silent: true }, 'npm', args);
+  return _exec({ silent: true }, 'node', [NPM_CLI_JS, ...args]);
 }
 
 export function silentYarn(...args: string[]) {
-  return _exec({ silent: true }, 'yarn', args);
+  return _exec({ silent: true }, 'node', [YARN_CLI_JS, ...args]);
 }
 
 export function npm(...args: string[]) {
-  return _exec({}, 'npm', args);
+  return _exec({}, 'node', [NPM_CLI_JS, ...args]);
 }
 
 export function node(...args: string[]) {
diff --git a/tests/legacy-cli/e2e/utils/utils.ts b/tests/legacy-cli/e2e/utils/utils.ts
@@ -1,4 +1,4 @@
-export function expectToFail(fn: () => Promise<any>, errorMessage?: string): Promise<any> {
+export function expectToFail(fn: () => Promise<any>, errorMessage?: string): Promise<Error> {
   return fn().then(
     () => {
       const functionSource = fn.name || (<any>fn).source || fn.toString();
diff --git a/tests/legacy-cli/e2e_runner.ts b/tests/legacy-cli/e2e_runner.ts
@@ -19,9 +19,7 @@ Error.stackTraceLimit = Infinity;
  * Here's a short description of those flags:
  *   --debug          If a test fails, block the thread so the temporary directory isn't deleted.
  *   --noproject      Skip creating a project or using one.
- *   --nobuild        Skip building the packages. Use with --noglobal and --reuse to quickly
- *                    rerun tests.
- *   --noglobal       Skip linking your local @angular/cli directory. Can save a few seconds.
+ *   --nobuild        Skip building the packages. Use with --reuse to quickly rerun tests.
  *   --nosilent       Never silence ng commands.
  *   --ng-tag=TAG     Use a specific tag for build snapshots. Similar to ng-snapshots but point to a
  *                    tag instead of using the latest `main`.
@@ -39,7 +37,7 @@ Error.stackTraceLimit = Infinity;
  * If unnamed flags are passed in, the list of tests will be filtered to include only those passed.
  */
 const argv = yargsParser(process.argv.slice(2), {
-  boolean: ['debug', 'esbuild', 'ng-snapshots', 'noglobal', 'nosilent', 'noproject', 'verbose'],
+  boolean: ['debug', 'esbuild', 'ng-snapshots', 'nosilent', 'noproject', 'verbose'],
   string: ['devkit', 'glob', 'ignore', 'reuse', 'ng-tag', 'tmpdir', 'ng-version'],
   configuration: {
     'dot-notation': false,
diff --git a/yarn.lock b/yarn.lock
