reovim-driver-log 0.14.4

Logging driver for reovim (bridges kernel printk to tracing)
Documentation
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
use std::error::Error;

use super::*;

#[test]
fn test_log_error_display() {
    assert_eq!(LogError::MissingFilePath.to_string(), "file_path required for File output");

    assert_eq!(LogError::InvalidFilter("bad".into()).to_string(), "invalid filter: bad");

    assert_eq!(
        LogError::SetGlobalDefault("already set".into()).to_string(),
        "failed to set global subscriber: already set"
    );
}

#[test]
fn test_level_to_filter_str() {
    assert_eq!(level_to_filter_str(Level::Error), "error");
    assert_eq!(level_to_filter_str(Level::Warn), "warn");
    assert_eq!(level_to_filter_str(Level::Info), "info");
    assert_eq!(level_to_filter_str(Level::Debug), "debug");
    assert_eq!(level_to_filter_str(Level::Trace), "trace");
}

#[test]
fn test_log_error_debug() {
    let err = LogError::MissingFilePath;
    let debug_str = format!("{err:?}");
    assert!(debug_str.contains("MissingFilePath"));
}

#[test]
fn test_log_error_from_io() {
    let io_err = io::Error::new(io::ErrorKind::NotFound, "file not found");
    let log_err = LogError::from(io_err);
    assert!(matches!(log_err, LogError::Io(_)));
}

#[test]
fn test_log_error_source() {
    let io_err = io::Error::new(io::ErrorKind::NotFound, "file not found");
    let log_err = LogError::Io(io_err);
    assert!(log_err.source().is_some());

    let missing_err = LogError::MissingFilePath;
    assert!(missing_err.source().is_none());
}

#[test]
fn test_log_error_io_display() {
    let io_err = io::Error::new(io::ErrorKind::PermissionDenied, "access denied");
    let log_err = LogError::Io(io_err);
    let display = log_err.to_string();
    assert!(display.contains("I/O error"));
    assert!(display.contains("access denied"));
}

#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_log_error_source_all_variants() {
    // MissingFilePath has no source
    let err = LogError::MissingFilePath;
    assert!(err.source().is_none());

    // InvalidFilter has no source
    let err = LogError::InvalidFilter("bad filter".into());
    assert!(err.source().is_none());

    // SetGlobalDefault has no source
    let err = LogError::SetGlobalDefault("already set".into());
    assert!(err.source().is_none());

    // Io wraps an io::Error which IS the source
    let io_err = io::Error::new(io::ErrorKind::NotFound, "gone");
    let err = LogError::Io(io_err);
    assert!(err.source().is_some());
}

#[test]
#[cfg_attr(coverage_nightly, coverage(off))]
fn test_log_error_from_io_preserves_error_kind() {
    let io_err = io::Error::new(io::ErrorKind::BrokenPipe, "pipe broken");
    let log_err = LogError::from(io_err);
    match log_err {
        LogError::Io(ref e) => assert_eq!(e.kind(), io::ErrorKind::BrokenPipe),
        _ => panic!("Expected LogError::Io"),
    }
}

#[test]
fn test_log_error_debug_all_variants() {
    let variants: Vec<LogError> = vec![
        LogError::MissingFilePath,
        LogError::InvalidFilter("test".into()),
        LogError::SetGlobalDefault("test".into()),
        LogError::Io(io::Error::other("test")),
    ];
    for variant in &variants {
        let debug_str = format!("{variant:?}");
        assert!(!debug_str.is_empty());
    }
}

#[test]
fn test_log_error_display_missing_file_path() {
    let err = LogError::MissingFilePath;
    assert_eq!(err.to_string(), "file_path required for File output");
}

#[test]
fn test_log_error_display_invalid_filter() {
    let err = LogError::InvalidFilter("not a valid directive".into());
    assert_eq!(err.to_string(), "invalid filter: not a valid directive");
}

#[test]
fn test_log_error_display_set_global_default() {
    let err = LogError::SetGlobalDefault("a]ready set".into());
    assert_eq!(err.to_string(), "failed to set global subscriber: a]ready set");
}

