@cnrai/pave 0.3.33 → 0.3.34

package/test/agent-log-files.test.js

@@ -0,0 +1,349 @@
+#!/usr/bin/env node
+/**
+ * Tests for agent log file redirection and session file location (Issue #99).
+ *
+ * Verifies that:
+ * 1. Agent command writes pave.log to --config directory (not silencing console)
+ * 2. Agent command writes debug.log when DEBUG=1
+ * 3. Agent session file is stored in cwd as .pave-session.json (not config dir, see #108)
+ * 4. Log directory defaults to $(cwd)/.pave when --config is not specified
+ *
+ * Runs under `npm test` via test/run-tests.js
+ */
+
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+
+let passed = 0;
+let failed = 0;
+
+function runTest(name, testFn) {
+  try {
+    testFn();
+    passed++;
+    console.log(`✅ ${name}`);
+  } catch (error) {
+    failed++;
+    console.log(`❌ ${name}: ${error.message}`);
+  }
+}
+
+function assertEqual(actual, expected, message) {
+  if (actual !== expected) {
+    throw new Error(`${message || 'Assertion'}: expected ${JSON.stringify(expected)}, got ${JSON.stringify(actual)}`);
+  }
+}
+
+function assertContains(str, substr, message) {
+  if (typeof str !== 'string' || str.indexOf(substr) < 0) {
+    throw new Error(`${message || 'Assertion'}: expected ${JSON.stringify(str)} to contain ${JSON.stringify(substr)}`);
+  }
+}
+
+console.log('\n=== Agent Log Files Tests (Issue #99) ===\n');
+
+// ============================================================================
+// Test: Log directory resolution logic
+// ============================================================================
+console.log('--- Log directory resolution ---');
+
+runTest('Default log directory should resolve ./.pave (args-parser default)', () => {
+  // args.config defaults to './.pave' from args-parser (always truthy)
+  const argsConfig = './.pave';
+  const logDir = path.resolve(argsConfig);
+  assertEqual(logDir, path.resolve('./.pave'), 'log dir');
+});
+
+runTest('Log directory should use --config path when specified', () => {
+  const argsConfig = '/tmp/myproject/.pave';
+  const logDir = path.resolve(argsConfig);
+  assertEqual(logDir, path.resolve('/tmp/myproject/.pave'), 'log dir');
+});
+
+runTest('Log directory should resolve relative --config paths', () => {
+  const argsConfig = './custom-config';
+  const logDir = path.resolve(argsConfig);
+  assertEqual(logDir, path.resolve('./custom-config'), 'log dir');
+});
+
+runTest('pave.log path should be inside log directory', () => {
+  const logDir = '/tmp/test-config';
+  const logFile = path.join(logDir, 'pave.log');
+  assertEqual(logFile, path.join('/tmp/test-config', 'pave.log'), 'pave.log path');
+});
+
+runTest('debug.log path should be inside log directory', () => {
+  const logDir = '/tmp/test-config';
+  const debugLog = path.join(logDir, 'debug.log');
+  assertEqual(debugLog, path.join('/tmp/test-config', 'debug.log'), 'debug.log path');
+});
+
+// ============================================================================
+// Test: Session file location
+// ============================================================================
+console.log('\n--- Session file location ---');
+
+runTest('Session file should use resolveSessionFile (not direct path, #108 + #174)', () => {
+  // Verify from source code that agent SESSION_FILE uses resolveSessionFile
+  const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+  const agentBody = extractHandleAgentCommand(source);
+
+  // Agent should use resolveSessionFile(configDir) not path.join(process.cwd(), ...)
+  assertContains(agentBody, 'resolveSessionFile(configDir)', 'agent uses resolveSessionFile');
+  if (agentBody.indexOf("path.join(process.cwd(), '.pave-session.json')") >= 0) {
+    throw new Error('agent SESSION_FILE should not use direct .pave-session.json path');
+  }
+});
+
+runTest('Session file resolves to .pave/session.json', () => {
+  // The new session file is inside the config directory
+  const configDir = path.join(process.cwd(), '.pave');
+  const sessionFile = path.join(configDir, 'session.json');
+  assertContains(sessionFile, 'session.json', 'config dir session file');
+  assertEqual(path.basename(sessionFile), 'session.json', 'filename');
+});
+
+runTest('Only one session file path (no dual writes, #108)', () => {
+  // After #108, there should be no CWD_SESSION_FILE — session is now at .pave/session.json
+  // (migrated from .pave-session.json in #174, resolved via resolveSessionFile helper)
+  const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+  if (source.indexOf('CWD_SESSION_FILE') >= 0) {
+    throw new Error('CWD_SESSION_FILE should not exist after #108');
+  }
+});
+
+// ============================================================================
+// Test: Debug logging enablement
+// ============================================================================
+console.log('\n--- Debug logging enablement ---');
+
+// Helper that mirrors the actual debugEnabled logic in handleAgentCommand
+function isDebugEnabled(envDebug, envPaveDebug, argsDebug) {
+  return envDebug === '1' || envPaveDebug === '1' || Boolean(argsDebug);
+}
+
+runTest('Debug is enabled when DEBUG=1', () => {
+  assertEqual(isDebugEnabled('1', undefined, false), true, 'DEBUG=1');
+});
+
+runTest('Debug is enabled when PAVE_DEBUG=1', () => {
+  assertEqual(isDebugEnabled(undefined, '1', false), true, 'PAVE_DEBUG=1');
+});
+
+runTest('Debug is enabled when --debug flag is set', () => {
+  assertEqual(isDebugEnabled(undefined, undefined, true), true, '--debug');
+});
+
+runTest('Debug is disabled when no debug flag', () => {
+  assertEqual(isDebugEnabled(undefined, undefined, false), false, 'no debug');
+});
+
+runTest('Debug is disabled when env vars are not "1"', () => {
+  assertEqual(isDebugEnabled('0', '0', false), false, 'DEBUG=0');
+  assertEqual(isDebugEnabled('true', 'true', false), false, 'DEBUG=true (not "1")');
+});
+
+// ============================================================================
+// Test: Log stream writeToAgentLog format
+// ============================================================================
+console.log('\n--- Log format ---');
+
+runTest('Log format should include timestamp, level, and message', () => {
+  // Simulate the writeToAgentLog format
+  const ts = new Date().toISOString();
+  const level = "[LOG]";
+  const msg = "test message";
+  const line = "[" + ts + "] " + level + " " + msg + "\n";
+
+  assertContains(line, "[LOG]", 'contains level');
+  assertContains(line, "test message", 'contains message');
+  assertContains(line, "T", 'contains ISO timestamp T separator');
+  if (!line.endsWith("\n")) {
+    throw new Error('log line should end with newline');
+  }
+});
+
+runTest('Debug log format should include [agent] prefix', () => {
+  const ts = new Date().toISOString();
+  const msg = "Starting iteration 1";
+  const line = "[" + ts + "] [agent] " + msg + "\n";
+
+  assertContains(line, "[agent]", 'contains agent prefix');
+  assertContains(line, "Starting iteration 1", 'contains message');
+});
+
+// ============================================================================
+// Test: Actual file I/O (write and read log files)
+// ============================================================================
+console.log('\n--- File I/O ---');
+
+runTest('Should create log directory and write pave.log', () => {
+  const tmpDir = path.join(os.tmpdir(), 'pave-test-log-' + Date.now());
+  try {
+    fs.mkdirSync(tmpDir, { recursive: true });
+    const logFile = path.join(tmpDir, 'pave.log');
+    fs.appendFileSync(logFile, "[2026-01-01T00:00:00.000Z] [LOG] test log entry\n");
+    fs.appendFileSync(logFile, "[2026-01-01T00:00:01.000Z] [INF] second entry\n");
+    const content = fs.readFileSync(logFile, 'utf8');
+    assertContains(content, 'second entry', 'log file contains entry');
+    // Cleanup
+    try { fs.unlinkSync(logFile); fs.rmdirSync(tmpDir); } catch (e) { /* ignore */ }
+  } catch (e) {
+    if (e.message && e.message.indexOf('not a function') >= 0) {
+      throw new Error('SKIP: fs.mkdirSync not available in sandbox');
+    }
+    throw e;
+  }
+});
+
+runTest('Should write debug.log when debug is enabled', () => {
+  const tmpDir = path.join(os.tmpdir(), 'pave-test-debug-' + Date.now());
+  try {
+    fs.mkdirSync(tmpDir, { recursive: true });
+    const debugLog = path.join(tmpDir, 'debug.log');
+    const ts = new Date().toISOString();
+    fs.appendFileSync(debugLog, "[" + ts + "] [agent] Starting iteration 1\n");
+    fs.appendFileSync(debugLog, "[" + ts + "] [exit] agent cleanup called\n");
+
+    const content = fs.readFileSync(debugLog, 'utf8');
+    assertContains(content, '[agent] Starting iteration 1', 'debug log agent entry');
+    assertContains(content, '[exit] agent cleanup called', 'debug log exit entry');
+    // Cleanup
+    try { fs.unlinkSync(debugLog); fs.rmdirSync(tmpDir); } catch (e) { /* ignore */ }
+  } catch (e) {
+    if (e.message && e.message.indexOf('not a function') >= 0) {
+      throw new Error('SKIP: fs.mkdirSync not available in sandbox');
+    }
+    throw e;
+  }
+});
+
+runTest('Should write session.json to .pave/ directory (#174)', () => {
+  const tmpDir = path.join(os.tmpdir(), 'pave-test-session-' + Date.now());
+  try {
+    const configDir = path.join(tmpDir, '.pave');
+    fs.mkdirSync(configDir, { recursive: true });
+    // Session file goes in .pave/ directory
+    const sessionFile = path.join(configDir, 'session.json');
+    fs.writeFileSync(sessionFile, JSON.stringify({ sessionId: 'test-123', agentName: 'test' }, null, 2));
+
+    const data = JSON.parse(fs.readFileSync(sessionFile, 'utf8'));
+    assertEqual(data.sessionId, 'test-123', 'session ID');
+    assertEqual(data.agentName, 'test', 'agent name');
+    // Verify session file IS inside the .pave subdirectory
+    assertEqual(path.basename(path.dirname(sessionFile)), '.pave', 'in .pave subdir');
+    // Cleanup
+    try { fs.unlinkSync(sessionFile); fs.rmdirSync(configDir); fs.rmdirSync(tmpDir); } catch (e) { /* ignore */ }
+  } catch (e) {
+    if (e.message && e.message.indexOf('not a function') >= 0) {
+      throw new Error('SKIP: fs.mkdirSync not available in sandbox');
+    }
+    throw e;
+  }
+});
+
+// ============================================================================
+// Test: Source code verification
+// ============================================================================
+console.log('\n--- Source code verification ---');
+
+runTest('handleAgentCommand should reference AGENT_LOG_DIR and pave.log', () => {
+  try {
+    const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+    assertContains(source, 'AGENT_LOG_DIR', 'source contains AGENT_LOG_DIR');
+    assertContains(source, 'AGENT_LOG_FILE', 'source contains AGENT_LOG_FILE');
+    assertContains(source, "pave.log", 'source references pave.log');
+    assertContains(source, 'agentLogStream', 'source contains agentLogStream');
+  } catch (e) {
+    if (e.code === 'ENOENT') {
+      throw new Error('Could not read index.js for verification');
+    }
+    throw e;
+  }
+});
+
+runTest('handleAgentCommand should reference DEBUG_LOG_FILE and debug.log', () => {
+  try {
+    const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+    assertContains(source, 'DEBUG_LOG_FILE', 'source contains DEBUG_LOG_FILE');
+    assertContains(source, "debug.log", 'source references debug.log');
+    assertContains(source, 'debugLog(', 'source contains debugLog helper calls');
+    assertContains(source, 'debugEnabled', 'source contains debugEnabled check');
+  } catch (e) {
+    if (e.code === 'ENOENT') {
+      throw new Error('Could not read index.js for verification');
+    }
+    throw e;
+  }
+});
+
+// Helper: extract the full body of handleAgentCommand by brace matching
+function extractHandleAgentCommand(source) {
+  const funcStart = source.indexOf('async function handleAgentCommand');
+  if (funcStart < 0) throw new Error('handleAgentCommand not found in source');
+  // Find the opening brace of the function
+  const braceStart = source.indexOf('{', funcStart);
+  if (braceStart < 0) throw new Error('Could not find opening brace of handleAgentCommand');
+  let depth = 0;
+  let end = braceStart;
+  for (let i = braceStart; i < source.length; i++) {
+    if (source[i] === '{') depth++;
+    else if (source[i] === '}') {
+      depth--;
+      if (depth === 0) { end = i + 1; break; }
+    }
+  }
+  return source.substring(funcStart, end);
+}
+
+runTest('handleAgentCommand should NOT use crypto for session hash', () => {
+  try {
+    const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+    const agentBody = extractHandleAgentCommand(source);
+    // Remove comments before checking for crypto
+    const codeOnly = agentBody.replace(/\/\/.*$/gm, '').replace(/\/\*[\s\S]*?\*\//g, '');
+    if (codeOnly.indexOf("require(\"crypto\")") >= 0 || codeOnly.indexOf("require('crypto')") >= 0) {
+      throw new Error('handleAgentCommand should not require crypto (session hash removed)');
+    }
+  } catch (e) {
+    if (e.message && (e.message.indexOf('handleAgentCommand') >= 0 || e.message.indexOf('crypto') >= 0)) throw e;
+    if (e.code === 'ENOENT') throw new Error('Could not read index.js');
+    throw e;
+  }
+});
+
+runTest('Session file should use resolveSessionFile not agent-session-*.json', () => {
+  try {
+    const source = fs.readFileSync(path.join(__dirname, '..', 'index.js'), 'utf8');
+    const agentBody = extractHandleAgentCommand(source);
+
+    // Check that resolveSessionFile is used
+    assertContains(agentBody, 'resolveSessionFile', 'uses resolveSessionFile');
+
+    // Check that agent-session-*.json is NOT used in code (only in comments)
+    const codeOnly = agentBody.replace(/\/\/.*$/gm, '').replace(/\/\*[\s\S]*?\*\//g, '');
+    if (codeOnly.indexOf('agent-session-') >= 0) {
+      throw new Error('Should not reference agent-session-*.json pattern in code');
+    }
+  } catch (e) {
+    if (e.message && (e.message.indexOf('agent-session') >= 0 || e.message.indexOf('resolveSessionFile') >= 0 || e.message.indexOf('handleAgentCommand') >= 0)) throw e;
+    if (e.code === 'ENOENT') throw new Error('Could not read index.js');
+    throw e;
+  }
+});
+
+// ============================================================================
+// Summary
+// ============================================================================
+console.log('\n=== Results: ' + passed + ' passed, ' + failed + ' failed ===\n');
+if (failed > 0) process.exitCode = 1;
+
+// Export for run-tests.js integration
+if (typeof module !== 'undefined') {
+  module.exports = {
+    runAgentLogTests() {
+      return { passed, failed, total: passed + failed };
+    },
+  };
+}