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

* 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.4.1", "path": null } ``` Cookie: ``` { "remote": "https://github.com/nautobot/nautobot-app-chatops.git", "path": "/tmp/tmprygef_3a/nautobot-app-chatops", "repository_path": "/tmp/tmprygef_3a/nautobot-app-chatops", "dir": "", "branch_prefix": "drift-manager", "context": { "codeowner_github_usernames": "@glennmatthews @jvanderaa @smk4664 @whitej6", "full_name": "Network to Code, LLC", "email": "[email protected]", "github_org": "nautobot", "app_name": "nautobot_chatops", "verbose_name": "Nautobot ChatOps App", "app_slug": "nautobot-chatops", "project_slug": "nautobot-app-chatops", "repo_url": "https://github.com/nautobot/nautobot-app-chatops", "base_url": "chatops", "min_nautobot_version": "2.0.0", "max_nautobot_version": "2.9999", "camel_name": "NautobotChatOpsApp", "project_short_description": "Nautobot ChatOps App", "model_class_name": "CommandLog", "open_source_license": "Apache-2.0", "docs_base_url": "https://docs.nautobot.com", "docs_app_url": "https://docs.nautobot.com/projects/chatops/en/latest", "_template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "_output_dir": "/tmp/tmprygef_3a", "_repo_dir": "/github/home/.cookiecutters/cookiecutter-nautobot-app/nautobot-app", "_checkout": "refs/tags/nautobot-app-v2.4.1" }, "base_branch": "develop", "remote_name": "origin", "pull_request_strategy": "PullRequestStrategy.CREATE", "post_actions": [ "PostAction.RUFF", "PostAction.POETRY" ], "baked_commit_ref": "8b2952d1ee1fdae0ae408ac26a8d09c9485da662", "draft": false } ``` CLI Arguments: ``` { "cookie_dir": "", "input": false, "json_filename": "", "output_dir": "", "push": true, "template": "", "template_dir": "", "template_ref": "refs/tags/nautobot-app-v2.4.1", "pull_request": null, "post_action": [ "ruff", "poetry" ], "disable_post_actions": true, "draft": false } ``` * Remove unnecessary Drift Management changes. * Add back the old test_views.py * Remove Architecture Decision Record URL * Apply code review suggestions. * Address additional feedback. --------- Co-authored-by: bakebot <[email protected]> Co-authored-by: Stephen Kiely <[email protected]>
nautobot · Jan 24, 2025 · 3c5c316 · 3c5c316
1 parent a5a5cd3
commit 3c5c316
Show file tree

Hide file tree

Showing 15 changed files with 1,302 additions and 1,188 deletions.
diff --git a/.cookiecutter.json b/.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": "8b2952d1ee1fdae0ae408ac26a8d09c9485da662"
+            "baked_commit_ref": "2d92f5251b7abddc2e71936a1d5d366dd6ad89af"
         }
     }
 }
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -27,7 +27,7 @@
     Please feel free to update todos to keep track of your own notes for WIP PRs.
 -->
 - [ ] Explanation of Change(s)
-- [ ] Added change log fragment(s) (for more information see [the documentation](https://docs.nautobot.com/projects/core/en/stable/development/#creating-changelog-fragments))
+- [ ] Added change log fragment(s) (for more information see [the documentation](https://docs.nautobot.com/projects/core/en/stable/development/core/#creating-changelog-fragments))
 - [ ] Attached Screenshots, Payload Example
 - [ ] Unit, Integration Tests
 - [ ] Documentation Updates (when adding/changing features)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,34 @@
+<!--
+    Thank you for your interest in contributing to Nautobot ChatOps App! Please note
+    that our contribution policy recommends that a feature request or bug
+    report be opened for approval prior to filing a pull request. This
+    helps avoid wasting time and effort on something that we might not
+    be able to accept.
+
+    Please indicate the relevant feature request or bug report below.
+-->
+
+# Closes: #<ISSUE NUMBER GOES HERE>
+
+## What's Changed
+
+<!--
+    Please include:
+    - A summary of the proposed changes
+    - A sectioned breakdown for larger features under ## subheadings
+    - Screenshots, example payloads where relevant:
+      - Before/After for bugfixes
+      - Using a new feature
+-->
+
+## To Do
+
+<!--
+    Please feel free to update todos to keep track of your own notes for WIP PRs.
+-->
+- [ ] Explanation of Change(s)
+- [ ] Added change log fragment(s) (for more information see [the documentation](https://docs.nautobot.com/projects/core/en/stable/development/core/#creating-changelog-fragments))
+- [ ] Attached Screenshots, Payload Example
+- [ ] Unit, Integration Tests
+- [ ] Documentation Updates (when adding/changing features)
+- [ ] Outline Remaining Work, Constraints from Design
diff --git a/.github/workflows/ci.yml b/.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_CHATOPS_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_CHATOPS_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 }}

diff --git a/LICENSE b/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.

diff --git a/changes/+nautobot-app-v2.4.1.housekeeping b/changes/+nautobot-app-v2.4.1.housekeeping
@@ -0,0 +1 @@
+Rebaked from the cookie `nautobot-app-v2.4.1`.
diff --git a/development/docker-compose.dev.yml b/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"
diff --git a/development/docker-compose.mysql.yml b/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:

diff --git a/development/nautobot_config.py b/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

diff --git a/nautobot_chatops/api/serializers.py b/nautobot_chatops/api/serializers.py
@@ -1,40 +1,35 @@
-"""API Serializers for ChatOps App."""
+"""API serializers for nautobot_chatops."""
 
-from nautobot.core.api import NautobotModelSerializer
-from rest_framework import serializers
+from nautobot.apps.api import NautobotModelSerializer, TaggedModelSerializerMixin
 
-from nautobot_chatops.models import AccessGrant, CommandLog, CommandToken
+from nautobot_chatops import models
 
 
-class CommandTokenSerializer(NautobotModelSerializer):
-    """API serializer for interacting with CommandToken objects."""
-
-    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_chatops-api:commandtoken-detail")
+class CommandLogSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
+    """CommandLog Serializer."""
 
     class Meta:
-        """Meta for CommandToken Serializer."""
+        """Meta attributes."""
 
-        model = CommandToken
+        model = models.CommandLog
         fields = "__all__"
 
 
-class AccessGrantSerializer(NautobotModelSerializer):
-    """API serializer for interacting with AccessGrant objects."""
-
-    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:nautobot_chatops-api:accessgrant-detail")
+class CommandTokenSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
+    """CommandToken Serializer."""
 
     class Meta:
-        """Meta for AccessGrant Serializer."""
+        """Meta attributes."""
 
-        model = AccessGrant
+        model = models.CommandToken
         fields = "__all__"
 
 
-class CommandLogSerializer(NautobotModelSerializer):
-    """API serializer for interacting with CommandLog objects."""
+class AccessGrantSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=too-many-ancestors
+    """AccessGrant Serializer."""
 
     class Meta:
-        """Meta for CommandLog Serializer."""
+        """Meta attributes."""
 
-        model = CommandLog
+        model = models.AccessGrant
         fields = "__all__"
diff --git a/nautobot_chatops/api/urls.py b/nautobot_chatops/api/urls.py
@@ -1,6 +1,4 @@
-"""Django urlpatterns declaration for nautobot_chatops app."""
-
-import logging
+"""Django API urlpatterns declaration for nautobot_chatops app."""
 
 from django.urls import path
 from nautobot.apps.api import OrderedDefaultRouter
@@ -9,15 +7,13 @@
     AccessGrantViewSet,
     CommandLogViewSet,
     CommandTokenViewSet,
-    NautobotChatopsRootView,
 )
 from nautobot_chatops.api.views.lookup import AccessLookupView, UserEmailLookupView
 from nautobot_chatops.api.views.mattermost import MattermostInteractionView, MattermostSlashCommandView
 from nautobot_chatops.api.views.ms_teams import MSTeamsMessagesView
 from nautobot_chatops.api.views.slack import SlackEventAPIView, SlackInteractionView, SlackSlashCommandView
 from nautobot_chatops.api.views.webex import WebexView
 
-logger = logging.getLogger(__name__)
 urlpatterns = [
     path("lookup/", AccessLookupView.as_view(), name="access_lookup"),
     path("email-lookup/", UserEmailLookupView.as_view(), name="email_lookup"),
@@ -31,7 +27,7 @@
 ]
 
 router = OrderedDefaultRouter()
-router.APIRootView = NautobotChatopsRootView
+# add the name of your api endpoint, usually hyphenated model name in plural, e.g. "my-model-classes"
 router.register("commandtoken", CommandTokenViewSet)
 router.register("accessgrant", AccessGrantViewSet)
 router.register("commandlog", CommandLogViewSet)

diff --git a/nautobot_chatops/api/views/generic.py b/nautobot_chatops/api/views/generic.py
@@ -1,21 +1,12 @@
 """API Views for Nautobot Chatops."""
 
 from nautobot.apps.api import NautobotModelViewSet
-from rest_framework.routers import APIRootView
 
 from nautobot_chatops.api.serializers import AccessGrantSerializer, CommandLogSerializer, CommandTokenSerializer
 from nautobot_chatops.filters import AccessGrantFilterSet, CommandLogFilterSet, CommandTokenFilterSet
 from nautobot_chatops.models import AccessGrant, CommandLog, CommandToken
 
 
-class NautobotChatopsRootView(APIRootView):
-    """Nautobot Chatops API root view."""
-
-    def get_view_name(self):
-        """Return name for the Nautobot Chatops API Root."""
-        return "Nautobot Chatops"
-
-
 class CommandTokenViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
     """API viewset for interacting with CommandToken objects."""
 

diff --git a/nautobot_chatops/urls.py b/nautobot_chatops/urls.py
@@ -89,3 +89,5 @@
     *grafana_urlpatterns,
     path("docs/", RedirectView.as_view(url=static("nautobot_chatops/docs/index.html")), name="docs"),
 ]
+
+app_name = "nautobot_chatops"