Updates for Nautobot 2.0

.github/workflows/ci.yml

@@ -83,7 +83,7 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.8"]
-        nautobot-version: ["1.5.13"]
+        nautobot-version: ["v2.0.0-beta.1"]
     env:
       INVOKE_NAUTOBOT_SSOT_PYTHON_VER: "${{ matrix.python-version }}"
       INVOKE_NAUTOBOT_SSOT_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
@@ -119,19 +119,16 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10"]
         db-backend: ["postgresql"]
-        nautobot-version: ["latest"]
+        nautobot-version: ["v2.0.0-beta.1"]
         include:
-          - python-version: "3.10"
-            db-backend: "postgresql"
-            nautobot-version: "1.5.13"
-          - python-version: "3.7"
+          - python-version: "3.8"
             db-backend: "mysql"
-            nautobot-version: "1.5.13"
+            nautobot-version: "v2.0.0-beta.1"
           - python-version: "3.10"
             db-backend: "mysql"
-            nautobot-version: "stable"
+            nautobot-version: "v2.0.0-beta.1"
     runs-on: "ubuntu-20.04"
     env:
       INVOKE_NAUTOBOT_SSOT_PYTHON_VER: "${{ matrix.python-version }}"

development/development.env

@@ -42,8 +42,7 @@ MYSQL_ROOT_HOST=%
 NAUTOBOT_SSOT_HIDE_EXAMPLE_JOBS="False"
 
 NAUTOBOT_SSOT_ENABLE_INFOBLOX="True"
-NAUTOBOT_SSOT_INFOBLOX_DEFAULT_STATUS="active"
-NAUTOBOT_SSOT_INFOBLOX_ENABLE_RFC1918_NETWORK_CONTAINERS="True"
+NAUTOBOT_SSOT_INFOBLOX_DEFAULT_STATUS="Active"
 NAUTOBOT_SSOT_INFOBLOX_ENABLE_SYNC_TO_INFOBLOX="True"
 NAUTOBOT_SSOT_INFOBLOX_IMPORT_OBJECTS_IP_ADDRESSES="True"
 NAUTOBOT_SSOT_INFOBLOX_IMPORT_OBJECTS_SUBNETS="True"

development/nautobot_config.py

@@ -141,9 +141,6 @@
         "enable_infoblox": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_INFOBLOX")),
         "hide_example_jobs": is_truthy(os.getenv("NAUTOBOT_SSOT_HIDE_EXAMPLE_JOBS")),
         "infoblox_default_status": os.getenv("NAUTOBOT_SSOT_INFOBLOX_DEFAULT_STATUS", "active"),
