Skip to content

added an option --show-output-paths to silence the file paths details #191

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

Open
yarukha wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added an option --show-output-paths to silence the file paths details #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 26 additions & 10 deletions core/Cmd.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ type conf = {
(* Run and Status *)
intro : string;
show_output : bool;
show_output_paths : bool;
autoclean : bool;
full_stack_backtrace : bool;
max_inline_log_bytes : int option;
Expand Down Expand Up @@ -66,6 +67,7 @@ let default_conf =
filter_by_tag = None;
env = [];
show_output = false;
show_output_paths = true;
autoclean = false;
full_stack_backtrace = false;
max_inline_log_bytes = Some default_max_inline_log_bytes;
Expand Down Expand Up @@ -142,7 +144,7 @@ let run_with_conf ((get_tests, handle_subcommand_result) : _ test_spec)
~filter_by_substring:conf.filter_by_substring
~filter_by_tag:conf.filter_by_tag ~intro:conf.intro
~is_worker:conf.is_worker ~jobs:conf.jobs ~lazy_:conf.lazy_ ~orig_cwd
~slice:conf.slice ~strict:conf.strict
~show_output_paths:conf.show_output_paths ~slice:conf.slice ~strict:conf.strict
~test_list_checksum:conf.test_list_checksum tests
(fun exit_code tests_with_status ->
handle_subcommand_result exit_code (Run_result tests_with_status))
Expand All @@ -165,7 +167,8 @@ let run_with_conf ((get_tests, handle_subcommand_result) : _ test_spec)
~autoclean:conf.autoclean
~filter_by_substring:conf.filter_by_substring
~filter_by_tag:conf.filter_by_tag ~intro:conf.intro
~output_style:conf.status_output_style ~strict:conf.strict
~output_style:conf.status_output_style
~show_output_paths:conf.show_output_paths ~strict:conf.strict
(get_tests conf.env)
in
handle_subcommand_result exit_code (Status_result tests_with_status)
Expand Down Expand Up @@ -270,6 +273,15 @@ let show_output_term : bool Term.t =
in
Arg.value (Arg.flag info)

let no_output_paths_term : bool Term.t =
let info =
Arg.info [ "no-output-paths" ]
~doc:
"Do not show the paths to captured and expected output files after \
each test."
in
Arg.value (Arg.flag info)

let nonnegative_int_limit =
let parse_nonnegative_int_limit str =
match str with
Expand Down Expand Up @@ -480,8 +492,8 @@ let optional_nonempty_list xs =
let subcmd_run_term ~default_workers ocaml_conf (test_spec : _ test_spec) :
unit Term.t =
let combine autoclean chdir debug env expert filter_by_substring filter_by_tag
jobs lazy_ max_inline_log_bytes show_output slice stack_backtrace strict
test_list_checksum verbose worker =
jobs lazy_ max_inline_log_bytes no_output_paths show_output slice
stack_backtrace strict test_list_checksum verbose worker =
let filter_by_substring = optional_nonempty_list filter_by_substring in
let intro = if expert then "" else default_conf.intro in
let show_output = show_output || verbose in
Expand All @@ -508,6 +520,7 @@ let subcmd_run_term ~default_workers ocaml_conf (test_spec : _ test_spec) :
max_inline_log_bytes;
ocaml_conf;
show_output;
show_output_paths = not no_output_paths;
slice;
strict;
test_list_checksum;
Expand All @@ -518,8 +531,9 @@ let subcmd_run_term ~default_workers ocaml_conf (test_spec : _ test_spec) :
const combine $ autoclean_term $ chdir_term $ debug_term $ env_term
$ expert_term $ filter_by_substring_term $ filter_by_tag_term
$ jobs_term ~default_workers $ lazy_term $ max_inline_log_bytes_term
$ show_output_term $ slice_term $ stack_backtrace_term $ strict_term
$ test_list_checksum_term $ verbose_run_term $ worker_term)
$ no_output_paths_term $ show_output_term $ slice_term
$ stack_backtrace_term $ strict_term $ test_list_checksum_term
$ verbose_run_term $ worker_term)

let subcmd_run ~default_workers ocaml_conf test_spec =
let info = Cmd.info "run" ~doc:run_doc ~man:run_man in
Expand Down Expand Up @@ -563,8 +577,8 @@ let status_doc = "show test status"

