@vibe-agent-toolkit/utils 0.2.0-rc.1 → 0.2.0-rc.10

package/dist/test-helpers.d.ts

@@ -1,118 +1,153 @@
+declare const symlinkCapabilityBrand: unique symbol;
 /**
- * Get isolated test output directory for current test run
- *
- * Creates a unique directory under `packages/{packageName}/.test-output/{testType}/{runId}`
- * where runId is `{timestamp}-{randomId}` to ensure isolation across parallel test runs.
- *
- * @param packageName - Name of package (e.g., 'rag-lancedb')
- * @param testType - Type of test ('unit', 'integration', 'system')
- * @param subdirs - Optional subdirectories to create within the test output directory
- * @returns Absolute path to the created directory
- *
- * @example
- * ```typescript
- * // Create isolated database directory for system tests
- * const dbPath = getTestOutputDir('rag-lancedb', 'system', 'databases', 'test-db');
- * // Result: packages/rag-lancedb/.test-output/system/20260105-143022-abc123/databases/test-db
- *
- * // Create temporary file directory for integration tests
- * const tempDir = getTestOutputDir('agent-skills', 'integration', 'temp-files');
- * // Result: packages/agent-skills/.test-output/integration/20260105-143022-def456/temp-files
- * ```
+ * Proof that this process can create filesystem symlinks.
+ *
+ * The only way to obtain one is {@link symlinkCapability}, and it exists at
+ * all only when a real probe already succeeded — so a function that requires
+ * this as a parameter cannot be reached by code that skipped the check. That
+ * is the point of branding it rather than passing a `boolean`: forgetting the
+ * check becomes a type error instead of a runtime `EPERM` on a machine you
+ * don't control.
  */
-export declare function getTestOutputDir(packageName: string, testType: 'unit' | 'integration' | 'system', ...subdirs: string[]): string;
+export type SymlinkCapability = {
+    readonly [symlinkCapabilityBrand]: true;
+};
 /**
- * Get the base test output directory for a package
- * Useful for cleanup operations that need to remove all test output
+ * Whether this PROCESS can create symlinks — probed once and memoized.
  *
- * @param packageName - Name of package (e.g., 'rag-lancedb')
- * @returns Absolute path to packages/{packageName}/.test-output
- *
- * @example
- * ```typescript
- * const baseDir = getTestOutputBase('rag-lancedb');
- * // Result: packages/rag-lancedb/.test-output
- * ```
+ * On Windows, `symlink()` needs either Developer Mode or
+ * `SeCreateSymbolicLinkPrivilege`. That privilege lives on the process's
+ * security token, not on any one directory: it cannot change between calls
+ * within a single run, so probing it once and reusing the result is a
+ * memoization, not a shortcut that risks a stale answer. (A filesystem that
+ * itself has no symlinks — some network shares, some FAT variants — answers
+ * `ENOTSUP` and is read as the same "no"; every fixture in this repo creates
+ * its roots under {@link normalizedTmpdir}, so it never arises here.)
+ *
+ * Because the answer is memoized for the whole process, what reads as "no"
+ * matters more than usual: a `null` here silently `skip()`s every symlink test
+ * for the rest of the run. So ONLY {@link SYMLINK_UNSUPPORTED_ERRNOS} is a
+ * no. A tmpdir that is unwritable or missing, or a bug, is not an answer about
+ * symlinks at all and stays loud rather than becoming a process-wide skip for
+ * a reason nothing reported.
+ *
+ * Fixtures that depend on symlinks must ask rather than assume — and, having
+ * asked, must SAY they skipped. A symlink case that silently no-ops reads as
+ * a passing test for a property nobody exercised.
+ *
+ * @returns A {@link SymlinkCapability} token when this process can create
+ *   symlinks, else `null`. Route the `null` case through vitest's `skip()`
+ *   rather than a plain `return`, so the skip is visible in the report.
  */
-export declare function getTestOutputBase(packageName: string): string;
+export declare function symlinkCapability(): SymlinkCapability | null;
 /**
- * Per-suite temp directory pattern (async version)
- * Creates a single temp directory for the entire test suite,
- * with subdirectories for each test. This is 3-5x faster on Windows
- * than creating a new mkdtemp for each test.
- *
- * @param prefix - Prefix for the suite temp directory name
- * @returns Suite helper with beforeAll, afterAll, beforeEach, afterEach, and getTempDir
- *
- * @example
- * ```typescript
- * const suite = setupAsyncTempDirSuite('my-test');
- *
- * describe('my tests', () => {
- *   beforeAll(suite.beforeAll);
- *   afterAll(suite.afterAll);
- *   beforeEach(suite.beforeEach);
+ * Create a symlink — the one sanctioned call site for `fs.symlinkSync` in
+ * test code. Requires a {@link SymlinkCapability}, which only
+ * {@link symlinkCapability} can mint, so a test cannot reach the real
+ * syscall without first proving (or explicitly bypassing via `skip()`) that
+ * this host supports it.
+ *
+ * @param _cap - Proof from {@link symlinkCapability} that this host can create symlinks
+ * @param target - The existing path the new link should point at
+ * @param path - Where to create the link
+ * @param type - Windows-only link-type hint (`'file'` \| `'dir'` \| `'junction'`); ignored on POSIX
+ */
+export declare function createSymlink(_cap: SymlinkCapability, target: string, path: string, type?: 'dir' | 'file' | 'junction'): void;
+/**
+ * The async counterpart of {@link createSymlink}, for fixtures already using
+ * `node:fs/promises`. Same capability requirement, same reasoning.
  *
- *   it('test 1', async () => {
- *     const tempDir = suite.getTempDir();
- *     // Use tempDir...
- *   });
- * });
- * ```
+ * @param _cap - Proof from {@link symlinkCapability} that this host can create symlinks
+ * @param target - The existing path the new link should point at
+ * @param path - Where to create the link
+ * @param type - Windows-only link-type hint (`'file'` \| `'dir'` \| `'junction'`); ignored on POSIX
  */
