parlov-analysis 0.7.0

Analysis engine trait and signal detection for parlov.
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
//! Classifiers for burst and header-diff existence oracle probe variants.

use http::HeaderMap;
use parlov_core::{OracleResult, OracleVerdict, Severity, SignalKind, StrategyOutcome, Technique};

use crate::aggregation::modifiers::ModifierResult;
use crate::signals::header::rate_limit_diff;

/// Classifies a burst probe outcome.
///
/// - `Positive`: baseline was rate-limited, probe was not (expected direction).
/// - `Contradictory`: probe was rate-limited, baseline was not (inverted — contradicts existence).
/// - `NoSignal`: neither side triggered, or both triggered.
///
/// `modifiers` gates the inverted-signal weight on the Contradictory path. When
/// `modifiers.is_blocked()` is true, the would-be Contradictory becomes `Inapplicable` with the
/// structured `block_reason`.
#[must_use]
pub fn burst_result(
    baseline_429: usize,
    probe_429: usize,
    technique: &Technique,
    modifiers: ModifierResult,
) -> StrategyOutcome {
    let evidence = format!("baseline 429 count: {baseline_429}, probe 429 count: {probe_429}");
    if baseline_429 > 0 && probe_429 == 0 {
        let result = OracleResult::from_technique(
            OracleVerdict::Confirmed,
            Some(Severity::Medium),
            evidence,
            SignalKind::StatusCodeDiff,
            80,
            technique,
        );
        StrategyOutcome::Positive(result)
    } else if probe_429 > 0 && baseline_429 == 0 {
        let result = OracleResult::from_technique(
            OracleVerdict::NotPresent,
            None,
            evidence,
            SignalKind::StatusCodeDiff,
            0,
            technique,
        );
        contradictory_with_modifiers(result, technique.inverted_signal_weight, modifiers)
    } else {
        let result = OracleResult::from_technique(
            OracleVerdict::NotPresent,
            None,
            evidence,
            SignalKind::StatusCodeDiff,
            0,
            technique,
        );
        StrategyOutcome::NoSignal(result)
    }
}

/// Classifies a header-diff probe outcome.
///
/// - `Positive`: rate-limit headers present in baseline only (expected direction).
/// - `Contradictory`: rate-limit headers present in probe only (inverted — server rate-limits the
///   probe path, which contradicts existence).
/// - `NoSignal`: no differential, or headers on both sides.
///
/// `modifiers` gates the inverted-signal weight on the Contradictory path identically to
/// [`burst_result`].
#[must_use]
pub fn header_diff_result(
    baseline: &HeaderMap,
    probe: &HeaderMap,
    technique: &Technique,
    modifiers: ModifierResult,
) -> StrategyOutcome {
    let baseline_only = rate_limit_diff(baseline, probe);
    let probe_only = rate_limit_diff(probe, baseline);

    if !baseline_only.is_empty() {
        let evidence = format!(
            "rate-limit headers in baseline only: {}",
            baseline_only.join(", ")
        );
        let result = OracleResult::from_technique(
            OracleVerdict::Confirmed,
            Some(Severity::Low),
            evidence,
            SignalKind::HeaderPresence,
            80,
            technique,
        );
        StrategyOutcome::Positive(result)
    } else if !probe_only.is_empty() {
        let evidence = format!(
            "rate-limit headers in probe only: {}",
            probe_only.join(", ")
        );
        let result = OracleResult::from_technique(
            OracleVerdict::NotPresent,
            None,
            evidence,
            SignalKind::HeaderPresence,
            0,
            technique,
        );
        contradictory_with_modifiers(result, technique.inverted_signal_weight, modifiers)
    } else {
        let result = OracleResult::from_technique(
            OracleVerdict::NotPresent,
            None,
            "no rate-limit header differential".to_owned(),
            SignalKind::HeaderPresence,
            0,
            technique,
        );
        StrategyOutcome::NoSignal(result)
    }
}