let subcmd_status_term ocaml_conf tests : unit Term.t =
let combine all autoclean chdir debug env expert filter_by_substring
filter_by_tag long max_inline_log_bytes show_output stack_backtrace strict
verbose =
filter_by_tag long max_inline_log_bytes no_output_paths show_output
stack_backtrace strict verbose =
let filter_by_substring = optional_nonempty_list filter_by_substring in
let intro = if expert then "" else default_conf.intro in
let status_output_style : Run.status_output_style =
Expand Down Expand Up @@ -592,6 +606,7 @@ let subcmd_status_term ocaml_conf tests : unit Term.t =
max_inline_log_bytes;
ocaml_conf;
show_output;
show_output_paths = not no_output_paths;
status_output_style;
strict;
}
Expand All @@ -600,8 +615,9 @@ let subcmd_status_term ocaml_conf tests : unit Term.t =
Term.(
const combine $ all_term $ autoclean_term $ chdir_term $ debug_term
$ env_term $ expert_term $ filter_by_substring_term $ filter_by_tag_term
$ long_term $ max_inline_log_bytes_term $ show_output_term
$ stack_backtrace_term $ strict_term $ verbose_status_term)
$ long_term $ max_inline_log_bytes_term $ no_output_paths_term
$ show_output_term $ stack_backtrace_term $ strict_term
$ verbose_status_term)

let subcmd_status ocaml_conf tests =
let info = Cmd.info "status" ~doc:status_doc in
Expand Down
98 changes: 50 additions & 48 deletions core/Run.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ let truncate_backtrace ~full_stack_backtrace msg =
\ ... (for the full stack backtrace, use --stack-backtrace, -v, or \
--verbose)"

let print_status ~highlight_test
let print_status ~highlight_test ~show_output_paths
~always_show_unchecked_output:
(always_show_unchecked_output, max_inline_log_bytes, full_stack_backtrace)
(((test : T.test), (status : T.status), sum) as test_with_status) =
Expand Down Expand Up @@ -709,27 +709,28 @@ let print_status ~highlight_test
| Should_succeed -> ()
| Should_fail reason ->
printf "%sExpected to fail: %s\n" bullet reason);
(match test.checked_output with
| Ignore_output -> ()
| _ ->
let text =
match test.checked_output with
| Ignore_output -> Error.assert_false ~__LOC__ ()
| Stdout _ -> "stdout"
| Stderr _ -> "stderr"
| Stdxxx _ -> "merged stdout and stderr"
| Split_stdout_stderr _ -> "separate stdout and stderr"
in
printf "%sChecked output: %s\n" bullet text);
(match test.checked_output_files with
| [] -> ()
| xs ->
let names =
Helpers.list_map (fun (x : T.checked_output_file) -> x.name) xs
in
printf "%sChecked output file%s: %s\n" bullet
(if_plural (List.length names) "s")
(String.concat ", " names));
if show_output_paths then (
(match test.checked_output with
| Ignore_output -> ()
| _ ->
let text =
match test.checked_output with
| Ignore_output -> Error.assert_false ~__LOC__ ()
| Stdout _ -> "stdout"
| Stderr _ -> "stderr"
| Stdxxx _ -> "merged stdout and stderr"
| Split_stdout_stderr _ -> "separate stdout and stderr"
in
printf "%sChecked output: %s\n" bullet text);
match test.checked_output_files with
| [] -> ()
| xs ->
let names =
Helpers.list_map (fun (x : T.checked_output_file) -> x.name) xs
in
printf "%sChecked output file%s: %s\n" bullet
(if_plural (List.length names) "s")
(String.concat ", " names));
(* Details about results *)
(match status.expectation.expected_output with
| Error (Missing_files [ path ]) ->
Expand Down Expand Up @@ -775,7 +776,8 @@ let print_status ~highlight_test
(with_cwd [ missing_file ]))
| Ok _ -> ());
let capture_paths = Store.all_capture_paths_of_test test in
show_output_details test sum capture_paths;
if show_output_paths then
show_output_details test sum capture_paths;
let success = success_of_status_summary sum in
(* Show timeout info *)
(match (test.max_duration, success) with
Expand Down Expand Up @@ -893,10 +895,10 @@ let print_status ~highlight_test
()));
flush stdout

let print_statuses ~highlight_test ~always_show_unchecked_output
let print_statuses ~highlight_test ~show_output_paths ~always_show_unchecked_output
tests_with_status =
tests_with_status
|> List.iter (print_status ~highlight_test ~always_show_unchecked_output)
|> List.iter (print_status ~highlight_test ~show_output_paths ~always_show_unchecked_output)

