Merge pull request #138 from fosslight/temp

Add yaml error reason to file name

Author: bjk7119

requirements.txt

@@ -3,4 +3,4 @@ binaryornot
 requests
 reuse
 PyYAML
-fosslight_util>=1.4.14
+fosslight_util>=1.4.16

src/fosslight_oss_pkg/_parsing_excel.py

@@ -46,7 +46,11 @@ def convert_yml_to_excel(oss_yaml_files, output_file, file_option_on, base_path)
 
                 if file_option_on:
                     base_path = os.path.dirname(yaml_file)
-                oss_items, _ = parsing_yml(yaml_file, base_path)
+                oss_items, _, _ = parsing_yml(yaml_file, base_path)
+                # if oss_items is abnormal(empty or invalid)
+                if not oss_items:
+                    continue
+
                 for item in oss_items:
                     items_to_print.extend(item.get_print_array())
                 if not base_path.endswith(f"{os.sep}"):

src/fosslight_prechecker/_add.py

@@ -323,7 +323,7 @@ def download_oss_info_license(base_path, input_license=""):
         logger.info(f"\n # There is OSS Package Info file(s) : {oss_yaml_files}\n")
 
     for oss_pkg_file in oss_yaml_files:
-        _, license_list = parsing_yml(oss_pkg_file, base_path)
+        _, license_list, _ = parsing_yml(oss_pkg_file, base_path)
 
     for lic in license_list:
         converted_lic_list.append(check_input_license_format(lic))

src/fosslight_prechecker/_result.py

@@ -239,8 +239,14 @@ def exclude_file_in_yaml(path_to_find, yaml_files, license_missing_files, copyri
     excluded_path = []
     lic_present_path = []
     cop_present_path = []
+    abnormal_yaml_files = {}
+
     for file in yaml_files:
-        oss_items, _ = parsing_yml(file, path_to_find)
+        oss_items, _, err_reason = parsing_yml(file, path_to_find, False)
+        # if oss_items is abnormal(empty or invalid)
+        if not oss_items:
+            abnormal_yaml_files[file] = err_reason
+
         for oss_item in oss_items:
             if oss_item.exclude:
                 excluded_path.extend(get_path_in_yaml(oss_item))
@@ -255,7 +261,7 @@ def exclude_file_in_yaml(path_to_find, yaml_files, license_missing_files, copyri
     license_missing_files = extract_files_in_path(lic_present_path, list(license_missing_files - set(files_with_exclude_removed)))
     copyright_missing_files = extract_files_in_path(cop_present_path, list(copyright_missing_files - set(files_with_exclude_removed)))
 
-    return license_missing_files, copyright_missing_files
+    return license_missing_files, copyright_missing_files, abnormal_yaml_files
 
 
 def get_total_file_list(path_to_find, prj_report, exclude_files):
@@ -266,12 +272,33 @@ def get_total_file_list(path_to_find, prj_report, exclude_files):
     return total_files_excluded
 
 
+def add_reason_to_file_name(oss_pkg_info_files, abnormal_yaml_files, path_to_find):
+    if not path_to_find.endswith('/'):
+        path_to_find += '/'
+
+    for key, val in abnormal_yaml_files.items():
+        file_name = key.replace(path_to_find, '', 1)
+        if file_name in oss_pkg_info_files:
+            oss_pkg_info_files.remove(file_name)
+            if val == "yaml_error":
+                file_name += " (Yaml format error)"
+            elif val == "not_supported":
+                file_name += " (Not supported format)"
+            elif val == "empty":
+                file_name += " (Empty)"
+            else:
+                file_name += " (Unknown error)"
+            oss_pkg_info_files.append(file_name)
+    return oss_pkg_info_files
+
+
 def result_for_summary(path_to_find, oss_pkg_info_files, license_missing_files, copyright_missing_files,
                        prj_report, _result_log, _check_only_file_mode, file_to_check_list, error_items, exclude_files):
     prechecker_compliant = False
     detected_lic = []
     missing_both_files = []
     file_total_num = ""
+    abnormal_yaml_files = {}
 
     if _check_only_file_mode:
         file_total_num = len(file_to_check_list)
@@ -286,12 +313,16 @@ def result_for_summary(path_to_find, oss_pkg_info_files, license_missing_files,
     if oss_pkg_info_files:
         oss_yaml_files = find_sbom_yaml_files(path_to_find)
         # Exclude files in yaml
-        license_missing_files, copyright_missing_files = exclude_file_in_yaml(path_to_find, oss_yaml_files,
-                                                                              set(license_missing_files) - set(oss_pkg_info_files),
-                                                                              set(copyright_missing_files) - set(oss_pkg_info_files))
+        license_missing_files, copyright_missing_files, abnormal_yaml_files \
+            = exclude_file_in_yaml(path_to_find, oss_yaml_files,
+                                   set(license_missing_files) - set(oss_pkg_info_files),
+                                   set(copyright_missing_files) - set(oss_pkg_info_files))
         # Subtract excluded files(untracked or ignored file)
         oss_pkg_info_files = list(set(oss_pkg_info_files) - set(exclude_files))
 
+    # Add invalid format to file name
+    oss_pkg_info_files = add_reason_to_file_name(oss_pkg_info_files, abnormal_yaml_files, path_to_find)
+
     if len(license_missing_files) == 0 and len(copyright_missing_files) == 0:
         prechecker_compliant = True