rlt 0.5.0

A universal load testing library for Rust, with real-time TUI support
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
//! Baseline comparison logic.

use chrono::{DateTime, Utc};
use serde::Serialize;

use crate::{report::BenchReport, util::rate};

use super::Baseline;

/// Metrics that can be used for regression detection.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, clap::ValueEnum, strum::Display)]
#[strum(serialize_all = "kebab-case")]
#[serde(rename_all = "kebab-case")]
pub enum RegressionMetric {
    /// Iterations per second.
    ItersRate,
    /// Items per second.
    ItemsRate,
    /// Bytes per second.
    BytesRate,
    /// Mean latency.
    LatencyMean,
    /// Median latency (p50).
    LatencyMedian,
    /// 90th percentile latency.
    LatencyP90,
    /// 99th percentile latency.
    LatencyP99,
    /// Maximum latency.
    LatencyMax,
    /// Success ratio.
    SuccessRatio,
}

impl RegressionMetric {
    /// Returns the display name for this metric in comparison tables.
    pub fn display_name(&self) -> &'static str {
        match self {
            Self::ItersRate => "Iters/s",
            Self::ItemsRate => "Items/s",
            Self::BytesRate => "Bytes/s",
            Self::SuccessRatio => "Success",
            Self::LatencyMean => "Avg",
            Self::LatencyMedian => "Med",
            Self::LatencyP90 => "p90",
            Self::LatencyP99 => "p99",
            Self::LatencyMax => "Max",
        }
    }
}

/// Status of a metric comparison.
#[derive(Debug, Clone, Copy, Serialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum DeltaStatus {
    /// Performance improved.
    Improved,
    /// Performance regressed.
    Regressed,
    /// Within noise threshold (no significant change).
    Unchanged,
}

/// Comparison result for a single metric.
#[derive(Debug, Clone, Serialize)]
pub struct Delta {
    /// Current value.
    pub current: f64,
    /// Baseline value.
    pub baseline: f64,
    /// Ratio of current to baseline (current / baseline).
    /// None if baseline is 0 and current is non-zero (infinite ratio).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ratio: Option<f64>,
    /// The delta percentage: (current - baseline) / baseline * 100.
    /// None if baseline is 0 (cannot compute percentage).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delta: Option<f64>,
    /// Comparison status.
    pub status: DeltaStatus,
}

/// Latency comparison results.
#[derive(Debug, Clone, Serialize)]
pub struct LatencyDeltas {
    /// Mean latency comparison.
    pub mean: Delta,
    /// Median latency comparison.
    pub median: Delta,
    /// 90th percentile latency comparison (if available in baseline).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub p90: Option<Delta>,
    /// 99th percentile latency comparison (if available in baseline).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub p99: Option<Delta>,
    /// Maximum latency comparison.
    pub max: Delta,
}

/// Throughput comparison results.
#[derive(Debug, Clone, Serialize)]
pub struct ThroughputDeltas {
    /// Iterations per second comparison.
    pub iters_rate: Delta,
    /// Items per second comparison (optional).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub items_rate: Option<Delta>,
    /// Bytes per second comparison (optional).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bytes_rate: Option<Delta>,
}

/// Overall verdict of the comparison.
#[derive(Debug, Clone, Copy, Serialize, PartialEq, Eq, strum::Display)]
#[serde(rename_all = "lowercase")]
#[strum(serialize_all = "lowercase")]
pub enum Verdict {
    /// All regression metrics improved or unchanged, at least one improved.
    Improved,
    /// All regression metrics regressed or unchanged, at least one regressed.
    Regressed,
    /// All regression metrics unchanged.
    Unchanged,
    /// Some metrics improved, some regressed (treated as regression for --fail-on-regression).
    Mixed,
}

/// Overall comparison result.
#[derive(Debug, Clone, Serialize)]
pub struct Comparison {
    /// Name of the baseline.
    pub baseline_name: String,
    /// When the baseline was created.
    pub baseline_created_at: DateTime<Utc>,
    /// Schema version of the baseline.
    pub schema_version: u32,
    /// Noise threshold used for comparison.
    pub noise_threshold: f64,
    /// Metrics considered for verdict calculation.
    pub regression_metrics: Vec<RegressionMetric>,
    /// Metrics that were skipped (unavailable for comparison).
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub skipped_metrics: Vec<RegressionMetric>,
    /// Overall verdict.
    pub verdict: Verdict,
    /// Throughput comparisons.
    pub throughput: ThroughputDeltas,
    /// Latency comparisons (if available).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub latency: Option<LatencyDeltas>,
    /// Success ratio comparison.
    pub success_ratio: Delta,
}

