PUC-740: comparing data from Openstack Projects and Nautobot Tenants

Author: haseebsyed12

python/diff-nautobot-understack/README.md

@@ -6,4 +6,5 @@ poetry lock
 poetry install
 
 export NB_TOKEN=<get_token_from_nautobot_dev>
-poetry run diff-network
+poetry run diff-networks
+poetry run diff-projects

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

@@ -5,6 +5,9 @@
 OS_CLOUD = os.environ.get("OS_CLOUD", "uc-dev-infra")
 
 
+openstack.enable_logging(debug=True)
+
+
 class API:
     def __init__(self):
         self.cloud_connection = openstack.connect(cloud=OS_CLOUD)

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

@@ -1,23 +1,11 @@
 from pprint import pprint
-from diffsync 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
 
 
-class MyDiff(Diff):
-    """Custom Diff class to control the order of the site objects."""
-
-    @classmethod
-    def order_children_site(cls, children):
-        """Return the site children ordered in alphabetical order."""
-        keys = sorted(children.keys(), reverse=False)
-        for key in keys:
-            yield children[key]
-
-
 def openstack_network_diff_from_ucvni_network():
     openstack_network = OpenstackNetwork()
     openstack_network.load()

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

@@ -0,0 +1,29 @@
+from diffsync import Adapter
+from diff_nautobot_understack.clients.nautobot import API
+
+from diff_nautobot_understack.project import models
+
+
+class Tenant(Adapter):
+    project = models.ProjectModel
+
+    top_level = ["project"]
+    type = "Tenant"
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.api_client = API()
+
+    def load(self):
+        url = "/api/tenancy/tenants/?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"),
+                    name=tenant.get("name"),
+                    description=tenant.get("description"),
+                )
+            )

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

@@ -0,0 +1,26 @@
+from diffsync import Adapter
+from diff_nautobot_understack.clients.openstack import API
+
+from diff_nautobot_understack.project import models
+
+
+class Project(Adapter):
+    project = models.ProjectModel
+
+    top_level = ["project"]
+    type = "OpenstackProject"
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        openstack_api = API()
+        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,
+                )
+            )

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

@@ -1,15 +1,19 @@
-import openstack
+from pprint import pprint
+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
 
-openstack.enable_logging(debug=True)
 
+def openstack_project_diff_from_nautobot_tenant():
+    openstack_project = Project()
+    openstack_project.load()
 
-def list_projects(conn):
-    print("List Projects:")
-
-    for project in conn.identity.projects():
-        print(project)
-
-
-if __name__ == "__main__":
-    cloud_connection = openstack.connect(os_cloud="uc-dev-infra")
-    list_projects(cloud_connection)
+    nautobot_tenant = Tenant()
+    nautobot_tenant.load()
+    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)

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

@@ -0,0 +1,14 @@
+from diffsync import DiffSyncModel
+
+
+class ProjectModel(DiffSyncModel):
+    _modelname = "project"
+    _identifiers = ("id",)
+    _attributes = (
+        "name",
+        "description",
+    )
+
+    id: str
+    name: str
+    description: str

python/diff-nautobot-understack/pyproject.toml

@@ -13,8 +13,8 @@ diffsync = "^2.0.1"
 oslo-log = "^7.0.0"
 
 [tool.poetry.scripts]
-diff-network = "diff_nautobot_understack.network.main:openstack_network_diff_from_ucvni_network"
-
+diff-networks = "diff_nautobot_understack.network.main:openstack_network_diff_from_ucvni_network"
+diff-projects = "diff_nautobot_understack.project.main:openstack_project_diff_from_nautobot_tenant"
 
 [build-system]
 requires = ["poetry-core"]