realizar 0.8.5

Pure Rust ML inference engine built from scratch - model serving for GGUF and safetensors
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
//! Infer Module Tests Part 04 - Helper Functions Coverage
//!
//! Tests for:
//! - clean_model_output function
//! - run_mock_inference function
//! - InferenceResult struct
//! - InferenceConfig edge cases
//!
//! Refs PMAT-802: Protocol T-COV-95

#[cfg(test)]
mod tests {
    use crate::infer::*;
    use std::path::PathBuf;

    // =========================================================================
    // clean_model_output Tests
    // =========================================================================

    #[test]
    fn test_clean_model_output_no_markers() {
        let output = clean_model_output("Hello, world!");
        assert_eq!(output, "Hello, world!");
    }

    #[test]
    fn test_clean_model_output_im_start_assistant() {
        let output = clean_model_output("<|im_start|>assistant\nHello!");
        assert_eq!(output, "Hello!");
    }

    #[test]
    fn test_clean_model_output_im_end() {
        let output = clean_model_output("Response text<|im_end|>");
        assert_eq!(output, "Response text");
    }

    #[test]
    fn test_clean_model_output_endoftext() {
        let output = clean_model_output("Final text<|endoftext|>");
        assert_eq!(output, "Final text");
    }

    #[test]
    fn test_clean_model_output_multiple_markers() {
        let output = clean_model_output("<|im_start|>assistant\nContent<|im_end|><|endoftext|>");
        assert_eq!(output, "Content");
    }

    #[test]
    fn test_clean_model_output_all_markers() {
        let raw = "<|im_start|>assistant\n<|im_start|>User said<|im_end|><|endoftext|>";
        let output = clean_model_output(raw);
        assert_eq!(output, "User said");
    }

    #[test]
    fn test_clean_model_output_empty_string() {
        let output = clean_model_output("");
        assert_eq!(output, "");
    }

    #[test]
    fn test_clean_model_output_only_markers() {
        let output = clean_model_output("<|im_start|><|im_end|>");
        assert_eq!(output, "");
    }

    #[test]
    fn test_clean_model_output_trims_whitespace() {
        let output = clean_model_output("  text with spaces  ");
        assert_eq!(output, "text with spaces");
    }

    #[test]
    fn test_clean_model_output_preserves_internal_newlines() {
        let output = clean_model_output("line1\nline2\nline3");
        assert_eq!(output, "line1\nline2\nline3");
    }

    // =========================================================================
    // run_mock_inference Tests
    // =========================================================================

    #[test]
    fn test_mock_inference_basic() {
        let config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("Hello world")
            .with_max_tokens(10);
        let mut mock_config = config;
        mock_config.use_mock_backend = true;

        let result = run_mock_inference(&mock_config).expect("mock inference should succeed");

        assert_eq!(result.format, "Mock");
        assert!(!result.used_gpu);
        assert!(result.text.contains("mock response for: Hello world"));
    }

    #[test]
    fn test_mock_inference_no_prompt() {
        let config = InferenceConfig::new("/test/model.gguf").with_max_tokens(5);
        let mut mock_config = config;
        mock_config.use_mock_backend = true;

        let result = run_mock_inference(&mock_config).expect("mock inference should succeed");

        assert!(result.text.contains("(no prompt)"));
        assert_eq!(result.input_token_count, 1); // BOS token
    }

