borrowscope-runtime 0.1.2

Runtime tracking system for BorrowScope
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
use borrowscope_runtime::*;
use quickcheck::{Arbitrary, Gen, QuickCheck, TestResult};
use quickcheck_macros::quickcheck;
use serial_test::serial;

// ============================================================================
// Custom Arbitrary Types
// ============================================================================

#[derive(Clone, Debug)]
struct TrackingOperation {
    op_type: OperationType,
    var_name: String,
    value: i32,
}

#[derive(Clone, Debug)]
enum OperationType {
    New,
    Borrow,
    Move,
    Drop,
}

impl Arbitrary for OperationType {
    fn arbitrary(g: &mut Gen) -> Self {
        match u8::arbitrary(g) % 4 {
            0 => OperationType::New,
            1 => OperationType::Borrow,
            2 => OperationType::Move,
            _ => OperationType::Drop,
        }
    }
}

impl Arbitrary for TrackingOperation {
    fn arbitrary(g: &mut Gen) -> Self {
        TrackingOperation {
            op_type: OperationType::arbitrary(g),
            var_name: format!("var_{}", usize::arbitrary(g) % 100),
            value: i32::arbitrary(g),
        }
    }
}

// ============================================================================
// QuickCheck Tests
// ============================================================================

#[quickcheck]
#[serial]
fn qc_track_new_identity(value: i32) -> bool {
    reset();
    let result = track_new("x", value);
    result == value
}

#[quickcheck]
#[serial]
fn qc_track_new_string_identity(s: String) -> bool {
    reset();
    let result = track_new("s", s.clone());
    result == s
}

#[quickcheck]
#[serial]
fn qc_borrow_preserves_value(value: i32) -> bool {
    reset();
    let x = track_new("x", value);
    let r = track_borrow("r", &x);
    *r == value
}

#[quickcheck]
#[serial]
fn qc_move_preserves_value(value: i32) -> bool {
    reset();
    let x = track_new("x", value);
    let y = track_move("x", "y", x);
    y == value
}

#[quickcheck]
#[serial]
fn qc_event_count_matches_operations(values: Vec<i32>) -> TestResult {
    if values.is_empty() || values.len() > 100 {
        return TestResult::discard();
    }

    reset();

    for (i, &value) in values.iter().enumerate() {
        track_new(&format!("var_{}", i), value);
    }

    let events = get_events();
    TestResult::from_bool(events.len() == values.len())
}

#[quickcheck]
#[serial]
fn qc_timestamps_monotonic(count: usize) -> TestResult {
    if count == 0 || count > 100 {
        return TestResult::discard();
    }

    reset();

    for i in 0..count {
        track_new(&format!("var_{}", i), i as i32);
    }

    let events = get_events();
    let timestamps: Vec<_> = events.iter().map(|e| e.timestamp()).collect();

    for i in 1..timestamps.len() {
        if timestamps[i] < timestamps[i - 1] {
            return TestResult::failed();
        }
    }

    TestResult::passed()
}

#[quickcheck]
#[serial]
fn qc_rc_strong_count_tracked(clone_count: usize) -> TestResult {
    if clone_count == 0 || clone_count > 20 {
        return TestResult::discard();
    }

    reset();

    let rc = std::rc::Rc::new(42);
    let mut tracked = track_rc_new("rc_0", rc);

    for i in 1..=clone_count {
        let cloned = std::rc::Rc::clone(&tracked);
        tracked = track_rc_clone(&format!("rc_{}", i), &format!("rc_{}", i - 1), cloned);
    }

    let events = get_events();
    let rc_events = events
        .iter()
        .filter(|e| matches!(e, Event::RcNew { .. } | Event::RcClone { .. }))
        .count();

    TestResult::from_bool(rc_events == clone_count + 1)
}

