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

nautobot/users/api/serializers.py

@@ -18,13 +18,13 @@ class UserSerializer(ValidatedModelSerializer):
         exclude = ["user_permissions"]
         extra_kwargs = {"password": {"write_only": True, "required": False, "allow_null": True}}
 
-    def validate(self, data):
+    def validate(self, attrs):
         """Handle omission of a password by setting it to the unusable None value."""
         mock_password = False
-        if "password" not in data and not self.partial:
-            data["password"] = make_password(None)
+        if "password" not in attrs and not self.partial:
+            attrs["password"] = make_password(None)
             mock_password = True
-        validated_data = super().validate(data)
+        validated_data = super().validate(attrs)
         if mock_password:
             validated_data["password"] = None
         return validated_data

nautobot/users/api/views.py

@@ -22,7 +22,7 @@ from . import serializers
 
 
 class UserViewSet(ModelViewSet):
-    queryset = RestrictedQuerySet(model=get_user_model()).prefetch_related("groups").order_by("username")
+    queryset = RestrictedQuerySet(model=get_user_model()).order_by("username")
     serializer_class = serializers.UserSerializer
     filterset_class = filters.UserFilterSet
 
@@ -43,7 +43,7 @@ class GroupViewSet(ModelViewSet):
 
 
 class TokenViewSet(ModelViewSet):
-    queryset = RestrictedQuerySet(model=Token).select_related("user")
+    queryset = RestrictedQuerySet(model=Token).select_related("user")  # pylint: disable=not-callable  # no idea why?
     serializer_class = serializers.TokenSerializer
     filterset_class = filters.TokenFilterSet
 
@@ -69,7 +69,7 @@ class TokenViewSet(ModelViewSet):
 
 
 class ObjectPermissionViewSet(ModelViewSet):
-    queryset = ObjectPermission.objects.prefetch_related("object_types", "groups", "users")
+    queryset = ObjectPermission.objects.all()
     serializer_class = serializers.ObjectPermissionSerializer
     filterset_class = filters.ObjectPermissionFilterSet
 

nautobot/users/forms.py

@@ -1,11 +1,16 @@
 from django import forms
 from django.contrib.auth.forms import (
+    AdminPasswordChangeForm as _AdminPasswordChangeForm,
     AuthenticationForm,
     PasswordChangeForm as DjangoPasswordChangeForm,
 )
+from timezone_field import TimeZoneFormField
 
+from nautobot.core.events import publish_event
 from nautobot.core.forms import BootstrapMixin, DateTimePicker
+from nautobot.core.forms.widgets import StaticSelect2
 from nautobot.core.utils.config import get_settings_or_config
+from nautobot.users.utils import serialize_user_without_config_and_views
 
 from .models import Token
 
@@ -64,3 +69,17 @@ class AdvancedProfileSettingsForm(BootstrapMixin, forms.Form):
             raise forms.ValidationError(
                 {"request_profiling": "Request profiling has been globally disabled by an administrator."}
             )
+
+
+class PreferenceProfileSettingsForm(BootstrapMixin, forms.Form):
+    timezone = TimeZoneFormField(required=False, help_text="Set your default timezone", widget=StaticSelect2)
+
+
+class AdminPasswordChangeForm(_AdminPasswordChangeForm):
+    def save(self, commit=True):
+        # Override `_AdminPasswordChangeForm.save()` to publish admin change user password event
+        instance = super().save(commit)
+        if commit:
+            payload = serialize_user_without_config_and_views(instance)
+            publish_event(topic="nautobot.admin.user.change_password", payload=payload)
+        return instance

nautobot/users/templates/users/preferences.html

@@ -1,5 +1,6 @@
 {% extends 'users/base.html' %}
 {% load helpers %}
+{% load form_helpers %}
 
 {% block title %}User Preferences{% endblock %}
 
@@ -32,4 +33,25 @@
     {% else %}
         <h3 class="text-muted text-center">No preferences found</h3>
     {% endif %}