/// Compare a benchmark report against a baseline.
pub fn compare(
    report: &BenchReport,
    baseline: &Baseline,
    noise_threshold: f64,
    regression_metrics: &[RegressionMetric],
) -> Comparison {
    let elapsed = report.elapsed.as_secs_f64();
    let counter = &report.stats.counter;
    let baseline_summary = &baseline.report.summary;

    // Calculate throughput deltas
    let throughput = ThroughputDeltas {
        iters_rate: calculate_throughput_delta(
            rate(counter.iters, elapsed),
            baseline_summary.iters.rate,
            noise_threshold,
        ),
        items_rate: if counter.items > 0 || baseline_summary.items.total > 0 {
            Some(calculate_throughput_delta(
                rate(counter.items, elapsed),
                baseline_summary.items.rate,
                noise_threshold,
            ))
        } else {
            None
        },
        bytes_rate: if counter.bytes > 0 || baseline_summary.bytes.total > 0 {
            Some(calculate_throughput_delta(
                rate(counter.bytes, elapsed),
                baseline_summary.bytes.rate,
                noise_threshold,
            ))
        } else {
            None
        },
    };

    // Calculate latency deltas (if available)
    let latency = if report.hist.is_empty() {
        None
    } else {
        baseline.report.latency.as_ref().map(|baseline_latency| LatencyDeltas {
            mean: calculate_latency_delta(
                report.hist.mean().as_secs_f64(),
                baseline_latency.stats.mean,
                noise_threshold,
            ),
            median: calculate_latency_delta(
                report.hist.median().as_secs_f64(),
                baseline_latency.stats.median,
                noise_threshold,
            ),
            p90: baseline_latency.percentiles.get("p90").map(|&v| {
                calculate_latency_delta(report.hist.value_at_quantile(0.90).as_secs_f64(), v, noise_threshold)
            }),
            p99: baseline_latency.percentiles.get("p99").map(|&v| {
                calculate_latency_delta(report.hist.value_at_quantile(0.99).as_secs_f64(), v, noise_threshold)
            }),
            max: calculate_latency_delta(
                report.hist.max().as_secs_f64(),
                baseline_latency.stats.max,
                noise_threshold,
            ),
        })
    };

    // Calculate success ratio delta
    let success_ratio =
        calculate_success_ratio_delta(report.success_ratio(), baseline_summary.success_ratio, noise_threshold);

    // Calculate verdict based on regression metrics
    let (verdict, skipped) = calculate_verdict(&throughput, latency.as_ref(), &success_ratio, regression_metrics);

    Comparison {
        baseline_name: baseline.metadata.name.clone(),
        baseline_created_at: baseline.metadata.created_at,
        schema_version: baseline.schema_version,
        noise_threshold,
        regression_metrics: regression_metrics.to_vec(),
        skipped_metrics: skipped,
        verdict,
        throughput,
        latency,
        success_ratio,
    }
}

/// Calculate delta for a throughput metric (higher is better).
fn calculate_throughput_delta(current: f64, baseline: f64, noise_threshold: f64) -> Delta {
    calculate_delta(current, baseline, noise_threshold, true)
}

/// Calculate delta for a latency metric (lower is better).
fn calculate_latency_delta(current: f64, baseline: f64, noise_threshold: f64) -> Delta {
    calculate_delta(current, baseline, noise_threshold, false)
}

/// Calculate delta for success ratio (higher is better).
fn calculate_success_ratio_delta(current: f64, baseline: f64, noise_threshold: f64) -> Delta {
    // Success ratio uses the same relative change calculation as throughput
    calculate_delta(current, baseline, noise_threshold, true)
}

/// Generic delta calculation.
///
/// - `higher_is_better`: true for throughput metrics, false for latency metrics.
fn calculate_delta(current: f64, baseline: f64, noise_threshold: f64, higher_is_better: bool) -> Delta {
    // Handle edge case: both zero
    if baseline == 0.0 && current == 0.0 {
        return Delta {
            current,
            baseline,
            ratio: Some(1.0),
            delta: Some(0.0),
            status: DeltaStatus::Unchanged,
        };
    }

    // Calculate ratio and delta (None if baseline is 0)
    let (ratio, delta) = if baseline == 0.0 {
        (None, None)
    } else {
        let r = current / baseline;
        let d = (current - baseline) / baseline * 100.0;
        (Some(r), Some(d))
    };

    // Determine status based on ratio and noise threshold
    let status = match ratio {
        Some(r) => {
            let percent_change = (r - 1.0).abs() * 100.0;
            if percent_change <= noise_threshold {
                DeltaStatus::Unchanged
            } else {
                // For throughput (higher_is_better=true): ratio > 1 means improved
                // For latency (higher_is_better=false): ratio < 1 means improved
                let is_improved = if higher_is_better { r > 1.0 } else { r < 1.0 };
                if is_improved {
                    DeltaStatus::Improved
                } else {
                    DeltaStatus::Regressed
                }
            }
        }
        // baseline == 0, current != 0: throughput improved, latency regressed
        None => {
            if higher_is_better {
                DeltaStatus::Improved
            } else {
                DeltaStatus::Regressed
            }
        }
    };

    Delta { current, baseline, ratio, delta, status }
}

