Device modules UI #5724

gsnider2195 · 2024-05-16T18:13:46Z

Closes #2101

What's Changed

Screenshots

List views

Module

ModuleType

ModuleBay

Modular device component list view

Device bulk add component

Module bulk add component

Create/Edit views

Module

ModuleType

Delete/Bulk Delete views

ModuleBay delete

ModuleBay bulk delete

Module delete

Module bulk delete

Detail views

Module

Module ModuleBay view tab

ModuleBay

ModuleType

ModuleType detail tab

ModuleType detail "add components" menu

Device Modules tab

DeviceType ModuleBays tab

DeviceType detail "add components" menu

TODO

nautobot/core/filters.py

nautobot/core/testing/views.py

nautobot/core/views/renderers.py

glennmatthews · 2024-05-16T18:47:31Z

nautobot/dcim/filters/mixins.py

+    has_empty_module_bays = django_filters.BooleanFilter(
+        method="filter_has_empty_module_bays",
+        label="Has empty module bays",
+    )
    module_bays = django_filters.ModelMultipleChoiceFilter(


Not NaturalKeyOrPKMultipleChoiceFilter?

Might be appropriate here? I was thinking the module bay "position" wouldn't be suitable for a natural key since in the common case they're going to be integers.

I think that would be appropriate, seems like module_bays=lc0&module_bays=lc1 might be a plausible filter to use?

nautobot/dcim/filters/mixins.py

nautobot/dcim/navigation.py

nautobot/dcim/tables/devices.py

nautobot/dcim/templates/dcim/module_retrieve.html

nautobot/dcim/views.py

…es-ui

…e detail views, add module column to component list views, update destroy and bulk destroy warnings, various other fixes

gsnider2195 · 2024-05-21T19:55:15Z

nautobot/dcim/templates/dcim/device/devicebays.html

@@ -18,21 +18,21 @@
            {% render_table devicebay_table 'inc/table.html' %}
            <div class="panel-footer noprint">
                {% if perms.dcim.change_devicebay %}
-                    <button type="submit" name="_rename" formaction="{% url 'dcim:devicebay_bulk_rename' %}?return_url={{ object.get_absolute_url }}%23tab_devicebays" class="btn btn-warning btn-xs">
+                    <button type="submit" name="_rename" formaction="{% url 'dcim:devicebay_bulk_rename' %}?return_url={% url 'dcim:device_devicebays' pk=object.pk %}" class="btn btn-warning btn-xs">


Unrelated bug fix

glennmatthews

Wow! Great stuff.

glennmatthews · 2024-05-23T12:45:37Z

nautobot/core/management/commands/generate_test_data.py

-        ModuleBayTemplateFactory.create_batch(30, using=db_name)
+        ModuleBayTemplateFactory.create_batch(90, using=db_name)


That's a lot! Not necessarily opposed but curious why so many are needed?

I think I needed this for the ModuleFilterSet.has_modules test. I know it was one of the filter tests. All of the components are split between modules and devices, so it was around 15 for devices and 15 for modules before. If we only had 15 of these split up between 20 modules there's a chance we wouldn't have enough modules with multiple module bays or at least 2 modules with nested modules.

Might be able to instead call ModuleBayTemplateFactory.create_batch() several times with distinct parameters as an alternative (create_batch(10, has_parent_device=False) or whatever). Not critical.

nautobot/core/testing/views.py

nautobot/core/views/generic.py

glennmatthews · 2024-05-23T12:48:41Z

nautobot/core/views/mixins.py

-
-        context = serializer.data
-        context["use_new_ui"] = True
+        context = {"use_new_ui": True}


Could probably yeet this.

nautobot/core/views/renderers.py

nautobot/dcim/views.py

glennmatthews · 2024-05-23T13:47:35Z

nautobot/extras/templates/extras/role_retrieve.html

@@ -191,4 +191,20 @@
        </div>
    {% include 'inc/paginator.html' with paginator=controller_table.paginator page=controller_table.page %}
    {% endif %}
+    {% if module_table %}


Should we similarly update the location detail view to include a count of colocated modules?

…recursion of modules

gsnider2195 · 2024-05-24T03:12:36Z

nautobot/project-static/css/base.css

@@ -97,6 +97,7 @@ table.attr-table td:nth-child(1) {
 }
 .table-headings th {
    background-color: #f5f5f5;
+    white-space: nowrap;


This removes wrapping on all table headings throughout nautobot @lampwins

gsnider2195 · 2024-05-31T13:08:04Z

nautobot/circuits/factory.py

-    name = factory.LazyAttribute(
-        lambda o: f"{o.provider.name} Network {faker.Faker().word(part_of_speech='noun')}"[:100]
-    )
+    name = factory.LazyAttributeSequence(lambda o, n: f"{o.provider.name} Network {n + 1}"[:100])


Fixes random failures

gsnider2195 · 2024-05-31T13:08:49Z

nautobot/circuits/tests/test_filters.py

@@ -108,7 +108,9 @@ def test_location(self):
            has_location=True,
            location=locations[1],
        )
-        expected = self.queryset.filter(circuit_terminations__location__in=[locations[0].pk, locations[1].pk])
+        expected = self.queryset.filter(


Random flaky test failure fixes

gsnider2195 · 2024-05-31T13:12:12Z

nautobot/core/forms/forms.py

@@ -121,7 +121,7 @@ class BulkRenameForm(forms.Form):
    """

    find = forms.CharField()
-    replace = forms.CharField()
+    replace = forms.CharField(required=False, strip=False)


This allows you to have a blank replacement string, or to have leading and trailing whitespace on your replacement string. Examples:

Interface1

Replace ^Interface with blank string to change the name to just 1
Replace ^Interface with Interface to change the name to Interface 1

gsnider2195 · 2024-05-31T13:15:02Z

nautobot/core/testing/filters.py

-            # Create random 5 char string to append to attribute, used for icontains partial lookup
-            lookup = "".join(random.choices(string.ascii_lowercase, k=5))  # noqa: S311 # pseudo-random generator
-            obj_field_value = getattr(obj, obj_field_name)
+            # Generic test only supports CharField or TextFields, skip all other types


This test was randomly failing because 5 random characters wasn't enough to make the field unique enough. Now the test fills the entire field with random lowercase letters and then filters on field__icontains=new_field_value[1:].upper() or field__iexact=new_field_value.upper()

1 in 26^5 = one in 11881376 odds of non-uniqueness? Sheesh, you did have the worst luck. :-)

gsnider2195 · 2024-05-31T13:17:26Z

nautobot/core/testing/views.py

        """

        form_data = {}
+        update_data = {}


Added a new attr to the edit view generic test for cases where the create data and edit data are not interchangeable. Similar but not identical to the api generic tests

gsnider2195 · 2024-05-31T13:18:29Z

nautobot/core/testing/views.py

@@ -780,6 +785,10 @@ def test_list_objects_anonymous(self):
        @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
        def test_list_objects_filtered(self):
            instance1, instance2 = self._get_queryset().all()[:2]
+            if hasattr(self.model, "name") and instance1.name == instance2.name:


Fixing issues with random data generation sometimes creating two instances with the same name

This an issue with models with non-globally-unique names? Might be better to fix in the factories, but not critical.

I think the issue might actually be where we're creating data that looks realistic like Interface 1 - Interface 24 on more than one device.

gsnider2195 · 2024-05-31T13:19:13Z

nautobot/core/testing/views.py

@@ -1363,6 +1379,7 @@ class BulkRenameObjectsViewTestCase(ModelViewTestCase):
            "replace": "\\1X",  # Append an X to the original value
            "use_regex": True,
        }
+        rename_field = "name"  # The model field to be changed


May be able to remove this when we add the name field to ModuleBay

gsnider2195 · 2024-05-31T13:23:42Z

nautobot/core/testing/views.py

+        def _edit_object_test_setup(self):
+            test_instance = self._get_queryset().first()
+            self.update_data = {
+                "name": test_instance.name,
+                "device_type": test_instance.device_type.pk,
+                "label": "new test label",
+                "description": "new test description",
+            }
+
+        @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
+        def test_edit_object_with_constrained_permission(self):
+            # Overload this test so that only the label and description fields are changed
+            self._edit_object_test_setup()
+            super().test_edit_object_with_constrained_permission()
+
+        @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
+        def test_edit_object_with_permission(self):
+            # Overload this test so that only the label and description fields are changed
+            self._edit_object_test_setup()
+            super().test_edit_object_with_permission()
+
+    class ModularDeviceComponentTemplateViewTestCase(DeviceComponentTemplateViewTestCase):
+        def _edit_object_test_setup(self):
+            test_instance = self._get_queryset().first()
+            self.update_data = {
+                "name": test_instance.name,
+                "device_type": getattr(getattr(test_instance, "device_type", None), "pk", None),
+                "module_type": getattr(getattr(test_instance, "module_type", None), "pk", None),
+                "label": "new test label",
+                "description": "new test description",
+            }


With the creation of the component factories, this test was setting statically defined data on randomly generated instances. That doesn't work for cases like FrontPort where the RearPort has to belong to the same device/module. We should update this test to work like the API tests where we can supply specific field values to change instead of having to provide the entire set of form data.

gsnider2195 · 2024-05-31T13:43:35Z

nautobot/dcim/factory.py

-        factory.LazyAttribute(lambda o: get_random_software_version_for_device_type(o.device_type)),
-        None,
-    )
+    software_version = factory.LazyAttribute(lambda o: get_random_software_version_for_device_type(o.device_type))


