tokmd-gate 1.10.0

Policy evaluation engine for tokmd analysis receipts
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
//! Policy evaluation logic.

use crate::pointer::resolve_pointer;
use crate::types::{GateResult, PolicyConfig, PolicyRule, RuleLevel, RuleOperator, RuleResult};
use serde_json::Value;

/// Evaluate a policy against a JSON receipt.
///
/// # Arguments
/// * `receipt` - The JSON receipt to evaluate
/// * `policy` - The policy configuration with rules
///
/// # Returns
/// A `GateResult` with pass/fail status and individual rule results.
///
/// # Examples
///
/// ```
/// use serde_json::json;
/// use tokmd_gate::{evaluate_policy, PolicyConfig, PolicyRule, RuleOperator, RuleLevel};
///
/// let receipt = json!({"tokens": 500, "files": 10});
/// let policy = PolicyConfig {
///     rules: vec![PolicyRule {
///         name: "max_tokens".into(),
///         pointer: "/tokens".into(),
///         op: RuleOperator::Lte,
///         value: Some(json!(1000)),
///         values: None,
///         negate: false,
///         level: RuleLevel::Error,
///         message: None,
///     }],
///     fail_fast: false,
///     allow_missing: false,
/// };
///
/// let result = evaluate_policy(&receipt, &policy);
/// assert!(result.passed);
/// assert_eq!(result.errors, 0);
/// ```
pub fn evaluate_policy(receipt: &Value, policy: &PolicyConfig) -> GateResult {
    let mut rule_results = Vec::with_capacity(policy.rules.len());

    for rule in &policy.rules {
        let result = evaluate_rule(receipt, rule, policy.allow_missing);
        let failed_error = !result.passed && result.level == RuleLevel::Error;

        rule_results.push(result);

        if policy.fail_fast && failed_error {
            break;
        }
    }

    GateResult::from_results(rule_results)
}

/// Evaluate a single rule against a receipt.
fn evaluate_rule(receipt: &Value, rule: &PolicyRule, allow_missing: bool) -> RuleResult {
    let resolved = resolve_pointer(receipt, &rule.pointer);

    // Handle exists operator specially
    if rule.op == RuleOperator::Exists {
        let exists = resolved.is_some();
        let passed = if rule.negate { !exists } else { exists };
        return RuleResult {
            name: rule.name.clone(),
            passed,
            level: rule.level,
            actual: resolved.cloned(),
            expected: if rule.negate {
                format!("pointer {} to NOT exist", rule.pointer)
            } else {
                format!("pointer {} to exist", rule.pointer)
            },
            message: if passed { None } else { rule.message.clone() },
        };
    }

    // For other operators, we need a value
    let actual = match resolved {
        Some(v) => v,
        None => {
            // Missing value
            if allow_missing {
                return RuleResult {
                    name: rule.name.clone(),
                    passed: true,
                    level: rule.level,
                    actual: None,
                    expected: format!("{} {} {:?}", rule.pointer, rule.op, rule.value),
                    message: None,
                };
            } else {
                return RuleResult {
                    name: rule.name.clone(),
                    passed: false,
                    level: rule.level,
                    actual: None,
                    expected: format!("{} {} {:?}", rule.pointer, rule.op, rule.value),
                    message: Some(format!("Pointer '{}' not found in receipt", rule.pointer)),
                };
            }
        }
    };

    let comparison_result = match rule.op {
        RuleOperator::Gt => compare_numeric(actual, rule.value.as_ref(), |a, b| a > b),
        RuleOperator::Gte => compare_numeric(actual, rule.value.as_ref(), |a, b| a >= b),
        RuleOperator::Lt => compare_numeric(actual, rule.value.as_ref(), |a, b| a < b),
        RuleOperator::Lte => compare_numeric(actual, rule.value.as_ref(), |a, b| a <= b),
        RuleOperator::Eq => compare_equal(actual, rule.value.as_ref()),
        RuleOperator::Ne => compare_equal(actual, rule.value.as_ref()).map(|b| !b),
        RuleOperator::In => compare_in(actual, rule.values.as_ref()),
        RuleOperator::Contains => compare_contains(actual, rule.value.as_ref()),
        RuleOperator::Exists => unreachable!(), // Handled above
    };

    let passed = match &comparison_result {
        Ok(result) => {
            if rule.negate {
                !result
            } else {
                *result
            }
        }
        Err(_) => false,
    };

    let empty_values: Vec<serde_json::Value> = Vec::new();
    let expected = match rule.op {
        RuleOperator::In => format!(
            "{} in {:?}",
            rule.pointer,
            rule.values.as_ref().unwrap_or(&empty_values)
        ),
        _ => format!(
            "{} {} {}",
            rule.pointer,
            rule.op,
            rule.value
                .as_ref()
                .map(|v| v.to_string())
                .unwrap_or_default()
        ),
    };

    let generated_failure_message = comparison_result.err().map(|reason| {
        format!(
            "Rule '{}' failed: {} (pointer='{}', op='{}')",
            rule.name, reason, rule.pointer, rule.op
        )
    });

    RuleResult {
        name: rule.name.clone(),
        passed,
        level: rule.level,
        actual: Some(actual.clone()),
        expected,
        message: if passed {
            None
        } else {
            rule.message.clone().or(generated_failure_message)
        },
    }
}