(*
If anything's not perfect, consider it a failure.
Expand Down Expand Up @@ -944,19 +946,19 @@ let print_compact_status ?(important = false) ~strict tests_with_status =
if is_overall_success ~strict tests_with_status then Error.Exit_code.success
else Error.Exit_code.test_failure

let print_short_status ~always_show_unchecked_output tests_with_status =
let print_short_status ~show_output_paths ~always_show_unchecked_output tests_with_status =
let tests_with_status = List.filter is_important_status tests_with_status in
match tests_with_status with
| [] -> ()
| _ ->
print_statuses ~highlight_test:true ~always_show_unchecked_output
print_statuses ~highlight_test:true ~show_output_paths ~always_show_unchecked_output
tests_with_status

let print_long_status ~always_show_unchecked_output tests_with_status =
let print_long_status ~show_output_paths ~always_show_unchecked_output tests_with_status =
match tests_with_status with
| [] -> ()
| _ ->
print_statuses ~highlight_test:false ~always_show_unchecked_output
print_statuses ~highlight_test:false ~show_output_paths ~always_show_unchecked_output
tests_with_status

let handle_dead_snapshots ~autoclean ~report_dead_snapshots all_tests =
Expand Down Expand Up @@ -1021,19 +1023,19 @@ let print_status_summary ~autoclean ~report_dead_snapshots ~strict tests
if overall_success then Error.Exit_code.success
else Error.Exit_code.test_failure

let print_all_statuses ~always_show_unchecked_output ~autoclean ~intro
let print_all_statuses ~show_output_paths ~always_show_unchecked_output ~autoclean ~intro
~report_dead_snapshots tests tests_with_status =
print_introduction intro;
print_newline ();
print_long_status ~always_show_unchecked_output tests_with_status;
print_long_status ~show_output_paths ~always_show_unchecked_output tests_with_status;
print_newline ();
print_short_status ~always_show_unchecked_output tests_with_status;
print_short_status ~show_output_paths ~always_show_unchecked_output tests_with_status;
print_status_summary ~autoclean ~report_dead_snapshots tests tests_with_status

let print_important_statuses ~always_show_unchecked_output ~autoclean
let print_important_statuses ~show_output_paths ~always_show_unchecked_output ~autoclean
~report_dead_snapshots ~strict tests tests_with_status : int =
(* Print details about each test that needs attention *)
print_short_status ~always_show_unchecked_output tests_with_status;
print_short_status ~show_output_paths ~always_show_unchecked_output tests_with_status;
print_status_summary ~autoclean ~report_dead_snapshots ~strict tests
tests_with_status

Expand All @@ -1047,17 +1049,17 @@ let get_tests_with_status tests = tests |> Helpers.list_map get_test_with_status
Entry point for the 'status' subcommand
*)
let cmd_status ~always_show_unchecked_output ~autoclean ~filter_by_substring
~filter_by_tag ~intro ~output_style ~strict tests =
~filter_by_tag ~intro ~output_style ~show_output_paths ~strict tests =
check_test_definitions tests;
let selected_tests = filter ~filter_by_substring ~filter_by_tag tests in
let tests_with_status = get_tests_with_status selected_tests in
let exit_code =
match output_style with
| Long_all ->
print_all_statuses ~always_show_unchecked_output ~autoclean
print_all_statuses ~show_output_paths ~always_show_unchecked_output ~autoclean
~report_dead_snapshots:true ~intro ~strict tests tests_with_status
| Long_important ->
print_important_statuses ~always_show_unchecked_output ~autoclean
print_important_statuses ~show_output_paths ~always_show_unchecked_output ~autoclean
~report_dead_snapshots:true ~strict tests tests_with_status
| Compact_all ->
handle_dead_snapshots ~autoclean ~report_dead_snapshots:true tests;
Expand All @@ -1084,9 +1086,9 @@ let report_start_test (timers : Timers.t option)
| Some timers, Some worker -> Timers.add_test timers test worker
| _ -> (* bad combination *) Error.assert_false ~__LOC__ ()

let report_end_sequential_test ~always_show_unchecked_output test =
let report_end_sequential_test ~show_output_paths ~always_show_unchecked_output test =
get_test_with_status test
|> print_status ~highlight_test:false ~always_show_unchecked_output
|> print_status ~highlight_test:false ~show_output_paths ~always_show_unchecked_output

