Merge pull request #83 from fosslight/develop

Check null after removing empty sheet

Author: soimkim

src/fosslight_util/output_format.py

@@ -3,7 +3,7 @@
 # Copyright (c) 2021 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
 import os
-from fosslight_util.write_excel import write_result_to_excel, write_result_to_csv
+from fosslight_util.write_excel import write_result_to_excel, write_result_to_csv, remove_empty_sheet
 from fosslight_util.write_opossum import write_opossum
 from fosslight_util.write_yaml import write_yaml
 
@@ -63,7 +63,8 @@ def write_output_file(output_file_without_ext, file_extension, sheet_list, exten
     success = True
     msg = ''
 
-    if sheet_list:
+    is_not_null, sheet_list = remove_empty_sheet(sheet_list)
+    if is_not_null:
         if file_extension == '':
             file_extension = '.xlsx'
         result_file = output_file_without_ext + file_extension

src/fosslight_util/write_excel.py

@@ -115,8 +115,7 @@ def write_result_to_csv(output_file, sheet_list_origin, separate_sheet=False, ex
 
     try:
         sheet_list = copy.deepcopy(sheet_list_origin)
-        is_not_null, sheet_list = remove_empty_sheet(sheet_list)
-        if is_not_null:
+        if sheet_list:
             output_files = []
             output_dir = os.path.dirname(output_file)
             Path(output_dir).mkdir(parents=True, exist_ok=True)
@@ -160,8 +159,7 @@ def write_result_to_excel(out_file_name, sheet_list, extended_header={}):
     error_msg = ""
 
     try:
-        is_not_null, sheet_list = remove_empty_sheet(sheet_list)
-        if is_not_null:
+        if sheet_list:
             output_dir = os.path.dirname(out_file_name)
             Path(output_dir).mkdir(parents=True, exist_ok=True)
 

src/fosslight_util/write_opossum.py

@@ -14,7 +14,6 @@
 from typing import Dict, Optional
 
 import fosslight_util.constant as constant
-from fosslight_util.write_excel import remove_empty_sheet
 
 
 PACKAGE = {
@@ -177,9 +176,7 @@ def write_opossum(filename, sheet_list):
     _filesWithChildren_key = 'filesWithChildren'
     _attributionBreakpoints_key = 'attributionBreakpoints'
 
-    is_not_null, sheet_list = remove_empty_sheet(sheet_list)
-
-    if is_not_null:
+    if sheet_list:
         output_dir = os.path.dirname(filename)
         Path(output_dir).mkdir(parents=True, exist_ok=True)
 

src/fosslight_util/write_yaml.py

@@ -10,7 +10,7 @@
 from pathlib import Path
 import fosslight_util.constant as constant
 from fosslight_util.oss_item import OssItem
-from fosslight_util.write_excel import remove_empty_sheet, _EMPTY_ITEM_MSG
+from fosslight_util.write_excel import _EMPTY_ITEM_MSG
 
 _logger = logging.getLogger(constant.LOGGER_NAME)
 
@@ -22,8 +22,7 @@ def write_yaml(output_file, sheet_list_origin, separate_yaml=False):
 
     try:
         sheet_list = copy.deepcopy(sheet_list_origin)
-        is_not_null, sheet_list = remove_empty_sheet(sheet_list)
-        if is_not_null:
+        if sheet_list:
             output_files = []
             output_dir = os.path.dirname(output_file)
 

tests/test_excel_and_csv.py

@@ -2,8 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2021 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
-from fosslight_util.write_excel import write_excel_and_csv, write_result_to_csv, write_result_to_excel
+from fosslight_util.write_excel import write_excel_and_csv
+from fosslight_util.output_format import write_output_file
 from fosslight_util.set_log import init_log
+from copy import deepcopy
 
 
 def main():
@@ -53,23 +55,17 @@ def main():
 
     logger.warning("TESTING - Writing an excel and csv")
     success, msg, result_file = write_excel_and_csv(
-        'test_result/excel_and_csv/FOSSLight-Report', sheet_contents)
-    logger.warning(f"Result:{success}, error_msg:{msg}, result:{result_file}")
+        'test_result/excel_and_csv/FOSSLight-Report', deepcopy(sheet_contents))
+    logger.warning(f"|-- Result:{success}, file:{result_file}, error_msg:{msg}")
 
     logger.warning("TESTING - Writing an excel")
-    success, msg = write_result_to_excel(
-        'test_result/excel_and_csv/excel/Test_Excel.xlsx', sheet_contents)
-    logger.warning(f"Result:{success}, error_msg:{msg}")
+    success, msg, result_file = write_output_file('test_result/excel_and_csv/excel/Test_Excel', '.xlsx', deepcopy(sheet_contents))
+    logger.warning(f"|-- Result:{success}, file:{result_file}, error_msg:{msg}")
 
-    logger.warning("TESTING - Writing an csv (separate sheet)")
-    success, msg, result_file = write_result_to_csv(
-        'test_result/excel_and_csv/csv/Test_Csv.csv', sheet_contents, True)
-    logger.warning(f"Result:{success}, error_msg:{msg}, result:{result_file}")
-
-    logger.warning("TESTING - Writing an csv (merge one sheet)")
-    success, msg, result_file = write_result_to_csv(
-        'test_result/excel_and_csv/csv/Test_Csv.csv', sheet_contents)
-    logger.warning(f"Result:{success}, error_msg:{msg}, result:{result_file}")
+    logger.warning("TESTING - Writing an csv")
+    success, msg, result_file = write_output_file(
+        'test_result/excel_and_csv/csv/Test_Csv', '.csv', deepcopy(sheet_contents))
+    logger.warning(f"|-- Result:{success}, file:{result_file}, error_msg:{msg}")
 
 
 if __name__ == '__main__':

tox.ini

@@ -35,9 +35,6 @@ commands =
   cat test_result/excel_and_csv/FOSSLight-Report_BIN_TEST.csv
   cat test_result/excel_and_csv/FOSSLight-Report_CUSTOM_HEADER_SHEET.csv
   cat test_result/excel_and_csv/csv/Test_Csv.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_SRC.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_BIN_TEST.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_CUSTOM_HEADER_SHEET.csv
   # Test - downloading source
   fosslight_download  -s "https://github.com/LGE-OSS/example" -t test_git/
   ls test_git/
@@ -72,9 +69,6 @@ commands =
   cat test_result/excel_and_csv/FOSSLight-Report_BIN_TEST.csv
   cat test_result/excel_and_csv/FOSSLight-Report_CUSTOM_HEADER_SHEET.csv
   cat test_result/excel_and_csv/csv/Test_Csv.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_SRC.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_BIN_TEST.csv
-  cat test_result/excel_and_csv/csv/Test_Csv_CUSTOM_HEADER_SHEET.csv
   # Test - writing opossum
   python tests/test_opossum.py
   ls test_result/opossum