onbuzz 3.4.0 → 3.6.2

package/src/tools/__tests__/terminalTool.test.js

@@ -0,0 +1,384 @@
+import { jest, describe, test, expect, beforeEach } from '@jest/globals';
+import { createMockLogger, createMockConfig } from '../../__test-utils__/mockFactories.js';
+
+// Mock child_process BEFORE importing TerminalTool
+const mockExec = jest.fn();
+const mockSpawn = jest.fn();
+
+jest.unstable_mockModule('child_process', () => ({
+  exec: mockExec,
+  spawn: mockSpawn,
+  execSync: jest.fn(() => ''),
+  default: { exec: mockExec, spawn: mockSpawn, execSync: jest.fn(() => '') }
+}));
+
+// Mock fs/promises
+const mockFs = {
+  stat: jest.fn(),
+  readdir: jest.fn(),
+  mkdir: jest.fn()
+};
+
+jest.unstable_mockModule('fs/promises', () => ({
+  default: mockFs,
+  ...mockFs
+}));
+
+// Mock constants
+const TERMINAL_CONFIG = {
+  STATES: {
+    RUNNING: 'running',
+    COMPLETED: 'completed',
+    FAILED: 'failed',
+    KILLED: 'killed'
+  },
+  MAX_OUTPUT_SIZE: 100000
+};
+
+jest.unstable_mockModule('../../utilities/constants.js', () => ({
+  TOOL_STATUS: { PENDING: 'pending', EXECUTING: 'executing', COMPLETED: 'completed', FAILED: 'failed' },
+  OPERATION_STATUS: { NOT_FOUND: 'not_found' },
+  ERROR_TYPES: {},
+  SYSTEM_DEFAULTS: { MAX_TOOL_EXECUTION_TIME: 300000 },
+  TERMINAL_CONFIG
+}));
+
+// Mock tagParser
+jest.unstable_mockModule('../../utilities/tagParser.js', () => ({
+  default: {
+    extractContent: jest.fn((content, tag) => {
+      const regex = new RegExp(`<${tag}>([\\s\\S]*?)<\\/${tag}>`, 'gi');
+      const matches = [];
+      let match;
+      while ((match = regex.exec(content)) !== null) {
+        matches.push(match[1]);
+      }
+      return matches;
+    })
+  }
+}));
+
+// Mock DirectoryAccessManager
+jest.unstable_mockModule('../../utilities/directoryAccessManager.js', () => ({
+  default: class MockDirectoryAccessManager {
+    constructor() {}
+    createDirectoryAccess(config) { return config; }
+    getWorkingDirectory(config) { return config.workingDirectory || '/project'; }
+    validateReadAccess() { return { allowed: true }; }
+    validateWriteAccess() { return { allowed: true }; }
+  }
+}));
+
+const { default: TerminalTool } = await import('../terminalTool.js');
+
+// Helper: configure mockExec to call callback with success
+function setupExecSuccess(stdout = 'output', stderr = '') {
+  mockExec.mockImplementation((cmd, opts, cb) => {
+    if (typeof opts === 'function') { cb = opts; opts = {}; }
+    process.nextTick(() => cb(null, stdout, stderr));
+    return { pid: 12345, on: jest.fn(), kill: jest.fn(), killed: false };
+  });
+}
+
+// Helper: configure mockExec to call callback with error
+function setupExecError(message = 'command failed', code = 1, stdout = '', stderr = 'error output') {
+  mockExec.mockImplementation((cmd, opts, cb) => {
+    if (typeof opts === 'function') { cb = opts; opts = {}; }
+    const error = new Error(message);
+    error.code = code;
+    process.nextTick(() => cb(error, stdout, stderr));
+    return { pid: 12345, on: jest.fn(), kill: jest.fn(), killed: false };
+  });
+}
+
+describe('TerminalTool', () => {
+  let tool;
+  let logger;
+  const context = { agentId: 'agent-1', projectDir: '/project' };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    logger = createMockLogger();
+    tool = new TerminalTool({}, logger);
+    // Override translateCommand to return command as-is for simpler testing
+    tool.translateCommand = jest.fn(async (cmd) => cmd);
+  });
+
+  test('constructor sets metadata correctly', () => {
+    expect(tool.id).toBe('terminal');
+    expect(tool.requiresProject).toBe(false);
+    expect(tool.timeout).toBe(120000);
+  });
+
+  test('getDescription mentions terminal', () => {
+    const desc = tool.getDescription();
+    expect(desc).toContain('Terminal Tool');
+    expect(desc).toContain('run-command');
+  });
+
+  test('getSupportedActions returns all action types', () => {
+    const actions = tool.getSupportedActions();
+    expect(actions).toContain('run-command');
+    expect(actions).toContain('change-directory');
+    expect(actions).toContain('list-directory');
+    expect(actions).toContain('create-directory');
+    expect(actions).toContain('get-working-directory');
+  });
+
+  test('getRequiredParameters returns actions', () => {
+    expect(tool.getRequiredParameters()).toEqual(['actions']);
+  });
+
+  test('parseParameters extracts run-command from XML', () => {
+    const content = '<run-command>npm install</run-command>';
+    const result = tool.parseParameters(content);
+    expect(result.actions).toEqual([{ type: 'run-command', command: 'npm install' }]);
+  });
+
+  test('parseParameters extracts change-directory from XML', () => {
+    const content = '<change-directory>src/components</change-directory>';
+    const result = tool.parseParameters(content);
+    expect(result.actions).toEqual([{ type: 'change-directory', directory: 'src/components' }]);
+  });
+
+  test('parseParameters extracts get-working-directory from XML', () => {
+    const content = '<get-working-directory>true</get-working-directory>';
+    const result = tool.parseParameters(content);
+    expect(result.actions.some(a => a.type === 'get-working-directory')).toBe(true);
+  });
+
+  test('parseParameters extracts timeout and async flags', () => {
+    const content = '<run-command>ls</run-command><timeout>5000</timeout><async>true</async>';
+    const result = tool.parseParameters(content);
+    expect(result.timeout).toBe(5000);
+    expect(result.async).toBe(true);
+  });
+
+  test('customValidateParameters rejects empty actions', () => {
+    const result = tool.customValidateParameters({ actions: [] });
+    expect(result.valid).toBe(false);
+  });
+
+  test('customValidateParameters rejects action without type', () => {
+    const result = tool.customValidateParameters({ actions: [{ command: 'ls' }] });
+    expect(result.valid).toBe(false);
+  });
+
+  test('customValidateParameters rejects run-command without command', () => {
+    const result = tool.customValidateParameters({
+      actions: [{ type: 'run-command', command: '' }]
+    });
+    expect(result.valid).toBe(false);
+  });
+
+  test('customValidateParameters rejects blocked commands', () => {
+    const result = tool.customValidateParameters({
+      actions: [{ type: 'run-command', command: 'rm -rf /' }]
+    });
+    expect(result.valid).toBe(false);
+    expect(result.errors.some(e => e.includes('blocked'))).toBe(true);
+  });
+
+  test('customValidateParameters rejects change-directory without directory', () => {
+    const result = tool.customValidateParameters({
+      actions: [{ type: 'change-directory', directory: '' }]
+    });
+    expect(result.valid).toBe(false);
+  });
+
+  test('customValidateParameters rejects unknown action type', () => {
+    const result = tool.customValidateParameters({
+      actions: [{ type: 'unknown-action' }]
+    });
+    expect(result.valid).toBe(false);
+  });
+
+  test('customValidateParameters accepts valid actions', () => {
+    const result = tool.customValidateParameters({
+      actions: [{ type: 'run-command', command: 'npm install' }]
+    });
+    expect(result.valid).toBe(true);
+  });
+
+  test('isBlockedCommand detects blocked commands', () => {
+    expect(tool.isBlockedCommand('rm -rf /')).toBe(true);
+    expect(tool.isBlockedCommand('format C:')).toBe(true);
+    expect(tool.isBlockedCommand('shutdown')).toBe(true);
+    expect(tool.isBlockedCommand('npm install')).toBe(false);
+  });
+
+  test('isBlockedCommand is case-insensitive', () => {
+    expect(tool.isBlockedCommand('SHUTDOWN')).toBe(true);
+    expect(tool.isBlockedCommand('Format')).toBe(true);
+  });
+
+  test('execute run-command returns stdout on success', async () => {
+    setupExecSuccess('hello world');
+
+    const result = await tool.execute(
+      { actions: [{ type: 'run-command', command: 'echo hello' }] },
+      context
+    );
+
+    expect(result.success).toBe(true);
+    expect(result.actions[0].success).toBe(true);
+    expect(result.actions[0].stdout).toBe('hello world');
+    expect(result.actions[0].exitCode).toBe(0);
+  });
+
+  test('execute run-command handles command error', async () => {
+    setupExecError('command not found', 127, '', 'bash: badcmd: command not found');
+
+    const result = await tool.execute(
+      { actions: [{ type: 'run-command', command: 'badcmd' }] },
+      context
+    );
+
+    // The tool resolves even on failure, just with success: false on the action
+    expect(result.actions[0].success).toBe(false);
+    expect(result.actions[0].exitCode).toBe(127);
+    expect(result.actions[0].error).toContain('command not found');
+  });
+
+  test('execute run-command captures exit code', async () => {
+    setupExecError('exit 2', 2);
+
+    const result = await tool.execute(
+      { actions: [{ type: 'run-command', command: 'exit 2' }] },
+      context
+    );
+
+    expect(result.actions[0].exitCode).toBe(2);
+  });
+
+  test('execute change-directory updates working dir', async () => {
+    mockFs.stat.mockResolvedValue({ isDirectory: () => true });
+
+    const result = await tool.execute(
+      { actions: [{ type: 'change-directory', directory: 'src' }] },
+      context
+    );
+
+    expect(result.success).toBe(true);
+    expect(result.actions[0].success).toBe(true);
+    expect(result.actions[0].action).toBe('change-directory');
+    expect(result.workingDirectory).toContain('src');
+  });
+
+  test('execute get-working-directory returns current dir', async () => {
+    const result = await tool.execute(
+      { actions: [{ type: 'get-working-directory' }] },
+      context
+    );
+
+    expect(result.success).toBe(true);
+    expect(result.actions[0].action).toBe('get-working-directory');
+    expect(result.actions[0].workingDirectory).toBeTruthy();
+  });
+
+  test('execute list-directory returns directory contents', async () => {
+    mockFs.readdir.mockResolvedValue([
+      { name: 'file.js', isDirectory: () => false, isFile: () => true, isSymbolicLink: () => false },
+      { name: 'src', isDirectory: () => true, isFile: () => false, isSymbolicLink: () => false }
+    ]);
+
+    const result = await tool.execute(
+      { actions: [{ type: 'list-directory', directory: '/project' }] },
+      context
+    );
+
+    expect(result.success).toBe(true);
+    expect(result.actions[0].totalItems).toBe(2);
+    expect(result.actions[0].files).toBe(1);
+    expect(result.actions[0].directories).toBe(1);
+  });
+
+  test('execute create-directory creates directory', async () => {
+    mockFs.mkdir.mockResolvedValue(undefined);
+
+    const result = await tool.execute(
+      { actions: [{ type: 'create-directory', directory: 'new-dir' }] },
+      context
+    );
+
+    expect(result.success).toBe(true);
+    expect(result.actions[0].success).toBe(true);
+    expect(result.actions[0].action).toBe('create-directory');
+  });
+
+  test('execute handles multiple actions', async () => {
+    setupExecSuccess('ok');
+
+    const result = await tool.execute(
+      {
+        actions: [
+          { type: 'get-working-directory' },
+          { type: 'run-command', command: 'echo ok' }
+        ]
+      },
+      context
+    );
+
+    expect(result.executedActions).toBe(2);
+    expect(result.actions.length).toBe(2);
+  });
+
+  test('execute reports overall failure when some actions fail', async () => {
+    setupExecError('fail', 1);
+
+    const result = await tool.execute(
+      { actions: [{ type: 'run-command', command: 'fail-cmd' }] },
+      context
+    );
+
+    expect(result.success).toBe(false);
+    expect(result.failedActions).toBe(1);
+  });
+
+  test('execute handles action throwing error gracefully', async () => {
+    mockFs.readdir.mockRejectedValue(new Error('permission denied'));
+
+    const result = await tool.execute(
+      { actions: [{ type: 'list-directory', directory: '/forbidden' }] },
+      context
+    );
+
+    expect(result.actions[0].success).toBe(false);
+    expect(result.actions[0].error).toContain('permission denied');
+  });
+
+  test('addToHistory records command and trims history', () => {
+    for (let i = 0; i < 110; i++) {
+      tool.addToHistory(
+        { type: 'run-command', command: `cmd-${i}` },
+        { success: true, executionTime: 10, workingDirectory: '/project' },
+        'agent-1'
+      );
+    }
+    expect(tool.commandHistory.length).toBe(100);
+  });
+
+  test('execute uses directoryAccess working directory', async () => {
+    setupExecSuccess('ok');
+
+    const result = await tool.execute(
+      { actions: [{ type: 'run-command', command: 'ls' }] },
+      {
+        agentId: 'agent-1',
+        projectDir: '/project',
+        directoryAccess: {
+          workingDirectory: '/custom/dir',
+          writeEnabledDirectories: ['/custom/dir']
+        }
+      }
+    );
+
+    expect(result.success).toBe(true);
+  });
+
+  test('getParameterSchema returns valid schema', () => {
+    const schema = tool.getParameterSchema();
+    expect(schema.type).toBe('object');
+    expect(schema.properties).toHaveProperty('actions');
+  });
+});

