PUC-740: linting

Author: haseebsyed12

python/diff-nautobot-understack/README.md

@@ -20,8 +20,8 @@ This tool compares data between Nautobot and OpenStack.
 4. poetry lock
 5. poetry install
 6. Export environment variables (or add them to a .env file):
-   1. export nautobot_api_token=<get_token_from_nautobot_dev>
-   2. export nautobot_url=https://nautobot.staging.undercloud.rackspace.net (no need to export for dev env)
+   1. export NAUTOBOT_TOKEN=<get_token_from_nautobot_dev>
+   2. export NAUTOBOT_URL=https://nautobot.staging.undercloud.rackspace.net (no need to export for dev env)
    3. export OS_CLOUD=uc-dev-infra
    4. 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))
 

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

@@ -1,17 +1,22 @@
-from typing import Optional
+import os
+import sys
 
 import typer
 from diffsync.diff import Diff
-from diff_nautobot_understack.project.main import (
-    openstack_project_diff_from_nautobot_tenant,
-)
+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
-from rich.console import Console
-from rich.table import Table
-from rich import print
+
+required_env_vars = ["NAUTOBOT_TOKEN", "NAUTOBOT_URL", "OS_CLOUD"]
+
 
 app = typer.Typer(
     name="diff",
@@ -25,7 +30,7 @@
 
 
 def display_output(
-    diff_result: Diff, diff_output: str, output_format: Optional[str] = None
+    diff_result: Diff, diff_output: str, output_format: str | None = None
 ):
     print(diff_result.summary())
     __output_format = (
@@ -84,5 +89,14 @@ def network(
     display_output(diff_result, "network", output_format)
 
 
-if __name__ == "__main__":
-    app()
+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/clients/nautobot.py

@@ -1,8 +1,9 @@
-import requests
-import logging
 import inspect
+import logging
 from urllib.parse import urljoin
 
+import requests
+
 from diff_nautobot_understack.settings import app_settings as settings
 
 
@@ -12,7 +13,7 @@ class API:
     def __init__(self):
         self.base_url = settings.nautobot_url
         self.s = requests.Session()
-        self.token = settings.nautobot_api_token
+        self.token = settings.nautobot_token
         self.s.headers.update({"Authorization": f"Token {self.token}"})
 
     def make_api_request(

python/diff-nautobot-understack/diff_nautobot_understack/network/adapters/openstack_network.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/ucvni.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/main.py

@@ -1,5 +1,7 @@
 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,
 )
@@ -8,10 +10,15 @@
 
 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()
+    try:
+        ucvni_network.load()
+    except Exception:
+        print("Error retrieving ucvnis from Nautobot")
     openstack_network_destination_ucvni_source = openstack_network.diff_from(
         ucvni_network, flags=DiffSyncFlags.CONTINUE_ON_FAILURE
     )

python/diff-nautobot-understack/diff_nautobot_understack/network/models.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/project/adapters/nautobot_tenant.py

@@ -1,8 +1,8 @@
 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
 
 

python/diff-nautobot-understack/diff_nautobot_understack/project/adapters/openstack_project.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.project import models
 
 

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

@@ -1,7 +1,8 @@
 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
 
 

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

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