fluent-test 0.4.3

A fluent, Jest-like testing library for Rust
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
use crate::backend::{Assertion, TestSessionResult};
use crate::config::Config;
use crate::events::{AssertionEvent, EventEmitter, on_failure, on_success};
use crate::frontend::ConsoleRenderer;
use once_cell::sync::Lazy;
use std::cell::RefCell;
use std::collections::HashSet;
use std::sync::RwLock;

pub(crate) static GLOBAL_CONFIG: Lazy<RwLock<Config>> = Lazy::new(|| RwLock::new(Config::new()));

thread_local! {
    static TEST_SESSION: RefCell<TestSessionResult> = RefCell::new(TestSessionResult::default());
    // Track already reported messages to avoid duplicates
    static REPORTED_MESSAGES: RefCell<HashSet<String>> = RefCell::new(HashSet::new());
    // Flag to enable/disable deduplication
    static DEDUPLICATE_ENABLED: RefCell<bool> = const { RefCell::new(true) };
    // Flag to enable silent mode for intermediate steps in a chain
    static SILENT_MODE: RefCell<bool> = const { RefCell::new(false) };
}

pub struct Reporter;

impl Reporter {
    /// Initialize the reporter with event handlers
    pub fn init() {
        // Register success event handler
        on_success(|result| {
            Self::handle_success_event(result);
        });

        // Register failure event handler
        on_failure(|result| {
            Self::handle_failure_event(result);
        });
    }

    /// Handle success events
    fn handle_success_event(result: Assertion<()>) {
        TEST_SESSION.with(|session| {
            let mut session = session.borrow_mut();
            session.passed_count += 1;
        });

        // Check if silent mode is enabled
        let silent = SILENT_MODE.with(|silent| *silent.borrow());
        if silent {
            return;
        }

        // Check if we should deduplicate
        let should_report = DEDUPLICATE_ENABLED.with(|enabled| {
            if !*enabled.borrow() {
                // Deduplication disabled, always report
                return true;
            }

            // Only report each unique success message once
            REPORTED_MESSAGES.with(|msgs| {
                let key = format!("{:?}", result);
                let mut messages = msgs.borrow_mut();
                if !messages.contains(&key) {
                    messages.insert(key);
                    true
                } else {
                    false
                }
            })
        });

        if should_report {
            let config = GLOBAL_CONFIG.read().unwrap();
            let renderer = ConsoleRenderer::new(Config {
                use_colors: config.use_colors,
                use_unicode_symbols: config.use_unicode_symbols,
                show_success_details: config.show_success_details,
                enhanced_output: config.enhanced_output,
            });
            renderer.print_success(&result);
        }
    }

    /// Handle failure events
    fn handle_failure_event(result: Assertion<()>) {
        TEST_SESSION.with(|session| {
            let mut session = session.borrow_mut();
            session.failed_count += 1;
            session.failures.push(result.clone());
        });

        // Check if silent mode is enabled
        let silent = SILENT_MODE.with(|silent| *silent.borrow());
        if silent {
            return;
        }

        // Check if we should deduplicate
        let should_report = DEDUPLICATE_ENABLED.with(|enabled| {
            if !*enabled.borrow() {
                // Deduplication disabled, always report
                return true;
            }

            // Only report each unique failure message once
            let key = format!("{:?}", result);
            REPORTED_MESSAGES.with(|msgs| {
                let mut messages = msgs.borrow_mut();
                if !messages.contains(&key) {
                    messages.insert(key);
                    true
                } else {
                    false
                }
            })
        });

        if should_report {
            let config = GLOBAL_CONFIG.read().unwrap();
            let renderer = ConsoleRenderer::new(Config {
                use_colors: config.use_colors,
                use_unicode_symbols: config.use_unicode_symbols,
                show_success_details: config.show_success_details,
                enhanced_output: config.enhanced_output,
            });
            renderer.print_failure(&result);
        }
    }

    /// Clear the message cache to allow duplicated messages in different test scopes
    pub fn reset_message_cache() {
        REPORTED_MESSAGES.with(|msgs| {
            msgs.borrow_mut().clear();
        });
    }

    /// Enable deduplication of messages
    pub fn enable_deduplication() {
        DEDUPLICATE_ENABLED.with(|enabled| {
            *enabled.borrow_mut() = true;
        });
    }

    /// Disable deduplication of messages (for tests)
    pub fn disable_deduplication() {
        DEDUPLICATE_ENABLED.with(|enabled| {
            *enabled.borrow_mut() = false;
        });
    }

    /// Enable silent mode to suppress intermediate output in chains
    pub fn enable_silent_mode() {
        SILENT_MODE.with(|silent| {
            *silent.borrow_mut() = true;
        });
    }

    /// Disable silent mode to show all output
    pub fn disable_silent_mode() {
        SILENT_MODE.with(|silent| {
            *silent.borrow_mut() = false;
        });
    }

