nautobot 2.0.0a2__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/tenancy/templates/tenancy/tenant_edit.html

@@ -7,7 +7,6 @@
         <div class="panel-heading"><strong>Tenant</strong></div>
         <div class="panel-body">
             {% render_field form.name %}
-            {% render_field form.slug %}
             {% render_field form.group %}
             {% render_field form.description %}
         </div>

nautobot/tenancy/templates/tenancy/tenantgroup.html

@@ -18,7 +18,7 @@
                 <tr>
                     <td>Tenants</td>
                     <td>
-                        <a href="{% url 'tenancy:tenant_list' %}?group={{ object.slug }}">{{ tenant_table.rows|length }}</a>
+                        <a href="{% url 'tenancy:tenant_list' %}?group={{ object.name }}">{{ tenant_table.rows|length }}</a>
                     </td>
                 </tr>
             </table>

nautobot/tenancy/tests/test_api.py

@@ -6,37 +6,31 @@ from nautobot.tenancy.models import Tenant, TenantGroup
 
 class AppTest(APITestCase):
     def test_root(self):
-
         url = reverse("tenancy-api:api-root")
         response = self.client.get(f"{url}?format=api", **self.header)
 
         self.assertEqual(response.status_code, 200)
 
 
-class TenantGroupTest(APIViewTestCases.APIViewTestCase):
+class TenantGroupTest(APIViewTestCases.APIViewTestCase, APIViewTestCases.TreeModelAPIViewTestCaseMixin):
     model = TenantGroup
-    brief_fields = ["display", "id", "name", "slug", "tenant_count", "tree_depth", "url"]
     bulk_update_data = {
         "description": "New description",
     }
