mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-11-01 00:40:19 +00:00
483 lines
19 KiB
Rust
483 lines
19 KiB
Rust
use super::Exporter;
|
|
use crate::benchmark::benchmark_result::BenchmarkResult;
|
|
use crate::benchmark::measurement::{Measurement, Measurements};
|
|
use crate::export::asciidoc::AsciidocExporter;
|
|
use crate::export::markdown::MarkdownExporter;
|
|
use crate::export::orgmode::OrgmodeExporter;
|
|
use crate::metric::{MetricSelection, Unit};
|
|
use crate::quantity::{byte, second, Information, Time, Zero};
|
|
use std::collections::BTreeMap;
|
|
use std::process::ExitStatus;
|
|
|
|
fn get_output<E: Exporter + Default>(results: &[BenchmarkResult], unit: Option<Unit>) -> String {
|
|
let exporter = E::default();
|
|
String::from_utf8(
|
|
exporter
|
|
.serialize(
|
|
results,
|
|
MetricSelection {
|
|
unit,
|
|
..MetricSelection::default()
|
|
},
|
|
)
|
|
.unwrap(),
|
|
)
|
|
.unwrap()
|
|
}
|
|
|
|
/// Ensure the makrup output includes the table header and the multiple
|
|
/// benchmark results as a table. The list of actual times is not included
|
|
/// in the output.
|
|
///
|
|
/// This also demonstrates that the first entry's units (ms) are used to set
|
|
/// the units for all entries when the time unit is not specified.
|
|
#[test]
|
|
fn test_markup_export_auto_ms() {
|
|
let results = [
|
|
BenchmarkResult {
|
|
command: String::from("sleep 0.1"),
|
|
name: None,
|
|
display_name: String::from("sleep 0.1"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.09),
|
|
time_cpu: Time::new::<second>(0.09),
|
|
time_user: Time::new::<second>(0.09),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.10),
|
|
time_cpu: Time::new::<second>(0.10),
|
|
time_user: Time::new::<second>(0.10),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.14),
|
|
time_cpu: Time::new::<second>(0.14),
|
|
time_user: Time::new::<second>(0.14),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
BenchmarkResult {
|
|
command: String::from("sleep 2"),
|
|
name: None,
|
|
display_name: String::from("sleep 2"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.0),
|
|
time_cpu: Time::new::<second>(2.0),
|
|
time_user: Time::new::<second>(2.0),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(3.0),
|
|
time_cpu: Time::new::<second>(3.0),
|
|
time_user: Time::new::<second>(3.0),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(4.0),
|
|
time_cpu: Time::new::<second>(4.0),
|
|
time_user: Time::new::<second>(4.0),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
];
|
|
|
|
insta::assert_snapshot!(get_output::<MarkdownExporter>(&results, None), @"
|
|
| Command | Mean Wall Time [ms] | Min [ms] | Max [ms] | Change |
|
|
|:---|---:|---:|---:|---:|
|
|
| `sleep 0.1` | 110.0 ± 26.5 | 90.0 | 140.0 | reference |
|
|
| `sleep 2` | 3000.0 ± 1000.0 | 2000.0 | 4000.0 | +2627.3% |
|
|
");
|
|
|
|
insta::assert_snapshot!(get_output::<AsciidocExporter>(&results, None), @r#"
|
|
[cols="<,>,>,>,>"]
|
|
|===
|
|
| Command
|
|
| Mean Wall Time [ms]
|
|
| Min [ms]
|
|
| Max [ms]
|
|
| Change
|
|
|
|
| `sleep 0.1`
|
|
| 110.0 ± 26.5
|
|
| 90.0
|
|
| 140.0
|
|
| reference
|
|
|
|
| `sleep 2`
|
|
| 3000.0 ± 1000.0
|
|
| 2000.0
|
|
| 4000.0
|
|
| +2627.3%
|
|
|===
|
|
"#);
|
|
|
|
insta::assert_snapshot!(get_output::<OrgmodeExporter>(&results, None), @"
|
|
| Command | Mean Wall Time [ms] | Min [ms] | Max [ms] | Change |
|
|
|--+--+--+--+--|
|
|
| =sleep 0.1= | 110.0 ± 26.5 | 90.0 | 140.0 | reference |
|
|
| =sleep 2= | 3000.0 ± 1000.0 | 2000.0 | 4000.0 | +2627.3% |
|
|
");
|
|
}
|
|
|
|
/// This (again) demonstrates that the first entry's units (s) are used to set
|
|
/// the units for all entries when the time unit is not given.
|
|
#[test]
|
|
fn test_markup_export_auto_s() {
|
|
let results = [
|
|
BenchmarkResult {
|
|
command: String::from("sleep 2"),
|
|
name: None,
|
|
display_name: String::from("sleep 2"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.1),
|
|
time_cpu: Time::new::<second>(2.1),
|
|
time_user: Time::new::<second>(2.1),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.2),
|
|
time_cpu: Time::new::<second>(2.2),
|
|
time_user: Time::new::<second>(2.2),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.3),
|
|
time_cpu: Time::new::<second>(2.3),
|
|
time_user: Time::new::<second>(2.3),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
BenchmarkResult {
|
|
command: String::from("sleep 0.1"),
|
|
name: None,
|
|
display_name: String::from("sleep 0.1"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.1),
|
|
time_cpu: Time::new::<second>(0.1),
|
|
time_user: Time::new::<second>(0.1),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.2),
|
|
time_cpu: Time::new::<second>(0.2),
|
|
time_user: Time::new::<second>(0.2),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.3),
|
|
time_cpu: Time::new::<second>(0.3),
|
|
time_user: Time::new::<second>(0.3),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
];
|
|
|
|
insta::assert_snapshot!(get_output::<MarkdownExporter>(&results, None), @"
|
|
| Command | Mean Wall Time [s] | Min [s] | Max [s] | Change |
|
|
|:---|---:|---:|---:|---:|
|
|
| `sleep 2` | 2.200 ± 0.100 | 2.100 | 2.300 | reference |
|
|
| `sleep 0.1` | 0.200 ± 0.100 | 0.100 | 0.300 | -90.9% |
|
|
");
|
|
|
|
insta::assert_snapshot!(get_output::<AsciidocExporter>(&results, None), @r#"
|
|
[cols="<,>,>,>,>"]
|
|
|===
|
|
| Command
|
|
| Mean Wall Time [s]
|
|
| Min [s]
|
|
| Max [s]
|
|
| Change
|
|
|
|
| `sleep 2`
|
|
| 2.200 ± 0.100
|
|
| 2.100
|
|
| 2.300
|
|
| reference
|
|
|
|
| `sleep 0.1`
|
|
| 0.200 ± 0.100
|
|
| 0.100
|
|
| 0.300
|
|
| -90.9%
|
|
|===
|
|
"#);
|
|
|
|
insta::assert_snapshot!(get_output::<OrgmodeExporter>(&results, None), @"
|
|
| Command | Mean Wall Time [s] | Min [s] | Max [s] | Change |
|
|
|--+--+--+--+--|
|
|
| =sleep 2= | 2.200 ± 0.100 | 2.100 | 2.300 | reference |
|
|
| =sleep 0.1= | 0.200 ± 0.100 | 0.100 | 0.300 | -90.9% |
|
|
");
|
|
}
|
|
|
|
/// This (again) demonstrates that the given time unit (ms) is used to set
|
|
/// the units for all entries.
|
|
#[test]
|
|
fn test_markup_export_manual_ms() {
|
|
let timing_results = [
|
|
BenchmarkResult {
|
|
command: String::from("sleep 2"),
|
|
name: None,
|
|
display_name: String::from("sleep 2"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.1),
|
|
time_cpu: Time::new::<second>(2.1),
|
|
time_user: Time::new::<second>(2.1),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.2),
|
|
time_cpu: Time::new::<second>(2.2),
|
|
time_user: Time::new::<second>(2.2),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.3),
|
|
time_cpu: Time::new::<second>(2.3),
|
|
time_user: Time::new::<second>(2.3),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
BenchmarkResult {
|
|
command: String::from("sleep 0.1"),
|
|
name: None,
|
|
display_name: String::from("sleep 0.1"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.1),
|
|
time_cpu: Time::new::<second>(0.1),
|
|
time_user: Time::new::<second>(0.1),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.2),
|
|
time_cpu: Time::new::<second>(0.2),
|
|
time_user: Time::new::<second>(0.2),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.3),
|
|
time_cpu: Time::new::<second>(0.3),
|
|
time_user: Time::new::<second>(0.3),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
];
|
|
|
|
insta::assert_snapshot!(get_output::<MarkdownExporter>(&timing_results, Some(Unit { symbol: "ms", scale: 0.001 })), @"
|
|
| Command | Mean Wall Time [ms] | Min [ms] | Max [ms] | Change |
|
|
|:---|---:|---:|---:|---:|
|
|
| `sleep 2` | 2200.0 ± 100.0 | 2100.0 | 2300.0 | reference |
|
|
| `sleep 0.1` | 200.0 ± 100.0 | 100.0 | 300.0 | -90.9% |
|
|
");
|
|
|
|
insta::assert_snapshot!(get_output::<AsciidocExporter>(&timing_results, Some(Unit { symbol: "ms", scale: 0.001 })), @r#"
|
|
[cols="<,>,>,>,>"]
|
|
|===
|
|
| Command
|
|
| Mean Wall Time [ms]
|
|
| Min [ms]
|
|
| Max [ms]
|
|
| Change
|
|
|
|
| `sleep 2`
|
|
| 2200.0 ± 100.0
|
|
| 2100.0
|
|
| 2300.0
|
|
| reference
|
|
|
|
| `sleep 0.1`
|
|
| 200.0 ± 100.0
|
|
| 100.0
|
|
| 300.0
|
|
| -90.9%
|
|
|===
|
|
"#);
|
|
|
|
insta::assert_snapshot!(get_output::<OrgmodeExporter>(&timing_results, Some(Unit { symbol: "ms", scale: 0.001 })), @"
|
|
| Command | Mean Wall Time [ms] | Min [ms] | Max [ms] | Change |
|
|
|--+--+--+--+--|
|
|
| =sleep 2= | 2200.0 ± 100.0 | 2100.0 | 2300.0 | reference |
|
|
| =sleep 0.1= | 200.0 ± 100.0 | 100.0 | 300.0 | -90.9% |
|
|
");
|
|
}
|
|
|
|
/// The given time unit (s) is used to set the units for all entries.
|
|
#[test]
|
|
fn test_markup_export_manual_s() {
|
|
let results = [
|
|
BenchmarkResult {
|
|
command: String::from("sleep 2"),
|
|
name: None,
|
|
display_name: String::from("sleep 2"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.01),
|
|
time_cpu: Time::new::<second>(2.01),
|
|
time_user: Time::new::<second>(2.01),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.02),
|
|
time_cpu: Time::new::<second>(2.02),
|
|
time_user: Time::new::<second>(2.02),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(2.03),
|
|
time_cpu: Time::new::<second>(2.03),
|
|
time_user: Time::new::<second>(2.03),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
BenchmarkResult {
|
|
command: String::from("sleep 0.1"),
|
|
name: None,
|
|
display_name: String::from("sleep 0.1"),
|
|
measurements: Measurements::new(vec![
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.11),
|
|
time_cpu: Time::new::<second>(0.11),
|
|
time_user: Time::new::<second>(0.11),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.12),
|
|
time_cpu: Time::new::<second>(0.12),
|
|
time_user: Time::new::<second>(0.12),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
Measurement {
|
|
time_wall_clock: Time::new::<second>(0.13),
|
|
time_cpu: Time::new::<second>(0.13),
|
|
time_user: Time::new::<second>(0.13),
|
|
time_system: Time::zero(),
|
|
memory_peak_resident: Some(Information::new::<byte>(1024.)),
|
|
hardware_counters: Default::default(),
|
|
exit_status: ExitStatus::default(),
|
|
},
|
|
]),
|
|
parameters: BTreeMap::new(),
|
|
},
|
|
];
|
|
|
|
insta::assert_snapshot!(get_output::<MarkdownExporter>(&results, Some(Unit { symbol: "s", scale: 1.0 })), @"
|
|
| Command | Mean Wall Time [s] | Min [s] | Max [s] | Change |
|
|
|:---|---:|---:|---:|---:|
|
|
| `sleep 2` | 2.020 ± 0.010 | 2.010 | 2.030 | reference |
|
|
| `sleep 0.1` | 0.120 ± 0.010 | 0.110 | 0.130 | -94.1% |
|
|
");
|
|
|
|
insta::assert_snapshot!(get_output::<AsciidocExporter>(&results, Some(Unit { symbol: "s", scale: 1.0 })), @r#"
|
|
[cols="<,>,>,>,>"]
|
|
|===
|
|
| Command
|
|
| Mean Wall Time [s]
|
|
| Min [s]
|
|
| Max [s]
|
|
| Change
|
|
|
|
| `sleep 2`
|
|
| 2.020 ± 0.010
|
|
| 2.010
|
|
| 2.030
|
|
| reference
|
|
|
|
| `sleep 0.1`
|
|
| 0.120 ± 0.010
|
|
| 0.110
|
|
| 0.130
|
|
| -94.1%
|
|
|===
|
|
"#);
|
|
}
|