-        "infoblox_enable_rfc1918_network_containers": is_truthy(
-            os.getenv("NAUTOBOT_SSOT_INFOBLOX_ENABLE_RFC1918_NETWORK_CONTAINERS")
-        ),
         "infoblox_enable_sync_to_infoblox": is_truthy(os.getenv("NAUTOBOT_SSOT_INFOBLOX_ENABLE_SYNC_TO_INFOBLOX")),
         "infoblox_import_objects_ip_addresses": is_truthy(
             os.getenv("NAUTOBOT_SSOT_INFOBLOX_IMPORT_OBJECTS_IP_ADDRESSES")

docs/user/developing_jobs.md

@@ -158,34 +158,6 @@ Similar to the database example further up, this suffers from having to perform
 
 Finally, there are a couple of further ideas that could be used to improve performance. These aren't as well analyzed as the prior ones and there might be built-in support in this app for the in the future:
 
-#### Escaping the Atomic Transaction
-
-In Nautobot 1.x, all Jobs are executed in an [atomic transaction](https://en.wikipedia.org/wiki/Atomicity_(database_systems)). Atomic transactions often incur a performance overhead. The following example highlights how to have your sync operation "escape" the atomic transaction:
-
-```python
-class DataSource(DataSource, Job):
-    ...  # Excluded most of the class definition for example brevity
-
-    def execute_sync(self):
-        self.log_info(obj=None, message="The actual sync happens in post_run to escape the atomic transaction.")
-
-    def post_run(self):
-        super().execute_sync()
-```
-
-Using this example, the CRUD (create, update and delete) operations of your job will not happen as part of the atomic database transaction, because `post_run` is run outside of that. This brings with it the following caveats:
-
-- The job result page in Nautobot will show the status of "Completed" _before_ your actual sync runs
-  - You will need to manually update the page to get further job log results
-  - The job result might still go into an erroneous state, updating the job result status
-- If you implement any further logic in `post_run` keep in mind that it doesn't bubble exceptions up to the job result page in Nautobot
-- If any exceptions are encountered during the CRUD operations (i.e. the diffsync models' `create`, `update` and `delete` methods) they will _not_ trigger a rollback of the objects created during this job
-
-Due to these caveats it is recommended that you check carefully whether this optimization actually benefits your use case or not before applying it in production code.
-
-!!! note
-    In Nautobot 2.0, jobs will no longer be atomic by default so this section will not apply anymore.
-
 #### Using Bulk ORM Operations
 
 Bulk ORM operations are available within Django to perform multiple inserts/updates in a single DB query. Take a look at the documentation for [bulk_create](https://docs.djangoproject.com/en/3.2/ref/models/querysets/#bulk-create) for example. These bulk operations should only be used very carefully in Nautobot. The following caveats apply when using them:

nautobot_ssot/__init__.py

@@ -1,11 +1,6 @@
 """Plugin declaration for nautobot_ssot."""
 # Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
-
-try:
-    from importlib import metadata
-except ImportError:
-    # Python version < 3.8
-    import importlib_metadata as metadata
+from importlib import metadata
 
 from nautobot.extras.plugins import PluginConfig
 
@@ -25,8 +20,8 @@ class NautobotSSOTPluginConfig(PluginConfig):
     description = "Nautobot App that enables Single Source of Truth.  Allows users to aggregate distributed data sources and/or distribute Nautobot data to other data sources such as databases and SDN controllers."
     base_url = "ssot"
     required_settings = []
-    min_version = "1.4.0"
-    max_version = "1.9999"
+    min_version = "2.0.0b1"
+    max_version = "2.9999"
     default_settings = {
         "enable_infoblox": False,
         "hide_example_jobs": True,

nautobot_ssot/choices.py

@@ -1,6 +1,6 @@
 """ChoiceSet classes for Single Source of Truth (SSoT)."""
 
-from nautobot.utilities.choices import ChoiceSet
+from nautobot.apps.choices import ChoiceSet
 
 
 class SyncLogEntryActionChoices(ChoiceSet):

nautobot_ssot/filters.py

@@ -3,7 +3,7 @@
 import django_filters
 from django.db.models import Q
 
-from nautobot.utilities.filters import BaseFilterSet
+from nautobot.apps.filters import BaseFilterSet
 
 from .models import Sync, SyncLogEntry
 
@@ -29,8 +29,12 @@ class Meta:
         model = SyncLogEntry
         fields = ["sync", "action", "status", "synced_object_type"]
 
-    def search(self, queryset, _name, value):  # pylint: disable=no-self-use
+    def search(self, queryset, _name, value):
         """String search of SyncLogEntry records."""
         if not value.strip():
             return queryset
-        return queryset.filter(Q(diff__icontains=value) | Q(message__icontains=value) | Q(object_repr__icontains=value))
+        return queryset.filter(
+            Q(diff__icontains=value)  # pylint: disable=unsupported-binary-operation
+            | Q(message__icontains=value)
+            | Q(object_repr__icontains=value)
+        )

nautobot_ssot/forms.py

@@ -2,7 +2,8 @@
 
 from django import forms
 
-from nautobot.utilities.forms import add_blank_choice, BootstrapMixin, BOOLEAN_WITH_BLANK_CHOICES
+from nautobot.apps.forms import add_blank_choice
+from nautobot.core.forms import BootstrapMixin, BOOLEAN_WITH_BLANK_CHOICES
 
 from .choices import SyncLogEntryActionChoices, SyncLogEntryStatusChoices
 from .models import Sync, SyncLogEntry

nautobot_ssot/integrations/infoblox/diffsync/adapters/infoblox.py

@@ -1,5 +1,4 @@
 """Infoblox Adapter for Infoblox integration with SSoT plugin."""
-import ipaddress
 import re
 
 from diffsync import DiffSync
@@ -9,7 +8,6 @@
 from nautobot_ssot.integrations.infoblox.utils.client import get_default_ext_attrs, get_dns_name
 from nautobot_ssot.integrations.infoblox.utils.diffsync import get_ext_attr_dict, build_vlan_map
 from nautobot_ssot.integrations.infoblox.diffsync.models.infoblox import (
-    InfobloxAggregate,
     InfobloxIPAddress,
     InfobloxNetwork,
     InfobloxVLANView,
@@ -42,8 +40,8 @@ def __init__(self, *args, job=None, sync=None, conn=None, **kwargs):
         self.subnets = []
 
         if self.conn in [None, False]:
-            self.job.log_failure(
-                message="Improperly configured settings for communicating to Infoblox. Please validate accuracy."
+            self.job.logger.error(
+                "Improperly configured settings for communicating to Infoblox. Please validate accuracy."
             )
             raise PluginImproperlyConfigured
 
@@ -66,7 +64,7 @@ def load_prefixes(self):
             new_pf = self.prefix(
                 network=_pf["network"],
                 description=_pf.get("comment", ""),
-                status=_pf.get("status", "active"),
+                status=_pf.get("status", "Active"),
                 ext_attrs={**default_ext_attrs, **pf_ext_attrs},
                 vlans=build_vlan_map(vlans=_pf["vlans"]) if _pf.get("vlans") else {},
             )
@@ -135,59 +133,15 @@ def load(self):
             if PLUGIN_CFG["infoblox_import_objects"].get("vlans"):
                 self.load_vlans()
         else:
-            self.job.log_info(
-                message="The `infoblox_import_objects` setting was not found so all objects will be imported."
-            )
+            self.job.logger.info("The `infoblox_import_objects` setting was not found so all objects will be imported.")
             self.load_prefixes()
             self.load_ipaddresses()
             self.load_vlanviews()
             self.load_vlans()
         for obj in ["prefix", "ipaddress", "vlangroup", "vlan"]:
             if obj in self.dict():
-                self.job.log(message=f"Loaded {len(self.dict()[obj])} {obj} from Infoblox.")
+                self.job.logger.info(f"Loaded {len(self.dict()[obj])} {obj} from Infoblox.")
 
     def sync_complete(self, source, diff, flags=DiffSyncFlags.NONE, logger=None):
         """Add tags and custom fields to synced objects."""
         source.tag_involved_objects(target=self)
-
-
-class InfobloxAggregateAdapter(DiffSync):
-    """DiffSync adapter using requests to communicate to Infoblox server."""
-
-    aggregate = InfobloxAggregate
-
-    top_level = ["aggregate"]
-
-    def __init__(self, *args, job=None, sync=None, conn=None, **kwargs):
-        """Initialize Infoblox.
-
-        Args:
-            job (object, optional): Infoblox job. Defaults to None.
-            sync (object, optional): Infoblox DiffSync. Defaults to None.
-            conn (object): InfobloxAPI connection.
-        """
-        super().__init__(*args, **kwargs)
-        self.job = job
-        self.sync = sync
-        self.conn = conn
-
-        if self.conn in [None, False]:
-            self.job.log_failure(
-                message="Improperly configured settings for communicating to Infoblox. Please validate accuracy."
-            )
-            raise PluginImproperlyConfigured
-
-    def load(self):
-        """Load aggregate models."""
-        containers = self.conn.get_network_containers()
-        default_ext_attrs = get_default_ext_attrs(review_list=containers)
-        for container in containers:
-            network = ipaddress.ip_network(container["network"])
-            container_ext_attrs = get_ext_attr_dict(extattrs=container.get("extattrs", {}))
-            if network.is_private and container["network"] in ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]:
-                new_aggregate = self.aggregate(
-                    network=container["network"],
-                    description=container["comment"] if container.get("comment") else "",
-                    ext_attrs={**default_ext_attrs, **container_ext_attrs},
-                )
-                self.add(new_aggregate)