    #[test]
    fn test_mock_inference_with_input_tokens() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_input_tokens(vec![10, 20, 30])
            .with_max_tokens(5);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        assert_eq!(result.input_token_count, 3);
        assert!(result.tokens.starts_with(&[10, 20, 30]));
    }

    #[test]
    fn test_mock_inference_generated_tokens() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("test")
            .with_max_tokens(5);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        assert_eq!(result.generated_token_count, 5);
        // Generated tokens should be 100, 101, 102, 103, 104
        let generated = &result.tokens[result.input_token_count..];
        assert_eq!(generated, &[100, 101, 102, 103, 104]);
    }

    #[test]
    fn test_mock_inference_max_tokens_capped() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("test")
            .with_max_tokens(100); // Will be capped to 32
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        // Mock caps at 32 tokens
        assert_eq!(result.generated_token_count, 32);
    }

    #[test]
    fn test_mock_inference_timing() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("test")
            .with_max_tokens(5);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        // Mock timing: 10ms load, inference_ms = 50 + (tokens * 2)
        assert!((result.load_ms - 10.0).abs() < 0.001);
        // For 5 tokens: 50 + 10 = 60ms
        assert!((result.inference_ms - 60.0).abs() < 0.001);
    }

    #[test]
    fn test_mock_inference_tok_per_sec() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("test")
            .with_max_tokens(5);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        // tok_per_sec = 5 tokens / 0.06 seconds = ~83.33 tok/s
        // Formula: inference_ms = 50 + (5 * 2) = 60ms
        let expected = 5.0 / 0.060;
        assert!((result.tok_per_sec - expected).abs() < 0.01);
    }

    #[test]
    fn test_mock_inference_prompt_tokenization() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("one two three four five")
            .with_max_tokens(3);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");

        // Mock tokenizes by splitting on whitespace: 5 words = 5 input tokens
        assert_eq!(result.input_token_count, 5);
    }

    // =========================================================================
    // InferenceConfig Builder Tests
    // =========================================================================

    #[test]
    fn test_inference_config_default_values() {
        let config = InferenceConfig::new("/test/model.gguf");

        assert_eq!(config.model_path, PathBuf::from("/test/model.gguf"));
        assert!(config.prompt.is_none());
        assert!(config.input_tokens.is_none());
        assert_eq!(config.max_tokens, 32);
        assert!((config.temperature - 0.0).abs() < 0.001);
        assert_eq!(config.top_k, 1);
        assert!(!config.no_gpu);
        assert!(!config.trace);
        assert!(!config.trace_verbose);
        assert!(config.trace_output.is_none());
        assert!(config.trace_steps.is_none());
        assert!(!config.verbose);
        assert!(!config.use_mock_backend);
    }

    #[test]
    fn test_inference_config_with_prompt() {
        let config = InferenceConfig::new("/model.gguf").with_prompt("Hello");
        assert_eq!(config.prompt, Some("Hello".to_string()));
    }

    #[test]
    fn test_inference_config_with_input_tokens() {
        let config = InferenceConfig::new("/model.gguf").with_input_tokens(vec![1, 2, 3]);
        assert_eq!(config.input_tokens, Some(vec![1, 2, 3]));
    }

    #[test]
    fn test_inference_config_with_max_tokens() {
        let config = InferenceConfig::new("/model.gguf").with_max_tokens(64);
        assert_eq!(config.max_tokens, 64);
    }

    #[test]
    fn test_inference_config_with_temperature() {
        let config = InferenceConfig::new("/model.gguf").with_temperature(0.7);
        assert!((config.temperature - 0.7).abs() < 0.001);
    }

    #[test]
    fn test_inference_config_with_top_k() {
        let config = InferenceConfig::new("/model.gguf").with_top_k(50);
        assert_eq!(config.top_k, 50);
    }

    #[test]
    fn test_inference_config_without_gpu() {
        let config = InferenceConfig::new("/model.gguf").without_gpu();
        assert!(config.no_gpu);
    }

    #[test]
    fn test_inference_config_with_verbose() {
        let config = InferenceConfig::new("/model.gguf").with_verbose(true);
        assert!(config.verbose);
    }

    #[test]
    fn test_inference_config_with_trace() {
        let config = InferenceConfig::new("/model.gguf").with_trace(true);
        assert!(config.trace);
    }

    #[test]
    fn test_inference_config_with_trace_output() {
        let config = InferenceConfig::new("/model.gguf").with_trace_output("/tmp/trace.json");
        assert_eq!(config.trace_output, Some(PathBuf::from("/tmp/trace.json")));
    }

    #[test]
    fn test_inference_config_chained_builders() {
        let config = InferenceConfig::new("/model.gguf")
            .with_prompt("Test prompt")
            .with_max_tokens(50)
            .with_temperature(0.5)
            .with_top_k(40)
            .without_gpu()
            .with_verbose(true)
            .with_trace(true)
            .with_trace_output("/output/trace.json");

        assert_eq!(config.prompt, Some("Test prompt".to_string()));
        assert_eq!(config.max_tokens, 50);
        assert!((config.temperature - 0.5).abs() < 0.001);
        assert_eq!(config.top_k, 40);
        assert!(config.no_gpu);
        assert!(config.verbose);
        assert!(config.trace);
        assert_eq!(
            config.trace_output,
            Some(PathBuf::from("/output/trace.json"))
        );
    }

    #[test]
    fn test_inference_config_clone() {
        let config = InferenceConfig::new("/model.gguf")
            .with_prompt("test")
            .with_max_tokens(20);

        let cloned = config.clone();
        assert_eq!(cloned.prompt, Some("test".to_string()));
        assert_eq!(cloned.max_tokens, 20);
    }

    #[test]
    fn test_inference_config_debug() {
        let config = InferenceConfig::new("/model.gguf");
        let debug_str = format!("{:?}", config);
        assert!(debug_str.contains("InferenceConfig"));
        assert!(debug_str.contains("model.gguf"));
    }

    // =========================================================================
    // InferenceResult Tests
    // =========================================================================

    #[test]
    fn test_inference_result_clone() {
        let result = InferenceResult {
            text: "output text".to_string(),
            tokens: vec![1, 2, 3],
            input_token_count: 1,
            generated_token_count: 2,
            inference_ms: 50.0,
            tok_per_sec: 40.0,
            load_ms: 10.0,
            format: "GGUF".to_string(),
            used_gpu: true,
        };

        let cloned = result.clone();
        assert_eq!(cloned.text, "output text");
        assert_eq!(cloned.tokens, vec![1, 2, 3]);
        assert_eq!(cloned.input_token_count, 1);
        assert_eq!(cloned.generated_token_count, 2);
        assert!((cloned.inference_ms - 50.0).abs() < 0.001);
        assert!((cloned.tok_per_sec - 40.0).abs() < 0.001);
        assert!((cloned.load_ms - 10.0).abs() < 0.001);
        assert_eq!(cloned.format, "GGUF");
        assert!(cloned.used_gpu);
    }

    #[test]
    fn test_inference_result_debug() {
        let result = InferenceResult {
            text: "test".to_string(),
            tokens: vec![1],
            input_token_count: 1,
            generated_token_count: 0,
            inference_ms: 1.0,
            tok_per_sec: 0.0,
            load_ms: 1.0,
            format: "Mock".to_string(),
            used_gpu: false,
        };

        let debug_str = format!("{:?}", result);
        assert!(debug_str.contains("InferenceResult"));
        assert!(debug_str.contains("Mock"));
    }

    // =========================================================================
    // run_inference with mock Tests
    // =========================================================================

    #[test]
    fn test_run_inference_mock_backend() {
        let mut config = InferenceConfig::new("/test/nonexistent.gguf")
            .with_prompt("Test prompt")
            .with_max_tokens(5);
        config.use_mock_backend = true;

        // Should succeed without accessing disk
        let result = run_inference(&config).expect("mock inference should succeed");
        assert_eq!(result.format, "Mock");
    }

    // =========================================================================
    // Edge Cases
    // =========================================================================

    #[test]
    fn test_inference_config_empty_prompt() {
        let config = InferenceConfig::new("/model.gguf").with_prompt("");
        assert_eq!(config.prompt, Some(String::new()));
    }

    #[test]
    fn test_inference_config_zero_max_tokens() {
        let config = InferenceConfig::new("/model.gguf").with_max_tokens(0);
        assert_eq!(config.max_tokens, 0);
    }

    #[test]
    fn test_inference_config_zero_temperature() {
        let config = InferenceConfig::new("/model.gguf").with_temperature(0.0);
        assert!((config.temperature - 0.0).abs() < 0.001);
    }

    #[test]
    fn test_inference_config_zero_top_k() {
        let config = InferenceConfig::new("/model.gguf").with_top_k(0);
        assert_eq!(config.top_k, 0);
    }

    #[test]
    fn test_mock_inference_zero_max_tokens() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("test")
            .with_max_tokens(0);
        config.use_mock_backend = true;

        // Mock returns error for max_tokens == 0
        let result = run_mock_inference(&config);
        assert!(result.is_err());
        let err_msg = format!("{}", result.unwrap_err());
        assert!(err_msg.contains("max_tokens"));
    }

    #[test]
    fn test_mock_inference_empty_prompt() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("")
            .with_max_tokens(3);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");
        // Empty string split by whitespace gives 0 tokens, falls back to BOS
        assert_eq!(result.input_token_count, 0);
    }

    #[test]
    fn test_mock_inference_whitespace_only_prompt() {
        let mut config = InferenceConfig::new("/test/model.gguf")
            .with_prompt("   ")
            .with_max_tokens(3);
        config.use_mock_backend = true;

        let result = run_mock_inference(&config).expect("mock inference should succeed");
        // Whitespace-only prompt gives 0 words when split
        assert_eq!(result.input_token_count, 0);
    }

    // =========================================================================
    // prefault_mmap Test (simple coverage)
    // =========================================================================

    #[test]
    fn test_prefault_mmap_empty() {
        let data: [u8; 0] = [];
        prefault_mmap(&data);
        // Should not panic
    }

    #[test]
    fn test_prefault_mmap_small() {
        let data = [1u8, 2, 3, 4, 5];
        prefault_mmap(&data);
        // Should not panic
    }

    #[test]
    fn test_prefault_mmap_page_size() {
        let data = vec![0u8; 4096]; // Exactly one page
        prefault_mmap(&data);
        // Should not panic
    }

    #[test]
    fn test_prefault_mmap_multiple_pages() {
        let data = vec![0u8; 4096 * 3 + 100]; // 3+ pages
        prefault_mmap(&data);
        // Should not panic
    }
}