git-perf 0.20.0

Track, plot, and statistically validate simple measurements using git-notes for storage
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

use std::collections::HashMap;

/// Represents a parsed measurement from various input formats
#[derive(Debug, Clone, PartialEq)]
pub enum ParsedMeasurement {
    Test(TestMeasurement),
    Benchmark(BenchmarkMeasurement),
}

/// Represents a test measurement from test runners (e.g., JUnit XML)
#[derive(Debug, Clone, PartialEq)]
pub struct TestMeasurement {
    pub name: String,
    pub duration: Option<std::time::Duration>,
    pub status: TestStatus,
    pub metadata: HashMap<String, String>,
}

/// Test execution status
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TestStatus {
    Passed,
    Failed,
    Error,
    Skipped,
}

impl TestStatus {
    #[must_use]
    pub fn as_str(&self) -> &'static str {
        match self {
            TestStatus::Passed => "passed",
            TestStatus::Failed => "failed",
            TestStatus::Error => "error",
            TestStatus::Skipped => "skipped",
        }
    }
}

/// Represents a benchmark measurement from benchmark tools (e.g., criterion)
#[derive(Debug, Clone, PartialEq)]
pub struct BenchmarkMeasurement {
    pub id: String,
    pub statistics: BenchStatistics,
    pub metadata: HashMap<String, String>,
}

/// Benchmark statistics from criterion output
#[derive(Debug, Clone, PartialEq)]
pub struct BenchStatistics {
    pub mean_ns: Option<f64>,
    pub median_ns: Option<f64>,
    pub slope_ns: Option<f64>,
    pub mad_ns: Option<f64>,
    pub unit: String,
}

/// Trait for parsers that convert external formats to ParsedMeasurement
pub trait Parser {
    fn parse(&self, input: &str) -> anyhow::Result<Vec<ParsedMeasurement>>;
}