Merge pull request #92 from SeongjunJo/multi_mode

Supports for multiple modes

Author: soimkim

requirements.txt

@@ -5,7 +5,7 @@ progress
 pyyaml
 beautifulsoup4
 fosslight_util>=1.4.44
-fosslight_source>=1.7.3
-fosslight_dependency>=3.7.4
+fosslight_source>=1.7.7
+fosslight_dependency>=3.15.0
 fosslight_binary>=4.1.29
-fosslight_prechecker>=3.0.1
+fosslight_prechecker>=3.0.27

src/fosslight_scanner/_get_input.py

@@ -25,7 +25,7 @@ def ask_to_run(ask_msg):
     return return_value in return_true_item
 
 
-def get_input_mode(_executed_path, mode="all"):
+def get_input_mode(_executed_path, mode_list=["all"]):
     global _PYTHON_VERSION
     _PYTHON_VERSION = sys.version_info[0]
 
@@ -40,7 +40,7 @@ def get_input_mode(_executed_path, mode="all"):
     else:
         src_path = get_input("Please enter the path to analyze:", _executed_path)
 
-        if mode == "all" or mode == "dependency" or mode == "dep":
+        if "all" or "dependency" or "dep" in mode_list:
             dep_arguments = get_input(
                 "Please enter arguments for dependency analysis:", "")
 

src/fosslight_scanner/cli.py

@@ -11,7 +11,7 @@
 
 def main():
     parser = ArgumentParser(description='FOSSLight Scanner', prog='fosslight_scanner', add_help=False)
-    parser.add_argument('mode', nargs='?', help='source| dependency| binary| all| compare', default="all")
+    parser.add_argument('mode', nargs='*', help='source| dependency| binary| all| compare', default="")
     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="")
@@ -41,6 +41,8 @@ def main():
     elif args.version:
         print_package_version(PKG_NAME, "FOSSLight Scanner Version:")
     else:
+        if not args.mode:
+            args.mode = ['all']
         run_main(args.mode, args.path, args.dep_argument, args.output, args.format,
                  args.link, args.db_url, args.timer, args.raw, args.core,
                  not args.no_correction, args.correct_fpath, args.ui)

src/fosslight_scanner/fosslight_scanner.py

@@ -45,7 +45,7 @@
 _start_time = ""
 _executed_path = ""
 SRC_DIR_FROM_LINK_PREFIX = "fosslight_src_dir_"
-SCANNER_MODE = ["compare", "reuse", "prechecker", "binary", "bin", "src", "source", "dependency", "dep"]
+SCANNER_MODE = ["all", "compare", "reuse", "prechecker", "binary", "bin", "src", "source", "dependency", "dep"]
 
 
 def run_dependency(path_to_analyze, output_file_with_path, params=""):
@@ -307,7 +307,7 @@ def init(output_path="", make_outdir=True):
     return os.path.isdir(_output_dir), output_root_dir, result_log
 
 
-def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url_to_analyze, db_url,
+def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format, url_to_analyze, db_url,
              hide_progressbar=False, keep_raw_data=False, num_cores=-1, correct_mode=True, correct_fpath="", ui_mode=False):
     global _executed_path, _start_time
 
@@ -317,7 +317,18 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
     src_path = ""
     _executed_path = os.getcwd()
 
-    if mode == "compare":
+    mode_not_supported = list(set(mode_list).difference(SCANNER_MODE))
+    if mode_not_supported:
+        logger.error(f"[Error]: An unsupported mode was entered.:{mode_not_supported}")
+        sys.exit(1)
+    if len(mode_list) > 2:
+        logger.error("[Error]: Enter no more than two modes.")
+        sys.exit(1)
+    if ("compare" in mode_list) and (len(mode_list) > 1) and (mode_list != ["compare", "compare"]):
+        logger.error("[Error]: Compare mode cannot be run together with other modes.")
+        sys.exit(1)
+
+    if "compare" in mode_list:
         CUSTOMIZED_FORMAT = {'excel': '.xlsx', 'html': '.html', 'json': '.json', 'yaml': '.yaml'}
         if isinstance(path_arg, list) and len(path_arg) == 2:
             before_comp_f = path_arg[0]
@@ -342,7 +353,7 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
         logger.error(msg)
         sys.exit(1)
     try:
-        if mode == "compare":
+        if "compare" in mode_list:
             if before_comp_f == '' or after_comp_f == '':
                 logger.error("before and after files are necessary.")
                 return False
@@ -362,20 +373,14 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
             run_dep = False
             run_prechecker = False
             remove_downloaded_source = False
-            mode_list = []
 
-            if mode:
-                mode_list = mode.split(',')
-                mode_list = [item.strip() for item in mode_list]
-
-            if "compare" in mode_list:
-                logger.error("Compare mode cannot be run together with other modes.")
-                sys.exit(1)
-            elif "all" in mode_list or (not mode):
+            if "all" in mode_list or (not mode_list):
                 run_src = True
                 run_bin = True
                 run_dep = True
                 run_prechecker = False
+                if "prechecker" in mode_list or "reuse" in mode_list:
+                    run_prechecker = True
             else:
                 if "prechecker" in mode_list or "reuse" in mode_list:
                     run_prechecker = True
@@ -385,14 +390,10 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
                     run_src = True
                 if "dependency" in mode_list or "dep" in mode_list:
                     run_dep = True
-                mode_not_supported = list(set(mode_list).difference(SCANNER_MODE))
-                if len(mode_not_supported) > 0:
-                    logger.error(f"An unsupported mode was entered.:{mode_not_supported}")
-                    sys.exit(1)
 
             if run_dep or run_src or run_bin or run_prechecker:
                 if src_path == "" and url_to_analyze == "":
-                    src_path, dep_arguments, url_to_analyze = get_input_mode(_executed_path, mode)
+                    src_path, dep_arguments, url_to_analyze = get_input_mode(_executed_path, mode_list)
 
                 if not hide_progressbar:
                     timer = TimerThread()

tox.ini

@@ -27,6 +27,7 @@ commands =
     rm -rf test_result_local_path
     rm -rf test_result_wget
     fosslight -o test_result_local_path/test.xlsx -p tests -r
+    fosslight binary source -o test_result_multi_mode/test.xlsx -p tests -r
     fosslight dependency -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
     ls test_result_wget
 
@@ -37,5 +38,6 @@ deps =
 commands =
     fosslight -h
     fosslight all -o test_result_local_path/test.xlsx -p tests -r
+    fosslight binary dependency -o test_result_multi_mode/test.xlsx -p tests -r
     fosslight source -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
     pytest -v --flake8