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
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

//! Promote use case for copying run receipts to become baselines.
//!
//! This module provides functionality for promoting a current run receipt
//! to become the new baseline for subsequent comparisons. This is typically
//! used on trusted branches (e.g., main) after successful benchmark runs.

use perfgate_types::{HostInfo, RunMeta, RunReceipt};

/// Request for promoting a run receipt to become a baseline.
#[derive(Debug, Clone)]
pub struct PromoteRequest {
    /// The run receipt to promote.
    pub receipt: RunReceipt,

    /// If true, strip run-specific fields (run_id, timestamps) to make
    /// the baseline more stable across runs.
    pub normalize: bool,
}

/// Result of a promote operation.
#[derive(Debug, Clone)]
pub struct PromoteResult {
    /// The (possibly normalized) receipt to be written as baseline.
    pub receipt: RunReceipt,
}

/// Use case for promoting run receipts to baselines.
pub struct PromoteUseCase;

impl PromoteUseCase {
    /// Execute the promote operation.
    ///
    /// If `normalize` is true, the receipt will have run-specific fields
    /// (run_id, started_at, ended_at) replaced with placeholder values
    /// to make the baseline more stable for comparison purposes.
    pub fn execute(req: PromoteRequest) -> PromoteResult {
        let receipt = if req.normalize {
            Self::normalize_receipt(req.receipt)
        } else {
            req.receipt
        };

        PromoteResult { receipt }
    }