#[test]
fn test_level_to_filter_str_exhaustive() {
    // Verify every level maps to a distinct filter string
    let levels = Level::ALL;
    let strs: Vec<&str> = levels.iter().map(|l| level_to_filter_str(*l)).collect();

    // All should be non-empty
    for s in &strs {
        assert!(!s.is_empty());
    }

    // All should be distinct
    for (i, a) in strs.iter().enumerate() {
        for (j, b) in strs.iter().enumerate() {
            if i != j {
                assert_ne!(a, b, "Filter strings at indices {i} and {j} should differ");
            }
        }
    }
}

#[test]
fn test_build_filter_with_default_config() {
    // build_filter should succeed with a default config
    let config = LogConfig::default();
    let filter = build_filter(&config);
    assert!(filter.is_ok());
}

#[test]
fn test_build_filter_with_all_levels() {
    for level in Level::ALL {
        let config = LogConfig {
            level,
            ..Default::default()
        };
        let filter = build_filter(&config);
        assert!(filter.is_ok(), "build_filter should succeed for level {level:?}");
    }
}

#[test]
fn test_log_error_is_error_trait() {
    fn assert_error<T: std::error::Error>() {}
    assert_error::<LogError>();
}

// Note: We can't test init_logging() via set_global_default because
// it can only be set once per process. Instead, we test the building
// logic by using tracing::subscriber::with_default for thread-local
// subscriber testing.

#[test]
fn test_init_logging_stderr_plain_builds_subscriber() {
    // Verify the subscriber construction path for Stderr+Plain
    let config = LogConfig {
        output: LogOutput::Stderr,
        format: LogFormat::Plain,
        level: Level::Info,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    // Build the subscriber the same way init_logging does
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stderr)
        .with_file(true)
        .with_line_number(true)
        .with_target(true)
        .finish();
    // Use with_default to verify the subscriber works
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log from stderr plain");
    });
}

#[test]
fn test_init_logging_stderr_json_builds_subscriber() {
    let config = LogConfig {
        output: LogOutput::Stderr,
        format: LogFormat::Json,
        level: Level::Debug,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stderr)
        .json()
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::debug!("test log from stderr json");
    });
}

#[test]
fn test_init_logging_stderr_pretty_builds_subscriber() {
    let config = LogConfig {
        output: LogOutput::Stderr,
        format: LogFormat::Pretty,
        level: Level::Warn,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stderr)
        .pretty()
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::warn!("test log from stderr pretty");
    });
}

#[test]
fn test_init_stdout_plain_builds_subscriber() {
    let config = LogConfig {
        output: LogOutput::Stdout,
        format: LogFormat::Plain,
        level: Level::Info,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stdout)
        .with_file(true)
        .with_line_number(true)
        .with_target(true)
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log from stdout plain");
    });
}

#[test]
fn test_init_stdout_json_builds_subscriber() {
    let config = LogConfig {
        output: LogOutput::Stdout,
        format: LogFormat::Json,
        level: Level::Info,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stdout)
        .json()
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log from stdout json");
    });
}

#[test]
fn test_init_stdout_pretty_builds_subscriber() {
    let config = LogConfig {
        output: LogOutput::Stdout,
        format: LogFormat::Pretty,
        level: Level::Info,
        ..Default::default()
    };
    let filter = build_filter(&config).unwrap();
    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(io::stdout)
        .pretty()
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log from stdout pretty");
    });
}

