Supports for applying setting from json file

Signed-off-by: SeongjunJo <[email protected]>

Author: SeongjunJo

README.md

@@ -84,6 +84,9 @@ Options:
         -r                      Keep raw data
         -t                      Hide the progress bar
         -v                      Print FOSSLight Scanner version
+        -s <path>               Path to apply setting from json file (check format with 'setting.json' in this repository)
+                                 * Direct cli flags have higher priority than setting file
+                                   (ex, '-f yaml -s setting.json' - result file extension is .yaml)
 ```
 - Refs. 
     - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.

src/fosslight_scanner/_help.py

@@ -33,6 +33,9 @@
             -r\t\t\t    Keep raw data
             -t\t\t\t    Hide the progress bar
             -v\t\t\t    Print FOSSLight Scanner version
+            -s <path>\t            Path to apply setting from file (check format with 'setting.json' in this repository)
+                                     * Direct cli flags have higher priority than setting file
+                                       (ex, '-f yaml -s setting.json' - result file extension is .yaml)
             --no_correction\t    Enter if you don't want to correct OSS information with sbom-info.yaml
                                      * Correction mode only supported xlsx format.
             --correct_fpath <path>  Path to the sbom-info.yaml file

src/fosslight_scanner/_parse_setting.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+import os
+
+
+def parse_setting_json(data):
+    # check type, if invalid = init value
+    mode = data.get('mode', [])
+    path = data.get('path', [])
+    dep_argument = data.get('dep_argument', '')
+    outputDir = data.get('outputDir', '')
+    outputFile = data.get('outputFile', '')
+    format = data.get('format', '')
+    link = data.get('link', [])
+    db_url = data.get('db_url', '')
+    timer = data.get('timer', False)
+    raw = data.get('raw', False)
+    core = data.get('core', -1)
+    no_correction = data.get('no_correction', False)
+    correct_fpath = data.get('correct_fpath', '')
+    ui = data.get('ui', False)
+    exclude_path = data.get('exclude_path', [])
+
+    str_lists = [mode, path, link, exclude_path]
+    strings = [dep_argument, outputDir, outputFile, format, db_url, correct_fpath]
+    booleans = [timer, raw, no_correction, ui]
+    is_incorrect = False
+
+    # check if json file is incorrect format
+    for i, target in enumerate(str_lists):
+        if not (isinstance(target, list) and all(isinstance(item, str) for item in target)):
+            is_incorrect = True
+            str_lists[i] = []
+
+    for i, target in enumerate(strings):
+        if not isinstance(target, str):
+            is_incorrect = True
+            str_lists[i] = ''
+
+    for i, target in enumerate(booleans):
+        if not isinstance(target, bool):
+            is_incorrect = True
+            str_lists[i] = False
+
+    if not isinstance(core, int):
+        is_incorrect = True
+        core = -1
+
+    if (is_incorrect):
+        print('Ignoring some values with incorrect format in the setting file.')
+
+    if not mode:
+        mode = ['all']
+    final_mode = mode[0].split()
+    if (not ("compare" in final_mode) and (len(path) > 0)):
+        path = [path[0]]
+    link = link[0] if (link and not path) else ''
+    output = os.path.join(outputDir, outputFile)
+
+    return final_mode, path, dep_argument, output, format, link, db_url, timer, \
+        raw, core, no_correction, correct_fpath, ui, exclude_path

src/fosslight_scanner/cli.py

@@ -3,12 +3,45 @@
 # Copyright (c) 2022 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
 import sys
+import json
 from argparse import ArgumentParser
 from ._help import print_help_msg
 from .fosslight_scanner import run_main, PKG_NAME
+from ._parse_setting import parse_setting_json
 from fosslight_util.help import print_package_version
 
 
+def set_args(mode, path, dep_argument, output, format, link, db_url, timer,
+             raw, core, no_correction, correct_fpath, ui, setting, exclude_path):
+    if (setting):
+        try:
+            with open(setting, 'r', encoding='utf-8') as file:
+                data = json.load(file)
+            s_mode, s_path, s_dep_argument, s_output, s_format, s_link, s_db_url, s_timer, s_raw, s_core, \
+                s_no_correction, s_correct_fpath, s_ui, s_exclude_path = parse_setting_json(data)
+
+            # direct cli arguments have higher priority than setting file
+            mode = mode if mode else s_mode
+            path = path if path else s_path
+            dep_argument = dep_argument if dep_argument else s_dep_argument
+            output = output if output else s_output
+            format = format if format else s_format
+            link = link if link else s_link
+            db_url = db_url if db_url else s_db_url
+            timer = timer if timer else s_timer
+            raw = raw if raw else s_raw
+            core = core if core else s_core
+            no_correction = no_correction if no_correction else s_no_correction
+            correct_fpath = correct_fpath if correct_fpath else s_correct_fpath
+            ui = ui if ui else s_ui
+            exclude_path = exclude_path if exclude_path else s_exclude_path
+
+        except Exception as e:
+            print(f"Cannot open setting file: {e}")
+    return mode, path, dep_argument, output, format, link, db_url, timer, \
+        raw, core, no_correction, correct_fpath, ui, exclude_path
+
+
 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="")
@@ -26,6 +59,7 @@ def main():
     parser.add_argument('--version', '-v', help='Print version', action='store_true', dest='version', default=False)
     parser.add_argument('--help', '-h', help='Print help message', action='store_true', dest='help')
     parser.add_argument('--exclude', '-e', help='Path to exclude from analysis', dest='exclude_path', nargs='*', default=[])
+    parser.add_argument('--setting', '-s', help='Scanner json setting file', type=str, dest='setting', default="")
     parser.add_argument('--no_correction', help='No correction with sbom-info.yaml',
                         action='store_true', required=False, default=False)
     parser.add_argument('--correct_fpath', help='Path to the sbom-info.yaml',
@@ -35,18 +69,20 @@ def main():
     try:
         args = parser.parse_args()
     except SystemExit:
-        sys.exit(0)
+        sys.exit(1)
 
     if args.help:
         print_help_msg()
     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, args.exclude_path)
+        mode, path, dep_argument, output, format, link, db_url, timer, raw, core, no_correction, correct_fpath, \
+          ui, exclude_path = set_args(args.mode, args.path, args.dep_argument, args.output, args.format,
+                                      args.link, args.db_url, args.timer, args.raw, args.core, args.no_correction,
+                                      args.correct_fpath, args.ui, args.setting, args.exclude_path)
+
+        run_main(mode, path, dep_argument, output, format, link, db_url, timer,
+                 raw, core, not no_correction, correct_fpath, ui, exclude_path)
 
 
 if __name__ == "__main__":

tests/setting.json

@@ -0,0 +1,18 @@
+{
+  "mode": ["binary source"],
+  "path": ["tests"],
+  "link": [],
+  "dep_argument": "",
+  "outputDir": "test_result_parse_setting",
+  "outputFile": "",
+  "exclude_path": ["test", "sample_license.txt"],
+  "format": "excel",
+  "db_url": "",
+  "timer": false,
+  "raw": true,
+  "core": -1,
+  "no_correction": false,
+  "correct_fpath": "",
+  "ui": false,
+  "type": "analyze"
+}

tox.ini

@@ -31,6 +31,7 @@ commands =
     fosslight binary source -o test_result_multi_mode/test.xlsx -p tests -r
     fosslight -o test_result_exclude_path/test.xlsx -p tests -e test sample_license.txt
     fosslight dependency -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
+    fosslight -f yaml -s tests/setting.json
     ls test_result_wget
 
 [testenv:release]
@@ -43,4 +44,5 @@ commands =
     fosslight binary dependency -o test_result_multi_mode/test.xlsx -p tests -r
     fosslight -o test_result_exclude_path/test.xlsx -p tests -e test sample_license.txt
     fosslight source -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
+    fosslight -f yaml -s tests/setting.json
     pytest -v --flake8