Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export exit codes to JSON output #371

Merged
merged 3 commits into from
May 10, 2021
Merged

Export exit codes to JSON output #371

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
979598e
Export exit codes to JSON output
JordiChauzi Feb 28, 2021
59bb138
Store exit codes as Options (and remove unwrapping)
JordiChauzi May 9, 2021
153f34d
Avoid confusion between exit code and signal values
JordiChauzi May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# unreleased

- Add command exit code to output if it fails, see #342 (@KaindlJulian)
- Export command exit code to JSON output, see #371 (@JordiChauzi)

## Features

Expand Down
36 changes: 31 additions & 5 deletions src/hyperfine/benchmark.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::cmp;
use std::io;
use std::process::Stdio;
use std::process::{ExitStatus, Stdio};

use colored::*;
use statistical::{mean, median, standard_deviation};
Expand Down Expand Up @@ -46,7 +46,7 @@ pub fn time_shell_command(
show_output: bool,
failure_action: CmdFailureAction,
shell_spawning_time: Option<TimingResult>,
) -> io::Result<(TimingResult, bool)> {
) -> io::Result<(TimingResult, ExitStatus)> {
let (stdout, stderr) = if show_output {
(Stdio::inherit(), Stdio::inherit())
} else {
Expand Down Expand Up @@ -88,7 +88,7 @@ pub fn time_shell_command(
time_user,
time_system,
},
result.status.success(),
result.status,
))
}

Expand Down Expand Up @@ -201,6 +201,26 @@ fn run_cleanup_command(
run_intermediate_command(shell, command, show_output, error_output)
}

#[cfg(unix)]
fn extract_exit_code(status: ExitStatus) -> i32 {
use std::os::unix::process::ExitStatusExt;

/* From the ExitStatus::code documentation:
"On Unix, this will return None if the process was terminated by a signal."
In that case, ExitStatusExt::signal should never return None.
*/
status.code().unwrap_or_else(|| status.signal().unwrap())
}

#[cfg(not(unix))]
fn extract_exit_code(status: ExitStatus) -> i32 {
/* From the ExitStatus::code documentation:
"On Unix, this will return None if the process was terminated by a signal."
On the other configurations, ExitStatus::code should never return None.
*/
Copy link
Owner

@sharkdp sharkdp Apr 3, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, but I don't really see a guarantee for the latter part ("On the other configurations, ExitStatus::code should never return None.") in the documentation.

I think it might be best to simply return an Option<i32> from this function and later (in the export) convert exit codes to a string that either contains the exit code or an empty string.

This would also allow us to remove all the unwraps.

What do you think?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JordiChauzi Are you interested in finishing this? Otherwise, that's also fine! We can find someone else then.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the delay. Last month was a little busy and I kind of forgot about this PR.
Anyway, I will try and implement the changes in the next days.
You are right, there is no real guarantee that a configuration may return None from the ExitStatus::code method (this is currently not the case but again, this is not a guarantee). Printing an empty string in that case makes sense. Do we also want to store None instead of unwrapping when the ExitStatus::signal method returns None?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default behavior for serde and outputting json is to serialize None as null. This will create outputs that look like this:

...
"exit_codes": [
        0,
        0,
        0,
        1,
        null,
        null,
        42,
        0,
        0,
        0
      ]
...

To me, it looks "good enough". If you still want the empty string behavior tell me so. If this is the case, I think I will have to add a custom serialize method pour the exit_codes field?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I like the null solution better. You are right. Thanks!

status.code().unwrap()
}