/// Calculate the overall verdict based on regression metrics.
///
/// Returns the verdict and a list of metrics that were skipped (unavailable).
fn calculate_verdict(
    throughput: &ThroughputDeltas,
    latency: Option<&LatencyDeltas>,
    success_ratio: &Delta,
    metrics: &[RegressionMetric],
) -> (Verdict, Vec<RegressionMetric>) {
    let mut statuses = Vec::new();
    let mut skipped = Vec::new();

    for metric in metrics {
        let status = match metric {
            RegressionMetric::ItersRate => Some(throughput.iters_rate.status),
            RegressionMetric::ItemsRate => throughput.items_rate.as_ref().map(|d| d.status),
            RegressionMetric::BytesRate => throughput.bytes_rate.as_ref().map(|d| d.status),
            RegressionMetric::LatencyMean => latency.map(|l| l.mean.status),
            RegressionMetric::LatencyMedian => latency.map(|l| l.median.status),
            RegressionMetric::LatencyP90 => latency.and_then(|l| l.p90.as_ref().map(|d| d.status)),
            RegressionMetric::LatencyP99 => latency.and_then(|l| l.p99.as_ref().map(|d| d.status)),
            RegressionMetric::LatencyMax => latency.map(|l| l.max.status),
            RegressionMetric::SuccessRatio => Some(success_ratio.status),
        };

        match status {
            Some(s) => statuses.push(s),
            None => skipped.push(*metric),
        }
    }

    let has_improved = statuses.contains(&DeltaStatus::Improved);
    let has_regressed = statuses.contains(&DeltaStatus::Regressed);

    let verdict = match (has_improved, has_regressed) {
        (true, true) => Verdict::Mixed,
        (true, false) => Verdict::Improved,
        (false, true) => Verdict::Regressed,
        (false, false) => Verdict::Unchanged,
    };

    (verdict, skipped)
}

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

    #[test]
    fn test_calculate_throughput_delta_improved() {
        let delta = calculate_throughput_delta(1100.0, 1000.0, 1.0);
        assert_eq!(delta.status, DeltaStatus::Improved);
        assert!((delta.ratio.unwrap() - 1.1).abs() < 0.001);
    }

    #[test]
    fn test_calculate_throughput_delta_regressed() {
        let delta = calculate_throughput_delta(900.0, 1000.0, 1.0);
        assert_eq!(delta.status, DeltaStatus::Regressed);
        assert!((delta.ratio.unwrap() - 0.9).abs() < 0.001);
    }

    #[test]
    fn test_calculate_throughput_delta_unchanged() {
        let delta = calculate_throughput_delta(1005.0, 1000.0, 1.0);
        assert_eq!(delta.status, DeltaStatus::Unchanged);
    }

    #[test]
    fn test_calculate_latency_delta_improved() {
        // Lower latency is better
        let delta = calculate_latency_delta(0.9, 1.0, 1.0);
        assert_eq!(delta.status, DeltaStatus::Improved);
    }

    #[test]
    fn test_calculate_latency_delta_regressed() {
        // Higher latency is worse
        let delta = calculate_latency_delta(1.1, 1.0, 1.0);
        assert_eq!(delta.status, DeltaStatus::Regressed);
    }

    #[test]
    fn test_calculate_verdict_improved() {
        let throughput = ThroughputDeltas {
            iters_rate: Delta {
                current: 1100.0,
                baseline: 1000.0,
                ratio: Some(1.1),
                delta: Some(10.0),
                status: DeltaStatus::Improved,
            },
            items_rate: None,
            bytes_rate: None,
        };
        let success_ratio = Delta {
            current: 1.0,
            baseline: 1.0,
            ratio: Some(1.0),
            delta: Some(0.0),
            status: DeltaStatus::Unchanged,
        };

        let (verdict, skipped) = calculate_verdict(&throughput, None, &success_ratio, &[RegressionMetric::ItersRate]);
        assert_eq!(verdict, Verdict::Improved);
        assert!(skipped.is_empty());
    }

    #[test]
    fn test_calculate_verdict_mixed() {
        let throughput = ThroughputDeltas {
            iters_rate: Delta {
                current: 1100.0,
                baseline: 1000.0,
                ratio: Some(1.1),
                delta: Some(10.0),
                status: DeltaStatus::Improved,
            },
            items_rate: None,
            bytes_rate: None,
        };
        let success_ratio = Delta {
            current: 0.95,
            baseline: 0.99,
            ratio: Some(0.9596),
            delta: Some(-4.04), // (0.95 - 0.99) / 0.99 * 100
            status: DeltaStatus::Regressed,
        };

        let (verdict, skipped) = calculate_verdict(
            &throughput,
            None,
            &success_ratio,
            &[RegressionMetric::ItersRate, RegressionMetric::SuccessRatio],
        );
        assert_eq!(verdict, Verdict::Mixed);
        assert!(skipped.is_empty());
    }
}