Fix to add default name and url for yaml

and add compared result summary log

Signed-off-by: Jiyeong Seok <[email protected]>

Author: dd-jy

src/fosslight_scanner/_run_compare.py

@@ -19,6 +19,7 @@
 ADD = "add"
 DELETE = "delete"
 CHANGE = "change"
+COMP_STATUS = [ADD, DELETE, CHANGE]
 
 
 def write_result_json_yaml(output_file, compared_result, file_ext):
@@ -93,10 +94,9 @@ def write_result_html(output_file, compared_result, before_yaml, after_yaml):
 
             table_html = f.find("table", {"id": "comp_result"})
 
-            status = [ADD, DELETE, CHANGE]
             row = 2
             MIN_ROW_NUM = 100
-            for st in status:
+            for st in COMP_STATUS:
                 for oi in compared_result[st]:
                     compared_row = parse_result_for_table(oi, st)
                     tr = f.new_tag('tr')
@@ -155,8 +155,7 @@ def write_result_xlsx(output_file, compared_result):
         worksheet.write_row(0, 0, HEADER, bold)
 
         row = 1
-        status = [ADD, DELETE, CHANGE]
-        for st in status:
+        for st in COMP_STATUS:
             for oi in compared_result[st]:
                 compared_row = parse_result_for_table(oi, st)
                 worksheet.write_row(row, 0, compared_row)
@@ -215,6 +214,16 @@ def get_comparison_result_filename(output_path, output_file, output_extension, _
     return result_file
 
 
+def count_compared_result(compared_result):
+    comp_len = [len(compared_result[st]) for st in COMP_STATUS]
+    if sum(comp_len) == 0:
+        count_str = "all oss lists are the same."
+    else:
+        count_str = f"total {sum(comp_len)} oss updated ("
+        count_str += ', '.join([f"{COMP_STATUS[x]}: {comp_len[x]}" for x in range(0, 3)]) + ")"
+    logger.info(f"Comparison result: {count_str}")
+
+
 def run_compare(before_yaml, after_yaml, output_path, output_file, file_ext, _start_time):
     ret = False
     logger.info("Start compare mode")
@@ -224,6 +233,7 @@ def run_compare(before_yaml, after_yaml, output_path, output_file, file_ext, _st
     result_file = get_comparison_result_filename(output_path, output_file, file_ext, _start_time)
     compared_result = compare_yaml(before_yaml, after_yaml)
     if compared_result != '':
+        count_compared_result(compared_result)
         ret, result_file = write_compared_result(result_file, compared_result, file_ext, before_yaml, after_yaml)
         if ret:
             logger.info(f"Success to write compared result: {result_file}")

src/fosslight_scanner/common.py

@@ -159,7 +159,7 @@ def overwrite_excel(excel_file_path, oss_name, column_name='OSS Name'):
             logger.debug(f"overwrite_excel:{ex}")
 
 
-def merge_yamls(_output_dir, merge_yaml_files, final_report):
+def merge_yamls(_output_dir, merge_yaml_files, final_report, remove_src_data=False, default_oss_name='', url=''):
     success = True
     err_msg = ''
 
@@ -169,11 +169,21 @@ def merge_yamls(_output_dir, merge_yaml_files, final_report):
         for mf in merge_yaml_files:
             if os.path.exists(os.path.join(_output_dir, mf)):
                 oss_list, license_list = parsing_yml(os.path.join(_output_dir, mf), _output_dir)
+
+                if remove_src_data:
+                    existed_yaml = {}
+                    for oi in oss_list:
+                        oi.name = default_oss_name if oi.name == '-' else oi.name
+                        oi.download_location = url if oi.download_location == '' else oi.download_location
+                        create_yaml_with_ossitem(oi, existed_yaml)
+                    with open(os.path.join(_output_dir, mf), 'w') as f:
+                        yaml.dump(existed_yaml, f, default_flow_style=False, sort_keys=False)
+
                 oss_total_list.extend(oss_list)
 
         if oss_total_list != []:
-            for oi in oss_total_list:
-                create_yaml_with_ossitem(oi, yaml_dict)
+            for oti in oss_total_list:
+                create_yaml_with_ossitem(oti, yaml_dict)
             with open(os.path.join(_output_dir, final_report), 'w') as f:
                 yaml.dump(yaml_dict, f, default_flow_style=False, sort_keys=False)
         else:

src/fosslight_scanner/fosslight_scanner.py

@@ -130,7 +130,6 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
                             "BIN": f"FL_Binary{output_extension}",
                             "BIN_TXT": "FL_Binary.txt",
                             "DEP": f"FL_Dependency{output_extension}",
-
                             "PRECHECKER": "FL_Prechecker.yaml"}
             if run_prechecker:
                 output_prechecker = os.path.join(_output_dir, output_files["PRECHECKER"])
@@ -197,7 +196,8 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
             success, err_msg = merge_excels(_output_dir, final_report)
         elif output_extension == ".yaml":
             merge_yaml_files = [output_files["SRC"], output_files["BIN"], output_files["DEP"]]
-            success, err_msg = merge_yamls(_output_dir, merge_yaml_files, final_report)
+            success, err_msg = merge_yamls(_output_dir, merge_yaml_files, final_report,
+                                           remove_src_data, default_oss_name, url)
 
         if success:
             result_log["Output File"] = final_report