let opt_files = ref ([] : string list) let opt_taken = ref ([] : string list) let opt_taken_list = ref ([] : string list) let opt_all = ref "all_branches" let opt_tab_width = ref 4 let opt_index = ref None let opt_index_default = ref None let opt_prefix = ref "" let opt_cumulative_table = ref None let opt_histogram = ref false let opt_cumulative_histogram = ref None let opt_colour_count = ref false type color = { hue: int; saturation: int; } let opt_bad_color = ref { hue = 0; saturation = 85 } let opt_good_color = ref { hue = 120; saturation = 85 } let opt_darken = ref 5 let clamp_degree n = max 0 (min n 360) let clamp_percent n = max 0 (min n 100) let use_alt_colors () = opt_good_color := { !opt_good_color with hue = 220 }; opt_bad_color := { !opt_good_color with hue = 50 } let options = Arg.align [ ( "-t", Arg.String (fun str -> opt_taken := str::!opt_taken), " coverage information for branches taken while executing the model (default: sail_coverage)"); ( "--taken", Arg.String (fun str -> opt_taken := str::!opt_taken), " long form of -t"); ( "--taken-list", Arg.String (fun str -> opt_taken_list := str::!opt_taken_list), " file containing a list of filenames of branches taken"); ( "-a", Arg.String (fun str -> opt_all := str), " information about all possible branches (default: all_branches)"); ( "--all", Arg.String (fun str -> opt_all := str), " long form of -a"); ( "--tab-width", Arg.Int (fun n -> opt_tab_width := n), " set the tab width for html output (default: 4)"); ( "--index", Arg.String (fun str -> opt_index := Some str), " create a .html page as an index"); ( "--index-default", Arg.String (fun str -> opt_index_default := Some str), " The .sail file that will be displayed by the generated index page by default"); ( "--prefix", Arg.String (fun str -> opt_prefix := str), " Prepend a prefix to all generated html coverage files"); ( "--covered-hue", Arg.Int (fun n -> opt_good_color := { !opt_good_color with hue = clamp_degree n }), " set the hue (between 0 and 360) of the color used for code that is covered (default: 120 (green))"); ( "--uncovered-hue", Arg.Int (fun n -> opt_bad_color := { !opt_bad_color with hue = clamp_degree n }), " set the hue (between 0 and 360) of the color used for code that is not covered (default: 0 (red))"); ( "--covered-saturation", Arg.Int (fun n -> opt_good_color := { !opt_good_color with saturation = clamp_percent n }), " set the saturation (between 0 and 100) of the color used for code that is covered (default: 85)"); ( "--uncovered-saturation", Arg.Int (fun n -> opt_bad_color := { !opt_bad_color with saturation = clamp_percent n }), " set the hue (between 0 and 100) of the color used for code that is not covered (default: 85)"); ( "--nesting-darkness", Arg.Int (fun n -> opt_darken := n), " factor which controls how much darker nested spans of the same color become (default: 5)"); ( "--alt-colors", Arg.Unit use_alt_colors, " swap default colors from red/green into alternate yellow/blue theme"); ( "--alt-colours", Arg.Unit use_alt_colors, ""); ( "--cumulative-table", Arg.String (fun str -> opt_cumulative_table := Some str), " write a table of cumulative coverage to file"); ( "--histogram", Arg.Set opt_histogram, "display a histogram of the coverage level"); ( "--cumulative-histogram", Arg.String (fun str -> opt_cumulative_histogram := Some str), " write a table of cumulative histograms to file"); ( "--color-by-count", Arg.Set opt_colour_count, "color by number of files a span appears in (instead of nesting depth)"); ( "--colour-by-count", Arg.Set opt_colour_count, "colour by number of files a span appears in (instead of nesting depth)"); ] type span = { l1 : int; c1 : int; l2 : int; c2 : int; } let string_of_span file span = Printf.sprintf "\"%s\" %d:%d - %d:%d" file span.l1 span.c1 span.l2 span.c2 module Span = struct type t = span let compare s1 s2 = if s1.l1 < s2.l1 then -1 else if s1.l1 > s2.l1 then 1 else if s1.c1 < s2.c1 then -1 else if s1.c1 > s2.c1 then 1 else if s1.l2 < s2.l2 then -1 else if s1.l2 > s2.l2 then 1 else if s1.c2 < s2.c2 then -1 else if s1.c2 > s2.c2 then 1 else 0 end module SpanSet = Set.Make(Span) module SpanMap = Map.Make(Span) module StringMap = Map.Make(String) module IntMap = Map.Make(Int) let add_span spans _ file l1 c1 l2 c2 = StringMap.update (Filename.basename file) (fun x -> let file_spans = Option.value x ~default:SpanMap.empty in Some (SpanMap.update { l1 = l1; c1 = c1; l2 = l2; c2 = c2 } (function None -> Some 1 | Some i -> Some (i+1)) file_spans)) spans let read_more_coverage filename spans = let spans = ref spans in let chan = open_in filename in try let rec loop () = let line = input_line chan in spans := Scanf.sscanf line "%c %S, %d, %d, %d, %d" (add_span !spans); loop () in loop () with End_of_file -> close_in chan; !spans let read_coverage filename = read_more_coverage filename StringMap.empty (** We color the source either red (bad) or green (good) if it's covered vs uncovered. If we have nested uncovered branches, they will be increasingly bad, whereas nested covered branches will be increasingly good. *) type source_char = { mutable badness : int; mutable goodness : int; mutable bad_zero_width: bool; char : char; } let zero_width span = span.l1 = span.l2 && span.c1 = span.c2 let mark_bad_region source span _ = if zero_width span then ( source.(span.l2 - 1).(span.c2 - 1).bad_zero_width <- true ) else ( source.(span.l1 - 1).(span.c1).badness <- source.(span.l1 - 1).(span.c1).badness + 1; source.(span.l2 - 1).(span.c2 - 1).badness <- source.(span.l2 - 1).(span.c2 - 1).badness - 1 ) let mark_good_region source span _ = if not (zero_width span) then ( source.(span.l1 - 1).(span.c1).goodness <- source.(span.l1 - 1).(span.c1).goodness + 1; source.(span.l2 - 1).(span.c2 - 1).goodness <- source.(span.l2 - 1).(span.c2 - 1).goodness - 1 ) let process_line l = Array.init (String.length l) (fun n -> { badness = 0; goodness = 0; char = l.[n]; bad_zero_width = false }) let read_source filename = let lines = ref [] in let chan = open_in filename in try let rec loop () = lines := process_line (input_line chan) :: !lines; loop () in loop () with End_of_file -> close_in chan; Array.of_list (List.rev !lines) let output_html_char chan c = if c == ' ' then output_string chan " " else if c == '<' then output_string chan "<" else if c == '>' then output_string chan ">" else if c == '"' then output_string chan """ else if c == '\t' then output_string chan (String.concat "" (List.init !opt_tab_width (fun _ -> " "))) else output_char chan c let file_info file all taken = let diff span all_count taken_count = match all_count, taken_count with | Some _, Some _ -> None | Some n, None -> Some n | None, Some _ -> begin Printf.eprintf "Warning: span not in all branches file: %s\n" (string_of_span file span); None end | None, None -> None in let not_taken = SpanMap.merge diff all taken in let percent = if SpanMap.cardinal all != 0 then let p = 100. *. (Float.of_int (SpanMap.cardinal taken) /. Float.of_int (SpanMap.cardinal all)) in Printf.sprintf "%.0f%%" p else "-" in taken, not_taken, Printf.sprintf "%s (%d/%d) %s" (Filename.basename file) (SpanMap.cardinal taken) (SpanMap.cardinal all) percent let index_css = " body, html { width: 100%; height: 100%; margin: 0; padding: 0; } table { width: 100%; height: 100%; margin: 0; padding: 0; border-collapse: collapse; overflow: hidden; } .left { width: 20%; } .left .scroll { height: 100vh; overflow-x: hidden; overflow-y: auto; } .right { width: 80%; } td { padding: 0; margin: 0; } tr { padding: 0; margin: 0; height: 100%; overflow-x: hidden; overflow-y: auto; } iframe { height: 100%; width: 100%; display: block; margin: 0; padding: 0; } " let html_file_for file = !opt_prefix ^ Filename.remove_extension (Filename.basename file) ^ ".html" let read_taken_files all = (* Initialise optional CSV outputs *) let table_chan = match !opt_cumulative_table with | Some table_name -> let table_chan = open_out table_name in List.iter (fun src_file -> Printf.fprintf table_chan "%s, " (Filename.basename src_file)) !opt_files; Printf.fprintf table_chan ",, Total\n"; Some table_chan | None -> None in let histograms_info = match !opt_cumulative_histogram with | Some file_name -> let chan = open_out file_name in Printf.fprintf chan "Total, File, sum"; for i = 1 to List.length !opt_files do Printf.fprintf chan ", %d" i done; output_char chan '\n'; let total_spans = StringMap.fold (fun _ spans n -> n + SpanMap.cardinal spans) all 0 in Some (chan, total_spans) | None -> None in (* Read each file, generating lines for CSV outputs if necessary *) let read_more filename (spans, i) = let new_spans = read_more_coverage filename spans in Option.iter (fun chan -> let counts = List.map (fun src_name -> let taken = Option.value ~default:SpanMap.empty (StringMap.find_opt (Filename.basename src_name) new_spans) in SpanMap.cardinal taken ) !opt_files in List.iter (fun i -> Printf.fprintf chan "%d, " i) counts; Printf.fprintf chan ",, %d\n" (List.fold_left (+) 0 counts) ) table_chan; Option.iter (fun (chan, total_spans) -> let histogram = StringMap.fold (fun _ spans histo -> SpanMap.fold (fun _ count histo -> IntMap.update count (function None -> Some 1 | Some i -> Some (i+1)) histo) spans histo) new_spans IntMap.empty in let sum = IntMap.fold (fun _ m n -> m + n) histogram 0 in Printf.fprintf chan "%d,%d,%d," total_spans i sum; for i = 1 to fst (IntMap.max_binding histogram) do Printf.fprintf chan "%d," (Option.value ~default:0 (IntMap.find_opt i histogram)) done; Printf.fprintf chan "\n" ) histograms_info; new_spans, i+1 in let spans, _ = List.fold_right read_more !opt_taken (StringMap.empty, 1) in (* Clean up *) Option.iter close_out table_chan; Option.iter (fun (c,_) -> close_out c) histograms_info; spans let get_file_spans filename all taken = let file = Filename.basename filename in let all = match StringMap.find_opt file all with | None -> Printf.eprintf "Warning: %s not found in coverage files\n" file; SpanMap.empty | Some s -> s in let taken = Option.value ~default:SpanMap.empty (StringMap.find_opt file taken) in all, taken let main () = let all = read_coverage !opt_all in let taken = read_taken_files all in List.iter (fun file -> let all, taken = get_file_spans file all taken in let taken, not_taken, desc = file_info file all taken in print_endline desc; if !opt_histogram && not (SpanMap.is_empty taken) then begin let histogram = SpanMap.fold (fun _ count m -> IntMap.update count (function None -> Some 1 | Some i -> Some (i+1)) m) taken IntMap.empty in Printf.printf "Files | Number of spans\n"; IntMap.iter (fun count spans -> Printf.printf "%5d | %7d\n" count spans ) histogram end; let source = read_source file in SpanMap.iter (mark_good_region source) taken; SpanMap.iter (mark_bad_region source) not_taken; let output_file = html_file_for file in let chan = open_out output_file in let current_goodness = ref 0 in let current_badness = ref 0 in let clamp_lightness l = max 30 (min 80 l) in let html_color color darkness = Printf.sprintf "hsl(%d, %d%%, %d%%)" color.hue color.saturation (clamp_lightness ((80 + !opt_darken) - darkness * !opt_darken)) in let good_color () = html_color !opt_good_color !current_goodness in let bad_color () = html_color !opt_bad_color !current_badness in output_string chan "\n"; output_string chan "\n\n\n"; output_string chan (Printf.sprintf "%s" (Filename.remove_extension (Filename.basename file))); output_string chan "\n"; output_string chan "\n"; output_string chan (Printf.sprintf "

%s

\n" desc); output_string chan "\n"; if !opt_colour_count then let combined = SpanMap.merge (fun span present count -> match present, count with | None, _ -> Printf.eprintf "Span %s missing in all branches file %s" (string_of_span file span) !opt_all; None | Some _, None -> Some 0 | Some _, Some n -> Some n) all taken in (* The spans are ordered, so print forwards until we find the next span start or end (the ends of spans are held in the stack). TODO: check for lingering off-by-one errors. *) let rec process span count (stack, line, char) = (*Printf.eprintf "span %s line %d char %d\n" (string_of_span file span) line char;*) if span.l1 > line then match stack with | h::t when h.l2 = line -> for i = char to h.c2 - 1 do output_html_char chan source.(line - 1).(i).char done; output_string chan (Printf.sprintf ""); process span count (t, line, h.c2) | _ -> for i = char to Array.length (source.(line - 1)) - 1 do output_html_char chan source.(line - 1).(i).char done; output_string chan "
\n"; process span count (stack, line + 1, 0) else if span.l1 = line && span.c1 > char then match stack with | h::t when h.l2 = line && h.c2 < span.c1 -> for i = char to h.c2 - 1 do output_html_char chan source.(line - 1).(i).char done; output_string chan (Printf.sprintf ""); process span count (t, line, h.c2) | _ -> for i = char to span.c1 - 1 do output_html_char chan source.(line - 1).(i).char done; if span.c1 - 1 = Array.length source.(line - 1) then process span count (stack, line + 1, 0) else process span count (stack, line, span.c1) else let () = assert (span.l1 = line && span.c1 = char) in if zero_width span then begin output_string chan (Printf.sprintf "" (bad_color ())); output_string chan "«Invisible branch not taken here»"; output_string chan ""; (stack, line, char) end else begin let colour = if count = 0 then html_color !opt_bad_color 0 else html_color !opt_good_color count in output_string chan (Printf.sprintf "" count colour); (span::stack, line, char) end in let rec finish (stack, line, char) = (*Printf.eprintf "line %d char %d\n" line char;*) match stack with | h::t when h.l2 = line -> for i = char to h.c2 - 1 do output_html_char chan source.(line - 1).(i).char done; output_string chan (Printf.sprintf ""); finish (t, line, h.c2) | _ -> if line >= Array.length source then () else for i = char to Array.length (source.(line - 1)) - 1 do output_html_char chan source.(line - 1).(i).char done; output_string chan "
\n"; if line + 1 < Array.length source then finish (stack, line + 1, 0) else () in let (stack, line, char) = SpanMap.fold process combined ([], 1, 0) in finish (stack, line, char) else Array.iter (fun line -> Array.iter (fun loc -> if loc.goodness < 0 && loc.badness < 0 then ( output_html_char chan loc.char; current_goodness := !current_goodness + loc.goodness; current_badness := !current_badness + loc.badness; for _ = 1 to abs loc.goodness + abs loc.badness do output_string chan (Printf.sprintf "") done ) else if loc.goodness < 0 then ( assert (loc.badness >= 0); output_html_char chan loc.char; current_goodness := !current_goodness + loc.goodness; for _ = 1 to abs loc.goodness do output_string chan (Printf.sprintf "") done ) else if loc.badness < 0 then ( assert (loc.goodness >= 0); output_html_char chan loc.char; current_badness := !current_badness + loc.badness; for _ = 1 to abs loc.badness do output_string chan (Printf.sprintf "") done ) else if loc.badness > 0 then ( assert (loc.goodness <= 0); current_badness := !current_badness + loc.badness; for _ = 1 to loc.badness do output_string chan (Printf.sprintf "" (bad_color ())); done; output_html_char chan loc.char ) else if loc.goodness > 0 then ( assert (!current_badness == 0); current_goodness := !current_goodness + loc.goodness; for _ = 1 to loc.goodness do output_string chan (Printf.sprintf "" (good_color ())); done; output_html_char chan loc.char ) else ( output_html_char chan loc.char ); if loc.bad_zero_width then ( output_string chan (Printf.sprintf "" (bad_color ())); output_string chan "«Invisible branch not taken here»"; output_string chan "" ); assert (!current_goodness >= 0); assert (!current_badness >= 0) ) line; output_string chan "
\n" ) source; output_string chan "
\n"; output_string chan "\n"; output_string chan ""; close_out chan ) !opt_files; begin match !opt_index with | Some name -> let chan = open_out (name ^ ".html") in output_string chan "\n"; output_string chan "\n"; Printf.ksprintf (output_string chan) "\n\nCoverage Report\n\n\n" index_css; output_string chan "\n"; output_string chan ""; output_string chan "
"; List.iter (fun file -> let all, taken = get_file_spans file all taken in let _, _, desc = file_info file all taken in Printf.ksprintf (output_string chan) "%s
\n" (html_file_for file) desc ) !opt_files; output_string chan "
"; begin match !opt_index_default with | Some default_file -> Printf.ksprintf (output_string chan) "" (html_file_for default_file); | None -> output_string chan "" end; output_string chan "
\n"; output_string chan "\n"; output_string chan ""; close_out chan | None -> () end let usage_msg = "usage: sailcov -t -a <.sail files>\n" let read_taken_lists () = List.iter (fun filename -> let chan = open_in filename in try let rec loop () = opt_taken := (input_line chan)::!opt_taken; loop () in loop () with End_of_file -> ()) !opt_taken_list let _ = Arg.parse options (fun s -> opt_files := !opt_files @ [s]) usage_msg; read_taken_lists (); begin opt_taken := match !opt_taken with | [] -> ["sail_coverage"] | l -> List.rev l end; try main () with | Sys_error msg -> prerr_endline msg; exit 1