Replaces device_role with role on device model (#13342)

* replaces device_role with role on device model #6391 * fixes lint issue #6391 * revert the database user * revert test_runner comment * changes as per review * Update references to device_role column in UserConfigs --------- Co-authored-by: Jeremy Stretch <[email protected]>
netbox-community · Aug 2, 2023 · 0bb86f1 · 0bb86f1
1 parent 79030ec
commit 0bb86f1
Show file tree

Hide file tree

Showing 37 changed files with 422 additions and 331 deletions.
diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
@@ -390,7 +390,7 @@ class NewBranchScript(Script):
                 name=f'{site.slug}-switch{i}',
                 site=site,
                 status=DeviceStatusChoices.STATUS_PLANNED,
-                device_role=switch_role
+                role=switch_role
             )
             switch.full_clean()
             switch.save()

diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py
@@ -665,7 +665,8 @@ class Meta:
 class DeviceSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='dcim-api:device-detail')
     device_type = NestedDeviceTypeSerializer()
-    device_role = NestedDeviceRoleSerializer()
+    role = NestedDeviceRoleSerializer()
+    device_role = NestedDeviceRoleSerializer(read_only=True, help_text='Deprecated in v3.6 in favor of `role`.')
     tenant = NestedTenantSerializer(required=False, allow_null=True, default=None)
     platform = NestedPlatformSerializer(required=False, allow_null=True)
     site = NestedSiteSerializer()
