realizar 0.8.4

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
//! Loader Tests Part 01 - Loading Functions, Header Parsing, and Error Handling
//!
//! Comprehensive tests for /src/gguf/loader.rs focusing on:
//! - Header parsing edge cases (magic, version validation)
//! - Metadata parsing with corrupted data
//! - Tensor info parsing with invalid dimensions
//! - Error propagation through read_* helper methods
//! - Alignment calculations
//! - Data range validation in get_tensor_f32
//!
//! This file targets uncovered paths identified in coverage analysis.

use crate::error::RealizarError;
use crate::gguf::{
    GGUFModel, GGUFValue, GGUF_ALIGNMENT, GGUF_MAGIC, GGUF_TYPE_F16, GGUF_TYPE_F32,
    GGUF_TYPE_Q4_0, GGUF_TYPE_Q4_1, GGUF_TYPE_Q4_K, GGUF_TYPE_Q5_0, GGUF_TYPE_Q5_1,
    GGUF_TYPE_Q5_K, GGUF_TYPE_Q6_K, GGUF_TYPE_Q8_0, GGUF_VERSION_V3,
};

// =============================================================================
// Test Data Builders
// =============================================================================

/// Build valid GGUF header bytes
fn build_header(tensor_count: u64, metadata_count: u64) -> Vec<u8> {
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_le_bytes());
    data.extend_from_slice(&GGUF_VERSION_V3.to_le_bytes());
    data.extend_from_slice(&tensor_count.to_le_bytes());
    data.extend_from_slice(&metadata_count.to_le_bytes());
    data
}

/// Build GGUF string (u64 length + UTF-8 bytes)
fn build_string(s: &str) -> Vec<u8> {
    let mut data = Vec::new();
    data.extend_from_slice(&(s.len() as u64).to_le_bytes());
    data.extend_from_slice(s.as_bytes());
    data
}

/// Build metadata entry
fn build_metadata(key: &str, value_type: u32, value_bytes: &[u8]) -> Vec<u8> {
    let mut data = Vec::new();
    data.extend(build_string(key));
    data.extend_from_slice(&value_type.to_le_bytes());
    data.extend_from_slice(value_bytes);
    data
}

/// Build tensor info entry
fn build_tensor_info(name: &str, dims: &[u64], qtype: u32, offset: u64) -> Vec<u8> {
    let mut data = Vec::new();
    data.extend(build_string(name));
    data.extend_from_slice(&(dims.len() as u32).to_le_bytes());
    for &dim in dims.iter().rev() {
        data.extend_from_slice(&dim.to_le_bytes());
    }
    data.extend_from_slice(&qtype.to_le_bytes());
    data.extend_from_slice(&offset.to_le_bytes());
    data
}

/// Pad data to GGUF alignment (32 bytes)
fn align_to_boundary(data: &mut Vec<u8>) {
    let current_len = data.len();
    let aligned = current_len.div_ceil(GGUF_ALIGNMENT) * GGUF_ALIGNMENT;
    data.resize(aligned, 0);
}

// =============================================================================
// Header Parsing - Edge Cases
// =============================================================================

#[test]
fn test_loader_header_exactly_minimum_size() {
    // Exactly 24 bytes: magic(4) + version(4) + tensor_count(8) + metadata_count(8)
    let data = build_header(0, 0);
    assert_eq!(data.len(), 24);
    let model = GGUFModel::from_bytes(&data).expect("Minimum header should parse");
    assert_eq!(model.header.magic, GGUF_MAGIC);
    assert_eq!(model.header.version, GGUF_VERSION_V3);
}

