use super::Exporter; use crate::benchmark::benchmark_result::BenchmarkResult; use crate::benchmark::relative_speed::{self, BenchmarkResultWithRelativeSpeed}; use crate::output::format::format_duration_value; use crate::util::units::Unit; use anyhow::{anyhow, Result}; #[derive(Default)] pub struct MarkdownExporter {} impl Exporter for MarkdownExporter { fn serialize(&self, results: &[BenchmarkResult], unit: Option) -> Result> { let unit = if let Some(unit) = unit { // Use the given unit for all entries. unit } else if let Some(first_result) = results.first() { // Use the first BenchmarkResult entry to determine the unit for all entries. format_duration_value(first_result.mean, None).1 } else { // Default to `Second`. Unit::Second }; if let Some(annotated_results) = relative_speed::compute(results) { let mut destination = start_table(unit); for result in annotated_results { add_table_row(&mut destination, &result, unit); } Ok(destination) } else { Err(anyhow!( "Relative speed comparison is not available for Markdown export." )) } } } fn table_header(unit_short_name: String) -> String { format!( "| Command | Mean [{unit}] | Min [{unit}] | Max [{unit}] | Relative |\n|:---|---:|---:|---:|---:|\n", unit = unit_short_name ) } fn start_table(unit: Unit) -> Vec { table_header(unit.short_name()).bytes().collect() } fn add_table_row(dest: &mut Vec, entry: &BenchmarkResultWithRelativeSpeed, unit: Unit) { let result = &entry.result; let mean_str = format_duration_value(result.mean, Some(unit)).0; let stddev_str = if let Some(stddev) = result.stddev { format!(" ± {}", format_duration_value(stddev, Some(unit)).0) } else { "".into() }; let min_str = format_duration_value(result.min, Some(unit)).0; let max_str = format_duration_value(result.max, Some(unit)).0; let rel_str = format!("{:.2}", entry.relative_speed); let rel_stddev_str = if entry.is_fastest { "".into() } else if let Some(stddev) = entry.relative_speed_stddev { format!(" ± {:.2}", stddev) } else { "".into() }; dest.extend( format!( "| `{command}` | {mean}{stddev} | {min} | {max} | {rel}{rel_stddev} |\n", command = result.command.replace("|", "\\|"), mean = mean_str, stddev = stddev_str, min = min_str, max = max_str, rel = rel_str, rel_stddev = rel_stddev_str, ) .as_bytes(), ); } /// Ensure the markdown 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 given. #[test] fn test_markdown_format_ms() { use std::collections::BTreeMap; let exporter = MarkdownExporter::default(); let timing_results = vec![ BenchmarkResult { command: String::from("sleep 0.1"), mean: 0.1057, stddev: Some(0.0016), median: 0.1057, user: 0.0009, system: 0.0011, min: 0.1023, max: 0.1080, times: Some(vec![0.1, 0.1, 0.1]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, BenchmarkResult { command: String::from("sleep 2"), mean: 2.0050, stddev: Some(0.0020), median: 2.0050, user: 0.0009, system: 0.0012, min: 2.0020, max: 2.0080, times: Some(vec![2.0, 2.0, 2.0]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, ]; let formatted = String::from_utf8(exporter.serialize(&timing_results, None).unwrap()).unwrap(); let formatted_expected = format!( "{}\ | `sleep 0.1` | 105.7 ± 1.6 | 102.3 | 108.0 | 1.00 | | `sleep 2` | 2005.0 ± 2.0 | 2002.0 | 2008.0 | 18.97 ± 0.29 | ", table_header("ms".to_string()) ); assert_eq!(formatted_expected, formatted); } /// 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_markdown_format_s() { use std::collections::BTreeMap; let exporter = MarkdownExporter::default(); let timing_results = vec![ BenchmarkResult { command: String::from("sleep 2"), mean: 2.0050, stddev: Some(0.0020), median: 2.0050, user: 0.0009, system: 0.0012, min: 2.0020, max: 2.0080, times: Some(vec![2.0, 2.0, 2.0]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, BenchmarkResult { command: String::from("sleep 0.1"), mean: 0.1057, stddev: Some(0.0016), median: 0.1057, user: 0.0009, system: 0.0011, min: 0.1023, max: 0.1080, times: Some(vec![0.1, 0.1, 0.1]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, ]; let formatted = String::from_utf8(exporter.serialize(&timing_results, None).unwrap()).unwrap(); let formatted_expected = format!( "{}\ | `sleep 2` | 2.005 ± 0.002 | 2.002 | 2.008 | 18.97 ± 0.29 | | `sleep 0.1` | 0.106 ± 0.002 | 0.102 | 0.108 | 1.00 | ", table_header("s".to_string()) ); assert_eq!(formatted_expected, formatted); } /// The given time unit (s) is used to set the units for all entries. #[test] fn test_markdown_format_time_unit_s() { use std::collections::BTreeMap; let exporter = MarkdownExporter::default(); let timing_results = vec![ BenchmarkResult { command: String::from("sleep 0.1"), mean: 0.1057, stddev: Some(0.0016), median: 0.1057, user: 0.0009, system: 0.0011, min: 0.1023, max: 0.1080, times: Some(vec![0.1, 0.1, 0.1]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, BenchmarkResult { command: String::from("sleep 2"), mean: 2.0050, stddev: Some(0.0020), median: 2.0050, user: 0.0009, system: 0.0012, min: 2.0020, max: 2.0080, times: Some(vec![2.0, 2.0, 2.0]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, ]; let formatted = String::from_utf8( exporter .serialize(&timing_results, Some(Unit::Second)) .unwrap(), ) .unwrap(); let formatted_expected = format!( "{}\ | `sleep 0.1` | 0.106 ± 0.002 | 0.102 | 0.108 | 1.00 | | `sleep 2` | 2.005 ± 0.002 | 2.002 | 2.008 | 18.97 ± 0.29 | ", table_header("s".to_string()) ); assert_eq!(formatted_expected, formatted); } /// This (again) demonstrates that the given time unit (ms) is used to set /// the units for all entries. #[test] fn test_markdown_format_time_unit_ms() { use std::collections::BTreeMap; let exporter = MarkdownExporter::default(); let timing_results = vec![ BenchmarkResult { command: String::from("sleep 2"), mean: 2.0050, stddev: Some(0.0020), median: 2.0050, user: 0.0009, system: 0.0012, min: 2.0020, max: 2.0080, times: Some(vec![2.0, 2.0, 2.0]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, BenchmarkResult { command: String::from("sleep 0.1"), mean: 0.1057, stddev: Some(0.0016), median: 0.1057, user: 0.0009, system: 0.0011, min: 0.1023, max: 0.1080, times: Some(vec![0.1, 0.1, 0.1]), exit_codes: vec![Some(0), Some(0), Some(0)], parameters: BTreeMap::new(), }, ]; let formatted = String::from_utf8( exporter .serialize(&timing_results, Some(Unit::MilliSecond)) .unwrap(), ) .unwrap(); let formatted_expected = format!( "{}\ | `sleep 2` | 2005.0 ± 2.0 | 2002.0 | 2008.0 | 18.97 ± 0.29 | | `sleep 0.1` | 105.7 ± 1.6 | 102.3 | 108.0 | 1.00 | ", table_header("ms".to_string()) ); assert_eq!(formatted_expected, formatted); }