-export declare function setupAsyncTempDirSuite(prefix: string): {
-    beforeAll: () => Promise<void>;
-    afterAll: () => Promise<void>;
-    beforeEach: () => Promise<void>;
-    afterEach: () => Promise<void>;
-    getTempDir: () => string;
-};
+export declare function createSymlinkAsync(_cap: SymlinkCapability, target: string, path: string, type?: 'dir' | 'file' | 'junction'): Promise<void>;
 /**
- * Per-suite temp directory pattern (sync version)
- * Creates a single temp directory for the entire test suite,
- * with subdirectories for each test. This is 3-5x faster on Windows
- * than creating a new mkdtemp for each test.
+ * The variables git exports into a hook, which a fixture must clear before it
+ * can fabricate its own.
  *
- * @param prefix - Prefix for the suite temp directory name
- * @returns Suite helper with beforeAll, afterAll, beforeEach, afterEach, and getTempDir
+ * These are the ones git sets *for* you. Deliberately **not** the operator's own
+ * `GIT_CONFIG_COUNT`/`KEY_n`/`VALUE_n`/`GLOBAL`/`SYSTEM` channel — a test may be
+ * using that on purpose to point a clone at a local path, and clearing it sends
+ * the clone to the network instead.
+ */
+export declare const INHERITED_GIT_ENV: readonly ["GIT_ALTERNATE_OBJECT_DIRECTORIES", "GIT_CEILING_DIRECTORIES", "GIT_COMMON_DIR", "GIT_CONFIG_PARAMETERS", "GIT_DIR", "GIT_DISCOVERY_ACROSS_FILESYSTEM", "GIT_GRAFT_FILE", "GIT_INDEX_FILE", "GIT_INDEX_VERSION", "GIT_NAMESPACE", "GIT_NOTES_REF", "GIT_OBJECT_DIRECTORY", "GIT_PREFIX", "GIT_SHALLOW_FILE", "GIT_WORK_TREE"];
+/**
+ * Remove every inherited git redirection from `process.env`, and hand back the
+ * undo.
+ *
+ * A test that fabricates a hook environment has to start from a known-clean one,
+ * or it inherits whatever the *outer* runner exported and can no longer tell its
+ * own fixture apart from the ambient state — it then passes or fails for reasons
+ * it never set up. Restoring afterwards matters just as much: these are
+ * process-global, so a test that leaks `GIT_DIR` silently redirects every later
+ * test sharing the worker.
+ *
+ * ⚠️ **The key list is restated here on purpose, not by oversight.** Deriving it
+ * from `@vibe-validate/git`'s `stripGitEnv()` would be tidier, and it is exactly
+ * what this function did for one revision — but this module is the `./testing`
+ * subpath, which `subpath-purity.test.ts` pins as reaching **no third-party
+ * package at all** so it stays importable with zero dependencies installed. One
+ * import cost that property. The drift risk the derivation was avoiding is
+ * handled instead by {@link "../test/test-helpers-git-env.test".default}, which
+ * asserts this list equals what the shipped scrub removes.
+ *
+ * @returns A function restoring every variable to its prior value, putting back
+ *   "was not set" as unset rather than as an empty string
  *
  * @example
  * ```typescript
- * const suite = setupSyncTempDirSuite('my-test');
- *
- * describe('my tests', () => {
- *   beforeAll(suite.beforeAll);
- *   afterAll(suite.afterAll);
- *   beforeEach(suite.beforeEach);
- *
- *   it('test 1', () => {
- *     const tempDir = suite.getTempDir();
- *     // Use tempDir...
- *   });
- * });
+ * let restoreGitEnv: () => void;
+ * beforeEach(() => { restoreGitEnv = detachGitEnv(); });
+ * afterEach(() => { restoreGitEnv(); });
  * ```
  */