    pub fn summarize() {
        TEST_SESSION.with(|session| {
            let session = session.borrow();
            let config = GLOBAL_CONFIG.read().unwrap();
            let renderer = ConsoleRenderer::new(Config {
                use_colors: config.use_colors,
                use_unicode_symbols: config.use_unicode_symbols,
                show_success_details: config.show_success_details,
                enhanced_output: config.enhanced_output,
            });
            renderer.print_session_summary(&session);
        });

        // Emit session completed event
        EventEmitter::emit(AssertionEvent::SessionCompleted);

        // Clear reported messages
        Self::reset_message_cache();

        // Reset deduplication to default (enabled)
        Self::enable_deduplication();
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::backend::assertions::AssertionStep;
    use crate::backend::assertions::sentence::AssertionSentence;

    // Helper function to create a test assertion that won't evaluate on drop
    fn create_test_assertion(passed: bool) -> Assertion<()> {
        // Create a base assertion
        let mut assertion = Assertion::new((), "test_value");

        // Add a step with the appropriate pass/fail status
        assertion.steps.push(AssertionStep {
            sentence: AssertionSentence::new("be", if passed { "correct" } else { "incorrect" }),
            passed,
            logical_op: None,
        });

        // Set it as non-final to prevent Drop evaluation
        assertion.is_final = false;

        assertion
    }

    // Helper function to just record a failure in the session without actually
    // invoking the full reporter (which would panic on failure)
    fn record_failure(assertion: Assertion<()>) {
        TEST_SESSION.with(|session| {
            let mut session = session.borrow_mut();
            session.failed_count += 1;
            session.failures.push(assertion);
        });
    }

    #[test]
    fn test_reporter_deduplication_flags() {
        // Test enabling and disabling deduplication
        Reporter::enable_deduplication();
        DEDUPLICATE_ENABLED.with(|enabled| {
            assert_eq!(*enabled.borrow(), true);
        });

        Reporter::disable_deduplication();
        DEDUPLICATE_ENABLED.with(|enabled| {
            assert_eq!(*enabled.borrow(), false);
        });

        // Reset to default state
        Reporter::enable_deduplication();
    }

    #[test]
    fn test_reporter_silent_mode() {
        // Test enabling and disabling silent mode
        Reporter::enable_silent_mode();
        SILENT_MODE.with(|silent| {
            assert_eq!(*silent.borrow(), true);
        });

        Reporter::disable_silent_mode();
        SILENT_MODE.with(|silent| {
            assert_eq!(*silent.borrow(), false);
        });
    }

    #[test]
    fn test_reporter_message_cache() {
        // Add a message to the cache
        REPORTED_MESSAGES.with(|msgs| {
            msgs.borrow_mut().insert("test_message".to_string());
        });

        // Verify it's in the cache
        REPORTED_MESSAGES.with(|msgs| {
            assert!(msgs.borrow().contains("test_message"));
        });

        // Reset the cache
        Reporter::reset_message_cache();

        // Verify it's been cleared
        REPORTED_MESSAGES.with(|msgs| {
            assert!(!msgs.borrow().contains("test_message"));
        });
    }

    #[test]
    fn test_handle_success_event() {
        // Start with a clean session
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });

        // Disable deduplication for this test
        Reporter::disable_deduplication();

        // Create and handle a success event
        let assertion = create_test_assertion(true);
        Reporter::handle_success_event(assertion);

        // Verify the pass count was incremented
        TEST_SESSION.with(|session| {
            let session = session.borrow();
            assert_eq!(session.passed_count, 1);
            assert_eq!(session.failed_count, 0);
            assert_eq!(session.failures.len(), 0);
        });

        // Reset to default state
        Reporter::enable_deduplication();
        Reporter::reset_message_cache();
    }

    #[test]
    fn test_session_tracking() {
        // Start with a clean session
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });

        // Create a test assertion for failure
        let assertion = create_test_assertion(false);

        // Use our helper to directly record a failure without going through the reporter
        record_failure(assertion.clone());

        // Verify the failure count was incremented and the failure was recorded
        TEST_SESSION.with(|session| {
            let session = session.borrow();
            assert_eq!(session.passed_count, 0);
            assert_eq!(session.failed_count, 1);
            assert_eq!(session.failures.len(), 1);

            // Check that the failure matches what we sent
            if !session.failures.is_empty() {
                let first_failure = &session.failures[0];
                assert_eq!(first_failure.expr_str, assertion.expr_str);
                assert_eq!(first_failure.steps.len(), assertion.steps.len());
                assert_eq!(first_failure.steps[0].passed, assertion.steps[0].passed);
            }
        });

        // Clean up
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });
    }

    #[test]
    fn test_silent_mode() {
        // Enable silent mode
        Reporter::enable_silent_mode();

        // Verify silent mode is enabled
        SILENT_MODE.with(|silent| {
            assert_eq!(*silent.borrow(), true);
        });

        // Test that success events still increment the counter in silent mode
        // Start with a clean session
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });

        // Handle a success event in silent mode
        Reporter::handle_success_event(create_test_assertion(true));

        // Verify the pass count was incremented
        TEST_SESSION.with(|session| {
            let session = session.borrow();
            assert_eq!(session.passed_count, 1);
        });

        // Disable silent mode
        Reporter::disable_silent_mode();

        // Verify silent mode is disabled
        SILENT_MODE.with(|silent| {
            assert_eq!(*silent.borrow(), false);
        });

        // Clean up
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });
    }

    #[test]
    fn test_deduplication() {
        // Enable deduplication
        Reporter::enable_deduplication();
        Reporter::reset_message_cache();

        // Start with a clean session
        TEST_SESSION.with(|session| {
            *session.borrow_mut() = TestSessionResult::default();
        });

        // Create an assertion and send it twice
        let assertion = create_test_assertion(true);

        // Handle the same success event twice
        Reporter::handle_success_event(assertion.clone());
        Reporter::handle_success_event(assertion);

        // We should only count it once due to deduplication
        REPORTED_MESSAGES.with(|msgs| {
            assert_eq!(msgs.borrow().len(), 1);
        });

        // Verify it was still counted twice in the session
        TEST_SESSION.with(|session| {
            let session = session.borrow();
            assert_eq!(session.passed_count, 2);
        });

        // Clean up
        Reporter::reset_message_cache();
    }
}