test: fix global snap test checkout resolution

Author: Han5991

packages/cli/snap-tests-global/create-framework-shim-astro/snap.txt

@@ -3,6 +3,6 @@
 /// <reference types="astro/client" />
 
 > cd my-astro-app && vp install -- --no-frozen-lockfile # install dependencies
-> cd my-astro-app && sed -i.bak -e '/jsPlugins/d' -e '/rules:/d' -e '/options:/d' vite.config.ts && vp check --fix # fix generated formatting and ensure no errors
+> cd my-astro-app && vp check --fix # fix generated formatting and ensure no errors
 pass: Formatting completed for checked files (<variable>ms)
-pass: Found no warnings or lint errors in 6 files (<variable>ms, <variable> threads)
+pass: Found no warnings, lint errors, or type errors in 6 files (<variable>ms, <variable> threads)

packages/cli/snap-tests-global/create-framework-shim-astro/steps.json

@@ -1,5 +1,6 @@
 {
   "ignoredPlatforms": ["win32"],
+  "linkCheckoutPackages": true,
   "commands": [
     {
       "command": "vp create astro --no-interactive -- my-astro-app --yes --skip-houston --template basics # create Astro app",
@@ -10,8 +11,6 @@
       "command": "cd my-astro-app && vp install -- --no-frozen-lockfile # install dependencies",
       "ignoreOutput": true
     },
-    {
-      "command": "cd my-astro-app && sed -i.bak -e '/jsPlugins/d' -e '/rules:/d' -e '/options:/d' vite.config.ts && vp check --fix # fix generated formatting and ensure no errors"
-    }
+    "cd my-astro-app && vp check --fix # fix generated formatting and ensure no errors"
   ]
 }

packages/cli/snap-tests-global/create-framework-shim-vue/snap.txt

@@ -7,6 +7,6 @@ declare module '*.vue' {
 }
 
 > cd vite-plus-application && vp install # install dependencies
-> cd vite-plus-application && sed -i.bak -e '/jsPlugins/d' -e '/rules:/d' -e '/options:/d' vite.config.ts && vp check --fix # fix generated formatting and ensure no errors
+> cd vite-plus-application && vp check --fix # fix generated formatting and ensure no errors
 pass: Formatting completed for checked files (<variable>ms)
-pass: Found no warnings or lint errors in 5 files (<variable>ms, <variable> threads)
+pass: Found no warnings, lint errors, or type errors in 5 files (<variable>ms, <variable> threads)

packages/cli/snap-tests-global/create-framework-shim-vue/steps.json

@@ -1,5 +1,6 @@
 {
   "ignoredPlatforms": ["win32"],
+  "linkCheckoutPackages": true,
   "commands": [
     {
       "command": "vp create vite:application --no-interactive -- --template vue-ts # create Vue+TS app",
@@ -10,8 +11,6 @@
       "command": "cd vite-plus-application && vp install # install dependencies",
       "ignoreOutput": true
     },
-    {
-      "command": "cd vite-plus-application && sed -i.bak -e '/jsPlugins/d' -e '/rules:/d' -e '/options:/d' vite.config.ts && vp check --fix # fix generated formatting and ensure no errors"
-    }
+    "cd vite-plus-application && vp check --fix # fix generated formatting and ensure no errors"
   ]
 }

packages/tools/src/snap-test.ts

@@ -1,7 +1,6 @@
 import { randomUUID } from 'node:crypto';
-import fs, { readFileSync } from 'node:fs';
+import fs from 'node:fs';
 import fsPromises from 'node:fs/promises';
-import { open } from 'node:fs/promises';
 import { cpus, homedir, tmpdir } from 'node:os';
 import path from 'node:path';
 import { setTimeout } from 'node:timers/promises';