let report_skip_test test reason =
printf "%s%s\n%!"
Expand Down Expand Up @@ -1118,7 +1120,7 @@ let get_timed_out_workers timers =
Run tests and report progress. This is done in the main process when
running without worker processes ('-j 0' option).
*)
let run_tests_sequentially ~always_show_unchecked_output (tests : T.test list) :
let run_tests_sequentially ~show_output_paths ~always_show_unchecked_output (tests : T.test list) :
'unit_promise =
List.fold_left
(fun previous (test : T.test) ->
Expand All @@ -1136,7 +1138,7 @@ let run_tests_sequentially ~always_show_unchecked_output (tests : T.test list) :
| None ->
report_start_test None None test;
test_func () >>= fun () ->
report_end_sequential_test ~always_show_unchecked_output test;
report_end_sequential_test ~show_output_paths ~always_show_unchecked_output test;
P.return ())
(fun exn trace ->
(* For now, we abort in case of an internal error.
Expand Down Expand Up @@ -1218,12 +1220,12 @@ let before_run ~filter_by_substring ~filter_by_tag ~intro ~lazy_ ~slice tests =
selected_tests

(* Run this after a run or Lwt run. *)
let after_run ~always_show_unchecked_output ~autoclean ~strict tests
let after_run ~show_output_paths ~always_show_unchecked_output ~autoclean ~strict tests
selected_tests =
let tests_with_status = get_tests_with_status selected_tests in
let exit_code =
(* Print details about each test that needs attention *)
print_short_status ~always_show_unchecked_output tests_with_status;
print_short_status ~show_output_paths ~always_show_unchecked_output tests_with_status;
(* Print one line per test that needs attention *)
print_compact_status ~important:true ~strict tests_with_status |> ignore;
print_status_summary ~autoclean ~report_dead_snapshots:false ~strict tests
Expand Down Expand Up @@ -1255,8 +1257,8 @@ let ignore_broken_pipe () =
list of selected tests to the workers).
*)
let cmd_run ~always_show_unchecked_output ~argv ~autoclean ~filter_by_substring
~filter_by_tag ~intro ~is_worker ~jobs ~lazy_ ~orig_cwd ~slice ~strict
~test_list_checksum:expected_checksum tests cont =
~filter_by_tag ~intro ~is_worker ~jobs ~lazy_ ~orig_cwd ~show_output_paths
~slice ~strict ~test_list_checksum:expected_checksum tests cont =
if is_worker then (
ignore_broken_pipe ();
(*
Expand Down Expand Up @@ -1295,11 +1297,11 @@ let cmd_run ~always_show_unchecked_output ~argv ~autoclean ~filter_by_substring
| Some reason -> report_skip_test test reason
| None ->
get_test_with_status test
|> print_status ~highlight_test:false ~always_show_unchecked_output
|> print_status ~highlight_test:false ~show_output_paths ~always_show_unchecked_output
in
(* Run in the same process. This is for situations or platforms where
multiprocessing might not work for whatever reason. *)
run_tests_sequentially ~always_show_unchecked_output sequential_tests
run_tests_sequentially ~show_output_paths ~always_show_unchecked_output sequential_tests
>>= fun () ->
(if num_workers > 0 then
match
Expand All @@ -1317,7 +1319,7 @@ let cmd_run ~always_show_unchecked_output ~argv ~autoclean ~filter_by_substring
exit Error.Exit_code.internal_error);
P.return () >>= fun () ->
let exit_code, tests_with_status =
after_run ~always_show_unchecked_output ~autoclean ~strict tests
after_run ~show_output_paths ~always_show_unchecked_output ~autoclean ~strict tests
selected_tests
in
cont exit_code tests_with_status |> ignore;
Expand Down
2 changes: 2 additions & 0 deletions core/Run.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ val cmd_run :
jobs:int option ->
lazy_:bool ->
orig_cwd:Fpath.t option ->
show_output_paths:bool ->
slice:Testo_util.Slice.t list ->
strict:bool ->
test_list_checksum:string option ->
Expand All @@ -48,6 +49,7 @@ val cmd_status :
filter_by_tag:Testo_util.Tag_query.t option ->
intro:string ->
output_style:status_output_style ->
show_output_paths:bool ->
strict:bool ->
Types.test list ->
int * Types.test_with_status list
Expand Down