Merge pull request #43 from fosslight/temp_prechecker

Change FL Reuse to FL Prechecker

Author: soimkim

README.md

@@ -11,7 +11,7 @@ SPDX-License-Identifier: Apache-2.0
 
 **FOSSLight Scanner** performs open source analysis after downloading the source by passing a link that can be cloned by wget or git. Instead, open source analysis can be performed for the local source path. The output result is generated in [FOSSLight Report][or] format.
 
-- **[FOSSLight Reuse][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
+- **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
 - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
 - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
 - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
@@ -21,7 +21,7 @@ SPDX-License-Identifier: Apache-2.0
 [sc]: https://github.com/nexB/scancode-toolkit
 [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
 [flbin]: https://github.com/fosslight/fosslight_binary_scanner
-[re]: https://github.com/fosslight/fosslight_reuse
+[re]: https://github.com/fosslight/fosslight_prechecker
 [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
 
 ## Contents
@@ -65,7 +65,7 @@ Mode
             source            Run FOSSLight Source
             dependency        Run FOSSLight Dependency
             binary            Run FOSSLight Binary
-            reuse             Run FOSSLight Reuse
+            prechecker        Run FOSSLight Prechecker
             all               Run all scanners
 ``` 
 Options:

requirements.txt

@@ -9,4 +9,4 @@ beautifulsoup4
 fosslight_util>=1.4.1
 fosslight_dependency>=3.7.4
 fosslight_binary>=4.0.7
-fosslight_reuse>=2.2.1
+fosslight_prechecker>=3.0.1

src/fosslight_scanner/_help.py

@@ -16,7 +16,7 @@
             source\t\t    Run FOSSLight Source
             dependency\t\t    Run FOSSLight Dependency
             binary\t\t    Run FOSSLight Binary
-            reuse\t\t    Run FOSSLight Reuse
+            prechecker\t\t    Run FOSSLight Prechecker
             all\t\t\t    Run all scanners
             compare\t\t    Compare two FOSSLight reports in yaml format
 

src/fosslight_scanner/cli.py

@@ -10,7 +10,7 @@
 
 def main():
     parser = ArgumentParser(description='FOSSLight Scanner', prog='fosslight_scanner', add_help=False)
-    parser.add_argument('mode', nargs='?', help='source| dependency| binary| reuse| all| compare', default="all")
+    parser.add_argument('mode', nargs='?', help='source| dependency| binary| prechecker| all| compare', default="all")
     parser.add_argument('--path', '-p', help='Path to analyze (In compare mode, two FOSSLight reports',
                         dest='path', nargs='+', default="")
     parser.add_argument('--wget', '-w', help='Link to be analyzed', type=str, dest='link', default="")

src/fosslight_scanner/fosslight_scanner.py

@@ -20,7 +20,7 @@
 from fosslight_util.timer_thread import TimerThread
 import fosslight_util.constant as constant
 from fosslight_util.output_format import check_output_format
-from fosslight_reuse._fosslight_reuse import run_lint as reuse_lint
+from fosslight_prechecker._precheck import run_lint as prechecker_lint
 from .common import (copy_file, call_analysis_api,
                      overwrite_excel, extract_name_from_link)
 from fosslight_util.write_excel import merge_excels
@@ -99,7 +99,7 @@ def run_dependency(path_to_analyze, output_file_with_path, params=""):
 
 
 def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
-                run_src=True, run_bin=True, run_dep=True, run_reuse=True,
+                run_src=True, run_bin=True, run_dep=True, run_prechecker=True,
                 remove_src_data=True, result_log={}, output_file="",
                 output_extension="", num_cores=-1, db_url="",
                 default_oss_name="", url=""):
@@ -128,15 +128,15 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
             output_files = {"SRC": "FL_Source.xlsx",
                             "BIN": "FL_Binary.xlsx",
                             "BIN_TXT": "FL_Binary.txt",
-                            "DEP": "FL_Dependency.xlsx",
-                            "REUSE": "FL_Reuse.yaml"}
-            if run_reuse:
-                output_reuse = os.path.join(_output_dir, output_files["REUSE"])
-                success, result = call_analysis_api(src_path, "Reuse Lint",
-                                                    -1, reuse_lint,
+                            "DEP": f"FL_Dependency{output_extension}",
+                            "PRECHECKER": "FL_Prechecker.yaml"}
+            if run_prechecker:
+                output_prechecker = os.path.join(_output_dir, output_files["PRECHECKER"])
+                success, result = call_analysis_api(src_path, "Prechecker Lint",
+                                                    -1, prechecker_lint,
                                                     abs_path, False,
-                                                    output_reuse)
-                success_file, copied_file = copy_file(output_reuse, output_path)
+                                                    output_prechecker)
+                success_file, copied_file = copy_file(output_prechecker, output_path)
                 if success_file:
                     temp_output_fiiles.append(copied_file)
 
@@ -316,13 +316,13 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
             run_src = False
             run_bin = False
             run_dep = False
-            run_reuse = False
+            run_prechecker = False
             remove_downloaded_source = False
             if output_path == "":
                 output_path = _executed_path
 
-            if mode == "reuse":
-                run_reuse = True
+            if mode == "prechecker" or mode == "reuse":
+                run_prechecker = True
             elif mode == "binary" or mode == "bin":
                 run_bin = True
             elif mode == "source" or mode == "src":
@@ -333,7 +333,7 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
                 run_src = True
                 run_bin = True
                 run_dep = True
-                run_reuse = True
+                run_prechecker = True
 
             if src_path == "" and url_to_analyze == "":
                 src_path, dep_arguments, url_to_analyze = get_input_mode()
@@ -350,7 +350,7 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
 
             if src_path != "":
                 run_scanner(src_path, dep_arguments, output_path, keep_raw_data,
-                            run_src, run_bin, run_dep, run_reuse,
+                            run_src, run_bin, run_dep, run_prechecker,
                             remove_downloaded_source, {}, output_file,
                             output_extension, num_cores, db_url,
                             default_oss_name, url_to_analyze)