nautobot 2.4.0b1__py3-none-any.whl → 2.4.2__py3-none-any.whl

nautobot/extras/datasources/git.py

@@ -30,6 +30,7 @@ from nautobot.extras.models import (
     DynamicGroup,
     ExportTemplate,
     GitRepository,
+    GraphQLQuery,
     Job,
     JobQueue,
     JobResult,
@@ -935,6 +936,120 @@ def delete_git_export_templates(repository_record, job_result, preserve=None):
             job_result.log(msg, level_choice=LogLevelChoices.LOG_WARNING, grouping="export templates")
 
 
+#
+# GraphQL handling
+#
+
+
+def refresh_git_graphql_queries(repository_record, job_result, delete=False):
+    """Callback function for GitRepository updates - refresh all GraphQLQuery managed by this repository."""
+    if "extras.graphqlquery" in repository_record.provided_contents and not delete:
+        update_git_graphql_queries(repository_record, job_result)
+    else:
+        delete_git_graphql_queries(repository_record, job_result)
+
+
+logger = logging.getLogger(__name__)
+
+
+def update_git_graphql_queries(repository_record, job_result):
+    """Refresh any GraphQL queries provided by this Git repository."""
+    graphql_query_path = os.path.join(repository_record.filesystem_path, "graphql_queries")
+    git_repository_content_type = ContentType.objects.get_for_model(GitRepository)
+    graphql_queries = []
+
+    if os.path.isdir(graphql_query_path):
+        for file in os.listdir(graphql_query_path):
+            file_path = os.path.join(graphql_query_path, file)
+            if not os.path.isfile(file_path):
+                continue
+
+            # Remove `.gql` extension from the name if it exists
+            query_name = file.rsplit(".gql", 1)[0] if file.endswith(".gql") else file
+
+            try:
+                with open(file_path, "r") as fd:
+                    query_content = fd.read().strip()
+
+                graphql_query, created = GraphQLQuery.objects.get_or_create(
+                    name=query_name,
+                    owner_content_type=git_repository_content_type,
+                    owner_object_id=repository_record.pk,
+                    defaults={"query": query_content},
+                )
+                modified = graphql_query.query != query_content
+                graphql_queries.append(query_name)
+                # Only attempt to update if the content has changed
+                if modified:
+                    try:
+                        graphql_query.query = query_content
+                        graphql_query.validated_save()
+                        msg = (
+                            f"Successfully created GraphQL query: {query_name}"
+                            if created
+                            else f"Successfully updated GraphQL query: {query_name}"
+                        )
+                        logger.info(msg)
+                        job_result.log(
+                            msg, obj=graphql_query, level_choice=LogLevelChoices.LOG_INFO, grouping="graphql queries"
+                        )
+                    except Exception as exc:
+                        # Log validation error and retain the existing query
+                        error_msg = (
+                            f"Invalid GraphQL syntax for query '{query_name}'. "
+                            f"Retaining the existing query. Error: {exc}"
+                        )
+                        logger.error(error_msg)
+                        job_result.log(error_msg, level_choice=LogLevelChoices.LOG_ERROR, grouping="graphql queries")
+                        continue
+                else:
+                    msg = f"No changes to GraphQL query: {query_name}"
+                    logger.info(msg)
+                    job_result.log(
+                        msg, obj=graphql_query, level_choice=LogLevelChoices.LOG_INFO, grouping="graphql queries"
+                    )
+
+            except Exception as exc:
+                # Check if a query with the same name already exists
+                existing_query = GraphQLQuery.objects.filter(name=query_name).first()
+                if existing_query and existing_query.owner_object_id != repository_record.pk:
+                    error_msg = (
+                        f"GraphQL query '{query_name}' already exists "
+                        f"Please rename the query in the repository and try again."
+                    )
+                else:
+                    error_msg = f"Error processing GraphQL query file '{file}': {exc}"
+
+                # Log the error
+                logger.error(error_msg)
+                job_result.log(error_msg, level_choice=LogLevelChoices.LOG_ERROR, grouping="graphql queries")
+
+    # Delete any queries not in the preserved list
+    delete_git_graphql_queries(repository_record, job_result, preserve=graphql_queries)
+
+
+def delete_git_graphql_queries(repository_record, job_result, preserve=None):
+    """Delete GraphQL queries owned by the given Git repository that are not in the preserve list."""
+    git_repository_content_type = ContentType.objects.get_for_model(GitRepository)
+    if preserve is None:
+        preserve = []
+
+    for graphql_query in GraphQLQuery.objects.filter(
+        owner_content_type=git_repository_content_type,
+        owner_object_id=repository_record.pk,
+    ):
+        if graphql_query.name not in preserve:
+            try:
+                graphql_query.delete()
+                msg = f"Deleted GraphQL query: {graphql_query.name}"
+                logger.warning(msg)
+                job_result.log(msg, level_choice=LogLevelChoices.LOG_WARNING, grouping="graphql queries")
+            except Exception as exc:
+                error_msg = f"Unable to delete '{graphql_query.name}': {exc}"
+                logger.error(error_msg)
+                job_result.log(error_msg, level_choice=LogLevelChoices.LOG_ERROR, grouping="graphql queries")
+
+
 # Register built-in callbacks for data types potentially provided by a GitRepository
 register_datasource_contents(
     [
@@ -978,5 +1093,15 @@ register_datasource_contents(
                 callback=refresh_git_export_templates,
             ),
         ),
+        (
+            "extras.gitrepository",
+            DatasourceContent(
+                name="graphql queries",
+                content_identifier="extras.graphqlquery",
+                icon="mdi-graphql",
+                weight=400,
+                callback=refresh_git_graphql_queries,
+            ),
+        ),
     ]
 )