/// Applies `modifiers` to the inverted-signal weight, returning `Inapplicable` when blocked.
///
/// `inverted_signal_weight: None` is treated as `0.0` to preserve current behavior — the
/// resulting `Contradictory` carries zero weight and contributes nothing to the reducer.
fn contradictory_with_modifiers(
    result: OracleResult,
    inverted_signal_weight: Option<f32>,
    modifiers: ModifierResult,
) -> StrategyOutcome {
    if modifiers.is_blocked() {
        let reason = modifiers
            .block_reason
            .map_or("modifier blocked", |r| r.as_str());
        return StrategyOutcome::Inapplicable(std::borrow::Cow::Borrowed(reason));
    }
    let base = inverted_signal_weight.unwrap_or(0.0);
    #[allow(clippy::cast_possible_truncation)]
    let effective = base * modifiers.modifiers.total() as f32;
    StrategyOutcome::Contradictory(result, effective)
}

#[cfg(test)]
mod tests {
    use super::*;
    use http::{HeaderMap, HeaderName, HeaderValue};
    use parlov_core::{
        always_applicable, NormativeStrength, OracleClass, OracleVerdict, SignalKind,
        SignalSurface, Vector,
    };
    use proptest::prelude::*;

    fn test_technique() -> Technique {
        Technique {
            id: "rate-limit-burst",
            name: "Rate Limit Burst",
            oracle_class: OracleClass::Existence,
            vector: Vector::StatusCodeDiff,
            strength: NormativeStrength::May,
            normalization_weight: Some(0.2),
            inverted_signal_weight: Some(0.2),
            method_relevant: false,
            parser_relevant: false,
            applicability: always_applicable,
            contradiction_surface: SignalSurface::Status,
        }
    }

    /// All-1.0 default — used by every existing classifier test that doesn't exercise gating.
    fn no_gating() -> ModifierResult {
        ModifierResult {
            modifiers: crate::aggregation::EvidenceModifiers::default(),
            block_reason: None,
        }
    }

    fn make_header_map(pairs: &[(&str, &str)]) -> HeaderMap {
        let mut map = HeaderMap::new();
        for &(name, value) in pairs {
            map.insert(
                HeaderName::from_bytes(name.as_bytes()).expect("valid header name"),
                HeaderValue::from_str(value).expect("valid header value"),
            );
        }
        map
    }

    fn inner_result(outcome: &StrategyOutcome) -> &OracleResult {
        match outcome {
            StrategyOutcome::Positive(r)
            | StrategyOutcome::NoSignal(r)
            | StrategyOutcome::Contradictory(r, _) => r,
            StrategyOutcome::Inapplicable(_) => panic!("unexpected Inapplicable"),
        }
    }

    // --- burst_result unit tests ---

