@jamaynor/hal-config 1.0.1

package/test-utils.js

@@ -0,0 +1,255 @@
+/**
+ * test-utils
+ *
+ * Responsibility: Reusable test helpers for HAL skill test suites — temp dirs,
+ * file scaffolding, output capture, and process.exit mocking.
+ *
+ * Public Interface:
+ * test-utils
+ * ├── makeTmpDir(prefix?: string): string
+ * ├── makeTmpDirAsync(prefix?: string): Promise<string>
+ * ├── cleanup(dir: string): void
+ * ├── cleanupAsync(dir: string): Promise<void>
+ * ├── scaffold(baseDir: string, { dirs?, files? }): void
+ * ├── captureLog(): { lines: string[], restore: () => void }
+ * ├── captureStderr(): { lines: string[], restore: () => void }
+ * ├── captureWarn(): { lines: string[], restore: () => void }
+ * ├── captureOutput(): { stdout: string[], stderr: string[], raw: Array, restore: () => void }
+ * ├── silent(fn: Function): any
+ * ├── withCapturedLog(fn: Function): string[]
+ * ├── writeJson(filePath: string, data: any): void
+ * └── mockProcessExit(): { code: number|undefined, restore: () => void }
+ *
+ * Intentionally NOT extracted (grouped by reason):
+ *
+ * Skill-specific mock builders (22 — tightly coupled to their module under test):
+ *   email-triage:  buildMockDetect, buildNoopPromptMod, buildNoAnswerPromptMod,
+ *                  buildMockSystemCfg, buildNullContactResolver, buildNoopStarterRules,
+ *                  buildReadyImapCtor, buildErrorImapCtor, runWizardWithDeps,
+ *                  mockClient, mockClientWithError, mockSanitize, mockScan,
+ *                  mockScanAllow, mockScanBlock, blockResult, reviewResult, allowResult,
+ *                  buildMockIo, buildCleanIo, makeMockFs, makeEmptyFs,
+ *                  cleanGate, blockedGate, successFn, freshFn, memFs,
+ *                  makeRunLogWithMockFs, makeMemFs, makeEntry, makeSendNotification,
+ *                  makeCmdNoise
+ *   project-mgr:   makeMockSpawn
+ *
+ * Skill-specific utility functions (10 — domain logic, not test infrastructure):
+ *   plan-your-day: dateOffset, buildNoteWithTasks, makeVault, writeConfig
+ *   email-triage:  normPath, sha256, fakeBaseline, writeSkillConfig, makeTempDirs
+ *   secret-mgr:    run, secrets, wrapper, cleanup (Bitwarden secret cleanup)
+ */
+
+import fs from 'node:fs';
+import fsp from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
+
+// ============================================================================
+// Task 1.4 — Temp dirs, cleanup, scaffold
+// ============================================================================
+
+export function makeTmpDir(prefix) {
+  const p = prefix !== undefined ? prefix : 'hal-test-';
+  return fs.mkdtempSync(path.join(os.tmpdir(), p));
+}
+
+export async function makeTmpDirAsync(prefix) {
+  const p = prefix !== undefined ? prefix : 'hal-test-';
+  return fsp.mkdtemp(path.join(os.tmpdir(), p));
+}
+
+export function cleanup(dir) {
+  if (!dir) return;
+  if (!fs.existsSync(dir)) return;
+  fs.rmSync(dir, { recursive: true, force: true });
+}
+
+export async function cleanupAsync(dir) {
+  if (!dir) return;
+  try {
+    await fsp.access(dir);
+  } catch {
+    return;
+  }
+  await fsp.rm(dir, { recursive: true, force: true });
+}
+
+export function scaffold(baseDir, { dirs, files } = {}) {
+  if (dirs) {
+    for (const d of dirs) {
+      fs.mkdirSync(path.join(baseDir, d), { recursive: true });
+    }
+  }
+  if (files) {
+    for (const [relPath, content] of Object.entries(files)) {
+      const fullPath = path.join(baseDir, relPath);
+      const dirname = path.dirname(fullPath);
+      fs.mkdirSync(dirname, { recursive: true });
+      const data = typeof content === 'string'
+        ? content
+        : JSON.stringify(content, null, 2);
+      fs.writeFileSync(fullPath, data);
+    }
+  }
+}
+
+// ============================================================================
+// Task 1.5 — Output capture helpers
+// ============================================================================
+
+export function captureLog() {
+  const lines = [];
+  const original = console.log;
+  let restored = false;
+  console.log = (...args) => { lines.push(args.join(' ')); };
+  function restore() {
+    if (restored) return;
+    restored = true;
+    console.log = original;
+  }
+  return { lines, restore };
+}
+
+export function captureStderr() {
+  const lines = [];
+  const original = console.error;
+  let restored = false;
+  console.error = (...args) => { lines.push(args.join(' ')); };
+  function restore() {
+    if (restored) return;
+    restored = true;
+    console.error = original;
+  }
+  return { lines, restore };
+}
+
+export function captureWarn() {
+  const lines = [];
+  const original = console.warn;
+  let restored = false;
+  console.warn = (...args) => { lines.push(args.join(' ')); };
+  function restore() {
+    if (restored) return;
+    restored = true;
+    console.warn = original;
+  }
+  return { lines, restore };
+}
+
+export function captureOutput() {
+  const stdout = [];
+  const stderr = [];
+  const raw = [];
+
+  const origLog = console.log;
+  const origError = console.error;
+  const origWrite = process.stdout.write.bind(process.stdout);
+
+  let restored = false;
+
+  console.log = (...args) => { stdout.push(args.join(' ')); };
+  console.error = (...args) => { stderr.push(args.join(' ')); };
+  process.stdout.write = (chunk, ...rest) => {
+    raw.push(chunk);
+    return true;
+  };
+
+  function restore() {
+    if (restored) return;
+    restored = true;
+    console.log = origLog;
+    console.error = origError;
+    process.stdout.write = origWrite;
+  }
+
+  return { stdout, stderr, raw, restore };
+}
+
+export function silent(fn) {
+  const noop = () => {};
+  const origLog = console.log;
+  const origError = console.error;
+  const origWarn = console.warn;
+  console.log = noop;
+  console.error = noop;
+  console.warn = noop;
+
+  function restore() {
+    console.log = origLog;
+    console.error = origError;
+    console.warn = origWarn;
+  }
+
+  let result;
+  try {
+    result = fn();
+  } catch (err) {
+    restore();
+    throw err;
+  }
+
+  if (result && typeof result.then === 'function') {
+    return result.then(
+      (val) => { restore(); return val; },
+      (err) => { restore(); throw err; }
+    );
+  }
+
+  restore();
+  return result;
+}
+
+export function withCapturedLog(fn) {
+  const cap = captureLog();
+  let result;
+  try {
+    result = fn();
+  } catch (err) {
+    cap.restore();
+    throw err;
+  }
+
+  if (result && typeof result.then === 'function') {
+    return result.then(
+      () => { cap.restore(); return cap.lines; },
+      (err) => { cap.restore(); throw err; }
+    );
+  }
+
+  cap.restore();
+  return cap.lines;
+}
+
+// ============================================================================
+// Task 1.6 — writeJson and mockProcessExit
+// ============================================================================
+
+export function writeJson(filePath, data) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, JSON.stringify(data, null, 2));
+}
+
+export function mockProcessExit() {
+  const original = process.exit;
+  const holder = { code: undefined };
+  let restored = false;
+
+  process.exit = (exitCode) => {
+    holder.code = exitCode;
+    const err = new Error('process.exit called');
+    err.exitCode = exitCode;
+    throw err;
+  };
+
+  function restore() {
+    if (restored) return;
+    restored = true;
+    process.exit = original;
+  }
+
+  return {
+    get code() { return holder.code; },
+    restore,
+  };
+}