|
| 1 | +/** |
| 2 | + * Unit tests for command logger utilities. |
| 3 | + * |
| 4 | + * Purpose: |
| 5 | + * Tests the command-scoped logger functionality. |
| 6 | + * |
| 7 | + * Test Coverage: |
| 8 | + * - createCommandLogger function |
| 9 | + * - createOperationLogger function |
| 10 | + * - createDebugLogger function |
| 11 | + * - getLogger, clearLogger, clearAllLoggers functions |
| 12 | + * |
| 13 | + * Related Files: |
| 14 | + * - src/utils/command/logger.mts (implementation) |
| 15 | + */ |
| 16 | + |
| 17 | +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' |
| 18 | + |
| 19 | +// Mock the logger. |
| 20 | +const mockLogger = vi.hoisted(() => ({ |
| 21 | + log: vi.fn(), |
| 22 | + error: vi.fn(), |
| 23 | + warn: vi.fn(), |
| 24 | + fail: vi.fn(), |
| 25 | + success: vi.fn(), |
| 26 | + info: vi.fn(), |
| 27 | +})) |
| 28 | +vi.mock('@socketsecurity/lib/logger', () => ({ |
| 29 | + getDefaultLogger: () => mockLogger, |
| 30 | +})) |
| 31 | + |
| 32 | +import { |
| 33 | + clearAllLoggers, |
| 34 | + clearLogger, |
| 35 | + createCommandLogger, |
| 36 | + createDebugLogger, |
| 37 | + createOperationLogger, |
| 38 | + getLogger, |
| 39 | +} from '../../../../src/utils/command/logger.mts' |
| 40 | + |
| 41 | +describe('command logger utilities', () => { |
| 42 | + beforeEach(() => { |
| 43 | + vi.clearAllMocks() |
| 44 | + clearAllLoggers() |
| 45 | + }) |
| 46 | + |
| 47 | + describe('createCommandLogger', () => { |
| 48 | + it('creates logger with command name', () => { |
| 49 | + const logger = createCommandLogger('scan:create') |
| 50 | + |
| 51 | + expect(logger.commandName).toBe('scan:create') |
| 52 | + }) |
| 53 | + |
| 54 | + it('prefixes log messages by default', () => { |
| 55 | + const logger = createCommandLogger('test-cmd') |
| 56 | + |
| 57 | + logger.log('test message') |
| 58 | + |
| 59 | + expect(mockLogger.log).toHaveBeenCalledWith('[test-cmd]', 'test message') |
| 60 | + }) |
| 61 | + |
| 62 | + it('prefixes all log levels', () => { |
| 63 | + const logger = createCommandLogger('test-cmd') |
| 64 | + |
| 65 | + logger.info('info') |
| 66 | + logger.warn('warn') |
| 67 | + logger.error('error') |
| 68 | + logger.fail('fail') |
| 69 | + logger.success('success') |
| 70 | + |
| 71 | + expect(mockLogger.info).toHaveBeenCalledWith('[test-cmd]', 'info') |
| 72 | + expect(mockLogger.warn).toHaveBeenCalledWith('[test-cmd]', 'warn') |
| 73 | + expect(mockLogger.error).toHaveBeenCalledWith('[test-cmd]', 'error') |
| 74 | + expect(mockLogger.fail).toHaveBeenCalledWith('[test-cmd]', 'fail') |
| 75 | + expect(mockLogger.success).toHaveBeenCalledWith('[test-cmd]', 'success') |
| 76 | + }) |
| 77 | + |
| 78 | + it('can disable prefix', () => { |
| 79 | + const logger = createCommandLogger('test-cmd', { includePrefix: false }) |
| 80 | + |
| 81 | + logger.log('test message') |
| 82 | + |
| 83 | + expect(mockLogger.log).toHaveBeenCalledWith('test message') |
| 84 | + }) |
| 85 | + |
| 86 | + it('supports custom prefix format', () => { |
| 87 | + const logger = createCommandLogger('test-cmd', { |
| 88 | + formatPrefix: name => `{${name}}`, |
| 89 | + }) |
| 90 | + |
| 91 | + logger.log('test message') |
| 92 | + |
| 93 | + expect(mockLogger.log).toHaveBeenCalledWith('{test-cmd}', 'test message') |
| 94 | + }) |
| 95 | + |
| 96 | + it('handles multiple arguments', () => { |
| 97 | + const logger = createCommandLogger('test-cmd') |
| 98 | + |
| 99 | + logger.log('arg1', 'arg2', { key: 'value' }) |
| 100 | + |
| 101 | + expect(mockLogger.log).toHaveBeenCalledWith('[test-cmd]', 'arg1', 'arg2', { |
| 102 | + key: 'value', |
| 103 | + }) |
| 104 | + }) |
| 105 | + }) |
| 106 | + |
| 107 | + describe('createOperationLogger', () => { |
| 108 | + it('creates scoped logger with operation name', () => { |
| 109 | + const cmdLogger = createCommandLogger('scan') |
| 110 | + const opLogger = createOperationLogger(cmdLogger, 'fetch') |
| 111 | + |
| 112 | + expect(opLogger.commandName).toBe('scan:fetch') |
| 113 | + }) |
| 114 | + |
| 115 | + it('prefixes with combined name', () => { |
| 116 | + const cmdLogger = createCommandLogger('repository') |
| 117 | + const opLogger = createOperationLogger(cmdLogger, 'validate') |
| 118 | + |
| 119 | + opLogger.log('validating...') |
| 120 | + |
| 121 | + expect(mockLogger.log).toHaveBeenCalledWith( |
| 122 | + '[repository:validate]', |
| 123 | + 'validating...', |
| 124 | + ) |
| 125 | + }) |
| 126 | + }) |
| 127 | + |
| 128 | + describe('createDebugLogger', () => { |
| 129 | + const originalDebug = process.env['DEBUG'] |
| 130 | + |
| 131 | + afterEach(() => { |
| 132 | + if (originalDebug !== undefined) { |
| 133 | + process.env['DEBUG'] = originalDebug |
| 134 | + } else { |
| 135 | + delete process.env['DEBUG'] |
| 136 | + } |
| 137 | + }) |
| 138 | + |
| 139 | + it('returns no-op when DEBUG is not set', () => { |
| 140 | + delete process.env['DEBUG'] |
| 141 | + |
| 142 | + const debug = createDebugLogger('socket:cli:test') |
| 143 | + debug('test message') |
| 144 | + |
| 145 | + expect(mockLogger.log).not.toHaveBeenCalled() |
| 146 | + }) |
| 147 | + |
| 148 | + it('logs when DEBUG matches namespace exactly', () => { |
| 149 | + process.env['DEBUG'] = 'socket:cli:test' |
| 150 | + |
| 151 | + const debug = createDebugLogger('socket:cli:test') |
| 152 | + debug('test message') |
| 153 | + |
| 154 | + expect(mockLogger.log).toHaveBeenCalledWith( |
| 155 | + '[socket:cli:test]', |
| 156 | + 'test message', |
| 157 | + ) |
| 158 | + }) |
| 159 | + |
| 160 | + it('logs when DEBUG is wildcard', () => { |
| 161 | + process.env['DEBUG'] = '*' |
| 162 | + |
| 163 | + const debug = createDebugLogger('anything:here') |
| 164 | + debug('test message') |
| 165 | + |
| 166 | + expect(mockLogger.log).toHaveBeenCalledWith( |
| 167 | + '[anything:here]', |
| 168 | + 'test message', |
| 169 | + ) |
| 170 | + }) |
| 171 | + |
| 172 | + it('logs when DEBUG matches with wildcard pattern', () => { |
| 173 | + process.env['DEBUG'] = 'socket:*' |
| 174 | + |
| 175 | + const debug = createDebugLogger('socket:cli:scan') |
| 176 | + debug('test message') |
| 177 | + |
| 178 | + expect(mockLogger.log).toHaveBeenCalledWith( |
| 179 | + '[socket:cli:scan]', |
| 180 | + 'test message', |
| 181 | + ) |
| 182 | + }) |
| 183 | + |
| 184 | + it('supports comma-separated namespaces', () => { |
| 185 | + process.env['DEBUG'] = 'other,socket:cli:test,another' |
| 186 | + |
| 187 | + const debug = createDebugLogger('socket:cli:test') |
| 188 | + debug('test message') |
| 189 | + |
| 190 | + expect(mockLogger.log).toHaveBeenCalled() |
| 191 | + }) |
| 192 | + }) |
| 193 | + |
| 194 | + describe('getLogger', () => { |
| 195 | + it('creates new logger when not cached', () => { |
| 196 | + const logger = getLogger('new-command') |
| 197 | + |
| 198 | + expect(logger.commandName).toBe('new-command') |
| 199 | + }) |
| 200 | + |
| 201 | + it('returns cached logger on subsequent calls', () => { |
| 202 | + const logger1 = getLogger('cached-command') |
| 203 | + const logger2 = getLogger('cached-command') |
| 204 | + |
| 205 | + expect(logger1).toBe(logger2) |
| 206 | + }) |
| 207 | + |
| 208 | + it('creates different loggers for different commands', () => { |
| 209 | + const logger1 = getLogger('command-1') |
| 210 | + const logger2 = getLogger('command-2') |
| 211 | + |
| 212 | + expect(logger1).not.toBe(logger2) |
| 213 | + expect(logger1.commandName).toBe('command-1') |
| 214 | + expect(logger2.commandName).toBe('command-2') |
| 215 | + }) |
| 216 | + }) |
| 217 | + |
| 218 | + describe('clearLogger', () => { |
| 219 | + it('removes logger from cache', () => { |
| 220 | + const logger1 = getLogger('clear-test') |
| 221 | + clearLogger('clear-test') |
| 222 | + const logger2 = getLogger('clear-test') |
| 223 | + |
| 224 | + // Should be different instances since cache was cleared. |
| 225 | + expect(logger1).not.toBe(logger2) |
| 226 | + }) |
| 227 | + }) |
| 228 | + |
| 229 | + describe('clearAllLoggers', () => { |
| 230 | + it('removes all loggers from cache', () => { |
| 231 | + const logger1 = getLogger('test-1') |
| 232 | + const logger2 = getLogger('test-2') |
| 233 | + |
| 234 | + clearAllLoggers() |
| 235 | + |
| 236 | + const logger1b = getLogger('test-1') |
| 237 | + const logger2b = getLogger('test-2') |
| 238 | + |
| 239 | + expect(logger1).not.toBe(logger1b) |
| 240 | + expect(logger2).not.toBe(logger2b) |
| 241 | + }) |
| 242 | + }) |
| 243 | +}) |
0 commit comments