@@ -707,9 +708,9 @@ class DeviceSerializer(NetBoxModelSerializer):
     class Meta:
         model = Device
         fields = [
-            'id', 'url', 'display', 'name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
-            'site', 'location', 'rack', 'position', 'face', 'latitude', 'longitude', 'parent_device', 'status',
-            'airflow', 'primary_ip', 'primary_ip4', 'primary_ip6', 'oob_ip', 'cluster', 'virtual_chassis',
+            'id', 'url', 'display', 'name', 'device_type', 'role', 'device_role', 'tenant', 'platform', 'serial',
+            'asset_tag', 'site', 'location', 'rack', 'position', 'face', 'latitude', 'longitude', 'parent_device',
+            'status', 'airflow', 'primary_ip', 'primary_ip4', 'primary_ip6', 'oob_ip', 'cluster', 'virtual_chassis',
             'vc_position', 'vc_priority', 'description', 'comments', 'config_template', 'local_context_data', 'tags',
             'custom_fields', 'created', 'last_updated', 'console_port_count', 'console_server_port_count',
             'power_port_count', 'power_outlet_count', 'interface_count', 'front_port_count', 'rear_port_count',
@@ -727,13 +728,16 @@ def get_parent_device(self, obj):
         data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data
         return data
 
+    def get_device_role(self, obj):
+        return obj.role
+
 
 class DeviceWithConfigContextSerializer(DeviceSerializer):
     config_context = serializers.SerializerMethodField(read_only=True)
 
     class Meta(DeviceSerializer.Meta):
         fields = [
-            'id', 'url', 'display', 'name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
+            'id', 'url', 'display', 'name', 'device_type', 'role', 'tenant', 'platform', 'serial', 'asset_tag',
             'site', 'location', 'rack', 'position', 'face', 'parent_device', 'status', 'airflow', 'primary_ip',
             'primary_ip4', 'primary_ip6', 'oob_ip', 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority',
             'description', 'comments', 'local_context_data', 'tags', 'custom_fields', 'config_context',
@@ -1035,7 +1039,8 @@ class ModuleBaySerializer(NetBoxModelSerializer):
     class Meta:
         model = ModuleBay
         fields = [
-            'id', 'url', 'display', 'device', 'name', 'installed_module', 'label', 'position', 'description', 'tags', 'custom_fields',
+            'id', 'url', 'display', 'device', 'name', 'installed_module', 'label', 'position', 'description', 'tags',
+            'custom_fields',
             'created', 'last_updated',
         ]
 

diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py
@@ -362,7 +362,7 @@ class InventoryItemTemplateViewSet(NetBoxModelViewSet):
 
 class DeviceRoleViewSet(NetBoxModelViewSet):
     queryset = DeviceRole.objects.prefetch_related('config_template', 'tags').annotate(
-        device_count=count_related(Device, 'device_role'),
+        device_count=count_related(Device, 'role'),
         virtualmachine_count=count_related(VirtualMachine, 'role')
     )
     serializer_class = serializers.DeviceRoleSerializer
@@ -393,7 +393,7 @@ class DeviceViewSet(
     NetBoxModelViewSet
 ):
     queryset = Device.objects.prefetch_related(
-        'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'location', 'rack', 'parent_bay',
+        'device_type__manufacturer', 'role', 'tenant', 'platform', 'site', 'location', 'rack', 'parent_bay',
         'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'config_template', 'tags',
     )
     filterset_class = filtersets.DeviceFilterSet

diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py
@@ -840,12 +840,12 @@ class DeviceFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilter
         label=_('Device type (ID)'),
     )
     role_id = django_filters.ModelMultipleChoiceFilter(
-        field_name='device_role_id',
+        field_name='role_id',
         queryset=DeviceRole.objects.all(),
         label=_('Role (ID)'),
     )
     role = django_filters.ModelMultipleChoiceFilter(
-        field_name='device_role__slug',
+        field_name='role__slug',
         queryset=DeviceRole.objects.all(),
         to_field_name='slug',
         label=_('Role (slug)'),
@@ -1251,13 +1251,13 @@ class DeviceComponentFilterSet(django_filters.FilterSet):
         to_field_name='model',
         label=_('Device type (model)'),
     )
-    device_role_id = django_filters.ModelMultipleChoiceFilter(
-        field_name='device__device_role',
+    role_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='device__role',
         queryset=DeviceRole.objects.all(),
         label=_('Device role (ID)'),
     )
-    device_role = django_filters.ModelMultipleChoiceFilter(
-        field_name='device__device_role__slug',
+    role = django_filters.ModelMultipleChoiceFilter(
+        field_name='device__role__slug',
         queryset=DeviceRole.objects.all(),
         to_field_name='slug',
         label=_('Device role (slug)'),
@@ -1273,6 +1273,18 @@ class DeviceComponentFilterSet(django_filters.FilterSet):
         to_field_name='name',
         label=_('Virtual Chassis'),
     )
+    # TODO: Remove in v4.0
+    device_role_id = django_filters.ModelMultipleChoiceFilter(
+        field_name='device__role',
+        queryset=DeviceRole.objects.all(),
+        label=_('Device role (ID)'),
+    )
+    device_role = django_filters.ModelMultipleChoiceFilter(
+        field_name='device__role__slug',
+        queryset=DeviceRole.objects.all(),
+        to_field_name='slug',
+        label=_('Device role (slug)'),
+    )
 
     def search(self, queryset, name, value):
         if not value.strip():

diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py
@@ -553,7 +553,7 @@ class DeviceBulkEditForm(NetBoxModelBulkEditForm):
             'manufacturer_id': '$manufacturer'
         }
     )