/// Run the benchmark for a single shell command
pub fn run_benchmark(
num: usize,
Expand Down Expand Up @@ -228,6 +248,7 @@ pub fn run_benchmark(
let mut times_real: Vec<Second> = vec![];
let mut times_user: Vec<Second> = vec![];
let mut times_system: Vec<Second> = vec![];
let mut exit_codes: Vec<i32> = vec![];
let mut all_succeeded = true;

// Run init command
Expand Down Expand Up @@ -280,13 +301,14 @@ pub fn run_benchmark(
let prepare_res = run_preparation_command(&options.shell, &prepare_cmd, options.show_output)?;

// Initial timing run
let (res, success) = time_shell_command(
let (res, status) = time_shell_command(
&options.shell,
cmd,
options.show_output,
options.failure_action,
Some(shell_spawning_time),
)?;
let success = status.success();

// Determine number of benchmark runs
let runs_in_min_time = (options.min_time_sec
Expand All @@ -310,6 +332,7 @@ pub fn run_benchmark(
times_real.push(res.time_real);
times_user.push(res.time_user);
times_system.push(res.time_system);
exit_codes.push(extract_exit_code(status));

all_succeeded = all_succeeded && success;

Expand All @@ -328,17 +351,19 @@ pub fn run_benchmark(

progress_bar.as_ref().map(|bar| bar.set_message(&msg));

let (res, success) = time_shell_command(
let (res, status) = time_shell_command(
&options.shell,
cmd,
options.show_output,
options.failure_action,
Some(shell_spawning_time),
)?;
let success = status.success();

times_real.push(res.time_real);
times_user.push(res.time_user);
times_system.push(res.time_system);
exit_codes.push(extract_exit_code(status));

all_succeeded = all_succeeded && success;

Expand Down Expand Up @@ -438,6 +463,7 @@ pub fn run_benchmark(
t_min,
t_max,
times_real,
exit_codes,
cmd.get_parameters()
.iter()
.map(|(name, value)| ((*name).to_string(), value.to_string()))
Expand Down
4 changes: 4 additions & 0 deletions src/hyperfine/export/asciidoc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ fn test_asciidoc_table_row() {
0.10745223440000001,
0.10697327940000001,
],
vec![0, 0, 0], // exit codes
BTreeMap::new(), // param
);

Expand Down Expand Up @@ -151,6 +152,7 @@ fn test_asciidoc_table_row_command_escape() {
0.10745223440000001,
0.10697327940000001,
],
vec![0, 0, 0], // exit codes
BTreeMap::new(), // param
);
let exps = format!(
Expand Down Expand Up @@ -185,6 +187,7 @@ fn test_asciidoc() {
5.0,
6.0,
vec![7.0, 8.0, 9.0],
vec![0, 0, 0],
{
let mut params = BTreeMap::new();
params.insert("foo".into(), "1".into());
Expand All @@ -202,6 +205,7 @@ fn test_asciidoc() {
15.0,
16.0,
vec![17.0, 18.0, 19.0],
vec![0, 0, 0],
{
let mut params = BTreeMap::new();
params.insert("foo".into(), "1".into());
Expand Down
4 changes: 3 additions & 1 deletion src/hyperfine/export/csv.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ impl Exporter for CsvExporter {

{
let mut headers: Vec<Cow<[u8]>> = [
// The list of times cannot be exported to the CSV file - omit it.
// The list of times and exit codes cannot be exported to the CSV file - omit them.
"command", "mean", "stddev", "median", "user", "system", "min", "max",
]
.iter()
Expand Down Expand Up @@ -68,6 +68,7 @@ fn test_csv() {
5.0,
6.0,
vec![7.0, 8.0, 9.0],
vec![0, 0, 0],
{
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
Expand All @@ -85,6 +86,7 @@ fn test_csv() {
15.0,
16.5,
vec![17.0, 18.0, 19.0],
vec![0, 0, 0],
{
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
Expand Down
8 changes: 8 additions & 0 deletions src/hyperfine/export/markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ fn test_markdown_format_ms() {
0.1023, // min
0.1080, // max
vec![0.1, 0.1, 0.1], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand All @@ -115,6 +116,7 @@ fn test_markdown_format_ms() {
2.0020, // min
2.0080, // max
vec![2.0, 2.0, 2.0], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand Down Expand Up @@ -150,6 +152,7 @@ fn test_markdown_format_s() {
2.0020, // min
2.0080, // max
vec![2.0, 2.0, 2.0], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand All @@ -163,6 +166,7 @@ fn test_markdown_format_s() {
0.1023, // min
0.1080, // max
vec![0.1, 0.1, 0.1], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand Down Expand Up @@ -197,6 +201,7 @@ fn test_markdown_format_time_unit_s() {
0.1023, // min
0.1080, // max
vec![0.1, 0.1, 0.1], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand All @@ -210,6 +215,7 @@ fn test_markdown_format_time_unit_s() {
2.0020, // min
2.0080, // max
vec![2.0, 2.0, 2.0], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand Down Expand Up @@ -250,6 +256,7 @@ fn test_markdown_format_time_unit_ms() {
2.0020, // min
2.0080, // max
vec![2.0, 2.0, 2.0], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand All @@ -263,6 +270,7 @@ fn test_markdown_format_time_unit_ms() {
0.1023, // min
0.1080, // max
vec![0.1, 0.1, 0.1], // times
vec![0, 0, 0], // exit codes
BTreeMap::new(), // parameter
));

Expand Down
1 change: 1 addition & 0 deletions src/hyperfine/internal.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ fn create_result(name: &str, mean: Scalar) -> BenchmarkResult {
min: mean,
max: mean,
times: None,
exit_codes: Vec::new(),
parameters: BTreeMap::new(),
}
}
Expand Down
5 changes: 5 additions & 0 deletions src/hyperfine/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,9 @@ pub struct BenchmarkResult {
#[serde(skip_serializing_if = "Option::is_none")]
pub times: Option<Vec<Second>>,

/// All run exit codes
pub exit_codes: Vec<i32>,

/// Any parameter values used
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub parameters: BTreeMap<String, String>,
Expand All @@ -285,6 +288,7 @@ impl BenchmarkResult {
min: Second,
max: Second,
times: Vec<Second>,
exit_codes: Vec<i32>,
parameters: BTreeMap<String, String>,
) -> Self {
BenchmarkResult {
Expand All @@ -297,6 +301,7 @@ impl BenchmarkResult {
min,
max,
times: Some(times),
exit_codes,
parameters,
}
}
Expand Down