Cookie updated by NetworkToCode Cookie Drift Manager Tool (#264)

* Cookie updated by NetworkToCode Cookie Drift Manager Tool Template: ``` { "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "dir": "nautobot-app", "ref": "refs/tags/nautobot-app-v2.3.0", "path": null } ``` Cookie: ``` { "remote": "https://github.com/nautobot/nautobot-app-firewall-models.git", "path": "/tmp/tmpjesvwnzl/nautobot-app-firewall-models", "repository_path": "/tmp/tmpjesvwnzl/nautobot-app-firewall-models", "dir": "", "branch_prefix": "drift-manager", "context": { "codeowner_github_usernames": "@whitej6 @itdependsnetworks @jdrew82", "full_name": "Network to Code, LLC", "email": "[email protected]", "github_org": "nautobot", "app_name": "nautobot_firewall_models", "verbose_name": "Nautobot Firewall Models", "app_slug": "nautobot-firewall-models", "project_slug": "nautobot-app-firewall-models", "repo_url": "https://github.com/nautobot/nautobot-app-firewall-models", "base_url": "firewall-models", "min_nautobot_version": "2.0.0", "max_nautobot_version": "2.9999", "camel_name": "NautobotFirewallModels", "project_short_description": "Nautobot App to model firewall and security objects. Allows users to model policies in a vendor-neutral manner and use that data to drive network security automation", "model_class_name": "None", "open_source_license": "Apache-2.0", "docs_base_url": "https://docs.nautobot.com", "docs_app_url": "https://docs.nautobot.com/projects/firewall-models/en/latest", "_template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "_output_dir": "/tmp/tmpjesvwnzl", "_repo_dir": "/github/home/.cookiecutters/cookiecutter-nautobot-app/nautobot-app", "_checkout": "refs/tags/nautobot-app-v2.3.0" }, "base_branch": "develop", "remote_name": "origin", "pull_request_strategy": "PullRequestStrategy.CREATE", "post_actions": [ "PostAction.BLACK" ], "baked_commit_ref": "1724c1ae2e9ba5efe0dc010cb84291b6269b5fa5", "draft": true } ``` CLI Arguments: ``` { "cookie_dir": "", "input": false, "json_filename": "", "output_dir": "", "push": true, "template": "", "template_dir": "", "template_ref": "refs/tags/nautobot-app-v2.3.0", "pull_request": null, "post_action": [], "disable_post_actions": false, "draft": null } ``` * Remove Bandit * Ruff Fixes * Update 264.housekeeping Co-authored-by: Gary Snider <[email protected]> * Update test_capirca.py Co-authored-by: Gary Snider <[email protected]> * Apply suggestions from code review Co-authored-by: Gary Snider <[email protected]> --------- Co-authored-by: bakebot <[email protected]> Co-authored-by: Stephen Kiely <[email protected]> Co-authored-by: Gary Snider <[email protected]>
nautobot · Aug 19, 2024 · 55513f2 · 55513f2
1 parent d733001
commit 55513f2
Show file tree

Hide file tree

Showing 75 changed files with 261 additions and 493 deletions.
diff --git a/.bandit.yml b/.bandit.yml
diff --git a/.cookiecutter.json b/.cookiecutter.json
@@ -21,15 +21,15 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.2.1",
+            "template_ref": "refs/tags/nautobot-app-v2.3.0",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
             "post_actions": [
                 "black"
             ],
             "draft": true,
-            "baked_commit_ref": "1724c1ae2e9ba5efe0dc010cb84291b6269b5fa5"
+            "baked_commit_ref": "fcb62757ef4e78dd327cacb192ea19f1ac5344f8"
         }
     }
 }
diff --git a/.dockerignore b/.dockerignore
@@ -19,7 +19,6 @@ FAQ.md
 .git/
 .gitignore
 .github
-tasks.py
 LICENSE
 **/*.log
 **/.vscode/

diff --git a/.flake8 b/.flake8
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,7 +16,7 @@ env:
   APP_NAME: "nautobot-app-firewall-models"
 
 jobs:
-  black:
+  ruff-format:
     runs-on: "ubuntu-22.04"
     env:
       INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