    #[test]
    fn burst_baseline_429_probe_zero_is_positive() {
        let t = test_technique();
        let outcome = burst_result(1, 0, &t, no_gating());
        let StrategyOutcome::Positive(r) = &outcome else {
            panic!("expected Positive, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::Confirmed);
        assert_eq!(r.severity, Some(Severity::Medium));
        assert_eq!(r.confidence, 80);
        assert_eq!(r.signals[0].kind, SignalKind::StatusCodeDiff);
    }

    #[test]
    fn burst_both_zero_is_no_signal() {
        let t = test_technique();
        let outcome = burst_result(0, 0, &t, no_gating());
        let StrategyOutcome::NoSignal(r) = &outcome else {
            panic!("expected NoSignal, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::NotPresent);
        assert_eq!(r.severity, None);
        assert_eq!(r.confidence, 0);
    }

    #[test]
    fn burst_both_nonzero_is_no_signal() {
        let t = test_technique();
        let outcome = burst_result(2, 3, &t, no_gating());
        assert!(matches!(outcome, StrategyOutcome::NoSignal(_)));
    }

    #[test]
    fn burst_probe_429_baseline_zero_is_contradictory() {
        let t = test_technique();
        let outcome = burst_result(0, 1, &t, no_gating());
        let StrategyOutcome::Contradictory(r, w) = &outcome else {
            panic!("expected Contradictory, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::NotPresent);
        assert_eq!(r.severity, None);
        assert!(
            (w - t.inverted_signal_weight.unwrap_or(0.0)).abs() < f32::EPSILON,
            "weight must equal technique inverted_signal_weight"
        );
    }

    #[test]
    fn burst_multiple_baseline_429_is_positive() {
        let t = test_technique();
        let outcome = burst_result(3, 0, &t, no_gating());
        let StrategyOutcome::Positive(r) = &outcome else {
            panic!("expected Positive");
        };
        assert_eq!(r.severity, Some(Severity::Medium));
    }

    #[test]
    fn burst_evidence_contains_both_counts() {
        let t = test_technique();
        let outcome = burst_result(2, 0, &t, no_gating());
        let evidence = &inner_result(&outcome).signals[0].evidence;
        assert!(
            evidence.contains('2'),
            "evidence must contain baseline count"
        );
        assert!(evidence.contains('0'), "evidence must contain probe count");
    }

    #[test]
    fn burst_contradictory_evidence_contains_both_counts() {
        let t = test_technique();
        let outcome = burst_result(0, 5, &t, no_gating());
        let evidence = &inner_result(&outcome).signals[0].evidence;
        assert!(
            evidence.contains('0'),
            "evidence must contain baseline count"
        );
        assert!(evidence.contains('5'), "evidence must contain probe count");
    }

    // --- header_diff_result unit tests ---

    #[test]
    fn header_diff_baseline_only_is_positive() {
        let t = test_technique();
        let baseline = make_header_map(&[("ratelimit-remaining", "99")]);
        let probe = HeaderMap::new();
        let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
        let StrategyOutcome::Positive(r) = &outcome else {
            panic!("expected Positive, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::Confirmed);
        assert_eq!(r.severity, Some(Severity::Low));
        assert_eq!(r.confidence, 80);
        assert_eq!(r.signals[0].kind, SignalKind::HeaderPresence);
    }

    #[test]
    fn header_diff_no_headers_is_no_signal() {
        let t = test_technique();
        let outcome = header_diff_result(&HeaderMap::new(), &HeaderMap::new(), &t, no_gating());
        let StrategyOutcome::NoSignal(r) = &outcome else {
            panic!("expected NoSignal, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::NotPresent);
        assert_eq!(r.severity, None);
        assert_eq!(r.confidence, 0);
    }

    #[test]
    fn header_diff_headers_in_both_is_no_signal() {
        let t = test_technique();
        let baseline = make_header_map(&[("ratelimit-remaining", "99")]);
        let probe = make_header_map(&[("ratelimit-remaining", "99")]);
        let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
        assert!(matches!(outcome, StrategyOutcome::NoSignal(_)));
    }

    #[test]
    fn header_diff_probe_only_is_contradictory() {
        let t = test_technique();
        let baseline = HeaderMap::new();
        let probe = make_header_map(&[("ratelimit-remaining", "99")]);
        let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
        let StrategyOutcome::Contradictory(r, w) = &outcome else {
            panic!("expected Contradictory, got {outcome:?}");
        };
        assert_eq!(r.verdict, OracleVerdict::NotPresent);
        assert!(
            (w - t.inverted_signal_weight.unwrap_or(0.0)).abs() < f32::EPSILON,
            "weight must equal technique inverted_signal_weight"
        );
    }

    #[test]
    fn header_diff_positive_evidence_contains_header_name() {
        let t = test_technique();
        let baseline = make_header_map(&[("ratelimit-remaining", "99")]);
        let probe = HeaderMap::new();
        let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
        assert!(inner_result(&outcome).signals[0]
            .evidence
            .contains("ratelimit-remaining"));
    }

    #[test]
    fn header_diff_contradictory_evidence_contains_header_name() {
        let t = test_technique();
        let baseline = HeaderMap::new();
        let probe = make_header_map(&[("ratelimit-remaining", "5")]);
        let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
        assert!(inner_result(&outcome).signals[0]
            .evidence
            .contains("ratelimit-remaining"));
    }

    #[test]
    fn header_diff_no_signal_evidence_is_canonical_string() {
        let t = test_technique();
        let outcome = header_diff_result(&HeaderMap::new(), &HeaderMap::new(), &t, no_gating());
        assert_eq!(
            inner_result(&outcome).signals[0].evidence,
            "no rate-limit header differential"
        );
    }

    // --- proptest: burst_result ---

    proptest! {
        #[test]
        fn burst_positive_when_baseline_nonzero_probe_zero(
            baseline in 1usize..=100,
        ) {
            let t = test_technique();
            let outcome = burst_result(baseline, 0, &t, no_gating());
            prop_assert!(matches!(outcome, StrategyOutcome::Positive(_)));
        }

        #[test]
        fn burst_contradictory_when_probe_nonzero_baseline_zero(
            probe in 1usize..=100,
        ) {
            let t = test_technique();
            let outcome = burst_result(0, probe, &t, no_gating());
            let StrategyOutcome::Contradictory(_, w) = outcome else {
                return Err(proptest::test_runner::TestCaseError::fail(
                    "expected Contradictory"
                ));
            };
            let expected = t.inverted_signal_weight.unwrap_or(0.0);
            prop_assert!((w - expected).abs() < f32::EPSILON);
        }

        #[test]
        fn burst_no_signal_when_both_zero_or_both_nonzero(
            baseline in 0usize..=50,
            probe in 0usize..=50,
        ) {
            prop_assume!(!(baseline > 0 && probe == 0));
            prop_assume!(!(baseline == 0 && probe > 0));
            let t = test_technique();
            let outcome = burst_result(baseline, probe, &t, no_gating());
            prop_assert!(matches!(outcome, StrategyOutcome::NoSignal(_)));
        }
    }

    // --- proptest: header_diff_result ---

    proptest! {
        #[test]
        fn header_diff_never_inapplicable(b_has_header: bool, p_has_header: bool) {
            let t = test_technique();
            let baseline = if b_has_header {
                make_header_map(&[("ratelimit-remaining", "10")])
            } else {
                HeaderMap::new()
            };
            let probe = if p_has_header {
                make_header_map(&[("ratelimit-remaining", "10")])
            } else {
                HeaderMap::new()
            };
            let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
            prop_assert!(!matches!(outcome, StrategyOutcome::Inapplicable(_)));
        }

        #[test]
        fn header_diff_contradictory_weight_matches_technique(
            inverted_signal_weight in 0.1f32..=1.0f32,
        ) {
            let t = Technique {
                id: "rate-limit-burst",
                name: "Rate Limit Burst",
                oracle_class: OracleClass::Existence,
                vector: Vector::StatusCodeDiff,
                strength: NormativeStrength::May,
                normalization_weight: Some(inverted_signal_weight),
                inverted_signal_weight: Some(inverted_signal_weight),
                method_relevant: false,
                parser_relevant: false,
                applicability: always_applicable,
                contradiction_surface: SignalSurface::Status,
            };
            let baseline = HeaderMap::new();
            let probe = make_header_map(&[("ratelimit-remaining", "5")]);
            let outcome = header_diff_result(&baseline, &probe, &t, no_gating());
            let StrategyOutcome::Contradictory(_, w) = outcome else {
                return Err(proptest::test_runner::TestCaseError::fail(
                    "expected Contradictory when probe has rate-limit headers and baseline does not",
                ));
            };
            let expected = t.inverted_signal_weight.unwrap_or(0.0);
            prop_assert!(
                (w - expected).abs() < f32::EPSILON,
                "weight {w} must equal technique inverted_signal_weight {expected}"
            );
        }
    }
}