PUC-740: review comments

Author: haseebsyed12

python/diff-nautobot-understack/README.md

@@ -1,10 +1,17 @@
 
-cd python/diff-nautobot-understack
-python3 -m venv .venv
-source .venv/bin/activate
-poetry lock
-poetry install
+1. cd python/diff-nautobot-understack
+2. python3 -m venv .venv
+3. source .venv/bin/activate
+4. poetry lock
+5. poetry install
+6. export nautobot_api_token=<get_token_from_nautobot_dev>  (can be added in .env file too)
+7. export nautobot_url=https://nautobot.staging.undercloud.rackspace.net (no need to export for dev env)
+8. export OS_CLOUD=uc-dev-infra
+9. export OS_CLIENT_CONFIG_FILE=./my_clouds.yaml (set this if it is any other location [defined here](https://opendev.org/openstack/openstacksdk#getting-started))
 
-export NB_TOKEN=<get_token_from_nautobot_dev>
-poetry run diff-networks
-poetry run diff-projects
+- 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,37 @@
+import typer
+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
+
+app = typer.Typer(
+    name="diff",
+    add_completion=False,
+    help="compare data between Openstack and Nautobot.",
+)
+
+
+@app.command()
+def project(
+    name: str,
+    debug: bool = typer.Option(False, "--debug", "-v", help="Enable debug mode"),
+):
+    """Nautobot tenants ⟹ Openstack projects"""
+    settings.debug = debug
+    openstack_project_diff_from_nautobot_tenant(os_project=name)
+
+
+@app.command()
+def network(
+    debug: bool = typer.Option(False, "--debug", "-v", help="Enable debug mode"),
+):
+    """Nautobot ucvnis ⟹ Openstack networks"""
+    settings.debug = debug
+    openstack_network_diff_from_ucvni_network()
+
+
+if __name__ == "__main__":
+    app()

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

@@ -1,22 +1,19 @@
-import os
-
 import requests
 import logging
 import inspect
 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")
+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_api_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,9 +1,16 @@
+import uuid
+
 from diffsync import Adapter
 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

@@ -13,14 +13,15 @@ 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)
+        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

@@ -2,13 +2,15 @@
 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():
-    openstack_project = Project()
+def openstack_project_diff_from_nautobot_tenant(os_project=None):
+    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

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

@@ -0,0 +1,18 @@
+from typing import Optional
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(env_file="./.env", env_file_encoding="utf-8")
+
+    nautobot_api_token: Optional[str] = None
+    nautobot_url: str = "https://nautobot.dev.undercloud.rackspace.net"
+    debug: bool = False
+    os_cloud: Optional[str] = None
+    os_project: Optional[str] = "default"
+    os_client_config_file: Optional[str] = None
+
+
+Settings.model_rebuild()
+app_settings = Settings()