Refactor tests to use safeExecaEnv for environment management

Author: NullVoxPopuli

tests/helpers/utils.ts

@@ -48,6 +48,26 @@ export async function createTmp() {
   return tmpDirPath;
 }
 
+/**
+ * Returns a copy of the current process env with EMBER_, VITE_, and NODE_
+ * prefixed vars removed.
+ *
+ * Useful when spawning child processes with `extendEnv: false` so that
+ * vitest's NODE_ENV=test (and similar) doesn't leak into the child and
+ * interfere with the build-time / runtime macro mode detection.
+ */
+export function safeExecaEnv(): Record<string, string | undefined> {
+  let env = { ...process.env };
+
+  for (let key of Object.keys(env)) {
+    if (key.startsWith('EMBER_') || key.startsWith('VITE_') || key.startsWith('NODE_')) {
+      delete env[key];
+    }
+  }
+
+  return env;
+}
+
 /**
  * Abstraction for install, as the blueprint supports multiple package managers
  */

tests/smoke-tests/--typescript.test.ts

@@ -5,7 +5,7 @@ import fixturify from 'fixturify';
 import { execa } from 'execa';
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
-import { assertGeneratedCorrectly, filesMatching, SUPPORTED_PACKAGE_MANAGERS } from '../helpers.js';
+import { assertGeneratedCorrectly, filesMatching, SUPPORTED_PACKAGE_MANAGERS, safeExecaEnv } from '../helpers.js';
 const blueprintPath = path.join(__dirname, '../..');
 let localEmberCli = require.resolve('ember-cli/bin/ember');
 
@@ -20,6 +20,8 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
         cwd: addonDir,
         shell: true,
         preferLocal: true,
+        extendEnv: false,
+        env: safeExecaEnv(),
         // Allows us to not fail yet when the command fails
         // but we'd still fail appropriately with the exitCode check below.
         // When we fail, we want to check for git diffs for debugging purposes.
@@ -45,13 +47,14 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
       addonDir = join(tmpDir, addonName);
       await execa({
         cwd: tmpDir,
+        extendEnv: false,
       })`${localEmberCli} addon ${addonName} -b ${blueprintPath} --skip-npm --prefer-local true --${packageManager} --typescript`;
       // Have to use --force because NPM is *stricter* when you use tags in package.json
       // than pnpm (in that tags don't match any specified stable version)
       if (packageManager === 'npm') {
-        await execa({ cwd: addonDir })`npm install --force`;
+        await execa({ cwd: addonDir, extendEnv: false })`npm install --force`;
       } else if (packageManager === 'pnpm') {
-        await execa({ cwd: addonDir })`pnpm install`;
+        await execa({ cwd: addonDir, extendEnv: false })`pnpm install`;
       }
     });
 

tests/smoke-tests/defaults.test.ts

@@ -14,6 +14,7 @@ import {
   dirContents,
   matchesFixture,
   packageJsonAt,
+  safeExecaEnv,
   SUPPORTED_PACKAGE_MANAGERS,
 } from '../helpers.js';
 import { existsSync } from 'node:fs';
@@ -161,20 +162,13 @@ for (let packageManager of SUPPORTED_PACKAGE_MANAGERS) {
         // It's important that we ensure that dist directory is empty for this test, because
         await fs.rm(join(addonDir, 'dist'), { recursive: true, force: true });
 
-        let safeEnv = { ...process.env };
-        for (let key of Object.keys(safeEnv)) {
-          if (key.startsWith('EMBER_') || key.startsWith('VITE_') || key.startsWith('NODE_')) {
-            delete safeEnv[key];
-          }
-        }
-
         let testResult = await execa({
           cwd: addonDir,
           extendEnv: false,
           // a modified env required with extendEnv, else we still inherit/merge the env of vitest
           // which overrides our NODE_ENV from our .env.development file (read by vite)
           // (because in-shell ENV vars override .env files)
-          env: safeEnv,
+          env: safeExecaEnv(),
         })`${packageManager} run test`;
 
         expect(testResult.exitCode).toEqual(0);