nautobot/extras/filters/__init__.py

@@ -119,13 +119,13 @@ __all__ = (
     "CustomFieldDateFilter",
     "CustomFieldFilterMixin",
     "CustomFieldJSONFilter",
+    "CustomFieldModelFilterSet",
+    "CustomFieldModelFilterSetMixin",
     "CustomFieldMultiSelectFilter",
     "CustomFieldMultiValueCharFilter",
     "CustomFieldMultiValueDateFilter",
     "CustomFieldMultiValueNumberFilter",
     "CustomFieldNumberFilter",
-    "CustomFieldModelFilterSet",
-    "CustomFieldModelFilterSetMixin",
     "CustomLinkFilterSet",
     "DynamicGroupFilterSet",
     "DynamicGroupMembershipFilterSet",
@@ -136,25 +136,25 @@ __all__ = (
     "ImageAttachmentFilterSet",
     "JobFilterSet",
     "JobLogEntryFilterSet",
-    "JobQueueFilterSet",
     "JobQueueAssignmentFilterSet",
+    "JobQueueFilterSet",
     "JobResultFilterSet",
     "LocalContextFilterSet",
     "LocalContextModelFilterSetMixin",
-    "MetadataTypeFilterSet",
     "MetadataChoiceFilterSet",
+    "MetadataTypeFilterSet",
     "NautobotFilterSet",
     "NoteFilterSet",
     "ObjectChangeFilterSet",
+    "RelationshipAssociationFilterSet",
     "RelationshipFilter",
     "RelationshipFilterSet",
-    "RelationshipAssociationFilterSet",
     "RoleFilterSet",
     "RoleModelFilterSetMixin",
     "ScheduledJobFilterSet",
     "SecretFilterSet",
-    "SecretsGroupFilterSet",
     "SecretsGroupAssociationFilterSet",
+    "SecretsGroupFilterSet",
     "StatusFilter",
     "StatusFilterSet",
     "StatusModelFilterSetMixin",
@@ -874,6 +874,7 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "is_job_button_receiver",
             "soft_time_limit",
             "time_limit",
+            "is_singleton",
             "grouping_override",
             "name_override",
             "approval_required_override",
@@ -883,6 +884,7 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "soft_time_limit_override",
             "time_limit_override",
             "has_sensitive_variables_override",
+            "is_singleton_override",
             "tags",
         ]
 

nautobot/extras/forms/base.py

@@ -14,9 +14,9 @@ from .mixins import (
 )
 
 __all__ = (
-    "NautobotModelForm",
-    "NautobotFilterForm",
     "NautobotBulkEditForm",
+    "NautobotFilterForm",
+    "NautobotModelForm",
 )
 
 

nautobot/extras/forms/forms.py

@@ -1,5 +1,7 @@
 import inspect
+import logging
 
+from celery import chain
 from django import forms
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -7,7 +9,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db.models.fields import TextField
-from django.forms import inlineformset_factory, ModelMultipleChoiceField
+from django.forms import inlineformset_factory, ModelMultipleChoiceField, MultipleHiddenInput
 from django.urls.base import reverse
 from django.utils.timezone import get_current_timezone_name
 
@@ -35,6 +37,7 @@ from nautobot.core.forms import (
     TagFilterField,
 )
 from nautobot.core.forms.constants import BOOLEAN_WITH_BLANK_CHOICES
+from nautobot.core.forms.forms import ConfirmationForm
 from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
@@ -88,9 +91,12 @@ from nautobot.extras.models import (
     Webhook,
 )
 from nautobot.extras.registry import registry
+from nautobot.extras.signals import change_context_state
+from nautobot.extras.tasks import delete_custom_field_data
 from nautobot.extras.utils import (
     ChangeLoggedModelsQuery,
     FeatureQuery,
+    get_worker_count,
     RoleModelsQuery,
     TaggableClassesQuery,
 )
@@ -111,87 +117,90 @@ from .mixins import (
     TagsBulkEditFormMixin,
 )
 
+logger = logging.getLogger(__name__)
+
 __all__ = (
     "BaseDynamicGroupMembershipFormSet",
-    "ComputedFieldForm",
     "ComputedFieldFilterForm",
-    "ConfigContextForm",
+    "ComputedFieldForm",
     "ConfigContextBulkEditForm",
     "ConfigContextFilterForm",
-    "ConfigContextSchemaForm",
+    "ConfigContextForm",
     "ConfigContextSchemaBulkEditForm",
     "ConfigContextSchemaFilterForm",
-    "CustomFieldForm",
-    "CustomFieldFilterForm",
-    "CustomFieldModelCSVForm",
+    "ConfigContextSchemaForm",
     "CustomFieldBulkCreateForm",  # 2.0 TODO remove this deprecated class
+    "CustomFieldBulkDeleteForm",
     "CustomFieldChoiceFormSet",
-    "CustomLinkForm",
+    "CustomFieldFilterForm",
+    "CustomFieldForm",
+    "CustomFieldModelCSVForm",
     "CustomLinkFilterForm",
+    "CustomLinkForm",
     "DynamicGroupBulkAssignForm",
-    "DynamicGroupForm",
     "DynamicGroupFilterForm",
+    "DynamicGroupForm",
     "DynamicGroupMembershipFormSet",
-    "ExportTemplateForm",
     "ExportTemplateFilterForm",
+    "ExportTemplateForm",
+    "ExternalIntegrationBulkEditForm",
     "ExternalIntegrationFilterForm",
     "ExternalIntegrationForm",
-    "ExternalIntegrationBulkEditForm",
-    "GitRepositoryForm",
     "GitRepositoryBulkEditForm",
     "GitRepositoryFilterForm",
-    "GraphQLQueryForm",
+    "GitRepositoryForm",
     "GraphQLQueryFilterForm",
+    "GraphQLQueryForm",
     "ImageAttachmentForm",
-    "JobForm",
     "JobBulkEditForm",
-    "JobButtonForm",
     "JobButtonBulkEditForm",
     "JobButtonFilterForm",
+    "JobButtonForm",
     "JobEditForm",
     "JobFilterForm",
-    "JobHookForm",
+    "JobForm",
     "JobHookFilterForm",
+    "JobHookForm",
     "JobQueueBulkEditForm",
     "JobQueueFilterForm",
     "JobQueueForm",
-    "JobScheduleForm",
     "JobResultFilterForm",
+    "JobScheduleForm",
     "LocalContextFilterForm",
-    "LocalContextModelForm",
     "LocalContextModelBulkEditForm",
+    "LocalContextModelForm",
+    "MetadataChoiceFormSet",
     "MetadataTypeBulkEditForm",
-    "MetadataTypeForm",
     "MetadataTypeFilterForm",
-    "MetadataChoiceFormSet",
-    "NoteForm",
+    "MetadataTypeForm",
     "NoteFilterForm",
+    "NoteForm",
     "ObjectChangeFilterForm",
     "ObjectMetadataFilterForm",
     "PasswordInputWithPlaceholder",
-    "RelationshipForm",
-    "RelationshipFilterForm",
     "RelationshipAssociationFilterForm",
+    "RelationshipFilterForm",
+    "RelationshipForm",
     "RoleBulkEditForm",
     "RoleFilterForm",
     "RoleForm",
     "SavedViewForm",
     "SavedViewModalForm",
     "ScheduledJobFilterForm",
-    "SecretForm",
     "SecretFilterForm",
-    "SecretsGroupForm",
-    "SecretsGroupFilterForm",
+    "SecretForm",
     "SecretsGroupAssociationFormSet",
+    "SecretsGroupFilterForm",
+    "SecretsGroupForm",
     "StaticGroupAssociationFilterForm",
-    "StatusForm",
-    "StatusFilterForm",
     "StatusBulkEditForm",
-    "TagForm",
-    "TagFilterForm",
+    "StatusFilterForm",
+    "StatusForm",
     "TagBulkEditForm",
-    "WebhookForm",
+    "TagFilterForm",
+    "TagForm",
     "WebhookFilterForm",
+    "WebhookForm",
 )
 
 
@@ -491,6 +500,44 @@ class CustomFieldBulkCreateForm(CustomFieldModelBulkEditFormMixin):
     """No longer needed as a separate class - use CustomFieldModelBulkEditFormMixin instead."""
 
 
+class CustomFieldBulkDeleteForm(ConfirmationForm):
+    def __init__(self, *args, delete_all=False, **kwargs):
+        super().__init__(*args, **kwargs)
+        queryset = CustomField.objects.all()
+        self.fields["pk"] = ModelMultipleChoiceField(
+            queryset=queryset, widget=MultipleHiddenInput, required=not delete_all
+        )
+
+    def construct_custom_field_delete_tasks(self, queryset):
+        """
+        Helper method to construct a list of celery tasks to execute when bulk deleting custom fields.
+        """
+        change_context = change_context_state.get()
+        if change_context is None:
+            context = None
+        else:
+            context = change_context.as_dict(queryset)
+            context["context_detail"] = "bulk delete custom field data"
+        tasks = [
+            delete_custom_field_data.si(obj.key, set(obj.content_types.values_list("pk", flat=True)), context)
+            for obj in queryset
+        ]
+        return tasks
+
+    def perform_pre_delete(self, queryset):
+        """
+        Remove all Custom Field Keys/Values from _custom_field_data of the related ContentType in the background.
+        """
+        if not get_worker_count():
+            logger.error("Celery worker process not running. Object custom fields may fail to reflect this deletion.")
+            return
+        tasks = self.construct_custom_field_delete_tasks(queryset)
+        # Executing the tasks in the background sequentially using chain() aligns with how a single
+        # CustomField object is deleted.  We decided to not check the result because it needs at least one worker
+        # to be active and comes with extra performance penalty.
+        chain(*tasks).apply_async()
+
+
 #
 # Custom Links
 #
@@ -990,6 +1037,8 @@ class JobEditForm(NautobotModelForm):
             "job_queues",
             "default_job_queue_override",
             "default_job_queue",
+            "is_singleton",
+            "is_singleton_override",
             "tags",
         ]
 