package/src/tools/__tests__/userPromptTool.test.js

@@ -0,0 +1,297 @@
+import { jest, describe, test, expect, beforeEach } from '@jest/globals';
+import { createMockLogger, createMockConfig } from '../../__test-utils__/mockFactories.js';
+
+// Mock prompt service
+const mockPromptService = {
+  createPromptRequest: jest.fn(),
+  formatResponseAsMessage: jest.fn().mockReturnValue('Formatted response')
+};
+
+jest.unstable_mockModule('../../services/promptService.js', () => ({
+  getPromptService: jest.fn().mockReturnValue(mockPromptService)
+}));
+
+const { default: UserPromptTool } = await import('../userPromptTool.js');
+
+describe('UserPromptTool', () => {
+  let tool;
+  let logger;
+
+  beforeEach(() => {
+    logger = createMockLogger();
+    tool = new UserPromptTool({}, logger);
+    jest.clearAllMocks();
+  });
+
+  describe('constructor', () => {
+    test('should set correct metadata', () => {
+      expect(tool.requiresProject).toBe(false);
+      expect(tool.isAsync).toBe(false);
+      expect(tool.timeout).toBe(300000); // 5 minutes
+      expect(tool.agentPool).toBeNull();
+      expect(tool.webSocketManager).toBeNull();
+    });
+  });
+
+  describe('getDescription', () => {
+    test('should return description with usage info', () => {
+      const desc = tool.getDescription();
+      expect(desc).toContain('User Prompt Tool');
+      expect(desc).toContain('questions');
+      expect(desc).toContain('options');
+    });
+  });
+
+  describe('parseParameters', () => {
+    test('should return content as-is', () => {
+      const result = tool.parseParameters('test');
+      expect(result).toBe('test');
+    });
+  });
+
+  describe('getRequiredParameters', () => {
+    test('should require questions', () => {
+      expect(tool.getRequiredParameters()).toContain('questions');
+    });
+  });
+
+  describe('getSupportedActions', () => {
+    test('should include prompt and ask actions', () => {
+      const actions = tool.getSupportedActions();
+      expect(actions).toContain('prompt');
+      expect(actions).toContain('ask');
+      expect(actions).toContain('question');
+    });
+  });
+
+  describe('validateParameterTypes', () => {
+    test('should accept valid params', () => {
+      const result = tool.validateParameterTypes({
+        message: 'Context',
+        questions: [{ message: 'Question?' }]
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test('should reject non-string message', () => {
+      const result = tool.validateParameterTypes({ message: 123 });
+      expect(result.valid).toBe(false);
+      expect(result.errors[0]).toContain('message must be a string');
+    });
+
+    test('should reject non-array questions', () => {
+      const result = tool.validateParameterTypes({ questions: 'not-array' });
+      expect(result.valid).toBe(false);
+    });
+  });
+
+  describe('customValidateParameters', () => {
+    test('should reject empty questions', () => {
+      const result = tool.customValidateParameters({ questions: [] });
+      expect(result.valid).toBe(false);
+    });
+
+    test('should reject more than 5 questions', () => {
+      const questions = Array(6).fill({ message: 'Q' });
+      const result = tool.customValidateParameters({ questions });
+      expect(result.valid).toBe(false);
+      expect(result.errors[0]).toContain('Maximum 5');
+    });
+
+    test('should reject question without message', () => {
+      const result = tool.customValidateParameters({ questions: [{ options: ['A'] }] });
+      expect(result.valid).toBe(false);
+      expect(result.errors[0]).toContain('message is required');
+    });
+
+    test('should reject long context message', () => {
+      const result = tool.customValidateParameters({
+        message: 'x'.repeat(501),
+        questions: [{ message: 'Q?' }]
+      });
+      expect(result.valid).toBe(false);
+    });
+
+    test('should accept valid params', () => {
+      const result = tool.customValidateParameters({
+        questions: [{ message: 'Question?' }]
+      });
+      expect(result.valid).toBe(true);
+    });
+
+    test('should accept question with "question" field instead of "message"', () => {
+      const result = tool.customValidateParameters({
+        questions: [{ question: 'Question?' }]
+      });
+      expect(result.valid).toBe(true);
+    });
+  });
+
+  describe('execute', () => {
+    test('should throw when agentId is missing', async () => {
+      await expect(tool.execute(
+        { questions: [{ message: 'Q?' }] },
+        {}
+      )).rejects.toThrow('Agent ID is required');
+    });
+
+    test('should throw when webSocketManager is not set', async () => {
+      await expect(tool.execute(
+        { questions: [{ message: 'Q?' }] },
+        { agentId: 'agent-1' }
+      )).rejects.toThrow('WebSocket manager not available');
+    });
+
+    test('should send prompt and return response on success', async () => {
+      const mockWs = { broadcastToSession: jest.fn() };
+      const mockPool = {
+        getAgent: jest.fn().mockResolvedValue({ id: 'agent-1', mode: 'agent', awaitingUserInput: null }),
+        persistAgentState: jest.fn().mockResolvedValue(undefined)
+      };
+
+      tool.setWebSocketManager(mockWs);
+      tool.setAgentPool(mockPool);
+
+      mockPromptService.createPromptRequest.mockReturnValue({
+        requestInfo: {
+          requestId: 'req-1',
+          message: 'Context',
+          questions: [{ message: 'Q?' }],
+          timeoutAt: new Date().toISOString()
+        },
+        promise: Promise.resolve({ response: { q1: 'Answer' } })
+      });
+
+      const result = await tool.execute(
+        { message: 'Context', questions: [{ message: 'Q?' }] },
+        { agentId: 'agent-1', sessionId: 'sess-1' }
+      );
+
+      expect(result.success).toBe(true);
+      expect(result.action).toBe('prompt');
+      expect(result.formattedResponse).toBe('Formatted response');
+      expect(mockWs.broadcastToSession).toHaveBeenCalled();
+    });
+
+    test('should handle timeout error', async () => {
+      const mockWs = { broadcastToSession: jest.fn() };
+      const mockPool = {
+        getAgent: jest.fn().mockResolvedValue({ id: 'agent-1', mode: 'agent' }),
+        persistAgentState: jest.fn().mockResolvedValue(undefined)
+      };
+
+      tool.setWebSocketManager(mockWs);
+      tool.setAgentPool(mockPool);
+
+      mockPromptService.createPromptRequest.mockReturnValue({
+        requestInfo: {
+          requestId: 'req-1',
+          message: 'Context',
+          questions: [{ message: 'Q?' }],
+          timeoutAt: new Date().toISOString()
+        },
+        promise: Promise.reject(new Error('Request timed out'))
+      });
+
+      const result = await tool.execute(
+        { questions: [{ message: 'Q?' }] },
+        { agentId: 'agent-1', sessionId: 'sess-1' }
+      );
+
+      expect(result.success).toBe(false);
+      expect(result.error.toLowerCase()).toMatch(/timed?\s*out|timeout|not respond/);
+    });
+
+    test('should handle cancellation', async () => {
+      const mockWs = { broadcastToSession: jest.fn() };
+      const mockPool = {
+        getAgent: jest.fn().mockResolvedValue({ id: 'agent-1', mode: 'agent' }),
+        persistAgentState: jest.fn().mockResolvedValue(undefined)
+      };
+
+      tool.setWebSocketManager(mockWs);
+      tool.setAgentPool(mockPool);
+
+      mockPromptService.createPromptRequest.mockReturnValue({
+        requestInfo: {
+          requestId: 'req-1',
+          message: null,
+          questions: [{ message: 'Q?' }],
+          timeoutAt: new Date().toISOString()
+        },
+        promise: Promise.reject(new Error('Request cancelled'))
+      });
+
+      const result = await tool.execute(
+        { questions: [{ message: 'Q?' }] },
+        { agentId: 'agent-1', sessionId: 'sess-1' }
+      );
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain('cancelled');
+    });
+
+    test('should rethrow unexpected errors', async () => {
+      const mockWs = { broadcastToSession: jest.fn() };
+      const mockPool = {
+        getAgent: jest.fn().mockResolvedValue({ id: 'agent-1', mode: 'agent' }),
+        persistAgentState: jest.fn().mockResolvedValue(undefined)
+      };
+
+      tool.setWebSocketManager(mockWs);
+      tool.setAgentPool(mockPool);
+
+      mockPromptService.createPromptRequest.mockReturnValue({
+        requestInfo: {
+          requestId: 'req-1',
+          message: null,
+          questions: [],
+          timeoutAt: new Date().toISOString()
+        },
+        promise: Promise.reject(new Error('Unexpected failure'))
+      });
+
+      await expect(tool.execute(
+        { questions: [{ message: 'Q?' }] },
+        { agentId: 'agent-1', sessionId: 'sess-1' }
+      )).rejects.toThrow('Unexpected failure');
+    });
+  });
+
+  describe('setAgentPool', () => {
+    test('should store agent pool', () => {
+      const pool = { getAgent: jest.fn() };
+      tool.setAgentPool(pool);
+      expect(tool.agentPool).toBe(pool);
+    });
+  });
+
+  describe('setWebSocketManager', () => {
+    test('should enable tool when ws manager is provided', () => {
+      tool.setWebSocketManager({ broadcastToSession: jest.fn() });
+      expect(tool.isEnabled).toBe(true);
+    });
+
+    test('should disable tool when ws manager is null', () => {
+      tool.setWebSocketManager(null);
+      expect(tool.isEnabled).toBe(false);
+    });
+  });
+
+  describe('getCapabilities', () => {
+    test('should include pausesAgent and requiresUI', () => {
+      const caps = tool.getCapabilities();
+      expect(caps.pausesAgent).toBe(true);
+      expect(caps.requiresUI).toBe(true);
+    });
+  });
+
+  describe('getParameterSchema', () => {
+    test('should return schema with questions', () => {
+      const schema = tool.getParameterSchema();
+      expect(schema.required).toContain('questions');
+      expect(schema.properties.questions).toBeDefined();
+      expect(schema.properties.message).toBeDefined();
+    });
+  });
+});