#[test]
fn test_init_file_json_builds_subscriber() {
    let temp_dir = std::env::temp_dir().join("reovim_test_log_file_json");
    let _ = std::fs::create_dir_all(&temp_dir);
    let log_path = temp_dir.join("test.log");

    let config = LogConfig {
        output: LogOutput::File,
        format: LogFormat::Json,
        level: Level::Info,
        file_path: Some(log_path.clone()),
        rotation: RotationPolicy::Never,
    };
    let filter = build_filter(&config).unwrap();

    let dir = log_path.parent().unwrap_or_else(|| Path::new("."));
    let prefix = log_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    let appender = rolling::never(dir, prefix);
    let (non_blocking, guard) = tracing_appender::non_blocking(appender);

    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(non_blocking)
        .json()
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log to file json");
    });
    drop(guard);
    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn test_init_file_plain_builds_subscriber() {
    let temp_dir = std::env::temp_dir().join("reovim_test_log_file_plain");
    let _ = std::fs::create_dir_all(&temp_dir);
    let log_path = temp_dir.join("test.log");

    let config = LogConfig {
        output: LogOutput::File,
        format: LogFormat::Plain,
        level: Level::Info,
        file_path: Some(log_path.clone()),
        rotation: RotationPolicy::Never,
    };
    let filter = build_filter(&config).unwrap();

    let dir = log_path.parent().unwrap_or_else(|| Path::new("."));
    let prefix = log_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    let appender = rolling::never(dir, prefix);
    let (non_blocking, guard) = tracing_appender::non_blocking(appender);

    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(non_blocking)
        .with_file(true)
        .with_line_number(true)
        .with_target(true)
        .with_ansi(false)
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log to file plain");
    });
    drop(guard);
    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn test_init_file_pretty_builds_as_plain() {
    // Pretty format for files falls through to Plain (no ANSI in files)
    let temp_dir = std::env::temp_dir().join("reovim_test_log_file_pretty");
    let _ = std::fs::create_dir_all(&temp_dir);
    let log_path = temp_dir.join("test.log");

    let config = LogConfig {
        output: LogOutput::File,
        format: LogFormat::Pretty,
        level: Level::Info,
        file_path: Some(log_path.clone()),
        rotation: RotationPolicy::Never,
    };
    let filter = build_filter(&config).unwrap();

    let dir = log_path.parent().unwrap_or_else(|| Path::new("."));
    let prefix = log_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    let appender = rolling::never(dir, prefix);
    let (non_blocking, guard) = tracing_appender::non_blocking(appender);

    let subscriber = fmt::Subscriber::builder()
        .with_env_filter(filter)
        .with_writer(non_blocking)
        .with_file(true)
        .with_line_number(true)
        .with_target(true)
        .with_ansi(false)
        .finish();
    tracing::subscriber::with_default(subscriber, || {
        tracing::info!("test log to file pretty-as-plain");
    });
    drop(guard);
    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn test_init_file_rotation_daily() {
    let temp_dir = std::env::temp_dir().join("reovim_test_log_daily");
    let _ = std::fs::create_dir_all(&temp_dir);
    let log_path = temp_dir.join("daily.log");

    let dir = log_path.parent().unwrap_or_else(|| Path::new("."));
    let prefix = log_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    let appender = rolling::daily(dir, prefix);
    let (non_blocking, guard) = tracing_appender::non_blocking(appender);
    drop(non_blocking);
    drop(guard);
    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn test_init_file_rotation_hourly() {
    let temp_dir = std::env::temp_dir().join("reovim_test_log_hourly");
    let _ = std::fs::create_dir_all(&temp_dir);
    let log_path = temp_dir.join("hourly.log");

    let dir = log_path.parent().unwrap_or_else(|| Path::new("."));
    let prefix = log_path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    let appender = rolling::hourly(dir, prefix);
    let (non_blocking, guard) = tracing_appender::non_blocking(appender);
    drop(non_blocking);
    drop(guard);
    let _ = std::fs::remove_dir_all(&temp_dir);
}

#[test]
fn test_init_logging_file_missing_path_error() {
    let config = LogConfig {
        output: LogOutput::File,
        format: LogFormat::Plain,
        level: Level::Info,
        file_path: None,
        rotation: RotationPolicy::Never,
    };
    let result = init_logging(&config);
    assert!(result.is_err());
    assert!(matches!(result.unwrap_err(), LogError::MissingFilePath));
}

#[test]
fn test_init_file_path_without_parent() {
    // Test the unwrap_or_else fallback for dir (no parent path)
    let path = Path::new("justfilename.log");
    let dir = path.parent().unwrap_or_else(|| Path::new("."));
    assert_eq!(dir, Path::new(""));
}

#[test]
fn test_init_file_path_without_filename() {
    // Test the unwrap_or fallback for prefix (no file name)
    let path = Path::new("/");
    let prefix = path
        .file_name()
        .and_then(|n| n.to_str())
        .unwrap_or("reovim");
    assert_eq!(prefix, "reovim");
}