@@ -1089,6 +1138,11 @@ class JobBulkEditForm(NautobotBulkEditForm):
         required=False,
         help_text="Default Job Queue the job runs on if no Job Queue is specified",
     )
+    is_singleton = forms.NullBooleanField(
+        required=False,
+        widget=BulkEditNullBooleanSelect,
+        help_text="Whether this job should fail to run if another instance of this job is already running",
+    )
     # Flags to indicate whether the above properties are inherited from the source code or overridden by the database
     # Text field overrides
     clear_grouping_override = forms.BooleanField(
@@ -1132,10 +1186,62 @@ class JobBulkEditForm(NautobotBulkEditForm):
         required=False,
         help_text="If checked, the values of has sensitive variables will be reverted to the default values defined in each Job's source code",
     )
+    is_singleton_override = forms.BooleanField(
+        required=False,
+        help_text="If checked, the values of is singleton will be reverted to the default values defined in each Job's source code",
+    )
 
     class Meta:
         model = Job
 
+    def post_save(self, obj):
+        super().post_save(obj)
+
+        cleaned_data = self.cleaned_data
+
+        # Handle text related fields
+        for overridable_field in JOB_OVERRIDABLE_FIELDS:
+            override_field = overridable_field + "_override"
+            clear_override_field = "clear_" + overridable_field + "_override"
+            reset_override = cleaned_data.get(clear_override_field, False)
+            override_value = cleaned_data.get(overridable_field)
+            if reset_override:
+                setattr(obj, override_field, False)
+            elif not reset_override and override_value not in [None, ""]:
+                setattr(obj, override_field, True)
+                setattr(obj, overridable_field, override_value)
+
+        # Handle job queues
+        clear_override_field = "clear_job_queues_override"
+        reset_override = cleaned_data.get(clear_override_field, False)
+        if reset_override:
+            meta_task_queues = obj.job_class.task_queues
+            job_queues = []
+            for queue_name in meta_task_queues:
+                try:
+                    job_queues.append(JobQueue.objects.get(name=queue_name))
+                except JobQueue.DoesNotExist:
+                    # Do we want to create the Job Queue for the users here if we do not have it in the database?
+                    pass
+            obj.job_queues_override = False
+            obj.job_queues.set(job_queues)
+        elif cleaned_data["job_queues"]:
+            obj.job_queues_override = True
+
+        # Handle default job queue
+        clear_override_field = "clear_default_job_queue_override"
+        reset_override = cleaned_data.get(clear_override_field, False)
+        if reset_override:
+            meta_task_queues = obj.job_class.task_queues
+            obj.default_job_queue_override = False
+            obj.default_job_queue, _ = JobQueue.objects.get_or_create(
+                name=meta_task_queues[0] if meta_task_queues else settings.CELERY_TASK_DEFAULT_QUEUE
+            )
+        elif cleaned_data["default_job_queue"]:
+            obj.default_job_queue_override = True
+
+        obj.validated_save()
+
 
 class JobFilterForm(BootstrapMixin, forms.Form):
     model = Job
