refactor: improve console logging for find-source and dump-defaults

Signed-off-by: Demolus13 <parth.govale@oracle.com>

Author: Demolus13

src/macaron/__main__.py

@@ -217,7 +217,7 @@ def verify_policy(verify_policy_args: argparse.Namespace) -> int:
         rich_handler = access_handler.get_handler()
         if vsa is not None:
             vsa_filepath = os.path.join(global_config.output_path, "vsa.intoto.jsonl")
-            rich_handler.update_vsa(vsa_filepath)
+            rich_handler.update_vsa(os.path.relpath(vsa_filepath, os.getcwd()))
             logger.info(
                 "Generating the Verification Summary Attestation (VSA) to %s.",
                 os.path.relpath(vsa_filepath, os.getcwd()),
@@ -416,7 +416,6 @@ def main(argv: list[str] | None = None) -> None:
     )
 
     main_parser.add_argument(
-        "-dro",
         "--disable-rich-output",
         default=False,
         help="Disable Rich UI output",

src/macaron/config/defaults.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 - 2024, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2022 - 2025, Oracle and/or its affiliates. All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
 
 """This module provides functions to manage default values."""
@@ -9,6 +9,8 @@
 import pathlib
 import shutil
 
+from macaron.console import access_handler
+
 logger: logging.Logger = logging.getLogger(__name__)
 
 
@@ -162,14 +164,17 @@ def create_defaults(output_path: str, cwd_path: str) -> bool:
     # Since we have only one defaults.ini file and ConfigParser.write does not
     # preserve the comments, copy the file directly.
     dest_path = os.path.join(output_path, "defaults.ini")
+    rich_handler = access_handler.get_handler()
     try:
         shutil.copy2(src_path, dest_path)
         logger.info(
             "Dumped the default values in %s.",
             os.path.relpath(os.path.join(output_path, "defaults.ini"), cwd_path),
         )
+        rich_handler.update_dump_defaults(os.path.relpath(dest_path, cwd_path))
         return True
     # We catch OSError to support errors on different platforms.
     except OSError as error:
         logger.error("Failed to create %s: %s.", os.path.relpath(dest_path, cwd_path), error)
+        rich_handler.update_dump_defaults("[bold red]Failed[/]")
         return False

src/macaron/console.py

@@ -16,8 +16,6 @@
 from rich.status import Status
 from rich.table import Table
 
-from macaron.slsa_analyzer.checks.check_result import CheckResultType
-
 
 class Check:
     """Class to represent a check with its status and target."""
@@ -72,6 +70,15 @@ def __init__(self, *args: Any, verbose: bool = False, **kwargs: Any) -> None:
             "Policy Report": Status("[green]Generating[/]"),
         }
         self.verification_summary_attestation: str | None = None