-export declare function setupSyncTempDirSuite(prefix: string): {
-    beforeAll: () => void;
-    afterAll: () => void;
-    beforeEach: () => void;
-    afterEach: () => void;
-    getTempDir: () => string;
-};
+export declare function detachGitEnv(): () => void;
 /**
- * Probe whether this host can create symbolic links inside `dir`.
- *
- * On Windows, `symlink()` needs either Developer Mode or
- * `SeCreateSymbolicLinkPrivilege`; CI agents frequently have neither. Fixtures
- * that depend on symlinks must therefore ask rather than assume — and, having
- * asked, must SAY they skipped. A symlink case that silently no-ops reads as a
- * passing test for a property nobody exercised.
- *
- * The probe creates and removes one link, because the privilege cannot be
- * inferred from `process.platform` alone.
- *
- * @param dir - An existing directory to probe in (the probe cleans up after itself)
- * @returns True when a symlink was created successfully
+ * The errno-shaped error a refused `fs` call throws: a message, the `code`,
+ * and the `syscall`, exactly as Node shapes one.
+ */
+export declare function errnoError(code: string, syscall: string, target: string): NodeJS.ErrnoException;
+/** The sync `node:fs` calls a refusal can be injected into. */
+export type RefusableSyncFsMethod = 'readdirSync' | 'readFileSync' | 'statSync' | 'lstatSync' | 'realpathSync' | 'renameSync' | 'rmSync' | 'unlinkSync';
+/** The `node:fs/promises` calls a refusal can be injected into. */
+export type RefusableAsyncFsMethod = 'readdir' | 'readFile' | 'stat' | 'lstat' | 'access';
+/**
+ * Make `fs[method]` throw `code` for exactly `targetPath` until the returned
+ * restore is called; every other path, and every other method, stays real.
+ *
+ * A patch rather than a `chmod`: `chmod` reaches one errno (`EACCES`), only
+ * where POSIX modes bind, and not as root — and the property under test is
+ * "any refusal that is not an absence", so `EACCES`, `ELOOP`, `EMFILE` must all
+ * be reachable. What a walk under test meets is ONE refused call inside an
+ * otherwise ordinary tree; a walk that gave up entirely would pass a test where
+ * everything was refused.
+ *
+ * Lives in the shipped helpers because consumers in five packages each need to
+ * refuse a call, and the duplication gate refuses five copies.
+ */
+export declare function refuseSyncFs(method: RefusableSyncFsMethod, targetPath: string, code: string): () => void;
+/**
+ * `fs/promises[method]` rejects with `code` for exactly `targetPath` until the
+ * returned restore is called; every other path, and every other method, is real.
+ */
+export declare function refuseAsyncFs(method: RefusableAsyncFsMethod, targetPath: string, code: string): () => void;
+/**
+ * Run `body` while `fs[method]` throws `code` for exactly `targetPath`; the
+ * patch is lifted however `body` exits. See {@link refuseSyncFs}.
+ */
+export declare function withSyncFsRefused<T>(method: RefusableSyncFsMethod, targetPath: string, code: string, body: () => T | Promise<T>): Promise<T>;
+/**
+ * Run `body` with `fs.readdirSync` of exactly `directory` throwing an error
+ * carrying errno `code`. The listing case of {@link withSyncFsRefused}, named
+ * because refusing a LISTING is the question the crawler's consumers ask.
+ *
+ * @param directory - Absolute path of the one directory to refuse
+ * @param code - The errno to reject with
+ * @param body - Runs while the refusal is in force; may be async
+ * @returns Whatever `body` returned
  */
-export declare function canCreateSymlinks(dir: string): boolean;
+export declare function withReaddirSyncRefused<T>(directory: string, code: string, body: () => T | Promise<T>): Promise<T>;
+export {};
 //# sourceMappingURL=test-helpers.d.ts.map

package/dist/test-helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,QAAQ,EAC3C,GAAG,OAAO,EAAE,MAAM,EAAE,GACnB,MAAM,CAuBR;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG;IACtD,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAyBA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG;IACrD,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,MAAM,CAAC;CAC1B,CAwBA;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAUtD"}
+{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["../src/test-helpers.ts"],"names":[],"mappings":"AAQA,OAAO,CAAC,MAAM,sBAAsB,EAAE,OAAO,MAAM,CAAC;AAEpD;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,QAAQ,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAe5E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,iBAAiB,IAAI,iBAAiB,GAAG,IAAI,CAwB5D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,iBAAiB,EACvB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GACjC,IAAI,CAEN;AAED;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,iBAAiB,EACvB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GACjC,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,yUAgBpB,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,YAAY,IAAI,MAAM,IAAI,CAoBzC;AAGD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,CAE/F;AAED,+DAA+D;AAC/D,MAAM,MAAM,qBAAqB,GAC7B,aAAa,GACb,cAAc,GACd,UAAU,GACV,WAAW,GACX,cAAc,GACd,YAAY,GACZ,QAAQ,GACR,YAAY,CAAC;AAEjB,mEAAmE;AACnE,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAiB1F;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,IAAI,CAQxG;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,IAAI,CAQ1G;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,MAAM,EAAE,qBAAqB,EAC7B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,CAAC,CAAC,CAOZ;AAED;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAC5C,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,CAAC,CAAC,CAEZ"}