fosslight-source 2.2.2__py3-none-any.whl → 2.2.3__py3-none-any.whl

fosslight_source/cli.py

@@ -30,6 +30,7 @@ from ._scan_item import SourceItem, KB_URL
 from fosslight_util.oss_item import ScannerItem
 from typing import Tuple
 from ._scan_item import is_manifest_file
+import shutil
 
 
 SRC_SHEET_NAME = 'SRC_FL_Source'
@@ -40,9 +41,7 @@ MERGED_HEADER = {SRC_SHEET_NAME: ['ID', 'Source Path', 'OSS Name',
                                   'OSS Version', 'License', 'Download Location',
                                   'Homepage', 'Copyright Text', 'Exclude', 'Comment', 'license_reference']}
 SCANNER_TYPE = ['kb', 'scancode', 'scanoss', 'all']
-EXCLUDE_FILENAME = ["changelog", "config.guess", "config.sub", "changes", "ltmain.sh",
-                    "configure", "configure.ac", "depcomp", "compile", "missing", "Makefile"]
-EXCLUDE_FILE_EXTENSION = [".m4", ".in", ".po"]
+
 
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.filterwarnings("ignore", category=FutureWarning)
@@ -138,7 +137,7 @@ def create_report_file(
     output_path: str = "", output_files: list = [],
     output_extensions: list = [], correct_mode: bool = True,
     correct_filepath: str = "", path_to_scan: str = "", path_to_exclude: list = [],
-    formats: list = [], api_limit_exceed: bool = False, files_count: int = 0
+    formats: list = [], api_limit_exceed: bool = False, files_count: int = 0, final_output_path: str = ""
 ) -> 'ScannerItem':
     """
     Create report files for given scanned result.
@@ -152,10 +151,7 @@ def create_report_file(
     sheet_list = {}
     _json_ext = ".json"
 
-    if output_path == "":
-        output_path = os.getcwd()
-    else:
-        output_path = os.path.abspath(output_path)
+    output_path = os.path.abspath(output_path)
 
     if not output_files:
         # If -o does not contains file name, set default name
@@ -199,15 +195,27 @@ def create_report_file(
     scan_item.set_cover_pathinfo(path_to_scan, path_to_exclude)
     scan_item.set_cover_comment(f"Scanned files: {files_count}")
 
-    if api_limit_exceed:
-        scan_item.set_cover_comment("(Some of) SCANOSS scan was skipped. (API limits being exceeded)")
-
-    if not merged_result:
+    if merged_result:
+        scan_item.set_cover_comment(f"Detected source : {len(merged_result)}")
+    else:
         if files_count < 1:
             scan_item.set_cover_comment("(No file detected.)")
         else:
             scan_item.set_cover_comment("(No OSS detected.)")
 
+    if api_limit_exceed:
+        scan_item.set_cover_comment("SCANOSS skipped (API limits)")
+
+    run_kb = True if selected_scanner in ['kb', 'all'] else False
+    if run_kb:
+        scan_item.set_cover_comment("KB Enabled" if check_kb_server_reachable() else "KB Unreachable")
+    display_mode = selected_scanner
+    if selected_scanner == "kb":
+        display_mode += ", scancode"
+    elif selected_scanner == "all":
+        display_mode = "kb, scancode, scanoss"
+    scan_item.set_cover_comment(f"Mode : {display_mode}")
+
     if merged_result:
         sheet_list = {}
         scan_item.append_file_items(merged_result, PKG_NAME)
@@ -243,12 +251,13 @@ def create_report_file(
         #     del sheet_list["scanoss_reference"]
         results.append(write_output_file(combined_path_and_file, output_extension, scan_item, extended_header, "", output_format))
     for success, msg, result_file in results:
+        final_result_file = result_file.replace(output_path, final_output_path)
         if success:
-            logger.info(f"Output file: {result_file}")
+            logger.info(f"Output file: {final_result_file}")
             for row in scan_item.get_cover_comment():
                 logger.info(row)
         else:
-            logger.error(f"Fail to generate result file {result_file}. msg:({msg})")
+            logger.error(f"Fail to generate result file {final_result_file}. msg:({msg})")
     return scan_item
 
 
@@ -326,7 +335,8 @@ def run_scanners(
     called_by_cli: bool = True, print_matched_text: bool = False,
     formats: list = [], time_out: int = 120,
     correct_mode: bool = True, correct_filepath: str = "",
-    selected_scanner: str = 'all', path_to_exclude: list = []
+    selected_scanner: str = 'all', path_to_exclude: list = [],
+    all_exclude_mode: tuple = ()
 ) -> Tuple[bool, str, 'ScannerItem', list, list]:
     """
     Run Scancode and scanoss.py for the given path.
