Add PR review + fix linting tests

Author: chadell

examples/05-nautobot-peeringdb/adapter_nautobot.py

@@ -1,9 +1,10 @@
 """Diffsync adapter class for Nautobot."""
+# pylint: disable=import-error,no-name-in-module
 import os
 import requests
+from models import RegionModel, SiteModel
 from diffsync import DiffSync
 
-from .models import RegionModel, SiteModel
 
 NAUTOBOT_URL = os.getenv("NAUTOBOT_URL", "https://demo.nautobot.com")
 NAUTOBOT_TOKEN = os.getenv("NAUTOBOT_TOKEN", "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
@@ -15,6 +16,7 @@ class RegionNautobotModel(RegionModel):
     @classmethod
     def create(cls, diffsync, ids, attrs):
         """Create a new Region record in remote Nautobot.
+
         Args:
             diffsync (NautobotRemote): DiffSync adapter owning this Region
             ids (dict): Initial values for this model's _identifiers
@@ -33,6 +35,7 @@ def create(cls, diffsync, ids, attrs):
 
     def update(self, attrs):
         """Update an existing Region record in remote Nautobot.
+
         Args:
             attrs (dict): Updated values for this record's _attributes
         """
@@ -43,13 +46,13 @@ def update(self, attrs):
             data["description"] = attrs["description"]
         if "parent_name" in attrs:
             if attrs["parent_name"]:
-                data["parent"] = {"name": attrs["parent_name"]}
+                data["parent"] = str(self.get(self.region, attrs["parent_name"]).pk)
             else:
                 data["parent"] = None
         self.diffsync.patch(f"/api/dcim/regions/{self.pk}/", data)
         return super().update(attrs)
 
-    def delete(self):
+    def delete(self):  # pylint: disable= useless-super-delegation
         """Delete an existing Region record from remote Nautobot."""
         # self.diffsync.delete(f"/api/dcim/regions/{self.pk}/")
         return super().delete()
@@ -61,6 +64,7 @@ class SiteNautobotModel(SiteModel):
     @classmethod
     def create(cls, diffsync, ids, attrs):
         """Create a new Site in remote Nautobot.
+
         Args:
             diffsync (NautobotRemote): DiffSync adapter owning this Site
             ids (dict): Initial values for this model's _identifiers
@@ -82,6 +86,7 @@ def create(cls, diffsync, ids, attrs):
 
     def update(self, attrs):
         """Update an existing Site record in remote Nautobot.
+
         Args:
             attrs (dict): Updated values for this record's _attributes
         """
@@ -104,17 +109,14 @@ def update(self, attrs):
         self.diffsync.patch(f"/api/dcim/sites/{self.pk}/", data)
         return super().update(attrs)
 
-    def delete(self):
+    def delete(self):  # pylint: disable= useless-super-delegation
         """Delete an existing Site record from remote Nautobot."""
         # self.diffsync.delete(f"/api/dcim/sites/{self.pk}/")
         return super().delete()
 
 
 class NautobotRemote(DiffSync):
-    """DiffSync adapter class for loading data from a remote Nautobot instance using Python requests.
-    In a more realistic example, you'd probably use PyNautobot here instead of raw requests,
-    but we didn't want to add PyNautobot as a dependency of this plugin just to make an example more realistic.
-    """
+    """DiffSync adapter class for loading data from a remote Nautobot instance using Python requests."""
 
     # Model classes used by this adapter class
     region = RegionNautobotModel
@@ -125,6 +127,7 @@ class NautobotRemote(DiffSync):
 
     def __init__(self, *args, url=NAUTOBOT_URL, token=NAUTOBOT_TOKEN, **kwargs):
         """Instantiate this class, but do not load data immediately from the remote system.
+
         Args:
             url (str): URL of the remote Nautobot system
             token (str): REST API authentication token
@@ -142,9 +145,6 @@ def __init__(self, *args, url=NAUTOBOT_URL, token=NAUTOBOT_TOKEN, **kwargs):
 
     def load(self):
         """Load Region and Site data from the remote Nautobot instance."""
-        # To keep the example simple, we disable REST API pagination of results.
-        # In a real job, especially when expecting a large number of results,
-        # we'd want to handle pagination, or use something like PyNautobot.
         region_data = requests.get(f"{self.url}/api/dcim/regions/", headers=self.headers, params={"limit": 0}).json()
         regions = region_data["results"]
         while region_data["next"]:

examples/05-nautobot-peeringdb/adapter_peeringdb.py

@@ -1,18 +1,18 @@
 """Diffsync adapter class for PeeringDB."""
+# pylint: disable=import-error,no-name-in-module
 import requests
 from slugify import slugify
 import pycountry
-
+from models import RegionModel, SiteModel
 from diffsync import DiffSync
 from diffsync.exceptions import ObjectNotFound
 
-from .models import RegionModel, SiteModel
 
 PEERINGDB_URL = "https://peeringdb.com/"
 
 
 class PeeringDB(DiffSync):
-    """DiffSync adapter using pysnow to communicate with PeeringDB."""
+    """DiffSync adapter using requests to communicate with PeeringDB."""
 
     # Model classes used by this adapter class
     region = RegionModel
@@ -35,10 +35,21 @@ def load(self):
             try:
                 self.get(self.region, fac["city"])
             except ObjectNotFound:
+                # Adding the parent region if necessary
+                parent_name = pycountry.countries.get(alpha_2=fac["country"]).name
+                try:
+                    self.get(self.region, parent_name)
+                except ObjectNotFound:
+                    parent_region = self.region(
+                        name=parent_name,
+                        slug=slugify(parent_name),
+                    )
+                    self.add(parent_region)
+
                 region = self.region(
                     name=fac["city"],
                     slug=slugify(fac["city"]),
-                    parent_name=pycountry.countries.get(alpha_2=fac["country"]).name,
+                    parent_name=parent_name,
                 )
                 self.add(region)
 

examples/05-nautobot-peeringdb/requirements.txt

@@ -0,0 +1,5 @@
+diffsync
+python-slugify
+pycountry
+requests
+IPython