diff --git a/.github/ISSUE_TEMPLATE/01-feature_request.yaml b/.github/ISSUE_TEMPLATE/01-feature_request.yaml index f66b88a47..b31d6d31b 100644 --- a/.github/ISSUE_TEMPLATE/01-feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/01-feature_request.yaml @@ -15,7 +15,7 @@ body: attributes: label: NetBox version description: What version of NetBox are you currently running? - placeholder: v4.5.6 + placeholder: v4.5.7 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/02-bug_report.yaml b/.github/ISSUE_TEMPLATE/02-bug_report.yaml index 445893e0c..4581cef4a 100644 --- a/.github/ISSUE_TEMPLATE/02-bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/02-bug_report.yaml @@ -27,7 +27,7 @@ body: attributes: label: NetBox Version description: What version of NetBox are you currently running? - placeholder: v4.5.6 + placeholder: v4.5.7 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/03-performance.yaml b/.github/ISSUE_TEMPLATE/03-performance.yaml index fcea8cb08..ab59898e2 100644 --- a/.github/ISSUE_TEMPLATE/03-performance.yaml +++ b/.github/ISSUE_TEMPLATE/03-performance.yaml @@ -8,7 +8,7 @@ body: attributes: label: NetBox Version description: What version of NetBox are you currently running? - placeholder: v4.5.6 + placeholder: v4.5.7 validations: required: true - type: dropdown diff --git a/base_requirements.txt b/base_requirements.txt index 5a58f4df5..4568740fe 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -49,8 +49,7 @@ django-rich # Django integration for RQ (Reqis queuing) # https://github.com/rq/django-rq/blob/master/CHANGELOG.md -# See https://github.com/netbox-community/netbox/issues/21696 -django-rq<4.0 +django-rq # Provides a variety of storage backends # https://github.com/jschneier/django-storages/blob/master/CHANGELOG.rst diff --git a/contrib/openapi.json b/contrib/openapi.json index e7f4819b6..edd3dee35 100644 --- a/contrib/openapi.json +++ b/contrib/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.3", "info": { "title": "NetBox REST API", - "version": "4.5.6", + "version": "4.5.7", "license": { "name": "Apache v2 License" } @@ -25468,7 +25468,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25488,7 +25488,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25501,7 +25501,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25514,7 +25514,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25527,7 +25527,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25540,7 +25540,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25553,7 +25553,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25566,7 +25566,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25579,7 +25579,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25592,7 +25592,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25605,7 +25605,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -25618,7 +25618,7 @@ "type": "array", "items": { "type": "string", - "x-spec-enum-id": "5e0f85310f0184ea" + "x-spec-enum-id": "f566e6df6572f5d0" } }, "explode": true, @@ -138591,6 +138591,50 @@ } } }, + "/api/extras/scripts/upload/": { + "post": { + "operationId": "extras_scripts_upload_create", + "description": "Post a list of script module objects.", + "tags": [ + "extras" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScriptModuleRequest" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScriptModuleRequest" + } + } + }, + "required": true + }, + "security": [ + { + "cookieAuth": [] + }, + { + "tokenAuth": [] + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScriptModule" + } + } + }, + "description": "" + } + } + } + }, "/api/extras/subscriptions/": { "get": { "operationId": "extras_subscriptions_list", @@ -228046,13 +228090,14 @@ "trunk-4c6p", "trunk-4c8p", "trunk-8c4p", + "breakout-1c2p-2c1p", "breakout-1c4p-4c1p", "breakout-1c6p-6c1p", "breakout-2c4p-8c1p-shuffle" ], "type": "string", - "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", - "x-spec-enum-id": "5e0f85310f0184ea" + "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", + "x-spec-enum-id": "f566e6df6572f5d0" }, "label": { "type": "string", @@ -228078,6 +228123,7 @@ "4C6P trunk", "4C8P trunk", "8C4P trunk", + "1C2P:2C1P breakout", "1C4P:4C1P breakout", "1C6P:6C1P breakout", "2C4P:8C1P breakout (shuffle)" @@ -228282,13 +228328,14 @@ "trunk-4c6p", "trunk-4c8p", "trunk-8c4p", + "breakout-1c2p-2c1p", "breakout-1c4p-4c1p", "breakout-1c6p-6c1p", "breakout-2c4p-8c1p-shuffle" ], "type": "string", - "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", - "x-spec-enum-id": "5e0f85310f0184ea" + "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", + "x-spec-enum-id": "f566e6df6572f5d0" }, "tenant": { "oneOf": [ @@ -254488,8 +254535,7 @@ "size": { "type": "integer", "maximum": 2147483647, - "minimum": 0, - "title": "Size (MB)" + "minimum": 0 }, "owner": { "oneOf": [ @@ -254774,14 +254820,15 @@ "trunk-4c6p", "trunk-4c8p", "trunk-8c4p", + "breakout-1c2p-2c1p", "breakout-1c4p-4c1p", "breakout-1c6p-6c1p", "breakout-2c4p-8c1p-shuffle", "" ], "type": "string", - "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", - "x-spec-enum-id": "5e0f85310f0184ea" + "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", + "x-spec-enum-id": "f566e6df6572f5d0" }, "tenant": { "oneOf": [ @@ -262819,15 +262866,13 @@ "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Memory (MB)" + "nullable": true }, "disk": { "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Disk (MB)" + "nullable": true }, "description": { "type": "string", @@ -270340,6 +270385,56 @@ "data" ] }, + "ScriptModule": { + "type": "object", + "description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)", + "properties": { + "id": { + "type": "integer", + "readOnly": true + }, + "display": { + "type": "string", + "readOnly": true + }, + "file_path": { + "type": "string", + "readOnly": true + }, + "created": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "last_updated": { + "type": "string", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "created", + "display", + "file_path", + "id", + "last_updated" + ] + }, + "ScriptModuleRequest": { + "type": "object", + "description": "Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during\nvalidation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)", + "properties": { + "file": { + "type": "string", + "format": "binary", + "writeOnly": true + } + }, + "required": [ + "file" + ] + }, "Service": { "type": "object", "description": "Base serializer class for models inheriting from PrimaryModel.", @@ -275384,8 +275479,7 @@ "size": { "type": "integer", "maximum": 2147483647, - "minimum": 0, - "title": "Size (MB)" + "minimum": 0 }, "owner": { "allOf": [ @@ -275456,8 +275550,7 @@ "size": { "type": "integer", "maximum": 2147483647, - "minimum": 0, - "title": "Size (MB)" + "minimum": 0 }, "owner": { "oneOf": [ @@ -275662,15 +275755,13 @@ "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Memory (MB)" + "nullable": true }, "disk": { "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Disk (MB)" + "nullable": true }, "description": { "type": "string", @@ -275926,15 +276017,13 @@ "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Memory (MB)" + "nullable": true }, "disk": { "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Disk (MB)" + "nullable": true }, "description": { "type": "string", @@ -277220,14 +277309,15 @@ "trunk-4c6p", "trunk-4c8p", "trunk-8c4p", + "breakout-1c2p-2c1p", "breakout-1c4p-4c1p", "breakout-1c6p-6c1p", "breakout-2c4p-8c1p-shuffle", "" ], "type": "string", - "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", - "x-spec-enum-id": "5e0f85310f0184ea" + "description": "* `single-1c1p` - 1C1P\n* `single-1c2p` - 1C2P\n* `single-1c4p` - 1C4P\n* `single-1c6p` - 1C6P\n* `single-1c8p` - 1C8P\n* `single-1c12p` - 1C12P\n* `single-1c16p` - 1C16P\n* `trunk-2c1p` - 2C1P trunk\n* `trunk-2c2p` - 2C2P trunk\n* `trunk-2c4p` - 2C4P trunk\n* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)\n* `trunk-2c6p` - 2C6P trunk\n* `trunk-2c8p` - 2C8P trunk\n* `trunk-2c12p` - 2C12P trunk\n* `trunk-4c1p` - 4C1P trunk\n* `trunk-4c2p` - 4C2P trunk\n* `trunk-4c4p` - 4C4P trunk\n* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)\n* `trunk-4c6p` - 4C6P trunk\n* `trunk-4c8p` - 4C8P trunk\n* `trunk-8c4p` - 8C4P trunk\n* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout\n* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout\n* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout\n* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)", + "x-spec-enum-id": "f566e6df6572f5d0" }, "tenant": { "oneOf": [ @@ -285520,15 +285610,13 @@ "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Memory (MB)" + "nullable": true }, "disk": { "type": "integer", "maximum": 2147483647, "minimum": 0, - "nullable": true, - "title": "Disk (MB)" + "nullable": true }, "description": { "type": "string", diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md index 048f72452..2f9e2a519 100644 --- a/docs/configuration/miscellaneous.md +++ b/docs/configuration/miscellaneous.md @@ -237,6 +237,14 @@ This parameter defines the URL of the repository that will be checked for new Ne --- +## RQ + +Default: `{}` (Empty) + +This is a wrapper for passing global configuration parameters to [Django RQ](https://github.com/rq/django-rq) to customize its behavior. It is employed within NetBox primarily to alter conditions during testing. + +--- + ## RQ_DEFAULT_TIMEOUT Default: `300` diff --git a/docs/configuration/system.md b/docs/configuration/system.md index 2505c5fde..9c40a41d8 100644 --- a/docs/configuration/system.md +++ b/docs/configuration/system.md @@ -248,21 +248,49 @@ STORAGES = { Within the `STORAGES` dictionary, `"default"` is used for image uploads, "staticfiles" is for static files and `"scripts"` is used for custom scripts. -If using a remote storage like S3, define the config as `STORAGES[key]["OPTIONS"]` for each storage item as needed. For example: +If using a remote storage such as S3 or an S3-compatible service, define the configuration as `STORAGES[key]["OPTIONS"]` for each storage item as needed. For example: ```python -STORAGES = { - "scripts": { - "BACKEND": "storages.backends.s3boto3.S3Boto3Storage", - "OPTIONS": { - 'access_key': 'access key', +STORAGES = { + 'default': { + 'BACKEND': 'storages.backends.s3.S3Storage', + 'OPTIONS': { + 'bucket_name': 'netbox', + 'access_key': 'access key', 'secret_key': 'secret key', - "allow_overwrite": True, - } - }, + 'region_name': 'us-east-1', + 'endpoint_url': 'https://s3.example.com', + 'location': 'media/', + }, + }, + 'staticfiles': { + 'BACKEND': 'storages.backends.s3.S3Storage', + 'OPTIONS': { + 'bucket_name': 'netbox', + 'access_key': 'access key', + 'secret_key': 'secret key', + 'region_name': 'us-east-1', + 'endpoint_url': 'https://s3.example.com', + 'location': 'static/', + }, + }, + 'scripts': { + 'BACKEND': 'storages.backends.s3.S3Storage', + 'OPTIONS': { + 'bucket_name': 'netbox', + 'access_key': 'access key', + 'secret_key': 'secret key', + 'region_name': 'us-east-1', + 'endpoint_url': 'https://s3.example.com', + 'location': 'scripts/', + 'file_overwrite': True, + }, + }, } ``` +`bucket_name` is required for `S3Storage`. When using an S3-compatible service, set `region_name` and `endpoint_url` according to your provider. + The specific configuration settings for each storage backend can be found in the [django-storages documentation](https://django-storages.readthedocs.io/en/latest/index.html). !!! note @@ -286,6 +314,7 @@ STORAGES = { 'bucket_name': os.environ.get('AWS_STORAGE_BUCKET_NAME'), 'access_key': os.environ.get('AWS_S3_ACCESS_KEY_ID'), 'secret_key': os.environ.get('AWS_S3_SECRET_ACCESS_KEY'), + 'region_name': os.environ.get('AWS_S3_REGION_NAME'), 'endpoint_url': os.environ.get('AWS_S3_ENDPOINT_URL'), 'location': 'media/', } @@ -296,6 +325,7 @@ STORAGES = { 'bucket_name': os.environ.get('AWS_STORAGE_BUCKET_NAME'), 'access_key': os.environ.get('AWS_S3_ACCESS_KEY_ID'), 'secret_key': os.environ.get('AWS_S3_SECRET_ACCESS_KEY'), + 'region_name': os.environ.get('AWS_S3_REGION_NAME'), 'endpoint_url': os.environ.get('AWS_S3_ENDPOINT_URL'), 'location': 'static/', } diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index add8fafb1..0947a2c94 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -384,6 +384,18 @@ A calendar date. Returns a `datetime.date` object. A complete date & time. Returns a `datetime.datetime` object. +## Uploading Scripts via the API + +Script modules can be uploaded to NetBox via the REST API by sending a `multipart/form-data` POST request to `/api/extras/scripts/upload/`. The caller must have the `extras.add_scriptmodule` and `core.add_managedfile` permissions. + +```no-highlight +curl -X POST \ +-H "Authorization: Token $TOKEN" \ +-H "Accept: application/json; indent=4" \ +-F "file=@/path/to/myscript.py" \ +http://netbox/api/extras/scripts/upload/ +``` + ## Running Custom Scripts !!! note diff --git a/docs/release-notes/version-4.5.md b/docs/release-notes/version-4.5.md index 2557d0806..c662053be 100644 --- a/docs/release-notes/version-4.5.md +++ b/docs/release-notes/version-4.5.md @@ -1,5 +1,31 @@ # NetBox v4.5 +## v4.5.7 (2026-04-03) + +### Enhancements + +* [#21095](https://github.com/netbox-community/netbox/issues/21095) - Adopt IEC unit labels (e.g. GiB) for virtual machine resources +* [#21696](https://github.com/netbox-community/netbox/issues/21696) - Add support for django-rq 4.0 and introduce `RQ` configuration parameter +* [#21701](https://github.com/netbox-community/netbox/issues/21701) - Support uploading custom scripts via the REST API (`/api/extras/scripts/upload/`) +* [#21760](https://github.com/netbox-community/netbox/issues/21760) - Add a 1C2P:2C1P breakout cable profile + +### Performance Improvements + +* [#21655](https://github.com/netbox-community/netbox/issues/21655) - Optimize queries for object and multi-object type custom fields + +### Bug Fixes + +* [#20474](https://github.com/netbox-community/netbox/issues/20474) - Fix installation of modules with placeholder values in component names +* [#21498](https://github.com/netbox-community/netbox/issues/21498) - Fix server error triggered by event rules referencing deleted objects +* [#21533](https://github.com/netbox-community/netbox/issues/21533) - Ensure read-only fields are included in REST API responses upon object creation +* [#21535](https://github.com/netbox-community/netbox/issues/21535) - Fix filtering of object-type custom fields when "is empty" is selected +* [#21784](https://github.com/netbox-community/netbox/issues/21784) - Fix `AttributeError` exception when sorting a table as an anonymous user +* [#21808](https://github.com/netbox-community/netbox/issues/21808) - Fix `RelatedObjectDoesNotExist` exception when viewing an interface with a virtual circuit termination +* [#21810](https://github.com/netbox-community/netbox/issues/21810) - Fix `AttributeError` exception when viewing virtual chassis member +* [#21825](https://github.com/netbox-community/netbox/issues/21825) - Fix sorting by broken columns in several object lists + +--- + ## v4.5.6 (2026-03-31) ### Enhancements diff --git a/netbox/circuits/migrations/0057_default_ordering_indexes.py b/netbox/circuits/migrations/0057_default_ordering_indexes.py index 256983f22..ce053c47b 100644 --- a/netbox/circuits/migrations/0057_default_ordering_indexes.py +++ b/netbox/circuits/migrations/0057_default_ordering_indexes.py @@ -5,7 +5,7 @@ class Migration(migrations.Migration): dependencies = [ ('circuits', '0056_gfk_indexes'), ('contenttypes', '0002_remove_content_type_name'), - ('dcim', '0230_interface_rf_channel_frequency_precision'), + ('dcim', '0231_interface_rf_channel_frequency_precision'), ('extras', '0136_customfield_validation_schema'), ('tenancy', '0023_add_mptt_tree_indexes'), ('users', '0015_owner'), diff --git a/netbox/circuits/tables/virtual_circuits.py b/netbox/circuits/tables/virtual_circuits.py index 43f03675b..84bbebf33 100644 --- a/netbox/circuits/tables/virtual_circuits.py +++ b/netbox/circuits/tables/virtual_circuits.py @@ -95,6 +95,7 @@ class VirtualCircuitTerminationTable(NetBoxTable): verbose_name=_('Provider network') ) provider_account = tables.Column( + accessor=tables.A('virtual_circuit__provider_account'), linkify=True, verbose_name=_('Account') ) @@ -112,7 +113,7 @@ class VirtualCircuitTerminationTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VirtualCircuitTermination fields = ( - 'pk', 'id', 'virtual_circuit', 'provider', 'provider_network', 'provider_account', 'role', 'interfaces', + 'pk', 'id', 'virtual_circuit', 'provider', 'provider_network', 'provider_account', 'role', 'interface', 'description', 'created', 'last_updated', 'actions', ) default_columns = ( diff --git a/netbox/circuits/tests/test_tables.py b/netbox/circuits/tests/test_tables.py index fd142f01b..29c104d03 100644 --- a/netbox/circuits/tests/test_tables.py +++ b/netbox/circuits/tests/test_tables.py @@ -1,48 +1,46 @@ -from django.test import RequestFactory, TestCase, tag - -from circuits.models import CircuitGroupAssignment, CircuitTermination -from circuits.tables import CircuitGroupAssignmentTable, CircuitTerminationTable +from circuits.tables import * +from utilities.testing import TableTestCases -@tag('regression') -class CircuitTerminationTableTest(TestCase): - def test_every_orderable_field_does_not_throw_exception(self): - terminations = CircuitTermination.objects.all() - disallowed = { - 'actions', - } - - orderable_columns = [ - column.name - for column in CircuitTerminationTable(terminations).columns - if column.orderable and column.name not in disallowed - ] - fake_request = RequestFactory().get('/') - - for col in orderable_columns: - for direction in ('-', ''): - table = CircuitTerminationTable(terminations) - table.order_by = f'{direction}{col}' - table.as_html(fake_request) +class CircuitTypeTableTest(TableTestCases.StandardTableTestCase): + table = CircuitTypeTable -@tag('regression') -class CircuitGroupAssignmentTableTest(TestCase): - def test_every_orderable_field_does_not_throw_exception(self): - assignment = CircuitGroupAssignment.objects.all() - disallowed = { - 'actions', - } +class CircuitTableTest(TableTestCases.StandardTableTestCase): + table = CircuitTable - orderable_columns = [ - column.name - for column in CircuitGroupAssignmentTable(assignment).columns - if column.orderable and column.name not in disallowed - ] - fake_request = RequestFactory().get('/') - for col in orderable_columns: - for direction in ('-', ''): - table = CircuitGroupAssignmentTable(assignment) - table.order_by = f'{direction}{col}' - table.as_html(fake_request) +class CircuitTerminationTableTest(TableTestCases.StandardTableTestCase): + table = CircuitTerminationTable + + +class CircuitGroupTableTest(TableTestCases.StandardTableTestCase): + table = CircuitGroupTable + + +class CircuitGroupAssignmentTableTest(TableTestCases.StandardTableTestCase): + table = CircuitGroupAssignmentTable + + +class ProviderTableTest(TableTestCases.StandardTableTestCase): + table = ProviderTable + + +class ProviderAccountTableTest(TableTestCases.StandardTableTestCase): + table = ProviderAccountTable + + +class ProviderNetworkTableTest(TableTestCases.StandardTableTestCase): + table = ProviderNetworkTable + + +class VirtualCircuitTypeTableTest(TableTestCases.StandardTableTestCase): + table = VirtualCircuitTypeTable + + +class VirtualCircuitTableTest(TableTestCases.StandardTableTestCase): + table = VirtualCircuitTable + + +class VirtualCircuitTerminationTableTest(TableTestCases.StandardTableTestCase): + table = VirtualCircuitTerminationTable diff --git a/netbox/circuits/tests/test_views.py b/netbox/circuits/tests/test_views.py index 6ced9a958..b3593b927 100644 --- a/netbox/circuits/tests/test_views.py +++ b/netbox/circuits/tests/test_views.py @@ -196,6 +196,20 @@ class CircuitTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'comments': 'New comments', } + def test_circuit_type_display_colored(self): + circuit_type = CircuitType.objects.first() + circuit_type.color = '12ab34' + circuit_type.save() + + circuit = Circuit.objects.first() + + self.add_permissions('circuits.view_circuit') + response = self.client.get(circuit.get_absolute_url()) + + self.assertHttpStatus(response, 200) + self.assertContains(response, circuit_type.name) + self.assertContains(response, 'background-color: #12ab34') + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*'], EXEMPT_EXCLUDE_MODELS=[]) def test_bulk_import_objects_with_terminations(self): site = Site.objects.first() diff --git a/netbox/circuits/ui/panels.py b/netbox/circuits/ui/panels.py index 7f86db88f..3572479cd 100644 --- a/netbox/circuits/ui/panels.py +++ b/netbox/circuits/ui/panels.py @@ -89,7 +89,7 @@ class CircuitPanel(panels.ObjectAttributesPanel): provider = attrs.RelatedObjectAttr('provider', linkify=True) provider_account = attrs.RelatedObjectAttr('provider_account', linkify=True) cid = attrs.TextAttr('cid', label=_('Circuit ID'), style='font-monospace', copy_button=True) - type = attrs.RelatedObjectAttr('type', linkify=True) + type = attrs.RelatedObjectAttr('type', linkify=True, colored=True) status = attrs.ChoiceAttr('status') distance = attrs.NumericAttr('distance', unit_accessor='get_distance_unit_display') tenant = attrs.RelatedObjectAttr('tenant', linkify=True, grouped_by='group') @@ -132,7 +132,7 @@ class VirtualCircuitPanel(panels.ObjectAttributesPanel): provider_network = attrs.RelatedObjectAttr('provider_network', linkify=True) provider_account = attrs.RelatedObjectAttr('provider_account', linkify=True) cid = attrs.TextAttr('cid', label=_('Circuit ID'), style='font-monospace', copy_button=True) - type = attrs.RelatedObjectAttr('type', linkify=True) + type = attrs.RelatedObjectAttr('type', linkify=True, colored=True) status = attrs.ChoiceAttr('status') tenant = attrs.RelatedObjectAttr('tenant', linkify=True, grouped_by='group') description = attrs.TextAttr('description') diff --git a/netbox/core/api/views.py b/netbox/core/api/views.py index bea332f1b..7d5e21f20 100644 --- a/netbox/core/api/views.py +++ b/netbox/core/api/views.py @@ -2,7 +2,7 @@ from django.http import Http404, HttpResponse from django.shortcuts import get_object_or_404 from django.utils.translation import gettext_lazy as _ from django_rq.queues import get_redis_connection -from django_rq.settings import QUEUES_LIST +from django_rq.settings import get_queues_list from django_rq.utils import get_statistics from drf_spectacular.types import OpenApiTypes from drf_spectacular.utils import OpenApiParameter, extend_schema @@ -195,7 +195,7 @@ class BackgroundWorkerViewSet(BaseRQViewSet): return 'Background Workers' def get_data(self): - config = QUEUES_LIST[0] + config = get_queues_list()[0] return Worker.all(get_redis_connection(config['connection_config'])) @extend_schema( @@ -205,7 +205,7 @@ class BackgroundWorkerViewSet(BaseRQViewSet): ) def retrieve(self, request, name): # all the RQ queues should use the same connection - config = QUEUES_LIST[0] + config = get_queues_list()[0] workers = Worker.all(get_redis_connection(config['connection_config'])) worker = next((item for item in workers if item.name == name), None) if not worker: @@ -229,7 +229,7 @@ class BackgroundTaskViewSet(BaseRQViewSet): return get_rq_jobs() def get_task_from_id(self, task_id): - config = QUEUES_LIST[0] + config = get_queues_list()[0] task = RQ_Job.fetch(task_id, connection=get_redis_connection(config['connection_config'])) if not task: raise Http404 diff --git a/netbox/core/tables/config.py b/netbox/core/tables/config.py index 018d89edf..0562f9199 100644 --- a/netbox/core/tables/config.py +++ b/netbox/core/tables/config.py @@ -19,6 +19,7 @@ REVISION_BUTTONS = """ class ConfigRevisionTable(NetBoxTable): is_active = columns.BooleanColumn( verbose_name=_('Is Active'), + accessor='active', false_mark=None ) actions = columns.ActionsColumn( diff --git a/netbox/core/tests/test_tables.py b/netbox/core/tests/test_tables.py new file mode 100644 index 000000000..ca28f1830 --- /dev/null +++ b/netbox/core/tests/test_tables.py @@ -0,0 +1,26 @@ +from core.models import ObjectChange +from core.tables import * +from utilities.testing import TableTestCases + + +class DataSourceTableTest(TableTestCases.StandardTableTestCase): + table = DataSourceTable + + +class DataFileTableTest(TableTestCases.StandardTableTestCase): + table = DataFileTable + + +class JobTableTest(TableTestCases.StandardTableTestCase): + table = JobTable + + +class ObjectChangeTableTest(TableTestCases.StandardTableTestCase): + table = ObjectChangeTable + queryset_sources = [ + ('ObjectChangeListView', ObjectChange.objects.all()), + ] + + +class ConfigRevisionTableTest(TableTestCases.StandardTableTestCase): + table = ConfigRevisionTable diff --git a/netbox/core/tests/test_views.py b/netbox/core/tests/test_views.py index f4254a299..82838a576 100644 --- a/netbox/core/tests/test_views.py +++ b/netbox/core/tests/test_views.py @@ -6,7 +6,7 @@ from datetime import datetime from django.urls import reverse from django.utils import timezone from django_rq import get_queue -from django_rq.settings import QUEUES_MAP +from django_rq.settings import get_queues_map from django_rq.workers import get_worker from rq.job import Job as RQ_Job from rq.job import JobStatus @@ -189,7 +189,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_list_default(self): queue = get_queue('default') queue.enqueue(self.dummy_job_default) - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] response = self.client.get(reverse('core:background_task_list', args=[queue_index, 'queued'])) self.assertEqual(response.status_code, 200) @@ -198,7 +198,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_list_high(self): queue = get_queue('high') queue.enqueue(self.dummy_job_high) - queue_index = QUEUES_MAP['high'] + queue_index = get_queues_map()['high'] response = self.client.get(reverse('core:background_task_list', args=[queue_index, 'queued'])) self.assertEqual(response.status_code, 200) @@ -207,7 +207,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_list_finished(self): queue = get_queue('default') job = queue.enqueue(self.dummy_job_default) - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] registry = FinishedJobRegistry(queue.name, queue.connection) registry.add(job, 2) @@ -218,7 +218,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_list_failed(self): queue = get_queue('default') job = queue.enqueue(self.dummy_job_default) - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] registry = FailedJobRegistry(queue.name, queue.connection) registry.add(job, 2) @@ -229,7 +229,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_scheduled(self): queue = get_queue('default') queue.enqueue_at(datetime.now(), self.dummy_job_default) - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] response = self.client.get(reverse('core:background_task_list', args=[queue_index, 'scheduled'])) self.assertEqual(response.status_code, 200) @@ -238,7 +238,7 @@ class BackgroundTaskTestCase(TestCase): def test_background_tasks_list_deferred(self): queue = get_queue('default') job = queue.enqueue(self.dummy_job_default) - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] registry = DeferredJobRegistry(queue.name, queue.connection) registry.add(job, 2) @@ -335,7 +335,7 @@ class BackgroundTaskTestCase(TestCase): worker2 = get_worker('high') worker2.register_birth() - queue_index = QUEUES_MAP['default'] + queue_index = get_queues_map()['default'] response = self.client.get(reverse('core:worker_list', args=[queue_index])) self.assertEqual(response.status_code, 200) self.assertIn(str(worker1.name), str(response.content)) diff --git a/netbox/core/utils.py b/netbox/core/utils.py index d5be09b49..1ef6e5136 100644 --- a/netbox/core/utils.py +++ b/netbox/core/utils.py @@ -1,7 +1,7 @@ from django.http import Http404 from django.utils.translation import gettext_lazy as _ from django_rq.queues import get_queue, get_queue_by_index, get_redis_connection -from django_rq.settings import QUEUES_LIST, QUEUES_MAP +from django_rq.settings import get_queues_list, get_queues_map from django_rq.utils import get_jobs, stop_jobs from rq import requeue_job from rq.exceptions import NoSuchJobError @@ -31,7 +31,7 @@ def get_rq_jobs(): """ jobs = set() - for queue in QUEUES_LIST: + for queue in get_queues_list(): queue = get_queue(queue['name']) jobs.update(queue.get_jobs()) @@ -78,13 +78,13 @@ def delete_rq_job(job_id): """ Delete the specified RQ job. """ - config = QUEUES_LIST[0] + config = get_queues_list()[0] try: job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),) except NoSuchJobError: raise Http404(_("Job {job_id} not found").format(job_id=job_id)) - queue_index = QUEUES_MAP[job.origin] + queue_index = get_queues_map()[job.origin] queue = get_queue_by_index(queue_index) # Remove job id from queue and delete the actual job @@ -96,13 +96,13 @@ def requeue_rq_job(job_id): """ Requeue the specified RQ job. """ - config = QUEUES_LIST[0] + config = get_queues_list()[0] try: job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),) except NoSuchJobError: raise Http404(_("Job {id} not found.").format(id=job_id)) - queue_index = QUEUES_MAP[job.origin] + queue_index = get_queues_map()[job.origin] queue = get_queue_by_index(queue_index) requeue_job(job_id, connection=queue.connection, serializer=queue.serializer) @@ -112,13 +112,13 @@ def enqueue_rq_job(job_id): """ Enqueue the specified RQ job. """ - config = QUEUES_LIST[0] + config = get_queues_list()[0] try: job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),) except NoSuchJobError: raise Http404(_("Job {id} not found.").format(id=job_id)) - queue_index = QUEUES_MAP[job.origin] + queue_index = get_queues_map()[job.origin] queue = get_queue_by_index(queue_index) try: @@ -144,13 +144,13 @@ def stop_rq_job(job_id): """ Stop the specified RQ job. """ - config = QUEUES_LIST[0] + config = get_queues_list()[0] try: job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),) except NoSuchJobError: raise Http404(_("Job {job_id} not found").format(job_id=job_id)) - queue_index = QUEUES_MAP[job.origin] + queue_index = get_queues_map()[job.origin] queue = get_queue_by_index(queue_index) return stop_jobs(queue, job_id)[0] diff --git a/netbox/core/views.py b/netbox/core/views.py index 006fdc03c..5f80975d9 100644 --- a/netbox/core/views.py +++ b/netbox/core/views.py @@ -14,7 +14,7 @@ from django.urls import reverse from django.utils.translation import gettext_lazy as _ from django.views.generic import View from django_rq.queues import get_connection, get_queue_by_index, get_redis_connection -from django_rq.settings import QUEUES_LIST, QUEUES_MAP +from django_rq.settings import get_queues_list, get_queues_map from django_rq.utils import get_statistics from rq.exceptions import NoSuchJobError from rq.job import Job as RQ_Job @@ -528,13 +528,13 @@ class BackgroundTaskView(BaseRQView): def get(self, request, job_id): # all the RQ queues should use the same connection - config = QUEUES_LIST[0] + config = get_queues_list()[0] try: job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),) except NoSuchJobError: raise Http404(_("Job {job_id} not found").format(job_id=job_id)) - queue_index = QUEUES_MAP[job.origin] + queue_index = get_queues_map()[job.origin] queue = get_queue_by_index(queue_index) try: @@ -644,7 +644,7 @@ class WorkerView(BaseRQView): def get(self, request, key): # all the RQ queues should use the same connection - config = QUEUES_LIST[0] + config = get_queues_list()[0] worker = Worker.find_by_key('rq:worker:' + key, connection=get_redis_connection(config['connection_config'])) # Convert microseconds to milliseconds worker.total_working_time = worker.total_working_time / 1000 diff --git a/netbox/dcim/api/serializers_/base.py b/netbox/dcim/api/serializers_/base.py index c60454937..9120ec109 100644 --- a/netbox/dcim/api/serializers_/base.py +++ b/netbox/dcim/api/serializers_/base.py @@ -38,7 +38,15 @@ class ConnectedEndpointsSerializer(serializers.ModelSerializer): @extend_schema_field(serializers.BooleanField) def get_connected_endpoints_reachable(self, obj): - return obj._path and obj._path.is_complete and obj._path.is_active + """ + Return whether the connected endpoints are reachable via a complete, active cable path. + """ + # Use the public `path` accessor rather than dereferencing `_path` + # directly. `path` already handles the stale in-memory relation case + # that can occur while CablePath rows are rebuilt during cable edits. + if path := obj.path: + return path.is_complete and path.is_active + return False class PortSerializer(serializers.ModelSerializer): diff --git a/netbox/dcim/cable_profiles.py b/netbox/dcim/cable_profiles.py index 8d5e787a3..8945370f2 100644 --- a/netbox/dcim/cable_profiles.py +++ b/netbox/dcim/cable_profiles.py @@ -254,6 +254,21 @@ class Trunk8C4PCableProfile(BaseCableProfile): b_connectors = a_connectors +class Breakout1C2Px2C1PCableProfile(BaseCableProfile): + a_connectors = { + 1: 2, + } + b_connectors = { + 1: 1, + 2: 1, + } + _mapping = { + (1, 1): (1, 1), + (1, 2): (2, 1), + (2, 1): (1, 2), + } + + class Breakout1C4Px4C1PCableProfile(BaseCableProfile): a_connectors = { 1: 4, diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 5aedd3031..514d4aedf 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1776,6 +1776,7 @@ class CableProfileChoices(ChoiceSet): TRUNK_4C8P = 'trunk-4c8p' TRUNK_8C4P = 'trunk-8c4p' # Breakouts + BREAKOUT_1C2P_2C1P = 'breakout-1c2p-2c1p' BREAKOUT_1C4P_4C1P = 'breakout-1c4p-4c1p' BREAKOUT_1C6P_6C1P = 'breakout-1c6p-6c1p' BREAKOUT_2C4P_8C1P_SHUFFLE = 'breakout-2c4p-8c1p-shuffle' @@ -1815,6 +1816,7 @@ class CableProfileChoices(ChoiceSet): ( _('Breakout'), ( + (BREAKOUT_1C2P_2C1P, _('1C2P:2C1P breakout')), (BREAKOUT_1C4P_4C1P, _('1C4P:4C1P breakout')), (BREAKOUT_1C6P_6C1P, _('1C6P:6C1P breakout')), (BREAKOUT_2C4P_8C1P_SHUFFLE, _('2C4P:8C1P breakout (shuffle)')), diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 4f840b988..d247f0d6d 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -27,6 +27,7 @@ from tenancy.models import * from users.filterset_mixins import OwnerFilterMixin from users.models import User from utilities.filters import ( + MultiValueBigNumberFilter, MultiValueCharFilter, MultiValueContentTypeFilter, MultiValueMACAddressFilter, @@ -2230,7 +2231,7 @@ class InterfaceFilterSet( distinct=False, label=_('LAG interface (ID)'), ) - speed = MultiValueNumberFilter() + speed = MultiValueBigNumberFilter(min_value=0) duplex = django_filters.MultipleChoiceFilter( choices=InterfaceDuplexChoices, distinct=False, diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 6dfa4884e..d15ef34e1 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -20,7 +20,13 @@ from netbox.forms.mixins import ChangelogMessageMixin, OwnerMixin from tenancy.models import Tenant from users.models import User from utilities.forms import BulkEditForm, add_blank_choice, form_from_model -from utilities.forms.fields import ColorField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, JSONField +from utilities.forms.fields import ( + ColorField, + DynamicModelChoiceField, + DynamicModelMultipleChoiceField, + JSONField, + PositiveBigIntegerField, +) from utilities.forms.rendering import FieldSet, InlineFields, TabbedGroups from utilities.forms.widgets import BulkEditNullBooleanSelect, NumberWithOptions from virtualization.models import Cluster @@ -1470,7 +1476,7 @@ class InterfaceBulkEditForm( 'device_id': '$device', } ) - speed = forms.IntegerField( + speed = PositiveBigIntegerField( label=_('Speed'), required=False, widget=NumberWithOptions( diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index d877250b8..f5bf31668 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -19,7 +19,7 @@ from tenancy.forms import ContactModelFilterForm, TenancyFilterForm from tenancy.models import Tenant from users.models import User from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, FilterForm, add_blank_choice -from utilities.forms.fields import ColorField, DynamicModelMultipleChoiceField, TagFilterField +from utilities.forms.fields import ColorField, DynamicModelMultipleChoiceField, PositiveBigIntegerField, TagFilterField from utilities.forms.rendering import FieldSet from utilities.forms.widgets import NumberWithOptions from virtualization.models import Cluster, ClusterGroup, VirtualMachine @@ -1652,7 +1652,7 @@ class InterfaceFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm): choices=InterfaceTypeChoices, required=False ) - speed = forms.IntegerField( + speed = PositiveBigIntegerField( label=_('Speed'), required=False, widget=NumberWithOptions( diff --git a/netbox/dcim/graphql/filters.py b/netbox/dcim/graphql/filters.py index 041f5fab3..02fb3ef64 100644 --- a/netbox/dcim/graphql/filters.py +++ b/netbox/dcim/graphql/filters.py @@ -47,7 +47,13 @@ if TYPE_CHECKING: VRFFilter, ) from netbox.graphql.enums import ColorEnum - from netbox.graphql.filter_lookups import FloatLookup, IntegerArrayLookup, IntegerLookup, TreeNodeFilter + from netbox.graphql.filter_lookups import ( + BigIntegerLookup, + FloatLookup, + IntegerArrayLookup, + IntegerLookup, + TreeNodeFilter, + ) from users.graphql.filters import UserFilter from virtualization.graphql.filters import ClusterFilter from vpn.graphql.filters import L2VPNFilter, TunnelTerminationFilter @@ -527,7 +533,7 @@ class InterfaceFilter( strawberry_django.filter_field() ) mgmt_only: FilterLookup[bool] | None = strawberry_django.filter_field() - speed: Annotated['IntegerLookup', strawberry.lazy('netbox.graphql.filter_lookups')] | None = ( + speed: Annotated['BigIntegerLookup', strawberry.lazy('netbox.graphql.filter_lookups')] | None = ( strawberry_django.filter_field() ) duplex: BaseFilterLookup[Annotated['InterfaceDuplexEnum', strawberry.lazy('dcim.graphql.enums')]] | None = ( diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index 539ba46eb..6cbab28f2 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -447,6 +447,7 @@ class MACAddressType(PrimaryObjectType): ) class InterfaceType(IPAddressesMixin, ModularComponentType, CabledObjectMixin, PathEndpointMixin): _name: str + speed: BigInt | None wwn: str | None parent: Annotated["InterfaceType", strawberry.lazy('dcim.graphql.types')] | None bridge: Annotated["InterfaceType", strawberry.lazy('dcim.graphql.types')] | None diff --git a/netbox/dcim/migrations/0227_alter_interface_speed_bigint.py b/netbox/dcim/migrations/0227_alter_interface_speed_bigint.py new file mode 100644 index 000000000..c9c657a6b --- /dev/null +++ b/netbox/dcim/migrations/0227_alter_interface_speed_bigint.py @@ -0,0 +1,15 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ('dcim', '0226_modulebay_rebuild_tree'), + ] + + operations = [ + migrations.AlterField( + model_name='interface', + name='speed', + field=models.PositiveBigIntegerField(blank=True, null=True), + ), + ] diff --git a/netbox/dcim/migrations/0227_rack_group.py b/netbox/dcim/migrations/0228_rack_group.py similarity index 97% rename from netbox/dcim/migrations/0227_rack_group.py rename to netbox/dcim/migrations/0228_rack_group.py index 8563b6c07..160961847 100644 --- a/netbox/dcim/migrations/0227_rack_group.py +++ b/netbox/dcim/migrations/0228_rack_group.py @@ -8,7 +8,7 @@ import utilities.json class Migration(migrations.Migration): dependencies = [ - ('dcim', '0226_modulebay_rebuild_tree'), + ('dcim', '0227_alter_interface_speed_bigint'), ('extras', '0134_owner'), ('users', '0015_owner'), ] diff --git a/netbox/dcim/migrations/0228_cable_bundle.py b/netbox/dcim/migrations/0229_cable_bundle.py similarity index 98% rename from netbox/dcim/migrations/0228_cable_bundle.py rename to netbox/dcim/migrations/0229_cable_bundle.py index 18c3a67f4..b2c555005 100644 --- a/netbox/dcim/migrations/0228_cable_bundle.py +++ b/netbox/dcim/migrations/0229_cable_bundle.py @@ -9,7 +9,7 @@ import utilities.json class Migration(migrations.Migration): dependencies = [ - ('dcim', '0227_rack_group'), + ('dcim', '0228_rack_group'), ('extras', '0134_owner'), ('users', '0015_owner'), ] diff --git a/netbox/dcim/migrations/0229_devicebay_modulebay_enabled.py b/netbox/dcim/migrations/0230_devicebay_modulebay_enabled.py similarity index 95% rename from netbox/dcim/migrations/0229_devicebay_modulebay_enabled.py rename to netbox/dcim/migrations/0230_devicebay_modulebay_enabled.py index 16083708a..494b5d999 100644 --- a/netbox/dcim/migrations/0229_devicebay_modulebay_enabled.py +++ b/netbox/dcim/migrations/0230_devicebay_modulebay_enabled.py @@ -3,7 +3,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ - ('dcim', '0228_cable_bundle'), + ('dcim', '0229_cable_bundle'), ] operations = [ diff --git a/netbox/dcim/migrations/0230_interface_rf_channel_frequency_precision.py b/netbox/dcim/migrations/0231_interface_rf_channel_frequency_precision.py similarity index 91% rename from netbox/dcim/migrations/0230_interface_rf_channel_frequency_precision.py rename to netbox/dcim/migrations/0231_interface_rf_channel_frequency_precision.py index b7ac25ff7..1d7574961 100644 --- a/netbox/dcim/migrations/0230_interface_rf_channel_frequency_precision.py +++ b/netbox/dcim/migrations/0231_interface_rf_channel_frequency_precision.py @@ -4,7 +4,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ - ('dcim', '0229_devicebay_modulebay_enabled'), + ('dcim', '0230_devicebay_modulebay_enabled'), ] operations = [ diff --git a/netbox/dcim/migrations/0231_default_ordering_indexes.py b/netbox/dcim/migrations/0232_default_ordering_indexes.py similarity index 98% rename from netbox/dcim/migrations/0231_default_ordering_indexes.py rename to netbox/dcim/migrations/0232_default_ordering_indexes.py index 71d0953a0..da70f6e67 100644 --- a/netbox/dcim/migrations/0231_default_ordering_indexes.py +++ b/netbox/dcim/migrations/0232_default_ordering_indexes.py @@ -5,7 +5,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ ('contenttypes', '0002_remove_content_type_name'), - ('dcim', '0230_interface_rf_channel_frequency_precision'), + ('dcim', '0231_interface_rf_channel_frequency_precision'), ('extras', '0136_customfield_validation_schema'), ('ipam', '0088_rename_vlangroup_total_vlan_ids'), ('tenancy', '0023_add_mptt_tree_indexes'), diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 39182b4f7..4b7a30852 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -196,6 +196,7 @@ class Cable(PrimaryModel): CableProfileChoices.TRUNK_4C6P: cable_profiles.Trunk4C6PCableProfile, CableProfileChoices.TRUNK_4C8P: cable_profiles.Trunk4C8PCableProfile, CableProfileChoices.TRUNK_8C4P: cable_profiles.Trunk8C4PCableProfile, + CableProfileChoices.BREAKOUT_1C2P_2C1P: cable_profiles.Breakout1C2Px2C1PCableProfile, CableProfileChoices.BREAKOUT_1C4P_4C1P: cable_profiles.Breakout1C4Px4C1PCableProfile, CableProfileChoices.BREAKOUT_1C6P_6C1P: cable_profiles.Breakout1C6Px6C1PCableProfile, CableProfileChoices.BREAKOUT_2C4P_8C1P_SHUFFLE: cable_profiles.Breakout2C4Px8C1PShuffleCableProfile, diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 9bf8db979..dec8758a9 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -584,6 +584,14 @@ class PortTemplateMapping(PortMappingBase): self.module_type = self.front_port.module_type super().save(*args, **kwargs) + def to_yaml(self): + return { + 'front_port': self.front_port.name, + 'front_port_position': self.front_port_position, + 'rear_port': self.rear_port.name, + 'rear_port_position': self.rear_port_position, + } + class FrontPortTemplate(ModularComponentTemplateModel): """ diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index d543d5bbd..1f12e0361 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -2,7 +2,7 @@ from functools import cached_property from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation from django.contrib.postgres.fields import ArrayField -from django.core.exceptions import ValidationError +from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from django.db.models import Sum @@ -307,11 +307,12 @@ class PathEndpoint(models.Model): `connected_endpoints()` is a convenience method for returning the destination of the associated CablePath, if any. """ + _path = models.ForeignKey( to='dcim.CablePath', on_delete=models.SET_NULL, null=True, - blank=True + blank=True, ) class Meta: @@ -323,11 +324,14 @@ class PathEndpoint(models.Model): # Construct the complete path (including e.g. bridged interfaces) while origin is not None: - - if origin._path is None: + # Go through the public accessor rather than dereferencing `_path` + # directly. During cable edits, CablePath rows can be deleted and + # recreated while this endpoint instance is still in memory. + cable_path = origin.path + if cable_path is None: break - path.extend(origin._path.path_objects) + path.extend(cable_path.path_objects) # If the path ends at a non-connected pass-through port, pad out the link and far-end terminations if len(path) % 3 == 1: @@ -336,8 +340,8 @@ class PathEndpoint(models.Model): elif len(path) % 3 == 2: path.insert(-1, []) - # Check for a bridged relationship to continue the trace - destinations = origin._path.destinations + # Check for a bridged relationship to continue the trace. + destinations = cable_path.destinations if len(destinations) == 1: origin = getattr(destinations[0], 'bridge', None) else: @@ -348,14 +352,42 @@ class PathEndpoint(models.Model): @property def path(self): - return self._path + """ + Return this endpoint's current CablePath, if any. + + `_path` is a denormalized reference that is updated from CablePath + save/delete handlers, including queryset.update() calls on origin + endpoints. That means an already-instantiated endpoint can briefly hold + a stale in-memory `_path` relation while the database already points to + a different CablePath (or to no path at all). + + If the cached relation points to a CablePath that has just been + deleted, refresh only the `_path` field from the database and retry. + This keeps the fix cheap and narrowly scoped to the denormalized FK. + """ + if self._path_id is None: + return None + + try: + return self._path + except ObjectDoesNotExist: + # Refresh only the denormalized FK instead of the whole model. + # The expected problem here is in-memory staleness during path + # rebuilds, not persistent database corruption. + self.refresh_from_db(fields=['_path']) + return self._path if self._path_id else None @cached_property def connected_endpoints(self): """ - Caching accessor for the attached CablePath's destination (if any) + Caching accessor for the attached CablePath's destinations (if any). + + Always route through `path` so stale in-memory `_path` references are + repaired before we cache the result for the lifetime of this instance. """ - return self._path.destinations if self._path else [] + if cable_path := self.path: + return cable_path.destinations + return [] # @@ -774,7 +806,7 @@ class Interface( verbose_name=_('management only'), help_text=_('This interface is used only for out-of-band management') ) - speed = models.PositiveIntegerField( + speed = models.PositiveBigIntegerField( blank=True, null=True, verbose_name=_('speed (Kbps)') diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index db9805600..53cde6471 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -276,6 +276,15 @@ class DeviceType(ImageAttachmentsMixin, PrimaryModel, WeightMixin): data['rear-ports'] = [ c.to_yaml() for c in self.rearporttemplates.all() ] + + # Port mappings + port_mapping_data = [ + c.to_yaml() for c in self.port_mappings.all() + ] + + if port_mapping_data: + data['port-mappings'] = port_mapping_data + if self.modulebaytemplates.exists(): data['module-bays'] = [ c.to_yaml() for c in self.modulebaytemplates.all() diff --git a/netbox/dcim/models/modules.py b/netbox/dcim/models/modules.py index 24394c45d..1d678deb0 100644 --- a/netbox/dcim/models/modules.py +++ b/netbox/dcim/models/modules.py @@ -195,6 +195,14 @@ class ModuleType(ImageAttachmentsMixin, PrimaryModel, WeightMixin): c.to_yaml() for c in self.rearporttemplates.all() ] + # Port mappings + port_mapping_data = [ + c.to_yaml() for c in self.port_mappings.all() + ] + + if port_mapping_data: + data['port-mappings'] = port_mapping_data + return yaml.dump(dict(data), sort_keys=False) diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 4f4aa3cc4..e824f2683 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -382,6 +382,17 @@ class PathEndpointTable(CableTerminationTable): orderable=False ) + def value_connection(self, value): + if value: + connections = [] + for termination in value: + if hasattr(termination, 'parent_object'): + connections.append(f'{termination.parent_object} > {termination}') + else: + connections.append(str(termination)) + return ', '.join(connections) + return None + class ConsolePortTable(ModularDeviceComponentTable, PathEndpointTable): device = tables.Column( @@ -683,6 +694,15 @@ class InterfaceTable(BaseInterfaceTable, ModularDeviceComponentTable, PathEndpoi orderable=False ) + def value_connection(self, record, value): + if record.is_virtual and hasattr(record, 'virtual_circuit_termination') and record.virtual_circuit_termination: + connections = [ + f"{t.interface.parent_object} > {t.interface} via {t.parent_object}" + for t in record.connected_endpoints + ] + return ', '.join(connections) + return super().value_connection(value) + class Meta(DeviceComponentTable.Meta): model = models.Interface fields = ( @@ -1161,7 +1181,7 @@ class VirtualDeviceContextTable(TenancyColumnsMixin, PrimaryModelTable): ) device = tables.Column( verbose_name=_('Device'), - order_by=('device___name',), + order_by=('device__name',), linkify=True ) status = columns.ChoiceFieldColumn( diff --git a/netbox/dcim/tables/modules.py b/netbox/dcim/tables/modules.py index 8e857072c..948c7a664 100644 --- a/netbox/dcim/tables/modules.py +++ b/netbox/dcim/tables/modules.py @@ -56,7 +56,9 @@ class ModuleTypeTable(PrimaryModelTable): template_code=WEIGHT, order_by=('_abs_weight', 'weight_unit') ) - attributes = columns.DictColumn() + attributes = columns.DictColumn( + orderable=False, + ) module_count = columns.LinkedCountColumn( viewname='dcim:module_list', url_params={'module_type_id': 'pk'}, diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 0c59cf31a..1ae90ca8e 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -2431,9 +2431,9 @@ class InterfaceTest(Mixins.ComponentTraceMixin, APIViewTestCases.APIViewTestCase { 'device': device.pk, 'name': 'Interface 4', - 'type': '1000base-t', + 'type': 'other', 'mode': InterfaceModeChoices.MODE_TAGGED, - 'speed': 1000000, + 'speed': 16_000_000_000, 'duplex': 'full', 'vrf': vrfs[0].pk, 'poe_mode': InterfacePoEModeChoices.MODE_PD, diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 4f3212a75..1236d5950 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -4753,7 +4753,7 @@ class InterfaceTestCase(TestCase, DeviceComponentFilterSetTests, ChangeLoggedFil enabled=True, mgmt_only=True, tx_power=40, - speed=100000, + speed=16_000_000_000, duplex='full', poe_mode=InterfacePoEModeChoices.MODE_PD, poe_type=InterfacePoETypeChoices.TYPE_2_8023AT, @@ -4855,7 +4855,7 @@ class InterfaceTestCase(TestCase, DeviceComponentFilterSetTests, ChangeLoggedFil self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_speed(self): - params = {'speed': [1000000, 100000]} + params = {'speed': [16_000_000_000, 1_000_000, 100_000]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) def test_duplex(self): diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index bfdaa5efe..ad589c53a 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -5,6 +5,7 @@ from circuits.models import * from core.models import ObjectType from dcim.choices import * from dcim.models import * +from extras.events import serialize_for_event from extras.models import CustomField from ipam.models import Prefix from netbox.choices import WeightUnitChoices @@ -1666,6 +1667,65 @@ class CableTestCase(TestCase): self.assertEqual(a_terms, [interface1]) self.assertEqual(b_terms, [interface2]) + @tag('regression') # #21498 + def test_path_refreshes_replaced_cablepath_reference(self): + """ + An already-instantiated interface should refresh its denormalized + `_path` foreign key when the referenced CablePath row has been + replaced in the database. + """ + stale_interface = Interface.objects.get(device__name='TestDevice1', name='eth0') + old_path = CablePath.objects.get(pk=stale_interface._path_id) + + new_path = CablePath( + path=old_path.path, + is_active=old_path.is_active, + is_complete=old_path.is_complete, + is_split=old_path.is_split, + ) + old_path_id = old_path.pk + old_path.delete() + new_path.save() + + # The old CablePath no longer exists + self.assertFalse(CablePath.objects.filter(pk=old_path_id).exists()) + + # The already-instantiated interface still points to the deleted path + # until the accessor refreshes `_path` from the database. + self.assertEqual(stale_interface._path_id, old_path_id) + self.assertEqual(stale_interface.path.pk, new_path.pk) + + @tag('regression') # #21498 + def test_serialize_for_event_handles_stale_cablepath_reference_after_retermination(self): + """ + Serializing an interface whose previously cached `_path` row has been + deleted during cable retermination must not raise. + """ + stale_interface = Interface.objects.get(device__name='TestDevice2', name='eth0') + old_path_id = stale_interface._path_id + new_peer = Interface.objects.get(device__name='TestDevice2', name='eth1') + cable = stale_interface.cable + + self.assertIsNotNone(cable) + self.assertIsNotNone(old_path_id) + self.assertEqual(stale_interface.cable_end, 'B') + + cable.b_terminations = [new_peer] + cable.save() + + # The old CablePath was deleted during retrace. + self.assertFalse(CablePath.objects.filter(pk=old_path_id).exists()) + + # The stale in-memory instance still holds the deleted FK value. + self.assertEqual(stale_interface._path_id, old_path_id) + + # Serialization must not raise ObjectDoesNotExist. Because this interface + # was the former B-side termination, it is now disconnected. + data = serialize_for_event(stale_interface) + self.assertIsNone(data['connected_endpoints']) + self.assertIsNone(data['connected_endpoints_type']) + self.assertFalse(data['connected_endpoints_reachable']) + class VirtualDeviceContextTestCase(TestCase): diff --git a/netbox/dcim/tests/test_tables.py b/netbox/dcim/tests/test_tables.py new file mode 100644 index 000000000..debd8256f --- /dev/null +++ b/netbox/dcim/tests/test_tables.py @@ -0,0 +1,204 @@ +from dcim.models import ConsolePort, Interface, PowerPort +from dcim.tables import * +from utilities.testing import TableTestCases + +# +# Sites +# + + +class RegionTableTest(TableTestCases.StandardTableTestCase): + table = RegionTable + + +class SiteGroupTableTest(TableTestCases.StandardTableTestCase): + table = SiteGroupTable + + +class SiteTableTest(TableTestCases.StandardTableTestCase): + table = SiteTable + + +class LocationTableTest(TableTestCases.StandardTableTestCase): + table = LocationTable + + +# +# Racks +# + +class RackRoleTableTest(TableTestCases.StandardTableTestCase): + table = RackRoleTable + + +class RackTypeTableTest(TableTestCases.StandardTableTestCase): + table = RackTypeTable + + +class RackTableTest(TableTestCases.StandardTableTestCase): + table = RackTable + + +class RackReservationTableTest(TableTestCases.StandardTableTestCase): + table = RackReservationTable + + +# +# Device types +# + +class ManufacturerTableTest(TableTestCases.StandardTableTestCase): + table = ManufacturerTable + + +class DeviceTypeTableTest(TableTestCases.StandardTableTestCase): + table = DeviceTypeTable + + +# +# Module types +# + +class ModuleTypeProfileTableTest(TableTestCases.StandardTableTestCase): + table = ModuleTypeProfileTable + + +class ModuleTypeTableTest(TableTestCases.StandardTableTestCase): + table = ModuleTypeTable + + +class ModuleTableTest(TableTestCases.StandardTableTestCase): + table = ModuleTable + + +# +# Devices +# + +class DeviceRoleTableTest(TableTestCases.StandardTableTestCase): + table = DeviceRoleTable + + +class PlatformTableTest(TableTestCases.StandardTableTestCase): + table = PlatformTable + + +class DeviceTableTest(TableTestCases.StandardTableTestCase): + table = DeviceTable + + +# +# Device components +# + +class ConsolePortTableTest(TableTestCases.StandardTableTestCase): + table = ConsolePortTable + + +class ConsoleServerPortTableTest(TableTestCases.StandardTableTestCase): + table = ConsoleServerPortTable + + +class PowerPortTableTest(TableTestCases.StandardTableTestCase): + table = PowerPortTable + + +class PowerOutletTableTest(TableTestCases.StandardTableTestCase): + table = PowerOutletTable + + +class InterfaceTableTest(TableTestCases.StandardTableTestCase): + table = InterfaceTable + + +class FrontPortTableTest(TableTestCases.StandardTableTestCase): + table = FrontPortTable + + +class RearPortTableTest(TableTestCases.StandardTableTestCase): + table = RearPortTable + + +class ModuleBayTableTest(TableTestCases.StandardTableTestCase): + table = ModuleBayTable + + +class DeviceBayTableTest(TableTestCases.StandardTableTestCase): + table = DeviceBayTable + + +class InventoryItemTableTest(TableTestCases.StandardTableTestCase): + table = InventoryItemTable + + +class InventoryItemRoleTableTest(TableTestCases.StandardTableTestCase): + table = InventoryItemRoleTable + + +# +# Connections +# + +class ConsoleConnectionTableTest(TableTestCases.StandardTableTestCase): + table = ConsoleConnectionTable + queryset_sources = [ + ('ConsoleConnectionsListView', ConsolePort.objects.filter(_path__is_complete=True)), + ] + + +class PowerConnectionTableTest(TableTestCases.StandardTableTestCase): + table = PowerConnectionTable + queryset_sources = [ + ('PowerConnectionsListView', PowerPort.objects.filter(_path__is_complete=True)), + ] + + +class InterfaceConnectionTableTest(TableTestCases.StandardTableTestCase): + table = InterfaceConnectionTable + queryset_sources = [ + ('InterfaceConnectionsListView', Interface.objects.filter(_path__is_complete=True)), + ] + + +# +# Cables +# + +class CableTableTest(TableTestCases.StandardTableTestCase): + table = CableTable + + +# +# Power +# + +class PowerPanelTableTest(TableTestCases.StandardTableTestCase): + table = PowerPanelTable + + +class PowerFeedTableTest(TableTestCases.StandardTableTestCase): + table = PowerFeedTable + + +# +# Virtual chassis +# + +class VirtualChassisTableTest(TableTestCases.StandardTableTestCase): + table = VirtualChassisTable + + +# +# Virtual device contexts +# + +class VirtualDeviceContextTableTest(TableTestCases.StandardTableTestCase): + table = VirtualDeviceContextTable + + +# +# MAC addresses +# + +class MACAddressTableTest(TableTestCases.StandardTableTestCase): + table = MACAddressTable diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index 6aeac74d7..2405893f7 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -2413,6 +2413,23 @@ class DeviceTestCase(ViewTestCases.PrimaryObjectViewTestCase): self.remove_permissions('dcim.view_device') self.assertHttpStatus(self.client.get(url), 403) + def test_device_role_display_colored(self): + parent_role = DeviceRole.objects.create(name='Parent Role', slug='parent-role', color='111111') + child_role = DeviceRole.objects.create(name='Child Role', slug='child-role', parent=parent_role, color='aa00bb') + + device = Device.objects.first() + device.role = child_role + device.save() + + self.add_permissions('dcim.view_device') + response = self.client.get(device.get_absolute_url()) + + self.assertHttpStatus(response, 200) + self.assertContains(response, 'Parent Role') + self.assertContains(response, 'Child Role') + self.assertContains(response, 'background-color: #aa00bb') + self.assertNotContains(response, 'background-color: #111111') + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) def test_bulk_import_duplicate_ids_error_message(self): device = Device.objects.first() @@ -3056,13 +3073,13 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): cls.form_data = { 'device': device.pk, 'name': 'Interface X', - 'type': InterfaceTypeChoices.TYPE_1GE_GBIC, + 'type': InterfaceTypeChoices.TYPE_OTHER, 'enabled': False, 'bridge': interfaces[4].pk, 'lag': interfaces[3].pk, 'wwn': EUI('01:02:03:04:05:06:07:08', version=64), 'mtu': 65000, - 'speed': 1000000, + 'speed': 16_000_000_000, 'duplex': 'full', 'mgmt_only': True, 'description': 'A front port', @@ -3080,13 +3097,13 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): cls.bulk_create_data = { 'device': device.pk, 'name': 'Interface [4-6]', - 'type': InterfaceTypeChoices.TYPE_1GE_GBIC, + 'type': InterfaceTypeChoices.TYPE_OTHER, 'enabled': False, 'bridge': interfaces[4].pk, 'lag': interfaces[3].pk, 'wwn': EUI('01:02:03:04:05:06:07:08', version=64), 'mtu': 2000, - 'speed': 100000, + 'speed': 16_000_000_000, 'duplex': 'half', 'mgmt_only': True, 'description': 'A front port', diff --git a/netbox/dcim/ui/panels.py b/netbox/dcim/ui/panels.py index 217a6b68f..29d0a1ed3 100644 --- a/netbox/dcim/ui/panels.py +++ b/netbox/dcim/ui/panels.py @@ -50,7 +50,7 @@ class RackPanel(panels.ObjectAttributesPanel): tenant = attrs.RelatedObjectAttr('tenant', linkify=True, grouped_by='group') status = attrs.ChoiceAttr('status') rack_type = attrs.RelatedObjectAttr('rack_type', linkify=True, grouped_by='manufacturer') - role = attrs.RelatedObjectAttr('role', linkify=True) + role = attrs.RelatedObjectAttr('role', linkify=True, colored=True) description = attrs.TextAttr('description') serial = attrs.TextAttr('serial', label=_('Serial number'), style='font-monospace', copy_button=True) asset_tag = attrs.TextAttr('asset_tag', style='font-monospace', copy_button=True) @@ -104,7 +104,7 @@ class DeviceManagementPanel(panels.ObjectAttributesPanel): title = _('Management') status = attrs.ChoiceAttr('status') - role = attrs.NestedObjectAttr('role', linkify=True, max_depth=3) + role = attrs.NestedObjectAttr('role', linkify=True, max_depth=3, colored=True) platform = attrs.NestedObjectAttr('platform', linkify=True, max_depth=3) primary_ip4 = attrs.TemplatedAttr( 'primary_ip4', @@ -295,7 +295,7 @@ class InventoryItemPanel(panels.ObjectAttributesPanel): name = attrs.TextAttr('name') label = attrs.TextAttr('label') status = attrs.ChoiceAttr('status') - role = attrs.RelatedObjectAttr('role', linkify=True) + role = attrs.RelatedObjectAttr('role', linkify=True, colored=True) component = attrs.GenericForeignKeyAttr('component', linkify=True) manufacturer = attrs.RelatedObjectAttr('manufacturer', linkify=True) part_id = attrs.TextAttr('part_id', label=_('Part ID')) diff --git a/netbox/extras/api/customfields.py b/netbox/extras/api/customfields.py index 2113cd0c0..9c9cb146e 100644 --- a/netbox/extras/api/customfields.py +++ b/netbox/extras/api/customfields.py @@ -85,8 +85,18 @@ class CustomFieldsDataField(Field): "values." ) + custom_fields = {cf.name: cf for cf in self._get_custom_fields()} + + # Reject any unknown custom field names + invalid_fields = set(data) - set(custom_fields) + if invalid_fields: + raise ValidationError({ + field: _("Custom field '{name}' does not exist for this object type.").format(name=field) + for field in sorted(invalid_fields) + }) + # Serialize object and multi-object values - for cf in self._get_custom_fields(): + for cf in custom_fields.values(): if cf.name in data and data[cf.name] not in CUSTOMFIELD_EMPTY_VALUES and cf.type in ( CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT diff --git a/netbox/extras/api/serializers_/scripts.py b/netbox/extras/api/serializers_/scripts.py index a7d5b9c2a..9f0afe3f1 100644 --- a/netbox/extras/api/serializers_/scripts.py +++ b/netbox/extras/api/serializers_/scripts.py @@ -1,19 +1,70 @@ -from django.utils.translation import gettext as _ +import logging + +from django.core.files.storage import storages +from django.db import IntegrityError +from django.utils.translation import gettext_lazy as _ from drf_spectacular.utils import extend_schema_field from rest_framework import serializers from core.api.serializers_.jobs import JobSerializer -from extras.models import Script +from core.choices import ManagedFileRootPathChoices +from extras.models import Script, ScriptModule from netbox.api.serializers import ValidatedModelSerializer from utilities.datetime import local_now +logger = logging.getLogger(__name__) + __all__ = ( 'ScriptDetailSerializer', 'ScriptInputSerializer', + 'ScriptModuleSerializer', 'ScriptSerializer', ) +class ScriptModuleSerializer(ValidatedModelSerializer): + file = serializers.FileField(write_only=True) + file_path = serializers.CharField(read_only=True) + + class Meta: + model = ScriptModule + fields = ['id', 'display', 'file_path', 'file', 'created', 'last_updated'] + brief_fields = ('id', 'display') + + def validate(self, data): + # ScriptModule.save() sets file_root; inject it here so full_clean() succeeds. + # Pop 'file' before model instantiation — ScriptModule has no such field. + file = data.pop('file', None) + data['file_root'] = ManagedFileRootPathChoices.SCRIPTS + data = super().validate(data) + data.pop('file_root', None) + if file is not None: + data['file'] = file + return data + + def create(self, validated_data): + file = validated_data.pop('file') + storage = storages.create_storage(storages.backends["scripts"]) + validated_data['file_path'] = storage.save(file.name, file) + created = False + try: + instance = super().create(validated_data) + created = True + return instance + except IntegrityError as e: + if 'file_path' in str(e): + raise serializers.ValidationError( + _("A script module with this file name already exists.") + ) + raise + finally: + if not created and (file_path := validated_data.get('file_path')): + try: + storage.delete(file_path) + except Exception: + logger.warning(f"Failed to delete orphaned script file '{file_path}' from storage.") + + class ScriptSerializer(ValidatedModelSerializer): description = serializers.SerializerMethodField(read_only=True) vars = serializers.SerializerMethodField(read_only=True) diff --git a/netbox/extras/api/urls.py b/netbox/extras/api/urls.py index 9478fbeb2..cd1a9f683 100644 --- a/netbox/extras/api/urls.py +++ b/netbox/extras/api/urls.py @@ -26,6 +26,7 @@ router.register('journal-entries', views.JournalEntryViewSet) router.register('config-contexts', views.ConfigContextViewSet) router.register('config-context-profiles', views.ConfigContextProfileViewSet) router.register('config-templates', views.ConfigTemplateViewSet) +router.register('scripts/upload', views.ScriptModuleViewSet) router.register('scripts', views.ScriptViewSet, basename='script') app_name = 'extras-api' diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index e72ad1ab5..5a2c03212 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -6,7 +6,7 @@ from rest_framework import status from rest_framework.decorators import action from rest_framework.exceptions import PermissionDenied from rest_framework.generics import RetrieveUpdateDestroyAPIView -from rest_framework.mixins import ListModelMixin, RetrieveModelMixin +from rest_framework.mixins import CreateModelMixin, ListModelMixin, RetrieveModelMixin from rest_framework.renderers import JSONRenderer from rest_framework.response import Response from rest_framework.routers import APIRootView @@ -21,6 +21,7 @@ from netbox.api.features import SyncedDataMixin from netbox.api.metadata import ContentTypeMetadata from netbox.api.renderers import TextRenderer from netbox.api.viewsets import BaseViewSet, NetBoxModelViewSet +from netbox.api.viewsets.mixins import ObjectValidationMixin from utilities.exceptions import RQWorkerNotRunningException from utilities.request import copy_safe_request @@ -264,6 +265,11 @@ class ConfigTemplateViewSet(SyncedDataMixin, ConfigTemplateRenderMixin, NetBoxMo # Scripts # +class ScriptModuleViewSet(ObjectValidationMixin, CreateModelMixin, BaseViewSet): + queryset = ScriptModule.objects.all() + serializer_class = serializers.ScriptModuleSerializer + + @extend_schema_view( update=extend_schema(request=serializers.ScriptInputSerializer), partial_update=extend_schema(request=serializers.ScriptInputSerializer), diff --git a/netbox/extras/events.py b/netbox/extras/events.py index 782b29633..55e8b83e7 100644 --- a/netbox/extras/events.py +++ b/netbox/extras/events.py @@ -25,16 +25,54 @@ logger = logging.getLogger('netbox.events_processor') class EventContext(UserDict): """ - A custom dictionary that automatically serializes its associated object on demand. + Dictionary-compatible wrapper for queued events that lazily serializes + ``event['data']`` on first access. + + Backward-compatible with the plain-dict interface expected by existing + EVENTS_PIPELINE consumers. When the same object is enqueued more than once + in a single request, the serialization source is updated so consumers see + the latest state. """ - # We're emulating a dictionary here (rather than using a custom class) because prior to NetBox v4.5.2, events were - # queued as dictionaries for processing by handles in EVENTS_PIPELINE. We need to avoid introducing any breaking - # changes until a suitable minor release. + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + # Track which model instance should be serialized if/when `data` is + # requested. This may be refreshed on duplicate enqueue, while leaving + # the public `object` entry untouched for compatibility. + self._serialization_source = None + if 'object' in self: + self._serialization_source = super().__getitem__('object') + + def refresh_serialization_source(self, instance): + """ + Point lazy serialization at a fresher instance, invalidating any + already-materialized ``data``. + """ + self._serialization_source = instance + # UserDict.__contains__ checks the backing dict directly, so `in` + # does not trigger __getitem__'s lazy serialization. + if 'data' in self: + del self['data'] + + def freeze_data(self, instance): + """ + Eagerly serialize and cache the payload for delete events, where the + object may become inaccessible after deletion. + """ + super().__setitem__('data', serialize_for_event(instance)) + self._serialization_source = None + def __getitem__(self, item): if item == 'data' and 'data' not in self: - data = serialize_for_event(self['object']) - self.__setitem__('data', data) + # Materialize the payload only when an event consumer asks for it. + # + # On coalesced events, use the latest explicitly queued instance so + # webhooks/scripts/notifications observe the final queued state for + # that object within the request. + source = self._serialization_source or super().__getitem__('object') + super().__setitem__('data', serialize_for_event(source)) + return super().__getitem__(item) @@ -76,8 +114,9 @@ def get_snapshots(instance, event_type): def enqueue_event(queue, instance, request, event_type): """ - Enqueue a serialized representation of a created/updated/deleted object for the processing of - events once the request has completed. + Enqueue (or coalesce) an event for a created/updated/deleted object. + + Events are processed after the request completes. """ # Bail if this type of object does not support event rules if not has_feature(instance, 'event_rules'): @@ -88,11 +127,18 @@ def enqueue_event(queue, instance, request, event_type): assert instance.pk is not None key = f'{app_label}.{model_name}:{instance.pk}' + if key in queue: queue[key]['snapshots']['postchange'] = get_snapshots(instance, event_type)['postchange'] - # If the object is being deleted, update any prior "update" event to "delete" + + # If the object is being deleted, convert any prior update event into a + # delete event and freeze the payload before the object (or related + # rows) become inaccessible. if event_type == OBJECT_DELETED: queue[key]['event_type'] = event_type + else: + # Keep the public `object` entry stable for compatibility. + queue[key].refresh_serialization_source(instance) else: queue[key] = EventContext( object_type=ObjectType.objects.get_for_model(instance), @@ -106,9 +152,11 @@ def enqueue_event(queue, instance, request, event_type): username=request.user.username, # DEPRECATED, will be removed in NetBox v4.7.0 request_id=request.id, # DEPRECATED, will be removed in NetBox v4.7.0 ) - # Force serialization of objects prior to them actually being deleted + + # For delete events, eagerly serialize the payload before the row is gone. + # This covers both first-time enqueues and coalesced update→delete promotions. if event_type == OBJECT_DELETED: - queue[key]['data'] = serialize_for_event(instance) + queue[key].freeze_data(instance) def process_event_rules(event_rules, object_type, event): @@ -133,9 +181,9 @@ def process_event_rules(event_rules, object_type, event): if not event_rule.eval_conditions(event['data']): continue - # Compile event data - event_data = event_rule.action_data or {} - event_data.update(event['data']) + # Merge rule-specific action_data with the event payload. + # Copy to avoid mutating the rule's stored action_data dict. + event_data = {**(event_rule.action_data or {}), **event['data']} # Webhooks if event_rule.action_type == EventRuleActionChoices.WEBHOOK: diff --git a/netbox/extras/migrations/0137_default_ordering_indexes.py b/netbox/extras/migrations/0137_default_ordering_indexes.py index 2407e7868..f15c3659e 100644 --- a/netbox/extras/migrations/0137_default_ordering_indexes.py +++ b/netbox/extras/migrations/0137_default_ordering_indexes.py @@ -6,7 +6,7 @@ class Migration(migrations.Migration): dependencies = [ ('contenttypes', '0002_remove_content_type_name'), ('core', '0022_default_ordering_indexes'), - ('dcim', '0231_default_ordering_indexes'), + ('dcim', '0232_default_ordering_indexes'), ('extras', '0136_customfield_validation_schema'), ('tenancy', '0023_add_mptt_tree_indexes'), ('users', '0015_owner'), diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index a5614fa85..3df1d7c70 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -421,6 +421,7 @@ class NotificationTable(NetBoxTable): icon = columns.TemplateColumn( template_code=NOTIFICATION_ICON, accessor=tables.A('event'), + orderable=False, attrs={ 'td': {'class': 'w-1'}, 'th': {'class': 'w-1'}, @@ -483,8 +484,8 @@ class WebhookTable(NetBoxTable): verbose_name=_('Name'), linkify=True ) - ssl_validation = columns.BooleanColumn( - verbose_name=_('SSL Validation') + ssl_verification = columns.BooleanColumn( + verbose_name=_('SSL Verification'), ) owner = tables.Column( linkify=True, diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py index 1c4996bcc..8a05fdc27 100644 --- a/netbox/extras/tests/test_api.py +++ b/netbox/extras/tests/test_api.py @@ -1,7 +1,10 @@ import datetime import hashlib +import io +from unittest.mock import MagicMock, patch from django.contrib.contenttypes.models import ContentType +from django.core.files.uploadedfile import SimpleUploadedFile from django.urls import reverse from django.utils.timezone import make_aware, now from rest_framework import status @@ -1011,10 +1014,14 @@ class ScriptTest(APITestCase): @classmethod def setUpTestData(cls): - module = ScriptModule.objects.create( - file_root=ManagedFileRootPathChoices.SCRIPTS, - file_path='script.py', - ) + # Avoid trying to import a non-existent on-disk module during setup. + # This test creates the Script row explicitly and monkey-patches + # Script.python_class below. + with patch.object(ScriptModule, 'sync_classes'): + module = ScriptModule.objects.create( + file_root=ManagedFileRootPathChoices.SCRIPTS, + file_path='script.py', + ) script = Script.objects.create( module=module, name='Test script', @@ -1384,3 +1391,66 @@ class NotificationTest(APIViewTestCases.APIViewTestCase): 'event_type': OBJECT_DELETED, }, ] + + +class ScriptModuleTest(APITestCase): + """ + Tests for the POST /api/extras/scripts/upload/ endpoint. + + ScriptModule is a proxy of core.ManagedFile (a different app) so the standard + APIViewTestCases mixins cannot be used directly. All tests use add_permissions() + with explicit Django model-level permissions. + """ + + def setUp(self): + super().setUp() + self.url = reverse('extras-api:scriptmodule-list') # /api/extras/scripts/upload/ + + def test_upload_script_module_without_permission(self): + script_content = b"from extras.scripts import Script\nclass TestScript(Script):\n pass\n" + upload_file = SimpleUploadedFile('test_upload.py', script_content, content_type='text/plain') + response = self.client.post( + self.url, + {'file': upload_file}, + format='multipart', + **self.header, + ) + self.assertHttpStatus(response, status.HTTP_403_FORBIDDEN) + + def test_upload_script_module(self): + # ScriptModule is a proxy of core.ManagedFile; both permissions required. + self.add_permissions('extras.add_scriptmodule', 'core.add_managedfile') + script_content = b"from extras.scripts import Script\nclass TestScript(Script):\n pass\n" + upload_file = SimpleUploadedFile('test_upload.py', script_content, content_type='text/plain') + mock_storage = MagicMock() + mock_storage.save.return_value = 'test_upload.py' + + # The upload serializer writes the file via storages.create_storage(...).save(), + # but ScriptModule.sync_classes() later imports it via storages["scripts"].open(). + # Provide both behaviors so the uploaded module can actually be loaded during the test. + mock_storage.open.side_effect = lambda *args, **kwargs: io.BytesIO(script_content) + + with ( + patch('extras.api.serializers_.scripts.storages') as mock_serializer_storages, + patch('extras.models.mixins.storages') as mock_module_storages, + ): + mock_serializer_storages.create_storage.return_value = mock_storage + mock_serializer_storages.backends = {'scripts': {}} + mock_module_storages.__getitem__.return_value = mock_storage + + response = self.client.post( + self.url, + {'file': upload_file}, + format='multipart', + **self.header, + ) + self.assertHttpStatus(response, status.HTTP_201_CREATED) + self.assertEqual(response.data['file_path'], 'test_upload.py') + mock_storage.save.assert_called_once() + self.assertTrue(ScriptModule.objects.filter(file_path='test_upload.py').exists()) + self.assertTrue(Script.objects.filter(module__file_path='test_upload.py', name='TestScript').exists()) + + def test_upload_script_module_without_file_fails(self): + self.add_permissions('extras.add_scriptmodule', 'core.add_managedfile') + response = self.client.post(self.url, {}, format='json', **self.header) + self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST) diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py index cb6f0ecae..7ab77e039 100644 --- a/netbox/extras/tests/test_customfields.py +++ b/netbox/extras/tests/test_customfields.py @@ -7,7 +7,7 @@ from django.test import tag from django.urls import reverse from rest_framework import status -from core.models import ObjectType +from core.models import ObjectChange, ObjectType from dcim.filtersets import SiteFilterSet from dcim.forms import SiteImportForm from dcim.models import Manufacturer, Rack, Site @@ -1233,6 +1233,82 @@ class CustomFieldAPITest(APITestCase): list(original_cfvs['multiobject_field']) ) + @tag('regression') + def test_update_single_object_rejects_unknown_custom_fields(self): + site2 = Site.objects.get(name='Site 2') + original_cf_data = {**site2.custom_field_data} + url = reverse('dcim-api:site-detail', kwargs={'pk': site2.pk}) + self.add_permissions('dcim.change_site') + + data = { + 'custom_fields': { + 'text_field': 'valid', + 'thisfieldshouldntexist': 'random text here', + }, + } + + response = self.client.patch(url, data, format='json', **self.header) + self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST) + self.assertIn('custom_fields', response.data) + self.assertIn('thisfieldshouldntexist', response.data['custom_fields']) + + # Ensure the object was not modified + site2.refresh_from_db() + self.assertEqual(site2.custom_field_data, original_cf_data) + + @tag('regression') + def test_update_single_object_prunes_stale_custom_field_data_from_database_and_postchange_data(self): + stale_key = 'thisfieldshouldntexist' + stale_value = 'random text here' + updated_text_value = 'ABCD' + + site2 = Site.objects.get(name='Site 2') + original_text_value = site2.custom_field_data['text_field'] + object_type = ObjectType.objects.get_for_model(Site) + + # Seed stale custom field data directly in the database to mimic a polluted row. + Site.objects.filter(pk=site2.pk).update( + custom_field_data={ + **site2.custom_field_data, + stale_key: stale_value, + } + ) + site2.refresh_from_db() + self.assertIn(stale_key, site2.custom_field_data) + + existing_change_ids = set( + ObjectChange.objects.filter( + changed_object_type=object_type, + changed_object_id=site2.pk, + ).values_list('pk', flat=True) + ) + + url = reverse('dcim-api:site-detail', kwargs={'pk': site2.pk}) + self.add_permissions('dcim.change_site') + data = { + 'custom_fields': { + 'text_field': updated_text_value, + }, + } + + response = self.client.patch(url, data, format='json', **self.header) + self.assertHttpStatus(response, status.HTTP_200_OK) + + site2.refresh_from_db() + self.assertEqual(site2.cf['text_field'], updated_text_value) + self.assertNotIn(stale_key, site2.custom_field_data) + + object_changes = ObjectChange.objects.filter( + changed_object_type=object_type, + changed_object_id=site2.pk, + ).exclude(pk__in=existing_change_ids) + self.assertEqual(object_changes.count(), 1) + + object_change = object_changes.get() + self.assertEqual(object_change.prechange_data['custom_fields']['text_field'], original_text_value) + self.assertEqual(object_change.postchange_data['custom_fields']['text_field'], updated_text_value) + self.assertNotIn(stale_key, object_change.postchange_data['custom_fields']) + def test_specify_related_object_by_attr(self): site1 = Site.objects.get(name='Site 1') vlans = VLAN.objects.all()[:3] diff --git a/netbox/extras/tests/test_event_rules.py b/netbox/extras/tests/test_event_rules.py index dacfefde6..eb20cba55 100644 --- a/netbox/extras/tests/test_event_rules.py +++ b/netbox/extras/tests/test_event_rules.py @@ -1,8 +1,10 @@ import json import uuid +from unittest import skipIf from unittest.mock import Mock, patch import django_rq +from django.conf import settings from django.http import HttpResponse from django.test import RequestFactory from django.urls import reverse @@ -343,6 +345,7 @@ class EventRuleTest(APITestCase): self.assertEqual(job.kwargs['snapshots']['prechange']['name'], sites[i].name) self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo']) + @skipIf('netbox.tests.dummy_plugin' not in settings.PLUGINS, 'dummy_plugin not in settings.PLUGINS') def test_send_webhook(self): request_id = uuid.uuid4() url_path = reverse('dcim:site_add') @@ -431,6 +434,97 @@ class EventRuleTest(APITestCase): self.assertEqual(job.kwargs['object_type'], script_type) self.assertEqual(job.kwargs['username'], self.user.username) + def test_duplicate_enqueue_refreshes_lazy_payload(self): + """ + When the same object is enqueued more than once in a single request, + lazy serialization should use the most recently enqueued instance while + preserving the original event['object'] reference. + """ + request = RequestFactory().get(reverse('dcim:site_add')) + request.id = uuid.uuid4() + request.user = self.user + + site = Site.objects.create(name='Site 1', slug='site-1') + stale_site = Site.objects.get(pk=site.pk) + + queue = {} + enqueue_event(queue, stale_site, request, OBJECT_UPDATED) + + event = queue[f'dcim.site:{site.pk}'] + + # Data should not be materialized yet (lazy serialization) + self.assertNotIn('data', event.data) + + fresh_site = Site.objects.get(pk=site.pk) + fresh_site.description = 'foo' + fresh_site.save() + + enqueue_event(queue, fresh_site, request, OBJECT_UPDATED) + + # The original object reference should be preserved + self.assertIs(event['object'], stale_site) + + # But serialized data should reflect the fresher instance + self.assertEqual(event['data']['description'], 'foo') + self.assertEqual(event['snapshots']['postchange']['description'], 'foo') + + def test_duplicate_enqueue_invalidates_materialized_data(self): + """ + If event['data'] has already been materialized before a second enqueue + for the same object, the stale payload should be discarded and rebuilt + from the fresher instance on next access. + """ + request = RequestFactory().get(reverse('dcim:site_add')) + request.id = uuid.uuid4() + request.user = self.user + + site = Site.objects.create(name='Site 1', slug='site-1') + + queue = {} + enqueue_event(queue, site, request, OBJECT_UPDATED) + + event = queue[f'dcim.site:{site.pk}'] + + # Force early materialization + self.assertEqual(event['data']['description'], '') + + # Now update and re-enqueue + fresh_site = Site.objects.get(pk=site.pk) + fresh_site.description = 'updated' + fresh_site.save() + + enqueue_event(queue, fresh_site, request, OBJECT_UPDATED) + + # Stale data should have been invalidated; new access should reflect update + self.assertEqual(event['data']['description'], 'updated') + + def test_update_then_delete_enqueue_freezes_payload(self): + """ + When an update event is coalesced with a subsequent delete, the event + type should be promoted to OBJECT_DELETED and the payload should be + eagerly frozen (since the object will be inaccessible after deletion). + """ + request = RequestFactory().get(reverse('dcim:site_add')) + request.id = uuid.uuid4() + request.user = self.user + + site = Site.objects.create(name='Site 1', slug='site-1') + + queue = {} + enqueue_event(queue, site, request, OBJECT_UPDATED) + + event = queue[f'dcim.site:{site.pk}'] + + enqueue_event(queue, site, request, OBJECT_DELETED) + + # Event type should have been promoted + self.assertEqual(event['event_type'], OBJECT_DELETED) + + # Data should already be materialized (frozen), not lazy + self.assertIn('data', event.data) + self.assertEqual(event['data']['name'], 'Site 1') + self.assertIsNone(event['snapshots']['postchange']) + def test_duplicate_triggers(self): """ Test for erroneous duplicate event triggers resulting from saving an object multiple times diff --git a/netbox/extras/tests/test_models.py b/netbox/extras/tests/test_models.py index 2494b266b..f6029b278 100644 --- a/netbox/extras/tests/test_models.py +++ b/netbox/extras/tests/test_models.py @@ -1,10 +1,15 @@ +import io import tempfile from pathlib import Path +from unittest.mock import patch from django.contrib.contenttypes.models import ContentType +from django.core.files.base import ContentFile +from django.core.files.storage import Storage from django.core.files.uploadedfile import SimpleUploadedFile from django.forms import ValidationError from django.test import TestCase, tag +from PIL import Image from core.models import AutoSyncRecord, DataSource, ObjectType from dcim.models import Device, DeviceRole, DeviceType, Location, Manufacturer, Platform, Region, Site, SiteGroup @@ -22,10 +27,50 @@ from utilities.exceptions import AbortRequest from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine +class OverwriteStyleMemoryStorage(Storage): + """ + In-memory storage that mimics overwrite-style backends by returning the + incoming name unchanged from get_available_name(). + """ + + def __init__(self): + self.files = {} + + def _open(self, name, mode='rb'): + return ContentFile(self.files[name], name=name) + + def _save(self, name, content): + self.files[name] = content.read() + return name + + def delete(self, name): + self.files.pop(name, None) + + def exists(self, name): + return name in self.files + + def get_available_name(self, name, max_length=None): + return name + + def get_alternative_name(self, file_root, file_ext): + return f'{file_root}_sdmmer4{file_ext}' + + def listdir(self, path): + return [], list(self.files) + + def size(self, name): + return len(self.files[name]) + + def url(self, name): + return f'https://example.invalid/{name}' + + class ImageAttachmentTests(TestCase): @classmethod def setUpTestData(cls): cls.ct_rack = ContentType.objects.get_by_natural_key('dcim', 'rack') + cls.ct_site = ContentType.objects.get_by_natural_key('dcim', 'site') + cls.site = Site.objects.create(name='Site 1') cls.image_content = b'' def _stub_image_attachment(self, object_id, image_filename, name=None): @@ -49,6 +94,15 @@ class ImageAttachmentTests(TestCase): ) return ia + def _uploaded_png(self, filename): + image = io.BytesIO() + Image.new('RGB', (1, 1)).save(image, format='PNG') + return SimpleUploadedFile( + name=filename, + content=image.getvalue(), + content_type='image/png', + ) + def test_filename_strips_expected_prefix(self): """ Tests that the filename of the image attachment is stripped of the expected @@ -97,6 +151,37 @@ class ImageAttachmentTests(TestCase): ia = self._stub_image_attachment(12, 'image-attachments/rack_12_file.png', name='') self.assertEqual('file.png', str(ia)) + def test_duplicate_uploaded_names_get_suffixed_with_overwrite_style_storage(self): + storage = OverwriteStyleMemoryStorage() + field = ImageAttachment._meta.get_field('image') + + with patch.object(field, 'storage', storage): + first = ImageAttachment( + object_type=self.ct_site, + object_id=self.site.pk, + image=self._uploaded_png('action-buttons.png'), + ) + first.save() + + second = ImageAttachment( + object_type=self.ct_site, + object_id=self.site.pk, + image=self._uploaded_png('action-buttons.png'), + ) + second.save() + + base_name = f'image-attachments/site_{self.site.pk}_action-buttons.png' + suffixed_name = f'image-attachments/site_{self.site.pk}_action-buttons_sdmmer4.png' + + self.assertEqual(first.image.name, base_name) + self.assertEqual(second.image.name, suffixed_name) + self.assertNotEqual(first.image.name, second.image.name) + + self.assertEqual(first.filename, 'action-buttons.png') + self.assertEqual(second.filename, 'action-buttons_sdmmer4.png') + + self.assertCountEqual(storage.files.keys(), {base_name, suffixed_name}) + class TagTest(TestCase): diff --git a/netbox/extras/tests/test_tables.py b/netbox/extras/tests/test_tables.py index 7fb6380c9..fb20a7e2e 100644 --- a/netbox/extras/tests/test_tables.py +++ b/netbox/extras/tests/test_tables.py @@ -1,24 +1,93 @@ -from django.test import RequestFactory, TestCase, tag - -from extras.models import EventRule -from extras.tables import EventRuleTable +from extras.models import Bookmark, Notification, Subscription +from extras.tables import * +from utilities.testing import TableTestCases -@tag('regression') -class EventRuleTableTest(TestCase): - def test_every_orderable_field_does_not_throw_exception(self): - rule = EventRule.objects.all() - disallowed = { - 'actions', - } +class CustomFieldTableTest(TableTestCases.StandardTableTestCase): + table = CustomFieldTable - orderable_columns = [ - column.name for column in EventRuleTable(rule).columns if column.orderable and column.name not in disallowed - ] - fake_request = RequestFactory().get('/') - for col in orderable_columns: - for direction in ('-', ''): - table = EventRuleTable(rule) - table.order_by = f'{direction}{col}' - table.as_html(fake_request) +class CustomFieldChoiceSetTableTest(TableTestCases.StandardTableTestCase): + table = CustomFieldChoiceSetTable + + +class CustomLinkTableTest(TableTestCases.StandardTableTestCase): + table = CustomLinkTable + + +class ExportTemplateTableTest(TableTestCases.StandardTableTestCase): + table = ExportTemplateTable + + +class SavedFilterTableTest(TableTestCases.StandardTableTestCase): + table = SavedFilterTable + + +class TableConfigTableTest(TableTestCases.StandardTableTestCase): + table = TableConfigTable + + +class BookmarkTableTest(TableTestCases.StandardTableTestCase): + table = BookmarkTable + + # The list view for this table lives in account.views (not extras.views), + # so auto-discovery cannot find it. Provide an explicit queryset source. + queryset_sources = [ + ('Bookmark.objects.all()', Bookmark.objects.all()), + ] + + +class NotificationGroupTableTest(TableTestCases.StandardTableTestCase): + table = NotificationGroupTable + + +class NotificationTableTest(TableTestCases.StandardTableTestCase): + table = NotificationTable + + # The list view for this table lives in account.views (not extras.views), + # so auto-discovery cannot find it. Provide an explicit queryset source. + queryset_sources = [ + ('Notification.objects.all()', Notification.objects.all()), + ] + + +class SubscriptionTableTest(TableTestCases.StandardTableTestCase): + table = SubscriptionTable + + # The list view for this table lives in account.views (not extras.views), + # so auto-discovery cannot find it. Provide an explicit queryset source. + queryset_sources = [ + ('Subscription.objects.all()', Subscription.objects.all()), + ] + + +class WebhookTableTest(TableTestCases.StandardTableTestCase): + table = WebhookTable + + +class EventRuleTableTest(TableTestCases.StandardTableTestCase): + table = EventRuleTable + + +class TagTableTest(TableTestCases.StandardTableTestCase): + table = TagTable + + +class ConfigContextProfileTableTest(TableTestCases.StandardTableTestCase): + table = ConfigContextProfileTable + + +class ConfigContextTableTest(TableTestCases.StandardTableTestCase): + table = ConfigContextTable + + +class ConfigTemplateTableTest(TableTestCases.StandardTableTestCase): + table = ConfigTemplateTable + + +class ImageAttachmentTableTest(TableTestCases.StandardTableTestCase): + table = ImageAttachmentTable + + +class JournalEntryTableTest(TableTestCases.StandardTableTestCase): + table = JournalEntryTable diff --git a/netbox/extras/tests/test_utils.py b/netbox/extras/tests/test_utils.py index 540c64701..1a80c8121 100644 --- a/netbox/extras/tests/test_utils.py +++ b/netbox/extras/tests/test_utils.py @@ -1,10 +1,12 @@ from types import SimpleNamespace +from unittest.mock import patch from django.contrib.contenttypes.models import ContentType +from django.core.files.storage import Storage from django.test import TestCase -from extras.models import ExportTemplate -from extras.utils import filename_from_model, image_upload +from extras.models import ExportTemplate, ImageAttachment +from extras.utils import _build_image_attachment_path, filename_from_model, image_upload from tenancy.models import ContactGroup, TenantGroup from wireless.models import WirelessLANGroup @@ -22,6 +24,25 @@ class FilenameFromModelTests(TestCase): self.assertEqual(filename_from_model(model), expected) +class OverwriteStyleStorage(Storage): + """ + Mimic an overwrite-style backend (for example, S3 with file_overwrite=True), + where get_available_name() returns the incoming name unchanged. + """ + + def __init__(self, existing_names=None): + self.existing_names = set(existing_names or []) + + def exists(self, name): + return name in self.existing_names + + def get_available_name(self, name, max_length=None): + return name + + def get_alternative_name(self, file_root, file_ext): + return f'{file_root}_sdmmer4{file_ext}' + + class ImageUploadTests(TestCase): @classmethod def setUpTestData(cls): @@ -31,16 +52,18 @@ class ImageUploadTests(TestCase): def _stub_instance(self, object_id=12, name=None): """ - Creates a minimal stub for use with the `image_upload()` function. - - This method generates an instance of `SimpleNamespace` containing a set - of attributes required to simulate the expected input for the - `image_upload()` method. - It is designed to simplify testing or processing by providing a - lightweight representation of an object. + Creates a minimal stub for use with image attachment path generation. """ return SimpleNamespace(object_type=self.ct_rack, object_id=object_id, name=name) + def _bound_instance(self, *, storage, object_id=12, name=None, max_length=100): + return SimpleNamespace( + object_type=self.ct_rack, + object_id=object_id, + name=name, + image=SimpleNamespace(field=SimpleNamespace(storage=storage, max_length=max_length)), + ) + def _second_segment(self, path: str): """ Extracts and returns the portion of the input string after the @@ -53,7 +76,7 @@ class ImageUploadTests(TestCase): Tests handling of a Windows file path with a fake directory and extension. """ inst = self._stub_instance(name=None) - path = image_upload(inst, r'C:\fake_path\MyPhoto.JPG') + path = _build_image_attachment_path(inst, r'C:\fake_path\MyPhoto.JPG') # Base directory and single-level path seg2 = self._second_segment(path) self.assertTrue(path.startswith('image-attachments/rack_12_')) @@ -67,7 +90,7 @@ class ImageUploadTests(TestCase): create subdirectories. """ inst = self._stub_instance(name='5/31/23') - path = image_upload(inst, 'image.png') + path = _build_image_attachment_path(inst, 'image.png') seg2 = self._second_segment(path) self.assertTrue(seg2.startswith('rack_12_')) self.assertNotIn('/', seg2) @@ -80,7 +103,7 @@ class ImageUploadTests(TestCase): into a single directory name without creating subdirectories. """ inst = self._stub_instance(name=r'5\31\23') - path = image_upload(inst, 'image_name.png') + path = _build_image_attachment_path(inst, 'image_name.png') seg2 = self._second_segment(path) self.assertTrue(seg2.startswith('rack_12_')) @@ -93,7 +116,7 @@ class ImageUploadTests(TestCase): Tests the output path format generated by the `image_upload` function. """ inst = self._stub_instance(object_id=99, name='label') - path = image_upload(inst, 'a.webp') + path = _build_image_attachment_path(inst, 'a.webp') # The second segment must begin with "rack_99_" seg2 = self._second_segment(path) self.assertTrue(seg2.startswith('rack_99_')) @@ -105,7 +128,7 @@ class ImageUploadTests(TestCase): is omitted. """ inst = self._stub_instance(name='test') - path = image_upload(inst, 'document.txt') + path = _build_image_attachment_path(inst, 'document.txt') seg2 = self._second_segment(path) self.assertTrue(seg2.startswith('rack_12_test')) @@ -121,7 +144,7 @@ class ImageUploadTests(TestCase): # Suppose the instance name has surrounding whitespace and # extra slashes. inst = self._stub_instance(name=' my/complex\\name ') - path = image_upload(inst, 'irrelevant.png') + path = _build_image_attachment_path(inst, 'irrelevant.png') # The output should be flattened and sanitized. # We expect the name to be transformed into a valid filename without @@ -141,7 +164,7 @@ class ImageUploadTests(TestCase): for name in ['2025/09/12', r'2025\09\12']: with self.subTest(name=name): inst = self._stub_instance(name=name) - path = image_upload(inst, 'x.jpeg') + path = _build_image_attachment_path(inst, 'x.jpeg') seg2 = self._second_segment(path) self.assertTrue(seg2.startswith('rack_12_')) self.assertNotIn('/', seg2) @@ -154,7 +177,49 @@ class ImageUploadTests(TestCase): SuspiciousFileOperation, the fallback default is used. """ inst = self._stub_instance(name=' ') - path = image_upload(inst, 'sample.png') + path = _build_image_attachment_path(inst, 'sample.png') # Expect the fallback name 'unnamed' to be used. self.assertIn('unnamed', path) self.assertTrue(path.startswith('image-attachments/rack_12_')) + + def test_image_upload_preserves_original_name_when_available(self): + inst = self._bound_instance( + storage=OverwriteStyleStorage(), + name='action-buttons', + ) + + path = image_upload(inst, 'action-buttons.png') + + self.assertEqual(path, 'image-attachments/rack_12_action-buttons.png') + + def test_image_upload_uses_base_collision_handling_with_overwrite_style_storage(self): + inst = self._bound_instance( + storage=OverwriteStyleStorage(existing_names={'image-attachments/rack_12_action-buttons.png'}), + name='action-buttons', + ) + + path = image_upload(inst, 'action-buttons.png') + + self.assertEqual( + path, + 'image-attachments/rack_12_action-buttons_sdmmer4.png', + ) + + def test_image_field_generate_filename_uses_image_upload_collision_handling(self): + field = ImageAttachment._meta.get_field('image') + instance = ImageAttachment( + object_type=self.ct_rack, + object_id=12, + ) + + with patch.object( + field, + 'storage', + OverwriteStyleStorage(existing_names={'image-attachments/rack_12_action-buttons.png'}), + ): + path = field.generate_filename(instance, 'action-buttons.png') + + self.assertEqual( + path, + 'image-attachments/rack_12_action-buttons_sdmmer4.png', + ) diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index 44cce289c..8d28f4602 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -924,7 +924,14 @@ class ScriptValidationErrorTest(TestCase): @classmethod def setUpTestData(cls): - module = ScriptModule.objects.create(file_root=ManagedFileRootPathChoices.SCRIPTS, file_path='test_script.py') + # Avoid trying to import a non-existent on-disk module during setup. + # This test creates the Script row explicitly and monkey-patches + # Script.python_class below. + with patch.object(ScriptModule, 'sync_classes'): + module = ScriptModule.objects.create( + file_root=ManagedFileRootPathChoices.SCRIPTS, + file_path='test_script.py', + ) cls.script = Script.objects.create(module=module, name='Test script', is_executable=True) def setUp(self): @@ -986,7 +993,14 @@ class ScriptDefaultValuesTest(TestCase): @classmethod def setUpTestData(cls): - module = ScriptModule.objects.create(file_root=ManagedFileRootPathChoices.SCRIPTS, file_path='test_script.py') + # Avoid trying to import a non-existent on-disk module during setup. + # This test creates the Script row explicitly and monkey-patches + # Script.python_class below. + with patch.object(ScriptModule, 'sync_classes'): + module = ScriptModule.objects.create( + file_root=ManagedFileRootPathChoices.SCRIPTS, + file_path='test_script.py', + ) cls.script = Script.objects.create(module=module, name='Test script', is_executable=True) def setUp(self): diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py index 4640902f0..612096ad7 100644 --- a/netbox/extras/utils.py +++ b/netbox/extras/utils.py @@ -2,7 +2,7 @@ import importlib from pathlib import Path from django.core.exceptions import ImproperlyConfigured, SuspiciousFileOperation -from django.core.files.storage import default_storage +from django.core.files.storage import Storage, default_storage from django.core.files.utils import validate_file_name from django.db import models from django.db.models import Q @@ -67,15 +67,13 @@ def is_taggable(obj): return False -def image_upload(instance, filename): +def _build_image_attachment_path(instance, filename, *, storage=default_storage): """ - Return a path for uploading image attachments. + Build a deterministic relative path for an image attachment. - Normalizes browser paths (e.g., C:\\fake_path\\photo.jpg) - Uses the instance.name if provided (sanitized to a *basename*, no ext) - Prefixes with a machine-friendly identifier - - Note: Relies on Django's default_storage utility. """ upload_dir = 'image-attachments' default_filename = 'unnamed' @@ -92,22 +90,38 @@ def image_upload(instance, filename): # Rely on Django's get_valid_filename to perform sanitization. stem = (instance.name or file_path.stem).strip() try: - safe_stem = default_storage.get_valid_name(stem) + safe_stem = storage.get_valid_name(stem) except SuspiciousFileOperation: safe_stem = default_filename # Append the uploaded extension only if it's an allowed image type - final_name = f"{safe_stem}.{ext}" if ext in allowed_img_extensions else safe_stem + final_name = f'{safe_stem}.{ext}' if ext in allowed_img_extensions else safe_stem # Create a machine-friendly prefix from the instance - prefix = f"{instance.object_type.model}_{instance.object_id}" - name_with_path = f"{upload_dir}/{prefix}_{final_name}" + prefix = f'{instance.object_type.model}_{instance.object_id}' + name_with_path = f'{upload_dir}/{prefix}_{final_name}' # Validate the generated relative path (blocks absolute/traversal) validate_file_name(name_with_path, allow_relative_path=True) return name_with_path +def image_upload(instance, filename): + """ + Return a relative upload path for an image attachment, applying Django's + usual suffix-on-collision behavior regardless of storage backend. + """ + field = instance.image.field + name_with_path = _build_image_attachment_path(instance, filename, storage=field.storage) + + # Intentionally call Django's base Storage implementation here. Some + # backends override get_available_name() to reuse the incoming name + # unchanged, but we want Django's normal suffix-on-collision behavior + # while still dispatching exists() / get_alternative_name() to the + # configured storage instance. + return Storage.get_available_name(field.storage, name_with_path, max_length=field.max_length) + + def is_script(obj): """ Returns True if the object is a Script or Report. diff --git a/netbox/ipam/migrations/0089_default_ordering_indexes.py b/netbox/ipam/migrations/0089_default_ordering_indexes.py index 13a43f4de..a718aa3fc 100644 --- a/netbox/ipam/migrations/0089_default_ordering_indexes.py +++ b/netbox/ipam/migrations/0089_default_ordering_indexes.py @@ -4,7 +4,7 @@ from django.db import migrations, models class Migration(migrations.Migration): dependencies = [ ('contenttypes', '0002_remove_content_type_name'), - ('dcim', '0231_default_ordering_indexes'), + ('dcim', '0232_default_ordering_indexes'), ('extras', '0137_default_ordering_indexes'), ('ipam', '0088_rename_vlangroup_total_vlan_ids'), ('tenancy', '0023_add_mptt_tree_indexes'), diff --git a/netbox/ipam/tables/vlans.py b/netbox/ipam/tables/vlans.py index a4eb61015..0297a2e5a 100644 --- a/netbox/ipam/tables/vlans.py +++ b/netbox/ipam/tables/vlans.py @@ -251,6 +251,6 @@ class VLANTranslationRuleTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VLANTranslationRule fields = ( - 'pk', 'id', 'name', 'policy', 'local_vid', 'remote_vid', 'description', 'tags', 'created', 'last_updated', + 'pk', 'id', 'policy', 'local_vid', 'remote_vid', 'description', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'policy', 'local_vid', 'remote_vid', 'description') diff --git a/netbox/ipam/tests/test_tables.py b/netbox/ipam/tests/test_tables.py index 527da9677..5283b62f0 100644 --- a/netbox/ipam/tests/test_tables.py +++ b/netbox/ipam/tests/test_tables.py @@ -1,9 +1,10 @@ from django.test import RequestFactory, TestCase from netaddr import IPNetwork -from ipam.models import IPAddress, IPRange, Prefix -from ipam.tables import AnnotatedIPAddressTable +from ipam.models import FHRPGroupAssignment, IPAddress, IPRange, Prefix +from ipam.tables import * from ipam.utils import annotate_ip_space +from utilities.testing import TableTestCases class AnnotatedIPAddressTableTest(TestCase): @@ -168,3 +169,85 @@ class AnnotatedIPAddressTableTest(TestCase): # Pools are fully usable self.assertEqual(available.first_ip, '2001:db8:1::/126') self.assertEqual(available.size, 4) + + +# +# Table ordering tests +# + +class VRFTableTest(TableTestCases.StandardTableTestCase): + table = VRFTable + + +class RouteTargetTableTest(TableTestCases.StandardTableTestCase): + table = RouteTargetTable + + +class RIRTableTest(TableTestCases.StandardTableTestCase): + table = RIRTable + + +class AggregateTableTest(TableTestCases.StandardTableTestCase): + table = AggregateTable + + +class RoleTableTest(TableTestCases.StandardTableTestCase): + table = RoleTable + + +class PrefixTableTest(TableTestCases.StandardTableTestCase): + table = PrefixTable + + +class IPRangeTableTest(TableTestCases.StandardTableTestCase): + table = IPRangeTable + + +class IPAddressTableTest(TableTestCases.StandardTableTestCase): + table = IPAddressTable + + +class FHRPGroupTableTest(TableTestCases.StandardTableTestCase): + table = FHRPGroupTable + + +class FHRPGroupAssignmentTableTest(TableTestCases.StandardTableTestCase): + table = FHRPGroupAssignmentTable + + # No ObjectListView exists for this table; it is only rendered inline on + # the FHRPGroup detail view. Provide an explicit queryset source. + queryset_sources = [ + ('FHRPGroupAssignment.objects.all()', FHRPGroupAssignment.objects.all()), + ] + + +class VLANGroupTableTest(TableTestCases.StandardTableTestCase): + table = VLANGroupTable + + +class VLANTableTest(TableTestCases.StandardTableTestCase): + table = VLANTable + + +class VLANTranslationPolicyTableTest(TableTestCases.StandardTableTestCase): + table = VLANTranslationPolicyTable + + +class VLANTranslationRuleTableTest(TableTestCases.StandardTableTestCase): + table = VLANTranslationRuleTable + + +class ASNRangeTableTest(TableTestCases.StandardTableTestCase): + table = ASNRangeTable + + +class ASNTableTest(TableTestCases.StandardTableTestCase): + table = ASNTable + + +class ServiceTemplateTableTest(TableTestCases.StandardTableTestCase): + table = ServiceTemplateTable + + +class ServiceTableTest(TableTestCases.StandardTableTestCase): + table = ServiceTable diff --git a/netbox/netbox/api/serializers/base.py b/netbox/netbox/api/serializers/base.py index 0d149e81c..0f933ed5f 100644 --- a/netbox/netbox/api/serializers/base.py +++ b/netbox/netbox/api/serializers/base.py @@ -95,9 +95,6 @@ class ValidatedModelSerializer(BaseModelSerializer): attrs = data.copy() - # Remove custom field data (if any) prior to model validation - attrs.pop('custom_fields', None) - # Skip ManyToManyFields opts = self.Meta.model._meta m2m_values = {} @@ -116,4 +113,8 @@ class ValidatedModelSerializer(BaseModelSerializer): # Skip uniqueness validation of individual fields inside `full_clean()` (this is handled by the serializer) instance.full_clean(validate_unique=False) + # Preserve any normalization performed by model.clean() (e.g. stale custom field pruning) + if 'custom_field_data' in attrs: + data['custom_field_data'] = instance.custom_field_data + return data diff --git a/netbox/netbox/configuration_testing.py b/netbox/netbox/configuration_testing.py index 3e552e944..3ac9c2642 100644 --- a/netbox/netbox/configuration_testing.py +++ b/netbox/netbox/configuration_testing.py @@ -20,6 +20,10 @@ PLUGINS = [ 'netbox.tests.dummy_plugin', ] +RQ = { + 'COMMIT_MODE': 'auto', +} + REDIS = { 'tasks': { 'HOST': 'localhost', diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index 1c39d5b08..920c8e0c1 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -467,7 +467,7 @@ class JobsMixin(models.Model): """ Return a list of the most recent jobs for this instance. """ - return self.jobs.filter(status__in=JobStatusChoices.TERMINAL_STATE_CHOICES).order_by('-created').defer('data') + return self.jobs.filter(status__in=JobStatusChoices.TERMINAL_STATE_CHOICES).order_by('-started').defer('data') class JournalingMixin(models.Model): diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index c9eee6dfd..67ed887c2 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -168,6 +168,7 @@ REMOTE_AUTH_USER_FIRST_NAME = getattr(configuration, 'REMOTE_AUTH_USER_FIRST_NAM REMOTE_AUTH_USER_LAST_NAME = getattr(configuration, 'REMOTE_AUTH_USER_LAST_NAME', 'HTTP_REMOTE_USER_LAST_NAME') # Required by extras/migrations/0109_script_models.py REPORTS_ROOT = getattr(configuration, 'REPORTS_ROOT', os.path.join(BASE_DIR, 'reports')).rstrip('/') +RQ = getattr(configuration, 'RQ', {}) RQ_DEFAULT_TIMEOUT = getattr(configuration, 'RQ_DEFAULT_TIMEOUT', 300) RQ_RETRY_INTERVAL = getattr(configuration, 'RQ_RETRY_INTERVAL', 60) RQ_RETRY_MAX = getattr(configuration, 'RQ_RETRY_MAX', 0) diff --git a/netbox/netbox/ui/attrs.py b/netbox/netbox/ui/attrs.py index 83a7e912e..d5f066ddd 100644 --- a/netbox/netbox/ui/attrs.py +++ b/netbox/netbox/ui/attrs.py @@ -275,19 +275,22 @@ class RelatedObjectAttr(ObjectAttribute): linkify (bool): If True, the rendered value will be hyperlinked to the related object's detail view grouped_by (str): A second-order object to annotate alongside the related object; for example, an attribute representing the dcim.Site model might specify grouped_by="region" + colored (bool): If True, render the object as a colored badge when it exposes a `color` attribute """ template_name = 'ui/attrs/object.html' - def __init__(self, *args, linkify=None, grouped_by=None, **kwargs): + def __init__(self, *args, linkify=None, grouped_by=None, colored=False, **kwargs): super().__init__(*args, **kwargs) self.linkify = linkify self.grouped_by = grouped_by + self.colored = colored def get_context(self, obj, attr, value, context): group = getattr(value, self.grouped_by, None) if self.grouped_by else None return { 'linkify': self.linkify, 'group': group, + 'colored': self.colored, } @@ -344,6 +347,7 @@ class RelatedObjectListAttr(RelatedObjectAttr): return { 'linkify': self.linkify, + 'colored': self.colored, 'items': [ { 'value': item, @@ -376,13 +380,15 @@ class NestedObjectAttr(ObjectAttribute): Parameters: linkify (bool): If True, the rendered value will be hyperlinked to the related object's detail view max_depth (int): Maximum number of ancestors to display (default: all) + colored (bool): If True, render the object as a colored badge when it exposes a `color` attribute """ template_name = 'ui/attrs/nested_object.html' - def __init__(self, *args, linkify=None, max_depth=None, **kwargs): + def __init__(self, *args, linkify=None, max_depth=None, colored=False, **kwargs): super().__init__(*args, **kwargs) self.linkify = linkify self.max_depth = max_depth + self.colored = colored def get_context(self, obj, attr, value, context): nodes = [] @@ -393,6 +399,7 @@ class NestedObjectAttr(ObjectAttribute): return { 'nodes': nodes, 'linkify': self.linkify, + 'colored': self.colored, } diff --git a/netbox/release.yaml b/netbox/release.yaml index 10dd40164..0aeeebac8 100644 --- a/netbox/release.yaml +++ b/netbox/release.yaml @@ -1,3 +1,3 @@ -version: "4.5.6" +version: "4.5.7" edition: "Community" -published: "2026-03-31" +published: "2026-04-03" diff --git a/netbox/templates/extras/inc/script_list_content.html b/netbox/templates/extras/inc/script_list_content.html index 783d6eac1..ed30e423d 100644 --- a/netbox/templates/extras/inc/script_list_content.html +++ b/netbox/templates/extras/inc/script_list_content.html @@ -11,7 +11,7 @@

