Print environment info to log

Author: soimkim

requirements.txt

@@ -1,4 +1,5 @@
-scancode-toolkit<=21.2.25
+scancode-toolkit<=21.3.31
 typecode_libmagic
 XlsxWriter
-fosslight_util
+fosslight_util
+PyYAML

setup.py

@@ -14,7 +14,7 @@
 if __name__ == "__main__":
     setup(
         name='fosslight_source',
-        version='1.4.1',
+        version='1.4.2',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
         description='FOSSLight Source',

src/fosslight_source/_parsing_scancode_file_item.py

@@ -100,7 +100,7 @@ def parsing_file_item(scancode_file_list):
 
     rc = True
     scancode_file_item = []
-    logger.warn("|---TOTAL FILE COUNT:"+str(len(scancode_file_list)))
+    msg ="TOTAL FILE COUNT: "+str(len(scancode_file_list))+"\n"
 
     prev_dir = ""
     prev_dir_value = False
@@ -177,7 +177,7 @@ def parsing_file_item(scancode_file_list):
 
                     scancode_file_item.append(result_item)
         except Exception as ex:
-            logger.warn("Error Parsing item-"+str(ex))
+            msg += "* Error Parsing item:"+str(ex)
             rc = False
 
-    return rc, scancode_file_item
+    return rc, scancode_file_item, msg.strip()

src/fosslight_source/convert_scancode.py

@@ -12,15 +12,22 @@
 import logging
 import fosslight_util.constant as constant
 from fosslight_util.set_log import init_log
-
+from fosslight_util.set_log import init_log_item
+import yaml
 from ._write_oss_report_src import write_result_to_csv, write_result_to_excel
 from ._parsing_scancode_file_item import parsing_file_item
 
 logger = logging.getLogger(constant.LOGGER_NAME)
+_PKG_NAME = "fosslight_source"
+_ERROR_PREFIX = "* Error : "
 
 
 def convert_json_to_excel(scancode_json, excel_name, csv_name):
     file_list = []
+    _result_log = init_log_item(_PKG_NAME)
+    msg = ""
+    success = True
+
     try:
         sheet_list = {}
         if os.path.isfile(scancode_json):
@@ -44,13 +51,25 @@ def convert_json_to_excel(scancode_json, excel_name, csv_name):
 
         if len(sheet_list) > 0:
             write_result_to_excel(excel_name, sheet_list)
+            _result_log["OSS Report"] = excel_name
+
             if platform.system() != "Windows":
                 write_result_to_csv(csv_name, sheet_list)
         else:
-            logger.warn("There is no item to print in OSS-Report.")
+            msg = "There is no item to print in OSS-Report."
 
     except Exception as ex:
-        logger.warn(str(ex))
+        success = False
+        msg = _ERROR_PREFIX+str(ex)
+
+    scan_result_msg = str(success)+" "+msg
+    _result_log["Scan Result"] = scan_result_msg.strip()
+
+    try:
+        _str_final_result_log = yaml.safe_dump(_result_log, allow_unicode=True, sort_keys=True)
+        logger.warn("\n"+_str_final_result_log)
+    except Exception as ex:
+        logger.warn(_ERROR_PREFIX+"Failed to print result log. "+ str(ex))
 
     return file_list
 
@@ -61,9 +80,10 @@ def get_detected_licenses_from_scancode(scancode_json_file):
         logger.warn("Start parsing " + scancode_json_file)
         with open(scancode_json_file, "r") as st_json:
             st_python = json.load(st_json)
-            rc, file_list = parsing_file_item(st_python["files"])
+            rc, file_list, msg= parsing_file_item(st_python["files"])
+            logger.warn("|---"+msg)
     except Exception as error:
-        logger.warn("Error Parsing - "+str(error))
+        logger.warn(_ERROR_PREFIX+"Parsing -"+str(error))
     logger.warn("|---Number of files detected: " + str(len(file_list)))
     return file_list
 

src/fosslight_source/run_scancode.py

@@ -10,17 +10,20 @@
 import platform
 import getopt
 import logging
+import yaml
 from scancode import cli
 from datetime import datetime
 import fosslight_util.constant as constant
 from fosslight_util.set_log import init_log
+from fosslight_util.set_log import init_log_item
+from fosslight_util.timer_thread import TimerThread
 from ._write_oss_report_src import write_result_to_csv, write_result_to_excel
 from ._parsing_scancode_file_item import parsing_file_item
-from fosslight_util.timer_thread import TimerThread
 
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.filterwarnings("ignore", category=FutureWarning)
-
+_PKG_NAME = "fosslight_source"
+_ERROR_PREFIX = "* Error : "
 
 def print_help_msg():
     print("* Required : -p path_to_scan")
@@ -52,7 +55,7 @@ def main():
     timer = TimerThread()
     timer.setDaemon(True)
     timer.start()
-    success, msg = run_scan(_path_to_scan, _output_file, _write_json_file, -1)
+    success, result_log = run_scan(_path_to_scan, _output_file, _write_json_file, -1)
 
 
 def run_scan(path_to_scan, output_file_name="",
@@ -61,6 +64,8 @@ def run_scan(path_to_scan, output_file_name="",
 
     success = True
     msg = ""
+    _str_final_result_log = ""
+    _result_log = {}
 
     _windows = platform.system() == "Windows"
     start_time = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
@@ -77,6 +82,7 @@ def run_scan(path_to_scan, output_file_name="",
         output_dir = os.path.dirname(os.path.abspath(output_file_name))
 
     logger = init_log(os.path.join(output_dir, "fosslight_src_log_"+start_time+".txt"))
+    _result_log = init_log_item(_PKG_NAME, path_to_scan)
 
     if path_to_scan == "":
         if _windows:
@@ -102,29 +108,38 @@ def run_scan(path_to_scan, output_file_name="",
             if rc:
                 for key, value in results.items():
                     if key == "files":
-                        rc, result_list = parsing_file_item(value)
+                        rc, result_list, parsing_msg = parsing_file_item(value)
+                        _result_log["Parsing Log"] = parsing_msg
                         if rc:
                             if len(result_list) > 0:
                                 sheet_list["SRC"] = result_list
                                 write_result_to_excel(
                                     output_file + ".xlsx", sheet_list)
+                                _result_log["OSS Report"] = output_file
                             else:
                                 msg = "* There is no item"\
                                     " to print in OSS-Report."
                 if not _windows:
                     write_result_to_csv(output_csv_file + ".csv", sheet_list)
             else:
-                msg = "* Source code analysis failed."
+                msg = _ERROR_PREFIX+"Source code analysis failed."
                 success = False
         except Exception as ex:
             success = False
-            msg = '* Error :' + str(ex)
+            msg = _ERROR_PREFIX + str(ex)
     else:
         success = False
-        msg = "* Check the path to scan. :" + path_to_scan
+        msg = _ERROR_PREFIX+"Check the path to scan. :" + path_to_scan
 
-    logger.warn("* Scan Result:" + str(success)+"\n"+msg)
-    return success, msg
+    scan_result_msg = str(success)+" "+msg
+    _result_log["Scan Result"] = scan_result_msg.strip()
+    _result_log["Output Directory"] = output_dir
+    try:
+        _str_final_result_log = yaml.safe_dump(_result_log, allow_unicode=True, sort_keys=True)
+        logger.warn("\n"+_str_final_result_log)
+    except Exception as ex:
+        logger.warn(_ERROR_PREFIX+"Failed to print result log. "+ str(ex))
+    return success, _str_final_result_log
 
 
 if __name__ == '__main__':