/// Compare two values numerically.
fn compare_numeric<F>(
    actual: &Value,
    expected: Option<&Value>,
    cmp: F,
) -> Result<bool, &'static str>
where
    F: Fn(f64, f64) -> bool,
{
    let actual_num = value_to_f64(actual).ok_or("actual value is not numeric")?;
    let expected_num = expected
        .and_then(value_to_f64)
        .ok_or("expected value is missing or not numeric")?;
    Ok(cmp(actual_num, expected_num))
}

/// Compare two values for equality.
fn compare_equal(actual: &Value, expected: Option<&Value>) -> Result<bool, &'static str> {
    let expected = expected.ok_or("expected value is missing")?;

    // For strings, compare case-sensitively (before numeric to avoid "inf"/"nan" issues)
    if let (Some(a), Some(b)) = (actual.as_str(), expected.as_str()) {
        return Ok(a == b);
    }

    // For numeric types, compare as f64 to handle int/float mismatches
    if let (Some(a), Some(b)) = (value_to_f64(actual), value_to_f64(expected)) {
        return Ok((a - b).abs() < f64::EPSILON);
    }

    // For other types, use JSON equality
    Ok(actual == expected)
}

/// Check if actual value is in a list of expected values.
fn compare_in(actual: &Value, expected: Option<&Vec<Value>>) -> Result<bool, &'static str> {
    let list = expected.ok_or("expected values list is missing")?;

    for item in list {
        if compare_equal(actual, Some(item)).unwrap_or(false) {
            return Ok(true);
        }
    }

    Ok(false)
}

/// Check if actual contains expected.
fn compare_contains(actual: &Value, expected: Option<&Value>) -> Result<bool, &'static str> {
    let expected = expected.ok_or("expected value is missing")?;

    match actual {
        Value::String(s) => {
            let needle = expected
                .as_str()
                .ok_or("expected value must be a string for string contains checks")?;
            Ok(s.contains(needle))
        }
        Value::Array(arr) => {
            for item in arr {
                if compare_equal(item, Some(expected)).unwrap_or(false) {
                    return Ok(true);
                }
            }
            Ok(false)
        }
        _ => Err("contains is only valid for string or array actual values"),
    }
}

