Merge pull request #287 from nautobot/drift-manager/pr

Cookie updated by NetworkToCode Cookie Drift Manager Tool

.cookiecutter.json

@@ -21,7 +21,7 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.4.0",
+            "template_ref": "refs/tags/nautobot-app-v2.4.1",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
@@ -30,7 +30,7 @@
                 "poetry"
             ],
             "draft": false,
-            "baked_commit_ref": "40d9cefc5c5b9f7db4b1c9bdb3e6645a4dc4933c"
+            "baked_commit_ref": "b5d763fab2885bec541b910e18c19d5a06238648"
         }
     }
 }

.github/workflows/ci.yml

@@ -25,6 +25,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff format"
         run: "poetry run invoke ruff --action format"
   ruff-lint:
@@ -36,6 +38,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff"
         run: "poetry run invoke ruff --action lint"
   check-docs-build:
@@ -47,6 +51,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
   poetry:
@@ -58,6 +64,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Checking: poetry lock file"
         run: "poetry run invoke lock --check"
   yamllint:
@@ -69,6 +77,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
   check-in-docker:
@@ -91,6 +101,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "true"
@@ -146,6 +158,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "true"
@@ -187,6 +201,8 @@ jobs:
           fetch-depth: "0"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check for changelog entry"
         run: |
           git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}

LICENSE

@@ -1,6 +1,6 @@
 Apache Software License 2.0
 
-Copyright (c) 2024, Network to Code, LLC
+Copyright (c) 2025, Network to Code, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

changes/+nautobot-app-v2.4.1.housekeeping

@@ -0,0 +1 @@
+Rebaked from the cookie `nautobot-app-v2.4.1`.

development/docker-compose.dev.yml

@@ -45,10 +45,12 @@ services:
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
-# To expose postgres or redis to the host uncomment the following
-# postgres:
+# To expose postgres (5432), myql (3306) on db service or redis (6379) to the host uncomment the
+# following. Ensure to match the 2 idented spaces which to have the service nested under services.
+# db:
 #   ports:
 #     - "5432:5432"
+#     - "3306:3306"
 # redis:
 #   ports:
 #     - "6379:6379"

development/docker-compose.mysql.yml

@@ -14,6 +14,13 @@ services:
       - "development.env"
       - "creds.env"
       - "development_mysql.env"
+  beat:
+    environment:
+      - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"
+    env_file:
+      - "development.env"
+      - "creds.env"
+      - "development_mysql.env"
   db:
     image: "mysql:8"
     command:

development/nautobot_config.py

@@ -4,7 +4,7 @@
 import sys
 
 from nautobot.core.settings import *  # noqa: F403  # pylint: disable=wildcard-import,unused-wildcard-import
-from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
+from nautobot.core.settings_funcs import is_truthy
 
 #
 # Debug
@@ -65,16 +65,8 @@
 #
 
 # The django-redis cache is used to establish concurrent locks using Redis.
-CACHES = {
-    "default": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": parse_redis_connection(redis_database=0),
-        "TIMEOUT": 300,
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-        },
-    }
-}
+# Inherited from nautobot.core.settings
+# CACHES = {....}
 
 #
 # Celery settings are not defined here because they can be overloaded with

mkdocs.yml

@@ -128,6 +128,7 @@ nav:
       - Extending the App: "dev/extending.md"
       - Contributing to the App: "dev/contributing.md"
       - Development Environment: "dev/dev_environment.md"
+      - Release Checklist: "dev/release_checklist.md"
       # - Architecture Decision Records: "dev/arch_decision.md"
       - Code Reference:
           - "dev/code_reference/index.md"

nautobot_firewall_models/api/serializers.py

@@ -1,12 +1,12 @@
-"""API serializers for firewall models."""
+"""API serializers for nautobot_firewall_models."""
 
-from nautobot.apps.api import NautobotModelSerializer, ValidatedModelSerializer
+from nautobot.apps.api import NautobotModelSerializer, TaggedModelSerializerMixin, ValidatedModelSerializer
 from rest_framework import serializers
 
 from nautobot_firewall_models import models
 
 
-class IPRangeSerializer(NautobotModelSerializer):
+class IPRangeSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
     """IPRange Serializer."""
 
     start_address = serializers.CharField()
@@ -49,7 +49,7 @@ def validate(self, data):
         return super().validate(data)
 
 
-class FQDNSerializer(NautobotModelSerializer):
+class FQDNSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """FQDN Serializer."""
 
     class Meta:
@@ -59,7 +59,7 @@ class Meta:
         fields = "__all__"
 
 
-class AddressObjectSerializer(NautobotModelSerializer):
+class AddressObjectSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """AddressObject Serializer."""
 
     class Meta:
@@ -69,7 +69,7 @@ class Meta:
         fields = "__all__"
 
 
-class AddressObjectGroupSerializer(NautobotModelSerializer):
+class AddressObjectGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """AddressObjectGroup Serializer."""
 
     class Meta:
@@ -79,7 +79,7 @@ class Meta:
         fields = "__all__"
 
 
-class ApplicationObjectSerializer(NautobotModelSerializer):
+class ApplicationObjectSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """ApplicationObject Serializer."""
 
     class Meta:
@@ -89,7 +89,7 @@ class Meta:
         fields = "__all__"
 
 
-class ApplicationObjectGroupSerializer(NautobotModelSerializer):
+class ApplicationObjectGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """ApplicationObjectGroup Serializer."""
 
     class Meta:
@@ -99,7 +99,7 @@ class Meta:
         fields = "__all__"
 
 
-class ServiceObjectSerializer(NautobotModelSerializer):
+class ServiceObjectSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """ServiceObject Serializer."""
 
     class Meta:
@@ -109,7 +109,7 @@ class Meta:
         fields = "__all__"
 
 
-class ServiceObjectGroupSerializer(NautobotModelSerializer):
+class ServiceObjectGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """ServiceObjectGroup Serializer."""
 
     class Meta:
@@ -119,7 +119,7 @@ class Meta:
         fields = "__all__"
 
 
-class UserObjectSerializer(NautobotModelSerializer):
+class UserObjectSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """UserObject Serializer."""
 
     class Meta:
@@ -129,7 +129,7 @@ class Meta:
         fields = "__all__"
 
 
-class UserObjectGroupSerializer(NautobotModelSerializer):
+class UserObjectGroupSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """UserObjectGroup Serializer."""
 
     class Meta:
@@ -139,7 +139,7 @@ class Meta:
         fields = "__all__"
 
 
-class ZoneSerializer(NautobotModelSerializer):
+class ZoneSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """Zone Serializer."""
 
     class Meta:
@@ -149,7 +149,7 @@ class Meta:
         fields = "__all__"
 
 
-class PolicyRuleSerializer(NautobotModelSerializer):
+class PolicyRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """PolicyRule Serializer."""
 
     index = serializers.IntegerField(required=False, default=None)
@@ -161,7 +161,7 @@ class Meta:
         fields = "__all__"
 
 
-class PolicySerializer(NautobotModelSerializer):
+class PolicySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """Policy Serializer."""
 
     class Meta:
@@ -171,7 +171,7 @@ class Meta:
         fields = "__all__"
 
 
-class NATPolicyRuleSerializer(NautobotModelSerializer):
+class NATPolicyRuleSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """PolicyRule Serializer."""
 
     class Meta:
@@ -181,7 +181,7 @@ class Meta:
         fields = "__all__"
 
 
-class NATPolicySerializer(NautobotModelSerializer):
+class NATPolicySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """NATPolicy Serializer."""
 
     class Meta:
@@ -191,7 +191,7 @@ class Meta:
         fields = "__all__"
 
 
-class CapircaPolicySerializer(NautobotModelSerializer):
+class CapircaPolicySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     """CapircaPolicy Serializer."""
 
     class Meta:

nautobot_firewall_models/api/urls.py

@@ -1,10 +1,11 @@
-"""Django API urlpatterns declaration for firewall model app."""
+"""Django API urlpatterns declaration for nautobot_firewall_models app."""
 
 from nautobot.apps.api import OrderedDefaultRouter
 
 from nautobot_firewall_models.api import views
 
 router = OrderedDefaultRouter()
+# add the name of your api endpoint, usually hyphenated model name in plural, e.g. "my-model-classes"
 router.register("address-object", views.AddressObjectViewSet)
 router.register("address-object-group", views.AddressObjectGroupViewSet)
 router.register("application-object", views.ApplicationObjectViewSet)

nautobot_firewall_models/api/views.py

@@ -1,4 +1,4 @@
-"""API views for firewall models."""
+"""API views for nautobot_firewall_models."""
 
 from nautobot.apps.api import ModelViewSet, NautobotModelViewSet