perfgate 0.17.0

Core library for perfgate performance budgets and baseline diffs
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

//! Logic for building budgets and metric statistics for comparisons.

use perfgate_types::{Budget, Metric, MetricStatistic, RunReceipt};
use std::collections::BTreeMap;

/// Build budgets for comparing two receipts.
#[allow(clippy::too_many_arguments)]
pub fn build_budgets(
    baseline: &RunReceipt,
    current: &RunReceipt,
    global_threshold: f64,
    global_warn_factor: f64,
    global_noise_threshold: Option<f64>,
    global_noise_policy: Option<perfgate_types::NoisePolicy>,
    metric_thresholds: Vec<(String, f64)>,
    noise_thresholds: Vec<(String, f64)>,
    direction_overrides: Vec<(String, String)>,
) -> anyhow::Result<BTreeMap<Metric, Budget>> {
    // Determine candidate metrics: those present in both baseline+current.
    let mut candidates = Vec::new();
    candidates.push(Metric::WallMs);
    if baseline.stats.binary_bytes.is_some() && current.stats.binary_bytes.is_some() {
        candidates.push(Metric::BinaryBytes);
    }
    if baseline.stats.cpu_ms.is_some() && current.stats.cpu_ms.is_some() {
        candidates.push(Metric::CpuMs);
    }
    if baseline.stats.ctx_switches.is_some() && current.stats.ctx_switches.is_some() {
        candidates.push(Metric::CtxSwitches);
    }
    if baseline.stats.max_rss_kb.is_some() && current.stats.max_rss_kb.is_some() {
        candidates.push(Metric::MaxRssKb);
    }
    if baseline.stats.page_faults.is_some() && current.stats.page_faults.is_some() {
        candidates.push(Metric::PageFaults);
    }
    if baseline.stats.throughput_per_s.is_some() && current.stats.throughput_per_s.is_some() {
        candidates.push(Metric::ThroughputPerS);
    }

    let mut thresholds: BTreeMap<String, f64> = metric_thresholds.into_iter().collect();
    let mut noise_limits: BTreeMap<String, f64> = noise_thresholds.into_iter().collect();
    let mut dirs: BTreeMap<String, String> = direction_overrides.into_iter().collect();

    let mut budgets = BTreeMap::new();

    for metric in candidates {
        let key = metric.as_str();
        let threshold = thresholds.remove(key).unwrap_or(global_threshold);
        let warn_threshold = threshold * global_warn_factor;
        let noise_threshold = noise_limits.remove(key).or(global_noise_threshold);
        let noise_policy = global_noise_policy.unwrap_or(perfgate_types::NoisePolicy::Warn);

        let dir = match dirs.remove(key).as_deref() {
            Some("lower") => perfgate_types::Direction::Lower,
            Some("higher") => perfgate_types::Direction::Higher,
            Some(other) => {
                anyhow::bail!("invalid direction for {key}: {other} (expected lower|higher)")
            }
            None => metric.default_direction(),
        };

        budgets.insert(
            metric,
            Budget {
                threshold,
                warn_threshold,
                noise_threshold,
                noise_policy,
                direction: dir,
            },
        );
    }

    Ok(budgets)
}

/// Build metric statistics overrides for a comparison.
pub fn build_metric_statistics(
    budgets: &BTreeMap<Metric, Budget>,
    overrides: Vec<(String, String)>,
) -> anyhow::Result<BTreeMap<Metric, MetricStatistic>> {
    let mut statistics = BTreeMap::new();

    for (key, value) in overrides {
        let metric = Metric::parse_key(&key)
            .ok_or_else(|| anyhow::anyhow!("unknown metric for --metric-stat: {}", key))?;
        if !budgets.contains_key(&metric) {
            anyhow::bail!(
                "metric-stat override for {} is not applicable (metric not present in both receipts)",
                key
            );
        }

        let statistic = match value.to_lowercase().as_str() {
            "median" => MetricStatistic::Median,
            "p95" => MetricStatistic::P95,
            _ => {
                anyhow::bail!(
                    "invalid statistic for {}: {} (expected median|p95)",
                    key,
                    value
                )
            }
        };

        statistics.insert(metric, statistic);
    }

    Ok(statistics)
}

/// Map verdict counts to a string verdict.
pub fn verdict_from_counts(pass_count: u32, warn_count: u32, fail_count: u32) -> &'static str {
    if fail_count > 0 {
        "fail"
    } else if warn_count > 0 {
        "warn"
    } else if pass_count > 0 {
        "pass"
    } else {
        "skip"
    }
}