rlg 0.0.8

A Rust library that implements application-level logging with a simple, readable output format. Features include log rotation, network logging, and support for multiple structured formats like JSON, CEF, and more.
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
476
477
478
479
480
481
// Copyright © 2024-2026 RustLogs (RLG). All rights reserved.
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

//! Integration tests for the new modules added in v0.0.7:
//! - `logger.rs` (RlgLogger, log facade bridge)
//! - `init.rs` (zero-config init API)
//! - `tracing.rs` (RlgLayer behind `tracing-layer` feature)
//! - `engine.rs` (Debug impl, inc_format)

#![allow(missing_docs)]

#[cfg(test)]
mod tests {
    use rlg::engine::{ENGINE, LockFreeEngine, LogEvent};
    use rlg::log::Log;
    use rlg::log_format::LogFormat;
    use rlg::log_level::LogLevel;

    // =========================================================================
    // engine.rs: Debug impl coverage
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_engine_debug_impl() {
        // Force LazyLock initialization by accessing the engine
        ENGINE.set_filter(0);
        // LazyLock<T> Debug shows the inner T once initialized
        let dbg = format!("{ENGINE:?}");
        assert!(dbg.contains("LockFreeEngine"));
        assert!(dbg.contains("queue"));
        assert!(dbg.contains("shutdown_flag"));
        assert!(dbg.contains("metrics"));
        assert!(dbg.contains("filter_level"));
        assert!(dbg.contains("flusher_thread"));
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_engine_debug_custom_instance() {
        let engine = LockFreeEngine::new(16);
        let dbg = format!("{engine:?}");
        assert!(dbg.contains("LockFreeEngine"));
        engine.shutdown();
    }

    // =========================================================================
    // engine.rs: inc_format coverage
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_engine_inc_format() {
        ENGINE.inc_format(LogFormat::JSON);
        ENGINE.inc_format(LogFormat::MCP);
        ENGINE.inc_format(LogFormat::OTLP);
    }

    // =========================================================================
    // logger.rs: RlgLogger integration
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_rlg_logger_via_log_trait() {
        use rlg::logger::RlgLogger;

        let logger = RlgLogger::new(LogFormat::JSON);

        // Test enabled check
        let meta = log::MetadataBuilder::new()
            .level(log::Level::Info)
            .target("test")
            .build();
        assert!(log::Log::enabled(&logger, &meta));

        // Test log with all optional fields
        let record = log::RecordBuilder::new()
            .args(format_args!("integration test msg"))
            .level(log::Level::Error)
            .target("integration::test")
            .file(Some("test.rs"))
            .line(Some(100))
            .module_path(Some("integration::test"))
            .build();
        log::Log::log(&logger, &record);

        // Test flush (no-op)
        log::Log::flush(&logger);
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_rlg_logger_log_without_optional_fields() {
        use rlg::logger::RlgLogger;

        let logger = RlgLogger::new(LogFormat::MCP);

        // Record with no file/line/module
        let record = log::RecordBuilder::new()
            .args(format_args!("no optional fields"))
            .level(log::Level::Warn)
            .target("bare_target")
            .build();
        log::Log::log(&logger, &record);
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_rlg_logger_all_log_levels() {
        use rlg::logger::RlgLogger;

        let logger = RlgLogger::new(LogFormat::JSON);
        for level in &[
            log::Level::Error,
            log::Level::Warn,
            log::Level::Info,
            log::Level::Debug,
            log::Level::Trace,
        ] {
            let record = log::RecordBuilder::new()
                .args(format_args!("level test"))
                .level(*level)
                .target("level_test")
                .build();
            log::Log::log(&logger, &record);
        }
    }

    #[test]
    fn test_map_log_level() {
        use rlg::logger::map_log_level;
        assert_eq!(map_log_level(log::Level::Error), LogLevel::ERROR);
        assert_eq!(map_log_level(log::Level::Warn), LogLevel::WARN);
        assert_eq!(map_log_level(log::Level::Info), LogLevel::INFO);
        assert_eq!(map_log_level(log::Level::Debug), LogLevel::DEBUG);
        assert_eq!(map_log_level(log::Level::Trace), LogLevel::TRACE);
    }

    #[test]
    fn test_to_log_level_filter() {
        use rlg::logger::to_log_level_filter;
        assert_eq!(
            to_log_level_filter(LogLevel::ALL),
            log::LevelFilter::Trace
        );
        assert_eq!(
            to_log_level_filter(LogLevel::TRACE),
            log::LevelFilter::Trace
        );
        assert_eq!(
            to_log_level_filter(LogLevel::DEBUG),
            log::LevelFilter::Debug
        );
        assert_eq!(
            to_log_level_filter(LogLevel::VERBOSE),
            log::LevelFilter::Info
        );
        assert_eq!(
            to_log_level_filter(LogLevel::INFO),
            log::LevelFilter::Info
        );
        assert_eq!(
            to_log_level_filter(LogLevel::WARN),
            log::LevelFilter::Warn
        );
        assert_eq!(
            to_log_level_filter(LogLevel::ERROR),
            log::LevelFilter::Error
        );
        assert_eq!(
            to_log_level_filter(LogLevel::FATAL),
            log::LevelFilter::Error
        );
        assert_eq!(
            to_log_level_filter(LogLevel::CRITICAL),
            log::LevelFilter::Error
        );
        assert_eq!(
            to_log_level_filter(LogLevel::NONE),
            log::LevelFilter::Off
        );
        assert_eq!(
            to_log_level_filter(LogLevel::DISABLED),
            log::LevelFilter::Off
        );
    }

    // =========================================================================
    // init.rs: Builder pattern and InitError
    // =========================================================================

    #[test]
    fn test_init_error_display_all() {
        use rlg::InitError;
        assert_eq!(
            InitError::LoggerAlreadySet.to_string(),
            "a log crate logger was already set"
        );
        assert_eq!(
            InitError::SubscriberAlreadySet.to_string(),
            "a tracing subscriber was already set"
        );
        assert_eq!(
            InitError::AlreadyInitialized.to_string(),
            "rlg was already initialized"
        );
    }

    #[test]
    fn test_init_error_debug() {
        use rlg::InitError;
        assert_eq!(
            format!("{:?}", InitError::LoggerAlreadySet),
            "LoggerAlreadySet"
        );
        assert_eq!(
            format!("{:?}", InitError::SubscriberAlreadySet),
            "SubscriberAlreadySet"
        );
        assert_eq!(
            format!("{:?}", InitError::AlreadyInitialized),
            "AlreadyInitialized"
        );
    }

    #[test]
    fn test_init_error_is_std_error() {
        use rlg::InitError;
        let err = InitError::LoggerAlreadySet;
        let _: &dyn std::error::Error = &err;
    }

    #[test]
    fn test_init_error_clone_copy() {
        use rlg::InitError;
        let err = InitError::AlreadyInitialized;
        let copy = err;
        assert_eq!(format!("{err:?}"), format!("{copy:?}"));
    }

    #[test]
    fn test_rlg_builder_defaults() {
        let b = rlg::builder();
        let dbg = format!("{b:?}");
        assert!(dbg.contains("INFO"));
        // Format is auto-detected (Logfmt for TTY, JSON for pipe/CI)
        assert!(dbg.contains("JSON") || dbg.contains("Logfmt"));
        assert!(dbg.contains("install_log: true"));
        assert!(dbg.contains("install_tracing: true"));
    }

    #[test]
    fn test_rlg_builder_level() {
        let b = rlg::builder().level(LogLevel::DEBUG);
        assert!(format!("{b:?}").contains("DEBUG"));
    }

    #[test]
    fn test_rlg_builder_format() {
        let b = rlg::builder().format(LogFormat::JSON);
        assert!(format!("{b:?}").contains("JSON"));
    }

    #[test]
    fn test_rlg_builder_without_log() {
        let b = rlg::builder().without_log();
        assert!(format!("{b:?}").contains("install_log: false"));
    }

    #[test]
    fn test_rlg_builder_without_tracing() {
        let b = rlg::builder().without_tracing();
        assert!(format!("{b:?}").contains("install_tracing: false"));
    }

    #[test]
    fn test_rlg_builder_full_chain() {
        let b = rlg::builder()
            .level(LogLevel::TRACE)
            .format(LogFormat::ECS)
            .without_log()
            .without_tracing();
        let dbg = format!("{b:?}");
        assert!(dbg.contains("TRACE"));
        assert!(dbg.contains("ECS"));
        assert!(dbg.contains("install_log: false"));
        assert!(dbg.contains("install_tracing: false"));
    }

    #[test]
    fn test_rlg_builder_copy() {
        let b = rlg::builder().level(LogLevel::WARN);
        let b2 = b;
        assert_eq!(format!("{b:?}"), format!("{b2:?}"));
    }

    // =========================================================================
    // tracing.rs: RlgSubscriber event routing for all levels
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_tracing_subscriber_all_levels_via_dispatch() {
        use rlg::tracing::RlgSubscriber;
        use tracing_core::dispatcher::Dispatch;

        let sub = RlgSubscriber::new();
        let dispatch = Dispatch::new(sub);

        tracing_core::dispatcher::with_default(&dispatch, || {
            tracing::error!("error event");
            tracing::warn!("warn event");
            tracing::info!("info event");
            tracing::debug!("debug event");
            tracing::trace!("trace event");
        });
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_tracing_subscriber_structured_fields() {
        use rlg::tracing::RlgSubscriber;
        use tracing_core::dispatcher::Dispatch;

        let sub = RlgSubscriber::new();
        let dispatch = Dispatch::new(sub);

        tracing_core::dispatcher::with_default(&dispatch, || {
            tracing::info!(
                user_id = 42_u64,
                latency = 12.5_f64,
                ok = true,
                "structured event"
            );
        });
    }

    // =========================================================================
    // tracing.rs: RlgLayer (behind tracing-layer feature)
    // =========================================================================

    #[cfg(feature = "tracing-layer")]
    mod tracing_layer_tests {
        use rlg::log_format::LogFormat;
        use rlg::tracing::RlgLayer;
        use tracing_subscriber::prelude::*;

        #[test]
        fn test_rlg_layer_new() {
            let layer = RlgLayer::new();
            assert!(format!("{layer:?}").contains("MCP"));
        }

        #[test]
        fn test_rlg_layer_with_format() {
            let layer = RlgLayer::new().with_format(LogFormat::JSON);
            assert!(format!("{layer:?}").contains("JSON"));
        }

        #[test]
        fn test_rlg_layer_default() {
            let layer = RlgLayer::default();
            assert!(format!("{layer:?}").contains("MCP"));
        }

        #[test]
        fn test_rlg_layer_clone_copy() {
            let layer = RlgLayer::new();
            let cloned = layer;
            let _ = format!("{layer:?}");
            let _ = format!("{cloned:?}");
        }

        #[test]
        #[cfg_attr(miri, ignore)]
        fn test_rlg_layer_event_routing() {
            let layer = RlgLayer::new().with_format(LogFormat::JSON);
            let subscriber = tracing_subscriber::registry().with(layer);
            let dispatch =
                tracing_core::dispatcher::Dispatch::new(subscriber);

            tracing_core::dispatcher::with_default(&dispatch, || {
                tracing::info!("layer event test");
                tracing::warn!(key = "value", "structured layer event");
                tracing::error!("error layer event");
                tracing::debug!("debug layer event");
                tracing::trace!("trace layer event");
            });
        }

        #[test]
        #[cfg_attr(miri, ignore)]
        fn test_rlg_layer_span_tracking() {
            let layer = RlgLayer::new();
            let subscriber = tracing_subscriber::registry().with(layer);
            let dispatch =
                tracing_core::dispatcher::Dispatch::new(subscriber);

            tracing_core::dispatcher::with_default(&dispatch, || {
                let _span =
                    tracing::info_span!("test_span", key = "val")
                        .entered();
                tracing::info!("inside span");
            });
        }

        #[test]
        #[cfg_attr(miri, ignore)]
        fn test_rlg_layer_multiple_formats() {
            for format in &[
                LogFormat::JSON,
                LogFormat::MCP,
                LogFormat::OTLP,
                LogFormat::ECS,
                LogFormat::Logfmt,
            ] {
                let layer = RlgLayer::new().with_format(*format);
                let subscriber =
                    tracing_subscriber::registry().with(layer);
                let dispatch =
                    tracing_core::dispatcher::Dispatch::new(subscriber);
                tracing_core::dispatcher::with_default(
                    &dispatch,
                    || {
                        tracing::info!("format test");
                    },
                );
            }
        }
    }

    // =========================================================================
    // LogEvent: new struct shape
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_log_event_with_log_field() {
        let log = Log::info("test event");
        let event = LogEvent {
            level: LogLevel::INFO,
            level_num: 6,
            log: log.clone(),
        };
        assert_eq!(event.level, LogLevel::INFO);
        assert_eq!(event.level_num, 6);
        assert_eq!(event.log.description, "test event");

        let cloned = event.clone();
        assert_eq!(cloned.log.description, "test event");

        let dbg = format!("{event:?}");
        assert!(dbg.contains("LogEvent"));
    }

    // =========================================================================
    // Log: deferred fire() and log() coverage
    // =========================================================================

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_log_fire_deferred() {
        Log::info("deferred fire test")
            .component("test")
            .with("key", "value")
            .format(LogFormat::JSON)
            .fire();
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn test_log_log_deferred() {
        let log = Log::info("deferred log test")
            .component("test")
            .with("key", "value")
            .format(LogFormat::MCP);
        log.log();
    }
}