benchmark-rs 0.0.7-alpha

Benchamrks for Rust libraries
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

use std::fmt::{Display, Formatter};
use std::thread::sleep;
use std::time::Duration;
use rand::Rng;
use benchmark_rs::benchmarks::Benchmarks;
use benchmark_rs::benchmark_comparison::BenchmarkComparison;
use benchmark_rs::stopwatch::StopWatch;

#[derive(Clone)]
struct BenchConfig {
    duration: Duration,
}

impl BenchConfig {
    fn new(t: u64) -> BenchConfig {
        let duration = Duration::from_micros(t);
        BenchConfig { duration }
    }

    fn duration(&self) -> Duration {
        self.duration
    }
}

impl Display for BenchConfig {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "slowdown: {}", self.duration.as_micros())
    }
}

#[test]
#[should_panic]
fn test_zero_runs() {
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("run zero times", zero_runs, BenchConfig::new(0), vec![0], 0, 0).expect("zero runs");
}

fn zero_runs(_stop_watch: &mut StopWatch, _config: BenchConfig, _work: i64) -> Result<(), anyhow::Error> {
    Ok(())
}

#[test]
#[should_panic]
fn test_benchmark_exists() {
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("exists", exists, BenchConfig::new(0), vec![0], 1, 1).expect("benchmark exists");
    benchmarks.add("exists", exists, BenchConfig::new(0), vec![0], 1, 1).expect("benchmark exists");
}

fn exists(_stop_watch: &mut StopWatch, _config: BenchConfig, _work: i64) -> Result<(), anyhow::Error> {
    Ok(())
}

#[test]
fn test_analyze_new() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=2).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort n", bench_sort, BenchConfig::new(0), work, 2, 1)?;
    benchmarks.run()?;

    let new_result = benchmarks.analyze(None, 0.0)?;
    assert!(!new_result.new_series().is_empty());
    assert!(new_result.results().is_empty());
    Ok(())
}

#[test]
fn test_analyze_identical() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=3).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort n", bench_sort, BenchConfig::new(0), work.clone(), 2, 1)?;
    benchmarks.add("sort n and rest", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks.run()?;

    let equal_result = benchmarks.analyze(
        Some(benchmarks.summary_as_json()),
        0.0,
    )?;
    assert!(equal_result.new_series().is_empty());
    for (name, benchmark_comparison) in equal_result.results() {
        match benchmark_comparison {
            BenchmarkComparison::Less { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Equal { point, previous, current, change } => {
                assert!(true, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Greater { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
        }
    }
    Ok(())
}

#[test]
fn test_analyze_different_runs_same_configuration() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=3).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort n", bench_sort, BenchConfig::new(0), work.clone(), 30, 1)?;
    benchmarks.add("sort n and rest", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks.run()?;

    let first_run_result = benchmarks.summary_as_json();

    let mut benchmarks2 = Benchmarks::new("Test");
    benchmarks2.add("sort n", bench_sort, BenchConfig::new(0), work.clone(), 30, 1)?;
    benchmarks2.add("sort n and rest", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks2.run()?;

    let different_runs_result = benchmarks2.analyze(Some(first_run_result), 10.0)?;
    for (name, benchmark_comparison) in different_runs_result.results() {
        match benchmark_comparison {
            BenchmarkComparison::Less { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Equal { point, previous, current, change } => {
                assert!(true, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Greater { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
        }
    }
    Ok(())
}

#[test]
fn test_analyze_different_runs_degradation() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=3).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort n", bench_sort, BenchConfig::new(0), work.clone(), 30, 1)?;
    benchmarks.add("sort n and rest", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks.run()?;

    let first_run_result = benchmarks.summary_as_json();

    let mut benchmarks2 = Benchmarks::new("Test");
    benchmarks2.add("sort n", bench_sort, BenchConfig::new(10), work.clone(), 30, 1)?;
    benchmarks2.add("sort n and rest", bench_sort, BenchConfig::new(100), work.clone(), 2, 1)?;
    benchmarks2.run()?;

    let different_runs_result = benchmarks2.analyze(Some(first_run_result), 10.0)?;
    for (name, benchmark_comparison) in different_runs_result.results() {
        match benchmark_comparison {
            BenchmarkComparison::Less { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Equal { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Greater { point, previous, current, change } => {
                assert!(true, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
        }
    }
    Ok(())
}

#[test]
fn test_analyze_different_runs_improvement() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=3).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort n", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks.add("sort n and rest", bench_sort, BenchConfig::new(100), work.clone(), 2, 1)?;
    benchmarks.run()?;

    let first_run_result = benchmarks.summary_as_json();

    let mut benchmarks2 = Benchmarks::new("Test");
    benchmarks2.add("sort n", bench_sort, BenchConfig::new(0), work.clone(), 2, 1)?;
    benchmarks2.add("sort n and rest", bench_sort, BenchConfig::new(10), work.clone(), 2, 1)?;
    benchmarks2.run()?;

    let different_runs_result = benchmarks2.analyze(Some(first_run_result), 10.0)?;
    for (name, benchmark_comparison) in different_runs_result.results() {
        match benchmark_comparison {
            BenchmarkComparison::Less { point, previous, current, change } => {
                assert!(true, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Equal { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
            BenchmarkComparison::Greater { point, previous, current, change } => {
                assert!(false, "name: {name}, point: {point}, previous: {previous}, current: {current}, change: {change}");
            }
        }
    }
    Ok(())
}

#[test]
fn test_csv() -> Result<(), anyhow::Error> {
    let work: Vec<usize> = (0..=2).map(|i| i * 100 as usize).collect();
    let mut benchmarks = Benchmarks::new("Test");
    benchmarks.add("sort-n", bench_sort, BenchConfig::new(0), work, 2, 1)?;
    benchmarks.run()?;

    let _series_csv = benchmarks.summary_as_csv(true, true);
    for (_key, _value) in _series_csv {
        // println!("series: {key}");
        // println!("csv: {value:?}");
    }

    for (_key, _value) in benchmarks.configs() {
        // println!("series: {key}");
        // println!("config: {value:?}");
    }

    Ok(())
}

fn bench_sort(stop_watch: &mut StopWatch, config: BenchConfig, work: usize) -> Result<(), anyhow::Error> {
    stop_watch.pause();
    let mut rng = rand::thread_rng();
    let mut v: Vec<u64> = (0..work).map(|_| rng.gen()).collect();
    stop_watch.resume();
    v.sort_by(|x, y| {
        sleep(config.duration());
        x.cmp(y)
    });
    stop_watch.pause();
    Ok(())
}