DeviceType already has a 50% chance of having a software version

glennmatthews · 2024-05-31T15:41:46Z

nautobot/core/testing/filters.py

-            # Create random 5 char string to append to attribute, used for icontains partial lookup
-            lookup = "".join(random.choices(string.ascii_lowercase, k=5))  # noqa: S311 # pseudo-random generator
-            obj_field_value = getattr(obj, obj_field_name)
+            # Generic test only supports CharField or TextFields, skip all other types


1 in 26^5 = one in 11881376 odds of non-uniqueness? Sheesh, you did have the worst luck. :-)

glennmatthews · 2024-05-31T15:43:47Z

nautobot/core/testing/views.py

@@ -780,6 +785,10 @@ def test_list_objects_anonymous(self):
        @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
        def test_list_objects_filtered(self):
            instance1, instance2 = self._get_queryset().all()[:2]
+            if hasattr(self.model, "name") and instance1.name == instance2.name:


This an issue with models with non-globally-unique names? Might be better to fix in the factories, but not critical.

glennmatthews · 2024-05-31T15:48:44Z

nautobot/core/views/generic.py

+                                # add parent object key to related object data
+                                rel_obj_data[obj._meta.verbose_name.replace(" ", "_")] = str(obj.pk)


Not entirely sure I follow this one, can you clarify the comment?