+        self.find_source_table = Table(show_header=False, box=None)
+        self.find_source_content: dict[str, str | Status] = {
+            "Repository PURL:": Status("[green]Processing[/]"),
+            "Commit Hash:": Status("[green]Processing[/]"),
+            "JSON Report:": "Not Generated",
+        }
+        for key, value in self.find_source_content.items():
+            self.find_source_table.add_row(key, value)
+        self.dump_defaults: str | Status = Status("[green]Generating[/]")
         self.verbose = verbose
         self.verbose_panel = Panel(
             "\n".join(self.logs),
@@ -137,7 +144,7 @@ def update_checks_summary(self, checks_summary: dict, total_checks: int) -> None
         failed_checks_table.add_column("Check ID", justify="left")
         failed_checks_table.add_column("Description", justify="left")
 
-        failed_checks = checks_summary[CheckResultType.FAILED]
+        failed_checks = checks_summary["FAILED"]
         for check in failed_checks:
             failed_checks_table.add_row(
                 "[bold red]FAILED[/]",
@@ -153,15 +160,15 @@ def update_checks_summary(self, checks_summary: dict, total_checks: int) -> None
         summary_table.add_row("Total Checks", str(total_checks), style="white")
 
         for check_result_type, checks in checks_summary.items():
-            if check_result_type == CheckResultType.PASSED:
+            if check_result_type == "PASSED":
                 summary_table.add_row("PASSED", str(len(checks)), style="green")
-            if check_result_type == CheckResultType.FAILED:
+            if check_result_type == "FAILED":
                 summary_table.add_row("FAILED", str(len(checks)), style="red")
-            if check_result_type == CheckResultType.SKIPPED:
+            if check_result_type == "SKIPPED":
                 summary_table.add_row("SKIPPED", str(len(checks)), style="yellow")
-            if check_result_type == CheckResultType.DISABLED:
+            if check_result_type == "DISABLED":
                 summary_table.add_row("DISABLED", str(len(checks)), style="bright_blue")
-            if check_result_type == CheckResultType.UNKNOWN:
+            if check_result_type == "UNKNOWN":
                 summary_table.add_row("UNKNOWN", str(len(checks)), style="white")
 
         self.summary_table = summary_table
@@ -236,6 +243,20 @@ def update_policy_engine(self, results: dict) -> None:
 
         self.generate_policy_summary_table()
 
+    def update_find_source_table(self, key: str, value: str | Status) -> None:
+        """Add or update a key-value pair in the find source table."""
+        self.find_source_content[key] = value
+        find_source_table = Table(show_header=False, box=None)
+        find_source_table.add_column("Details", justify="left")
+        find_source_table.add_column("Value", justify="left")
+        for field, content in self.find_source_content.items():
+            find_source_table.add_row(field, content)
+        self.find_source_table = find_source_table
+
+    def update_dump_defaults(self, value: str | Status) -> None:
+        """Update the dump defaults status."""
+        self.dump_defaults = value
+
     def make_layout(self) -> Group:
         """Create the overall layout for the console output."""
         layout: list[RenderableType] = []
@@ -303,6 +324,15 @@ def make_layout(self) -> Group:
                     )
 
                     layout = layout + [vsa_table]
+        elif self.command == "find-source":
+            if self.find_source_table.row_count > 0:
+                layout = layout + [self.find_source_table]
+        elif self.command == "dump-defaults":
+            dump_defaults_table = Table(show_header=False, box=None)
+            dump_defaults_table.add_column("Detail", justify="left")
+            dump_defaults_table.add_column("Value", justify="left")
+            dump_defaults_table.add_row("Dump Defaults", self.dump_defaults)
+            layout = layout + [dump_defaults_table]
 
         if self.verbose:
             layout = layout + ["", self.verbose_panel]

src/macaron/repo_finder/repo_finder.py

@@ -324,10 +324,15 @@ def find_source(purl_string: str, input_repo: str | None, latest_version_fallbac
 
             return find_source(str(purl), latest_repo, False)
 
+    rich_handler = access_handler.get_handler()
     if not input_repo:
         logger.info("Found repository for PURL: %s", found_repo)
+        rich_handler.update_find_source_table("Repository PURL:", found_repo)
+    else:
+        rich_handler.update_find_source_table("Repository PURL:", input_repo)
 
     logger.info("Found commit for PURL: %s", digest)
+    rich_handler.update_find_source_table("Commit Hash:", digest)
 
     if not generate_report(
         purl_string,

src/macaron/repo_finder/repo_utils.py

@@ -13,6 +13,7 @@
 from pydriller import Git
 
 from macaron.config.global_config import global_config
+from macaron.console import access_handler
 from macaron.slsa_analyzer.git_service import GIT_SERVICES, BaseGitService
 from macaron.slsa_analyzer.git_service.base_git_service import NoneGitService
 from macaron.slsa_analyzer.git_url import GIT_REPOS_DIR, decode_git_tags, parse_git_tags
@@ -88,6 +89,9 @@ def generate_report(purl: str, commit: str, repo: str, target_dir: str) -> bool:
 
     logger.info("Report written to: %s", os.path.relpath(fullpath, os.getcwd()))
 
+    rich_handler = access_handler.get_handler()
+    rich_handler.update_find_source_table("JSON Report:", os.path.relpath(fullpath, os.getcwd()))
+
     return True