PUC-740: pretty output

Author: haseebsyed12

python/diff-nautobot-understack/README.md

@@ -1,10 +1,35 @@
+# Nautobot vs OpenStack Comparison Tool
 
-cd python/diff-nautobot-understack
-python3 -m venv .venv
-source .venv/bin/activate
-poetry lock
-poetry install
+This tool compares data between Nautobot and OpenStack.
 
-export NB_TOKEN=<get_token_from_nautobot_dev>
-poetry run diff-networks
-poetry run diff-projects
+## Currently Supported Comparisons
+
+| OpenStack | Nautobot              |
+|-----------|-----------------------|
+| Project   | Tenant                |
+| Network   | UCVNI & Namespace     |
+
+
+---
+
+## Setup Instructions
+
+1. cd python/diff-nautobot-understack
+2. `poetry install`
+   1. poetry will handle the creation of this virtual environment for you. It'll use .venv in the project if you configure it to do so locally on your machine with `poetry config virtualenvs.in-project true`.
+   2. user can create a shell with poetry shell and then when they exit it will clean up auth variables. Or they can run source .venv/bin/activate or poetry run <commands-below>
+
+3. Export environment variables (or add them to a .env file):
+   1. export NAUTOBOT_URL=https://nautobot.url.here
+   2.   users should browse to https://nautobot.url.here/user/api-tokens/ and generate an API token
+   3. export NAUTOBOT_TOKEN= <generated token from above step>
+   4. export OS_CLOUD=uc-dev-infra
+   5. export OS_CLIENT_CONFIG_FILE=./my_clouds.yaml (set this if it is in any other location not [defined here](https://opendev.org/openstack/openstacksdk#getting-started))
+
+
+- Below are some example commands
+```
+    uc-diff --help
+    uc-diff project undercloud -v
+    uc-diff network
+```

python/diff-nautobot-understack/clouds.yaml

@@ -0,0 +1,102 @@
+import os
+import sys
+
+import typer
+from diffsync.diff import Diff
+from rich import print
+from rich.console import Console
+from rich.table import Table
+
+from diff_nautobot_understack.network.main import (
+    openstack_network_diff_from_ucvni_network,
+)
+from diff_nautobot_understack.project.main import (
+    openstack_project_diff_from_nautobot_tenant,
+)
+from diff_nautobot_understack.settings import app_settings as settings
+
+required_env_vars = ["NAUTOBOT_TOKEN", "NAUTOBOT_URL", "OS_CLOUD"]
+
+
+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: str | None = 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
+    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
+    diff_result = openstack_network_diff_from_ucvni_network()
+    display_output(diff_result, "network", output_format)
+
+
+def check_env_vars(required_vars):
+    missing_vars = [var for var in required_vars if var not in os.environ]
+
+    if missing_vars:
+        print(f"Error: Missing environment variables: {', '.join(missing_vars)}")
+        sys.exit(1)
+    else:
+        print("All required environment variables are set.")
+
+
+check_env_vars(required_env_vars)

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

@@ -1,22 +1,20 @@
-import os
-
-import requests
-import logging
 import inspect
+import logging
 from urllib.parse import urljoin
 
-NB_URL = os.environ.get("NB_URL", "https://nautobot.dev.undercloud.rackspace.net")
-NB_TOKEN = os.environ.get("NB_TOKEN")
+import requests
+
+from diff_nautobot_understack.settings import app_settings as settings
 
 
 class API:
     CALLER_FRAME = 1
 
     def __init__(self):
-        self.base_url = NB_URL
+        self.base_url = settings.nautobot_url
         self.s = requests.Session()
-        self.token = NB_TOKEN
-        self.s.headers.update({"Authorization": f"Token {NB_TOKEN}"})
+        self.token = settings.nautobot_token
+        self.s.headers.update({"Authorization": f"Token {self.token}"})
 
     def make_api_request(
         self, url: str, payload: dict | None = None, paginated: bool = False

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

@@ -1,13 +1,12 @@
-import os
-
 import openstack
 
-OS_CLOUD = os.environ.get("OS_CLOUD", "uc-dev-infra")
-
-
-openstack.enable_logging(debug=True)
+from diff_nautobot_understack.settings import app_settings as settings
 
 
 class API:
     def __init__(self):
-        self.cloud_connection = openstack.connect(cloud=OS_CLOUD)
+        cloud_name = settings.os_cloud
+        debug = settings.debug
+
+        openstack.enable_logging(debug=debug)
+        self.cloud_connection = openstack.connect(cloud=cloud_name)

python/diff-nautobot-understack/diff_nautobot_understack/clients/openstack.py

@@ -1,6 +1,6 @@
 from diffsync import Adapter
-from diff_nautobot_understack.clients.openstack import API
 
+from diff_nautobot_understack.clients.openstack import API
 from diff_nautobot_understack.network import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/network/adapters/openstack_network.py

@@ -1,7 +1,7 @@
 from diffsync import Adapter
 from pydantic import BaseModel
-from diff_nautobot_understack.clients.nautobot import API
 
+from diff_nautobot_understack.clients.nautobot import API
 from diff_nautobot_understack.network import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/network/adapters/ucvni.py

@@ -1,21 +1,25 @@
-from pprint import pprint
+from diffsync.diff import Diff
 from diffsync.enum import DiffSyncFlags
+from rich import print
+
 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()
-
+    try:
+        openstack_network.load()
+    except Exception:
+        print("Error retrieving networks from Openstack")
     ucvni_network = UcvniNetwork()
-    ucvni_network.load()
-    openstack_network_destination_ucvni_source = openstack_network.diff_from(
-        ucvni_network, flags=DiffSyncFlags.CONTINUE_ON_FAILURE
+    try:
+        ucvni_network.load()
+    except Exception:
+        print("Error retrieving ucvnis from Nautobot")
+    ucvni_network_destination_openstack_source = ucvni_network.diff_from(
+        openstack_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 ucvni_network_destination_openstack_source

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

@@ -14,5 +14,5 @@ class NetworkModel(DiffSyncModel):
     id: str
     name: str
     status: str
-    provider_physical_network: str
-    vni_id: int
+    provider_physical_network: str | None = None
+    vni_id: int | None = None

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

@@ -1,9 +1,16 @@
+import uuid
+
 from diffsync import Adapter
-from diff_nautobot_understack.clients.nautobot import API
 
+from diff_nautobot_understack.clients.nautobot import API
 from diff_nautobot_understack.project import models
 
 
+def _remove_hyphens(tenant_id: str):
+    uuid_obj = uuid.UUID(tenant_id)
+    return str(uuid_obj.hex)
+
+
 class Tenant(Adapter):
     project = models.ProjectModel
 
@@ -13,16 +20,17 @@ class Tenant(Adapter):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.api_client = API()
+        self.tenant_name = kwargs["name"]
 
     def load(self):
-        url = "/api/tenancy/tenants/?include=relationships"
+        url = f"/api/tenancy/tenants/?name={self.tenant_name}&include=relationships"
 
         tenants_response = self.api_client.make_api_request(url, paginated=True)
 
         for tenant in tenants_response:
             self.add(
                 self.project(
-                    id=tenant.get("id"),
+                    id=_remove_hyphens(tenant.get("id")),
                     name=tenant.get("name"),
                     description=tenant.get("description"),
                 )

python/diff-nautobot-understack/diff_nautobot_understack/project/adapters/nautobot_tenant.py

@@ -1,8 +1,12 @@
+import logging
+
 from diffsync import Adapter
-from diff_nautobot_understack.clients.openstack import API
 
+from diff_nautobot_understack.clients.openstack import API
 from diff_nautobot_understack.project import models
 
+logger = logging.getLogger(__name__)
+
 
 class Project(Adapter):
     project = models.ProjectModel
@@ -13,14 +17,18 @@ class Project(Adapter):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         openstack_api = API()
+        self.project_name = kwargs["name"]
         self.cloud = openstack_api.cloud_connection
 
     def load(self):
-        for project in self.cloud.identity.projects():
-            self.add(
-                self.project(
-                    id=project.id,
-                    name=project.name,
-                    description=project.description,
-                )
+        os_project = self.cloud.get_project(name_or_id=self.project_name)
+        if not os_project:
+            logger.error(f"Project '{self.project_name}' not found.")
+            return
+        self.add(
+            self.project(
+                id=os_project.id,
+                name=os_project.name,
+                description=os_project.description,
             )
+        )

python/diff-nautobot-understack/diff_nautobot_understack/project/adapters/openstack_project.py

@@ -1,19 +1,19 @@
-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.project.adapters.openstack_project import Project
+from diff_nautobot_understack.settings import app_settings as settings
 
 
-def openstack_project_diff_from_nautobot_tenant():
-    openstack_project = Project()
+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()
 
-    nautobot_tenant = Tenant()
+    nautobot_tenant = Tenant(name=project_name)
     nautobot_tenant.load()
-    openstack_project_destination_tenant_source = openstack_project.diff_from(
-        nautobot_tenant, flags=DiffSyncFlags.CONTINUE_ON_FAILURE
+    tenant_destination_openstack_project_source = nautobot_tenant.diff_from(
+        openstack_project, 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 tenant_destination_openstack_project_source