-    slug_source = "name"
 
     @classmethod
     def setUpTestData(cls):
         cls.create_data = [
             {
                 "name": "Tenant Group 4",
-                "slug": "tenant-group-4",
                 "parent": TenantGroup.objects.last().pk,
             },
             {
                 "name": "Tenant Group 5",
-                "slug": "tenant-group-5",
                 "parent": TenantGroup.objects.last().pk,
             },
             {
                 "name": "Tenant Group 6",
-                "slug": "tenant-group-6",
             },
             {
                 "name": "Tenant Group 7",
@@ -46,11 +40,9 @@ class TenantGroupTest(APIViewTestCases.APIViewTestCase):
 
 class TenantTest(APIViewTestCases.APIViewTestCase):
     model = Tenant
-    brief_fields = ["display", "id", "name", "slug", "url"]
     bulk_update_data = {
         "description": "New description",
     }
-    slug_source = "name"
 
     @classmethod
     def setUpTestData(cls):
@@ -60,17 +52,14 @@ class TenantTest(APIViewTestCases.APIViewTestCase):
         cls.create_data = [
             {
                 "name": "Tenant 4",
-                "slug": "tenant-4",
                 "tenant_group": TenantGroup.objects.first().pk,
             },
             {
                 "name": "Tenant 5",
-                "slug": "tenant-5",
                 "tenant_group": TenantGroup.objects.last().pk,
             },
             {
                 "name": "Tenant 6",
-                "slug": "tenant-6",
             },
             {
                 "name": "Tenant 7",

nautobot/tenancy/tests/test_filters.py

@@ -3,7 +3,7 @@ import factory
 from nautobot.circuits.models import Circuit
 from nautobot.core.testing import FilterTestCases
 from nautobot.dcim.models import Device, DeviceType, Location, LocationType, Platform, Rack, RackReservation
-from nautobot.extras.models import Role, Status
+from nautobot.extras.models import Role, Status, Tag
 from nautobot.ipam.models import IPAddress, Prefix, RouteTarget, VLAN, VRF
 from nautobot.tenancy.filters import TenantGroupFilterSet, TenantFilterSet
 from nautobot.tenancy.models import Tenant, TenantGroup
@@ -20,7 +20,7 @@ from nautobot.virtualization.factory import (
 )
 
 
-class TenantGroupTestCase(FilterTestCases.NameSlugFilterTestCase):
+class TenantGroupTestCase(FilterTestCases.NameOnlyFilterTestCase):
     queryset = TenantGroup.objects.all()
     filterset = TenantGroupFilterSet
 
@@ -37,7 +37,7 @@ class TenantGroupTestCase(FilterTestCases.NameSlugFilterTestCase):
             self.filterset(params, self.queryset).qs,
             TenantGroup.objects.filter(parent__in=[parent_groups[0], parent_groups[1]]),
         )
-        params = {"parent": [parent_groups[0].slug, parent_groups[1].slug]}
+        params = {"parent": [parent_groups[0].name, parent_groups[1].name]}
         self.assertQuerysetEqualAndNotEmpty(
             self.filterset(params, self.queryset).qs,
             TenantGroup.objects.filter(parent__in=[parent_groups[0], parent_groups[1]]),
@@ -46,7 +46,7 @@ class TenantGroupTestCase(FilterTestCases.NameSlugFilterTestCase):
     def test_children(self):
         """Test the `children` filter."""
         child_groups = TenantGroup.objects.filter(parent__isnull=False)
-        params = {"children": [child_groups[0].pk, child_groups[1].slug]}
+        params = {"children": [child_groups[0].pk, child_groups[1].name]}
         self.assertQuerysetEqualAndNotEmpty(
             self.filterset(params, self.queryset).qs,
             TenantGroup.objects.filter(children__in=[child_groups[0], child_groups[1]]).distinct(),
@@ -68,7 +68,7 @@ class TenantGroupTestCase(FilterTestCases.NameSlugFilterTestCase):
     def test_tenants(self):
         """Test the `tenants` filter."""
         tenants = Tenant.objects.filter(tenant_group__isnull=False)
-        params = {"tenants": [tenants[0].pk, tenants[1].slug]}
+        params = {"tenants": [tenants[0].pk, tenants[1].name]}
         self.assertQuerysetEqualAndNotEmpty(
             self.filterset(params, self.queryset).qs,
             TenantGroup.objects.filter(tenants__in=[tenants[0], tenants[1]]).distinct(),
@@ -88,17 +88,21 @@ class TenantGroupTestCase(FilterTestCases.NameSlugFilterTestCase):
         )
 
 
-class TenantTestCase(FilterTestCases.NameSlugFilterTestCase):
+class TenantTestCase(FilterTestCases.NameOnlyFilterTestCase):
     queryset = Tenant.objects.all()
     filterset = TenantFilterSet
 
     @classmethod
     def setUpTestData(cls):
-        active = Status.objects.get(name="Active")
         location_type = LocationType.objects.create(name="Root Type")
+        location_status = Status.objects.get_for_model(Location).first()
         cls.locations = (
-            Location.objects.create(name="Root 1", location_type=location_type, status=active, tenant=cls.queryset[0]),
-            Location.objects.create(name="Root 2", location_type=location_type, status=active, tenant=cls.queryset[1]),
+            Location.objects.create(
+                name="Root 1", location_type=location_type, status=location_status, tenant=cls.queryset[0]
+            ),
+            Location.objects.create(
+                name="Root 2", location_type=location_type, status=location_status, tenant=cls.queryset[1]
+            ),
         )
 
         # TODO: move this to nautobot.core.management.commands.generate_test_data and update all impacted tests
@@ -112,6 +116,7 @@ class TenantTestCase(FilterTestCases.NameSlugFilterTestCase):
         VirtualMachineFactory.create_batch(10)
 
         # We don't have a DeviceFactory yet
+        device_status = Status.objects.get_for_model(Device).first()
         cls.devices = (
             Device.objects.create(
                 name="Device 1",
@@ -119,7 +124,7 @@ class TenantTestCase(FilterTestCases.NameSlugFilterTestCase):
                 role=Role.objects.get_for_model(Device).first(),
                 platform=Platform.objects.first(),
                 location=cls.locations[0],
-                status=active,
+                status=device_status,
                 tenant=Tenant.objects.first(),
             ),
             Device.objects.create(
@@ -128,11 +133,14 @@ class TenantTestCase(FilterTestCases.NameSlugFilterTestCase):
                 role=Role.objects.get_for_model(Device).first(),
                 platform=Platform.objects.first(),
                 location=cls.locations[0],
-                status=active,
+                status=device_status,
                 tenant=Tenant.objects.last(),
             ),
         )
 
+        tenant = Tenant.objects.first()
+        tenant.tags.set(Tag.objects.all()[:2])
+
     def test_description(self):
         params = {
             "description": Tenant.objects.exclude(description__exact="").values_list("description", flat=True)[:2]
@@ -218,7 +226,7 @@ class TenantTestCase(FilterTestCases.NameSlugFilterTestCase):
             self.filterset(params, self.queryset).qs,
             self.queryset.filter(tenant_group__in=groups_including_children),
         )
-        params = {"tenant_group": [groups[0].slug, groups[1].slug]}
+        params = {"tenant_group": [groups[0].name, groups[1].name]}
         self.assertQuerysetEqualAndNotEmpty(
             self.filterset(params, self.queryset).qs,
             self.queryset.filter(tenant_group__in=groups_including_children),

nautobot/tenancy/tests/test_views.py

@@ -8,23 +8,18 @@ class TenantGroupTestCase(ViewTestCases.OrganizationalObjectViewTestCase):
 
     @classmethod
     def setUpTestData(cls):
-        TenantGroup.objects.create(name="Tenant Group 8")
-
         cls.form_data = {
             "name": "Tenant Group X",
-            "slug": "tenant-group-x",
             "description": "A new tenant group",
         }
 
         cls.csv_data = (
-            "name,slug,description",
-            "Tenant Group 4,tenant-group-4,Fourth tenant group",
-            "Tenant Group 5,tenant-group-5,Fifth tenant group",
-            "Tenant Group 6,tenant-group-6,Sixth tenant group",
-            "Tenant Group 7,,Seventh tenant group",
+            "name,description",
+            "Tenant Group 4,Fourth tenant group",
+            "Tenant Group 5,Fifth tenant group",
+            "Tenant Group 6,Sixth tenant group",
+            "Tenant Group 7,Seventh tenant group",
         )
-        cls.slug_source = "name"
-        cls.slug_test_object = "Tenant Group 8"
 
 
 class TenantTestCase(ViewTestCases.PrimaryObjectViewTestCase):
@@ -32,14 +27,11 @@ class TenantTestCase(ViewTestCases.PrimaryObjectViewTestCase):
 
     @classmethod
     def setUpTestData(cls):
-
         tenant_groups = TenantGroup.objects.all()[:2]
-
-        Tenant.objects.create(name="Tenant 8", tenant_group=tenant_groups[0])
+        Tenant.objects.create(name="New Tenant", tenant_group=tenant_groups[0])
 
         cls.form_data = {
             "name": "Tenant X",
-            "slug": "tenant-x",
             "tenant_group": tenant_groups[1].pk,
             "description": "A new tenant",
             "comments": "Some comments",
@@ -47,23 +39,13 @@ class TenantTestCase(ViewTestCases.PrimaryObjectViewTestCase):
         }
 
         cls.csv_data = (
-            "name,slug",
-            "Tenant 4,tenant-4",
-            "Tenant 5,tenant-5",
-            "Tenant 6,tenant-6",
-            "Tenant 7,",
+            "name,description",
+            "Tenant 4,A tenant",
+            "Tenant 5,A tenant",
+            "Tenant 6,A tenant",
+            "Tenant 7,A tenant",
         )
 
         cls.bulk_edit_data = {
             "tenant_group": tenant_groups[1].pk,
         }
-        cls.slug_source = "name"
-        cls.slug_test_object = "Tenant 8"
-
-    def get_deletable_object_pks(self):
-        tenants = [
-            Tenant.objects.create(name="Deletable Tenant 1"),
-            Tenant.objects.create(name="Deletable Tenant 2"),
-            Tenant.objects.create(name="Deletable Tenant 3"),
-        ]
-        return [t.pk for t in tenants]

nautobot/tenancy/urls.py

@@ -24,28 +24,28 @@ urlpatterns = [
         name="tenantgroup_bulk_delete",
     ),
     path(
-        "tenant-groups/<slug:slug>/",
+        "tenant-groups/<uuid:pk>/",
         views.TenantGroupView.as_view(),
         name="tenantgroup",
     ),
     path(
-        "tenant-groups/<slug:slug>/edit/",
+        "tenant-groups/<uuid:pk>/edit/",
         views.TenantGroupEditView.as_view(),
         name="tenantgroup_edit",
     ),
     path(
-        "tenant-groups/<slug:slug>/delete/",
+        "tenant-groups/<uuid:pk>/delete/",
         views.TenantGroupDeleteView.as_view(),
         name="tenantgroup_delete",
     ),
     path(
-        "tenant-groups/<slug:slug>/changelog/",
+        "tenant-groups/<uuid:pk>/changelog/",
         ObjectChangeLogView.as_view(),
         name="tenantgroup_changelog",
         kwargs={"model": TenantGroup},
     ),
     path(
-        "tenant-groups/<slug:slug>/notes/",
+        "tenant-groups/<uuid:pk>/notes/",
         ObjectNotesView.as_view(),
         name="tenantgroup_notes",
         kwargs={"model": TenantGroup},
@@ -60,21 +60,21 @@ urlpatterns = [
         views.TenantBulkDeleteView.as_view(),
         name="tenant_bulk_delete",
     ),
-    path("tenants/<slug:slug>/", views.TenantView.as_view(), name="tenant"),
-    path("tenants/<slug:slug>/edit/", views.TenantEditView.as_view(), name="tenant_edit"),
+    path("tenants/<uuid:pk>/", views.TenantView.as_view(), name="tenant"),
+    path("tenants/<uuid:pk>/edit/", views.TenantEditView.as_view(), name="tenant_edit"),
     path(
-        "tenants/<slug:slug>/delete/",
+        "tenants/<uuid:pk>/delete/",
         views.TenantDeleteView.as_view(),
         name="tenant_delete",
     ),
     path(
-        "tenants/<slug:slug>/changelog/",
+        "tenants/<uuid:pk>/changelog/",
         ObjectChangeLogView.as_view(),
         name="tenant_changelog",
         kwargs={"model": Tenant},
     ),
     path(
-        "tenants/<slug:slug>/notes/",
+        "tenants/<uuid:pk>/notes/",
         ObjectNotesView.as_view(),
         name="tenant_notes",
         kwargs={"model": Tenant},

nautobot/tenancy/views.py

@@ -26,7 +26,6 @@ class TenantGroupView(generic.ObjectView):
     queryset = TenantGroup.objects.all()
 
     def get_extra_context(self, request, instance):
-
         # Tenants
         tenants = Tenant.objects.restrict(request.user, "view").filter(
             tenant_group__in=instance.descendants(include_self=True)
@@ -57,7 +56,6 @@ class TenantGroupDeleteView(generic.ObjectDeleteView):
 
 class TenantGroupBulkImportView(generic.BulkImportView):
     queryset = TenantGroup.objects.all()
-    model_form = forms.TenantGroupCSVForm
     table = tables.TenantGroupTable
 
 
@@ -118,7 +116,6 @@ class TenantDeleteView(generic.ObjectDeleteView):
 
 class TenantBulkImportView(generic.BulkImportView):
     queryset = Tenant.objects.all()
-    model_form = forms.TenantCSVForm
     table = tables.TenantTable
 
 

nautobot/ui/.eslintignore

@@ -0,0 +1,6 @@
+build
+
+# These files get rendered by `nautobot-server build_ui`
+app_imports.js
+jsconfig.paths.json
+app_routes.json

nautobot/ui/.gitignore

@@ -0,0 +1,10 @@
+node_modules
+build
+
+# These files get rendered by `nautobot-server build_ui`
+app_imports.js
+jsconfig.paths.json
+app_routes.json
+
+# The output of `npm run analyze`
+analyze_report.html

nautobot/ui/.prettierignore

@@ -0,0 +1,9 @@
+build
+
+# These files get rendered by `nautobot-server build_ui`
+app_imports.js
+jsconfig.paths.json
+app_routes.json
+
+# This is generated when running `npm run analyze`
+analyze_report.html

nautobot/ui/.prettierrc

@@ -0,0 +1,4 @@
+{
+    "tabWidth": 4,
+    "useTabs": false
+}

nautobot/ui/README.md

@@ -0,0 +1,33 @@
+# Nautobot v2 UI Prototype
+
+## Running it
+
+Install and compile dependencies (note that you'll only use `--npm-install` on initial setup):
+
+```no-highlight
+nautobot-server build_ui --npm-install
+```
+
+Set the `NAUTOBOT_API_TOKEN` prior to starting the server:
+
+```no-highlight
+export NAUTOBOT_API_TOKEN=nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn
+```
+
+Start Nautobot on port `8080/tcp`:
+
+```no-highlight
+nautobot-server runserver 0.0.0.0:8080 --insecure
+```
+
+## Running test
+
+To run all test suite, run:
+
+```no-highlight
+invoke unittest-ui
+```
+
+## Debugging Startup/Build Failures
+
+Nautobot will attempt to build the UI on startup when running `post_upgrade` but during development the React project may fail to build, never allowing the Node.JS container from starting. In that situation, skip running the `post_upgrade` until the React app can start. In container workflows that will mean setting the `NAUTOBOT_DOCKER_SKIP_INIT` environment variable to `True`.

nautobot/ui/app_imports.js.j2

@@ -0,0 +1,7 @@
+export const NautobotApps = {
+{% for app in apps %}
+    "{{ app }}": import("@{{ app }}"),
+{% endfor %}
+}
+
+export default NautobotApps

nautobot/ui/craco.config.js

@@ -0,0 +1,46 @@
+const {
+    NautobotCracoAliasPlugin,
+} = require("./lib/nautobot-craco-alias-plugin");
+
+// Suppress console logging unless debugging is explicitly enabled.
+if (!process.env.NAUTOBOT_DEBUG) {
+    console.log = function () {};
+}
+
+module.exports = {
+    plugins: [
+        {
+            plugin: NautobotCracoAliasPlugin,
+        },
+    ],
+
+    webpack: {
+        configure: (webpackConfig) => {
+            // TODO(jathan): Still working out quirks on how to properly tie together static files and self-hosting
+            // config.output.path = path.resolve(__dirname, "build/static")  // Should be in STATICFILES_DIRS
+            // config.output.publicPath = process.env.NAUTOBOT_STATIC_URL // Should match STATIC_URL
+            webpackConfig.output.filename = "static/js/[name].js"; // No filename hashing; Django collectstatic takes care of this
+            webpackConfig.output.assetModuleFilename =
+                "static/media/[name].[ext]";
+            webpackConfig.output.chunkFilename =
+                "static/js/[id]-[chunkhash].js"; // DO have Webpack hash chunk filename
+
+            // Sourcemaps are our friend: https://blog.teamtreehouse.com/introduction-source-maps
+            // Prefer a hidden sourcemap file to help with analyzing code but don't link it for production.
+            webpackConfig.devtool = "hidden-source-map";
+            if (process.env.NAUTOBOT_DEBUG) {
+                // Generate a full sourcemap for debugging and analyzing with `npm run analyze`.
+                webpackConfig.devtool = "eval-source-map";
+            }
+
+            // Plugin item 5 is the `MiniCssExtractPlugin`. Overload it to not hash the CSS filename.
+            webpackConfig.plugins[5].options.filename = "static/css/[name].css";
+
+            // TODO(jathan): This might be safely deleted.
+            webpackConfig.devServer = {
+                writeToDisk: true, // Write files to disk in dev mode so Django can serve the assets
+            };
+            return webpackConfig;
+        },
+    },
+};

nautobot/ui/jsconfig-base.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "baseUrl": ".",
+        "paths": {
+            "@utils/*": ["src/utils/*"],
+            "@constants/*": ["src/constants/*"],
+            "@views/*": ["src/views/*"],
+            "@components/*": ["src/components/*"]
+        }
+    }
+}

nautobot/ui/jsconfig.json

@@ -0,0 +1,5 @@
+{
+    "extends": "./jsconfig.paths.json",
+    "compilerOptions": {},
+    "exclude": ["node_modules", "build"]
+}

nautobot/ui/lib/nautobot-craco-alias-plugin.js

@@ -0,0 +1,40 @@
+/**
+ * This is a wrapper around react-app-alias and react-app-alias-ex that addresses
+ * a bug in react-app-alias-ex where it does not properly resolve the path to
+ * node_modules when running Jest tests.
+ *
+ * See: https://github.com/oklas/react-app-alias/issues/95
+ */
+const path = require("path");
+const paths = require("react-scripts/config/paths");
+const { aliasJest: aliasJestSafe, defaultOptions } = require("react-app-alias");
+const { aliasWebpack } = require("react-app-alias-ex");
+
+function aliasJest(options) {
+    const aliasMap = defaultOptions(options).aliasMap;
+    const aliasJestInstance = aliasJestSafe(aliasMap);
+    return function (config) {
+        const expanded = aliasJestInstance(config);
+        const returning = {
+            ...expanded,
+            moduleDirectories: [
+                ...(config.moduleDirectories || ["node_modules"]), // react-app-alias-ex defaulted to [] instead of the Jest default of ["node_modules"]
+                path.resolve(paths.appPath, "node_modules"),
+            ],
+        };
+        return returning;
+    };
+}
+
+const NautobotCracoAliasPlugin = {
+    overrideWebpackConfig: function ({ webpackConfig, pluginOptions }) {
+        return aliasWebpack(pluginOptions)(webpackConfig);
+    },
+    overrideJestConfig: function ({ jestConfig, pluginOptions }) {
+        return aliasJest(pluginOptions)(jestConfig);
+    },
+};
+
+module.exports = {
+    NautobotCracoAliasPlugin,
+};