Make blint more usable as a library (#123)

* Deduplicate metadata export code.

Signed-off-by: Caroline Russell <[email protected]>

* Use CJD for io.

Signed-off-by: Caroline Russell <[email protected]>

* Refactor modules to be more usable as libraries.

Signed-off-by: Caroline Russell <[email protected]>

* Bump cjd.

Signed-off-by: Caroline Russell <[email protected]>

Move modules to lib.

Signed-off-by: Caroline Russell <[email protected]>

* Bump version.

Signed-off-by: Caroline Russell <[email protected]>

* Set defaults in parser.

Signed-off-by: Caroline Russell <[email protected]>

* Corrections.

Signed-off-by: Caroline Russell <[email protected]>

* Fix sbom_mode cmdline arg.

Signed-off-by: Caroline Russell <[email protected]>

* bint_options changed

Signed-off-by: Aryan Rajoria <[email protected]>

---------

Signed-off-by: Caroline Russell <[email protected]>
Signed-off-by: Aryan Rajoria <[email protected]>
Co-authored-by: Aryan Rajoria <[email protected]>

Author: cerrussell

blint/cli.py

@@ -2,11 +2,11 @@
 # -*- coding: utf-8 -*-
 
 import argparse
-import logging
 import os
-import sys
 
-from blint.lib.analysis import AnalysisRunner, report
+from blint.lib.runners import run_default_mode, run_sbom_mode
+from blint.lib.runners import AnalysisRunner, run_default_mode, run_sbom_mode
+from blint.config import BlintOptions
 from blint.logger import LOG
 from blint.lib.sbom import generate
 from blint.lib.utils import gen_file_list
@@ -25,10 +25,23 @@ def build_args():
     """
     Constructs command line arguments for the blint tool
     """
+    parser = build_parser()
+    return parser.parse_args()
+
+
+def build_parser():
     parser = argparse.ArgumentParser(
         prog="blint",
         description="Binary linter and SBOM generator.",
     )
+    parser.set_defaults(
+        deep_mode=False,
+        sbom_output="",
+        stdout_mode=False,
+        exports_prefix=[],
+        src_dir_boms=[],
+        sbom_mode=False
+    )
     parser.add_argument(
         "-i",
         "--src",
@@ -82,14 +95,14 @@ def build_args():
     sbom_parser = subparsers.add_parser(
         "sbom", help="Command to generate SBOM for supported binaries."
     )
+    sbom_parser.set_defaults(sbom_mode=True)
     sbom_parser.add_argument(
         "-i",
         "--src",
         dest="src_dir_image",
         action="extend",
         nargs="+",
-        help="Source directories, container images or binary files. Defaults "
-             "to current directory.",
+        help="Source directories, container images or binary files. Defaults to current directory.",
     )
     sbom_parser.add_argument(
         "-o",
@@ -127,7 +140,8 @@ def build_args():
         nargs="+",
         help="Directories containing pre-build and build BOMs. Use to improve the precision.",
     )
-    return parser.parse_args()
+    
+    return parser
 
 
 def parse_input(src):
@@ -153,68 +167,40 @@ def parse_input(src):
 def handle_args():
     """Handles the command-line arguments.
 
-    This function parses the command-line arguments and returns the parsed
-    arguments, reports directory, and source directory.
+    This function parses the command-line arguments and returns a BlintOptions object
 
     Returns:
-        tuple: A tuple containing the parsed arguments, reports directory, and
-               source directory.
+        BlintOptions: A class containing the parsed command-line arguments
     """
     args = build_args()
     if not args.no_banner and args.subcommand_name != "sbom":
         print(BLINT_LOGO)
-    if not args.src_dir_image:
-        args.src_dir_image = [os.getcwd()]
-    if not os.getenv("CI"):
-        src_dirs = args.src_dir_image
-    else:
-        src_dirs = parse_input(args.src_dir_image)
-
-    # Create reports directory
-    reports_dir = args.reports_dir
-
-    for src in src_dirs:
-        if not os.path.exists(src):
-            LOG.error(f"{src} is an invalid file or directory!")
-            sys.exit(1)
-    return args, reports_dir, src_dirs
+    blint_options = BlintOptions(
+        deep_mode=args.deep_mode,
+        exports_prefix=args.exports_prefix,
+        fuzzy=args.suggest_fuzzable,
+        no_error=args.noerror,
+        no_reviews=args.no_reviews,
+        reports_dir=args.reports_dir,
+        sbom_mode=args.sbom_mode,
+        sbom_output=args.sbom_output,
+        src_dir_boms=args.src_dir_boms,
+        src_dir_image=args.src_dir_image,
+        stdout_mode=args.stdout_mode
+    )
+    return blint_options
 
 
 def main():
     """Main function of the blint tool"""
-    args, reports_dir, src_dirs = handle_args()
+    blint_options = handle_args()
 
     # SBOM command
-    if args.subcommand_name == "sbom":
-        if args.stdout_mode:
-            sbom_output = sys.stdout
-            LOG.setLevel(logging.ERROR)
-        else:
-            if args.sbom_output:
-                sbom_output = args.sbom_output
-                if os.path.isdir(sbom_output):
-                    sbom_output = os.path.join(sbom_output, "bom-post-build.cdx.json")
-            else:
-                sbom_output = os.path.join(os.getcwd(), "bom-post-build.cdx.json")
-            sbom_output_dir = os.path.dirname(sbom_output)
-            if sbom_output_dir and not os.path.exists(sbom_output_dir):
-                os.makedirs(sbom_output_dir)
-        generate(src_dirs, sbom_output, args.deep_mode, args.exports_prefix, args.src_dir_boms)
+    if blint_options.sbom_mode:
+        run_sbom_mode(blint_options)
     # Default case
     else:
-        if reports_dir and not os.path.exists(reports_dir):
-            os.makedirs(reports_dir)
-        files = gen_file_list(src_dirs)
-        analyzer = AnalysisRunner()
-        findings, reviews, fuzzables = analyzer.start(
-            files, reports_dir, args.no_reviews, args.suggest_fuzzable
-        )
-        report(src_dirs, reports_dir, findings, reviews, files, fuzzables)
-
-        if os.getenv("CI") and not args.noerror:
-            for f in findings:
-                if f['severity'] == 'critical':
-                    sys.exit(1)
+        run_default_mode(blint_options)
 
 
 if __name__ == "__main__":

blint/config.py

@@ -1,6 +1,10 @@
 # pylint: disable=too-many-lines
+import sys
+from dataclasses import dataclass, field
 import os
 import re
+from typing import List
+
 
 # Default ignore list
 ignore_directories = [
@@ -1268,6 +1272,56 @@ def get_int_from_env(name, default):
     return int(get_float_from_env(name, default))
 
 
+@dataclass
+class BlintOptions:
+    """
+    A data class representing the command-line options for the blint tool.
+
+    Attributes:
+        deep_mode (bool): Flag indicating whether to perform deep analysis.
+        exports_prefix (list): Prefixes to determine exported symbols.
+        fuzzy (bool): Flag indicating whether to perform fuzzy analysis.
+        no_error (bool): Flag indicating whether to suppress error messages.
+        no_reviews (bool): Flag indicating whether to perform symbol reviews.
+        reports_dir (str): The path to the reports directory.
+        sbom_mode (bool): Flag indicating whether to perform SBOM analysis.
+        src_dir_image (list): A list of source directories.
+        sbom_output (str): The path to the output file.
+        deep_mode (bool): Flag indicating whether to perform deep analysis.
+        export_prefixes (list): Prefixes to determine exported symbols.
+        src_dir_boms (list): Directory containing pre-build and build sboms.
+    """
+    deep_mode: bool = False
+    exports_prefix: List = field(default_factory=list)
+    fuzzy: bool = False
+    no_error: bool = False
+    no_reviews: bool = False
+    reports_dir: str = ""
+    sbom_mode: bool = False
+    sbom_output: str = ""
+    sbom_output_dir: str = ""
+    src_dir_boms: List = field(default_factory=list)
+    src_dir_image: List = field(default_factory=list)
+    stdout_mode: bool = False
+    
+    def __post_init__(self):
+        if not self.src_dir_image and not (self.sbom_mode and self.src_dir_boms):
+            self.sources = [os.getcwd()]
+        if not self.reports_dir:
+            self.reports_dir = os.getcwd()
+        if self.sbom_mode:
+            if self.stdout_mode:
+                self.sbom_output = sys.stdout
+            elif not self.sbom_output:
+                self.sbom_output = os.path.join(self.reports_dir, "bom-post-build.cdx.json")
+                self.sbom_output_dir = os.path.join(self.reports_dir)
+            elif os.path.isdir(self.sbom_output):
+                self.sbom_output_dir = self.sbom_output
+                self.sbom_output = os.path.join(self.sbom_output, "bom-post-build.cdx.json")
+            else:
+                self.sbom_output_dir = os.path.dirname(self.sbom_output)
+        
+
 # PII related symbols
 PII_WORDS = (
     "FirstName",