-    device_role = DynamicModelChoiceField(
+    role = DynamicModelChoiceField(
         label=_('Device role'),
         queryset=DeviceRole.objects.all(),
         required=False
@@ -610,7 +610,7 @@ class DeviceBulkEditForm(NetBoxModelBulkEditForm):
 
     model = Device
     fieldsets = (
-        (_('Device'), ('device_role', 'status', 'tenant', 'platform', 'description')),
+        (_('Device'), ('role', 'status', 'tenant', 'platform', 'description')),
         (_('Location'), ('site', 'location')),
         (_('Hardware'), ('manufacturer', 'device_type', 'airflow', 'serial')),
         (_('Configuration'), ('config_template',)),

diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py
@@ -404,7 +404,7 @@ class Meta:
 
 
 class BaseDeviceImportForm(NetBoxModelImportForm):
-    device_role = CSVModelChoiceField(
+    role = CSVModelChoiceField(
         label=_('Device role'),
         queryset=DeviceRole.objects.all(),
         to_field_name='name',
@@ -527,7 +527,7 @@ class DeviceImportForm(BaseDeviceImportForm):
 
     class Meta(BaseDeviceImportForm.Meta):
         fields = [
-            'name', 'device_role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status',
+            'name', 'role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status',
             'site', 'location', 'rack', 'position', 'face', 'latitude', 'longitude', 'parent', 'device_bay', 'airflow',
             'virtual_chassis', 'vc_position', 'vc_priority', 'cluster', 'description', 'config_template', 'comments',
             'tags',

diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py
@@ -109,7 +109,7 @@ class DeviceComponentFilterForm(NetBoxModelFilterSetForm):
         required=False,
         label=_('Device type')
     )
-    device_role_id = DynamicModelMultipleChoiceField(
+    role_id = DynamicModelMultipleChoiceField(
         queryset=DeviceRole.objects.all(),
         required=False,
         label=_('Device role')
@@ -122,7 +122,7 @@ class DeviceComponentFilterForm(NetBoxModelFilterSetForm):
             'location_id': '$location_id',
             'virtual_chassis_id': '$virtual_chassis_id',
             'device_type_id': '$device_type_id',
-            'role_id': '$device_role_id'
+            'role_id': '$role_id'
         },
         label=_('Device')
     )
@@ -1136,7 +1136,7 @@ class ConsolePortFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type', 'speed')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Connection'), ('cabled', 'connected', 'occupied')),
     )
     type = forms.MultipleChoiceField(
@@ -1158,7 +1158,7 @@ class ConsoleServerPortFilterForm(PathEndpointFilterForm, DeviceComponentFilterF
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type', 'speed')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Connection'), ('cabled', 'connected', 'occupied')),
     )
     type = forms.MultipleChoiceField(
@@ -1180,7 +1180,7 @@ class PowerPortFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Connection'), ('cabled', 'connected', 'occupied')),
     )
     type = forms.MultipleChoiceField(
@@ -1197,7 +1197,7 @@ class PowerOutletFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Connection'), ('cabled', 'connected', 'occupied')),
     )
     type = forms.MultipleChoiceField(
@@ -1217,7 +1217,7 @@ class InterfaceFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
         (_('PoE'), ('poe_mode', 'poe_type')),
         (_('Wireless'), ('rf_role', 'rf_channel', 'rf_channel_width', 'tx_power')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id', 'vdc_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id', 'vdc_id')),
         (_('Connection'), ('cabled', 'connected', 'occupied')),
     )
     vdc_id = DynamicModelMultipleChoiceField(
@@ -1324,7 +1324,7 @@ class FrontPortFilterForm(CabledFilterForm, DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type', 'color')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Cable'), ('cabled', 'occupied')),
     )
     model = FrontPort
@@ -1346,7 +1346,7 @@ class RearPortFilterForm(CabledFilterForm, DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'type', 'color')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
         (_('Cable'), ('cabled', 'occupied')),
     )
     type = forms.MultipleChoiceField(
@@ -1367,7 +1367,7 @@ class ModuleBayFilterForm(DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'position')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
     )
     tag = TagFilterField(model)
     position = forms.CharField(
@@ -1382,7 +1382,7 @@ class DeviceBayFilterForm(DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
     )
     tag = TagFilterField(model)
 
@@ -1393,7 +1393,7 @@ class InventoryItemFilterForm(DeviceComponentFilterForm):
         (None, ('q', 'filter_id', 'tag')),
         (_('Attributes'), ('name', 'label', 'role_id', 'manufacturer_id', 'serial', 'asset_tag', 'discovered')),
         (_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
-        (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
+        (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
     )
     role_id = DynamicModelMultipleChoiceField(
         queryset=InventoryItemRole.objects.all(),

diff --git a/netbox/dcim/forms/model_forms.py b/netbox/dcim/forms/model_forms.py
@@ -434,7 +434,7 @@ class DeviceForm(TenancyForm, NetBoxModelForm):
         queryset=DeviceType.objects.all(),
         selector=True
     )
-    device_role = DynamicModelChoiceField(
+    role = DynamicModelChoiceField(
         label=_('Device role'),
         queryset=DeviceRole.objects.all()
     )
@@ -479,7 +479,7 @@ class DeviceForm(TenancyForm, NetBoxModelForm):
     class Meta:
         model = Device
         fields = [
-            'name', 'device_role', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'location', 'position', 'face',
+            'name', 'role', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'location', 'position', 'face',
             'latitude', 'longitude', 'status', 'airflow', 'platform', 'primary_ip4', 'primary_ip6', 'oob_ip', 'cluster',
             'tenant_group', 'tenant', 'virtual_chassis', 'vc_position', 'vc_priority', 'description', 'config_template',
             'comments', 'tags', 'local_context_data',

diff --git a/netbox/dcim/migrations/0181_rename_device_role_device_role.py b/netbox/dcim/migrations/0181_rename_device_role_device_role.py
@@ -0,0 +1,35 @@
+from django.db import migrations
+
+
+def update_table_configs(apps, schema_editor):
+    """
+    Replace the `device_role` column in DeviceTable configs with `role`.
+    """
+    UserConfig = apps.get_model('users', 'UserConfig')
+
+    for table in ('DeviceTable', 'DeviceBayTable'):
+        for config in UserConfig.objects.filter(**{f'data__tables__{table}__columns__contains': 'device_role'}):
+            config.data['tables'][table]['columns'] = [
+                'role' if x == 'device_role' else x
+                for x in config.data['tables'][table]['columns']
+            ]
+            config.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dcim', '0180_powerfeed_tenant'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='device',
+            old_name='device_role',
+            new_name='role',
+        ),
+        migrations.RunPython(
+            code=update_table_configs,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]
diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py
@@ -537,7 +537,7 @@ class Device(PrimaryModel, ConfigContextModel, TrackingModelMixin):
         on_delete=models.PROTECT,
         related_name='instances'
     )
-    device_role = models.ForeignKey(
+    role = models.ForeignKey(
         to='dcim.DeviceRole',
         on_delete=models.PROTECT,
         related_name='devices',
@@ -758,7 +758,7 @@ class Device(PrimaryModel, ConfigContextModel, TrackingModelMixin):
     objects = ConfigContextModelQuerySet.as_manager()
 
     clone_fields = (
-        'device_type', 'device_role', 'tenant', 'platform', 'site', 'location', 'rack', 'face', 'status', 'airflow',
+        'device_type', 'role', 'tenant', 'platform', 'site', 'location', 'rack', 'face', 'status', 'airflow',
         'cluster', 'virtual_chassis',
     )
     prerequisite_models = (
@@ -808,6 +808,20 @@ def __str__(self):
     def get_absolute_url(self):
         return reverse('dcim:device', args=[self.pk])
 
+    @property
+    def device_role(self):
+        """
+        For backwards compatibility with pre-v3.6 code expecting a device_role to be present on Device.
+        """
+        return self.role
+
+    @device_role.setter
+    def device_role(self, value):
+        """
+        For backwards compatibility with pre-v3.6 code expecting a device_role to be present on Device.
+        """
+        self.role = value
+
     def clean(self):
         super().clean()
 
@@ -1063,8 +1077,8 @@ def get_config_template(self):
         """
         if self.config_template:
             return self.config_template
-        if self.device_role.config_template:
-            return self.device_role.config_template
+        if self.role.config_template:
+            return self.role.config_template
         if self.platform and self.platform.config_template:
             return self.platform.config_template
 

diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py
@@ -323,7 +323,7 @@ def get_rack_units(self, user=None, face=DeviceFaceChoices.FACE_FRONT, exclude=N
             devices = Device.objects.prefetch_related(
                 'device_type',
                 'device_type__manufacturer',
-                'device_role'
+                'role'
             ).annotate(
                 devicebay_count=Count('devicebays')
             ).exclude(

diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py
@@ -167,9 +167,9 @@ def _get_color(cls, instance):
         if hasattr(instance, 'parent_object'):
             # Termination
             return getattr(instance, 'color', 'f0f0f0') or 'f0f0f0'
-        if hasattr(instance, 'device_role'):
+        if hasattr(instance, 'role'):
             # Device
-            return instance.device_role.color
+            return instance.role.color
         else:
             # Other parent object
             return 'e0e0e0'