Updates requested in PR diffblue#50: using with for to open files.

Author: marek-trtik

security-scanner/analyser.py

@@ -26,7 +26,7 @@ def get_analyser_binary_pathname(analyser_name):
     return None
 
 
-def run_secutiry_analyser(
+def run_security_analyser(
         root_jar,
         transition_rules_file_pathname,
         timeout,
@@ -46,15 +46,13 @@ def run_secutiry_analyser(
     program_json_fname = os.path.abspath(os.path.join(results_dir, "program.json"))
     print("Building the program JSON file (the list of all JARs application consists of) for the 'goto-analyser': "
           + program_json_fname)
-    program_json_file = open(program_json_fname,"w")
-    program_jars_list = [ os.path.relpath(root_jar,results_dir) ]
-    program_json_file.write(json.dumps(program_jars_list,sort_keys=True,indent=4))
-    program_json_file.close()
+    with open(program_json_fname,"w") as program_json_file:
+        program_jars_list = [ os.path.relpath(root_jar,results_dir) ]
+        program_json_file.write(json.dumps(program_jars_list,sort_keys=True,indent=4))
 
     # Building the root config file for the security analyser
     root_config_json_fname = os.path.abspath(os.path.join(results_dir, "config.json"))
     print("Building the root config JSON file for 'goto-analyser': " + root_config_json_fname)
-    root_config_json_file = open(root_config_json_fname,"w")
     root_config_json = {
         "program": "./program.json",
         "rules": os.path.relpath(transition_rules_file_pathname,results_dir),
@@ -82,8 +80,8 @@ def run_secutiry_analyser(
         root_config_json["dump_html_program"] = True
     else:
         root_config_json["dump_html_program"] = False
-    root_config_json_file.write(json.dumps(root_config_json,sort_keys=True,indent=4))
-    root_config_json_file.close()
+    with open(root_config_json_fname,"w") as root_config_json_file:
+        root_config_json_file.write(json.dumps(root_config_json,sort_keys=True,indent=4))
 
     if not os.path.exists(results_dir):
         os.makedirs(results_dir)
@@ -124,6 +122,35 @@ def run_program_slicing(
     return prof
 
 
+def append_cbmc_error_trace_if_it_is_relevant(trace,trace_id,results_dir,cfg,traces_list):
+    last_rec = trace[-1]
+    if "sourceLocation" in last_rec:
+        loc = last_rec["sourceLocation"]
+        for sink in cfg["sinks"]:
+            if loc["file"] == sink["file"] and \
+                            loc["function"] == sink["function"] and \
+                            loc["line"] == str(sink["line"]):
+                trace_fname = os.path.join(results_dir, "error_trace_" + str(trace_id) + ".json")
+                with open(trace_fname, "w") as trace_file:
+                    trace_file.write(json.dumps(trace, sort_keys=False, indent=4))
+                trace_id += 1
+
+                found = False
+                for rec in traces_list:
+                    if rec["file"] == sink["file"] and \
+                                    rec["function"] == sink["function"] and \
+                                    rec["line"] == sink["line"] and \
+                                    rec["goto_binary_file"] == cfg["goto_binary_file"]:
+                        rec["error_traces"].append(trace_fname)
+                if found == False:
+                    rec = sink
+                    rec["goto_binary_file"] = cfg["goto_binary_file"]
+                    rec["error_traces"] = [trace_fname]
+                    traces_list.append(rec)
+                break
+    return trace_id
+
+
 def run_search_for_error_traces(
         json_cfg_fname,
         results_dir,
@@ -165,31 +192,13 @@ def run_search_for_error_traces(
                 for inner_element in outer_element["result"]:
                     if "trace" in inner_element and len(inner_element["trace"]) > 0:
                         trace=inner_element["trace"]
-                        last_rec=trace[len(trace)-1]
-                        if "sourceLocation" in last_rec:
-                            loc=last_rec["sourceLocation"]
-                            for sink in cfg["sinks"]:
-                                if loc["file"] == sink["file"] and \
-                                   loc["function"] == sink["function"] and \
-                                   loc["line"] == str(sink["line"]):
-                                    trace_fname = os.path.join(results_dir, "error_trace_" + str(trace_id) + ".json")
-                                    with open(trace_fname,"w") as trace_file:
-                                        trace_file.write(json.dumps(trace,sort_keys=False,indent=4))
-                                    trace_id += 1
-
-                                    found = False
-                                    for rec in traces_list:
-                                        if rec["file"] == sink["file"] and \
-                                           rec["function"] == sink["function"] and \
-                                           rec["line"] == sink["line"] and \
-                                           rec["goto_binary_file"] == cfg["goto_binary_file"]:
-                                            rec["error_traces"].append(trace_fname)
-                                    if found == False:
-                                        rec=sink
-                                        rec["goto_binary_file"]=cfg["goto_binary_file"]
-                                        rec["error_traces"]=[trace_fname]
-                                        traces_list.append(rec)
-                                    break
+                        trace_id = append_cbmc_error_trace_if_it_is_relevant(
+                                        trace,
+                                        trace_id,
+                                        results_dir,
+                                        cfg,
+                                        traces_list
+                                        )
 
     with open(os.path.join(results_dir, "error_traces.json"), "w") as traces_file:
         traces_file.write(json.dumps(traces_list, sort_keys=True, indent=4))

security-scanner/mkplot.py

@@ -5,109 +5,103 @@
 
 
 def load_input_JSON(filename):
-    file = open(filename,"r")
-    stats = json.load(file)
-    file.close()
+    with open(filename,"r") as file:
+        stats = json.load(file)
     return stats
 
 
 def build_data_file(stats,output_file_name):
-    file = open(output_file_name,"w")
-    num_functions = 0
-    num_locations = 0
-    time = 0.0
-    num_functions_per_second = 0
-    num_locations_per_second = 0
-    for file_stats in stats["table-files"]:
-        for fn_stats in file_stats["functions"]:
-            delta_time = fn_stats["LVSA-duration"] + fn_stats["TA-duration"]
-            #if delta_time > 1.0:
-            #    print("TIME[" + str(delta_time) + "]: " + fn_stats["function-name"])
-            #    continue
-            time = time + delta_time 
-            num_functions = num_functions + 1
-            num_locations = num_locations + fn_stats["num-locations"]
-            if time > 0.0001:
-                num_functions_per_second =  num_functions / time
-                num_locations_per_second =  num_locations / time
-            file.write(str(time) + "    " + \
-                       str(num_functions)  + "    " + \
-                       str(num_locations)  + "    " + \
-                       str(num_functions_per_second) + "    " + \
-                       str(num_locations_per_second) + "\n")  
-    file.close()
-    
+    with open(output_file_name,"w") as file:
+        num_functions = 0
+        num_locations = 0
+        time = 0.0
+        num_functions_per_second = 0
+        num_locations_per_second = 0
+        for file_stats in stats["table-files"]:
+            for fn_stats in file_stats["functions"]:
+                delta_time = fn_stats["LVSA-duration"] + fn_stats["TA-duration"]
+                #if delta_time > 1.0:
+                #    print("TIME[" + str(delta_time) + "]: " + fn_stats["function-name"])
+                #    continue
+                time = time + delta_time
+                num_functions = num_functions + 1
+                num_locations = num_locations + fn_stats["num-locations"]
+                if time > 0.0001:
+                    num_functions_per_second =  num_functions / time
+                    num_locations_per_second =  num_locations / time
+                file.write(str(time) + "    " + \
+                           str(num_functions)  + "    " + \
+                           str(num_locations)  + "    " + \
+                           str(num_functions_per_second) + "    " + \
+                           str(num_locations_per_second) + "\n")
+
 
 def build_functions_speed_plot_file(plot_file_name,data_file_name):
-    file = open(plot_file_name,"w")
-    file.write(
-            "set title \"Number of analysed functions per second.\"\n"
-            "set terminal svg font 'Liberation,10' size 550,480\n"
-            "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
-            "set xtic rotate\n"
-            "set ytic auto\n"
-            "set xlabel \"Time (sec)\"\n"
-            "set ylabel \"Speed (funcs/sec)\"\n"
-            "set grid\n"
-            "set style data lines\n"
-            "unset key\n"
-            "plot \"./" + os.path.basename(data_file_name) + "\" using 1:4 lt -1 lw 2\n"
-            )
-    file.close()
+    with open(plot_file_name,"w") as file:
+        file.write(
+                "set title \"Number of analysed functions per second.\"\n"
+                "set terminal svg font 'Liberation,10' size 550,480\n"
+                "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
+                "set xtic rotate\n"
+                "set ytic auto\n"
+                "set xlabel \"Time (sec)\"\n"
+                "set ylabel \"Speed (funcs/sec)\"\n"
+                "set grid\n"
+                "set style data lines\n"
+                "unset key\n"
+                "plot \"./" + os.path.basename(data_file_name) + "\" using 1:4 lt -1 lw 2\n"
+                )
 
 
 def build_locations_speed_plot_file(plot_file_name,data_file_name):
-    file = open(plot_file_name,"w")
-    file.write(
-            "set title \"Number of analysed lines per second.\"\n"
-            "set terminal svg font 'Liberation,10' size 550,480\n"
-            "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
-            "set xtic rotate\n"
-            "set ytic auto\n"
-            "set xlabel \"Time (sec)\"\n"
-            "set ylabel \"Speed (lines/sec)\"\n"
-            "set style data lines\n"
-            "set grid\n"
-            "unset key\n"
-            "plot \"./" + os.path.basename(data_file_name) + "\" using 1:5 lt -1 lw 2\n"
-            )
-    file.close()
+    with open(plot_file_name,"w") as file:
+        file.write(
+                "set title \"Number of analysed lines per second.\"\n"
+                "set terminal svg font 'Liberation,10' size 550,480\n"
+                "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
+                "set xtic rotate\n"
+                "set ytic auto\n"
+                "set xlabel \"Time (sec)\"\n"
+                "set ylabel \"Speed (lines/sec)\"\n"
+                "set style data lines\n"
+                "set grid\n"
+                "unset key\n"
+                "plot \"./" + os.path.basename(data_file_name) + "\" using 1:5 lt -1 lw 2\n"
+                )
 
 
 def build_functions_progress_plot_file(plot_file_name,data_file_name):
-    file = open(plot_file_name,"w")
-    file.write(
-            "set title \"Number of analysed functions in time.\"\n"
-            "set terminal svg font 'Liberation,10' size 550,480\n"
-            "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
-            "set xtic rotate\n"
-            "set ytic auto\n"
-            "set xlabel \"Time (sec)\"\n"
-            "set ylabel \"Functions (#)\"\n"
-            "set style data lines\n"
-            "set grid\n"
-            "unset key\n"
-            "plot \"./" + os.path.basename(data_file_name) + "\" using 1:2 lt -1 lw 2\n"
-            )
-    file.close()
-    
+    with open(plot_file_name,"w") as file:
+        file.write(
+                "set title \"Number of analysed functions in time.\"\n"
+                "set terminal svg font 'Liberation,10' size 550,480\n"
+                "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
+                "set xtic rotate\n"
+                "set ytic auto\n"
+                "set xlabel \"Time (sec)\"\n"
+                "set ylabel \"Functions (#)\"\n"
+                "set style data lines\n"
+                "set grid\n"
+                "unset key\n"
+                "plot \"./" + os.path.basename(data_file_name) + "\" using 1:2 lt -1 lw 2\n"
+                )
+
 
 def build_locations_progress_plot_file(plot_file_name,data_file_name):
-    file = open(plot_file_name,"w")
-    file.write(
-            "set title \"Number of analysed lines in time.\"\n"
-            "set terminal svg font 'Liberation,10' size 550,480\n"
-            "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
-            "set xtic rotate\n"
-            "set ytic auto\n"
-            "set xlabel \"Time (sec)\"\n"
-            "set ylabel \"Lines (#)\"\n"
-            "set style data lines\n"
-            "set grid\n"
-            "unset key\n"
-            "plot \"./" + os.path.basename(data_file_name) + "\" using 1:3 lt -1 lw 2\n"
-            )
-    file.close()
+    with open(plot_file_name,"w") as file:
+        file.write(
+                "set title \"Number of analysed lines in time.\"\n"
+                "set terminal svg font 'Liberation,10' size 550,480\n"
+                "set output './" + os.path.splitext(os.path.basename(plot_file_name))[0] + ".svg'\n"
+                "set xtic rotate\n"
+                "set ytic auto\n"
+                "set xlabel \"Time (sec)\"\n"
+                "set ylabel \"Lines (#)\"\n"
+                "set style data lines\n"
+                "set grid\n"
+                "unset key\n"
+                "plot \"./" + os.path.basename(data_file_name) + "\" using 1:3 lt -1 lw 2\n"
+                )
 
 
 def build_general_stats_text_file(stats,output_file_path_name):
@@ -122,19 +116,18 @@ def build_general_stats_text_file(stats,output_file_path_name):
     num_files = len(stats["table-files"])
     program_building_duration = stats["table-phases"]["goto-program-building"]
 
-    file = open(output_file_path_name,"w")
-    file.write("number of files = " + str(num_files) + "\n")
-    file.write("number of functions = " + str(num_functions) + "\n")
-    file.write("number of locations = " + str(num_locations) + "\n")
-    file.write("program parsing duration = " + str(program_building_duration) + "\n")
-    if num_files > 0: file.write("average parsing duration per file = " + str(program_building_duration / num_files) + "\n")
-    if num_functions > 0: file.write("average parsing duration per function = " + str(program_building_duration / num_functions) + "\n")
-    if num_locations > 0: file.write("average parsing duration per location = " + str(program_building_duration / num_locations) + "\n")
-    file.write("analysis duration = " + str(analysis_duration) + "\n")
-    if num_files > 0: file.write("average analysis duration per file = " + str(analysis_duration / num_files) + "\n")
-    if num_functions > 0: file.write("average analysis duration per function = " + str(analysis_duration / num_functions) + "\n")
-    if num_locations > 0: file.write("average analysis duration per location = " + str(analysis_duration / num_locations) + "\n")
-    file.close()
+    with open(output_file_path_name,"w") as file:
+        file.write("number of files = " + str(num_files) + "\n")
+        file.write("number of functions = " + str(num_functions) + "\n")
+        file.write("number of locations = " + str(num_locations) + "\n")
+        file.write("program parsing duration = " + str(program_building_duration) + "\n")
+        if num_files > 0: file.write("average parsing duration per file = " + str(program_building_duration / num_files) + "\n")
+        if num_functions > 0: file.write("average parsing duration per function = " + str(program_building_duration / num_functions) + "\n")
+        if num_locations > 0: file.write("average parsing duration per location = " + str(program_building_duration / num_locations) + "\n")
+        file.write("analysis duration = " + str(analysis_duration) + "\n")
+        if num_files > 0: file.write("average analysis duration per file = " + str(analysis_duration / num_files) + "\n")
+        if num_functions > 0: file.write("average analysis duration per function = " + str(analysis_duration / num_functions) + "\n")
+        if num_locations > 0: file.write("average analysis duration per location = " + str(analysis_duration / num_locations) + "\n")
 
 
 def make_plots(input_json,output_dir,do_build_svg):