/// Convert a JSON value to f64 for numeric comparison.
fn value_to_f64(v: &Value) -> Option<f64> {
    match v {
        Value::Number(n) => n.as_f64(),
        Value::String(s) => s.parse().ok(),
        _ => None,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    fn make_rule(name: &str, pointer: &str, op: RuleOperator, value: Value) -> PolicyRule {
        PolicyRule {
            name: name.into(),
            pointer: pointer.into(),
            op,
            value: Some(value),
            values: None,
            negate: false,
            level: RuleLevel::Error,
            message: None,
        }
    }

    #[test]
    fn test_numeric_comparisons() {
        let receipt = json!({"tokens": 1000});

        let rule = make_rule("test", "/tokens", RuleOperator::Lt, json!(2000));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = make_rule("test", "/tokens", RuleOperator::Gt, json!(2000));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);

        let rule = make_rule("test", "/tokens", RuleOperator::Lte, json!(1000));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = make_rule("test", "/tokens", RuleOperator::Gte, json!(1000));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);
    }

    #[test]
    fn test_equality() {
        let receipt = json!({"name": "test", "count": 42});

        let rule = make_rule("test", "/name", RuleOperator::Eq, json!("test"));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = make_rule("test", "/count", RuleOperator::Eq, json!(42));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = make_rule("test", "/name", RuleOperator::Ne, json!("other"));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);
    }

    #[test]
    fn test_in_operator() {
        let receipt = json!({"license": "MIT"});

        let rule = PolicyRule {
            name: "license_check".into(),
            pointer: "/license".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("MIT"), json!("Apache-2.0")]),
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = PolicyRule {
            name: "license_check".into(),
            pointer: "/license".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("GPL"), json!("LGPL")]),
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);
    }

    #[test]
    fn test_contains_operator() {
        let receipt = json!({"tags": ["rust", "cli", "tools"]});

        let rule = make_rule("test", "/tags", RuleOperator::Contains, json!("cli"));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = make_rule("test", "/tags", RuleOperator::Contains, json!("python"));
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);
    }

    #[test]
    fn test_exists_operator() {
        let receipt = json!({"license": "MIT"});

        let rule = PolicyRule {
            name: "has_license".into(),
            pointer: "/license".into(),
            op: RuleOperator::Exists,
            value: None,
            values: None,
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);

        let rule = PolicyRule {
            name: "no_secrets".into(),
            pointer: "/secrets".into(),
            op: RuleOperator::Exists,
            value: None,
            values: None,
            negate: true, // should NOT exist
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed);
    }

    #[test]
    fn test_negate() {
        let receipt = json!({"count": 100});

        let rule = PolicyRule {
            name: "not_above_50".into(),
            pointer: "/count".into(),
            op: RuleOperator::Gt,
            value: Some(json!(50)),
            values: None,
            negate: true,
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed); // 100 > 50 is true, negated = false

        let rule = PolicyRule {
            name: "not_above_200".into(),
            pointer: "/count".into(),
            op: RuleOperator::Gt,
            value: Some(json!(200)),
            values: None,
            negate: true,
            level: RuleLevel::Error,
            message: None,
        };
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(result.passed); // 100 > 200 is false, negated = true
    }

    #[test]
    fn test_missing_value() {
        let receipt = json!({"foo": 1});

        let rule = make_rule("test", "/bar", RuleOperator::Eq, json!(1));

        // Without allow_missing - fails
        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);

        // With allow_missing - passes
        let result = evaluate_rule(&receipt, &rule, true);
        assert!(result.passed);
    }

    #[test]
    fn test_full_policy() {
        let receipt = json!({
            "derived": {
                "totals": {"tokens": 100000, "code": 5000}
            },
            "license": {"effective": "MIT"}
        });

        let policy = PolicyConfig {
            rules: vec![
                make_rule(
                    "max_tokens",
                    "/derived/totals/tokens",
                    RuleOperator::Lte,
                    json!(500000),
                ),
                make_rule(
                    "min_code",
                    "/derived/totals/code",
                    RuleOperator::Gte,
                    json!(100),
                ),
            ],
            fail_fast: false,
            allow_missing: false,
        };

        let result = evaluate_policy(&receipt, &policy);
        assert!(result.passed);
        assert_eq!(result.errors, 0);
        assert_eq!(result.warnings, 0);
    }

    #[test]
    fn test_fail_fast() {
        let receipt = json!({"a": 1, "b": 2});

        let policy = PolicyConfig {
            rules: vec![
                make_rule("first", "/a", RuleOperator::Gt, json!(10)), // fails
                make_rule("second", "/b", RuleOperator::Gt, json!(10)), // also fails
            ],
            fail_fast: true,
            allow_missing: false,
        };

        let result = evaluate_policy(&receipt, &policy);
        assert!(!result.passed);
        // Only one rule evaluated due to fail_fast
        assert_eq!(result.rule_results.len(), 1);
    }

    #[test]
    fn test_fail_fast_does_not_stop_on_pass() {
        // If fail_fast is true, we should NOT stop on a passing rule, even if its level is Error.
        // This kills the `failed_error` &&/|| mutants.
        let receipt = json!({"a": 1, "b": 2});

        let policy = PolicyConfig {
            rules: vec![
                make_rule("first_passes", "/a", RuleOperator::Gt, json!(0)), // passes
                make_rule("second_fails", "/b", RuleOperator::Gt, json!(10)), // fails
            ],
            fail_fast: true,
            allow_missing: false,
        };

        let result = evaluate_policy(&receipt, &policy);
        assert!(!result.passed);
        assert_eq!(
            result.rule_results.len(),
            2,
            "fail_fast must not stop after a passing rule"
        );
        assert_eq!(result.errors, 1);
    }

    #[test]
    fn test_no_fail_fast_evaluates_all_rules_even_after_failure() {
        // Kills the `if policy.fail_fast && failed_error` &&/|| mutant.
        let receipt = json!({"a": 1, "b": 2});

        let policy = PolicyConfig {
            rules: vec![
                make_rule("first_fails", "/a", RuleOperator::Gt, json!(10)), // fails
                make_rule("second_passes", "/b", RuleOperator::Gt, json!(0)), // passes
            ],
            fail_fast: false,
            allow_missing: false,
        };

        let result = evaluate_policy(&receipt, &policy);
        assert!(!result.passed);
        assert_eq!(
            result.rule_results.len(),
            2,
            "when fail_fast is false we should evaluate all rules"
        );
        assert_eq!(result.errors, 1);
    }

    #[test]
    fn test_strict_gt_lt_boundaries() {
        // Kills >->>= and <-><= mutants.
        let receipt = json!({"n": 10});

        let gt_equal = make_rule("gt_equal", "/n", RuleOperator::Gt, json!(10));
        assert!(!evaluate_rule(&receipt, &gt_equal, false).passed);

        let lt_equal = make_rule("lt_equal", "/n", RuleOperator::Lt, json!(10));
        assert!(!evaluate_rule(&receipt, &lt_equal, false).passed);
    }

    #[test]
    fn test_numeric_string_coercion() {
        // Kills deletion of Value::String arm in value_to_f64.
        let receipt = json!({"tokens": "1000"});

        let gt = make_rule("gt", "/tokens", RuleOperator::Gt, json!(500));
        assert!(evaluate_rule(&receipt, &gt, false).passed);

        let lt = make_rule("lt", "/tokens", RuleOperator::Lt, json!(1500));
        assert!(evaluate_rule(&receipt, &lt, false).passed);
    }

    #[test]
    fn test_contains_on_string() {
        // Kills deletion of Value::String arm in compare_contains.
        let receipt = json!({"text": "hello world"});
        let rule = make_rule("contains", "/text", RuleOperator::Contains, json!("world"));
        assert!(evaluate_rule(&receipt, &rule, false).passed);
    }

    #[test]
    fn test_equality_on_non_scalar_values() {
        // Kills mutation of the JSON equality fallback.
        let receipt = json!({"arr": [1, 2, 3]});
        let rule = make_rule("eq_arr", "/arr", RuleOperator::Eq, json!([1, 2, 3]));
        assert!(evaluate_rule(&receipt, &rule, false).passed);
    }

    #[test]
    fn test_numeric_epsilon_boundary_is_strict() {
        // Kills < -> <= mutant in numeric equality (abs(a-b) < EPSILON).
        let a = 1.0_f64;
        let b = a + f64::EPSILON;
        let receipt = json!({"x": a});
        let rule = make_rule("eq_eps", "/x", RuleOperator::Eq, json!(b));
        assert!(
            !evaluate_rule(&receipt, &rule, false).passed,
            "difference of exactly EPSILON must not be treated as equal"
        );
    }

    #[test]
    fn test_in_operator_membership() {
        // Additional test to ensure In arm deletion mutant is killed.
        let receipt = json!({"lang": "Rust"});

        let rule = PolicyRule {
            name: "lang_in".into(),
            pointer: "/lang".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("Rust"), json!("Go")]),
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };

        assert!(evaluate_rule(&receipt, &rule, false).passed);
    }

    #[test]
    fn test_in_operator_non_member() {
        // Kills In arm mutant by asserting non-membership fails.
        let receipt = json!({"lang": "Rust"});

        let rule = PolicyRule {
            name: "lang_not_in".into(),
            pointer: "/lang".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("Python"), json!("Go")]),
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };

        assert!(!evaluate_rule(&receipt, &rule, false).passed);
    }

    #[test]
    fn test_in_operator_with_negate() {
        // Test In with negate to ensure proper behavior when inverted.
        let receipt = json!({"lang": "Rust"});

        // Rust IS in the list, but negated → should fail
        let rule = PolicyRule {
            name: "lang_not_in_negate".into(),
            pointer: "/lang".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("Rust"), json!("Go")]),
            negate: true,
            level: RuleLevel::Error,
            message: None,
        };

        assert!(!evaluate_rule(&receipt, &rule, false).passed);
    }

    #[test]
    fn test_in_operator_expected_format() {
        // Kills the "delete match arm RuleOperator::In" mutant in the expected string formatting.
        // The In operator must produce an expected string like "/pointer in [values]",
        // not the generic "/pointer in " format from the wildcard arm.
        let receipt = json!({"lang": "Rust"});

        let rule = PolicyRule {
            name: "lang_in".into(),
            pointer: "/lang".into(),
            op: RuleOperator::In,
            value: None,
            values: Some(vec![json!("Python"), json!("Go")]),
            negate: false,
            level: RuleLevel::Error,
            message: None,
        };

        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);
        // The expected string must contain the values list, proving the In arm was used.
        // If the In arm is deleted, expected would be "/lang in " (empty/missing values).
        assert!(
            result.expected.contains("Python") && result.expected.contains("Go"),
            "expected string should contain the list values: got '{}'",
            result.expected
        );
    }

    #[test]
    fn test_comparison_type_error_generates_default_message() {
        let receipt = json!({"count": "not-a-number"});
        let rule = make_rule("numeric_check", "/count", RuleOperator::Lte, json!(10));

        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);
        let message = result.message.unwrap_or_default();
        assert!(
            message.contains("actual value is not numeric"),
            "expected diagnostic message, got: {message}"
        );
    }

    #[test]
    fn test_custom_message_overrides_generated_failure_message() {
        let receipt = json!({"count": "not-a-number"});
        let rule = PolicyRule {
            name: "numeric_check".into(),
            pointer: "/count".into(),
            op: RuleOperator::Lte,
            value: Some(json!(10)),
            values: None,
            negate: false,
            level: RuleLevel::Error,
            message: Some("Custom policy message".into()),
        };

        let result = evaluate_rule(&receipt, &rule, false);
        assert!(!result.passed);
        assert_eq!(result.message.as_deref(), Some("Custom policy message"));
    }
}