Add option to export JSON, change file handling

No longer serialize into strings, instead use Vec<u8> as it is
what we're writing to the files.

Fixup comments
This commit is contained in:
Steve Pentland authored and David Peter committed 2018-03-20 20:14:14 +01:00
1 parent ce79d81bd2
commit c59110d652
6 files changed
+130 -32

No files matched your search

+11 -11
View File
@@ -1,26 +1,26 @@
use super::{ExportEntry, ResultExporter};
use csv::WriterBuilder;
use std::io::Result;
use std::io::{Error, ErrorKind, Result};
pub struct CsvExporter {
out_file: String,
}
pub struct CsvExporter {}
impl ResultExporter for CsvExporter {
fn write(&self, results: &Vec<ExportEntry>) -> Result<()> {
let mut writer = WriterBuilder::new().from_path(&self.out_file)?;
fn write(&self, results: &Vec<ExportEntry>) -> Result<Vec<u8>> {
let mut writer = WriterBuilder::new().from_writer(vec![]);
for res in results {
writer.serialize(res)?;
}
Ok(())
if let Ok(inner) = writer.into_inner() {
return Ok(inner);
}
Err(Error::new(ErrorKind::Other, "Error serializing to CSV"))
}
}
impl CsvExporter {
pub fn new(file_name: String) -> Self {
CsvExporter {
out_file: file_name,
}
pub fn new() -> Self {
CsvExporter {}
}
}
+29
View File
@@ -0,0 +1,29 @@
use super::{ExportEntry, ResultExporter};
use std::io::{Error, ErrorKind, Result};
use serde_json::to_vec_pretty;
#[derive(Serialize, Debug)]
struct HyperfineSummary<'a> {
results: &'a Vec<ExportEntry>,
}
pub struct JsonExporter {}
impl ResultExporter for JsonExporter {
fn write(&self, results: &Vec<ExportEntry>) -> Result<Vec<u8>> {
let serialized = to_vec_pretty(&HyperfineSummary { results });
match serialized {
Ok(file_content) => Ok(file_content),
Err(e) => Err(Error::new(ErrorKind::Other, format!("{:?}", e))),
}
}
}
impl JsonExporter {
pub fn new() -> Self {
JsonExporter {}
}
}
+29 -10
View File
@@ -1,8 +1,11 @@
mod csv;
mod json;
use self::csv::CsvExporter;
use self::json::JsonExporter;
use std::io::Result;
use std::io::{Result, Write};
use std::fs::File;
use hyperfine::internal::Second;
@@ -51,16 +54,19 @@ impl ExportEntry {
/// The ResultExportType enum is used to denote the desired form
/// of exporter to use for a given file.
#[derive(Clone)]
pub enum ResultExportType {
/// Export to a csv file with the provided name
Csv(String),
/// Export to a JSON file
Json(String),
}
/// A ResultExporter is responsible for writing all results to the
/// appropriate file
trait ResultExporter {
/// Write all entries to the target destination
fn write(&self, values: &Vec<ExportEntry>) -> Result<()>;
fn write(&self, values: &Vec<ExportEntry>) -> Result<Vec<u8>>;
}
/// Create a new ExportManager
@@ -70,23 +76,36 @@ pub fn create_export_manager() -> ExportManager {
}
}
/// The Exporter is the internal implementation of the ExportManager
/// The ExportManager handles the management of multiple file
/// exporters.
pub struct ExportManager {
exporters: Vec<Box<ResultExporter>>,
exporters: Vec<ResultExportType>,
}
impl ExportManager {
pub fn add_exporter(&mut self, for_type: &ResultExportType) {
match for_type {
&ResultExportType::Csv(ref file_name) => self.exporters
.push(Box::from(CsvExporter::new(file_name.clone()))),
};
/// Add an additional exporter to the ExportManager
pub fn add_exporter(&mut self, for_type: ResultExportType) {
self.exporters.push(for_type);
}
/// Write the given results to all Exporters contained within this manager
pub fn write_results(&self, to_write: Vec<ExportEntry>) -> Result<()> {
for exp in &self.exporters {
exp.write(&to_write)?;
let (exporter, filename): (Box<ResultExporter>, &str) = match exp {
&ResultExportType::Csv(ref file) => (Box::from(CsvExporter::new()), file),
&ResultExportType::Json(ref file) => (Box::from(JsonExporter::new()), file),
};
let file_content = exporter.write(&to_write)?;
write_to_file(filename, file_content)?;
}
Ok(())
}
}
/// Write the given content to a file with the specified name
fn write_to_file(filename: &str, content: Vec<u8>) -> Result<()> {
let mut file = File::create(filename)?;
file.write_all(&content)?;
Ok(())
}
+35 -11
View File
@@ -12,6 +12,7 @@ extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serde_json;
extern crate statistical;
cfg_if! {
@@ -38,7 +39,7 @@ mod hyperfine;
use hyperfine::internal::{CmdFailureAction, HyperfineOptions, OutputStyleOption};
use hyperfine::benchmark::{mean_shell_spawning_time, run_benchmark};
use hyperfine::export::{create_export_manager, ExportEntry, ResultExportType};
use hyperfine::export::{create_export_manager, ExportEntry, ExportManager, ResultExportType};
/// Print error message to stderr and terminate
pub fn error(message: &str) -> ! {
@@ -144,6 +145,13 @@ fn main() {
.value_name("FILE")
.help("Export the timing results to the given file in csv format."),
)
.arg(
Arg::with_name("export-json")
.long("export-json")
.takes_value(true)
.value_name("FILE")
.help("Export the timing results to the given file in JSON format."),
)
.help_message("Print this help message.")
.version_message("Show version information.")
.get_matches();
@@ -173,17 +181,11 @@ fn main() {
},
};
// Initial impl since we're only doing csv files, expand once we have multiple
// export types. Simplest probably to do the same for each, but check for
// None manager on later additions (JSON, Markdown, etc.)
let export_manager = match matches.value_of("export-csv") {
Some(filename) => {
let mut export_manager = create_export_manager();
export_manager.add_exporter(&ResultExportType::Csv(filename.to_string()));
Some(export_manager)
}
None => None,
let export_targets = ExportTargetList {
json_file: matches.value_of("export-json"),
csv_file: matches.value_of("export-csv"),
};
let export_manager = create_exporter(export_targets);
// We default Windows to NoColor if full had been specified.
if cfg!(windows) && options.output_style == OutputStyleOption::Full {
@@ -210,3 +212,25 @@ fn main() {
Err(e) => error(e.description()),
}
}
struct ExportTargetList<'a> {
json_file: Option<&'a str>,
csv_file: Option<&'a str>,
}
fn create_exporter(targets: ExportTargetList) -> Option<ExportManager> {
if targets.json_file.is_none() && targets.csv_file.is_none() {
return None;
}
let mut export_manager = create_export_manager();
if let Some(filename) = targets.json_file {
export_manager.add_exporter(ResultExportType::Json(filename.to_string()));
}
if let Some(filename) = targets.csv_file {
export_manager.add_exporter(ResultExportType::Csv(filename.to_string()));
}
Some(export_manager)
}