PUC-740: pretty output

Author: haseebsyed12

python/diff-nautobot-understack/diff_nautobot_understack/cli.py

@@ -1,36 +1,87 @@
+from typing import Optional
+
 import typer
+from diffsync.diff import Diff
 from diff_nautobot_understack.project.main import (
     openstack_project_diff_from_nautobot_tenant,
 )
 from diff_nautobot_understack.network.main import (
     openstack_network_diff_from_ucvni_network,
 )
 from diff_nautobot_understack.settings import app_settings as settings
+from rich.console import Console
+from rich.table import Table
+from rich import print
 
 app = typer.Typer(
     name="diff",
     add_completion=False,
     help="compare data between Openstack and Nautobot.",
 )
+diff_outputs = {
+    "project": {"title": "Project Diff", "id_column_name": "Project ID"},
+    "network": {"title": "Network Diff", "id_column_name": "Network ID"},
+}
+
+
+def display_output(
+    diff_result: Diff, diff_output: str, output_format: Optional[str] = None
+):
+    print(diff_result.summary())
+    __output_format = (
+        output_format if output_format is not None else settings.output_format
+    )
+    if __output_format == "table":
+        diff_output_props = diff_outputs.get(diff_output)
+        tabular_output(
+            diff_result.dict().get(diff_output, {}),
+            diff_output_props.get("title"),
+            diff_output_props.get("id_column_name"),
+        )
+    else:
+        print(diff_result.dict())
+
+
+def tabular_output(diffs, title, id_column_name):
+    table = Table(title=title, show_lines=True)
+
+    table.add_column(id_column_name, style="cyan", no_wrap=True)
+    table.add_column("Change Type", style="magenta")
+    table.add_column("Details", style="yellow")
+
+    for diff_id, changes in diffs.items():
+        for change_type, details in changes.items():
+            table.add_row(diff_id, change_type, str(details))
+
+    console = Console()
+    console.print(table)
 
 
 @app.command()
 def project(
     name: str,
     debug: bool = typer.Option(False, "--debug", "-v", help="Enable debug mode"),
+    output_format: str = typer.Option(
+        "json", "--format", help="Available formats json, table"
+    ),
 ):
     """Nautobot tenants ⟹ Openstack projects"""
     settings.debug = debug
-    openstack_project_diff_from_nautobot_tenant(os_project=name)
+    diff_result = openstack_project_diff_from_nautobot_tenant(os_project=name)
+    display_output(diff_result, "project", output_format)
 
 
 @app.command()
 def network(
     debug: bool = typer.Option(False, "--debug", "-v", help="Enable debug mode"),
+    output_format: str = typer.Option(
+        "json", "--format", help="Available formats json, table"
+    ),
 ):
     """Nautobot ucvnis ⟹ Openstack networks"""
     settings.debug = debug
-    openstack_network_diff_from_ucvni_network()
+    diff_result = openstack_network_diff_from_ucvni_network()
+    display_output(diff_result, "network", output_format)
 
 
 if __name__ == "__main__":

python/diff-nautobot-understack/diff_nautobot_understack/network/main.py

@@ -1,12 +1,12 @@
-from pprint import pprint
+from diffsync.diff import Diff
 from diffsync.enum import DiffSyncFlags
 from diff_nautobot_understack.network.adapters.openstack_network import (
     Network as OpenstackNetwork,
 )
 from diff_nautobot_understack.network.adapters.ucvni import Network as UcvniNetwork
 
 
-def openstack_network_diff_from_ucvni_network():
+def openstack_network_diff_from_ucvni_network() -> Diff:
     openstack_network = OpenstackNetwork()
     openstack_network.load()
 
@@ -15,7 +15,4 @@ def openstack_network_diff_from_ucvni_network():
     openstack_network_destination_ucvni_source = openstack_network.diff_from(
         ucvni_network, flags=DiffSyncFlags.CONTINUE_ON_FAILURE
     )
-    pprint(" Nautobot ucvnis ⟹ Openstack networks ")
-    summary = openstack_network_destination_ucvni_source.summary()
-    pprint(summary, width=120)
-    pprint(openstack_network_destination_ucvni_source.dict(), width=120)
+    return openstack_network_destination_ucvni_source

python/diff-nautobot-understack/diff_nautobot_understack/project/main.py

@@ -1,11 +1,11 @@
-from pprint import pprint
+from diffsync.diff import Diff
 from diffsync.enum import DiffSyncFlags
 from diff_nautobot_understack.project.adapters.openstack_project import Project
 from diff_nautobot_understack.project.adapters.nautobot_tenant import Tenant
 from diff_nautobot_understack.settings import app_settings as settings
 
 
-def openstack_project_diff_from_nautobot_tenant(os_project=None):
+def openstack_project_diff_from_nautobot_tenant(os_project=None) -> Diff:
     project_name = os_project if os_project is not None else settings.os_project
     openstack_project = Project(name=project_name)
     openstack_project.load()
@@ -15,7 +15,4 @@ def openstack_project_diff_from_nautobot_tenant(os_project=None):
     openstack_project_destination_tenant_source = openstack_project.diff_from(
         nautobot_tenant, flags=DiffSyncFlags.CONTINUE_ON_FAILURE
     )
-    pprint(" Nautobot tenants ⟹ Openstack projects ")
-    summary = openstack_project_destination_tenant_source.summary()
-    pprint(summary, width=120)
-    pprint(openstack_project_destination_tenant_source.dict(), width=120)
+    return openstack_project_destination_tenant_source

python/diff-nautobot-understack/diff_nautobot_understack/settings.py

@@ -10,8 +10,9 @@ class Settings(BaseSettings):
     nautobot_url: str = "https://nautobot.dev.undercloud.rackspace.net"
     debug: bool = False
     os_cloud: Optional[str] = None
-    os_project: Optional[str] = "default"
+    os_project: str = "default"
     os_client_config_file: Optional[str] = None
+    output_format: str = "table"
 
 
 Settings.model_rebuild()