+
+    <form action="" method="post" class="form form-horizontal" style="margin-top: 30px;">
+        {% csrf_token %}
+        {% if form.non_field_errors %}
+            <div class="panel panel-danger">
+                <div class="panel-heading"><strong>Errors</strong></div>
+                <div class="panel-body">
+                    {{ form.non_field_errors }}
+                </div>
+            </div>
+        {% endif %}
+        <div class="panel panel-default">
+            <div class="panel-heading"><strong>Preference Settings</strong></div>
+            <div class="panel-body">
+                {% render_field form.timezone %}
+            </div>
+        </div>
+        <div class="text-right">
+            <button type="submit" name="_update_preference_form" class="btn btn-primary">Update</button>
+        </div>
+    </form>
 {% endblock %}

nautobot/users/tests/test_filters.py

@@ -122,15 +122,11 @@ class UserTestCase(FilterTestCases.FilterTestCase):
             self.filterset(params, self.queryset).qs, self.queryset.filter(is_active=True)
         )
 
-    def test_search(self):
-        value = self.queryset.values_list("pk", flat=True)[0]
-        params = {"q": value}
-        self.assertEqual(self.filterset(params, self.queryset).qs.values_list("pk", flat=True)[0], value)
-
 
 class GroupTestCase(FilterTestCases.FilterTestCase):
     queryset = Group.objects.all()
     filterset = GroupFilterSet
+    generic_filter_tests = (("name",),)
 
     @classmethod
     def setUpTestData(cls):
@@ -138,15 +134,6 @@ class GroupTestCase(FilterTestCases.FilterTestCase):
         Group.objects.create(name="Group 2")
         Group.objects.create(name="Group 3")
 
-    def test_name(self):
-        params = {"name": ["Group 1", "Group 2"]}
-        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
-    def test_search(self):
-        value = self.queryset.values_list("pk", flat=True)[0]
-        params = {"q": value}
-        self.assertEqual(self.filterset(params, self.queryset).qs.values_list("pk", flat=True)[0], value)
-
 
 class ObjectPermissionTestCase(FilterTestCases.FilterTestCase):
     queryset = ObjectPermission.objects.all()
@@ -261,8 +248,3 @@ class TokenTestCase(FilterTestCases.FilterTestCase):
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
         params = {"write_enabled": False}
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
-
-    def test_search(self):
-        value = self.queryset.values_list("pk", flat=True)[0]
-        params = {"q": value}
-        self.assertEqual(self.filterset(params, self.queryset).qs.values_list("pk", flat=True)[0], value)

nautobot/users/tests/test_views.py

@@ -1,3 +1,4 @@
+import json
 from unittest import mock
 
 from django.conf import settings
@@ -5,9 +6,13 @@ from django.contrib.auth import get_user_model
 from django.contrib.sessions.middleware import SessionMiddleware
 from django.test import override_settings, RequestFactory
 from django.urls import reverse
+from django.utils import timezone
 from social_django.utils import load_backend, load_strategy
 
 from nautobot.core.testing import TestCase, utils
+from nautobot.core.testing.context import load_event_broker_override_settings
+from nautobot.core.testing.utils import post_data
+from nautobot.users.utils import serialize_user_without_config_and_views
 
 User = get_user_model()
 
@@ -38,6 +43,37 @@ class PasswordUITest(TestCase):
         )
         self.assertBodyContains(post_response, "The two password fields")
 