#[quickcheck]
#[serial]
fn qc_arc_thread_safe(value: i32) -> bool {
    reset();

    let arc = std::sync::Arc::new(value);
    let tracked = track_arc_new("arc", arc);

    let arc_clone = std::sync::Arc::clone(&tracked);
    let handle = std::thread::spawn(move || *arc_clone);

    let result = handle.join().unwrap();
    result == value
}

#[quickcheck]
#[serial]
fn qc_refcell_borrow_mut_exclusive(value: i32, new_value: i32) -> bool {
    reset();

    let cell = std::cell::RefCell::new(value);
    let tracked = track_refcell_new("cell", cell);

    {
        let borrowed = tracked.borrow_mut();
        let mut tracked_borrow = track_refcell_borrow_mut("borrow", "cell", "test", borrowed);
        *tracked_borrow = new_value;
    }

    let result = *tracked.borrow();
    result == new_value
}

#[quickcheck]
#[serial]
fn qc_cell_get_set_roundtrip(value: i32) -> bool {
    reset();

    let cell = std::cell::Cell::new(0);
    let tracked = track_cell_new("cell", cell);

    tracked.set(value);
    let result = track_cell_get("cell", "test", tracked.get());

    result == value
}

#[quickcheck]
#[serial]
fn qc_batch_drop_equivalent(count: usize) -> TestResult {
    if count == 0 || count > 50 {
        return TestResult::discard();
    }

    // Batch
    reset();
    let names: Vec<String> = (0..count).map(|i| format!("var_{}", i)).collect();
    let name_refs: Vec<&str> = names.iter().map(|s| s.as_str()).collect();
    track_drop_batch(&name_refs);
    let batch_count = get_events().len();

    // Individual
    reset();
    for name in &names {
        track_drop(name);
    }
    let individual_count = get_events().len();

    TestResult::from_bool(batch_count == individual_count)
}

#[quickcheck]
#[serial]
fn qc_graph_node_count(var_count: usize) -> TestResult {
    if var_count == 0 || var_count > 50 {
        return TestResult::discard();
    }

    reset();

    for i in 0..var_count {
        track_new(&format!("var_{}", i), i as i32);
    }

    let events = get_events();
    let graph = build_graph(&events);

    TestResult::from_bool(graph.nodes.len() == var_count)
}

#[quickcheck]
#[serial]
fn qc_json_export_parseable(var_count: usize) -> TestResult {
    if var_count == 0 || var_count > 20 {
        return TestResult::discard();
    }

    reset();

    for i in 0..var_count {
        track_new(&format!("var_{}", i), i as i32);
    }

    let events = get_events();
    let graph = build_graph(&events);
    let export = ExportData::new(graph, events);

    match export.to_json() {
        Ok(json) => {
            let parse_result: std::result::Result<serde_json::Value, _> =
                serde_json::from_str(&json);
            TestResult::from_bool(parse_result.is_ok())
        }
        Err(_) => TestResult::failed(),
    }
}

#[quickcheck]
#[serial]
fn qc_reset_clears_state(op_count: usize) -> TestResult {
    if op_count == 0 || op_count > 100 {
        return TestResult::discard();
    }

    reset();

    for i in 0..op_count {
        track_new(&format!("var_{}", i), i as i32);
    }

    reset();
    let events = get_events();

    TestResult::from_bool(events.is_empty())
}

#[quickcheck]
#[serial]
fn qc_static_init_preserves_value(value: i32) -> bool {
    reset();
    let result = track_static_init("STATIC", 1, "i32", false, value);
    result == value
}

#[quickcheck]
#[serial]
fn qc_const_eval_preserves_value(value: i32) -> bool {
    reset();
    let result = track_const_eval("CONST", 1, "i32", "test", value);
    result == value
}

#[quickcheck]
#[serial]
fn qc_unsafe_block_pairs(block_count: usize) -> TestResult {
    if block_count == 0 || block_count > 20 {
        return TestResult::discard();
    }

    reset();

    for i in 0..block_count {
        track_unsafe_block_enter(i, "test");
        track_unsafe_block_exit(i, "test");
    }

    let events = get_events();
    let enter_count = events
        .iter()
        .filter(|e| matches!(e, Event::UnsafeBlockEnter { .. }))
        .count();
    let exit_count = events
        .iter()
        .filter(|e| matches!(e, Event::UnsafeBlockExit { .. }))
        .count();

    TestResult::from_bool(enter_count == block_count && exit_count == block_count)
}