@@ -92,6 +91,167 @@ function selectShard<T>(items: T[], index: number, total: number): T[] {
 
 const NPM_GLOBAL_PREFIX_DIR = 'npm-global-lib-for-snap-tests';
 
+function resolveGlobalCliScriptsDir(casesDir: string): string {
+  const candidates = [
+    // `packages/cli/snap-tests-global` -> `packages/cli/dist`
+    path.join(path.dirname(casesDir), 'dist'),
+    // Fallback for the common `pnpm -F vite-plus snap-test-global` cwd.
+    path.resolve('dist'),
+  ];
+
+  const scriptsDir = candidates.find((dir) => fs.existsSync(path.join(dir, 'bin.js')));
+  if (!scriptsDir) {
+    throw new Error(
+      `Unable to find built Vite+ CLI scripts for global snap tests. Tried:\n${candidates
+        .map((dir) => `- ${dir}`)
+        .join('\n')}`,
+    );
+  }
+
+  return scriptsDir;
+}
+
+function resolveRepoRoot(casesDir: string): string {
+  return path.resolve(path.dirname(casesDir), '..', '..');
+}
+
+function resolveGlobalCliBinary(binDir: string): string {
+  const binaryName = process.platform === 'win32' ? 'vp.exe' : 'vp';
+  const binaryPath = path.join(path.resolve(expandHome(binDir)), binaryName);
+  if (!fs.existsSync(binaryPath)) {
+    throw new Error(`Unable to find global snap test vp binary at ${binaryPath}`);
+  }
+
+  return fs.realpathSync(binaryPath);
+}
+
+function resolveBuiltGlobalCliBinary(casesDir: string): string {
+  const binaryName = process.platform === 'win32' ? 'vp.exe' : 'vp';
+  const repoRoot = resolveRepoRoot(casesDir);
+  const targetDirs = [
+    ...(process.env.CARGO_TARGET_DIR ? [process.env.CARGO_TARGET_DIR] : []),
+    path.join(repoRoot, 'target'),
+  ];
+  const candidates = targetDirs.flatMap((targetDir) => {
+    const directCandidates = [
+      path.join(targetDir, 'release', binaryName),
+      path.join(targetDir, 'debug', binaryName),
+    ];
+    if (!fs.existsSync(targetDir)) {
+      return directCandidates;
+    }
+
+    return [
+      ...directCandidates,
+      ...fs
+        .readdirSync(targetDir, { withFileTypes: true })
+        .filter((entry) => entry.isDirectory())
+        .flatMap((entry) => [
+          path.join(targetDir, entry.name, 'release', binaryName),
+          path.join(targetDir, entry.name, 'debug', binaryName),
+        ]),
+    ];
+  });
+  const binaryPath = candidates.find((candidate) => fs.existsSync(candidate));
+  if (!binaryPath) {
+    throw new Error(
+      `Unable to find built Vite+ global CLI binary for global snap tests. Tried:\n${candidates
+        .map((candidate) => `- ${candidate}`)
+        .join('\n')}\nRun \`cargo build -p vite_global_cli --release\` before snap-test-global.`,
+    );
+  }
+
+  return fs.realpathSync(binaryPath);
+}
+
+function newestMtimeMs(filePath: string): number {
+  const stats = fs.statSync(filePath);
+  if (!stats.isDirectory()) {
+    return stats.mtimeMs;
+  }
+
+  return fs
+    .readdirSync(filePath)
+    .reduce(
+      (newest, entry) => Math.max(newest, newestMtimeMs(path.join(filePath, entry))),
+      stats.mtimeMs,
+    );
+}
+
+function fileContentsEqual(a: string, b: string): boolean {
+  return fs.readFileSync(a).equals(fs.readFileSync(b));
+}
+
+function assertGlobalCliBinaryMatchesCheckout(binDir: string, casesDir: string): void {
+  const repoRoot = resolveRepoRoot(casesDir);
+  const builtBinary = resolveBuiltGlobalCliBinary(casesDir);
+  const sourcePaths = [
+    path.join(repoRoot, 'Cargo.toml'),
+    path.join(repoRoot, 'Cargo.lock'),
+    path.join(repoRoot, 'crates', 'vite_global_cli', 'src'),
+    path.join(repoRoot, 'crates', 'vite_shared', 'src'),
+  ];
+  const shouldCheckMtime = process.env.GITHUB_ACTIONS !== 'true';
+  const newestSourceMtime = shouldCheckMtime ? Math.max(...sourcePaths.map(newestMtimeMs)) : 0;
+  if (shouldCheckMtime && fs.statSync(builtBinary).mtimeMs + 1000 < newestSourceMtime) {
+    throw new Error(
+      `Built Vite+ global CLI binary is older than the current checkout: ${builtBinary}\n` +
+      'Run `cargo build -p vite_global_cli --release` before snap-test-global.',
+    );
+  }
+
+  const globalBinary = resolveGlobalCliBinary(binDir);
+  if (fileContentsEqual(globalBinary, builtBinary)) {
+    return;
+  }
+
+  throw new Error(
+    `Global snap tests would use a stale vp binary from ${globalBinary}.\n` +
+      `Expected it to match the current checkout build at ${builtBinary}.\n` +
+      'Run `pnpm bootstrap-cli` or `pnpm bootstrap-cli:ci` before snap-test-global.',
+  );
+}
+
+function replaceInstalledCheckoutPackages(rootDir: string, repoRoot: string): void {
+  const stack = [rootDir];
+  const symlinkType = process.platform === 'win32' ? 'junction' : 'dir';
+  const replacements = new Map([
+    ['node_modules/vite-plus', path.join(repoRoot, 'packages', 'cli')],
+    ['node_modules/vite', path.join(repoRoot, 'packages', 'core')],
+    ['node_modules/vitest', path.join(repoRoot, 'packages', 'test')],
+    ['node_modules/@voidzero-dev/vite-plus-core', path.join(repoRoot, 'packages', 'core')],
+    ['node_modules/@voidzero-dev/vite-plus-test', path.join(repoRoot, 'packages', 'test')],
+  ]);
+
+  while (stack.length > 0) {
+    const dir = stack.pop()!;
+    for (const [relativePackagePath, checkoutPackageDir] of replacements) {
+      const candidate = path.join(dir, relativePackagePath);
+      if (fs.existsSync(candidate) && fs.realpathSync(candidate) !== checkoutPackageDir) {
+        fs.rmSync(candidate, { recursive: true, force: true });
+        fs.symlinkSync(checkoutPackageDir, candidate, symlinkType);
+      }
+    }
+
+    const isNodeModulesPath = dir.split(path.sep).includes('node_modules');
+    const isPnpmStorePath = dir.split(path.sep).includes('.pnpm');
+    for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+      if (!entry.isDirectory() || entry.name === '.git' || entry.name === '.bin') {
+        continue;
+      }
+      if (
+        isNodeModulesPath &&
+        !isPnpmStorePath &&
+        entry.name !== '.pnpm' &&
+        entry.name !== '@voidzero-dev'
+      ) {
+        continue;
+      }
+      stack.push(path.join(dir, entry.name));
+    }
+  }
+}
+
 export async function snapTest() {
   const { positionals, values } = parseArgs({
     allowPositionals: true,
@@ -203,13 +363,18 @@ export async function snapTest() {
   const selectedCases = shard
     ? selectShard(validCaseNames, shard.index, shard.total)
     : validCaseNames;
+  const globalCliScriptsDir = values['bin-dir'] ? resolveGlobalCliScriptsDir(casesDir) : undefined;
+  if (values['bin-dir']) {
+    assertGlobalCliBinaryMatchesCheckout(values['bin-dir'], casesDir);
+  }
 
   const serialTasks: (() => Promise<void>)[] = [];
   const parallelTasks: (() => Promise<void>)[] = [];
   for (const caseName of selectedCases) {
     const stepsPath = path.join(casesDir, caseName, 'steps.json');
-    const steps: Steps = JSON.parse(readFileSync(stepsPath, 'utf-8'));
-    const task = () => runTestCase(caseName, tempTmpDir, casesDir, values['bin-dir']);
+    const steps: Steps = JSON.parse(fs.readFileSync(stepsPath, 'utf-8'));
+    const task = () =>
+      runTestCase(caseName, tempTmpDir, casesDir, values['bin-dir'], globalCliScriptsDir);
     if (steps.serial) {
       serialTasks.push(task);
     } else {
@@ -258,6 +423,11 @@ interface Steps {
   ignoredPlatforms?: (string | PlatformFilter)[];
   env: Record<string, string>;
   commands: (string | Command)[];
+  /**
+   * If true, installed Vite+ packages in the test project are relinked to the
+   * current checkout after each successful command.
+   */
+  linkCheckoutPackages?: boolean;
   /**
    * Commands to run after the test completes, regardless of success or failure.
    * Useful for cleanup tasks like killing background processes.
@@ -322,7 +492,13 @@ function shouldSkipPlatform(ignoredPlatforms: (string | PlatformFilter)[]): bool
   return false;
 }
 
-async function runTestCase(name: string, tempTmpDir: string, casesDir: string, binDir?: string) {
+async function runTestCase(
+  name: string,
+  tempTmpDir: string,
+  casesDir: string,
+  binDir?: string,
+  globalCliScriptsDir?: string,
+) {
   const steps: Steps = JSON.parse(
     await fsPromises.readFile(`${casesDir}/${name}/steps.json`, 'utf-8'),
   );
@@ -362,6 +538,9 @@ async function runTestCase(name: string, tempTmpDir: string, casesDir: string, b
     VP_SKIP_INSTALL: '1',
     // make sure npm install global packages to the temporary directory
     NPM_CONFIG_PREFIX: path.join(tempTmpDir, NPM_GLOBAL_PREFIX_DIR),
+    // Global CLI snap tests execute the Rust binary from --bin-dir, but the JS
+    // entry should come from this checkout instead of a stale ~/.vite-plus install.
+    ...(globalCliScriptsDir ? { VITE_GLOBAL_CLI_JS_SCRIPTS_DIR: globalCliScriptsDir } : {}),
 
     // A test case can override/unset environment variables above.
     // For example, VP_CLI_TEST/CI can be unset to test the real-world outputs.
@@ -409,7 +588,7 @@ async function runTestCase(name: string, tempTmpDir: string, casesDir: string, b
       // it seems not to have stable ordering of stdout/stderr chunks.
       // To ensure stable ordering, we redirect outputs to a file instead.
       const outputStreamPath = path.join(caseTmpDir, 'output.log');
-      const outputStream = await open(outputStreamPath, 'w');
+      const outputStream = await fsPromises.open(outputStreamPath, 'w');
 
       const exitCode = await Promise.race([
         execute(stripComments(cmd.command), [], {
@@ -431,8 +610,11 @@ async function runTestCase(name: string, tempTmpDir: string, casesDir: string, b
       ]);
 
       await outputStream.close();
+      if (exitCode === 0 && globalCliScriptsDir && steps.linkCheckoutPackages) {
+        replaceInstalledCheckoutPackages(caseTmpDir, resolveRepoRoot(casesDir));
+      }
 
-      let output = readFileSync(outputStreamPath, 'utf-8');
+      let output = fs.readFileSync(outputStreamPath, 'utf-8');
 
       let commandLine = `> ${cmd.command}`;
       if (exitCode !== 0) {