+    @load_event_broker_override_settings(
+        EVENT_BROKERS={
+            "SyslogEventBroker": {
+                "CLASS": "nautobot.core.events.SyslogEventBroker",
+                "TOPICS": {
+                    "INCLUDE": ["*"],
+                },
+            }
+        }
+    )
+    def test_change_password(self):
+        self.user.set_password("foo")
+        self.user.save()
+        self.client.force_login(self.user)
+        with self.assertLogs("nautobot.events") as cm:
+            self.client.post(
+                reverse("user:change_password"),
+                data={
+                    "old_password": "foo",
+                    "new_password1": "bar",
+                    "new_password2": "bar",
+                },
+            )
+        payload = serialize_user_without_config_and_views(self.user)
+        self.assertEqual(
+            cm.output,
+            [f"INFO:nautobot.events.nautobot.users.user.change_password:{json.dumps(payload, indent=4)}"],
+        )
+        self.user.refresh_from_db()
+        self.assertTrue(self.user.check_password("bar"))
+
     @override_settings(
         AUTHENTICATION_BACKENDS=[
             "social_core.backends.google.GoogleOAuth2",
@@ -133,3 +169,24 @@ class AdvancedProfileSettingsViewTest(TestCase):
 
         # Check if the session has the correct value
         self.assertFalse(self.client.session.get("silk_record_requests"))
+
+
+class PreferenceTestCase(TestCase):
+    def test_timezone_change(self):
+        self.user.is_superuser = True
+        self.user.save()
+        self.client.force_login(self.user)
+
+        timezone_name = timezone.get_current_timezone_name()
+        new_timezone_name = "US/Eastern"
+        form_data = {"timezone": new_timezone_name, "_update_preference_form": [""]}
+        url = reverse("user:preferences")
+        request = {
+            "path": url,
+            "data": post_data(form_data),
+        }
+        response = self.client.post(**request)
+        response = self.client.get(url)
+        self.assertEqual(timezone.get_current_timezone_name(), new_timezone_name)
+        self.assertNotEqual(timezone_name, new_timezone_name)
+        self.assertHttpStatus(response, 200)

nautobot/users/utils.py

@@ -0,0 +1,8 @@
+from nautobot.core.models.utils import serialize_object_v2
+
+
+def serialize_user_without_config_and_views(user):
+    serialized_data = serialize_object_v2(user)
+    for key in ["config_data", "default_saved_views"]:
+        serialized_data.pop(key, None)
+    return {"data": serialized_data}

nautobot/users/views.py

@@ -13,13 +13,16 @@ from django.urls import reverse
 from django.utils.decorators import method_decorator
 from django.utils.encoding import iri_to_uri
 from django.utils.http import url_has_allowed_host_and_scheme
+from django.utils.timezone import get_default_timezone_name
 from django.views.decorators.debug import sensitive_post_parameters
 from django.views.generic import View
 
+from nautobot.core.events import publish_event
 from nautobot.core.forms import ConfirmationForm
 from nautobot.core.views.generic import GenericView
+from nautobot.users.utils import serialize_user_without_config_and_views
 
-from .forms import AdvancedProfileSettingsForm, LoginForm, PasswordChangeForm, TokenForm
+from .forms import AdvancedProfileSettingsForm, LoginForm, PasswordChangeForm, PreferenceProfileSettingsForm, TokenForm
 from .models import Token
 
 #
@@ -33,7 +36,6 @@ class LoginView(View):
     """
 
     template_name = "login.html"
-    use_new_ui = True
 
     @method_decorator(sensitive_post_parameters("password"))
     def dispatch(self, *args, **kwargs):
@@ -62,8 +64,11 @@ class LoginView(View):
             logger.debug("Login form validation was successful")
 
             # Authenticate user
+            user = form.get_user()
             auth_login(request, form.get_user())
             messages.info(request, f"Logged in as {request.user}.")
+            payload = serialize_user_without_config_and_views(user)
+            publish_event(topic="nautobot.users.user.login", payload=payload)
 
             return self.redirect_to_next(request, logger)
 
@@ -92,6 +97,10 @@ class LoginView(View):
         return HttpResponseRedirect(iri_to_uri(redirect_to))
 
 
+# TODO: The LogoutView should inherit from `LoginRequiredMixin` or `GenericView`
+#   to prevent unauthenticated users from accessing the logout page.
+#   However, using `LoginRequiredMixin` or `GenericView` as-is currently redirects
+#   users to the login page with `?next=/logout/`, which is not desired.
 class LogoutView(View):
     """
     Deauthenticate a web user.
@@ -99,6 +108,9 @@ class LogoutView(View):
 
     def get(self, request):
         # Log out the user
+        if request.user.is_authenticated:
+            payload = serialize_user_without_config_and_views(request.user)
+            publish_event(topic="nautobot.users.user.logout", payload=payload)
         auth_logout(request)
         messages.info(request, "You have logged out.")
 
@@ -136,28 +148,51 @@ class UserConfigView(GenericView):
     template_name = "users/preferences.html"
 
     def get(self, request):
+        tzname = request.user.get_config("timezone", get_default_timezone_name())
+        form = PreferenceProfileSettingsForm(initial={"timezone": tzname})
         return render(
             request,
             self.template_name,
             {
                 "preferences": request.user.all_config(),
+                "form": form,
                 "active_tab": "preferences",
                 "is_django_auth_user": is_django_auth_user(request),
             },
         )
 
     def post(self, request):
-        user = request.user
-        data = user.all_config()
+        is_preference_update_post = "_update_preference_form" in request.POST
+        if is_preference_update_post:
+            form = PreferenceProfileSettingsForm(request.POST)
+            if form.is_valid():
+                if timezone := form.cleaned_data["timezone"]:
+                    request.user.set_config("timezone", str(timezone), commit=True)
+                return redirect("user:preferences")
+
+            return render(
+                request,
+                self.template_name,
+                {
+                    "preferences": request.user.all_config(),
+                    "form": form,
+                    "active_tab": "preferences",
+                    "is_django_auth_user": is_django_auth_user(request),
+                },
+            )
+
+        else:
+            user = request.user
+            data = user.all_config()
 
-        # Delete selected preferences
-        for key in request.POST.getlist("pk"):
-            if key in data:
-                user.clear_config(key)
-        user.save()
-        messages.success(request, "Your preferences have been updated.")
+            # Delete selected preferences
+            for key in request.POST.getlist("pk"):
+                if key in data:
+                    user.clear_config(key)
+            user.save()
+            messages.success(request, "Your preferences have been updated.")
 
-        return redirect("user:preferences")
+            return redirect("user:preferences")
 
 
 class ChangePasswordView(GenericView):
@@ -200,6 +235,8 @@ class ChangePasswordView(GenericView):
             form.save()
             update_session_auth_hash(request, form.user)
             messages.success(request, "Your password has been changed successfully.")
+            payload = serialize_user_without_config_and_views(request.user)
+            publish_event(topic="nautobot.users.user.change_password", payload=payload)
             return redirect("user:profile")
 
         return render(

nautobot/virtualization/api/serializers.py

@@ -87,10 +87,10 @@ class VMInterfaceSerializer(
         model = VMInterface
         fields = "__all__"
 
-    def validate(self, data):
+    def validate(self, attrs):
         # Validate many-to-many VLAN assignments
-        virtual_machine = self.instance.virtual_machine if self.instance else data.get("virtual_machine")
-        for vlan in data.get("tagged_vlans", []):
+        virtual_machine = self.instance.virtual_machine if self.instance else attrs.get("virtual_machine")
+        for vlan in attrs.get("tagged_vlans", []):
             if vlan.location not in [virtual_machine.location, None]:
                 raise serializers.ValidationError(
                     {
@@ -99,4 +99,4 @@ class VMInterfaceSerializer(
                     }
                 )
 
-        return super().validate(data)
+        return super().validate(attrs)

nautobot/virtualization/api/views.py

@@ -35,13 +35,9 @@ class ClusterGroupViewSet(NautobotModelViewSet):
 
 
 class ClusterViewSet(NautobotModelViewSet):
-    queryset = (
-        Cluster.objects.select_related("cluster_type", "cluster_group", "tenant", "location")
-        .prefetch_related("tags")
-        .annotate(
-            device_count=count_related(Device, "cluster"),
-            virtualmachine_count=count_related(VirtualMachine, "cluster"),
-        )
+    queryset = Cluster.objects.annotate(
+        device_count=count_related(Device, "cluster"),
+        virtualmachine_count=count_related(VirtualMachine, "cluster"),
     )
     serializer_class = serializers.ClusterSerializer
     filterset_class = filters.ClusterFilterSet
@@ -53,27 +49,12 @@ class ClusterViewSet(NautobotModelViewSet):
 
 
 class VirtualMachineViewSet(ConfigContextQuerySetMixin, NautobotModelViewSet):
-    queryset = VirtualMachine.objects.select_related(
-        "cluster__location",
-        "platform",
-        "primary_ip4",
-        "primary_ip6",
-        "status",
-        "role",
-        "software_version",
-        "tenant",
-    ).prefetch_related("tags")
+    queryset = VirtualMachine.objects.select_related("cluster__location")
     serializer_class = serializers.VirtualMachineSerializer
     filterset_class = filters.VirtualMachineFilterSet
 
 
 class VMInterfaceViewSet(NotesViewSetMixin, ModelViewSet):
-    queryset = VMInterface.objects.select_related(
-        "virtual_machine",
-        "parent_interface",
-        "bridge",
-        "status",
-        "untagged_vlan",
-    ).prefetch_related("tags", "ip_addresses", "tagged_vlans")
+    queryset = VMInterface.objects.all()
     serializer_class = serializers.VMInterfaceSerializer
     filterset_class = filters.VMInterfaceFilterSet

nautobot/virtualization/filters.py

@@ -30,8 +30,8 @@ __all__ = (
     "ClusterFilterSet",
     "ClusterGroupFilterSet",
     "ClusterTypeFilterSet",
-    "VirtualMachineFilterSet",
     "VMInterfaceFilterSet",
+    "VirtualMachineFilterSet",
 )
 
 
@@ -243,7 +243,6 @@ class VirtualMachineFilterSet(
         fields = [
             "id",
             "name",
-            "cluster",
             "vcpus",
             "memory",
             "disk",

nautobot/virtualization/models.py

@@ -22,8 +22,8 @@ __all__ = (
     "Cluster",
     "ClusterGroup",
     "ClusterType",
-    "VirtualMachine",
     "VMInterface",
+    "VirtualMachine",
 )
 
 

nautobot/virtualization/navigation.py

@@ -1,7 +1,4 @@
 from nautobot.core.apps import (
-    NavContext,
-    NavGrouping,
-    NavItem,
     NavMenuAddButton,
     NavMenuGroup,
     NavMenuItem,
@@ -101,48 +98,3 @@ menu_items = (
         ),
     ),
 )
-
-
-navigation = (
-    NavContext(
-        name="Inventory",
-        groups=(
-            NavGrouping(
-                name="Virtualization",
-                weight=600,
-                items=(
-                    NavItem(
-                        name="Virtual Machines",
-                        weight=100,
-                        link="virtualization:virtualmachine_list",
-                        permissions=["virtualization.view_virtualmachine"],
-                    ),
-                    NavItem(
-                        name="VM Interfaces",
-                        weight=200,
-                        link="virtualization:vminterface_list",
-                        permissions=["virtualization.view_vminterface"],
-                    ),
-                    NavItem(
-                        name="Clusters",
-                        weight=300,
-                        link="virtualization:cluster_list",
-                        permissions=["virtualization.view_cluster"],
-                    ),
-                    NavItem(
-                        name="Cluster Types",
-                        weight=400,
-                        link="virtualization:clustertype_list",
-                        permissions=["virtualization.view_clustertype"],
-                    ),
-                    NavItem(
-                        name="Cluster Groups",
-                        weight=500,
-                        link="virtualization:clustergroup_list",
-                        permissions=["virtualization.view_clustergroup"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-)

nautobot/virtualization/tables.py

@@ -14,13 +14,13 @@ from nautobot.tenancy.tables import TenantColumn
 from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface
 
 __all__ = (
-    "ClusterTable",
     "ClusterGroupTable",
+    "ClusterTable",
     "ClusterTypeTable",
+    "VMInterfaceTable",
     "VirtualMachineDetailTable",
     "VirtualMachineTable",
     "VirtualMachineVMInterfaceTable",
-    "VMInterfaceTable",
 )
 
 VMINTERFACE_BUTTONS = """

nautobot/virtualization/templates/virtualization/cluster_edit.html

@@ -11,13 +11,7 @@
             {% render_field form.location %}
         </div>
     </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Tenancy</strong></div>
-        <div class="panel-body">
-            {% render_field form.tenant_group %}
-            {% render_field form.tenant %}
-        </div>
-    </div>
+    {% include 'inc/tenancy_form_panel.html' %}
     {% include 'inc/extras_features_edit_form_fields.html' %}
     <div class="panel panel-default">
         <div class="panel-heading"><strong>Comments</strong></div>

nautobot/virtualization/templates/virtualization/clustertype.html

@@ -1,40 +1 @@
 {% extends 'generic/object_detail.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Cluster Type</strong>
-            </div>
-            <table class="table table-hover panel-body attr-table">
-                <tr>
-                    <td>Description</td>
-                    <td>{{ object.description|placeholder }}</td>
-                </tr>
-                <tr>
-                    <td>Clusters</td>
-                    <td>
-                        <a href="{% url 'virtualization:cluster_list' %}?cluster_type={{ object.name }}">{{ cluster_table.rows|length }}</a>
-                    </td>
-                </tr>
-            </table>
-        </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Clusters</strong>
-            </div>
-            {% include 'inc/table.html' with table=cluster_table %}
-            {% if perms.virtualization.add_cluster %}
-                <div class="panel-footer text-right noprint">
-                    <a href="{% url 'virtualization:cluster_add' %}?cluster_type={{ object.pk }}" class="btn btn-xs btn-primary">
-                        <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add cluster
-                    </a>
-                </div>
-            {% endif %}
-        </div>
-        {% include 'inc/paginator.html' with paginator=cluster_table.paginator page=cluster_table.page %}
-        <div class="row"></div>
-{% endblock content_right_page %}

nautobot/virtualization/templates/virtualization/virtualmachine.html

@@ -52,15 +52,7 @@
                         {% endif %}
                     </td>
                 </tr>
-                <tr>
-                    <td>Tenant</td>
-                    <td>
-                        {% if object.tenant and object.tenant.tenant_group %}
-                            {{ object.tenant.tenant_group|hyperlinked_object }} /
-                        {% endif %}
-                        {{ object.tenant|hyperlinked_object }}
-                    </td>
-                </tr>
+                {% include 'inc/tenant_table_row.html' %}
                 <tr>
                     <td>Primary IPv4</td>
                     <td>

nautobot/virtualization/templates/virtualization/virtualmachine_edit.html

@@ -8,6 +8,7 @@
         <div class="panel-body">
             {% render_field form.name %}
             {% render_field form.role %}
+            {% render_field form.status %}
         </div>
     </div>
     <div class="panel panel-default">
@@ -26,7 +27,6 @@
     <div class="panel panel-default">
         <div class="panel-heading"><strong>Management</strong></div>
         <div class="panel-body">
-            {% render_field form.status %}
             {% render_field form.platform %}
             {% render_field form.primary_ip4 %}
             {% render_field form.primary_ip6 %}
@@ -53,13 +53,7 @@
             {% render_field form.disk %}
         </div>
     </div>
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Tenancy</strong></div>
-        <div class="panel-body">
-            {% render_field form.tenant_group %}
-            {% render_field form.tenant %}
-        </div>
-    </div>
+    {% include 'inc/tenancy_form_panel.html' %}
     {% include 'inc/extras_features_edit_form_fields.html' %}
     <div class="panel panel-default">
         <div class="panel-heading"><strong>Local Config Context Data</strong></div>