import { spawnSync } from "node:child_process"; import { chmod, mkdir, mkdtemp, readFile, realpath, rm, writeFile } from "node:fs/promises"; import { tmpdir } from "node:os"; import path from "node:path"; import { afterEach, describe, expect, it } from "vitest"; import { DEPENDENCY_CACHE } from "../../scripts/contracts/ci-gates.ts"; import { childProcessTimeout } from "../helpers/child-process-timeout.ts"; /** * scripts/ci/dependency-cache-root.sh picks the merge job's dependency cache * folder: the first candidate on the checkout's filesystem and outside it * (run 230: with the store in the job's /tmp, pnpm copied node_modules across * filesystems and a warm install was no faster than a cold one). A fake * `stat` stands in for the devices, so the cases do not depend on how this * host mounts its folders: a path under FAKE_SAME is device 11, any other 22. */ const roots: string[] = []; afterEach(async () => { await Promise.all(roots.splice(0).map((root) => rm(root, { recursive: true, force: true }))); }); async function layout() { const root = await realpath(await mkdtemp(path.join(tmpdir(), "dependency-cache-root-"))); roots.push(root); const bin = path.join(root, "bin"); await mkdir(bin); await writeFile( path.join(bin, "stat"), ['#!/usr/bin/env bash', 'target=${@: -1}', 'case "$target/" in "$FAKE_SAME"/*) echo 11 ;; *) echo 22 ;; esac', ""].join("\n"), ); await chmod(path.join(bin, "stat"), 0o755); const folders = { same: path.join(root, "same"), checkout: path.join(root, "same", "checkout"), insideCheckout: path.join(root, "same", "checkout", "tmp"), sameTemp: path.join(root, "same", "runner-temp"), other: path.join(root, "other"), otherTemp: path.join(root, "other", "runner-temp"), missing: path.join(root, "missing"), }; for (const folder of [folders.insideCheckout, folders.sameTemp, folders.otherTemp]) { await mkdir(folder, { recursive: true }); } const environmentFile = path.join(root, "github-env"); const outputFile = path.join(root, "github-output"); const run = (...candidates: string[]) => spawnSync("bash", [DEPENDENCY_CACHE.rootScript, ...candidates], { encoding: "utf8", env: { PATH: `${bin}:${process.env.PATH ?? ""}`, FAKE_SAME: folders.same, GITHUB_WORKSPACE: folders.checkout, GITHUB_ENV: environmentFile, GITHUB_OUTPUT: outputFile, }, }); const written = async () => ({ environment: (await readFile(environmentFile, "utf8")).trim().split("\n"), output: (await readFile(outputFile, "utf8")).trim(), }); return { folders, run, written }; } const variables = (root: string) => [ `COREPACK_HOME=${root}/corepack`, `PNPM_CONFIG_STORE_DIR=${root}/pnpm-store`, `PNPM_CONFIG_CACHE_DIR=${root}/pnpm-cache`, ]; describe("the merge job's dependency cache folder", { timeout: childProcessTimeout(47) }, () => { it("is the first candidate on the checkout's filesystem, never one inside the checkout", async () => { const { folders, run, written } = await layout(); const result = run(folders.otherTemp, folders.insideCheckout, folders.sameTemp); expect(result.status, result.stderr).toBe(0); const root = `${folders.sameTemp}/fe-dependency-cache`; expect(await written()).toEqual({ environment: variables(root), output: `root=${root}` }); expect(result.stdout).toMatch( new RegExp( String.raw`^dependency cache: ${root} \(on the checkout's filesystem: yes; devices: checkout=11 ${folders.otherTemp}=22 ${folders.sameTemp}=11; load average at job start: [0-9.]+ [0-9.]+ [0-9.]+\)\n$`, "u", ), ); expect(DEPENDENCY_CACHE.environmentNames).toEqual(variables(root).map((line) => line.split("=")[0])); }); it("falls back to the first usable candidate when none shares the checkout's filesystem", async () => { const { folders, run, written } = await layout(); const result = run(folders.missing, "", folders.otherTemp, folders.other); expect(result.status, result.stderr).toBe(0); const root = `${folders.otherTemp}/fe-dependency-cache`; expect(await written()).toEqual({ environment: variables(root), output: `root=${root}` }); expect(result.stdout).toContain(`dependency cache: ${root} (on the checkout's filesystem: no; devices: checkout=11 ${folders.otherTemp}=22 ${folders.other}=22;`); }); });