@@ -357,6 +367,11 @@ def run_scanners(
 
     success, msg, output_path, output_files, output_extensions, formats = check_output_formats_v2(output_file_name, formats)
 
+    if output_path == "":
+        output_path = os.getcwd()
+    final_output_path = output_path
+    output_path = os.path.join(os.path.dirname(output_path), '.fosslight_temp')
+
     logger, result_log = init_log(os.path.join(output_path, f"fosslight_log_src_{start_time}.txt"),
                                   True, logging.INFO, logging.DEBUG, PKG_NAME, path_to_scan, path_to_exclude)
 
@@ -365,10 +380,18 @@ def run_scanners(
         print_matched_text = False
 
     if success:
-        path_to_exclude_with_filename = path_to_exclude + EXCLUDE_FILENAME
-        excluded_path_with_default_exclusion, excluded_path_without_dot, excluded_files, cnt_file_except_skipped = (
-            get_excluded_paths(path_to_scan, path_to_exclude_with_filename, EXCLUDE_FILE_EXTENSION))
-        logger.debug(f"Skipped paths: {excluded_path_with_default_exclusion}")
+        if all_exclude_mode and len(all_exclude_mode) == 4:
+            (excluded_path_with_default_exclusion,
+             excluded_path_without_dot,
+             excluded_files,
+             cnt_file_except_skipped) = all_exclude_mode
+        else:
+            path_to_exclude_with_filename = path_to_exclude
+            (excluded_path_with_default_exclusion,
+             excluded_path_without_dot,
+             excluded_files,
+             cnt_file_except_skipped) = get_excluded_paths(path_to_scan, path_to_exclude_with_filename)
+            logger.debug(f"Skipped paths: {excluded_path_with_default_exclusion}")
 
         if not selected_scanner:
             selected_scanner = 'all'
@@ -381,7 +404,7 @@ def run_scanners(
                                                                                       excluded_files)
         excluded_files = set(excluded_files) if excluded_files else set()
         if selected_scanner in ['scanoss', 'all']:
-            scanoss_result, api_limit_exceed = run_scanoss_py(path_to_scan, output_file_name, formats, True, write_json_file,
+            scanoss_result, api_limit_exceed = run_scanoss_py(path_to_scan, output_file_name, formats, True,
                                                               num_cores, excluded_path_with_default_exclusion, excluded_files)
         if selected_scanner in SCANNER_TYPE:
             run_kb = True if selected_scanner in ['kb', 'all'] else False
@@ -391,7 +414,7 @@ def run_scanners(
             scan_item = create_report_file(start_time, merged_result, license_list, scanoss_result, selected_scanner,
                                            print_matched_text, output_path, output_files, output_extensions, correct_mode,
                                            correct_filepath, path_to_scan, excluded_path_without_dot, formats,
-                                           api_limit_exceed, cnt_file_except_skipped)
+                                           api_limit_exceed, cnt_file_except_skipped, final_output_path)
         else:
             print_help_msg_source_scanner()
             result_log[RESULT_KEY] = "Unsupported scanner"
@@ -399,6 +422,13 @@ def run_scanners(
     else:
         result_log[RESULT_KEY] = f"Format error. {msg}"
         success = False
+
+    try:
+        shutil.copytree(output_path, final_output_path, dirs_exist_ok=True)
+        shutil.rmtree(output_path)
+    except Exception as ex:
+        logger.debug(f"Failed to move temp files: {ex}")
+
     return success, result_log.get(RESULT_KEY, ""), scan_item, license_list, scanoss_result
 
 

fosslight_source/run_manifest_extractor.py

@@ -42,8 +42,6 @@ def get_licenses_from_package_json(file_path: str) -> list[str]:
 
     if isinstance(license_field, str):
         value = license_field.strip()
-        if value.upper() == 'UNLICENSED':
-            return []
         if value.upper().startswith('SEE LICENSE IN'):
             return []
         licenses.extend(_split_spdx_expression(value))
@@ -51,7 +49,7 @@ def get_licenses_from_package_json(file_path: str) -> list[str]:
         type_val = license_field.get('type')
         if isinstance(type_val, str):
             type_val = type_val.strip()
-            if type_val and type_val.upper() != 'UNLICENSED':
+            if type_val:
                 licenses.append(type_val)
 
     if not licenses:
@@ -60,13 +58,13 @@ def get_licenses_from_package_json(file_path: str) -> list[str]:
             for item in legacy:
                 if isinstance(item, str):
                     token = item.strip()
-                    if token and token.upper() != 'UNLICENSED':
+                    if token:
                         licenses.append(token)
                 elif isinstance(item, dict):
                     t = item.get('type')
                     if isinstance(t, str):
                         t = t.strip()
-                        if t and t.upper() != 'UNLICENSED':
+                        if t:
                             licenses.append(t)
 
     unique: list[str] = []

fosslight_source/run_scanoss.py

@@ -8,14 +8,10 @@ import importlib_metadata
 import warnings
 import logging
 import json
-from datetime import datetime
 import fosslight_util.constant as constant
-from fosslight_util.set_log import init_log
 from fosslight_util.output_format import check_output_formats_v2  # , write_output_file
 from ._parsing_scanoss_file import parsing_scan_result  # scanoss
 from ._parsing_scanoss_file import parsing_extra_info  # scanoss
-import shutil
-from pathlib import Path
 from scanoss.scanner import Scanner, ScanType
 import io
 import contextlib
@@ -32,7 +28,7 @@ def get_scanoss_extra_info(scanned_result: dict) -> list:
 
 
 def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list = [],
-                   called_by_cli: bool = False, write_json_file: bool = False, num_threads: int = -1,
+                   called_by_cli: bool = False, num_threads: int = -1,
                    path_to_exclude: list = [], excluded_files: set = None) -> list:
     """
     Run scanoss.py for the given path.
@@ -46,13 +42,8 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
     """
     success, msg, output_path, output_files, output_extensions, formats = check_output_formats_v2(output_file_name, format)
 
-    if not called_by_cli:
-        global logger
-        _start_time = datetime.now().strftime('%y%m%d_%H%M')
-        logger, _result_log = init_log(os.path.join(output_path, f"fosslight_log_src_{_start_time}.txt"),
-                                       True, logging.INFO, logging.DEBUG, _PKG_NAME, path_to_scan, path_to_exclude)
-
     scanoss_file_list = []
+    api_limit_exceed = False
     try:
         importlib_metadata.distribution("scanoss")
     except Exception as error:
@@ -60,12 +51,6 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
         logger.warning("Please install scanoss and dataclasses before run fosslight_source with scanoss option.")
         return scanoss_file_list
 
-    if output_path == "":  # if json output with _write_json_file not used, output_path won't be needed.
-        output_path = os.getcwd()
-    else:
-        output_path = os.path.abspath(output_path)
-        if not os.path.isdir(output_path):
-            Path(output_path).mkdir(parents=True, exist_ok=True)
     output_json_file = os.path.join(output_path, SCANOSS_OUTPUT_FILE)
     if os.path.exists(output_json_file):  # remove scanner_output.wfp file if exist
         os.remove(output_json_file)
@@ -84,7 +69,6 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
             scanner.scan_folder_with_options(scan_dir=path_to_scan)
         captured_output = output_buffer.getvalue()
         api_limit_exceed = "due to service limits being exceeded" in captured_output
-        logger.debug(f"{captured_output}")
 
         if os.path.isfile(output_json_file):
             with open(output_json_file, "r") as st_json:
@@ -103,13 +87,4 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
 
     logger.info(f"|---Number of files detected with SCANOSS: {(len(scanoss_file_list))}")
 
-    try:
-        if write_json_file:
-            shutil.move(SCANOSS_RESULT_FILE, output_path)
-        else:
-            os.remove(output_json_file)
-            os.remove(SCANOSS_RESULT_FILE)
-    except Exception as error:
-        logger.debug(f"Moving scanoss raw files failed.: {error}")
-
     return scanoss_file_list, api_limit_exceed

{fosslight_source-2.2.2.dist-info → fosslight_source-2.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_source
-Version: 2.2.2
+Version: 2.2.3
 Summary: FOSSLight Source Scanner
 Home-page: https://github.com/fosslight/fosslight_source_scanner
 Download-URL: https://github.com/fosslight/fosslight_source_scanner
@@ -17,7 +17,7 @@ License-File: LICENSE
 Requires-Dist: pyparsing
 Requires-Dist: scanoss>=1.18.0
 Requires-Dist: XlsxWriter
-Requires-Dist: fosslight_util>=2.1.34
+Requires-Dist: fosslight_util>=2.1.37
 Requires-Dist: PyYAML
 Requires-Dist: wheel>=0.38.1
 Requires-Dist: intbitset

{fosslight_source-2.2.2.dist-info → fosslight_source-2.2.3.dist-info}/RECORD

@@ -4,14 +4,14 @@ fosslight_source/_license_matched.py,sha256=-3H881XQjFDafRttBsuboS3VbCPYEvPH1pwW
 fosslight_source/_parsing_scancode_file_item.py,sha256=9TjCwTTPaytqTlZzCKzaX-n20xJLy346xwp0Ee-rWWA,14951
 fosslight_source/_parsing_scanoss_file.py,sha256=L3iHqmQF2jeSpHYuYSre44doXKy-BoX0u1Lm2IfJSU8,3866
 fosslight_source/_scan_item.py,sha256=rWoC-jMc6Hf_dpiwVdQjATNhkzRgLVn966q3UA1TAxc,9412
-fosslight_source/cli.py,sha256=Ohsl9h4-9zS72pPQCf22Ij7LrUinhpioC_2DNro3bXQ,19385
-fosslight_source/run_manifest_extractor.py,sha256=oaCdfXDp0bRqeEq0U3Yaf6fiZ-xjOOGsZBVbAeMN2zI,9105
+fosslight_source/cli.py,sha256=GDwBlwgSvPtWlKhk6hZWQSUl71MJYaGIE4_Mcp1w_L8,20367
+fosslight_source/run_manifest_extractor.py,sha256=8itu69eoriEnSskVDF9rnkLZ3d515KTaKy6tkZKWgBk,8940
 fosslight_source/run_scancode.py,sha256=TFyNLV6P9rSBo9royDoG6az4l7Tkpl8Gr66IFK1DBU8,9021
-fosslight_source/run_scanoss.py,sha256=_gdA4kOByI4saT4bDvMwIabpxtpH4f_yruHdBtb_g-o,4852
+fosslight_source/run_scanoss.py,sha256=91hQ60BcjgCkfrcWuMYoR4lRSCa1-AdLMxVubTx_Wv4,3763
 fosslight_source/run_spdx_extractor.py,sha256=wIdjDIpzglc2tfrh_YodkAQ0QqfgfmJBSuE2bf4w4Tg,862
-fosslight_source-2.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-fosslight_source-2.2.2.dist-info/METADATA,sha256=Jw2ERDhSs7sfNrQuV3bLT5vnC4fMDYGV-EFmTak_yfc,3557
-fosslight_source-2.2.2.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-fosslight_source-2.2.2.dist-info/entry_points.txt,sha256=G4bBRWqSrJ68g-2M-JtNDrSZsdym_M7_KohQ2qR1vG8,113
-fosslight_source-2.2.2.dist-info/top_level.txt,sha256=C2vw-0OIent84Vq-UEk1gt_kK1EL8dIItzBzp3WNyA4,17
-fosslight_source-2.2.2.dist-info/RECORD,,
+fosslight_source-2.2.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+fosslight_source-2.2.3.dist-info/METADATA,sha256=Md1A-4vaFc-sabOYYLntHZFo6NoohWA-Sn_H7K4LWus,3557
+fosslight_source-2.2.3.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+fosslight_source-2.2.3.dist-info/entry_points.txt,sha256=G4bBRWqSrJ68g-2M-JtNDrSZsdym_M7_KohQ2qR1vG8,113
+fosslight_source-2.2.3.dist-info/top_level.txt,sha256=C2vw-0OIent84Vq-UEk1gt_kK1EL8dIItzBzp3WNyA4,17
+fosslight_source-2.2.3.dist-info/RECORD,,