    /// Normalize a receipt by stripping run-specific fields.
    fn normalize_receipt(mut receipt: RunReceipt) -> RunReceipt {
        receipt.run = RunMeta {
            id: "baseline".to_string(),
            started_at: "1970-01-01T00:00:00Z".to_string(),
            ended_at: "1970-01-01T00:00:00Z".to_string(),
            host: HostInfo {
                os: receipt.run.host.os,
                arch: receipt.run.host.arch,
                cpu_count: receipt.run.host.cpu_count,
                memory_bytes: receipt.run.host.memory_bytes,
                hostname_hash: receipt.run.host.hostname_hash,
            },
        };
        receipt
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use perfgate_types::{BenchMeta, HostInfo, RunMeta, Sample, Stats, ToolInfo, U64Summary};

    fn create_test_receipt() -> RunReceipt {
        RunReceipt {
            schema: "perfgate.run.v1".to_string(),
            tool: ToolInfo {
                name: "perfgate".to_string(),
                version: "0.1.0".to_string(),
            },
            run: RunMeta {
                id: "unique-run-id-12345".to_string(),
                started_at: "2024-01-15T10:00:00Z".to_string(),
                ended_at: "2024-01-15T10:00:05Z".to_string(),
                host: HostInfo {
                    os: "linux".to_string(),
                    arch: "x86_64".to_string(),
                    cpu_count: Some(4),
                    memory_bytes: Some(8_000_000_000),
                    hostname_hash: Some("testhash123".to_string()),
                },
            },
            bench: BenchMeta {
                name: "test-benchmark".to_string(),
                cwd: None,
                command: vec!["echo".to_string(), "hello".to_string()],
                repeat: 5,
                warmup: 0,
                work_units: None,
                timeout_ms: None,
            },
            samples: vec![Sample {
                wall_ms: 100,
                exit_code: 0,
                warmup: false,
                timed_out: false,
                cpu_ms: None,
                page_faults: None,
                ctx_switches: None,
                max_rss_kb: None,
                io_read_bytes: None,
                io_write_bytes: None,
                network_packets: None,
                energy_uj: None,
                binary_bytes: None,
                stdout: None,
                stderr: None,
            }],
            stats: Stats {
                wall_ms: U64Summary::new(100, 100, 100),
                cpu_ms: None,
                page_faults: None,
                ctx_switches: None,
                max_rss_kb: None,
                io_read_bytes: None,
                io_write_bytes: None,
                network_packets: None,
                energy_uj: None,
                binary_bytes: None,
                throughput_per_s: None,
            },
        }
    }

    #[test]
    fn test_promote_without_normalize() {
        let receipt = create_test_receipt();
        let original_run_id = receipt.run.id.clone();
        let original_started_at = receipt.run.started_at.clone();

        let result = PromoteUseCase::execute(PromoteRequest {
            receipt,
            normalize: false,
        });

        // Without normalize, the receipt should be unchanged
        assert_eq!(result.receipt.run.id, original_run_id);
        assert_eq!(result.receipt.run.started_at, original_started_at);
    }

    #[test]
    fn test_promote_with_normalize() {
        let receipt = create_test_receipt();

        let result = PromoteUseCase::execute(PromoteRequest {
            receipt,
            normalize: true,
        });

        // With normalize, run-specific fields should be replaced
        assert_eq!(result.receipt.run.id, "baseline");
        assert_eq!(result.receipt.run.started_at, "1970-01-01T00:00:00Z");
        assert_eq!(result.receipt.run.ended_at, "1970-01-01T00:00:00Z");

        // Host info should be preserved
        assert_eq!(result.receipt.run.host.os, "linux");
        assert_eq!(result.receipt.run.host.arch, "x86_64");

        // Other fields should be unchanged
        assert_eq!(result.receipt.bench.name, "test-benchmark");
        assert_eq!(result.receipt.stats.wall_ms.median, 100);
    }

    #[test]
    fn test_normalize_preserves_bench_data() {
        let receipt = create_test_receipt();

        let result = PromoteUseCase::execute(PromoteRequest {
            receipt: receipt.clone(),
            normalize: true,
        });

        // Verify bench metadata is preserved
        assert_eq!(result.receipt.bench.name, receipt.bench.name);
        assert_eq!(result.receipt.bench.command, receipt.bench.command);
        assert_eq!(result.receipt.bench.repeat, receipt.bench.repeat);
        assert_eq!(result.receipt.bench.warmup, receipt.bench.warmup);

        // Verify samples are preserved
        assert_eq!(result.receipt.samples.len(), receipt.samples.len());
        assert_eq!(
            result.receipt.samples[0].wall_ms,
            receipt.samples[0].wall_ms
        );

        // Verify stats are preserved
        assert_eq!(
            result.receipt.stats.wall_ms.median,
            receipt.stats.wall_ms.median
        );
    }

    #[test]
    fn test_normalize_preserves_schema_and_tool() {
        let receipt = create_test_receipt();

        let result = PromoteUseCase::execute(PromoteRequest {
            receipt: receipt.clone(),
            normalize: true,
        });

        assert_eq!(result.receipt.schema, receipt.schema);
        assert_eq!(result.receipt.tool.name, receipt.tool.name);
        assert_eq!(result.receipt.tool.version, receipt.tool.version);
    }

    #[test]
    fn test_promote_preserves_optional_none_fields() {
        let mut receipt = create_test_receipt();
        receipt.run.host.cpu_count = None;
        receipt.run.host.memory_bytes = None;
        receipt.run.host.hostname_hash = None;
        receipt.bench.cwd = None;
        receipt.bench.work_units = None;
        receipt.bench.timeout_ms = None;

        let result = PromoteUseCase::execute(PromoteRequest {
            receipt,
            normalize: true,
        });

        assert!(result.receipt.run.host.cpu_count.is_none());
        assert!(result.receipt.run.host.memory_bytes.is_none());
        assert!(result.receipt.run.host.hostname_hash.is_none());
        assert!(result.receipt.bench.cwd.is_none());
        assert!(result.receipt.bench.work_units.is_none());
    }

    #[test]
    fn test_promote_normalize_idempotent() {
        let receipt = create_test_receipt();

        let first = PromoteUseCase::execute(PromoteRequest {
            receipt,
            normalize: true,
        });

        let second = PromoteUseCase::execute(PromoteRequest {
            receipt: first.receipt.clone(),
            normalize: true,
        });

        assert_eq!(first.receipt.run.id, second.receipt.run.id);
        assert_eq!(first.receipt.run.started_at, second.receipt.run.started_at);
        assert_eq!(first.receipt.run.ended_at, second.receipt.run.ended_at);
    }
}