fosslight-scanner 2.1.11__tar.gz → 2.1.13__tar.gz

{fosslight_scanner-2.1.11/src/fosslight_scanner.egg-info → fosslight_scanner-2.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_scanner
-Version: 2.1.11
+Version: 2.1.13
 Summary: FOSSLight Scanner
 Home-page: https://github.com/fosslight/fosslight_scanner
 Download-URL: https://github.com/fosslight/fosslight_scanner
@@ -20,10 +20,10 @@ Requires-Dist: openpyxl
 Requires-Dist: progress
 Requires-Dist: pyyaml
 Requires-Dist: beautifulsoup4
-Requires-Dist: fosslight_util<3.0.0,>=2.1.12
-Requires-Dist: fosslight_source<3.0.0,>=2.1.12
-Requires-Dist: fosslight_dependency<5.0.0,>=4.1.3
-Requires-Dist: fosslight_binary<6.0.0,>=5.1.9
+Requires-Dist: fosslight_util<3.0.0,>=2.1.37
+Requires-Dist: fosslight_source<3.0.0,>=2.2.3
+Requires-Dist: fosslight_dependency<5.0.0,>=4.1.29
+Requires-Dist: fosslight_binary<6.0.0,>=5.1.17
 Requires-Dist: fosslight_prechecker<5.0.0,>=4.0.0
 Dynamic: author
 Dynamic: classifier
@@ -119,7 +119,9 @@ Options:
                                  * Compare mode result file: supports excel, json, yaml, html
         -o <output>             Output directory or file
         -c <number>             Number of processes to analyze source
-        -e <path>               Path to exclude from analysis (ex, -e {dir} {file})
+        -e <path>               Path to exclude from analysis (files and directories, pattern matching is available
+                                 * IMPORTANT: Always wrap patterns in quotes("") to avoid shell expansion.
+                                   Example) fosslight -e "test/abc.py" "*.jar" "test/"
         -r                      Keep raw data
         -t                      Hide the progress bar
         -v                      Print FOSSLight Scanner version
@@ -130,6 +132,10 @@ Options:
 - Refs. 
     - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
     - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
+- Pattern Matching Pattern matching guide Guide for the -e Option
+    - ⚠️ Make sure to use double quotes ("") when entering values.     
+        - Example) fosslight -e "test/abc.py" "*.jar" "test/"    
+    - ⚠️ File names and extensions are case-sensitive, so please enter them exactly as intended.    
 
 [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
 [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html

{fosslight_scanner-2.1.11 → fosslight_scanner-2.1.13}/README.md

@@ -80,7 +80,9 @@ Options:
                                  * Compare mode result file: supports excel, json, yaml, html
         -o <output>             Output directory or file
         -c <number>             Number of processes to analyze source
-        -e <path>               Path to exclude from analysis (ex, -e {dir} {file})
+        -e <path>               Path to exclude from analysis (files and directories, pattern matching is available
+                                 * IMPORTANT: Always wrap patterns in quotes("") to avoid shell expansion.
+                                   Example) fosslight -e "test/abc.py" "*.jar" "test/"
         -r                      Keep raw data
         -t                      Hide the progress bar
         -v                      Print FOSSLight Scanner version
@@ -91,6 +93,10 @@ Options:
 - Refs. 
     - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
     - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
+- Pattern Matching Pattern matching guide Guide for the -e Option
+    - ⚠️ Make sure to use double quotes ("") when entering values.     
+        - Example) fosslight -e "test/abc.py" "*.jar" "test/"    
+    - ⚠️ File names and extensions are case-sensitive, so please enter them exactly as intended.    
 
 [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
 [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html

fosslight_scanner-2.1.13/requirements.txt

@@ -0,0 +1,11 @@
+future
+pandas
+openpyxl
+progress
+pyyaml
+beautifulsoup4
+fosslight_util>=2.1.37,<3.0.0
+fosslight_source>=2.2.3,<3.0.0
+fosslight_dependency>=4.1.29,<5.0.0
+fosslight_binary>=5.1.17,<6.0.0
+fosslight_prechecker>=4.0.0,<5.0.0

{fosslight_scanner-2.1.11 → fosslight_scanner-2.1.13}/setup.py

@@ -15,7 +15,7 @@ with open('requirements.txt', 'r', 'utf-8') as f:
 if __name__ == "__main__":
     setup(
         name='fosslight_scanner',
-        version='2.1.11',
+        version='2.1.13',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
         description='FOSSLight Scanner',

{fosslight_scanner-2.1.11 → fosslight_scanner-2.1.13}/src/fosslight_scanner/_help.py

@@ -29,7 +29,9 @@ _HELP_MESSAGE_SCANNER = f"""
             -f <formats> [<format> ...]\t    FOSSLight Report file format ({', '.join(SUPPORT_FORMAT)})
                                      * Compare mode result file: supports excel, json, yaml, html
                                      * Multiple formats can be specified separated by space.
-            -e <path>\t\t    Path to exclude from analysis (ex, -e [dir] [file])
+            -e <path>\t\t    Path to exclude from analysis (files and directories)
+                                     * IMPORTANT: Always wrap patterns in double quotes ("") to avoid shell expansion.
+                                       Example) fosslight -e "test/abc.py" "*.jar"
             -o <output>\t\t    Output directory or file
             -c <number>\t\t    Number of processes to analyze source
             -r\t\t\t    Keep raw data

{fosslight_scanner-2.1.11 → fosslight_scanner-2.1.13}/src/fosslight_scanner/fosslight_scanner.py

@@ -28,6 +28,7 @@ from fosslight_util.output_format import check_output_formats_v2
 from fosslight_util.cover import CoverItem
 from fosslight_util.oss_item import ScannerItem
 from fosslight_util.output_format import write_output_file
+from fosslight_util.exclude import get_excluded_paths
 
 from .common import (
     call_analysis_api, update_oss_item,
@@ -46,7 +47,7 @@ COMPARE_OUTPUT_REPORT_PREFIX = "fosslight_compare_"
 PKG_NAME = "fosslight_scanner"
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.simplefilter(action='ignore', category=FutureWarning)
-_output_dir = "fosslight_raw_data"
+_output_dir = ".fosslight_raw_data"
 _log_file = "fosslight_log_all_"
 _start_time = ""
 _executed_path = ""
@@ -181,6 +182,10 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
     if not correct_fpath:
         correct_fpath = src_path
 
+    excluded_path_with_default_exclusion, excluded_path_without_dot, excluded_files, cnt_file_except_skipped = (
+            get_excluded_paths(src_path, path_to_exclude))
+    logger.debug(f"Skipped paths: {excluded_path_with_default_exclusion}")
+
     try:
         final_excel_dir = os.path.abspath(final_excel_dir)
         abs_path = os.path.abspath(src_path)
@@ -203,7 +208,10 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
                                     source_write_json_file=source_write_json_file,
                                     source_print_matched_text=source_print_matched_text,
                                     source_time_out=source_time_out,
-                                    formats=formats
+                                    formats=formats,
+                                    all_exclude_mode=(excluded_path_with_default_exclusion,
+                                                      excluded_path_without_dot,
+                                                      excluded_files, cnt_file_except_skipped)
                         )
                         if success:
                             all_scan_item.file_items.update(result[2].file_items)
@@ -228,7 +236,11 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
                                                     _output_dir,
                                                     formats, db_url, binary_simple,
                                                     correct_mode, correct_fpath,
-                                                    path_to_exclude=path_to_exclude)
+                                                    path_to_exclude=path_to_exclude,
+                                                    all_exclude_mode=(excluded_path_with_default_exclusion,
+                                                                      excluded_path_without_dot,
+                                                                      excluded_files,
+                                                                      cnt_file_except_skipped))
                 if success:
                     all_scan_item.file_items.update(result.file_items)
                     all_cover_items.append(result.cover)
@@ -236,7 +248,10 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
             if run_dep:
                 dep_scanitem = run_dependency(src_path, _output_dir,
                                               dep_arguments, path_to_exclude, formats,
-                                              recursive_dep)
+                                              recursive_dep,
+                                              all_exclude_mode=(excluded_path_with_default_exclusion,
+                                                                excluded_path_without_dot,
+                                                                excluded_files, cnt_file_except_skipped))
                 all_scan_item.file_items.update(dep_scanitem.file_items)
                 all_cover_items.append(dep_scanitem.cover)
         else:
@@ -249,7 +264,7 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
         cover = CoverItem(tool_name=PKG_NAME,
                           start_time=_start_time,
                           input_path=abs_path,
-                          exclude_path=path_to_exclude,
+                          exclude_path=excluded_path_without_dot,
                           simple_mode=False)
         merge_comment = []
         for ci in all_cover_items:
@@ -335,6 +350,38 @@ def download_source(link, out_dir):
     return success, temp_src_dir, oss_name, oss_version
 
 
+def rename_and_remove_hidden_folder(output_path, output_dir, keep_raw_data=False):
+    try:
+        hidden_log_dir = os.path.join(output_path, ".fosslight_log")
+        visible_log_dir = os.path.join(output_path, "fosslight_log")
+        if os.path.exists(hidden_log_dir):
+            try:
+                if os.path.exists(visible_log_dir):
+                    shutil.rmtree(visible_log_dir)
+                shutil.move(hidden_log_dir, visible_log_dir)
+            except Exception as ex:
+                logger.debug(f"Error renaming log folder: {ex}")
+        
+        if keep_raw_data:
+            visible_raw_dir = os.path.join(os.path.dirname(output_dir), "fosslight_raw_data")
+            if os.path.exists(output_dir):
+                if os.path.exists(visible_raw_dir):
+                    shutil.rmtree(visible_raw_dir)
+                shutil.move(output_dir, visible_raw_dir)
+                logger.debug(f"Renamed {output_dir} to {visible_raw_dir}")
+        else:
+            logger.debug(f"Remove temporary files: {output_dir}")
+            if os.path.exists(output_dir):
+                shutil.rmtree(output_dir)
+            
+            visible_raw_dir = os.path.join(os.path.dirname(output_dir), "fosslight_raw_data")
+            if os.path.exists(visible_raw_dir):
+                shutil.rmtree(visible_raw_dir)
+                logger.debug(f"Removed previous raw data folder: {visible_raw_dir}")
+    except Exception as ex:
+        logger.debug(f"Error cleaning up output directories: {ex}")
+
+
 def init(output_path="", make_outdir=True):
     global _output_dir, _log_file, _start_time, logger
 
@@ -352,7 +399,7 @@ def init(output_path="", make_outdir=True):
         Path(_output_dir).mkdir(parents=True, exist_ok=True)
         _output_dir = os.path.abspath(_output_dir)
 
-    log_dir = os.path.join(output_root_dir, "fosslight_log")
+    log_dir = os.path.join(output_root_dir, ".fosslight_log")
     logger, result_log = init_log(os.path.join(log_dir, f"{_log_file}{_start_time}.txt"),
                                   True, logging.INFO, logging.DEBUG, PKG_NAME)
 
@@ -480,12 +527,9 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
                     shutil.rmtree(extract_folder)
             else:
                 logger.error("(mode) No mode has been selected for analysis.")
-        try:
-            if not keep_raw_data:
-                logger.debug(f"Remove temporary files: {_output_dir}")
-                shutil.rmtree(_output_dir)
-        except Exception as ex:
-            logger.debug(f"Error to remove temp files:{ex}")
+        
+        rename_and_remove_hidden_folder(output_path, _output_dir, keep_raw_data)
+
     except Exception as ex:
         logger.warning(str(ex))
         return False

{fosslight_scanner-2.1.11 → fosslight_scanner-2.1.13/src/fosslight_scanner.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_scanner
-Version: 2.1.11
+Version: 2.1.13
 Summary: FOSSLight Scanner
 Home-page: https://github.com/fosslight/fosslight_scanner
 Download-URL: https://github.com/fosslight/fosslight_scanner
@@ -20,10 +20,10 @@ Requires-Dist: openpyxl
 Requires-Dist: progress
 Requires-Dist: pyyaml
 Requires-Dist: beautifulsoup4
-Requires-Dist: fosslight_util<3.0.0,>=2.1.12
-Requires-Dist: fosslight_source<3.0.0,>=2.1.12
-Requires-Dist: fosslight_dependency<5.0.0,>=4.1.3
-Requires-Dist: fosslight_binary<6.0.0,>=5.1.9
+Requires-Dist: fosslight_util<3.0.0,>=2.1.37
+Requires-Dist: fosslight_source<3.0.0,>=2.2.3
+Requires-Dist: fosslight_dependency<5.0.0,>=4.1.29
+Requires-Dist: fosslight_binary<6.0.0,>=5.1.17
 Requires-Dist: fosslight_prechecker<5.0.0,>=4.0.0
 Dynamic: author
 Dynamic: classifier
@@ -119,7 +119,9 @@ Options:
                                  * Compare mode result file: supports excel, json, yaml, html
         -o <output>             Output directory or file
         -c <number>             Number of processes to analyze source
-        -e <path>               Path to exclude from analysis (ex, -e {dir} {file})
+        -e <path>               Path to exclude from analysis (files and directories, pattern matching is available
+                                 * IMPORTANT: Always wrap patterns in quotes("") to avoid shell expansion.
+                                   Example) fosslight -e "test/abc.py" "*.jar" "test/"
         -r                      Keep raw data
         -t                      Hide the progress bar
         -v                      Print FOSSLight Scanner version
@@ -130,6 +132,10 @@ Options:
 - Refs. 
     - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
     - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
+- Pattern Matching Pattern matching guide Guide for the -e Option
+    - ⚠️ Make sure to use double quotes ("") when entering values.     
+        - Example) fosslight -e "test/abc.py" "*.jar" "test/"    
+    - ⚠️ File names and extensions are case-sensitive, so please enter them exactly as intended.    
 
 [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
 [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html

fosslight_scanner-2.1.13/src/fosslight_scanner.egg-info/requires.txt

@@ -0,0 +1,11 @@
+future
+pandas
+openpyxl
+progress
+pyyaml
+beautifulsoup4
+fosslight_util<3.0.0,>=2.1.37
+fosslight_source<3.0.0,>=2.2.3
+fosslight_dependency<5.0.0,>=4.1.29
+fosslight_binary<6.0.0,>=5.1.17
+fosslight_prechecker<5.0.0,>=4.0.0

fosslight_scanner-2.1.11/requirements.txt

@@ -1,11 +0,0 @@
-future
-pandas
-openpyxl
-progress
-pyyaml
-beautifulsoup4
-fosslight_util>=2.1.12,<3.0.0
-fosslight_source>=2.1.12,<3.0.0
-fosslight_dependency>=4.1.3,<5.0.0
-fosslight_binary>=5.1.9,<6.0.0
-fosslight_prechecker>=4.0.0,<5.0.0

fosslight_scanner-2.1.11/src/fosslight_scanner.egg-info/requires.txt

@@ -1,11 +0,0 @@
-future
-pandas
-openpyxl
-progress
-pyyaml
-beautifulsoup4
-fosslight_util<3.0.0,>=2.1.12
-fosslight_source<3.0.0,>=2.1.12
-fosslight_dependency<5.0.0,>=4.1.3
-fosslight_binary<6.0.0,>=5.1.9
-fosslight_prechecker<5.0.0,>=4.0.0