Previously, the ComponentTemplateImportForm base class took the parent object as the first argument in __init__ and added it to data. I changed it so we're updating the form data before we instantiate the form.

nautobot/nautobot/dcim/forms.py

Lines 1403 to 1411 in bc22ef3

def __init__(self, device_type, data=None, *args, **kwargs):

# Must pass the parent DeviceType on form initialization

data.update(

{

"device_type": device_type.pk,

}

)

super().__init__(data, *args, **kwargs)

nautobot/core/views/renderers.py

glennmatthews · 2024-05-31T15:56:58Z

nautobot/dcim/models/device_components.py

    class Meta:
        # TODO: Ordering by parent_module.id is not correct but prevents an infinite loop
        ordering = (
            "parent_device",
            "parent_module__id",
-            "position",
+            "_position",


Do we need CollateAsChar here?

nautobot/dcim/templates/dcim/device/modulebays.html

nautobot/dcim/tests/test_models.py

nautobot/dcim/tests/test_views.py

nautobot/dcim/views.py

…ding the base class test

HanlinMiao · 2024-05-31T19:10:22Z

nautobot/dcim/tables/template_code.py

            <i class="mdi mdi-plus-thick" aria-hidden="true" title="Install device"></i>
        </a>
    {% endif %}
 {% endif %}
 """
+
+MODULE_BUTTONS = """
+<a href="{% url 'dcim:module' pk=record.pk %}" class="btn btn-default btn-xs" title="Details"><i class="mdi mdi-information-outline" aria-hidden="true"></i></a>


do we need perms.dcim.view_module here?

I don't think these would be rendered if you don't have access to view modules (the table would be empty)

HanlinMiao · 2024-05-31T19:21:39Z

nautobot/dcim/templates/dcim/modulebay_bulk_destroy.html

@@ -0,0 +1,5 @@
+{% extends "generic/object_bulk_destroy.html" %}


nit: can we merge it with module_bulk_destroy.html?

gsnider2195 added 5 commits May 13, 2024 18:01

ui wip

b44c6d0

still a wip

75df311

module edit view with dynamic tabs

c2e7934

wip ui module view

3fb0746

fix nautobot html renderer, add the rest of the module component views

2fc00bd

glennmatthews reviewed May 16, 2024

View reviewed changes

gsnider2195 added 10 commits May 16, 2024 16:22

add bulk create for module bays and module bay templates

a7a6a5c

pr feedback

cab9539

update htmlrenderer

3c679c3

bulk add views

5ee54d7

bulk rename views for module bays and module bay templates

26c176a

pr feedback

5f2e949

fix linters and failing tests

df9541b

Merge branch 'u/gas-2101-device-modules' into u/gas-2101-device-modul…

55a05ca

…es-ui

fix nautobotuiviewset context priority

67d2b0c

add detail view for modulebay, move tabs for devicetype and moduletyp…

d01abbd

…e detail views, add module column to component list views, update destroy and bulk destroy warnings, various other fixes

gsnider2195 commented May 21, 2024

View reviewed changes

gsnider2195 added 4 commits May 21, 2024 21:38

add some tests, fix some tests

163cd68

ruff

36c5961

fix default tab for module create view, fix test failures

189201a

fix failing api tests

d2f114c

glennmatthews reviewed May 23, 2024

View reviewed changes

gsnider2195 added 5 commits May 23, 2024 16:36

add natural ordering to modulebay, add validation check for infinite …

8ea155d

…recursion of modules

large update with too many changes to enumerate

b062dc4

pr feedback

9c61c3d

pr feedback

3b3b1e3

pr feedback

17fb9a5

gsnider2195 commented May 24, 2024

View reviewed changes

gsnider2195 added 2 commits May 23, 2024 22:15

ruff

a51ade8

fix migration

a323906

gsnider2195 added 7 commits May 30, 2024 15:12

make device component templates not static group associable

5a51260

disable fragile generic test

0beeec8

fix and reenable flakey test

d62cf92

fix test again

dfcdac2

these tests were passing earlier today

890660c

fix tests

0bbae89

fix tests

ff4958a

gsnider2195 marked this pull request as ready for review May 31, 2024 03:13

gsnider2195 commented May 31, 2024

View reviewed changes

gsnider2195 added 2 commits May 31, 2024 10:38

revert factory max length change

dca892d

fix minor issue with unbound front port create form

ad82b9d

glennmatthews approved these changes May 31, 2024

View reviewed changes

gsnider2195 added 6 commits May 31, 2024 11:28

fix test

60bb4f5

update display name for device

85b16af

linkify manufacturer column on device type and module type list views

57f2313

fix test

88b2481

move view test setup into the setuptestdata method instead of overloa…

b310396

…ding the base class test

fix tests

8a35b58

HanlinMiao approved these changes May 31, 2024

View reviewed changes

cleanup, fix flaky integration test

bba8603

gsnider2195 merged commit af57f97 into u/gas-2101-device-modules May 31, 2024
17 checks passed

gsnider2195 deleted the u/gas-2101-device-modules-ui branch May 31, 2024 23:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Device modules UI #5724

Device modules UI #5724

gsnider2195 commented May 16, 2024 •

edited

glennmatthews May 16, 2024

gsnider2195 May 16, 2024

glennmatthews May 23, 2024

gsnider2195 May 21, 2024

glennmatthews left a comment

glennmatthews May 23, 2024

gsnider2195 May 24, 2024 •

edited

glennmatthews May 24, 2024

glennmatthews May 23, 2024

glennmatthews May 23, 2024

gsnider2195 May 24, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024 •

edited

glennmatthews May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

glennmatthews May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

gsnider2195 May 31, 2024

glennmatthews May 31, 2024

glennmatthews May 31, 2024

glennmatthews May 31, 2024

gsnider2195 May 31, 2024

glennmatthews May 31, 2024

HanlinMiao May 31, 2024

gsnider2195 May 31, 2024

HanlinMiao May 31, 2024

		ModuleBayTemplateFactory.create_batch(30, using=db_name)
		ModuleBayTemplateFactory.create_batch(90, using=db_name)

		# add parent object key to related object data
		rel_obj_data[obj._meta.verbose_name.replace(" ", "_")] = str(obj.pk)

	def __init__(self, device_type, data=None, args, *kwargs):
	# Must pass the parent DeviceType on form initialization
	data.update(
	{
	"device_type": device_type.pk,
	}
	)

	super().__init__(data, args, *kwargs)

		@@ -0,0 +1,5 @@
		{% extends "generic/object_bulk_destroy.html" %}

Device modules UI #5724

Device modules UI #5724

Conversation

gsnider2195 commented May 16, 2024 • edited

Closes #2101

What's Changed

Screenshots

List views

Module

ModuleType

ModuleBay

Modular device component list view

Device bulk add component

Module bulk add component

Create/Edit views

Module

ModuleType

Delete/Bulk Delete views

ModuleBay delete

ModuleBay bulk delete

Module delete

Module bulk delete

Detail views

Module

Module ModuleBay view tab

ModuleBay

ModuleType

ModuleType detail tab

ModuleType detail "add components" menu

Device Modules tab

DeviceType ModuleBays tab

DeviceType detail "add components" menu

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glennmatthews left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsnider2195 May 24, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsnider2195 May 31, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsnider2195 commented May 16, 2024 •

edited

gsnider2195 May 24, 2024 •

edited

gsnider2195 May 31, 2024 •

edited