{{ module }}
- {% if perms.extras.edit_scriptmodule %} + {% if perms.extras.change_scriptmodule %} {% trans "Edit" %} @@ -54,7 +54,7 @@ {{ script.python_class.description|markdown|placeholder }} {% if last_job %} - {{ last_job.created|isodatetime }} + {{ last_job.started|isodatetime }} {% badge last_job.get_status_display last_job.get_status_color %} diff --git a/netbox/templates/ui/attrs/nested_object.html b/netbox/templates/ui/attrs/nested_object.html index 8cae08189..5d7e52d2d 100644 --- a/netbox/templates/ui/attrs/nested_object.html +++ b/netbox/templates/ui/attrs/nested_object.html @@ -1,7 +1,15 @@
    {% for node in nodes %}
  1. - {% if linkify %} + {% if forloop.last and colored and node.color %} + {% if linkify %} + {% with badge_url=node.get_absolute_url %} + {% badge node hex_color=node.color url=badge_url %} + {% endwith %} + {% else %} + {% badge node hex_color=node.color %} + {% endif %} + {% elif linkify %} {{ node }} {% else %} {{ node }} diff --git a/netbox/templates/ui/attrs/object.html b/netbox/templates/ui/attrs/object.html index 58fce2316..2c4b02208 100644 --- a/netbox/templates/ui/attrs/object.html +++ b/netbox/templates/ui/attrs/object.html @@ -5,10 +5,34 @@ {% if linkify %}{{ group|linkify }}{% else %}{{ group }}{% endif %}
  2. - {% if linkify %}{{ value|linkify }}{% else %}{{ value }}{% endif %} + {% if colored and value.color %} + {% if linkify %} + {% with badge_url=value.get_absolute_url %} + {% badge value hex_color=value.color url=badge_url %} + {% endwith %} + {% else %} + {% badge value hex_color=value.color %} + {% endif %} + {% elif linkify %} + {{ value|linkify }} + {% else %} + {{ value }} + {% endif %}
{% else %} {# Display only the object #} - {% if linkify %}{{ value|linkify }}{% else %}{{ value }}{% endif %} + {% if colored and value.color %} + {% if linkify %} + {% with badge_url=value.get_absolute_url %} + {% badge value hex_color=value.color url=badge_url %} + {% endwith %} + {% else %} + {% badge value hex_color=value.color %} + {% endif %} + {% elif linkify %} + {{ value|linkify }} + {% else %} + {{ value }} + {% endif %} {% endif %} diff --git a/netbox/templates/ui/attrs/object_list.html b/netbox/templates/ui/attrs/object_list.html index 6daf3fcf2..58eaf2908 100644 --- a/netbox/templates/ui/attrs/object_list.html +++ b/netbox/templates/ui/attrs/object_list.html @@ -1,7 +1,7 @@