#[test]
fn test_loader_header_magic_partial_bytes() {
    // Only 3 bytes of magic
    let data = vec![0x47, 0x47, 0x55];
    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_version_truncated() {
    // Magic complete, version truncated
    let mut data = GGUF_MAGIC.to_le_bytes().to_vec();
    data.extend_from_slice(&[0x03, 0x00]); // Only 2 bytes of version
    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_tensor_count_truncated() {
    // Magic + version complete, tensor_count truncated
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_le_bytes());
    data.extend_from_slice(&GGUF_VERSION_V3.to_le_bytes());
    data.extend_from_slice(&[0x00, 0x00, 0x00, 0x00]); // Only 4 bytes of tensor_count
    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_metadata_count_truncated() {
    // Magic + version + tensor_count complete, metadata_count truncated
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_le_bytes());
    data.extend_from_slice(&GGUF_VERSION_V3.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());
    data.extend_from_slice(&[0x00, 0x00, 0x00]); // Only 3 bytes of metadata_count
    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_version_1_unsupported() {
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_le_bytes());
    data.extend_from_slice(&1u32.to_le_bytes()); // Version 1
    data.extend_from_slice(&0u64.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());

    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(err_msg.contains("version") || err_msg.contains("Version"));
}

#[test]
fn test_loader_header_version_4_unsupported() {
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_le_bytes());
    data.extend_from_slice(&4u32.to_le_bytes()); // Version 4 (future)
    data.extend_from_slice(&0u64.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());

    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_all_zeros_magic() {
    let mut data = vec![0u8; 24];
    // All zeros - magic is 0, not GGUF_MAGIC
    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
    let err = result.unwrap_err().to_string().to_lowercase();
    assert!(err.contains("magic"));
}

#[test]
fn test_loader_header_big_endian_magic() {
    // GGUF magic in big-endian (wrong byte order)
    let mut data = Vec::new();
    data.extend_from_slice(&GGUF_MAGIC.to_be_bytes()); // Wrong endianness
    data.extend_from_slice(&GGUF_VERSION_V3.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());

    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_header_max_tensor_count() {
    // Very large tensor count - parsing should succeed but no tensor data
    let mut data = build_header(u64::MAX, 0);
    // Don't add any tensor info - just test header parsing succeeds
    // The tensor info parsing will fail due to truncation

    let model = GGUFModel::from_bytes(&data);
    // Should fail during tensor info parsing due to truncation
    assert!(model.is_err());
}

// =============================================================================
// Metadata Parsing - Value Type Coverage
// =============================================================================

#[test]
fn test_loader_metadata_all_integer_types() {
    let mut data = build_header(0, 6);

    // u8
    data.extend(build_metadata("val_u8", 0, &[255u8]));
    // i8
    data.extend(build_metadata("val_i8", 1, &(-127i8).to_le_bytes()));
    // u16
    data.extend(build_metadata("val_u16", 2, &65535u16.to_le_bytes()));
    // i16
    data.extend(build_metadata("val_i16", 3, &(-32768i16).to_le_bytes()));
    // u32
    data.extend(build_metadata("val_u32", 4, &0xDEADBEEFu32.to_le_bytes()));
    // i32
    data.extend(build_metadata("val_i32", 5, &(-2147483648i32).to_le_bytes()));

    let model = GGUFModel::from_bytes(&data).expect("Should parse all integer types");

    assert!(matches!(
        model.metadata.get("val_u8"),
        Some(GGUFValue::UInt8(255))
    ));
    assert!(matches!(
        model.metadata.get("val_i8"),
        Some(GGUFValue::Int8(-127))
    ));
    assert!(matches!(
        model.metadata.get("val_u16"),
        Some(GGUFValue::UInt16(65535))
    ));
    assert!(matches!(
        model.metadata.get("val_i16"),
        Some(GGUFValue::Int16(-32768))
    ));
    assert!(matches!(
        model.metadata.get("val_u32"),
        Some(GGUFValue::UInt32(0xDEADBEEF))
    ));
    assert!(matches!(
        model.metadata.get("val_i32"),
        Some(GGUFValue::Int32(-2147483648))
    ));
}

#[test]
fn test_loader_metadata_bool_nonzero_values() {
    let mut data = build_header(0, 3);

    // bool: 0 = false
    data.extend(build_metadata("bool_zero", 7, &[0u8]));
    // bool: 1 = true
    data.extend(build_metadata("bool_one", 7, &[1u8]));
    // bool: 255 = also true (any non-zero)
    data.extend(build_metadata("bool_255", 7, &[255u8]));

    let model = GGUFModel::from_bytes(&data).expect("Should parse");

    assert!(matches!(
        model.metadata.get("bool_zero"),
        Some(GGUFValue::Bool(false))
    ));
    assert!(matches!(
        model.metadata.get("bool_one"),
        Some(GGUFValue::Bool(true))
    ));
    assert!(matches!(
        model.metadata.get("bool_255"),
        Some(GGUFValue::Bool(true))
    ));
}

#[test]
fn test_loader_metadata_float_special_values() {
    let mut data = build_header(0, 6);

    // f32 specials
    data.extend(build_metadata(
        "f32_nan",
        6,
        &f32::NAN.to_le_bytes(),
    ));
    data.extend(build_metadata(
        "f32_inf",
        6,
        &f32::INFINITY.to_le_bytes(),
    ));
    data.extend(build_metadata(
        "f32_neg_inf",
        6,
        &f32::NEG_INFINITY.to_le_bytes(),
    ));

    // f64 specials
    data.extend(build_metadata(
        "f64_nan",
        12,
        &f64::NAN.to_le_bytes(),
    ));
    data.extend(build_metadata(
        "f64_inf",
        12,
        &f64::INFINITY.to_le_bytes(),
    ));
    data.extend(build_metadata(
        "f64_neg_inf",
        12,
        &f64::NEG_INFINITY.to_le_bytes(),
    ));

    let model = GGUFModel::from_bytes(&data).expect("Should parse special floats");

    if let Some(GGUFValue::Float32(v)) = model.metadata.get("f32_nan") {
        assert!(v.is_nan());
    } else {
        panic!("Expected Float32 NaN");
    }

    if let Some(GGUFValue::Float32(v)) = model.metadata.get("f32_inf") {
        assert!(v.is_infinite() && *v > 0.0);
    }

    if let Some(GGUFValue::Float64(v)) = model.metadata.get("f64_neg_inf") {
        assert!(v.is_infinite() && *v < 0.0);
    }
}

#[test]
fn test_loader_metadata_empty_string() {
    let mut data = build_header(0, 1);
    let empty_str = build_string("");
    data.extend(build_metadata("empty", 8, &empty_str));

    let model = GGUFModel::from_bytes(&data).expect("Should parse empty string");

    if let Some(GGUFValue::String(s)) = model.metadata.get("empty") {
        assert!(s.is_empty());
    } else {
        panic!("Expected empty String");
    }
}

#[test]
fn test_loader_metadata_array_empty() {
    let mut data = build_header(0, 1);

    // Empty array of u32
    let mut array_bytes = Vec::new();
    array_bytes.extend_from_slice(&4u32.to_le_bytes()); // element type: u32
    array_bytes.extend_from_slice(&0u64.to_le_bytes()); // array length: 0

    data.extend(build_metadata("empty_arr", 9, &array_bytes));

    let model = GGUFModel::from_bytes(&data).expect("Should parse empty array");

    if let Some(GGUFValue::Array(arr)) = model.metadata.get("empty_arr") {
        assert!(arr.is_empty());
    } else {
        panic!("Expected empty Array");
    }
}

#[test]
fn test_loader_metadata_array_of_arrays_unsupported() {
    // Nested arrays (array of arrays) - type 9 inside type 9
    // This tests recursive array parsing
    let mut data = build_header(0, 1);

    let mut outer_array = Vec::new();
    outer_array.extend_from_slice(&9u32.to_le_bytes()); // element type: array
    outer_array.extend_from_slice(&1u64.to_le_bytes()); // outer array length: 1

    // Inner array: [1, 2]
    outer_array.extend_from_slice(&4u32.to_le_bytes()); // inner element type: u32
    outer_array.extend_from_slice(&2u64.to_le_bytes()); // inner array length: 2
    outer_array.extend_from_slice(&1u32.to_le_bytes());
    outer_array.extend_from_slice(&2u32.to_le_bytes());

    data.extend(build_metadata("nested", 9, &outer_array));

    let model = GGUFModel::from_bytes(&data).expect("Should parse nested arrays");

    if let Some(GGUFValue::Array(outer)) = model.metadata.get("nested") {
        assert_eq!(outer.len(), 1);
        if let GGUFValue::Array(inner) = &outer[0] {
            assert_eq!(inner.len(), 2);
        } else {
            panic!("Expected inner array");
        }
    } else {
        panic!("Expected outer Array");
    }
}

#[test]
fn test_loader_metadata_type_13_invalid() {
    let mut data = build_header(0, 1);
    // Type 13 doesn't exist in GGUF spec
    data.extend(build_metadata("bad_type", 13, &[0u8; 8]));

    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

#[test]
fn test_loader_metadata_type_max_u32_invalid() {
    let mut data = build_header(0, 1);
    // Type u32::MAX doesn't exist
    data.extend(build_string("bad_type"));
    data.extend_from_slice(&u32::MAX.to_le_bytes());
    data.extend_from_slice(&[0u8; 8]);

    let result = GGUFModel::from_bytes(&data);
    assert!(result.is_err());
}

// =============================================================================
// Tensor Info Parsing - Edge Cases
// =============================================================================

#[test]
fn test_loader_tensor_info_zero_dims() {
    let mut data = build_header(1, 0);
    // Tensor with 0 dimensions (scalar)
    data.extend(build_string("scalar"));
    data.extend_from_slice(&0u32.to_le_bytes()); // n_dims = 0
    data.extend_from_slice(&GGUF_TYPE_F32.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes()); // offset

    let model = GGUFModel::from_bytes(&data).expect("Should parse scalar tensor");
    assert_eq!(model.tensors[0].n_dims, 0);
    assert!(model.tensors[0].dims.is_empty());
}

#[test]
fn test_loader_tensor_info_high_dimensional() {
    let mut data = build_header(1, 0);
    // 6-dimensional tensor
    data.extend(build_string("high_dim"));
    data.extend_from_slice(&6u32.to_le_bytes()); // n_dims = 6
    for _ in 0..6 {
        data.extend_from_slice(&2u64.to_le_bytes()); // Each dim = 2
    }
    data.extend_from_slice(&GGUF_TYPE_F32.to_le_bytes());
    data.extend_from_slice(&0u64.to_le_bytes());

    let model = GGUFModel::from_bytes(&data).expect("Should parse high-dim tensor");
    assert_eq!(model.tensors[0].n_dims, 6);
    assert_eq!(model.tensors[0].dims.len(), 6);
}

#[test]
fn test_loader_tensor_info_dimension_reversal() {
    // GGUF stores dims in GGML order (reversed)
    let mut data = build_header(1, 0);
    data.extend(build_tensor_info("weights", &[256, 512], GGUF_TYPE_F32, 0));

    let model = GGUFModel::from_bytes(&data).expect("Should parse");
    // Dims should match input order after reversal handling
    assert_eq!(model.tensors[0].dims, vec![256, 512]);
}

include!("loader_tests_tensor.rs");