@@ -25,20 +25,9 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: black"
-        run: "poetry run invoke black"
-  bandit:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: bandit"
-        run: "poetry run invoke bandit"
-  ruff:
+      - name: "Linting: ruff format"
+        run: "poetry run invoke ruff --action format"
+  ruff-lint:
     runs-on: "ubuntu-22.04"
     env:
       INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
@@ -60,17 +49,6 @@ jobs:
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
-  flake8:
-    runs-on: "ubuntu-22.04"
-    env:
-      INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v6"
-      - name: "Linting: flake8"
-        run: "poetry run invoke flake8"
   poetry:
     runs-on: "ubuntu-22.04"
     env:
@@ -95,12 +73,10 @@ jobs:
         run: "poetry run invoke yamllint"
   check-in-docker:
     needs:
-      - "bandit"
-      - "ruff"
-      - "flake8"
+      - "ruff-format"
+      - "ruff-lint"
       - "poetry"
       - "yamllint"
-      - "black"
     runs-on: "ubuntu-22.04"
     strategy:
       fail-fast: true

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
   <a href="https://pypi.org/project/nautobot-firewall-models/"><img src="https://img.shields.io/pypi/v/nautobot-firewall-models"></a>
   <a href="https://pypi.org/project/nautobot-firewall-models/"><img src="https://img.shields.io/pypi/dm/nautobot-firewall-models"></a>
   <br>
-  An <a href="https://www.networktocode.com/nautobot/apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
+  An <a href="https://networktocode.com/nautobot-apps/">App</a> for <a href="https://nautobot.com/">Nautobot</a>.
 </p>
 
 ## Overview

diff --git a/changes/264.housekeeping b/changes/264.housekeeping
@@ -0,0 +1 @@
+Rebaked from the cookie `nautobot-app-v2.3.0`.
diff --git a/development/app_config_schema.py b/development/app_config_schema.py
@@ -1,4 +1,5 @@
 """App Config Schema Generator and Validator."""
+
 import json
 from importlib import import_module
 from os import getenv

diff --git a/development/docker-compose.base.yml b/development/docker-compose.base.yml
@@ -13,7 +13,6 @@ x-nautobot-base: &nautobot-base
     - "creds.env"
   tty: true
 
-version: "3.8"
 services:
   nautobot:
     depends_on:

diff --git a/development/docker-compose.dev.yml b/development/docker-compose.dev.yml
@@ -3,7 +3,6 @@
 # any override will need to include these volumes to use them.
 # see:  https://github.com/docker/compose/issues/3729
 ---
-version: "3.8"
 services:
   nautobot:
     command: "nautobot-server runserver 0.0.0.0:8080"

diff --git a/development/docker-compose.mysql.yml b/development/docker-compose.mysql.yml
@@ -1,6 +1,4 @@
 ---
-version: "3.8"
-
 services:
   nautobot:
     environment:
@@ -19,7 +17,6 @@ services:
   db:
     image: "mysql:8"
     command:
-      - "--default-authentication-plugin=mysql_native_password"
       - "--max_connections=1000"
     env_file:
       - "development.env"

diff --git a/development/docker-compose.postgres.yml b/development/docker-compose.postgres.yml
@@ -1,6 +1,4 @@
 ---
-version: "3.8"
-
 services:
   nautobot:
     environment:

diff --git a/development/docker-compose.redis.yml b/development/docker-compose.redis.yml
@@ -1,5 +1,4 @@
 ---
-version: "3.8"
 services:
   redis:
     image: "redis:6-alpine"

diff --git a/development/nautobot_config.py b/development/nautobot_config.py
@@ -1,4 +1,5 @@
 """Nautobot development configuration file."""
+
 import os
 import sys
 
@@ -9,7 +10,7 @@
 # Debug
 #
 
-DEBUG = is_truthy(os.getenv("NAUTOBOT_DEBUG", False))
+DEBUG = is_truthy(os.getenv("NAUTOBOT_DEBUG", "false"))
 _TESTING = len(sys.argv) > 1 and sys.argv[1] == "test"
 
 if DEBUG and not _TESTING:
@@ -47,9 +48,10 @@
         "PASSWORD": os.getenv("NAUTOBOT_DB_PASSWORD", ""),  # Database password
         "HOST": os.getenv("NAUTOBOT_DB_HOST", "localhost"),  # Database server
         "PORT": os.getenv(
-            "NAUTOBOT_DB_PORT", default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"]
+            "NAUTOBOT_DB_PORT",
+            default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"],
         ),  # Database port, default to postgres
-        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", 300)),  # Database timeout
+        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", "300")),  # Database timeout
         "ENGINE": nautobot_db_engine,
     }
 }

diff --git a/docs/assets/extra.css b/docs/assets/extra.css
@@ -96,7 +96,7 @@ a.autorefs-external:hover::after {
 }
 
 
-/* Customization for mkdocs-version-annotations */
+/* Customization for markdown-version-annotations */
 :root {
     /* Icon for "version-added" admonition: Material Design Icons "plus-box-outline" */
     --md-admonition-icon--version-added: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 19V5H5v14h14m0-16a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h14m-8 4h2v4h4v2h-4v4h-2v-4H7v-2h4V7Z"/></svg>');

diff --git a/docs/dev/contributing.md b/docs/dev/contributing.md
@@ -4,7 +4,7 @@ The project is packaged with a light [development environment](dev_environment.m
 
 The project is following Network to Code software development guidelines and is leveraging the following:
 
-- Python linting and formatting: `black`, `pylint`, `bandit`, `flake8`, and `ruff`.
+- Python linting and formatting: `pylint` and `ruff`.
 - YAML linting is done with `yamllint`.
 - Django unit test to ensure the app is working properly.
 

diff --git a/docs/dev/dev_environment.md b/docs/dev/dev_environment.md
@@ -123,10 +123,7 @@ Each command can be executed with `invoke <command>`. All commands support the a
 #### Testing
 
 ```
-  bandit           Run bandit to validate basic static code security analysis.
-  black            Run black to check that Python files adhere to its style standards.
-  flake8           Run flake8 to check that Python files adhere to its style standards.
-  ruff             Run ruff to validate docstring formatting adheres to NTC defined standards.
+  ruff             Run ruff to perform code formatting and/or linting.
   pylint           Run pylint code analysis.
   tests            Run all tests for this app.
   unittest         Run Django unit tests for the app.
@@ -454,7 +451,7 @@ This is the same as running:
 
 ### Tests
 
-To run tests against your code, you can run all of the tests that TravisCI runs against any new PR with:
+To run tests against your code, you can run all of the tests that the CI runs against any new PR with:
 
 ```bash
 ➜ invoke tests
@@ -464,9 +461,6 @@ To run an individual test, you can run any or all of the following:
 
 ```bash
 ➜ invoke unittest
-➜ invoke bandit
-➜ invoke black
-➜ invoke flake8
 ➜ invoke ruff
 ➜ invoke pylint
 ```

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 mkdocs==1.5.2
 mkdocs-material==9.1.15
-mkdocs-version-annotations==1.0.0
+markdown-version-annotations==1.0.1
 mkdocstrings-python==1.5.2
 mkdocstrings==0.22.0
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,6 +72,8 @@ extra:
       link: "https://twitter.com/networktocode"
       name: "Network to Code Twitter"
 markdown_extensions:
+  - "markdown_version_annotations":
+      admonition_tag: "???"
   - "admonition"
   - "toc":
       permalink: true
@@ -89,7 +91,6 @@ markdown_extensions:
   - "footnotes"
 plugins:
   - "search"
-  - "mkdocs-version-annotations"
   - "mkdocstrings":
       default_handler: "python"
       handlers:

diff --git a/nautobot_firewall_models/__init__.py b/nautobot_firewall_models/__init__.py
@@ -1,4 +1,5 @@
 """App declaration for nautobot_firewall_models."""
+
 # Metadata is inherited from Nautobot. If not including Nautobot in the environment, this should be added
 from importlib import metadata
 

diff --git a/nautobot_firewall_models/api/serializers.py b/nautobot_firewall_models/api/serializers.py
@@ -1,7 +1,7 @@
 """API serializers for firewall models."""
 
-from rest_framework import serializers
 from nautobot.apps.api import NautobotModelSerializer, ValidatedModelSerializer
+from rest_framework import serializers
 
 from nautobot_firewall_models import models
 

diff --git a/nautobot_firewall_models/api/urls.py b/nautobot_firewall_models/api/urls.py
@@ -4,7 +4,6 @@
 
 from nautobot_firewall_models.api import views
 
-
 router = OrderedDefaultRouter()
 router.register("address-object", views.AddressObjectViewSet)
 router.register("address-object-group", views.AddressObjectGroupViewSet)

diff --git a/nautobot_firewall_models/choices.py b/nautobot_firewall_models/choices.py
@@ -2,7 +2,6 @@
 
 from netutils.protocol_mapper import PROTO_NAME_TO_NUM
 
-
 IP_PROTOCOL_CHOICES = tuple((i, i) for i in PROTO_NAME_TO_NUM.keys())  # pylint: disable=consider-iterating-dictionary
 
 ACTION_CHOICES = (("allow", "allow"), ("deny", "deny"), ("drop", "drop"), ("remark", "remark"))
diff --git a/nautobot_firewall_models/constants.py b/nautobot_firewall_models/constants.py
@@ -1,4 +1,5 @@
 """Constants file."""
+
 from django.conf import settings
 
 # This is used to map the slug of the platform in the customers environment to the expected name that Capirca is looking for

diff --git a/nautobot_firewall_models/fields.py b/nautobot_firewall_models/fields.py
@@ -1,7 +1,6 @@
 """Creating fields for IPRange models."""
 
 from django import forms
-
 from nautobot.ipam.formfields import IPAddressFormField
 
 

diff --git a/nautobot_firewall_models/filters.py b/nautobot_firewall_models/filters.py
@@ -1,13 +1,14 @@
 """Filtering for Firewall Model App."""
+
+import django_filters
 from django.contrib.contenttypes.fields import GenericRelation
 from django.core.exceptions import ValidationError
 from django.db.models import Q
-import django_filters
 from nautobot.apps.filters import (
-    NautobotFilterSet,
-    StatusModelFilterSetMixin,
     MultiValueCharFilter,
     NaturalKeyOrPKMultipleChoiceFilter,
+    NautobotFilterSet,
+    StatusModelFilterSetMixin,
 )
 from nautobot.dcim.models import Device
 

diff --git a/nautobot_firewall_models/forms.py b/nautobot_firewall_models/forms.py
@@ -1,6 +1,12 @@
 """Forms for the Firewall app."""
 
 from django import forms
+from nautobot.apps.forms import (
+    DynamicModelChoiceField,
+    DynamicModelMultipleChoiceField,
+    TagFilterField,
+    add_blank_choice,
+)
 from nautobot.dcim.models import Device, Interface
 from nautobot.extras.forms import (
     CustomFieldModelCSVForm,
@@ -15,12 +21,6 @@
 from nautobot.ipam.models import VRF, IPAddress, Prefix
 from nautobot.tenancy.forms import TenancyFilterForm, TenancyForm
 from nautobot.tenancy.models import Tenant
-from nautobot.apps.forms import (
-    DynamicModelChoiceField,
-    DynamicModelMultipleChoiceField,
-    TagFilterField,
-    add_blank_choice,
-)
 
 from nautobot_firewall_models import choices, fields, models
 

diff --git a/nautobot_firewall_models/homepage.py b/nautobot_firewall_models/homepage.py
@@ -1,7 +1,8 @@
 """Adds App items to homepage."""
+
 from nautobot.core.apps import HomePageItem, HomePagePanel
 
-from nautobot_firewall_models.models import Policy, PolicyRule, CapircaPolicy, NATPolicy, NATPolicyRule
+from nautobot_firewall_models.models import CapircaPolicy, NATPolicy, NATPolicyRule, Policy, PolicyRule
 
 layout = (
     HomePagePanel(

diff --git a/nautobot_firewall_models/jobs.py b/nautobot_firewall_models/jobs.py
@@ -1,11 +1,10 @@
 """Jobs to run backups, intended config, and compliance."""
 
-from nautobot.extras.jobs import Job, MultiObjectVar, get_task_logger
 from nautobot.core.celery import register_jobs
-
 from nautobot.dcim.models import Device
-from nautobot_firewall_models.models import CapircaPolicy
-from nautobot_firewall_models.models import Policy
+from nautobot.extras.jobs import Job, MultiObjectVar, get_task_logger
+
+from nautobot_firewall_models.models import CapircaPolicy, Policy
 
 logger = get_task_logger(__name__)