-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathlogging_test.go
More file actions
402 lines (318 loc) · 12.5 KB
/
logging_test.go
File metadata and controls
402 lines (318 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
package logging
import (
"context"
"os"
"path/filepath"
"strings"
"testing"
"github.com/rs/zerolog"
zlog "github.com/rs/zerolog/log"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestInitialize(t *testing.T) {
t.Run("sets debug level when debug is true", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
// Call Initialize with debug=true
err := Initialize("test-service", true)
require.NoError(t, err)
// Verify that the global level is set to Debug
assert.Equal(t, zerolog.DebugLevel, zerolog.GlobalLevel())
assert.Equal(t, zerolog.DebugLevel, zlog.Logger.GetLevel())
})
t.Run("sets info level when debug is false", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
// Call Initialize with debug=false
err := Initialize("prod-service", false)
require.NoError(t, err)
// Verify that the global level is set to Info
assert.Equal(t, zerolog.InfoLevel, zerolog.GlobalLevel())
assert.Equal(t, zerolog.InfoLevel, zlog.Logger.GetLevel())
})
t.Run("uses console output by default", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
// Initialize should work without error
err := Initialize("test-service", false)
require.NoError(t, err)
// Verify logger is functional
zlog.Logger.Info().Msg("test message")
})
}
func TestInitializeWithFile(t *testing.T) {
// Create temp directory for test logs
tempDir := t.TempDir()
t.Run("console only output", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
closer, err := InitializeWithFile("console-service", true, OutputConsole, nil)
require.NoError(t, err)
assert.Nil(t, closer) // No file, no closer
assert.Equal(t, zerolog.DebugLevel, zerolog.GlobalLevel())
zlog.Logger.Info().Msg("console only message")
})
t.Run("file only output", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "file-only.log")
closer, err := InitializeWithFile("file-service", false, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
assert.Equal(t, zerolog.InfoLevel, zerolog.GlobalLevel())
// Write a log message
zlog.Logger.Info().Str("test", "value").Msg("file only message")
// Verify file exists and contains the message
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, "file only message")
assert.Contains(t, logStr, "file-service")
assert.Contains(t, logStr, `"test":"value"`)
assert.Contains(t, logStr, `"level":"info"`)
})
t.Run("both console and file output", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "both.log")
closer, err := InitializeWithFile("dual-service", true, OutputConsole|OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
assert.Equal(t, zerolog.DebugLevel, zerolog.GlobalLevel())
// Write a log message
zlog.Logger.Debug().Str("key", "value").Msg("dual output message")
// Verify file contains the message
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, "dual output message")
assert.Contains(t, logStr, "dual-service")
assert.Contains(t, logStr, `"key":"value"`)
assert.Contains(t, logStr, `"level":"debug"`)
})
t.Run("file output with append mode", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "append.log")
// First initialization
closer1, err := InitializeWithFile("append-service", false, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer1)
zlog.Logger.Info().Msg("first message")
closer1.Close()
// Re-initialize (simulating app restart)
zlog.Logger = zerolog.New(os.Stderr)
closer2, err := InitializeWithFile("append-service", false, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer2)
defer closer2.Close()
zlog.Logger.Info().Msg("second message")
// Verify both messages are in the file
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, "first message")
assert.Contains(t, logStr, "second message")
// Verify we have two separate log entries
lines := strings.Split(strings.TrimSpace(logStr), "\n")
assert.Equal(t, 2, len(lines))
})
t.Run("returns error when OutputFile specified without fileConfig", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
closer, err := InitializeWithFile("error-service", false, OutputFile, nil)
assert.Error(t, err)
assert.Nil(t, closer)
assert.Contains(t, err.Error(), "fileConfig with Path is required")
})
t.Run("returns error when OutputFile specified with empty path", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
closer, err := InitializeWithFile("error-service", false, OutputFile, &FileConfig{Path: ""})
assert.Error(t, err)
assert.Nil(t, closer)
assert.Contains(t, err.Error(), "fileConfig with Path is required")
})
t.Run("returns error when no output destination specified", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
closer, err := InitializeWithFile("error-service", false, 0, nil)
assert.Error(t, err)
assert.Nil(t, closer)
assert.Contains(t, err.Error(), "at least one output destination must be specified")
})
t.Run("returns error when file cannot be opened", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
invalidPath := "/invalid/nonexistent/directory/file.log"
closer, err := InitializeWithFile("error-service", false, OutputFile, &FileConfig{Path: invalidPath})
assert.Error(t, err)
assert.Nil(t, closer)
assert.Contains(t, err.Error(), "failed to open log file")
})
t.Run("creates file with correct permissions", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "permissions.log")
closer, err := InitializeWithFile("perm-service", false, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
// Write a message to ensure file is created
zlog.Logger.Info().Msg("test")
// Check file permissions
info, err := os.Stat(logFile)
require.NoError(t, err)
// Verify permissions are 0600 (owner read/write only)
mode := info.Mode().Perm()
assert.Equal(t, os.FileMode(0o600), mode)
})
t.Run("multiple log levels to file", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "levels.log")
closer, err := InitializeWithFile("levels-service", true, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
// Write multiple levels
zlog.Logger.Debug().Msg("debug message")
zlog.Logger.Info().Msg("info message")
zlog.Logger.Warn().Msg("warn message")
zlog.Logger.Error().Msg("error message")
// Verify all levels are in the file
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, `"level":"debug"`)
assert.Contains(t, logStr, `"level":"info"`)
assert.Contains(t, logStr, `"level":"warn"`)
assert.Contains(t, logStr, `"level":"error"`)
})
}
func TestContextLogger(t *testing.T) {
t.Run("creates logger with component field", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr).With().Timestamp().Logger()
// Create a context
ctx := context.Background()
// Get a logger with context
logger := ContextLogger(ctx, "test-component")
globalLogger := zlog.Logger
// Verify that the logger level matches global logger level
assert.Equal(t, globalLogger.GetLevel(), logger.GetLevel())
// Verify logger is not nil and can log without panic
logger.Info().Msg("test message")
})
t.Run("inherits level from global logger", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr).Level(zerolog.WarnLevel)
ctx := context.Background()
logger := ContextLogger(ctx, "warn-component")
// Verify logger inherits warn level
assert.Equal(t, zerolog.WarnLevel, logger.GetLevel())
})
t.Run("works with context values", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr).With().Timestamp().Logger()
// Create a context with values
type contextKey string
const requestIDKey contextKey = "request_id"
ctx := context.WithValue(context.Background(), requestIDKey, "123456")
// Get a logger with context - should not panic
logger := ContextLogger(ctx, "ctx-component")
// Verify logger can be used
logger.Info().Msg("message with context")
})
t.Run("works with file output", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
tempDir := t.TempDir()
logFile := filepath.Join(tempDir, "context.log")
zlog.Logger = zerolog.New(os.Stderr)
closer, err := InitializeWithFile("context-service", false, OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
ctx := context.Background()
logger := ContextLogger(ctx, "my-component")
logger.Info().Str("user_id", "123").Msg("user action")
// Verify file contains the message with component
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, "user action")
assert.Contains(t, logStr, `"component":"my-component"`)
assert.Contains(t, logStr, `"user_id":"123"`)
})
}
func TestIntegration(t *testing.T) {
tempDir := t.TempDir()
t.Run("complete workflow with file logging", func(t *testing.T) {
original := zlog.Logger
t.Cleanup(func() { zlog.Logger = original })
zlog.Logger = zerolog.New(os.Stderr)
logFile := filepath.Join(tempDir, "integration.log")
// Initialize the logger with both outputs
closer, err := InitializeWithFile("integration-service", true, OutputConsole|OutputFile, &FileConfig{Path: logFile})
require.NoError(t, err)
require.NotNil(t, closer)
defer closer.Close()
// Create a context logger
ctx := context.Background()
logger := ContextLogger(ctx, "integration-component")
// Log various messages
logger.Debug().Msg("Debug message")
logger.Info().Str("key", "value").Msg("Info message")
logger.Warn().Int("count", 42).Msg("Warning message")
// Also use global logger
globalLogger := zlog.Logger
globalLogger.Info().Msg("Global logger message")
// Verify file contains all messages
content, err := os.ReadFile(logFile)
require.NoError(t, err)
logStr := string(content)
assert.Contains(t, logStr, "Debug message")
assert.Contains(t, logStr, "Info message")
assert.Contains(t, logStr, "Warning message")
assert.Contains(t, logStr, "Global logger message")
assert.Contains(t, logStr, `"component":"integration-component"`)
assert.Contains(t, logStr, "integration-service")
})
}
func TestOutputDestination(t *testing.T) {
t.Run("bitwise operations work correctly", func(t *testing.T) {
// Test individual flags
assert.Equal(t, OutputDestination(1), OutputConsole)
assert.Equal(t, OutputDestination(2), OutputFile)
// Test combination
combined := OutputConsole | OutputFile
assert.Equal(t, OutputDestination(3), combined)
// Test checking flags
assert.NotEqual(t, 0, combined&OutputConsole)
assert.NotEqual(t, 0, combined&OutputFile)
// Test single flag
consoleOnly := OutputConsole
assert.NotEqual(t, 0, consoleOnly&OutputConsole)
assert.Equal(t, OutputDestination(0), consoleOnly&OutputFile)
})
}