#[quickcheck]
#[serial]
fn qc_raw_ptr_preserves_address(value: i32) -> bool {
    reset();

    let x = value;
    let ptr = &x as *const i32;
    let tracked = track_raw_ptr("ptr", 1, "i32", "test", ptr);

    tracked == ptr
}

#[quickcheck]
#[serial]
fn qc_variable_name_preserved(name: String) -> TestResult {
    if name.is_empty() || name.len() > 100 {
        return TestResult::discard();
    }

    reset();
    track_new(&name, 42);

    let events = get_events();
    if events.len() != 1 {
        return TestResult::failed();
    }

    match &events[0] {
        Event::New { var_id, .. } => TestResult::from_bool(var_id.contains(&name)),
        _ => TestResult::failed(),
    }
}

#[quickcheck]
#[serial]
fn qc_concurrent_operations_safe(thread_count: usize, ops_per_thread: usize) -> TestResult {
    if thread_count == 0 || thread_count > 8 || ops_per_thread == 0 || ops_per_thread > 50 {
        return TestResult::discard();
    }

    reset();

    let handles: Vec<_> = (0..thread_count)
        .map(|tid| {
            std::thread::spawn(move || {
                for i in 0..ops_per_thread {
                    track_new(&format!("t{}_v{}", tid, i), i as i32);
                }
            })
        })
        .collect();

    for handle in handles {
        if handle.join().is_err() {
            return TestResult::failed();
        }
    }

    let events = get_events();
    let expected_min = thread_count * ops_per_thread * 8 / 10; // Allow 20% loss

    TestResult::from_bool(events.len() >= expected_min)
}

#[quickcheck]
#[serial]
fn qc_memory_linear_scaling(size: usize, multiplier: usize) -> TestResult {
    if !(10..=100).contains(&size) || !(2..=5).contains(&multiplier) {
        return TestResult::discard();
    }

    // First measurement
    reset();
    for i in 0..size {
        track_new(&format!("var_{}", i), i as i32);
    }
    let events1 = get_events();
    let mem1 = events1.len() * std::mem::size_of::<Event>();

    // Second measurement
    reset();
    let size2 = size * multiplier;
    for i in 0..size2 {
        track_new(&format!("var_{}", i), i as i32);
    }
    let events2 = get_events();
    let mem2 = events2.len() * std::mem::size_of::<Event>();

    let ratio = mem2 as f64 / mem1 as f64;
    let expected_ratio = multiplier as f64;

    // Allow 20% variance
    TestResult::from_bool(ratio > expected_ratio * 0.8 && ratio < expected_ratio * 1.2)
}

// ============================================================================
// Stateful Testing
// ============================================================================

#[test]
#[serial]
fn qc_stateful_operations() {
    fn run_operations(ops: Vec<TrackingOperation>) -> bool {
        reset();
        let ops_len = ops.len();
        let mut tracked_count = 0;

        for op in ops {
            match op.op_type {
                OperationType::New => {
                    track_new(&op.var_name, op.value);
                    tracked_count += 1;
                }
                OperationType::Borrow => {
                    // Skip if no variables exist
                    if get_events().is_empty() {
                        continue;
                    }
                }
                OperationType::Move => {
                    // Skip for now
                }
                OperationType::Drop => {
                    track_drop(&op.var_name);
                    tracked_count += 1;
                }
            }
        }

        // Should not panic
        let events = get_events();
        // Events should match tracked operations
        assert!(events.len() >= tracked_count || ops_len == 0);
        true
    }

    QuickCheck::new()
        .tests(100)
        .quickcheck(run_operations as fn(Vec<TrackingOperation>) -> bool);
}