test: use NPM_CONFIG_legacy_peer_deps when testing prerelease versions of Angular material.

`@angular/material` pre-release may not support the current version of `@angular/core` pre-release. In this case peer dependency ranges may not resolve causing npm 7+ to fail during tests.

Author: alan-agius4

tests/legacy-cli/e2e/tests/build/material.ts

@@ -7,36 +7,51 @@ import { isPrereleaseCli, updateJsonFile } from '../../utils/project';
 const snapshots = require('../../ng-snapshot/package.json');
 
 export default async function () {
-  let tag = (await isPrereleaseCli()) ? '@next' : '';
-  await ng('add', `@angular/material${tag}`, '--skip-confirmation');
+  // `@angular/material` pre-release may not support the current version of `@angular/core` pre-release.
+  // due to the order of releases FW -> CLI -> Material
+  // In this case peer dependency ranges may not resolve causing npm 7+ to fail during tests.
+  const original_NPM_CONFIG_legacy_peer_deps = process.env['NPM_CONFIG_legacy_peer_deps'];
+  const isPrerelease = await isPrereleaseCli();
 
-  const isSnapshotBuild = getGlobalVariable('argv')['ng-snapshots'];
-  if (isSnapshotBuild) {
-    await updateJsonFile('package.json', (packageJson) => {
-      const dependencies = packageJson['dependencies'];
-      // Angular material adds dependencies on other Angular packages
-      // Iterate over all of the packages to update them to the snapshot version.
-      for (const [name, version] of Object.entries(snapshots.dependencies)) {
-        if (name in dependencies) {
-          dependencies[name] = version;
+  let tag = isPrerelease ? '@next' : '';
+
+  try {
+    process.env['NPM_CONFIG_legacy_peer_deps'] = isPrerelease
+      ? 'true'
+      : original_NPM_CONFIG_legacy_peer_deps;
+
+    await ng('add', `@angular/material${tag}`, '--skip-confirmation');
+
+    const isSnapshotBuild = getGlobalVariable('argv')['ng-snapshots'];
+    if (isSnapshotBuild) {
+      await updateJsonFile('package.json', (packageJson) => {
+        const dependencies = packageJson['dependencies'];
+        // Angular material adds dependencies on other Angular packages
+        // Iterate over all of the packages to update them to the snapshot version.
+        for (const [name, version] of Object.entries(snapshots.dependencies)) {
+          if (name in dependencies) {
+            dependencies[name] = version;
+          }
         }
-      }
 
-      dependencies['@angular/material-moment-adapter'] =
-        snapshots.dependencies['@angular/material-moment-adapter'];
-    });
-    await installWorkspacePackages();
-  } else {
-    if (!tag) {
-      const installedMaterialVersion = JSON.parse(await readFile('package.json'))['dependencies'][
-        '@angular/material'
-      ];
-      tag = `@${installedMaterialVersion}`;
+        dependencies['@angular/material-moment-adapter'] =
+          snapshots.dependencies['@angular/material-moment-adapter'];
+      });
+      await installWorkspacePackages();
+    } else {
+      if (!tag) {
+        const installedMaterialVersion = JSON.parse(await readFile('package.json'))['dependencies'][
+          '@angular/material'
+        ];
+        tag = `@${installedMaterialVersion}`;
+      }
+      await installPackage(`@angular/material-moment-adapter${tag}`);
     }
-    await installPackage(`@angular/material-moment-adapter${tag}`);
-  }
 
-  await installPackage('moment');
+    await installPackage('moment');
+  } finally {
+    process.env['NPM_CONFIG_legacy_peer_deps'] = original_NPM_CONFIG_legacy_peer_deps;
+  }
 
   await ng('build');
 

tests/legacy-cli/e2e/tests/commands/add/add-material.ts

@@ -1,32 +1,44 @@
 import { assertIsError } from '../../../utils/utils';
 import { expectFileToMatch, rimraf } from '../../../utils/fs';
 import { uninstallPackage } from '../../../utils/packages';
-import { ng } from '../../../utils/process';
+import { execWithEnv } from '../../../utils/process';
 import { isPrereleaseCli } from '../../../utils/project';
 
 export default async function () {
   // forcibly remove in case another test doesn't clean itself up
   await rimraf('node_modules/@angular/material');
 
-  const tag = (await isPrereleaseCli()) ? '@next' : '';
+  const isPrerelease = await isPrereleaseCli();
+  const tag = isPrerelease ? '@next' : '';
+  const processEnv = {
+    ...process.env,
+    // `@angular/material` pre-release may not support the current version of `@angular/core` pre-release.
+    // due to the order of releases FW -> CLI -> Material
+    // In this case peer dependency ranges may not resolve causing npm 7+ to fail during tests.
+    'NPM_CONFIG_legacy_peer_deps': isPrerelease
+      ? 'true'
+      : process.env['NPM_CONFIG_legacy_peer_deps'],
+  };
 
   try {
-    await ng('add', `@angular/material${tag}`, '--unknown', '--skip-confirmation');
+    await execWithEnv(
+      'ng',
+      ['add', `@angular/material${tag}`, '--skip-confirmation', '--unknown'],
+      processEnv,
+    );
   } catch (error) {
     assertIsError(error);
     if (!(error as Error).message.includes(`Unknown option: '--unknown'`)) {
       throw error;
     }
   }
 
-  await ng(
-    'add',
-    `@angular/material${tag}`,
-    '--theme',
-    'custom',
-    '--verbose',
-    '--skip-confirmation',
+  await execWithEnv(
+    'ng',
+    ['add', `@angular/material${tag}`, '--theme', 'custom', '--verbose', '--skip-confirmation'],
+    processEnv,
   );
+
   await expectFileToMatch('package.json', /@angular\/material/);
 
   // Clean up existing cdk package

tests/legacy-cli/e2e/tests/misc/invalid-schematic-dependencies.ts

@@ -1,5 +1,5 @@
 import { expectFileToMatch } from '../../utils/fs';
-import { execWithEnv, extractNpmEnv, ng, silentNpm } from '../../utils/process';
+import { execWithEnv, extractNpmEnv, silentNpm } from '../../utils/process';
 import { installPackage, uninstallPackage } from '../../utils/packages';
 import { isPrereleaseCli } from '../../utils/project';
 
@@ -13,8 +13,23 @@ export default async function () {
   // Install outdated and incompatible version
   await installPackage('@schematics/angular@7');
 
-  const tag = (await isPrereleaseCli()) ? '@next' : '';
-  await ng('add', `@angular/material${tag}`, '--skip-confirmation');
+  const isPrerelease = await isPrereleaseCli();
+  const tag = isPrerelease ? '@next' : '';
+
+  await execWithEnv(
+    'ng',
+    ['add', `@angular/material${tag}`, '--skip-confirmation'],
+    // `@angular/material` pre-release may not support the current version of `@angular/core` pre-release.
+    // due to the order of releases FW -> CLI -> Material
+    // In this case peer dependency ranges may not resolve causing npm 7+ to fail during tests.
+    {
+      ...process.env,
+      'NPM_CONFIG_legacy_peer_deps': isPrerelease
+        ? 'true'
+        : process.env['NPM_CONFIG_legacy_peer_deps'],
+    },
+  );
+
   await expectFileToMatch('package.json', /@angular\/material/);
 
   // Clean up existing cdk package