@@ -1779,6 +1885,8 @@ class RoleBulkEditForm(NautobotBulkEditForm):
 
     pk = forms.ModelMultipleChoiceField(queryset=Role.objects.all(), widget=forms.MultipleHiddenInput)
     color = forms.CharField(max_length=6, required=False, widget=ColorSelect())
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+    weight = forms.IntegerField(required=False)
     content_types = MultipleContentTypeField(
         queryset=RoleModelsQuery().as_queryset(), required=False, label="Content Type(s)"
     )

nautobot/extras/forms/mixins.py

@@ -34,7 +34,7 @@ from nautobot.extras.utils import remove_prefix_from_cf_key
 logger = logging.getLogger(__name__)
 
 
-__all__ = (
+__all__ = (  # noqa:RUF022
     "ContactTeamModelFilterFormMixin",
     "CustomFieldModelBulkEditFormMixin",
     "CustomFieldModelFilterFormMixin",
@@ -327,7 +327,7 @@ class RelationshipModelBulkEditFormMixin(BulkEditForm):
                     field_name,
                     instance,
                 )
-                if field_name in self.nullable_fields and field_name in nullified_fields:
+                if field_name in self.nullable_fields and nullified_fields and field_name in nullified_fields:
                     logger.debug("Deleting existing relationship associations for %s on %s", relationship, instance)
                     relationshipassociation_queryset.delete()
                 elif field_name in self.cleaned_data:
@@ -673,7 +673,7 @@ class RelationshipModelFormMixin(forms.ModelForm):
             for peer_id in target_peer_ids:
                 relationship = self.fields[field_name].model
                 if not relationship.symmetric:
-                    association = RelationshipAssociation(
+                    association = RelationshipAssociation(  # pylint: disable=repeated-keyword
                         relationship=relationship,
                         **{
                             f"{side}_type": self.obj_type,
@@ -837,13 +837,21 @@ class StatusModelFilterFormMixin(forms.Form):
         self.order_fields(self.field_order)  # Reorder fields again
 
 
-class TagsBulkEditFormMixin(forms.Form):
+class TagsBulkEditFormMixin(BulkEditForm):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
         # Add add/remove tags fields
-        self.fields["add_tags"] = DynamicModelMultipleChoiceField(queryset=Tag.objects.all(), required=False)
-        self.fields["remove_tags"] = DynamicModelMultipleChoiceField(queryset=Tag.objects.all(), required=False)
+        self.fields["add_tags"] = DynamicModelMultipleChoiceField(
+            queryset=Tag.objects.all(),
+            query_params={"content_types": self.model._meta.label_lower},
+            required=False,
+        )
+        self.fields["remove_tags"] = DynamicModelMultipleChoiceField(
+            queryset=Tag.objects.all(),
+            query_params={"content_types": self.model._meta.label_lower},
+            required=False,
+        )
 
 
 # 2.2 TODO: Names below are only for backward compatibility with Nautobot 1.3 and earlier. Remove in 2.2

nautobot/extras/group_sync.py

@@ -8,15 +8,15 @@ from django.contrib.auth.models import Group
 logger = logging.getLogger(__name__)
 
 
-CLAIMS_GROUP_NAME = getattr(settings, "NAUTOBOT_SSO_CLAIMS_GROUP", "groups")
+CLAIMS_GROUP_NAME = getattr(settings, "SSO_CLAIMS_GROUP", "groups")
 """ Which claim to look at in the OAuth2/OIDC response
 
     For Okta you can look at `Okta -> Authorization Servers -> Claims`. And a reasonable
     default is "groups". For Azure a reasonable default is "roles".
 """
 
-SUPERUSER_GROUPS = getattr(settings, "NAUTOBOT_SSO_SUPERUSER_GROUPS", [])
-STAFF_GROUPS = getattr(settings, "NAUTOBOT_SSO_STAFF_GROUPS", [])
+SUPERUSER_GROUPS = getattr(settings, "SSO_SUPERUSER_GROUPS", [])
+STAFF_GROUPS = getattr(settings, "SSO_STAFF_GROUPS", [])
 
 
 def group_sync(uid, user=None, response=None, *args, **kwargs):

nautobot/extras/health_checks.py

@@ -160,5 +160,4 @@ class RedisBackend(RedisHealthCheck):
         elif client_class == "django_redis.client.DefaultClient":
             self.check_redis(redis_url=location, **options.get("CONNECTION_POOL_KWARGS", {}))
         else:
-            if self.redis_url is None:
-                self.add_error(ServiceUnavailable(f"{client_class} is an unsupported CLIENT_CLASS!"))
+            self.add_error(ServiceUnavailable(f"{client_class} is an unsupported CLIENT_CLASS!"))