refactor: improve console logging for gen-build-spec command

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

Author: Demolus13

src/macaron/__main__.py

@@ -351,6 +351,8 @@ def perform_action(action_args: argparse.Namespace) -> None:
             find_source(action_args)
 
         case "gen-build-spec":
+            if not action_args.disable_rich_output:
+                rich_handler.start("gen-build-spec")
             sys.exit(gen_build_spec(action_args))
 
         case _:

src/macaron/build_spec_generator/build_spec_generator.py

@@ -14,6 +14,7 @@
 
 from macaron.build_spec_generator.build_command_patcher import PatchCommandBuildTool, PatchValueType
 from macaron.build_spec_generator.reproducible_central.reproducible_central import gen_reproducible_central_build_spec
+from macaron.console import access_handler
 from macaron.path_utils.purl_based_path import get_purl_based_dir
 
 logger: logging.Logger = logging.getLogger(__name__)
@@ -131,6 +132,8 @@ def gen_build_spec_for_purl(
         build_spec_format.value,
         os.path.relpath(build_spec_filepath, os.getcwd()),
     )
+    rich_handler = access_handler.get_handler()
+    rich_handler.update_gen_build_spec("Build Spec Path:", os.path.relpath(build_spec_filepath, os.getcwd()))
     try:
         with open(build_spec_filepath, mode="w", encoding="utf-8") as file:
             file.write(build_spec_content)

src/macaron/build_spec_generator/reproducible_central/reproducible_central.py

@@ -23,6 +23,7 @@
     lookup_build_tools_check,
     lookup_latest_component,
 )
+from macaron.console import access_handler
 from macaron.errors import QueryMacaronDatabaseError
 from macaron.slsa_analyzer.checks.build_tool_check import BuildToolFacts
 
@@ -253,6 +254,11 @@ def get_rc_build_tool_name(
         BuildToolFacts.__tablename__,
         [(fact.build_tool_name, fact.language) for fact in build_tool_facts],
     )
+    rich_handler = access_handler.get_handler()
+    rich_handler.update_gen_build_spec(
+        "Build Tools:",
+        "\n".join([f"{fact.build_tool_name} ({fact.language})" for fact in build_tool_facts]),
+    )
 
     return _get_rc_build_tool_name_from_build_facts(build_tool_facts)
 
@@ -351,6 +357,11 @@ def gen_reproducible_central_build_spec(
     version = purl.version
     if group is None or version is None:
         logger.error("Missing group and/or version for purl %s.", purl.to_string())
+        rich_handler = access_handler.get_handler()
+        rich_handler.update_gen_build_spec("Repository PURL:", "[red]FAILED[/]")
+        rich_handler.update_gen_build_spec("Repository URL:", "[red]FAILED[/]")
+        rich_handler.update_gen_build_spec("Commit Hash:", "[red]FAILED[/]")
+        rich_handler.update_gen_build_spec("Build Tools:", "[red]FAILED[/]")
         return None
 
     try:
@@ -386,6 +397,10 @@ def gen_reproducible_central_build_spec(
         latest_component_repository.remote_path,
         latest_component_repository.commit_sha,
     )
+    rich_handler = access_handler.get_handler()
+    rich_handler.update_gen_build_spec("Repository PURL:", purl.to_string())
+    rich_handler.update_gen_build_spec("Repository URL:", latest_component_repository.remote_path)
+    rich_handler.update_gen_build_spec("Commit Hash:", latest_component_repository.commit_sha)
 
     # Getting the RC build tool name from the build tool check facts.
     rc_build_tool_name = get_rc_build_tool_name(

src/macaron/console.py

@@ -79,6 +79,16 @@ def __init__(self, *args: Any, verbose: bool = False, **kwargs: Any) -> None:
         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.gen_build_spec: dict[str, str | Status] = {
+            "Repository PURL:": Status("[green]Processing[/]"),
+            "Repository URL:": Status("[green]Processing[/]"),
+            "Commit Hash:": Status("[green]Processing[/]"),
+            "Build Tools:": Status("[green]Processing[/]"),
+            "Build Spec Path:": "Not Generated",
+        }
+        self.gen_build_spec_table = Table(show_header=False, box=None)
+        for key, value in self.gen_build_spec.items():
+            self.gen_build_spec_table.add_row(key, value)
         self.verbose = verbose
         self.verbose_panel = Panel(
             "\n".join(self.logs),
@@ -257,6 +267,16 @@ def update_dump_defaults(self, value: str | Status) -> None:
         """Update the dump defaults status."""
         self.dump_defaults = value
 
+    def update_gen_build_spec(self, key: str, value: str | Status) -> None:
+        """Add or update a key-value pair in the generate build spec table."""
+        self.gen_build_spec[key] = value
+        gen_build_spec_table = Table(show_header=False, box=None)
+        gen_build_spec_table.add_column("Details", justify="left")
+        gen_build_spec_table.add_column("Value", justify="left")
+        for field, content in self.gen_build_spec.items():
+            gen_build_spec_table.add_row(field, content)
+        self.gen_build_spec_table = gen_build_spec_table
+
     def make_layout(self) -> Group:
         """Create the overall layout for the console output."""
         layout: list[RenderableType] = []
@@ -333,7 +353,9 @@ def make_layout(self) -> Group:
             dump_defaults_table.add_column("Value", justify="left")
             dump_defaults_table.add_row("Dump Defaults", self.dump_defaults)
             layout = layout + [dump_defaults_table]
-
+        elif self.command == "gen-build-spec":
+            if self.gen_build_spec_table.row_count > 0:
+                layout = layout + [self.gen_build_spec_table]
         if self.verbose:
             layout = layout + ["", self.verbose_panel]
         return Group(*layout)
@@ -353,12 +375,11 @@ class AccessHandler:
     """A class to manage access to the RichConsoleHandler instance."""
 
     def __init__(self) -> None:
-        self.verbose = False
         self.rich_handler = RichConsoleHandler()
 
     def set_handler(self, verbose: bool) -> RichConsoleHandler:
         """Set the verbosity and create a new RichConsoleHandler instance."""
-        self.rich_handler = RichConsoleHandler(verbose)
+        self.rich_handler = RichConsoleHandler(verbose=verbose)
         return self.rich_handler
 
     def get_handler(self) -> RichConsoleHandler: