Fix constance being accessed before database is ready and other fixes

changes/341.added

@@ -0,0 +1 @@
+Added a "grafana disabled" view in case a user clicks on a grafana nav menu item when the grafana integration is disabled.

changes/341.fixed

@@ -0,0 +1,4 @@
+Fixed django-constance not being upgradable due to this app accessing the database before migrations could run.
+Removed conditional logic for adding grafana navigation menu items.
+Fixed Nautobot v2.3 incompatibility caused by saved views not being able to determine the models' table classes.
+Added exception handling for cases where diffsync is not installed, since it's marked as optional.

changes/341.housekeeping

@@ -0,0 +1 @@
+Fixed dev environment nautobot_config.py to fall back to constance if environment variable is not used.

changes/341.removed

@@ -0,0 +1 @@
+Removed all grafana integration API files since there we no API views provided by grafana integration.

nautobot_chatops/api/urls.py

@@ -2,9 +2,8 @@
 
 import logging
 
-from django.urls import include, path
+from django.urls import path
 from nautobot.apps.api import OrderedDefaultRouter
-from nautobot.apps.config import get_app_settings_or_config
 
 from nautobot_chatops.api.views.generic import (
     AccessGrantViewSet,
@@ -13,44 +12,24 @@
     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"),
+    path("slack/slash_command/", SlackSlashCommandView.as_view(), name="slack_slash_command"),
+    path("slack/interaction/", SlackInteractionView.as_view(), name="slack_interaction"),
+    path("slack/event/", SlackEventAPIView.as_view(), name="slack_event"),
+    path("ms_teams/messages/", MSTeamsMessagesView.as_view(), name="ms_teams_messages"),
+    path("webex/", WebexView.as_view(), name="webex"),
+    path("mattermost/slash_command/", MattermostSlashCommandView.as_view(), name="mattermost_slash_command"),
+    path("mattermost/interaction/", MattermostInteractionView.as_view(), name="mattermost_interaction"),
 ]
 
-if get_app_settings_or_config("nautobot_chatops", "enable_slack"):
-    from nautobot_chatops.api.views.slack import SlackEventAPIView, SlackInteractionView, SlackSlashCommandView
-
-    urlpatterns += [
-        path("slack/slash_command/", SlackSlashCommandView.as_view(), name="slack_slash_command"),
-        path("slack/interaction/", SlackInteractionView.as_view(), name="slack_interaction"),
-        path("slack/event/", SlackEventAPIView.as_view(), name="slack_event"),
-    ]
-
-if get_app_settings_or_config("nautobot_chatops", "enable_ms_teams"):
-    from nautobot_chatops.api.views.ms_teams import MSTeamsMessagesView
-
-    urlpatterns += [
-        path("ms_teams/messages/", MSTeamsMessagesView.as_view(), name="ms_teams_messages"),
-    ]
-
-if get_app_settings_or_config("nautobot_chatops", "enable_webex"):
-    from nautobot_chatops.api.views.webex import WebexView
-
-    urlpatterns += [
-        path("webex/", WebexView.as_view(), name="webex"),
-    ]
-
-if get_app_settings_or_config("nautobot_chatops", "enable_mattermost"):
-    from nautobot_chatops.api.views.mattermost import MattermostInteractionView, MattermostSlashCommandView
-
-    urlpatterns += [
-        path("mattermost/slash_command/", MattermostSlashCommandView.as_view(), name="mattermost_slash_command"),
-        path("mattermost/interaction/", MattermostInteractionView.as_view(), name="mattermost_interaction"),
-    ]
-
 router = OrderedDefaultRouter()
 router.APIRootView = NautobotChatopsRootView
 router.register("commandtoken", CommandTokenViewSet)
@@ -60,5 +39,3 @@
 app_name = "nautobot_chatops-api"
 
 urlpatterns += router.urls
-
-urlpatterns += [path("grafana/", include("nautobot_chatops.integrations.grafana.api.urls"))]

nautobot_chatops/api/views/mattermost.py

@@ -15,6 +15,7 @@
 from nautobot_chatops.metrics import signature_error_cntr
 from nautobot_chatops.models import CommandToken
 from nautobot_chatops.utils import check_and_enqueue_command
+from nautobot_chatops.views import SettingsControlledViewMixin
 from nautobot_chatops.workers import commands_help, get_commands_registry, parse_command_string
 
 # pylint: disable=logging-fstring-interpolation
@@ -67,8 +68,14 @@ def verify_signature(request):
     return True, "Signature is valid"
 
 
+class MattermostView(SettingsControlledViewMixin, View):
+    """Base class for Mattermost views."""
+
+    enable_view_setting = "enable_mattermost"
+
+
 @method_decorator(csrf_exempt, name="dispatch")
-class MattermostSlashCommandView(View):
+class MattermostSlashCommandView(MattermostView):
     """Handle notifications from a Mattermost /command."""
 
     http_method_names = ["post"]
@@ -117,7 +124,7 @@ def post(self, request, *args, **kwargs):
 
 
 @method_decorator(csrf_exempt, name="dispatch")
-class MattermostInteractionView(View):
+class MattermostInteractionView(MattermostView):
     """Handle notifications resulting from a Mattermost interactive block."""
 
     http_method_names = ["post"]

nautobot_chatops/api/views/ms_teams.py

@@ -14,6 +14,7 @@
 
 from nautobot_chatops.dispatchers.ms_teams import MSTeamsDispatcher
 from nautobot_chatops.utils import check_and_enqueue_command
+from nautobot_chatops.views import SettingsControlledViewMixin
 from nautobot_chatops.workers import commands_help, get_commands_registry, parse_command_string
 
 logger = logging.getLogger(__name__)
@@ -113,9 +114,10 @@ def verify_jwt_token(request_headers, request_json):
 
 
 @method_decorator(csrf_exempt, name="dispatch")
-class MSTeamsMessagesView(View):
+class MSTeamsMessagesView(SettingsControlledViewMixin, View):
     """Handle notifications from a Microsoft Teams bot."""
 
+    enable_view_setting = "enable_ms_teams"
     http_method_names = ["post"]
 
     # pylint: disable=too-many-locals,too-many-branches,too-many-statements

nautobot_chatops/api/views/slack.py

@@ -16,6 +16,7 @@
 from nautobot_chatops.dispatchers.slack import SlackDispatcher
 from nautobot_chatops.metrics import signature_error_cntr
 from nautobot_chatops.utils import check_and_enqueue_command
+from nautobot_chatops.views import SettingsControlledViewMixin
 from nautobot_chatops.workers import commands_help, get_commands_registry, parse_command_string
 
 # pylint: disable=logging-fstring-interpolation
@@ -65,8 +66,14 @@ def verify_signature(request):
     return True, "Signature is valid"
 
 
+class SlackView(SettingsControlledViewMixin, View):
+    """Base class for Slack views."""
+
+    enable_view_setting = "enable_slack"
+
+
 @method_decorator(csrf_exempt, name="dispatch")
-class SlackSlashCommandView(View):
+class SlackSlashCommandView(SlackView):
     """Handle notifications from a Slack /command."""
 
     http_method_names = ["post"]
@@ -115,7 +122,7 @@ def post(self, request, *args, **kwargs):
 
 
 @method_decorator(csrf_exempt, name="dispatch")
-class SlackInteractionView(View):
+class SlackInteractionView(SlackView):
     """Handle notifications resulting from a Slack interactive block or modal."""
 
     http_method_names = ["post"]
@@ -276,7 +283,7 @@ def post(self, request, *args, **kwargs):
 
 
 @method_decorator(csrf_exempt, name="dispatch")
-class SlackEventAPIView(View):
+class SlackEventAPIView(SlackView):
     """Handle notifications resulting from a mention of the Slack app."""
 
     http_method_names = ["post"]

nautobot_chatops/api/views/webex.py

@@ -16,6 +16,7 @@
 
 from nautobot_chatops.dispatchers.webex import WEBEX_CONFIG, WebexDispatcher
 from nautobot_chatops.utils import check_and_enqueue_command
+from nautobot_chatops.views import SettingsControlledViewMixin
 from nautobot_chatops.workers import commands_help, get_commands_registry, parse_command_string
 
 logger = logging.getLogger(__name__)
@@ -76,9 +77,10 @@ def verify_signature(request):
 
 
 @method_decorator(csrf_exempt, name="dispatch")
-class WebexView(View):
+class WebexView(SettingsControlledViewMixin, View):
     """Handle all supported inbound notifications from Webex."""
 
+    enable_view_setting = "enable_webex"
     http_method_names = ["post"]
 
     # pylint: disable=too-many-locals,too-many-return-statements,too-many-branches

nautobot_chatops/integrations/grafana/diffsync/sync.py

@@ -2,16 +2,22 @@
 
 from typing import Union
 
-from diffsync import DiffSyncFlags
-
-from nautobot_chatops.integrations.grafana.diffsync.models import (
-    GrafanaDashboard,
-    GrafanaPanel,
-    GrafanaVariable,
-    NautobotDashboard,
-    NautobotPanel,
-    NautobotVariable,
-)
+try:
+    from diffsync import DiffSyncFlags
+
+    DIFFSYNC_INSTALLED = True
+except ImportError:
+    DIFFSYNC_INSTALLED = False
+
+if DIFFSYNC_INSTALLED:
+    from nautobot_chatops.integrations.grafana.diffsync.models import (
+        GrafanaDashboard,
+        GrafanaPanel,
+        GrafanaVariable,
+        NautobotDashboard,
+        NautobotPanel,
+        NautobotVariable,
+    )
 from nautobot_chatops.integrations.grafana.grafana import handler
 from nautobot_chatops.integrations.grafana.models import Dashboard, Panel, PanelVariable
 
@@ -21,7 +27,13 @@ def run_dashboard_sync(overwrite: bool = False) -> Union[str, None]:
 
     Args:
         overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana.
+
+    Raises:
+        ImportError: If DiffSync is not installed.
     """
+    if not DIFFSYNC_INSTALLED:
+        raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.")
+
     df_flags = DiffSyncFlags.NONE if overwrite else DiffSyncFlags.SKIP_UNMATCHED_DST
 
     # Fetch dashboards from the Grafana API
@@ -51,7 +63,13 @@ def run_panels_sync(dashboard: Dashboard, overwrite: bool = False) -> Union[str,
     Args:
         dashboard (nautobot_chatops.integrations.grafana.models.Dashboard): The dashboard we are going to do a diffsync with.
         overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana.
+
+    Raises:
+        ImportError: If DiffSync is not installed.
     """
+    if not DIFFSYNC_INSTALLED:
+        raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.")
+
     df_flags = DiffSyncFlags.NONE if overwrite else DiffSyncFlags.SKIP_UNMATCHED_DST
 
     # Fetch panels from the Grafana API
@@ -81,7 +99,13 @@ def run_variables_sync(dashboard: Dashboard, overwrite: bool = False) -> Union[s
     Args:
         dashboard (nautobot_chatops.integrations.grafana.models.Dashboard): The dashboard we are going to do a diffsync with.
         overwrite (bool): Overwrite Nautobot data and delete records that are no longer in Grafana.
+
+    Raises:
+        ImportError: If DiffSync is not installed.
     """
+    if not DIFFSYNC_INSTALLED:
+        raise ImportError("DiffSync is not installed. Please install DiffSync to use the grafana integration.")
+
     df_flags = DiffSyncFlags.NONE if overwrite else DiffSyncFlags.SKIP_UNMATCHED_DST
 
     # Fetch panels from the Grafana API

nautobot_chatops/integrations/grafana/navigation.py

@@ -4,7 +4,7 @@
 
 items = [
     NavMenuItem(
-        link="plugins:nautobot_chatops:grafanadashboards",
+        link="plugins:nautobot_chatops:grafanadashboard_list",
         permissions=["nautobot_chatops.dashboards_read"],
         name="Grafana Dashboards",
         buttons=(
@@ -15,7 +15,7 @@
         ),
     ),
     NavMenuItem(
-        link="plugins:nautobot_chatops:grafanapanel",
+        link="plugins:nautobot_chatops:grafanapanel_list",
         permissions=["nautobot_chatops.panel_read"],
         name="Grafana Panels",
         buttons=(
@@ -26,7 +26,7 @@
         ),
     ),
     NavMenuItem(
-        link="plugins:nautobot_chatops:grafanapanelvariables",
+        link="plugins:nautobot_chatops:grafanapanelvariable_list",
         permissions=["nautobot_chatops.panelvariables_read"],
         name="Grafana Variables",
         buttons=(