- The premiere source of truth powering network automation
+The premier source of truth powering network automation
- The premiere source of truth powering network automation
+The premier source of truth powering network automation
00ff00'),
+ }
class CircuitImportForm(NetBoxModelImportForm):
diff --git a/netbox/circuits/forms/filtersets.py b/netbox/circuits/forms/filtersets.py
index 1fb239023..1e1abd068 100644
--- a/netbox/circuits/forms/filtersets.py
+++ b/netbox/circuits/forms/filtersets.py
@@ -7,7 +7,7 @@ from dcim.models import Region, Site, SiteGroup
from ipam.models import ASN
from netbox.forms import NetBoxModelFilterSetForm
from tenancy.forms import TenancyFilterForm, ContactModelFilterForm
-from utilities.forms.fields import DynamicModelMultipleChoiceField, TagFilterField
+from utilities.forms.fields import ColorField, DynamicModelMultipleChoiceField, TagFilterField
from utilities.forms.widgets import DatePicker, NumberWithOptions
__all__ = (
@@ -88,7 +88,7 @@ class ProviderNetworkFilterForm(NetBoxModelFilterSetForm):
label=_('Provider')
)
service_id = forms.CharField(
- label=_('Service id'),
+ label=_('Service ID'),
max_length=100,
required=False
)
@@ -97,8 +97,17 @@ class ProviderNetworkFilterForm(NetBoxModelFilterSetForm):
class CircuitTypeFilterForm(NetBoxModelFilterSetForm):
model = CircuitType
+ fieldsets = (
+ (None, ('q', 'filter_id', 'tag')),
+ (_('Attributes'), ('color',)),
+ )
tag = TagFilterField(model)
+ color = ColorField(
+ label=_('Color'),
+ required=False
+ )
+
class CircuitFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFilterSetForm):
model = Circuit
@@ -110,6 +119,7 @@ class CircuitFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi
(_('Tenant'), ('tenant_group_id', 'tenant_id')),
(_('Contacts'), ('contact', 'contact_role', 'contact_group')),
)
+ selector_fields = ('filter_id', 'q', 'region_id', 'site_group_id', 'site_id', 'provider_id', 'provider_network_id')
type_id = DynamicModelMultipleChoiceField(
queryset=CircuitType.objects.all(),
required=False,
diff --git a/netbox/circuits/forms/model_forms.py b/netbox/circuits/forms/model_forms.py
index 8a540032e..0809cb2f4 100644
--- a/netbox/circuits/forms/model_forms.py
+++ b/netbox/circuits/forms/model_forms.py
@@ -76,14 +76,14 @@ class CircuitTypeForm(NetBoxModelForm):
fieldsets = (
(_('Circuit Type'), (
- 'name', 'slug', 'description', 'tags',
+ 'name', 'slug', 'color', 'description', 'tags',
)),
)
class Meta:
model = CircuitType
fields = [
- 'name', 'slug', 'description', 'tags',
+ 'name', 'slug', 'color', 'description', 'tags',
]
diff --git a/netbox/circuits/graphql/types.py b/netbox/circuits/graphql/types.py
index 33cb5749d..fc33a81a7 100644
--- a/netbox/circuits/graphql/types.py
+++ b/netbox/circuits/graphql/types.py
@@ -64,7 +64,8 @@ class CircuitType(NetBoxObjectType, ContactsMixin):
@strawberry.django.type(
models.CircuitType,
- fields='__all__',
+ # fields='__all__',
+ exclude=['color',], # bug - remove color from exclude
filters=CircuitTypeFilter
)
class CircuitTypeType(OrganizationalObjectType):
diff --git a/netbox/circuits/migrations/0043_circuittype_color.py b/netbox/circuits/migrations/0043_circuittype_color.py
new file mode 100644
index 000000000..6c4dffeb6
--- /dev/null
+++ b/netbox/circuits/migrations/0043_circuittype_color.py
@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-20 21:25
+
+from django.db import migrations
+import utilities.fields
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('circuits', '0042_provideraccount'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='circuittype',
+ name='color',
+ field=utilities.fields.ColorField(blank=True, max_length=6),
+ ),
+ ]
diff --git a/netbox/circuits/models/circuits.py b/netbox/circuits/models/circuits.py
index 0322b67c6..4dc775364 100644
--- a/netbox/circuits/models/circuits.py
+++ b/netbox/circuits/models/circuits.py
@@ -7,6 +7,7 @@ from circuits.choices import *
from dcim.models import CabledObjectModel
from netbox.models import ChangeLoggedModel, OrganizationalModel, PrimaryModel
from netbox.models.features import ContactsMixin, CustomFieldsMixin, CustomLinksMixin, ImageAttachmentsMixin, TagsMixin
+from utilities.fields import ColorField
__all__ = (
'Circuit',
@@ -20,6 +21,11 @@ class CircuitType(OrganizationalModel):
Circuits can be organized by their functional role. For example, a user might wish to define CircuitTypes named
"Long Haul," "Metro," or "Out-of-Band".
"""
+ color = ColorField(
+ verbose_name=_('color'),
+ blank=True
+ )
+
def get_absolute_url(self):
return reverse('circuits:circuittype', args=[self.pk])
diff --git a/netbox/circuits/search.py b/netbox/circuits/search.py
index b80f92d4d..c22b400eb 100644
--- a/netbox/circuits/search.py
+++ b/netbox/circuits/search.py
@@ -10,6 +10,7 @@ class CircuitIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('provider', 'provider_account', 'type', 'status', 'tenant', 'description')
@register_search
@@ -22,6 +23,7 @@ class CircuitTerminationIndex(SearchIndex):
('port_speed', 2000),
('upstream_speed', 2000),
)
+ display_attrs = ('circuit', 'site', 'provider_network', 'description')
@register_search
@@ -32,6 +34,7 @@ class CircuitTypeIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('description',)
@register_search
@@ -42,6 +45,7 @@ class ProviderIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('description',)
class ProviderAccountIndex(SearchIndex):
@@ -51,6 +55,7 @@ class ProviderAccountIndex(SearchIndex):
('account', 200),
('comments', 5000),
)
+ display_attrs = ('provider', 'account', 'description')
@register_search
@@ -62,3 +67,4 @@ class ProviderNetworkIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('provider', 'service_id', 'description')
diff --git a/netbox/circuits/tables/circuits.py b/netbox/circuits/tables/circuits.py
index 6a05983e6..6ae727eca 100644
--- a/netbox/circuits/tables/circuits.py
+++ b/netbox/circuits/tables/circuits.py
@@ -28,6 +28,7 @@ class CircuitTypeTable(NetBoxTable):
linkify=True,
verbose_name=_('Name'),
)
+ color = columns.ColorColumn()
tags = columns.TagColumn(
url_name='circuits:circuittype_list'
)
@@ -40,7 +41,7 @@ class CircuitTypeTable(NetBoxTable):
class Meta(NetBoxTable.Meta):
model = CircuitType
fields = (
- 'pk', 'id', 'name', 'circuit_count', 'description', 'slug', 'tags', 'created', 'last_updated', 'actions',
+ 'pk', 'id', 'name', 'circuit_count', 'color', 'description', 'slug', 'tags', 'created', 'last_updated', 'actions',
)
default_columns = ('pk', 'name', 'circuit_count', 'description', 'slug')
diff --git a/netbox/circuits/tests/test_filtersets.py b/netbox/circuits/tests/test_filtersets.py
index e3380a1e5..6553179ec 100644
--- a/netbox/circuits/tests/test_filtersets.py
+++ b/netbox/circuits/tests/test_filtersets.py
@@ -25,8 +25,8 @@ class ProviderTestCase(TestCase, ChangeLoggedFilterSetTests):
ASN.objects.bulk_create(asns)
providers = (
- Provider(name='Provider 1', slug='provider-1'),
- Provider(name='Provider 2', slug='provider-2'),
+ Provider(name='Provider 1', slug='provider-1', description='foobar1'),
+ Provider(name='Provider 2', slug='provider-2', description='foobar2'),
Provider(name='Provider 3', slug='provider-3'),
Provider(name='Provider 4', slug='provider-4'),
Provider(name='Provider 5', slug='provider-5'),
@@ -74,6 +74,10 @@ class ProviderTestCase(TestCase, ChangeLoggedFilterSetTests):
CircuitTermination(circuit=circuits[1], site=sites[0], term_side='A'),
))
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Provider 1', 'Provider 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -82,6 +86,10 @@ class ProviderTestCase(TestCase, ChangeLoggedFilterSetTests):
params = {'slug': ['provider-1', 'provider-2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
def test_asn_id(self): # ASN object assignment
asns = ASN.objects.all()[:2]
params = {'asn_id': [asns[0].pk, asns[1].pk]}
@@ -122,6 +130,10 @@ class CircuitTypeTestCase(TestCase, ChangeLoggedFilterSetTests):
CircuitType(name='Circuit Type 3', slug='circuit-type-3'),
))
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Circuit Type 1']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
@@ -227,6 +239,10 @@ class CircuitTestCase(TestCase, ChangeLoggedFilterSetTests):
))
CircuitTermination.objects.bulk_create(circuit_terminations)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_cid(self):
params = {'cid': ['Test Circuit 1', 'Test Circuit 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -369,6 +385,10 @@ class CircuitTerminationTestCase(TestCase, ChangeLoggedFilterSetTests):
Cable(a_terminations=[circuit_terminations[0]], b_terminations=[circuit_terminations[1]]).save()
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_term_side(self):
params = {'term_side': 'A'}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 7)
@@ -440,6 +460,10 @@ class ProviderNetworkTestCase(TestCase, ChangeLoggedFilterSetTests):
)
ProviderNetwork.objects.bulk_create(provider_networks)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Provider Network 1', 'Provider Network 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -477,6 +501,10 @@ class ProviderAccountTestCase(TestCase, ChangeLoggedFilterSetTests):
)
ProviderAccount.objects.bulk_create(provider_accounts)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Provider Account 1', 'Provider Account 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/core/api/serializers.py b/netbox/core/api/serializers.py
index 4117a609c..4ae426df5 100644
--- a/netbox/core/api/serializers.py
+++ b/netbox/core/api/serializers.py
@@ -4,6 +4,7 @@ from core.choices import *
from core.models import *
from netbox.api.fields import ChoiceField, ContentTypeField
from netbox.api.serializers import BaseModelSerializer, NetBoxModelSerializer
+from netbox.utils import get_data_backend_choices
from users.api.nested_serializers import NestedUserSerializer
from .nested_serializers import *
@@ -19,7 +20,7 @@ class DataSourceSerializer(NetBoxModelSerializer):
view_name='core-api:datasource-detail'
)
type = ChoiceField(
- choices=DataSourceTypeChoices
+ choices=get_data_backend_choices()
)
status = ChoiceField(
choices=DataSourceStatusChoices,
@@ -68,5 +69,5 @@ class JobSerializer(BaseModelSerializer):
model = Job
fields = [
'id', 'url', 'display', 'object_type', 'object_id', 'name', 'status', 'created', 'scheduled', 'interval',
- 'started', 'completed', 'user', 'data', 'job_id',
+ 'started', 'completed', 'user', 'data', 'error', 'job_id',
]
diff --git a/netbox/core/apps.py b/netbox/core/apps.py
index ffcf0b4ea..2d999c57e 100644
--- a/netbox/core/apps.py
+++ b/netbox/core/apps.py
@@ -1,4 +1,15 @@
from django.apps import AppConfig
+from django.db import models
+from django.db.migrations.operations import AlterModelOptions
+
+from utilities.migration import custom_deconstruct
+
+# Ignore verbose_name & verbose_name_plural Meta options when calculating model migrations
+AlterModelOptions.ALTER_OPTION_KEYS.remove('verbose_name')
+AlterModelOptions.ALTER_OPTION_KEYS.remove('verbose_name_plural')
+
+# Use our custom destructor to ignore certain attributes when calculating field migrations
+models.Field.deconstruct = custom_deconstruct
class CoreConfig(AppConfig):
diff --git a/netbox/core/choices.py b/netbox/core/choices.py
index 0067dfed8..8d7050414 100644
--- a/netbox/core/choices.py
+++ b/netbox/core/choices.py
@@ -7,18 +7,6 @@ from utilities.choices import ChoiceSet
# Data sources
#
-class DataSourceTypeChoices(ChoiceSet):
- LOCAL = 'local'
- GIT = 'git'
- AMAZON_S3 = 'amazon-s3'
-
- CHOICES = (
- (LOCAL, _('Local'), 'gray'),
- (GIT, _('Git'), 'blue'),
- (AMAZON_S3, _('Amazon S3'), 'blue'),
- )
-
-
class DataSourceStatusChoices(ChoiceSet):
NEW = 'new'
QUEUED = 'queued'
diff --git a/netbox/core/data_backends.py b/netbox/core/data_backends.py
index d947602a6..9ff0b4d63 100644
--- a/netbox/core/data_backends.py
+++ b/netbox/core/data_backends.py
@@ -10,61 +10,24 @@ from django import forms
from django.conf import settings
from django.utils.translation import gettext as _
-from netbox.registry import registry
-from .choices import DataSourceTypeChoices
+from netbox.data_backends import DataBackend
+from netbox.utils import register_data_backend
from .exceptions import SyncError
__all__ = (
- 'LocalBackend',
'GitBackend',
+ 'LocalBackend',
'S3Backend',
)
logger = logging.getLogger('netbox.data_backends')
-def register_backend(name):
- """
- Decorator for registering a DataBackend class.
- """
-
- def _wrapper(cls):
- registry['data_backends'][name] = cls
- return cls
-
- return _wrapper
-
-
-class DataBackend:
- parameters = {}
- sensitive_parameters = []
-
- # Prevent Django's template engine from calling the backend
- # class when referenced via DataSource.backend_class
- do_not_call_in_templates = True
-
- def __init__(self, url, **kwargs):
- self.url = url
- self.params = kwargs
- self.config = self.init_config()
-
- def init_config(self):
- """
- Hook to initialize the instance's configuration.
- """
- return
-
- @property
- def url_scheme(self):
- return urlparse(self.url).scheme.lower()
-
- @contextmanager
- def fetch(self):
- raise NotImplemented()
-
-
-@register_backend(DataSourceTypeChoices.LOCAL)
+@register_data_backend()
class LocalBackend(DataBackend):
+ name = 'local'
+ label = _('Local')
+ is_local = True
@contextmanager
def fetch(self):
@@ -74,20 +37,22 @@ class LocalBackend(DataBackend):
yield local_path
-@register_backend(DataSourceTypeChoices.GIT)
+@register_data_backend()
class GitBackend(DataBackend):
+ name = 'git'
+ label = 'Git'
parameters = {
'username': forms.CharField(
required=False,
label=_('Username'),
widget=forms.TextInput(attrs={'class': 'form-control'}),
- help_text=_("Only used for cloning with HTTP / HTTPS"),
+ help_text=_("Only used for cloning with HTTP(S)"),
),
'password': forms.CharField(
required=False,
label=_('Password'),
widget=forms.TextInput(attrs={'class': 'form-control'}),
- help_text=_("Only used for cloning with HTTP / HTTPS"),
+ help_text=_("Only used for cloning with HTTP(S)"),
),
'branch': forms.CharField(
required=False,
@@ -125,12 +90,13 @@ class GitBackend(DataBackend):
}
if self.url_scheme in ('http', 'https'):
- clone_args.update(
- {
- "username": self.params.get('username'),
- "password": self.params.get('password'),
- }
- )
+ if self.params.get('username'):
+ clone_args.update(
+ {
+ "username": self.params.get('username'),
+ "password": self.params.get('password'),
+ }
+ )
logger.debug(f"Cloning git repo: {self.url}")
try:
@@ -143,8 +109,10 @@ class GitBackend(DataBackend):
local_path.cleanup()
-@register_backend(DataSourceTypeChoices.AMAZON_S3)
+@register_data_backend()
class S3Backend(DataBackend):
+ name = 'amazon-s3'
+ label = 'Amazon S3'
parameters = {
'aws_access_key_id': forms.CharField(
label=_('AWS access key ID'),
diff --git a/netbox/core/filtersets.py b/netbox/core/filtersets.py
index 62a58086a..902e240ee 100644
--- a/netbox/core/filtersets.py
+++ b/netbox/core/filtersets.py
@@ -4,10 +4,12 @@ from django.utils.translation import gettext as _
import django_filters
from netbox.filtersets import BaseFilterSet, ChangeLoggedModelFilterSet, NetBoxModelFilterSet
+from netbox.utils import get_data_backend_choices
from .choices import *
from .models import *
__all__ = (
+ 'ConfigRevisionFilterSet',
'DataFileFilterSet',
'DataSourceFilterSet',
'JobFilterSet',
@@ -16,7 +18,7 @@ __all__ = (
class DataSourceFilterSet(NetBoxModelFilterSet):
type = django_filters.MultipleChoiceFilter(
- choices=DataSourceTypeChoices,
+ choices=get_data_backend_choices,
null_value=None
)
status = django_filters.MultipleChoiceFilter(
@@ -26,7 +28,7 @@ class DataSourceFilterSet(NetBoxModelFilterSet):
class Meta:
model = DataSource
- fields = ('id', 'name', 'enabled')
+ fields = ('id', 'name', 'enabled', 'description')
def search(self, queryset, name, value):
if not value.strip():
@@ -122,3 +124,23 @@ class JobFilterSet(BaseFilterSet):
Q(user__username__icontains=value) |
Q(name__icontains=value)
)
+
+
+class ConfigRevisionFilterSet(BaseFilterSet):
+ q = django_filters.CharFilter(
+ method='search',
+ label=_('Search'),
+ )
+
+ class Meta:
+ model = ConfigRevision
+ fields = [
+ 'id',
+ ]
+
+ def search(self, queryset, name, value):
+ if not value.strip():
+ return queryset
+ return queryset.filter(
+ Q(comment__icontains=value)
+ )
diff --git a/netbox/core/forms/bulk_edit.py b/netbox/core/forms/bulk_edit.py
index a4ecd646f..dcc92c6f0 100644
--- a/netbox/core/forms/bulk_edit.py
+++ b/netbox/core/forms/bulk_edit.py
@@ -1,10 +1,9 @@
from django import forms
from django.utils.translation import gettext_lazy as _
-from core.choices import DataSourceTypeChoices
from core.models import *
from netbox.forms import NetBoxModelBulkEditForm
-from utilities.forms import add_blank_choice
+from netbox.utils import get_data_backend_choices
from utilities.forms.fields import CommentField
from utilities.forms.widgets import BulkEditNullBooleanSelect
@@ -16,9 +15,8 @@ __all__ = (
class DataSourceBulkEditForm(NetBoxModelBulkEditForm):
type = forms.ChoiceField(
label=_('Type'),
- choices=add_blank_choice(DataSourceTypeChoices),
- required=False,
- initial=''
+ choices=get_data_backend_choices,
+ required=False
)
enabled = forms.NullBooleanField(
required=False,
diff --git a/netbox/core/forms/filtersets.py b/netbox/core/forms/filtersets.py
index f7a6f3595..f21bd3f87 100644
--- a/netbox/core/forms/filtersets.py
+++ b/netbox/core/forms/filtersets.py
@@ -1,18 +1,18 @@
from django import forms
from django.contrib.auth import get_user_model
-from django.contrib.contenttypes.models import ContentType
from django.utils.translation import gettext_lazy as _
from core.choices import *
from core.models import *
-from extras.forms.mixins import SavedFiltersMixin
-from extras.utils import FeatureQuery
from netbox.forms import NetBoxModelFilterSetForm
+from netbox.forms.mixins import SavedFiltersMixin
+from netbox.utils import get_data_backend_choices
from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, FilterForm
from utilities.forms.fields import ContentTypeChoiceField, DynamicModelMultipleChoiceField
from utilities.forms.widgets import APISelectMultiple, DateTimePicker
__all__ = (
+ 'ConfigRevisionFilterForm',
'DataFileFilterForm',
'DataSourceFilterForm',
'JobFilterForm',
@@ -27,7 +27,7 @@ class DataSourceFilterForm(NetBoxModelFilterSetForm):
)
type = forms.MultipleChoiceField(
label=_('Type'),
- choices=DataSourceTypeChoices,
+ choices=get_data_backend_choices,
required=False
)
status = forms.MultipleChoiceField(
@@ -68,7 +68,7 @@ class JobFilterForm(SavedFiltersMixin, FilterForm):
)
object_type = ContentTypeChoiceField(
label=_('Object Type'),
- queryset=ContentType.objects.filter(FeatureQuery('jobs').get_query()),
+ queryset=ContentType.objects.with_feature('jobs'),
required=False,
)
status = forms.MultipleChoiceField(
@@ -124,3 +124,9 @@ class JobFilterForm(SavedFiltersMixin, FilterForm):
api_url='/api/users/users/',
)
)
+
+
+class ConfigRevisionFilterForm(SavedFiltersMixin, FilterForm):
+ fieldsets = (
+ (None, ('q', 'filter_id')),
+ )
diff --git a/netbox/core/forms/model_forms.py b/netbox/core/forms/model_forms.py
index 01d5474c6..652728734 100644
--- a/netbox/core/forms/model_forms.py
+++ b/netbox/core/forms/model_forms.py
@@ -1,23 +1,34 @@
import copy
+import json
from django import forms
+from django.conf import settings
from django.utils.translation import gettext_lazy as _
from core.forms.mixins import SyncedDataMixin
from core.models import *
+from netbox.config import get_config, PARAMS
from netbox.forms import NetBoxModelForm
from netbox.registry import registry
-from utilities.forms import get_field_value
+from netbox.utils import get_data_backend_choices
+from utilities.forms import BootstrapMixin, get_field_value
from utilities.forms.fields import CommentField
from utilities.forms.widgets import HTMXSelect
__all__ = (
+ 'ConfigRevisionForm',
'DataSourceForm',
'ManagedFileForm',
)
+EMPTY_VALUES = ('', None, [], ())
+
class DataSourceForm(NetBoxModelForm):
+ type = forms.ChoiceField(
+ choices=get_data_backend_choices,
+ widget=HTMXSelect()
+ )
comments = CommentField()
class Meta:
@@ -26,7 +37,6 @@ class DataSourceForm(NetBoxModelForm):
'name', 'type', 'source_url', 'enabled', 'description', 'comments', 'ignore_rules', 'tags',
]
widgets = {
- 'type': HTMXSelect(),
'ignore_rules': forms.Textarea(
attrs={
'rows': 5,
@@ -56,12 +66,13 @@ class DataSourceForm(NetBoxModelForm):
# Add backend-specific form fields
self.backend_fields = []
- for name, form_field in backend.parameters.items():
- field_name = f'backend_{name}'
- self.backend_fields.append(field_name)
- self.fields[field_name] = copy.copy(form_field)
- if self.instance and self.instance.parameters:
- self.fields[field_name].initial = self.instance.parameters.get(name)
+ if backend:
+ for name, form_field in backend.parameters.items():
+ field_name = f'backend_{name}'
+ self.backend_fields.append(field_name)
+ self.fields[field_name] = copy.copy(form_field)
+ if self.instance and self.instance.parameters:
+ self.fields[field_name].initial = self.instance.parameters.get(name)
def save(self, *args, **kwargs):
@@ -106,3 +117,113 @@ class ManagedFileForm(SyncedDataMixin, NetBoxModelForm):
new_file.write(self.cleaned_data['upload_file'].read())
return super().save(*args, **kwargs)
+
+
+class ConfigFormMetaclass(forms.models.ModelFormMetaclass):
+
+ def __new__(mcs, name, bases, attrs):
+
+ # Emulate a declared field for each supported configuration parameter
+ param_fields = {}
+ for param in PARAMS:
+ field_kwargs = {
+ 'required': False,
+ 'label': param.label,
+ 'help_text': param.description,
+ }
+ field_kwargs.update(**param.field_kwargs)
+ param_fields[param.name] = param.field(**field_kwargs)
+ attrs.update(param_fields)
+
+ return super().__new__(mcs, name, bases, attrs)
+
+
+class ConfigRevisionForm(BootstrapMixin, forms.ModelForm, metaclass=ConfigFormMetaclass):
+ """
+ Form for creating a new ConfigRevision.
+ """
+
+ fieldsets = (
+ (_('Rack Elevations'), ('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH')),
+ (_('Power'), ('POWERFEED_DEFAULT_VOLTAGE', 'POWERFEED_DEFAULT_AMPERAGE', 'POWERFEED_DEFAULT_MAX_UTILIZATION')),
+ (_('IPAM'), ('ENFORCE_GLOBAL_UNIQUE', 'PREFER_IPV4')),
+ (_('Security'), ('ALLOWED_URL_SCHEMES',)),
+ (_('Banners'), ('BANNER_LOGIN', 'BANNER_MAINTENANCE', 'BANNER_TOP', 'BANNER_BOTTOM')),
+ (_('Pagination'), ('PAGINATE_COUNT', 'MAX_PAGE_SIZE')),
+ (_('Validation'), ('CUSTOM_VALIDATORS', 'PROTECTION_RULES')),
+ (_('User Preferences'), ('DEFAULT_USER_PREFERENCES',)),
+ (_('Miscellaneous'), (
+ 'MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOB_RETENTION', 'MAPS_URL',
+ )),
+ (_('Config Revision'), ('comment',))
+ )
+
+ class Meta:
+ model = ConfigRevision
+ fields = '__all__'
+ widgets = {
+ 'BANNER_LOGIN': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'BANNER_MAINTENANCE': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'BANNER_TOP': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'BANNER_BOTTOM': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'CUSTOM_VALIDATORS': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'PROTECTION_RULES': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'comment': forms.Textarea(),
+ }
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+
+ # Append current parameter values to form field help texts and check for static configurations
+ config = get_config()
+ for param in PARAMS:
+ value = getattr(config, param.name)
+
+ # Set the field's initial value, if it can be serialized. (This may not be the case e.g. for
+ # CUSTOM_VALIDATORS, which may reference Python objects.)
+ try:
+ json.dumps(value)
+ if type(value) in (tuple, list):
+ self.fields[param.name].initial = ', '.join(value)
+ else:
+ self.fields[param.name].initial = value
+ except TypeError:
+ pass
+
+ # Check whether this parameter is statically configured (e.g. in configuration.py)
+ if hasattr(settings, param.name):
+ self.fields[param.name].disabled = True
+ self.fields[param.name].help_text = _(
+ 'This parameter has been defined statically and cannot be modified.'
+ )
+ continue
+
+ # Set the field's help text
+ help_text = self.fields[param.name].help_text
+ if help_text:
+ help_text += '00ff00)')),
+ 'color': mark_safe(_('RGB color in hexadecimal. Example:') + ' 00ff00'),
}
@@ -333,8 +335,8 @@ class DeviceTypeImportForm(NetBoxModelImportForm):
class Meta:
model = DeviceType
fields = [
- 'manufacturer', 'default_platform', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth',
- 'subdevice_role', 'airflow', 'description', 'weight', 'weight_unit', 'comments', 'tags',
+ 'manufacturer', 'default_platform', 'model', 'slug', 'part_number', 'u_height', 'exclude_from_utilization',
+ 'is_full_depth', 'subdevice_role', 'airflow', 'description', 'weight', 'weight_unit', 'comments', 'tags',
]
@@ -375,7 +377,7 @@ class DeviceRoleImportForm(NetBoxModelImportForm):
model = DeviceRole
fields = ('name', 'slug', 'color', 'vm_role', 'config_template', 'description', 'tags')
help_texts = {
- 'color': mark_safe(_('RGB color in hexadecimal (e.g. 00ff00)')),
+ 'color': mark_safe(_('RGB color in hexadecimal. Example:') + ' 00ff00'),
}
@@ -547,9 +549,9 @@ class DeviceImportForm(BaseDeviceImportForm):
params = {
f"site__{self.fields['site'].to_field_name}": data.get('site'),
}
- if 'location' in data:
+ if location := data.get('location'):
params.update({
- f"location__{self.fields['location'].to_field_name}": data.get('location'),
+ f"location__{self.fields['location'].to_field_name}": location,
})
self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params)
@@ -790,7 +792,9 @@ class InterfaceImportForm(NetBoxModelImportForm):
queryset=VirtualDeviceContext.objects.all(),
required=False,
to_field_name='name',
- help_text=_('VDC names separated by commas, encased with double quotes (e.g. "vdc1, vdc2, vdc3")')
+ help_text=mark_safe(
+ _('VDC names separated by commas, encased with double quotes. Example:') + ' vdc1,vdc2,vdc3'
+ )
)
type = CSVChoiceField(
label=_('Type'),
@@ -1085,7 +1089,7 @@ class InventoryItemRoleImportForm(NetBoxModelImportForm):
model = InventoryItemRole
fields = ('name', 'slug', 'color', 'description')
help_texts = {
- 'color': mark_safe(_('RGB color in hexadecimal (e.g. 00ff00)')),
+ 'color': mark_safe(_('RGB color in hexadecimal. Example:') + ' 00ff00'),
}
@@ -1096,38 +1100,38 @@ class InventoryItemRoleImportForm(NetBoxModelImportForm):
class CableImportForm(NetBoxModelImportForm):
# Termination A
side_a_device = CSVModelChoiceField(
- label=_('Side a device'),
+ label=_('Side A device'),
queryset=Device.objects.all(),
to_field_name='name',
- help_text=_('Side A device')
+ help_text=_('Device name')
)
side_a_type = CSVContentTypeField(
- label=_('Side a type'),
+ label=_('Side A type'),
queryset=ContentType.objects.all(),
limit_choices_to=CABLE_TERMINATION_MODELS,
- help_text=_('Side A type')
+ help_text=_('Termination type')
)
side_a_name = forms.CharField(
- label=_('Side a name'),
- help_text=_('Side A component name')
+ label=_('Side A name'),
+ help_text=_('Termination name')
)
# Termination B
side_b_device = CSVModelChoiceField(
- label=_('Side b device'),
+ label=_('Side B device'),
queryset=Device.objects.all(),
to_field_name='name',
- help_text=_('Side B device')
+ help_text=_('Device name')
)
side_b_type = CSVContentTypeField(
- label=_('Side b type'),
+ label=_('Side B type'),
queryset=ContentType.objects.all(),
limit_choices_to=CABLE_TERMINATION_MODELS,
- help_text=_('Side B type')
+ help_text=_('Termination type')
)
side_b_name = forms.CharField(
- label=_('Side b name'),
- help_text=_('Side B component name')
+ label=_('Side B name'),
+ help_text=_('Termination name')
)
# Cable attributes
@@ -1164,7 +1168,7 @@ class CableImportForm(NetBoxModelImportForm):
'status', 'tenant', 'label', 'color', 'length', 'length_unit', 'description', 'comments', 'tags',
]
help_texts = {
- 'color': mark_safe(_('RGB color in hexadecimal (e.g. 00ff00)')),
+ 'color': mark_safe(_('RGB color in hexadecimal. Example:') + ' 00ff00'),
}
def _clean_side(self, side):
@@ -1188,7 +1192,7 @@ class CableImportForm(NetBoxModelImportForm):
termination_object = model.objects.get(device__in=device.virtual_chassis.members.all(), name=name)
else:
termination_object = model.objects.get(device=device, name=name)
- if termination_object.cable is not None:
+ if termination_object.cable is not None and termination_object.cable != self.instance:
raise forms.ValidationError(f"Side {side.upper()}: {device} {termination_object} is already connected")
except ObjectDoesNotExist:
raise forms.ValidationError(f"{side.upper()} side termination not found: {device} {name}")
diff --git a/netbox/dcim/forms/common.py b/netbox/dcim/forms/common.py
index 77543af12..3be4d08e8 100644
--- a/netbox/dcim/forms/common.py
+++ b/netbox/dcim/forms/common.py
@@ -116,17 +116,17 @@ class ModuleCommonForm(forms.Form):
# It is not possible to adopt components already belonging to a module
if adopt_components and existing_item and existing_item.module:
raise forms.ValidationError(
- _("Cannot adopt {name} '{resolved_name}' as it already belongs to a module").format(
- name=template.component_model.__name__,
- resolved_name=resolved_name
+ _("Cannot adopt {model} {name} as it already belongs to a module").format(
+ model=template.component_model.__name__,
+ name=resolved_name
)
)
# If we are not adopting components we error if the component exists
if not adopt_components and resolved_name in installed_components:
raise forms.ValidationError(
- _("{name} - {resolved_name} already exists").format(
- name=template.component_model.__name__,
- resolved_name=resolved_name
+ _("A {model} named {name} already exists").format(
+ model=template.component_model.__name__,
+ name=resolved_name
)
)
diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py
index 43e5f4481..95c441381 100644
--- a/netbox/dcim/forms/filtersets.py
+++ b/netbox/dcim/forms/filtersets.py
@@ -7,12 +7,13 @@ from dcim.constants import *
from dcim.models import *
from extras.forms import LocalConfigContextFilterForm
from extras.models import ConfigTemplate
-from ipam.models import ASN, L2VPN, VRF
+from ipam.models import ASN, VRF
from netbox.forms import NetBoxModelFilterSetForm
from tenancy.forms import ContactModelFilterForm, TenancyFilterForm
from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, FilterForm, add_blank_choice
from utilities.forms.fields import ColorField, DynamicModelMultipleChoiceField, TagFilterField
from utilities.forms.widgets import APISelectMultiple, NumberWithOptions
+from vpn.models import L2VPN
from wireless.choices import *
__all__ = (
@@ -109,7 +110,7 @@ class DeviceComponentFilterForm(NetBoxModelFilterSetForm):
required=False,
label=_('Device type')
)
- role_id = DynamicModelMultipleChoiceField(
+ device_role_id = DynamicModelMultipleChoiceField(
queryset=DeviceRole.objects.all(),
required=False,
label=_('Device role')
@@ -164,6 +165,7 @@ class SiteFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFilte
(_('Tenant'), ('tenant_group_id', 'tenant_id')),
(_('Contacts'), ('contact', 'contact_role', 'contact_group')),
)
+ selector_fields = ('filter_id', 'q', 'region_id', 'group_id')
status = forms.MultipleChoiceField(
label=_('Status'),
choices=SiteStatusChoices,
@@ -247,6 +249,7 @@ class RackFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFilte
(_('Contacts'), ('contact', 'contact_role', 'contact_group')),
(_('Weight'), ('weight', 'max_weight', 'weight_unit')),
)
+ selector_fields = ('filter_id', 'q', 'region_id', 'site_group_id', 'site_id', 'location_id')
region_id = DynamicModelMultipleChoiceField(
queryset=Region.objects.all(),
required=False,
@@ -419,6 +422,7 @@ class DeviceTypeFilterForm(NetBoxModelFilterSetForm):
)),
(_('Weight'), ('weight', 'weight_unit')),
)
+ selector_fields = ('filter_id', 'q', 'manufacturer_id')
manufacturer_id = DynamicModelMultipleChoiceField(
queryset=Manufacturer.objects.all(),
required=False,
@@ -543,6 +547,7 @@ class ModuleTypeFilterForm(NetBoxModelFilterSetForm):
)),
(_('Weight'), ('weight', 'weight_unit')),
)
+ selector_fields = ('filter_id', 'q', 'manufacturer_id')
manufacturer_id = DynamicModelMultipleChoiceField(
queryset=Manufacturer.objects.all(),
required=False,
@@ -619,6 +624,7 @@ class DeviceRoleFilterForm(NetBoxModelFilterSetForm):
class PlatformFilterForm(NetBoxModelFilterSetForm):
model = Platform
+ selector_fields = ('filter_id', 'q', 'manufacturer_id')
manufacturer_id = DynamicModelMultipleChoiceField(
queryset=Manufacturer.objects.all(),
required=False,
@@ -653,6 +659,7 @@ class DeviceFilterForm(
'has_primary_ip', 'has_oob_ip', 'virtual_chassis_member', 'config_template_id', 'local_context_data',
))
)
+ selector_fields = ('filter_id', 'q', 'region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')
region_id = DynamicModelMultipleChoiceField(
queryset=Region.objects.all(),
required=False,
@@ -910,7 +917,7 @@ class CableFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
fieldsets = (
(None, ('q', 'filter_id', 'tag')),
(_('Location'), ('site_id', 'location_id', 'rack_id', 'device_id')),
- (_('Attributes'), ('type', 'status', 'color', 'length', 'length_unit')),
+ (_('Attributes'), ('type', 'status', 'color', 'length', 'length_unit', 'unterminated')),
(_('Tenant'), ('tenant_group_id', 'tenant_id')),
)
region_id = DynamicModelMultipleChoiceField(
@@ -979,6 +986,13 @@ class CableFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
choices=add_blank_choice(CableLengthUnitChoices),
required=False
)
+ unterminated = forms.NullBooleanField(
+ label=_('Unterminated'),
+ required=False,
+ widget=forms.Select(
+ choices=BOOLEAN_WITH_BLANK_CHOICES
+ )
+ )
tag = TagFilterField(model)
@@ -989,6 +1003,7 @@ class PowerPanelFilterForm(ContactModelFilterForm, NetBoxModelFilterSetForm):
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id')),
(_('Contacts'), ('contact', 'contact_role', 'contact_group')),
)
+ selector_fields = ('filter_id', 'q', 'site_id', 'location_id')
region_id = DynamicModelMultipleChoiceField(
queryset=Region.objects.all(),
required=False,
@@ -1136,7 +1151,7 @@ class ConsolePortFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type', 'speed')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Connection'), ('cabled', 'connected', 'occupied')),
)
type = forms.MultipleChoiceField(
@@ -1158,7 +1173,7 @@ class ConsoleServerPortFilterForm(PathEndpointFilterForm, DeviceComponentFilterF
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type', 'speed')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Connection'), ('cabled', 'connected', 'occupied')),
)
type = forms.MultipleChoiceField(
@@ -1180,7 +1195,7 @@ class PowerPortFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Connection'), ('cabled', 'connected', 'occupied')),
)
type = forms.MultipleChoiceField(
@@ -1197,7 +1212,7 @@ class PowerOutletFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Connection'), ('cabled', 'connected', 'occupied')),
)
type = forms.MultipleChoiceField(
@@ -1217,9 +1232,10 @@ class InterfaceFilterForm(PathEndpointFilterForm, DeviceComponentFilterForm):
(_('PoE'), ('poe_mode', 'poe_type')),
(_('Wireless'), ('rf_role', 'rf_channel', 'rf_channel_width', 'tx_power')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id', 'vdc_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id', 'vdc_id')),
(_('Connection'), ('cabled', 'connected', 'occupied')),
)
+ selector_fields = ('filter_id', 'q', 'device_id')
vdc_id = DynamicModelMultipleChoiceField(
queryset=VirtualDeviceContext.objects.all(),
required=False,
@@ -1324,7 +1340,7 @@ class FrontPortFilterForm(CabledFilterForm, DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type', 'color')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Cable'), ('cabled', 'occupied')),
)
model = FrontPort
@@ -1346,7 +1362,7 @@ class RearPortFilterForm(CabledFilterForm, DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'type', 'color')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
(_('Cable'), ('cabled', 'occupied')),
)
type = forms.MultipleChoiceField(
@@ -1367,7 +1383,7 @@ class ModuleBayFilterForm(DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'position')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
)
tag = TagFilterField(model)
position = forms.CharField(
@@ -1382,7 +1398,7 @@ class DeviceBayFilterForm(DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
)
tag = TagFilterField(model)
@@ -1393,7 +1409,7 @@ class InventoryItemFilterForm(DeviceComponentFilterForm):
(None, ('q', 'filter_id', 'tag')),
(_('Attributes'), ('name', 'label', 'role_id', 'manufacturer_id', 'serial', 'asset_tag', 'discovered')),
(_('Location'), ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')),
- (_('Device'), ('device_type_id', 'role_id', 'device_id', 'virtual_chassis_id')),
+ (_('Device'), ('device_type_id', 'device_role_id', 'device_id', 'virtual_chassis_id')),
)
role_id = DynamicModelMultipleChoiceField(
queryset=InventoryItemRole.objects.all(),
diff --git a/netbox/dcim/forms/model_forms.py b/netbox/dcim/forms/model_forms.py
index 879b15da2..da3a2bea4 100644
--- a/netbox/dcim/forms/model_forms.py
+++ b/netbox/dcim/forms/model_forms.py
@@ -302,7 +302,8 @@ class DeviceTypeForm(NetBoxModelForm):
fieldsets = (
(_('Device Type'), ('manufacturer', 'model', 'slug', 'default_platform', 'description', 'tags')),
(_('Chassis'), (
- 'u_height', 'is_full_depth', 'part_number', 'subdevice_role', 'airflow', 'weight', 'weight_unit',
+ 'u_height', 'exclude_from_utilization', 'is_full_depth', 'part_number', 'subdevice_role', 'airflow',
+ 'weight', 'weight_unit',
)),
(_('Images'), ('front_image', 'rear_image')),
)
@@ -310,9 +311,9 @@ class DeviceTypeForm(NetBoxModelForm):
class Meta:
model = DeviceType
fields = [
- 'manufacturer', 'model', 'slug', 'default_platform', 'part_number', 'u_height', 'is_full_depth',
- 'subdevice_role', 'airflow', 'weight', 'weight_unit', 'front_image', 'rear_image', 'description',
- 'comments', 'tags',
+ 'manufacturer', 'model', 'slug', 'default_platform', 'part_number', 'u_height', 'exclude_from_utilization',
+ 'is_full_depth', 'subdevice_role', 'airflow', 'weight', 'weight_unit', 'front_image', 'rear_image',
+ 'description', 'comments', 'tags',
]
widgets = {
'front_image': ClearableFileInput(attrs={
@@ -421,12 +422,13 @@ class DeviceForm(TenancyForm, NetBoxModelForm):
label=_('Position'),
required=False,
help_text=_("The lowest-numbered unit occupied by the device"),
+ localize=True,
widget=APISelect(
api_url='/api/dcim/racks/{{rack}}/elevation/',
attrs={
'disabled-indicator': 'device',
'data-dynamic-params': '[{"fieldName":"face","queryParam":"face"}]'
- }
+ },
)
)
device_type = DynamicModelChoiceField(
@@ -441,7 +443,8 @@ class DeviceForm(TenancyForm, NetBoxModelForm):
platform = DynamicModelChoiceField(
label=_('Platform'),
queryset=Platform.objects.all(),
- required=False
+ required=False,
+ selector=True
)
cluster = DynamicModelChoiceField(
label=_('Cluster'),
@@ -1110,7 +1113,7 @@ class InterfaceForm(InterfaceCommonForm, ModularDeviceComponentForm):
required=False,
label=_('Parent interface'),
query_params={
- 'device_id': '$device',
+ 'virtual_chassis_member_id': '$device',
}
)
bridge = DynamicModelChoiceField(
@@ -1118,7 +1121,7 @@ class InterfaceForm(InterfaceCommonForm, ModularDeviceComponentForm):
required=False,
label=_('Bridged interface'),
query_params={
- 'device_id': '$device',
+ 'virtual_chassis_member_id': '$device',
}
)
lag = DynamicModelChoiceField(
@@ -1126,7 +1129,7 @@ class InterfaceForm(InterfaceCommonForm, ModularDeviceComponentForm):
required=False,
label=_('LAG interface'),
query_params={
- 'device_id': '$device',
+ 'virtual_chassis_member_id': '$device',
'type': 'lag',
}
)
diff --git a/netbox/dcim/forms/object_create.py b/netbox/dcim/forms/object_create.py
index abd7bd6f6..ea842508f 100644
--- a/netbox/dcim/forms/object_create.py
+++ b/netbox/dcim/forms/object_create.py
@@ -151,6 +151,23 @@ class FrontPortTemplateCreateForm(ComponentCreateForm, model_forms.FrontPortTemp
)
self.fields['rear_port'].choices = choices
+ def clean(self):
+
+ # Check that the number of FrontPortTemplates to be created matches the selected number of RearPortTemplate
+ # positions
+ frontport_count = len(self.cleaned_data['name'])
+ rearport_count = len(self.cleaned_data['rear_port'])
+ if frontport_count != rearport_count:
+ raise forms.ValidationError({
+ 'rear_port': _(
+ "The number of front port templates to be created ({frontport_count}) must match the selected "
+ "number of rear port positions ({rearport_count})."
+ ).format(
+ frontport_count=frontport_count,
+ rearport_count=rearport_count
+ )
+ })
+
def get_iterative_data(self, iteration):
# Assign rear port and position from selected set
@@ -291,6 +308,22 @@ class FrontPortCreateForm(ComponentCreateForm, model_forms.FrontPortForm):
)
self.fields['rear_port'].choices = choices
+ def clean(self):
+
+ # Check that the number of FrontPorts to be created matches the selected number of RearPort positions
+ frontport_count = len(self.cleaned_data['name'])
+ rearport_count = len(self.cleaned_data['rear_port'])
+ if frontport_count != rearport_count:
+ raise forms.ValidationError({
+ 'rear_port': _(
+ "The number of front ports to be created ({frontport_count}) must match the selected number of "
+ "rear port positions ({rearport_count})."
+ ).format(
+ frontport_count=frontport_count,
+ rearport_count=rearport_count
+ )
+ })
+
def get_iterative_data(self, iteration):
# Assign rear port and position from selected set
diff --git a/netbox/dcim/migrations/0174_rack_starting_unit.py b/netbox/dcim/migrations/0174_rack_starting_unit.py
index e32738660..2d2b5f826 100644
--- a/netbox/dcim/migrations/0174_rack_starting_unit.py
+++ b/netbox/dcim/migrations/0174_rack_starting_unit.py
@@ -1,5 +1,6 @@
# Generated by Django 4.1.9 on 2023-05-31 15:47
+import django.core.validators
from django.db import migrations, models
@@ -12,6 +13,6 @@ class Migration(migrations.Migration):
migrations.AddField(
model_name='rack',
name='starting_unit',
- field=models.PositiveSmallIntegerField(default=1),
+ field=models.PositiveSmallIntegerField(default=1, validators=[django.core.validators.MinValueValidator(1)]),
),
]
diff --git a/netbox/dcim/migrations/0176_device_component_counters.py b/netbox/dcim/migrations/0176_device_component_counters.py
index b570ddbd5..60857ecb9 100644
--- a/netbox/dcim/migrations/0176_device_component_counters.py
+++ b/netbox/dcim/migrations/0176_device_component_counters.py
@@ -2,47 +2,22 @@ from django.db import migrations
from django.db.models import Count
import utilities.fields
+from utilities.counters import update_counts
def recalculate_device_counts(apps, schema_editor):
Device = apps.get_model("dcim", "Device")
- devices = list(Device.objects.all().annotate(
- _console_port_count=Count('consoleports', distinct=True),
- _console_server_port_count=Count('consoleserverports', distinct=True),
- _power_port_count=Count('powerports', distinct=True),
- _power_outlet_count=Count('poweroutlets', distinct=True),
- _interface_count=Count('interfaces', distinct=True),
- _front_port_count=Count('frontports', distinct=True),
- _rear_port_count=Count('rearports', distinct=True),
- _device_bay_count=Count('devicebays', distinct=True),
- _module_bay_count=Count('modulebays', distinct=True),
- _inventory_item_count=Count('inventoryitems', distinct=True),
- ))
- for device in devices:
- device.console_port_count = device._console_port_count
- device.console_server_port_count = device._console_server_port_count
- device.power_port_count = device._power_port_count
- device.power_outlet_count = device._power_outlet_count
- device.interface_count = device._interface_count
- device.front_port_count = device._front_port_count
- device.rear_port_count = device._rear_port_count
- device.device_bay_count = device._device_bay_count
- device.module_bay_count = device._module_bay_count
- device.inventory_item_count = device._inventory_item_count
-
- Device.objects.bulk_update(devices, [
- 'console_port_count',
- 'console_server_port_count',
- 'power_port_count',
- 'power_outlet_count',
- 'interface_count',
- 'front_port_count',
- 'rear_port_count',
- 'device_bay_count',
- 'module_bay_count',
- 'inventory_item_count',
- ])
+ update_counts(Device, 'console_port_count', 'consoleports')
+ update_counts(Device, 'console_server_port_count', 'consoleserverports')
+ update_counts(Device, 'power_port_count', 'powerports')
+ update_counts(Device, 'power_outlet_count', 'poweroutlets')
+ update_counts(Device, 'interface_count', 'interfaces')
+ update_counts(Device, 'front_port_count', 'frontports')
+ update_counts(Device, 'rear_port_count', 'rearports')
+ update_counts(Device, 'device_bay_count', 'devicebays')
+ update_counts(Device, 'module_bay_count', 'modulebays')
+ update_counts(Device, 'inventory_item_count', 'inventoryitems')
class Migration(migrations.Migration):
diff --git a/netbox/dcim/migrations/0177_devicetype_component_counters.py b/netbox/dcim/migrations/0177_devicetype_component_counters.py
index 66d1460d9..b452ce2d9 100644
--- a/netbox/dcim/migrations/0177_devicetype_component_counters.py
+++ b/netbox/dcim/migrations/0177_devicetype_component_counters.py
@@ -2,47 +2,22 @@ from django.db import migrations
from django.db.models import Count
import utilities.fields
+from utilities.counters import update_counts
def recalculate_devicetype_template_counts(apps, schema_editor):
DeviceType = apps.get_model("dcim", "DeviceType")
- device_types = list(DeviceType.objects.all().annotate(
- _console_port_template_count=Count('consoleporttemplates', distinct=True),
- _console_server_port_template_count=Count('consoleserverporttemplates', distinct=True),
- _power_port_template_count=Count('powerporttemplates', distinct=True),
- _power_outlet_template_count=Count('poweroutlettemplates', distinct=True),
- _interface_template_count=Count('interfacetemplates', distinct=True),
- _front_port_template_count=Count('frontporttemplates', distinct=True),
- _rear_port_template_count=Count('rearporttemplates', distinct=True),
- _device_bay_template_count=Count('devicebaytemplates', distinct=True),
- _module_bay_template_count=Count('modulebaytemplates', distinct=True),
- _inventory_item_template_count=Count('inventoryitemtemplates', distinct=True),
- ))
- for devicetype in device_types:
- devicetype.console_port_template_count = devicetype._console_port_template_count
- devicetype.console_server_port_template_count = devicetype._console_server_port_template_count
- devicetype.power_port_template_count = devicetype._power_port_template_count
- devicetype.power_outlet_template_count = devicetype._power_outlet_template_count
- devicetype.interface_template_count = devicetype._interface_template_count
- devicetype.front_port_template_count = devicetype._front_port_template_count
- devicetype.rear_port_template_count = devicetype._rear_port_template_count
- devicetype.device_bay_template_count = devicetype._device_bay_template_count
- devicetype.module_bay_template_count = devicetype._module_bay_template_count
- devicetype.inventory_item_template_count = devicetype._inventory_item_template_count
-
- DeviceType.objects.bulk_update(device_types, [
- 'console_port_template_count',
- 'console_server_port_template_count',
- 'power_port_template_count',
- 'power_outlet_template_count',
- 'interface_template_count',
- 'front_port_template_count',
- 'rear_port_template_count',
- 'device_bay_template_count',
- 'module_bay_template_count',
- 'inventory_item_template_count',
- ])
+ update_counts(DeviceType, 'console_port_template_count', 'consoleporttemplates')
+ update_counts(DeviceType, 'console_server_port_template_count', 'consoleserverporttemplates')
+ update_counts(DeviceType, 'power_port_template_count', 'powerporttemplates')
+ update_counts(DeviceType, 'power_outlet_template_count', 'poweroutlettemplates')
+ update_counts(DeviceType, 'interface_template_count', 'interfacetemplates')
+ update_counts(DeviceType, 'front_port_template_count', 'frontporttemplates')
+ update_counts(DeviceType, 'rear_port_template_count', 'rearporttemplates')
+ update_counts(DeviceType, 'device_bay_template_count', 'devicebaytemplates')
+ update_counts(DeviceType, 'module_bay_template_count', 'modulebaytemplates')
+ update_counts(DeviceType, 'inventory_item_template_count', 'inventoryitemtemplates')
class Migration(migrations.Migration):
diff --git a/netbox/dcim/migrations/0178_virtual_chassis_member_counter.py b/netbox/dcim/migrations/0178_virtual_chassis_member_counter.py
index e3ade1344..99b304b66 100644
--- a/netbox/dcim/migrations/0178_virtual_chassis_member_counter.py
+++ b/netbox/dcim/migrations/0178_virtual_chassis_member_counter.py
@@ -2,17 +2,13 @@ from django.db import migrations
from django.db.models import Count
import utilities.fields
+from utilities.counters import update_counts
def populate_virtualchassis_members(apps, schema_editor):
VirtualChassis = apps.get_model('dcim', 'VirtualChassis')
- vcs = list(VirtualChassis.objects.annotate(_member_count=Count('members', distinct=True)))
-
- for vc in vcs:
- vc.member_count = vc._member_count
-
- VirtualChassis.objects.bulk_update(vcs, ['member_count'])
+ update_counts(VirtualChassis, 'member_count', 'members')
class Migration(migrations.Migration):
diff --git a/netbox/dcim/migrations/0182_zero_length_cable_fix.py b/netbox/dcim/migrations/0182_zero_length_cable_fix.py
new file mode 100644
index 000000000..080e00717
--- /dev/null
+++ b/netbox/dcim/migrations/0182_zero_length_cable_fix.py
@@ -0,0 +1,22 @@
+from django.db import migrations
+
+
+def update_cable_lengths(apps, schema_editor):
+ Cable = apps.get_model('dcim', 'Cable')
+
+ # Set the absolute length for any zero-length Cables
+ Cable.objects.filter(length=0).update(_abs_length=0)
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('dcim', '0181_rename_device_role_device_role'),
+ ]
+
+ operations = [
+ migrations.RunPython(
+ code=update_cable_lengths,
+ reverse_code=migrations.RunPython.noop
+ ),
+ ]
diff --git a/netbox/dcim/migrations/0183_devicetype_exclude_from_utilization.py b/netbox/dcim/migrations/0183_devicetype_exclude_from_utilization.py
new file mode 100644
index 000000000..f9f2c20b4
--- /dev/null
+++ b/netbox/dcim/migrations/0183_devicetype_exclude_from_utilization.py
@@ -0,0 +1,17 @@
+# Generated by Django 4.2.5 on 2023-10-20 22:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('dcim', '0182_zero_length_cable_fix'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='devicetype',
+ name='exclude_from_utilization',
+ field=models.BooleanField(default=False),
+ ),
+ ]
diff --git a/netbox/dcim/migrations/0184_protect_child_interfaces.py b/netbox/dcim/migrations/0184_protect_child_interfaces.py
new file mode 100644
index 000000000..3459e23fc
--- /dev/null
+++ b/netbox/dcim/migrations/0184_protect_child_interfaces.py
@@ -0,0 +1,19 @@
+# Generated by Django 4.2.6 on 2023-10-20 11:48
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('dcim', '0183_devicetype_exclude_from_utilization'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='interface',
+ name='parent',
+ field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.RESTRICT, related_name='child_interfaces', to='dcim.interface'),
+ ),
+ ]
diff --git a/netbox/dcim/migrations/0185_gfk_indexes.py b/netbox/dcim/migrations/0185_gfk_indexes.py
new file mode 100644
index 000000000..84cdc53ff
--- /dev/null
+++ b/netbox/dcim/migrations/0185_gfk_indexes.py
@@ -0,0 +1,25 @@
+# Generated by Django 4.2.7 on 2023-12-07 16:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('dcim', '0184_protect_child_interfaces'),
+ ]
+
+ operations = [
+ migrations.AddIndex(
+ model_name='cabletermination',
+ index=models.Index(fields=['termination_type', 'termination_id'], name='dcim_cablet_termina_884752_idx'),
+ ),
+ migrations.AddIndex(
+ model_name='inventoryitem',
+ index=models.Index(fields=['component_type', 'component_id'], name='dcim_invent_compone_0560bb_idx'),
+ ),
+ migrations.AddIndex(
+ model_name='inventoryitemtemplate',
+ index=models.Index(fields=['component_type', 'component_id'], name='dcim_invent_compone_77b5f8_idx'),
+ ),
+ ]
diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py
index de7ba0eb6..d1c80d0be 100644
--- a/netbox/dcim/models/cables.py
+++ b/netbox/dcim/models/cables.py
@@ -2,7 +2,6 @@ import itertools
from collections import defaultdict
from django.contrib.contenttypes.fields import GenericForeignKey
-from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ValidationError
from django.db import models
from django.db.models import Sum
@@ -10,17 +9,17 @@ from django.dispatch import Signal
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
+from core.models import ContentType
from dcim.choices import *
from dcim.constants import *
from dcim.fields import PathField
from dcim.utils import decompile_path_node, object_to_path_node
from netbox.models import ChangeLoggedModel, PrimaryModel
-
from utilities.fields import ColorField
from utilities.querysets import RestrictedQuerySet
from utilities.utils import to_meters
from wireless.models import WirelessLink
-from .device_components import FrontPort, RearPort
+from .device_components import FrontPort, RearPort, PathEndpoint
__all__ = (
'Cable',
@@ -98,10 +97,10 @@ class Cable(PrimaryModel):
super().__init__(*args, **kwargs)
# A copy of the PK to be used by __str__ in case the object is deleted
- self._pk = self.pk
+ self._pk = self.__dict__.get('id')
# Cache the original status so we can check later if it's been changed
- self._orig_status = self.status
+ self._orig_status = self.__dict__.get('status')
self._terminations_modified = False
@@ -180,6 +179,17 @@ class Cable(PrimaryModel):
if b_type not in COMPATIBLE_TERMINATION_TYPES.get(a_type):
raise ValidationError(f"Incompatible termination types: {a_type} and {b_type}")
+ if a_type == b_type:
+ # can't directly use self.a_terminations here as possible they
+ # don't have pk yet
+ a_pks = set(obj.pk for obj in self.a_terminations if obj.pk)
+ b_pks = set(obj.pk for obj in self.b_terminations if obj.pk)
+
+ if (a_pks & b_pks):
+ raise ValidationError(
+ _("A and B terminations cannot connect to the same object.")
+ )
+
# Run clean() on any new CableTerminations
for termination in self.a_terminations:
CableTermination(cable=self, cable_end='A', termination=termination).clean()
@@ -190,7 +200,7 @@ class Cable(PrimaryModel):
_created = self.pk is None
# Store the given length (if any) in meters for use in database ordering
- if self.length and self.length_unit:
+ if self.length is not None and self.length_unit:
self._abs_length = to_meters(self.length, self.length_unit)
else:
self._abs_length = None
@@ -247,7 +257,7 @@ class CableTermination(ChangeLoggedModel):
verbose_name=_('end')
)
termination_type = models.ForeignKey(
- to=ContentType,
+ to='contenttypes.ContentType',
limit_choices_to=CABLE_TERMINATION_MODELS,
on_delete=models.PROTECT,
related_name='+'
@@ -288,6 +298,9 @@ class CableTermination(ChangeLoggedModel):
class Meta:
ordering = ('cable', 'cable_end', 'pk')
+ indexes = (
+ models.Index(fields=('termination_type', 'termination_id')),
+ )
constraints = (
models.UniqueConstraint(
fields=('termination_type', 'termination_id'),
@@ -431,6 +444,8 @@ class CablePath(models.Model):
)
_nodes = PathField()
+ _netbox_private = True
+
class Meta:
verbose_name = _('cable path')
verbose_name_plural = _('cable paths')
@@ -518,9 +533,16 @@ class CablePath(models.Model):
# Terminations must all be of the same type
assert all(isinstance(t, type(terminations[0])) for t in terminations[1:])
+ # All mid-span terminations must all be attached to the same device
+ if not isinstance(terminations[0], PathEndpoint):
+ assert all(isinstance(t, type(terminations[0])) for t in terminations[1:])
+ assert all(t.parent_object == terminations[0].parent_object for t in terminations[1:])
+
# Check for a split path (e.g. rear port fanning out to multiple front ports with
# different cables attached)
- if len(set(t.link for t in terminations)) > 1:
+ if len(set(t.link for t in terminations)) > 1 and (
+ position_stack and len(terminations) != len(position_stack[-1])
+ ):
is_split = True
break
@@ -529,46 +551,68 @@ class CablePath(models.Model):
object_to_path_node(t) for t in terminations
])
- # Step 2: Determine the attached link (Cable or WirelessLink), if any
- link = terminations[0].link
- if link is None and len(path) == 1:
- # If this is the start of the path and no link exists, return None
- return None
- elif link is None:
+ # Step 2: Determine the attached links (Cable or WirelessLink), if any
+ links = [termination.link for termination in terminations if termination.link is not None]
+ if len(links) == 0:
+ if len(path) == 1:
+ # If this is the start of the path and no link exists, return None
+ return None
# Otherwise, halt the trace if no link exists
break
- assert type(link) in (Cable, WirelessLink)
+ assert all(type(link) in (Cable, WirelessLink) for link in links)
+ assert all(isinstance(link, type(links[0])) for link in links)
- # Step 3: Record the link and update path status if not "connected"
- path.append([object_to_path_node(link)])
- if hasattr(link, 'status') and link.status != LinkStatusChoices.STATUS_CONNECTED:
+ # Step 3: Record asymmetric paths as split
+ not_connected_terminations = [termination.link for termination in terminations if termination.link is None]
+ if len(not_connected_terminations) > 0:
+ is_complete = False
+ is_split = True
+
+ # Step 4: Record the links, keeping cables in order to allow for SVG rendering
+ cables = []
+ for link in links:
+ if object_to_path_node(link) not in cables:
+ cables.append(object_to_path_node(link))
+ path.append(cables)
+
+ # Step 5: Update the path status if a link is not connected
+ links_status = [link.status for link in links if link.status != LinkStatusChoices.STATUS_CONNECTED]
+ if any([status != LinkStatusChoices.STATUS_CONNECTED for status in links_status]):
is_active = False
- # Step 4: Determine the far-end terminations
- if isinstance(link, Cable):
+ # Step 6: Determine the far-end terminations
+ if isinstance(links[0], Cable):
termination_type = ContentType.objects.get_for_model(terminations[0])
local_cable_terminations = CableTermination.objects.filter(
termination_type=termination_type,
termination_id__in=[t.pk for t in terminations]
)
- # Terminations must all belong to same end of Cable
- local_cable_end = local_cable_terminations[0].cable_end
- assert all(ct.cable_end == local_cable_end for ct in local_cable_terminations[1:])
- remote_cable_terminations = CableTermination.objects.filter(
- cable=link,
- cable_end='A' if local_cable_end == 'B' else 'B'
- )
+
+ q_filter = Q()
+ for lct in local_cable_terminations:
+ cable_end = 'A' if lct.cable_end == 'B' else 'B'
+ q_filter |= Q(cable=lct.cable, cable_end=cable_end)
+
+ remote_cable_terminations = CableTermination.objects.filter(q_filter)
remote_terminations = [ct.termination for ct in remote_cable_terminations]
else:
# WirelessLink
- remote_terminations = [link.interface_b] if link.interface_a is terminations[0] else [link.interface_a]
+ remote_terminations = [
+ link.interface_b if link.interface_a is terminations[0] else link.interface_a for link in links
+ ]
- # Step 5: Record the far-end termination object(s)
+ # Remote Terminations must all be of the same type, otherwise return a split path
+ if not all(isinstance(t, type(remote_terminations[0])) for t in remote_terminations[1:]):
+ is_complete = False
+ is_split = True
+ break
+
+ # Step 7: Record the far-end termination object(s)
path.append([
object_to_path_node(t) for t in remote_terminations if t is not None
])
- # Step 6: Determine the "next hop" terminations, if applicable
+ # Step 8: Determine the "next hop" terminations, if applicable
if not remote_terminations:
break
@@ -577,20 +621,32 @@ class CablePath(models.Model):
rear_ports = RearPort.objects.filter(
pk__in=[t.rear_port_id for t in remote_terminations]
)
- if len(rear_ports) > 1:
- assert all(rp.positions == 1 for rp in rear_ports)
- elif rear_ports[0].positions > 1:
+ if len(rear_ports) > 1 or rear_ports[0].positions > 1:
position_stack.append([fp.rear_port_position for fp in remote_terminations])
terminations = rear_ports
elif isinstance(remote_terminations[0], RearPort):
-
- if len(remote_terminations) > 1 or remote_terminations[0].positions == 1:
+ if len(remote_terminations) == 1 and remote_terminations[0].positions == 1:
front_ports = FrontPort.objects.filter(
rear_port_id__in=[rp.pk for rp in remote_terminations],
rear_port_position=1
)
+ # Obtain the individual front ports based on the termination and all positions
+ elif len(remote_terminations) > 1 and position_stack:
+ positions = position_stack.pop()
+
+ # Ensure we have a number of positions equal to the amount of remote terminations
+ assert len(remote_terminations) == len(positions)
+
+ # Get our front ports
+ q_filter = Q()
+ for rt in remote_terminations:
+ position = positions.pop()
+ q_filter |= Q(rear_port_id=rt.pk, rear_port_position=position)
+ assert q_filter is not Q()
+ front_ports = FrontPort.objects.filter(q_filter)
+ # Obtain the individual front ports based on the termination and position
elif position_stack:
front_ports = FrontPort.objects.filter(
rear_port_id=remote_terminations[0].pk,
@@ -632,9 +688,16 @@ class CablePath(models.Model):
terminations = [circuit_termination]
- # Anything else marks the end of the path
else:
- is_complete = True
+ # Check for non-symmetric path
+ if all(isinstance(t, type(remote_terminations[0])) for t in remote_terminations[1:]):
+ is_complete = True
+ elif len(remote_terminations) == 0:
+ is_complete = False
+ else:
+ # Unsupported topology, mark as split and exit
+ is_complete = False
+ is_split = True
break
return cls(
@@ -740,3 +803,15 @@ class CablePath(models.Model):
return [
ct.get_peer_termination() for ct in nodes
]
+
+ def get_asymmetric_nodes(self):
+ """
+ Return all available next segments in a split cable path.
+ """
+ from circuits.models import CircuitTermination
+ asymmetric_nodes = []
+ for nodes in self.path_objects:
+ if type(nodes[0]) in [RearPort, FrontPort, CircuitTermination]:
+ asymmetric_nodes.extend([node for node in nodes if node.link is None])
+
+ return asymmetric_nodes
diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py
index f58d2bbca..dacd7ec3e 100644
--- a/netbox/dcim/models/device_component_templates.py
+++ b/netbox/dcim/models/device_component_templates.py
@@ -1,5 +1,4 @@
from django.contrib.contenttypes.fields import GenericForeignKey
-from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ValidationError
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models
@@ -89,7 +88,7 @@ class ComponentTemplateModel(ChangeLoggedModel, TrackingModelMixin):
super().__init__(*args, **kwargs)
# Cache the original DeviceType ID for reference under clean()
- self._original_device_type = self.device_type_id
+ self._original_device_type = self.__dict__.get('device_type_id')
def to_objectchange(self, action):
objectchange = super().to_objectchange(action)
@@ -534,14 +533,16 @@ class FrontPortTemplate(ModularComponentTemplateModel):
# Validate rear port assignment
if self.rear_port.device_type != self.device_type:
raise ValidationError(
- _("Rear port ({}) must belong to the same device type").format(self.rear_port)
+ _("Rear port ({name}) must belong to the same device type").format(name=self.rear_port)
)
# Validate rear port position assignment
if self.rear_port_position > self.rear_port.positions:
raise ValidationError(
- _("Invalid rear port position ({}); rear port {} has only {} positions").format(
- self.rear_port_position, self.rear_port.name, self.rear_port.positions
+ _("Invalid rear port position ({position}); rear port {name} has only {count} positions").format(
+ position=self.rear_port_position,
+ name=self.rear_port.name,
+ count=self.rear_port.positions
)
)
@@ -707,7 +708,7 @@ class InventoryItemTemplate(MPTTModel, ComponentTemplateModel):
db_index=True
)
component_type = models.ForeignKey(
- to=ContentType,
+ to='contenttypes.ContentType',
limit_choices_to=MODULAR_COMPONENT_TEMPLATE_MODELS,
on_delete=models.PROTECT,
related_name='+',
@@ -748,6 +749,9 @@ class InventoryItemTemplate(MPTTModel, ComponentTemplateModel):
class Meta:
ordering = ('device_type__id', 'parent__id', '_name')
+ indexes = (
+ models.Index(fields=('component_type', 'component_id')),
+ )
constraints = (
models.UniqueConstraint(
fields=('device_type', 'parent', 'name'),
diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py
index e18f25e4f..ef235078f 100644
--- a/netbox/dcim/models/device_components.py
+++ b/netbox/dcim/models/device_components.py
@@ -1,7 +1,6 @@
from functools import cached_property
from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
-from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ValidationError
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models
@@ -86,7 +85,7 @@ class ComponentModel(NetBoxModel):
super().__init__(*args, **kwargs)
# Cache the original Device ID for reference under clean()
- self._original_device = self.device_id
+ self._original_device = self.__dict__.get('device_id')
def __str__(self):
if self.label:
@@ -537,7 +536,7 @@ class BaseInterface(models.Model):
)
parent = models.ForeignKey(
to='self',
- on_delete=models.SET_NULL,
+ on_delete=models.RESTRICT,
related_name='child_interfaces',
null=True,
blank=True,
@@ -567,6 +566,10 @@ class BaseInterface(models.Model):
return super().save(*args, **kwargs)
+ @property
+ def tunnel_termination(self):
+ return self.tunnel_terminations.first()
+
@property
def count_ipaddresses(self):
return self.ip_addresses.count()
@@ -720,8 +723,14 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd
object_id_field='interface_id',
related_query_name='+'
)
+ tunnel_terminations = GenericRelation(
+ to='vpn.TunnelTermination',
+ content_type_field='termination_type',
+ object_id_field='termination_id',
+ related_query_name='interface'
+ )
l2vpn_terminations = GenericRelation(
- to='ipam.L2VPNTermination',
+ to='vpn.L2VPNTermination',
content_type_field='assigned_object_type',
object_id_field='assigned_object_id',
related_query_name='interface',
@@ -799,9 +808,9 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd
if self.bridge and self.bridge.device != self.device:
if self.device.virtual_chassis is None:
raise ValidationError({
- 'bridge': _("""
- The selected bridge interface ({bridge}) belongs to a different device
- ({device}).""").format(bridge=self.bridge, device=self.bridge.device)
+ 'bridge': _(
+ "The selected bridge interface ({bridge}) belongs to a different device ({device})."
+ ).format(bridge=self.bridge, device=self.bridge.device)
})
elif self.bridge.device.virtual_chassis != self.device.virtual_chassis:
raise ValidationError({
@@ -889,10 +898,10 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd
# Validate untagged VLAN
if self.untagged_vlan and self.untagged_vlan.site not in [self.device.site, None]:
raise ValidationError({
- 'untagged_vlan': _("""
- The untagged VLAN ({untagged_vlan}) must belong to the same site as the
- interface's parent device, or it must be global.
- """).format(untagged_vlan=self.untagged_vlan)
+ 'untagged_vlan': _(
+ "The untagged VLAN ({untagged_vlan}) must belong to the same site as the interface's parent "
+ "device, or it must be global."
+ ).format(untagged_vlan=self.untagged_vlan)
})
def save(self, *args, **kwargs):
@@ -1067,9 +1076,10 @@ class RearPort(ModularComponentModel, CabledObjectModel, TrackingModelMixin):
frontport_count = self.frontports.count()
if self.positions < frontport_count:
raise ValidationError({
- "positions": _("""
- The number of positions cannot be less than the number of mapped front ports
- ({frontport_count})""").format(frontport_count=frontport_count)
+ "positions": _(
+ "The number of positions cannot be less than the number of mapped front ports "
+ "({frontport_count})"
+ ).format(frontport_count=frontport_count)
})
@@ -1180,7 +1190,7 @@ class InventoryItem(MPTTModel, ComponentModel, TrackingModelMixin):
db_index=True
)
component_type = models.ForeignKey(
- to=ContentType,
+ to='contenttypes.ContentType',
limit_choices_to=MODULAR_COMPONENT_MODELS,
on_delete=models.PROTECT,
related_name='+',
@@ -1240,6 +1250,9 @@ class InventoryItem(MPTTModel, ComponentModel, TrackingModelMixin):
class Meta:
ordering = ('device__id', 'parent__id', '_name')
+ indexes = (
+ models.Index(fields=('component_type', 'component_id')),
+ )
constraints = (
models.UniqueConstraint(
fields=('device', 'parent', 'name'),
diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py
index 857251caf..4b9689a22 100644
--- a/netbox/dcim/models/devices.py
+++ b/netbox/dcim/models/devices.py
@@ -4,6 +4,7 @@ import yaml
from functools import cached_property
from django.core.exceptions import ValidationError
+from django.core.files.storage import default_storage
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models
from django.db.models import F, ProtectedError
@@ -15,7 +16,7 @@ from django.utils.translation import gettext_lazy as _
from dcim.choices import *
from dcim.constants import *
-from extras.models import ConfigContextModel
+from extras.models import ConfigContextModel, CustomField
from extras.querysets import ConfigContextModelQuerySet
from netbox.config import ConfigItem
from netbox.models import OrganizationalModel, PrimaryModel
@@ -105,10 +106,15 @@ class DeviceType(ImageAttachmentsMixin, PrimaryModel, WeightMixin):
default=1.0,
verbose_name=_('height (U)')
)
+ exclude_from_utilization = models.BooleanField(
+ default=False,
+ verbose_name=_('exclude from utilization'),
+ help_text=_('Devices of this type are excluded when calculating rack utilization.')
+ )
is_full_depth = models.BooleanField(
default=True,
verbose_name=_('is full depth'),
- help_text=_('Device consumes both front and rear rack faces')
+ help_text=_('Device consumes both front and rear rack faces.')
)
subdevice_role = models.CharField(
max_length=50,
@@ -205,11 +211,11 @@ class DeviceType(ImageAttachmentsMixin, PrimaryModel, WeightMixin):
super().__init__(*args, **kwargs)
# Save a copy of u_height for validation in clean()
- self._original_u_height = self.u_height
+ self._original_u_height = self.__dict__.get('u_height')
# Save references to the original front/rear images
- self._original_front_image = self.front_image
- self._original_rear_image = self.rear_image
+ self._original_front_image = self.__dict__.get('front_image')
+ self._original_rear_image = self.__dict__.get('rear_image')
def get_absolute_url(self):
return reverse('dcim:devicetype', args=[self.pk])
@@ -296,8 +302,10 @@ class DeviceType(ImageAttachmentsMixin, PrimaryModel, WeightMixin):
)
if d.position not in u_available:
raise ValidationError({
- 'u_height': _("Device {} in rack {} does not have sufficient space to accommodate a height of "
- "{}U").format(d, d.rack, self.u_height)
+ 'u_height': _(
+ "Device {device} in rack {rack} does not have sufficient space to accommodate a "
+ "height of {height}U"
+ ).format(device=d, rack=d.rack, height=self.u_height)
})
# If modifying the height of an existing DeviceType to 0U, check for any instances assigned to a rack position.
@@ -332,10 +340,10 @@ class DeviceType(ImageAttachmentsMixin, PrimaryModel, WeightMixin):
ret = super().save(*args, **kwargs)
# Delete any previously uploaded image files that are no longer in use
- if self.front_image != self._original_front_image:
- self._original_front_image.delete(save=False)
- if self.rear_image != self._original_rear_image:
- self._original_rear_image.delete(save=False)
+ if self._original_front_image and self.front_image != self._original_front_image:
+ default_storage.delete(self._original_front_image)
+ if self._original_rear_image and self.rear_image != self._original_rear_image:
+ default_storage.delete(self._original_rear_image)
return ret
@@ -914,7 +922,7 @@ class Device(
if self.primary_ip4:
if self.primary_ip4.family != 4:
raise ValidationError({
- 'primary_ip4': _("{primary_ip4} is not an IPv4 address.").format(primary_ip4=self.primary_ip4)
+ 'primary_ip4': _("{ip} is not an IPv4 address.").format(ip=self.primary_ip4)
})
if self.primary_ip4.assigned_object in vc_interfaces:
pass
@@ -923,13 +931,13 @@ class Device(
else:
raise ValidationError({
'primary_ip4': _(
- "The specified IP address ({primary_ip4}) is not assigned to this device."
- ).format(primary_ip4=self.primary_ip4)
+ "The specified IP address ({ip}) is not assigned to this device."
+ ).format(ip=self.primary_ip4)
})
if self.primary_ip6:
if self.primary_ip6.family != 6:
raise ValidationError({
- 'primary_ip6': _("{primary_ip6} is not an IPv6 address.").format(primary_ip6=self.primary_ip6m)
+ 'primary_ip6': _("{ip} is not an IPv6 address.").format(ip=self.primary_ip6)
})
if self.primary_ip6.assigned_object in vc_interfaces:
pass
@@ -938,8 +946,8 @@ class Device(
else:
raise ValidationError({
'primary_ip6': _(
- "The specified IP address ({primary_ip6}) is not assigned to this device."
- ).format(primary_ip6=self.primary_ip6)
+ "The specified IP address ({ip}) is not assigned to this device."
+ ).format(ip=self.primary_ip6)
})
if self.oob_ip:
if self.oob_ip.assigned_object in vc_interfaces:
@@ -957,17 +965,19 @@ class Device(
raise ValidationError({
'platform': _(
"The assigned platform is limited to {platform_manufacturer} device types, but this device's "
- "type belongs to {device_type_manufacturer}."
+ "type belongs to {devicetype_manufacturer}."
).format(
platform_manufacturer=self.platform.manufacturer,
- device_type_manufacturer=self.device_type.manufacturer
+ devicetype_manufacturer=self.device_type.manufacturer
)
})
# A Device can only be assigned to a Cluster in the same Site (or no Site)
if self.cluster and self.cluster.site is not None and self.cluster.site != self.site:
raise ValidationError({
- 'cluster': _("The assigned cluster belongs to a different site ({})").format(self.cluster.site)
+ 'cluster': _("The assigned cluster belongs to a different site ({site})").format(
+ site=self.cluster.site
+ )
})
# Validate virtual chassis assignment
@@ -984,11 +994,17 @@ class Device(
bulk_create: If True, bulk_create() will be called to create all components in a single query
(default). Otherwise, save() will be called on each instance individually.
"""
+ components = [obj.instantiate(device=self) for obj in queryset]
+ if not components:
+ return
+
+ # Set default values for any applicable custom fields
+ model = queryset.model.component_model
+ if cf_defaults := CustomField.objects.get_defaults_for_model(model):
+ for component in components:
+ component.custom_field_data = cf_defaults
+
if bulk_create:
- components = [obj.instantiate(device=self) for obj in queryset]
- if not components:
- return
- model = components[0]._meta.model
model.objects.bulk_create(components)
# Manually send the post_save signal for each of the newly created components
for component in components:
@@ -1001,8 +1017,7 @@ class Device(
update_fields=None
)
else:
- for obj in queryset:
- component = obj.instantiate(device=self)
+ for component in components:
component.save()
def save(self, *args, **kwargs):
@@ -1439,8 +1454,8 @@ class VirtualDeviceContext(PrimaryModel):
if primary_ip.family != family:
raise ValidationError({
f'primary_ip{family}': _(
- "{primary_ip} is not an IPv{family} address."
- ).format(family=family, primary_ip=primary_ip)
+ "{ip} is not an IPv{family} address."
+ ).format(family=family, ip=primary_ip)
})
device_interfaces = self.device.vc_interfaces(if_master=False)
if primary_ip.assigned_object not in device_interfaces:
diff --git a/netbox/dcim/models/mixins.py b/netbox/dcim/models/mixins.py
index 95f6d41fe..9be8dc0a3 100644
--- a/netbox/dcim/models/mixins.py
+++ b/netbox/dcim/models/mixins.py
@@ -69,7 +69,7 @@ class RenderConfigMixin(models.Model):
"""
if self.config_template:
return self.config_template
- if self.role.config_template:
+ if self.role and self.role.config_template:
return self.role.config_template
if self.platform and self.platform.config_template:
return self.platform.config_template
diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py
index 83e5eb23a..62578d6c4 100644
--- a/netbox/dcim/models/power.py
+++ b/netbox/dcim/models/power.py
@@ -174,8 +174,13 @@ class PowerFeed(PrimaryModel, PathEndpoint, CabledObjectModel):
# Rack must belong to same Site as PowerPanel
if self.rack and self.rack.site != self.power_panel.site:
- raise ValidationError(_("Rack {} ({}) and power panel {} ({}) are in different sites").format(
- self.rack, self.rack.site, self.power_panel, self.power_panel.site
+ raise ValidationError(_(
+ "Rack {rack} ({rack_site}) and power panel {powerpanel} ({powerpanel_site}) are in different sites."
+ ).format(
+ rack=self.rack,
+ rack_site=self.rack.site,
+ powerpanel=self.power_panel,
+ powerpanel_site=self.power_panel.site
))
# AC voltage cannot be negative
diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py
index ef0dde4da..3cb4e0225 100644
--- a/netbox/dcim/models/racks.py
+++ b/netbox/dcim/models/racks.py
@@ -141,6 +141,7 @@ class Rack(ContactsMixin, ImageAttachmentsMixin, PrimaryModel, WeightMixin):
starting_unit = models.PositiveSmallIntegerField(
default=RACK_STARTING_UNIT_DEFAULT,
verbose_name=_('starting unit'),
+ validators=[MinValueValidator(1),],
help_text=_('Starting unit for rack')
)
desc_units = models.BooleanField(
@@ -357,7 +358,7 @@ class Rack(ContactsMixin, ImageAttachmentsMixin, PrimaryModel, WeightMixin):
return [u for u in elevation.values()]
- def get_available_units(self, u_height=1, rack_face=None, exclude=None):
+ def get_available_units(self, u_height=1, rack_face=None, exclude=None, ignore_excluded_devices=False):
"""
Return a list of units within the rack available to accommodate a device of a given U height (default 1).
Optionally exclude one or more devices when calculating empty units (needed when moving a device from one
@@ -366,9 +367,13 @@ class Rack(ContactsMixin, ImageAttachmentsMixin, PrimaryModel, WeightMixin):
:param u_height: Minimum number of contiguous free units required
:param rack_face: The face of the rack (front or rear) required; 'None' if device is full depth
:param exclude: List of devices IDs to exclude (useful when moving a device within a rack)
+ :param ignore_excluded_devices: Ignore devices that are marked to exclude from utilization calculations
"""
# Gather all devices which consume U space within the rack
devices = self.devices.prefetch_related('device_type').filter(position__gte=1)
+ if ignore_excluded_devices:
+ devices = devices.exclude(device_type__exclude_from_utilization=True)
+
if exclude is not None:
devices = devices.exclude(pk__in=exclude)
@@ -453,7 +458,7 @@ class Rack(ContactsMixin, ImageAttachmentsMixin, PrimaryModel, WeightMixin):
"""
# Determine unoccupied units
total_units = len(list(self.units))
- available_units = self.get_available_units(u_height=0.5)
+ available_units = self.get_available_units(u_height=0.5, ignore_excluded_devices=True)
# Remove reserved units
for ru in self.get_reserved_units():
@@ -558,9 +563,9 @@ class RackReservation(PrimaryModel):
invalid_units = [u for u in self.units if u not in self.rack.units]
if invalid_units:
raise ValidationError({
- 'units': _("Invalid unit(s) for {}U rack: {}").format(
- self.rack.u_height,
- ', '.join([str(u) for u in invalid_units]),
+ 'units': _("Invalid unit(s) for {height}U rack: {unit_list}").format(
+ height=self.rack.u_height,
+ unit_list=', '.join([str(u) for u in invalid_units])
),
})
@@ -571,8 +576,8 @@ class RackReservation(PrimaryModel):
conflicting_units = [u for u in self.units if u in reserved_units]
if conflicting_units:
raise ValidationError({
- 'units': _('The following units have already been reserved: {}').format(
- ', '.join([str(u) for u in conflicting_units]),
+ 'units': _('The following units have already been reserved: {unit_list}').format(
+ unit_list=', '.join([str(u) for u in conflicting_units])
)
})
diff --git a/netbox/dcim/search.py b/netbox/dcim/search.py
index f70c729f4..18cf75a9a 100644
--- a/netbox/dcim/search.py
+++ b/netbox/dcim/search.py
@@ -10,6 +10,7 @@ class CableIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('type', 'status', 'tenant', 'label', 'description')
@register_search
@@ -21,6 +22,7 @@ class ConsolePortIndex(SearchIndex):
('description', 500),
('speed', 2000),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -32,6 +34,7 @@ class ConsoleServerPortIndex(SearchIndex):
('description', 500),
('speed', 2000),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -44,6 +47,10 @@ class DeviceIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = (
+ 'site', 'location', 'rack', 'status', 'device_type', 'role', 'tenant', 'platform', 'serial', 'asset_tag',
+ 'description',
+ )
@register_search
@@ -54,6 +61,7 @@ class DeviceBayIndex(SearchIndex):
('label', 200),
('description', 500),
)
+ display_attrs = ('device', 'label', 'description')
@register_search
@@ -64,6 +72,7 @@ class DeviceRoleIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('description',)
@register_search
@@ -75,6 +84,7 @@ class DeviceTypeIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('manufacturer', 'part_number', 'description')
@register_search
@@ -85,6 +95,7 @@ class FrontPortIndex(SearchIndex):
('label', 200),
('description', 500),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -99,6 +110,7 @@ class InterfaceIndex(SearchIndex):
('mtu', 2000),
('speed', 2000),
)
+ display_attrs = ('device', 'label', 'type', 'mac_address', 'wwn', 'description')
@register_search
@@ -112,6 +124,7 @@ class InventoryItemIndex(SearchIndex):
('description', 500),
('part_id', 2000),
)
+ display_attrs = ('device', 'manufacturer', 'parent', 'part_id', 'serial', 'asset_tag', 'description')
@register_search
@@ -122,6 +135,7 @@ class LocationIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('site', 'status', 'tenant', 'description')
@register_search
@@ -132,6 +146,7 @@ class ManufacturerIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('description',)
@register_search
@@ -143,6 +158,7 @@ class ModuleIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('device', 'module_bay', 'module_type', 'status', 'serial', 'asset_tag', 'description')
@register_search
@@ -153,6 +169,7 @@ class ModuleBayIndex(SearchIndex):
('label', 200),
('description', 500),
)
+ display_attrs = ('device', 'label', 'position', 'description')
@register_search
@@ -164,6 +181,7 @@ class ModuleTypeIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('manufacturer', 'model', 'part_number', 'description')
@register_search
@@ -174,6 +192,7 @@ class PlatformIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('manufacturer', 'description')
@register_search
@@ -184,6 +203,7 @@ class PowerFeedIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('power_panel', 'rack', 'status', 'description')
@register_search
@@ -194,6 +214,7 @@ class PowerOutletIndex(SearchIndex):
('label', 200),
('description', 500),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -204,6 +225,7 @@ class PowerPanelIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('site', 'location', 'description')
@register_search
@@ -216,6 +238,7 @@ class PowerPortIndex(SearchIndex):
('maximum_draw', 2000),
('allocated_draw', 2000),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -229,6 +252,9 @@ class RackIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = (
+ 'site', 'location', 'facility_id', 'tenant', 'status', 'role', 'serial', 'asset_tag', 'description',
+ )
@register_search
@@ -238,6 +264,7 @@ class RackReservationIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('rack', 'tenant', 'user', 'description')
@register_search
@@ -248,6 +275,7 @@ class RackRoleIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('description',)
@register_search
@@ -258,6 +286,7 @@ class RearPortIndex(SearchIndex):
('label', 200),
('description', 500),
)
+ display_attrs = ('device', 'label', 'type', 'description')
@register_search
@@ -268,6 +297,7 @@ class RegionIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('parent', 'description')
@register_search
@@ -282,6 +312,7 @@ class SiteIndex(SearchIndex):
('shipping_address', 2000),
('comments', 5000),
)
+ display_attrs = ('region', 'group', 'status', 'tenant', 'facility', 'description')
@register_search
@@ -292,6 +323,7 @@ class SiteGroupIndex(SearchIndex):
('slug', 110),
('description', 500),
)
+ display_attrs = ('parent', 'description')
@register_search
@@ -303,6 +335,7 @@ class VirtualChassisIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('master', 'domain', 'description')
@register_search
@@ -314,3 +347,4 @@ class VirtualDeviceContextIndex(SearchIndex):
('description', 500),
('comments', 5000),
)
+ display_attrs = ('device', 'status', 'identifier', 'tenant', 'description')
diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py
index 9413726fa..d7365161e 100644
--- a/netbox/dcim/svg/cables.py
+++ b/netbox/dcim/svg/cables.py
@@ -32,11 +32,18 @@ class Node(Hyperlink):
color: Box fill color (RRGGBB format)
labels: An iterable of text strings. Each label will render on a new line within the box.
radius: Box corner radius, for rounded corners (default: 10)
+ object: A copy of the object to allow reference when drawing cables to determine which cables are connected to
+ which terminations.
"""
- def __init__(self, position, width, url, color, labels, radius=10, **extra):
+ object = None
+
+ def __init__(self, position, width, url, color, labels, radius=10, object=object, **extra):
super(Node, self).__init__(href=url, target='_parent', **extra)
+ # Save object for reference by cable systems
+ self.object = object
+
x, y = position
# Add the box
@@ -77,7 +84,7 @@ class Connector(Group):
labels: Iterable of text labels
"""
- def __init__(self, start, url, color, labels=[], **extra):
+ def __init__(self, start, url, color, labels=[], description=[], **extra):
super().__init__(class_='connector', **extra)
self.start = start
@@ -104,6 +111,8 @@ class Connector(Group):
text_coords = (start[0] + PADDING * 2, cursor - LINE_HEIGHT / 2)
text = Text(label, insert=text_coords, class_='bold' if not i else [])
link.add(text)
+ if len(description) > 0:
+ link.set_desc("\n".join(description))
self.add(link)
@@ -150,7 +159,10 @@ class CableTraceSVG:
labels.append(location_label)
elif instance._meta.model_name == 'circuit':
labels[0] = f'Circuit {instance}'
+ labels.append(instance.type)
labels.append(instance.provider)
+ if instance.description:
+ labels.append(instance.description)
elif instance._meta.model_name == 'circuittermination':
if instance.xconnect_id:
labels.append(f'{instance.xconnect_id}')
@@ -170,6 +182,8 @@ class CableTraceSVG:
if hasattr(instance, 'role'):
# Device
return instance.role.color
+ elif instance._meta.model_name == 'circuit' and instance.type.color:
+ return instance.type.color
else:
# Other parent object
return 'e0e0e0'
@@ -206,7 +220,8 @@ class CableTraceSVG:
url=f'{self.base_url}{term.get_absolute_url()}',
color=self._get_color(term),
labels=self._get_labels(term),
- radius=5
+ radius=5,
+ object=term
)
nodes_height = max(nodes_height, node.box['height'])
nodes.append(node)
@@ -238,22 +253,65 @@ class CableTraceSVG:
Polyline(points=points, style=f'stroke: #{connector.color}'),
))
- def draw_cable(self, cable):
- labels = [
- f'Cable {cable}',
- cable.get_status_display()
- ]
- if cable.type:
- labels.append(cable.get_type_display())
- if cable.length and cable.length_unit:
- labels.append(f'{cable.length} {cable.get_length_unit_display()}')
+ def draw_cable(self, cable, terminations, cable_count=0):
+ """
+ Draw a single cable. Terminations and cable count are passed for determining position and padding
+
+ :param cable: The cable to draw
+ :param terminations: List of terminations to build positioning data off of
+ :param cable_count: Count of all cables on this layer for determining whether to collapse description into a
+ tooltip.
+ """
+
+ # If the cable count is higher than 2, collapse the description into a tooltip
+ if cable_count > 2:
+ # Use the cable __str__ function to denote the cable
+ labels = [f'{cable}']
+
+ # Include the label and the status description in the tooltip
+ description = [
+ f'Cable {cable}',
+ cable.get_status_display()
+ ]
+
+ if cable.type:
+ # Include the cable type in the tooltip
+ description.append(cable.get_type_display())
+ if cable.length is not None and cable.length_unit:
+ # Include the cable length in the tooltip
+ description.append(f'{cable.length} {cable.get_length_unit_display()}')
+ else:
+ labels = [
+ f'Cable {cable}',
+ cable.get_status_display()
+ ]
+ description = []
+ if cable.type:
+ labels.append(cable.get_type_display())
+ if cable.length is not None and cable.length_unit:
+ # Include the cable length in the tooltip
+ labels.append(f'{cable.length} {cable.get_length_unit_display()}')
+
+ # If there is only one termination, center on that termination
+ # Otherwise average the center across the terminations
+ if len(terminations) == 1:
+ center = terminations[0].bottom_center[0]
+ else:
+ # Get a list of termination centers
+ termination_centers = [term.bottom_center[0] for term in terminations]
+ # Average the centers
+ center = sum(termination_centers) / len(termination_centers)
+
+ # Create the connector
connector = Connector(
- start=(self.center + OFFSET, self.cursor),
+ start=(center, self.cursor),
color=cable.color or '000000',
url=f'{self.base_url}{cable.get_absolute_url()}',
- labels=labels
+ labels=labels,
+ description=description
)
+ # Set the cursor position
self.cursor += connector.height
return connector
@@ -334,34 +392,52 @@ class CableTraceSVG:
# Connector (a Cable or WirelessLink)
if links:
- link = links[0] # Remove Cable from list
+ link_cables = {}
+ fanin = False
+ fanout = False
- # Cable
- if type(link) is Cable:
+ # Determine if we have fanins or fanouts
+ if len(near_ends) > len(set(links)):
+ self.cursor += FANOUT_HEIGHT
+ fanin = True
+ if len(far_ends) > len(set(links)):
+ fanout = True
+ cursor = self.cursor
+ for link in links:
+ # Cable
+ if type(link) is Cable and not link_cables.get(link.pk):
+ # Reset cursor
+ self.cursor = cursor
+ # Generate a list of terminations connected to this cable
+ near_end_link_terminations = [term for term in terminations if term.object.cable == link]
+ # Draw the cable
+ cable = self.draw_cable(link, near_end_link_terminations, cable_count=len(links))
+ # Add cable to the list of cables
+ link_cables.update({link.pk: cable})
+ # Add cable to drawing
+ self.connectors.append(cable)
- # Account for fan-ins height
- if len(near_ends) > 1:
- self.cursor += FANOUT_HEIGHT
+ # Draw fan-ins
+ if len(near_ends) > 1 and fanin:
+ for term in terminations:
+ if term.object.cable == link:
+ self.draw_fanin(term, cable)
- cable = self.draw_cable(link)
- self.connectors.append(cable)
-
- # Draw fan-ins
- if len(near_ends) > 1:
- for term in terminations:
- self.draw_fanin(term, cable)
-
- # WirelessLink
- elif type(link) is WirelessLink:
- wirelesslink = self.draw_wirelesslink(link)
- self.connectors.append(wirelesslink)
+ # WirelessLink
+ elif type(link) is WirelessLink:
+ wirelesslink = self.draw_wirelesslink(link)
+ self.connectors.append(wirelesslink)
# Far end termination(s)
if len(far_ends) > 1:
- self.cursor += FANOUT_HEIGHT
- terminations = self.draw_terminations(far_ends)
- for term in terminations:
- self.draw_fanout(term, cable)
+ if fanout:
+ self.cursor += FANOUT_HEIGHT
+ terminations = self.draw_terminations(far_ends)
+ for term in terminations:
+ if hasattr(term.object, 'cable') and link_cables.get(term.object.cable.pk):
+ self.draw_fanout(term, link_cables.get(term.object.cable.pk))
+ else:
+ self.draw_terminations(far_ends)
elif far_ends:
self.draw_terminations(far_ends)
else:
diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py
index 68c24ca14..4c863e12a 100644
--- a/netbox/dcim/tables/devices.py
+++ b/netbox/dcim/tables/devices.py
@@ -64,9 +64,19 @@ def get_interface_state_attribute(record):
Get interface enabled state as string to attach to 00ff00'),
}
diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py
index 1ea361a7c..c91e3b8c6 100644
--- a/netbox/extras/forms/filtersets.py
+++ b/netbox/extras/forms/filtersets.py
@@ -1,14 +1,13 @@
from django import forms
from django.contrib.auth import get_user_model
-from django.contrib.contenttypes.models import ContentType
from django.utils.translation import gettext_lazy as _
-from core.models import DataFile, DataSource
+from core.models import ContentType, DataFile, DataSource
from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup
from extras.choices import *
from extras.models import *
-from extras.utils import FeatureQuery
from netbox.forms.base import NetBoxModelFilterSetForm
+from netbox.forms.mixins import SavedFiltersMixin
from tenancy.models import Tenant, TenantGroup
from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, FilterForm, add_blank_choice
from utilities.forms.fields import (
@@ -16,15 +15,14 @@ from utilities.forms.fields import (
)
from utilities.forms.widgets import APISelectMultiple, DateTimePicker
from virtualization.models import Cluster, ClusterGroup, ClusterType
-from .mixins import *
__all__ = (
'ConfigContextFilterForm',
- 'ConfigRevisionFilterForm',
'ConfigTemplateFilterForm',
'CustomFieldChoiceSetFilterForm',
'CustomFieldFilterForm',
'CustomLinkFilterForm',
+ 'EventRuleFilterForm',
'ExportTemplateFilterForm',
'ImageAttachmentFilterForm',
'JournalEntryFilterForm',
@@ -40,12 +38,12 @@ class CustomFieldFilterForm(SavedFiltersMixin, FilterForm):
fieldsets = (
(None, ('q', 'filter_id')),
(_('Attributes'), (
- 'type', 'content_type_id', 'group_name', 'weight', 'required', 'choice_set_id', 'ui_visibility',
+ 'type', 'content_type_id', 'group_name', 'weight', 'required', 'choice_set_id', 'ui_visible', 'ui_editable',
'is_cloneable',
)),
)
content_type_id = ContentTypeMultipleChoiceField(
- queryset=ContentType.objects.filter(FeatureQuery('custom_fields').get_query()),
+ queryset=ContentType.objects.with_feature('custom_fields'),
required=False,
label=_('Object type')
)
@@ -74,10 +72,15 @@ class CustomFieldFilterForm(SavedFiltersMixin, FilterForm):
required=False,
label=_('Choice set')
)
- ui_visibility = forms.ChoiceField(
- choices=add_blank_choice(CustomFieldVisibilityChoices),
+ ui_visible = forms.ChoiceField(
+ choices=add_blank_choice(CustomFieldUIVisibleChoices),
required=False,
- label=_('UI visibility')
+ label=_('UI visible')
+ )
+ ui_editable = forms.ChoiceField(
+ choices=add_blank_choice(CustomFieldUIEditableChoices),
+ required=False,
+ label=_('UI editable')
)
is_cloneable = forms.NullBooleanField(
label=_('Is cloneable'),
@@ -109,7 +112,7 @@ class CustomLinkFilterForm(SavedFiltersMixin, FilterForm):
)
content_types = ContentTypeMultipleChoiceField(
label=_('Content types'),
- queryset=ContentType.objects.filter(FeatureQuery('custom_links').get_query()),
+ queryset=ContentType.objects.with_feature('custom_links'),
required=False
)
enabled = forms.NullBooleanField(
@@ -136,7 +139,7 @@ class ExportTemplateFilterForm(SavedFiltersMixin, FilterForm):
fieldsets = (
(None, ('q', 'filter_id')),
(_('Data'), ('data_source_id', 'data_file_id')),
- (_('Attributes'), ('content_types', 'mime_type', 'file_extension', 'as_attachment')),
+ (_('Attributes'), ('content_type_id', 'mime_type', 'file_extension', 'as_attachment')),
)
data_source_id = DynamicModelMultipleChoiceField(
queryset=DataSource.objects.all(),
@@ -151,10 +154,10 @@ class ExportTemplateFilterForm(SavedFiltersMixin, FilterForm):
'source_id': '$data_source_id'
}
)
- content_types = ContentTypeMultipleChoiceField(
- label=_('Content types'),
- queryset=ContentType.objects.filter(FeatureQuery('export_templates').get_query()),
- required=False
+ content_type_id = ContentTypeMultipleChoiceField(
+ queryset=ContentType.objects.with_feature('export_templates'),
+ required=False,
+ label=_('Content types')
)
mime_type = forms.CharField(
required=False,
@@ -180,7 +183,7 @@ class ImageAttachmentFilterForm(SavedFiltersMixin, FilterForm):
)
content_type_id = ContentTypeChoiceField(
label=_('Content type'),
- queryset=ContentType.objects.filter(FeatureQuery('image_attachments').get_query()),
+ queryset=ContentType.objects.with_feature('image_attachments'),
required=False
)
name = forms.CharField(
@@ -196,7 +199,7 @@ class SavedFilterFilterForm(SavedFiltersMixin, FilterForm):
)
content_types = ContentTypeMultipleChoiceField(
label=_('Content types'),
- queryset=ContentType.objects.filter(FeatureQuery('export_templates').get_query()),
+ queryset=ContentType.objects.public(),
required=False
)
enabled = forms.NullBooleanField(
@@ -221,23 +224,45 @@ class SavedFilterFilterForm(SavedFiltersMixin, FilterForm):
class WebhookFilterForm(NetBoxModelFilterSetForm):
model = Webhook
- tag = TagFilterField(model)
-
fieldsets = (
(None, ('q', 'filter_id', 'tag')),
- (_('Attributes'), ('content_type_id', 'http_method', 'enabled')),
- (_('Events'), ('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end')),
+ (_('Attributes'), ('payload_url', 'http_method', 'http_content_type')),
)
- content_type_id = ContentTypeMultipleChoiceField(
- queryset=ContentType.objects.filter(FeatureQuery('webhooks').get_query()),
- required=False,
- label=_('Object type')
+ http_content_type = forms.CharField(
+ label=_('HTTP content type'),
+ required=False
+ )
+ payload_url = forms.CharField(
+ label=_('Payload URL'),
+ required=False
)
http_method = forms.MultipleChoiceField(
choices=WebhookHttpMethodChoices,
required=False,
label=_('HTTP method')
)
+ tag = TagFilterField(model)
+
+
+class EventRuleFilterForm(NetBoxModelFilterSetForm):
+ model = EventRule
+ tag = TagFilterField(model)
+
+ fieldsets = (
+ (None, ('q', 'filter_id', 'tag')),
+ (_('Attributes'), ('content_type_id', 'action_type', 'enabled')),
+ (_('Events'), ('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end')),
+ )
+ content_type_id = ContentTypeMultipleChoiceField(
+ queryset=ContentType.objects.with_feature('event_rules'),
+ required=False,
+ label=_('Object type')
+ )
+ action_type = forms.ChoiceField(
+ choices=add_blank_choice(EventRuleActionChoices),
+ required=False,
+ label=_('Action type')
+ )
enabled = forms.NullBooleanField(
label=_('Enabled'),
required=False,
@@ -285,12 +310,12 @@ class WebhookFilterForm(NetBoxModelFilterSetForm):
class TagFilterForm(SavedFiltersMixin, FilterForm):
model = Tag
content_type_id = ContentTypeMultipleChoiceField(
- queryset=ContentType.objects.filter(FeatureQuery('tags').get_query()),
+ queryset=ContentType.objects.with_feature('tags'),
required=False,
label=_('Tagged object type')
)
for_object_type_id = ContentTypeChoiceField(
- queryset=ContentType.objects.filter(FeatureQuery('tags').get_query()),
+ queryset=ContentType.objects.with_feature('tags'),
required=False,
label=_('Allowed object type')
)
@@ -496,9 +521,3 @@ class ObjectChangeFilterForm(SavedFiltersMixin, FilterForm):
api_url='/api/extras/content-types/',
)
)
-
-
-class ConfigRevisionFilterForm(SavedFiltersMixin, FilterForm):
- fieldsets = (
- (None, ('q', 'filter_id')),
- )
diff --git a/netbox/extras/forms/model_forms.py b/netbox/extras/forms/model_forms.py
index 47bde65f9..346225c8a 100644
--- a/netbox/extras/forms/model_forms.py
+++ b/netbox/extras/forms/model_forms.py
@@ -1,36 +1,34 @@
import json
+import re
from django import forms
-from django.conf import settings
-from django.db.models import Q
from django.contrib.contenttypes.models import ContentType
+from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from core.forms.mixins import SyncedDataMixin
+from core.models import ContentType
from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup
from extras.choices import *
from extras.models import *
-from extras.utils import FeatureQuery
-from netbox.config import get_config, PARAMS
from netbox.forms import NetBoxModelForm
from tenancy.models import Tenant, TenantGroup
-from utilities.forms import BootstrapMixin, add_blank_choice
+from utilities.forms import BootstrapMixin, add_blank_choice, get_field_value
from utilities.forms.fields import (
CommentField, ContentTypeChoiceField, ContentTypeMultipleChoiceField, DynamicModelChoiceField,
DynamicModelMultipleChoiceField, JSONField, SlugField,
)
-from utilities.forms.widgets import ChoicesWidget
+from utilities.forms.widgets import ChoicesWidget, HTMXSelect
from virtualization.models import Cluster, ClusterGroup, ClusterType
-
__all__ = (
'BookmarkForm',
'ConfigContextForm',
- 'ConfigRevisionForm',
'ConfigTemplateForm',
'CustomFieldChoiceSetForm',
'CustomFieldForm',
'CustomLinkForm',
+ 'EventRuleForm',
'ExportTemplateForm',
'ImageAttachmentForm',
'JournalEntryForm',
@@ -43,14 +41,11 @@ __all__ = (
class CustomFieldForm(BootstrapMixin, forms.ModelForm):
content_types = ContentTypeMultipleChoiceField(
label=_('Content types'),
- queryset=ContentType.objects.all(),
- limit_choices_to=FeatureQuery('custom_fields'),
+ queryset=ContentType.objects.with_feature('custom_fields')
)
object_type = ContentTypeChoiceField(
label=_('Object type'),
- queryset=ContentType.objects.all(),
- # TODO: Come up with a canonical way to register suitable models
- limit_choices_to=FeatureQuery('webhooks').get_query() | Q(app_label='auth', model__in=['user', 'group']),
+ queryset=ContentType.objects.public(),
required=False,
help_text=_("Type of the related object (for object/multi-object fields only)")
)
@@ -63,7 +58,7 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm):
(_('Custom Field'), (
'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'required', 'description',
)),
- (_('Behavior'), ('search_weight', 'filter_logic', 'ui_visibility', 'weight', 'is_cloneable')),
+ (_('Behavior'), ('search_weight', 'filter_logic', 'ui_visible', 'ui_editable', 'weight', 'is_cloneable')),
(_('Values'), ('default', 'choice_set')),
(_('Validation'), ('validation_minimum', 'validation_maximum', 'validation_regex')),
)
@@ -75,13 +70,15 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm):
'type': _(
"The type of data stored in this field. For object/multi-object fields, select the related object "
"type below."
- )
+ ),
+ 'description': _("This will be displayed as help text for the form field. Markdown is supported.")
}
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
- # Disable changing the type of a CustomField as it almost universally causes errors if custom field data is already present.
+ # Disable changing the type of a CustomField as it almost universally causes errors if custom field data
+ # is already present.
if self.instance.pk:
self.fields['type'].disabled = True
@@ -90,21 +87,35 @@ class CustomFieldChoiceSetForm(BootstrapMixin, forms.ModelForm):
extra_choices = forms.CharField(
widget=ChoicesWidget(),
required=False,
- help_text=_(
+ help_text=mark_safe(_(
'Enter one choice per line. An optional label may be specified for each choice by appending it with a '
- 'comma (for example, "choice1,First Choice").'
- )
+ 'colon. Example:'
+ ) + ' choice1:First Choice')
)
class Meta:
model = CustomFieldChoiceSet
fields = ('name', 'description', 'base_choices', 'extra_choices', 'order_alphabetically')
+ def __init__(self, *args, initial=None, **kwargs):
+ super().__init__(*args, initial=initial, **kwargs)
+
+ # Escape colons in extra_choices
+ if 'extra_choices' in self.initial and self.initial['extra_choices']:
+ choices = []
+ for choice in self.initial['extra_choices']:
+ choice = (choice[0].replace(':', '\\:'), choice[1].replace(':', '\\:'))
+ choices.append(choice)
+
+ self.initial['extra_choices'] = choices
+
def clean_extra_choices(self):
data = []
for line in self.cleaned_data['extra_choices'].splitlines():
try:
- value, label = line.split(',', maxsplit=1)
+ value, label = re.split(r'(?JSON format.')
+ )
+ action_data = JSONField(
+ required=False,
+ help_text=_('Enter parameters to pass to the action in JSON format.')
+ )
+
+ fieldsets = (
+ (_('Event Rule'), ('name', 'description', 'content_types', 'enabled', 'tags')),
+ (_('Events'), ('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end')),
+ (_('Conditions'), ('conditions',)),
+ (_('Action'), (
+ 'action_type', 'action_choice', 'action_object_type', 'action_object_id', 'action_data',
+ )),
+ )
+
+ class Meta:
+ model = EventRule
+ fields = (
+ 'content_types', 'name', 'description', 'type_create', 'type_update', 'type_delete', 'type_job_start',
+ 'type_job_end', 'enabled', 'conditions', 'action_type', 'action_object_type', 'action_object_id',
+ 'action_data', 'comments', 'tags'
+ )
labels = {
'type_create': _('Creations'),
'type_update': _('Updates'),
@@ -247,18 +288,90 @@ class WebhookForm(NetBoxModelForm):
'type_job_end': _('Job terminations'),
}
widgets = {
- 'additional_headers': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'body_template': forms.Textarea(attrs={'class': 'font-monospace'}),
'conditions': forms.Textarea(attrs={'class': 'font-monospace'}),
+ 'action_type': HTMXSelect(),
+ 'action_object_type': forms.HiddenInput,
+ 'action_object_id': forms.HiddenInput,
}
+ def init_script_choice(self):
+ choices = []
+ for module in ScriptModule.objects.all():
+ scripts = []
+ for script_name in module.scripts.keys():
+ name = f"{str(module.pk)}:{script_name}"
+ scripts.append((name, script_name))
+ if scripts:
+ choices.append((str(module), scripts))
+ self.fields['action_choice'].choices = choices
+
+ if self.instance.action_type == EventRuleActionChoices.SCRIPT and self.instance.action_parameters:
+ scriptmodule_id = self.instance.action_object_id
+ script_name = self.instance.action_parameters.get('script_name')
+ self.fields['action_choice'].initial = f'{scriptmodule_id}:{script_name}'
+
+ def init_webhook_choice(self):
+ initial = None
+ if self.instance.action_type == EventRuleActionChoices.WEBHOOK:
+ webhook_id = get_field_value(self, 'action_object_id')
+ initial = Webhook.objects.get(pk=webhook_id) if webhook_id else None
+ self.fields['action_choice'] = DynamicModelChoiceField(
+ label=_('Webhook'),
+ queryset=Webhook.objects.all(),
+ required=True,
+ initial=initial
+ )
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.fields['action_object_type'].required = False
+ self.fields['action_object_id'].required = False
+
+ # Determine the action type
+ action_type = get_field_value(self, 'action_type')
+
+ if action_type == EventRuleActionChoices.WEBHOOK:
+ self.init_webhook_choice()
+ elif action_type == EventRuleActionChoices.SCRIPT:
+ self.init_script_choice()
+
+ def clean(self):
+ super().clean()
+
+ action_choice = self.cleaned_data.get('action_choice')
+ # Webhook
+ if self.cleaned_data.get('action_type') == EventRuleActionChoices.WEBHOOK:
+ self.cleaned_data['action_object_type'] = ContentType.objects.get_for_model(action_choice)
+ self.cleaned_data['action_object_id'] = action_choice.id
+ # Script
+ elif self.cleaned_data.get('action_type') == EventRuleActionChoices.SCRIPT:
+ self.cleaned_data['action_object_type'] = ContentType.objects.get_for_model(
+ ScriptModule,
+ for_concrete_model=False
+ )
+ module_id, script_name = action_choice.split(":", maxsplit=1)
+ self.cleaned_data['action_object_id'] = module_id
+
+ return self.cleaned_data
+
+ def save(self, *args, **kwargs):
+ # Set action_parameters on the instance
+ if self.cleaned_data['action_type'] == EventRuleActionChoices.SCRIPT:
+ module_id, script_name = self.cleaned_data.get('action_choice').split(":", maxsplit=1)
+ self.instance.action_parameters = {
+ 'script_name': script_name,
+ }
+ else:
+ self.instance.action_parameters = None
+
+ return super().save(*args, **kwargs)
+
class TagForm(BootstrapMixin, forms.ModelForm):
slug = SlugField()
object_types = ContentTypeMultipleChoiceField(
label=_('Object types'),
- queryset=ContentType.objects.all(),
- limit_choices_to=FeatureQuery('tags'),
+ queryset=ContentType.objects.with_feature('tags'),
required=False
)
@@ -325,7 +438,7 @@ class ConfigContextForm(BootstrapMixin, SyncedDataMixin, forms.ModelForm):
required=False
)
tenant_groups = DynamicModelMultipleChoiceField(
- label=_('Tenat groups'),
+ label=_('Tenant groups'),
queryset=TenantGroup.objects.all(),
required=False
)
@@ -452,99 +565,3 @@ class JournalEntryForm(NetBoxModelForm):
'assigned_object_type': forms.HiddenInput,
'assigned_object_id': forms.HiddenInput,
}
-
-
-EMPTY_VALUES = ('', None, [], ())
-
-
-class ConfigFormMetaclass(forms.models.ModelFormMetaclass):
-
- def __new__(mcs, name, bases, attrs):
-
- # Emulate a declared field for each supported configuration parameter
- param_fields = {}
- for param in PARAMS:
- field_kwargs = {
- 'required': False,
- 'label': param.label,
- 'help_text': param.description,
- }
- field_kwargs.update(**param.field_kwargs)
- param_fields[param.name] = param.field(**field_kwargs)
- attrs.update(param_fields)
-
- return super().__new__(mcs, name, bases, attrs)
-
-
-class ConfigRevisionForm(BootstrapMixin, forms.ModelForm, metaclass=ConfigFormMetaclass):
- """
- Form for creating a new ConfigRevision.
- """
-
- fieldsets = (
- (_('Rack Elevations'), ('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH')),
- (_('Power'), ('POWERFEED_DEFAULT_VOLTAGE', 'POWERFEED_DEFAULT_AMPERAGE', 'POWERFEED_DEFAULT_MAX_UTILIZATION')),
- (_('IPAM'), ('ENFORCE_GLOBAL_UNIQUE', 'PREFER_IPV4')),
- (_('Security'), ('ALLOWED_URL_SCHEMES',)),
- (_('Banners'), ('BANNER_LOGIN', 'BANNER_MAINTENANCE', 'BANNER_TOP', 'BANNER_BOTTOM')),
- (_('Pagination'), ('PAGINATE_COUNT', 'MAX_PAGE_SIZE')),
- (_('Validation'), ('CUSTOM_VALIDATORS',)),
- (_('User Preferences'), ('DEFAULT_USER_PREFERENCES',)),
- (_('Miscellaneous'), ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOB_RETENTION', 'MAPS_URL')),
- (_('Config Revision'), ('comment',))
- )
-
- class Meta:
- model = ConfigRevision
- fields = '__all__'
- widgets = {
- 'BANNER_LOGIN': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'BANNER_MAINTENANCE': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'BANNER_TOP': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'BANNER_BOTTOM': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'CUSTOM_VALIDATORS': forms.Textarea(attrs={'class': 'font-monospace'}),
- 'comment': forms.Textarea(),
- }
-
- def __init__(self, *args, **kwargs):
- super().__init__(*args, **kwargs)
-
- # Append current parameter values to form field help texts and check for static configurations
- config = get_config()
- for param in PARAMS:
- value = getattr(config, param.name)
- is_static = hasattr(settings, param.name)
- if value:
- help_text = self.fields[param.name].help_text
- if help_text:
- help_text += '{stacktrace}")
logger.error(f"Exception raised during report execution: {e}")
- job.terminate(status=JobStatusChoices.STATUS_ERRORED)
+ job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
# Perform any post-run tasks
self.post_run()
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 9fa31db31..f28465547 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -17,13 +17,13 @@ from core.models import Job
from extras.api.serializers import ScriptOutputSerializer
from extras.choices import LogLevelChoices
from extras.models import ScriptModule
-from extras.signals import clear_webhooks
+from extras.signals import clear_events
from ipam.formfields import IPAddressFormField, IPNetworkFormField
from ipam.validators import MaxPrefixLengthValidator, MinPrefixLengthValidator, prefix_validator
from utilities.exceptions import AbortScript, AbortTransaction
from utilities.forms import add_blank_choice
from utilities.forms.fields import DynamicModelChoiceField, DynamicModelMultipleChoiceField
-from .context_managers import change_logging
+from .context_managers import event_tracking
from .forms import ScriptForm
__all__ = (
@@ -401,23 +401,23 @@ class BaseScript:
def log_debug(self, message):
self.logger.log(logging.DEBUG, message)
- self.log.append((LogLevelChoices.LOG_DEFAULT, message))
+ self.log.append((LogLevelChoices.LOG_DEFAULT, str(message)))
def log_success(self, message):
self.logger.log(logging.INFO, message) # No syslog equivalent for SUCCESS
- self.log.append((LogLevelChoices.LOG_SUCCESS, message))
+ self.log.append((LogLevelChoices.LOG_SUCCESS, str(message)))
def log_info(self, message):
self.logger.log(logging.INFO, message)
- self.log.append((LogLevelChoices.LOG_INFO, message))
+ self.log.append((LogLevelChoices.LOG_INFO, str(message)))
def log_warning(self, message):
self.logger.log(logging.WARNING, message)
- self.log.append((LogLevelChoices.LOG_WARNING, message))
+ self.log.append((LogLevelChoices.LOG_WARNING, str(message)))
def log_failure(self, message):
self.logger.log(logging.ERROR, message)
- self.log.append((LogLevelChoices.LOG_FAILURE, message))
+ self.log.append((LogLevelChoices.LOG_FAILURE, str(message)))
# Convenience functions
@@ -472,10 +472,16 @@ def get_module_and_script(module_name, script_name):
return module, script
-def run_script(data, request, job, commit=True, **kwargs):
+def run_script(data, job, request=None, commit=True, **kwargs):
"""
A wrapper for calling Script.run(). This performs error handling and provides a hook for committing changes. It
exists outside the Script class to ensure it cannot be overridden by a script author.
+
+ Args:
+ data: A dictionary of data to be passed to the script upon execution
+ job: The Job associated with this execution
+ request: The WSGI request associated with this execution (if any)
+ commit: Passed through to Script.run()
"""
job.start()
@@ -486,9 +492,10 @@ def run_script(data, request, job, commit=True, **kwargs):
logger.info(f"Running script (commit={commit})")
# Add files to form data
- files = request.FILES
- for field_name, fileobj in files.items():
- data[field_name] = fileobj
+ if request:
+ files = request.FILES
+ for field_name, fileobj in files.items():
+ data[field_name] = fileobj
# Add the current request as a property of the script
script.request = request
@@ -496,7 +503,7 @@ def run_script(data, request, job, commit=True, **kwargs):
def _run_script():
"""
Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
- the change_logging context manager (which is bypassed if commit == False).
+ the event_tracking context manager (which is bypassed if commit == False).
"""
try:
try:
@@ -506,7 +513,8 @@ def run_script(data, request, job, commit=True, **kwargs):
raise AbortTransaction()
except AbortTransaction:
script.log_info("Database changes have been reverted automatically.")
- clear_webhooks.send(request)
+ if request:
+ clear_events.send(request)
job.data = ScriptOutputSerializer(script).data
job.terminate()
except Exception as e:
@@ -519,15 +527,16 @@ def run_script(data, request, job, commit=True, **kwargs):
logger.error(f"Exception raised during script execution: {e}")
script.log_info("Database changes have been reverted due to error.")
job.data = ScriptOutputSerializer(script).data
- job.terminate(status=JobStatusChoices.STATUS_ERRORED)
- clear_webhooks.send(request)
+ job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
+ if request:
+ clear_events.send(request)
logger.info(f"Script completed in {job.duration}")
- # Execute the script. If commit is True, wrap it with the change_logging context manager to ensure we process
- # change logging, webhooks, etc.
+ # Execute the script. If commit is True, wrap it with the event_tracking context manager to ensure we process
+ # change logging, event rules, etc.
if commit:
- with change_logging(request):
+ with event_tracking(request):
_run_script()
else:
_run_script()
diff --git a/netbox/extras/search.py b/netbox/extras/search.py
index da4aa1c84..fff59fa77 100644
--- a/netbox/extras/search.py
+++ b/netbox/extras/search.py
@@ -9,3 +9,14 @@ class JournalEntryIndex(SearchIndex):
('comments', 5000),
)
category = 'Journal'
+ display_attrs = ('kind', 'created_by')
+
+
+@register_search
+class WebhookEntryIndex(SearchIndex):
+ model = models.Webhook
+ fields = (
+ ('name', 100),
+ ('description', 500),
+ )
+ display_attrs = ('description',)
diff --git a/netbox/extras/signals.py b/netbox/extras/signals.py
index d6550309f..798a9f442 100644
--- a/netbox/extras/signals.py
+++ b/netbox/extras/signals.py
@@ -2,25 +2,31 @@ import importlib
import logging
from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ValidationError
from django.db.models.signals import m2m_changed, post_save, pre_delete
from django.dispatch import receiver, Signal
+from django.utils.translation import gettext_lazy as _
from django_prometheus.models import model_deletes, model_inserts, model_updates
+from core.signals import job_end, job_start
+from extras.constants import EVENT_JOB_END, EVENT_JOB_START
+from extras.events import process_event_rules
+from extras.models import EventRule
from extras.validators import CustomValidator
from netbox.config import get_config
-from netbox.context import current_request, webhooks_queue
+from netbox.context import current_request, events_queue
from netbox.signals import post_clean
from utilities.exceptions import AbortRequest
from .choices import ObjectChangeActionChoices
-from .models import ConfigRevision, CustomField, ObjectChange, TaggedItem
-from .webhooks import enqueue_object, get_snapshots, serialize_for_webhook
+from .events import enqueue_object, get_snapshots, serialize_for_event
+from .models import CustomField, ObjectChange, TaggedItem
#
# Change logging/webhooks
#
-# Define a custom signal that can be sent to clear any queued webhooks
-clear_webhooks = Signal()
+# Define a custom signal that can be sent to clear any queued events
+clear_events = Signal()
def is_same_object(instance, webhook_data, request_id):
@@ -63,30 +69,30 @@ def handle_changed_object(sender, instance, **kwargs):
return
# Record an ObjectChange if applicable
- if hasattr(instance, 'to_objectchange'):
- if m2m_changed:
- ObjectChange.objects.filter(
- changed_object_type=ContentType.objects.get_for_model(instance),
- changed_object_id=instance.pk,
- request_id=request.id
- ).update(
- postchange_data=instance.to_objectchange(action).postchange_data
- )
- else:
- objectchange = instance.to_objectchange(action)
+ if m2m_changed:
+ ObjectChange.objects.filter(
+ changed_object_type=ContentType.objects.get_for_model(instance),
+ changed_object_id=instance.pk,
+ request_id=request.id
+ ).update(
+ postchange_data=instance.to_objectchange(action).postchange_data
+ )
+ else:
+ objectchange = instance.to_objectchange(action)
+ if objectchange and objectchange.has_changes:
objectchange.user = request.user
objectchange.request_id = request.id
objectchange.save()
# If this is an M2M change, update the previously queued webhook (from post_save)
- queue = webhooks_queue.get()
+ queue = events_queue.get()
if m2m_changed and queue and is_same_object(instance, queue[-1], request.id):
instance.refresh_from_db() # Ensure that we're working with fresh M2M assignments
- queue[-1]['data'] = serialize_for_webhook(instance)
+ queue[-1]['data'] = serialize_for_event(instance)
queue[-1]['snapshots']['postchange'] = get_snapshots(instance, action)['postchange']
else:
enqueue_object(queue, instance, request.user, request.id, action)
- webhooks_queue.set(queue)
+ events_queue.set(queue)
# Increment metric counters
if action == ObjectChangeActionChoices.ACTION_CREATE:
@@ -115,22 +121,22 @@ def handle_deleted_object(sender, instance, **kwargs):
objectchange.save()
# Enqueue webhooks
- queue = webhooks_queue.get()
+ queue = events_queue.get()
enqueue_object(queue, instance, request.user, request.id, ObjectChangeActionChoices.ACTION_DELETE)
- webhooks_queue.set(queue)
+ events_queue.set(queue)
# Increment metric counters
model_deletes.labels(instance._meta.model_name).inc()
-@receiver(clear_webhooks)
-def clear_webhook_queue(sender, **kwargs):
+@receiver(clear_events)
+def clear_events_queue(sender, **kwargs):
"""
- Delete any queued webhooks (e.g. because of an aborted bulk transaction)
+ Delete any queued events (e.g. because of an aborted bulk transaction)
"""
- logger = logging.getLogger('webhooks')
- logger.info(f"Clearing {len(webhooks_queue.get())} queued webhooks ({sender})")
- webhooks_queue.set([])
+ logger = logging.getLogger('events')
+ logger.info(f"Clearing {len(events_queue.get())} queued events ({sender})")
+ events_queue.set([])
#
@@ -178,11 +184,7 @@ m2m_changed.connect(handle_cf_removed_obj_types, sender=CustomField.content_type
# Custom validation
#
-@receiver(post_clean)
-def run_custom_validators(sender, instance, **kwargs):
- config = get_config()
- model_name = f'{sender._meta.app_label}.{sender._meta.model_name}'
- validators = config.CUSTOM_VALIDATORS.get(model_name, [])
+def run_validators(instance, validators):
for validator in validators:
@@ -198,16 +200,27 @@ def run_custom_validators(sender, instance, **kwargs):
validator(instance)
-#
-# Dynamic configuration
-#
+@receiver(post_clean)
+def run_save_validators(sender, instance, **kwargs):
+ model_name = f'{sender._meta.app_label}.{sender._meta.model_name}'
+ validators = get_config().CUSTOM_VALIDATORS.get(model_name, [])
-@receiver(post_save, sender=ConfigRevision)
-def update_config(sender, instance, **kwargs):
- """
- Update the cached NetBox configuration when a new ConfigRevision is created.
- """
- instance.activate()
+ run_validators(instance, validators)
+
+
+@receiver(pre_delete)
+def run_delete_validators(sender, instance, **kwargs):
+ model_name = f'{sender._meta.app_label}.{sender._meta.model_name}'
+ validators = get_config().PROTECTION_RULES.get(model_name, [])
+
+ try:
+ run_validators(instance, validators)
+ except ValidationError as e:
+ raise AbortRequest(
+ _("Deletion is prevented by a protection rule: {message}").format(
+ message=e
+ )
+ )
#
@@ -226,3 +239,25 @@ def validate_assigned_tags(sender, instance, action, model, pk_set, **kwargs):
for tag in model.objects.filter(pk__in=pk_set, object_types__isnull=False).prefetch_related('object_types'):
if ct not in tag.object_types.all():
raise AbortRequest(f"Tag {tag} cannot be assigned to {ct.model} objects.")
+
+
+#
+# Event rules
+#
+
+@receiver(job_start)
+def process_job_start_event_rules(sender, **kwargs):
+ """
+ Process event rules for jobs starting.
+ """
+ event_rules = EventRule.objects.filter(type_job_start=True, enabled=True, content_types=sender.object_type)
+ process_event_rules(event_rules, sender.object_type.model, EVENT_JOB_START, sender.data, sender.user.username)
+
+
+@receiver(job_end)
+def process_job_end_event_rules(sender, **kwargs):
+ """
+ Process event rules for jobs terminating.
+ """
+ event_rules = EventRule.objects.filter(type_job_end=True, enabled=True, content_types=sender.object_type)
+ process_event_rules(event_rules, sender.object_type.model, EVENT_JOB_END, sender.data, sender.user.username)
diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py
index 9e14a2d27..8482c5e24 100644
--- a/netbox/extras/tables/tables.py
+++ b/netbox/extras/tables/tables.py
@@ -11,11 +11,11 @@ from .template_code import *
__all__ = (
'BookmarkTable',
'ConfigContextTable',
- 'ConfigRevisionTable',
'ConfigTemplateTable',
'CustomFieldChoiceSetTable',
'CustomFieldTable',
'CustomLinkTable',
+ 'EventRuleTable',
'ExportTemplateTable',
'ImageAttachmentTable',
'JournalEntryTable',
@@ -34,31 +34,6 @@ IMAGEATTACHMENT_IMAGE = '''
{% endif %}
'''
-REVISION_BUTTONS = """
-{% if not record.is_active %}
-
-
-
-{% endif %}
-"""
-
-
-class ConfigRevisionTable(NetBoxTable):
- is_active = columns.BooleanColumn(
- verbose_name=_('Is Active'),
- )
- actions = columns.ActionsColumn(
- actions=('delete',),
- extra_buttons=REVISION_BUTTONS
- )
-
- class Meta(NetBoxTable.Meta):
- model = ConfigRevision
- fields = (
- 'pk', 'id', 'is_active', 'created', 'comment',
- )
- default_columns = ('pk', 'id', 'is_active', 'created', 'comment')
-
class CustomFieldTable(NetBoxTable):
name = tables.Column(
@@ -71,8 +46,11 @@ class CustomFieldTable(NetBoxTable):
required = columns.BooleanColumn(
verbose_name=_('Required')
)
- ui_visibility = columns.ChoiceFieldColumn(
- verbose_name=_('UI Visibility')
+ ui_visible = columns.ChoiceFieldColumn(
+ verbose_name=_('Visible')
+ )
+ ui_editable = columns.ChoiceFieldColumn(
+ verbose_name=_('Editable')
)
description = columns.MarkdownColumn(
verbose_name=_('Description')
@@ -94,8 +72,8 @@ class CustomFieldTable(NetBoxTable):
model = CustomField
fields = (
'pk', 'id', 'name', 'content_types', 'label', 'type', 'group_name', 'required', 'default', 'description',
- 'search_weight', 'filter_logic', 'ui_visibility', 'is_cloneable', 'weight', 'choice_set', 'choices',
- 'created', 'last_updated',
+ 'search_weight', 'filter_logic', 'ui_visible', 'ui_editable', 'is_cloneable', 'weight', 'choice_set',
+ 'choices', 'created', 'last_updated',
)
default_columns = ('pk', 'name', 'content_types', 'label', 'group_name', 'type', 'required', 'description')
@@ -273,6 +251,36 @@ class WebhookTable(NetBoxTable):
verbose_name=_('Name'),
linkify=True
)
+ ssl_validation = columns.BooleanColumn(
+ verbose_name=_('SSL Validation')
+ )
+ tags = columns.TagColumn(
+ url_name='extras:webhook_list'
+ )
+
+ class Meta(NetBoxTable.Meta):
+ model = Webhook
+ fields = (
+ 'pk', 'id', 'name', 'http_method', 'payload_url', 'http_content_type', 'secret', 'ssl_verification',
+ 'ca_file_path', 'description', 'tags', 'created', 'last_updated',
+ )
+ default_columns = (
+ 'pk', 'name', 'http_method', 'payload_url', 'description',
+ )
+
+
+class EventRuleTable(NetBoxTable):
+ name = tables.Column(
+ verbose_name=_('Name'),
+ linkify=True
+ )
+ action_type = tables.Column(
+ verbose_name=_('Type'),
+ )
+ action_object = tables.Column(
+ linkify=True,
+ verbose_name=_('Object'),
+ )
content_types = columns.ContentTypesColumn(
verbose_name=_('Content Types'),
)
@@ -294,23 +302,20 @@ class WebhookTable(NetBoxTable):
type_job_end = columns.BooleanColumn(
verbose_name=_('Job End')
)
- ssl_validation = columns.BooleanColumn(
- verbose_name=_('SSL Validation')
- )
tags = columns.TagColumn(
url_name='extras:webhook_list'
)
class Meta(NetBoxTable.Meta):
- model = Webhook
+ model = EventRule
fields = (
- 'pk', 'id', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete',
- 'type_job_start', 'type_job_end', 'http_method', 'payload_url', 'secret', 'ssl_validation', 'ca_file_path',
- 'tags', 'created', 'last_updated',
+ 'pk', 'id', 'name', 'enabled', 'description', 'action_type', 'action_object', 'content_types',
+ 'type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end', 'tags', 'created',
+ 'last_updated',
)
default_columns = (
- 'pk', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'type_job_start',
- 'type_job_end', 'http_method', 'payload_url',
+ 'pk', 'name', 'enabled', 'action_type', 'action_object', 'content_types', 'type_create', 'type_update',
+ 'type_delete', 'type_job_start', 'type_job_end',
)
diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py
index 255457f21..93be2d2c4 100644
--- a/netbox/extras/tests/test_api.py
+++ b/netbox/extras/tests/test_api.py
@@ -8,6 +8,7 @@ from rest_framework import status
from core.choices import ManagedFileRootPathChoices
from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Rack, Location, RackRole, Site
+from extras.choices import *
from extras.models import *
from extras.reports import Report
from extras.scripts import BooleanVar, IntegerVar, Script, StringVar
@@ -32,53 +33,119 @@ class WebhookTest(APIViewTestCases.APIViewTestCase):
brief_fields = ['display', 'id', 'name', 'url']
create_data = [
{
- 'content_types': ['dcim.device', 'dcim.devicetype'],
'name': 'Webhook 4',
- 'type_create': True,
'payload_url': 'http://example.com/?4',
},
{
- 'content_types': ['dcim.device', 'dcim.devicetype'],
'name': 'Webhook 5',
- 'type_update': True,
'payload_url': 'http://example.com/?5',
},
{
- 'content_types': ['dcim.device', 'dcim.devicetype'],
'name': 'Webhook 6',
- 'type_delete': True,
'payload_url': 'http://example.com/?6',
},
]
bulk_update_data = {
+ 'description': 'New description',
'ssl_verification': False,
}
@classmethod
def setUpTestData(cls):
- site_ct = ContentType.objects.get_for_model(Site)
- rack_ct = ContentType.objects.get_for_model(Rack)
webhooks = (
Webhook(
name='Webhook 1',
- type_create=True,
payload_url='http://example.com/?1',
),
Webhook(
name='Webhook 2',
- type_update=True,
payload_url='http://example.com/?1',
),
Webhook(
name='Webhook 3',
- type_delete=True,
payload_url='http://example.com/?1',
),
)
Webhook.objects.bulk_create(webhooks)
- for webhook in webhooks:
- webhook.content_types.add(site_ct, rack_ct)
+
+
+class EventRuleTest(APIViewTestCases.APIViewTestCase):
+ model = EventRule
+ brief_fields = ['display', 'id', 'name', 'url']
+ bulk_update_data = {
+ 'enabled': False,
+ 'description': 'New description',
+ }
+ update_data = {
+ 'name': 'Event Rule X',
+ 'enabled': False,
+ 'description': 'New description',
+ }
+
+ @classmethod
+ def setUpTestData(cls):
+ webhooks = (
+ Webhook(
+ name='Webhook 1',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 2',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 3',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 4',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 5',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 6',
+ payload_url='http://example.com/?1',
+ ),
+ )
+ Webhook.objects.bulk_create(webhooks)
+
+ event_rules = (
+ EventRule(name='EventRule 1', type_create=True, action_object=webhooks[0]),
+ EventRule(name='EventRule 2', type_create=True, action_object=webhooks[1]),
+ EventRule(name='EventRule 3', type_create=True, action_object=webhooks[2]),
+ )
+ EventRule.objects.bulk_create(event_rules)
+
+ cls.create_data = [
+ {
+ 'name': 'EventRule 4',
+ 'content_types': ['dcim.device', 'dcim.devicetype'],
+ 'type_create': True,
+ 'action_type': EventRuleActionChoices.WEBHOOK,
+ 'action_object_type': 'extras.webhook',
+ 'action_object_id': webhooks[3].pk,
+ },
+ {
+ 'name': 'EventRule 5',
+ 'content_types': ['dcim.device', 'dcim.devicetype'],
+ 'type_create': True,
+ 'action_type': EventRuleActionChoices.WEBHOOK,
+ 'action_object_type': 'extras.webhook',
+ 'action_object_id': webhooks[4].pk,
+ },
+ {
+ 'name': 'EventRule 6',
+ 'content_types': ['dcim.device', 'dcim.devicetype'],
+ 'type_create': True,
+ 'action_type': EventRuleActionChoices.WEBHOOK,
+ 'action_object_type': 'extras.webhook',
+ 'action_object_id': webhooks[5].pk,
+ },
+ ]
class CustomFieldTest(APIViewTestCases.APIViewTestCase):
diff --git a/netbox/extras/tests/test_changelog.py b/netbox/extras/tests/test_changelog.py
index 34fd72b2b..e144c5dee 100644
--- a/netbox/extras/tests/test_changelog.py
+++ b/netbox/extras/tests/test_changelog.py
@@ -1,4 +1,5 @@
from django.contrib.contenttypes.models import ContentType
+from django.test import override_settings
from django.urls import reverse
from rest_framework import status
@@ -207,6 +208,66 @@ class ChangeLogViewTest(ModelViewTestCase):
self.assertEqual(objectchange.prechange_data['slug'], sites[0].slug)
self.assertEqual(objectchange.postchange_data, None)
+ @override_settings(CHANGELOG_SKIP_EMPTY_CHANGES=False)
+ def test_update_object_change(self):
+ # Create a Site
+ site = Site.objects.create(
+ name='Site 1',
+ slug='site-1',
+ status=SiteStatusChoices.STATUS_PLANNED,
+ custom_field_data={
+ 'cf1': None,
+ 'cf2': None
+ }
+ )
+
+ # Update it with the same field values
+ form_data = {
+ 'name': site.name,
+ 'slug': site.slug,
+ 'status': SiteStatusChoices.STATUS_PLANNED,
+ }
+ request = {
+ 'path': self._get_url('edit', instance=site),
+ 'data': post_data(form_data),
+ }
+ self.add_permissions('dcim.change_site', 'extras.view_tag')
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 302)
+
+ # Check that an ObjectChange record has been created
+ self.assertEqual(ObjectChange.objects.count(), 1)
+
+ @override_settings(CHANGELOG_SKIP_EMPTY_CHANGES=True)
+ def test_update_object_nochange(self):
+ # Create a Site
+ site = Site.objects.create(
+ name='Site 1',
+ slug='site-1',
+ status=SiteStatusChoices.STATUS_PLANNED,
+ custom_field_data={
+ 'cf1': None,
+ 'cf2': None
+ }
+ )
+
+ # Update it with the same field values
+ form_data = {
+ 'name': site.name,
+ 'slug': site.slug,
+ 'status': SiteStatusChoices.STATUS_PLANNED,
+ }
+ request = {
+ 'path': self._get_url('edit', instance=site),
+ 'data': post_data(form_data),
+ }
+ self.add_permissions('dcim.change_site', 'extras.view_tag')
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 302)
+
+ # Check that no ObjectChange records have been created
+ self.assertEqual(ObjectChange.objects.count(), 0)
+
class ChangeLogAPITest(APITestCase):
diff --git a/netbox/extras/tests/test_custom_validation.py b/netbox/extras/tests/test_custom_validation.py
new file mode 100644
index 000000000..e375b49f5
--- /dev/null
+++ b/netbox/extras/tests/test_custom_validation.py
@@ -0,0 +1,265 @@
+from django.test import TestCase
+from django.test import override_settings
+
+from circuits.api.serializers import ProviderSerializer
+from circuits.forms import ProviderForm
+from circuits.models import Provider
+from ipam.models import ASN, RIR
+from utilities.choices import CSVDelimiterChoices, ImportFormatChoices
+from utilities.testing import APITestCase, ModelViewTestCase, create_tags, post_data
+
+
+class ModelFormCustomValidationTest(TestCase):
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'tags': {'required': True}}
+ ]
+ })
+ def test_tags_validation(self):
+ """
+ Check that custom validation rules work for tag assignment.
+ """
+ data = {
+ 'name': 'Provider 1',
+ 'slug': 'provider-1',
+ }
+ form = ProviderForm(data)
+ self.assertFalse(form.is_valid())
+
+ tags = create_tags('Tag1', 'Tag2', 'Tag3')
+ data['tags'] = [tag.pk for tag in tags]
+ form = ProviderForm(data)
+ self.assertTrue(form.is_valid())
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'asns': {'required': True}}
+ ]
+ })
+ def test_m2m_validation(self):
+ """
+ Check that custom validation rules work for many-to-many fields.
+ """
+ data = {
+ 'name': 'Provider 1',
+ 'slug': 'provider-1',
+ }
+ form = ProviderForm(data)
+ self.assertFalse(form.is_valid())
+
+ rir = RIR.objects.create(name='RIR 1', slug='rir-1')
+ asns = ASN.objects.bulk_create((
+ ASN(rir=rir, asn=65001),
+ ASN(rir=rir, asn=65002),
+ ASN(rir=rir, asn=65003),
+ ))
+ data['asns'] = [asn.pk for asn in asns]
+ form = ProviderForm(data)
+ self.assertTrue(form.is_valid())
+
+
+class BulkEditCustomValidationTest(ModelViewTestCase):
+ model = Provider
+
+ @classmethod
+ def setUpTestData(cls):
+ rir = RIR.objects.create(name='RIR 1', slug='rir-1')
+ asns = ASN.objects.bulk_create((
+ ASN(rir=rir, asn=65001),
+ ASN(rir=rir, asn=65002),
+ ASN(rir=rir, asn=65003),
+ ))
+
+ providers = (
+ Provider(name='Provider 1', slug='provider-1'),
+ Provider(name='Provider 2', slug='provider-2'),
+ Provider(name='Provider 3', slug='provider-3'),
+ )
+ Provider.objects.bulk_create(providers)
+ for provider in providers:
+ provider.asns.set(asns)
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'asns': {'required': True}}
+ ]
+ })
+ def test_bulk_edit_without_m2m(self):
+ """
+ Check that custom validation rules do not interfere with bulk editing.
+ """
+ data = {
+ 'pk': list(Provider.objects.values_list('pk', flat=True)),
+ '_apply': '',
+ 'description': 'New description',
+ }
+ self.add_permissions(
+ 'circuits.view_provider',
+ 'circuits.change_provider',
+ )
+
+ # Bulk edit the description without changing ASN assignments
+ request = {
+ 'path': self._get_url('bulk_edit'),
+ 'data': post_data(data),
+ }
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 302)
+ self.assertEqual(
+ Provider.objects.filter(description=data['description']).count(),
+ len(data['pk'])
+ )
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'asns': {'required': True}}
+ ]
+ })
+ def test_bulk_edit_m2m(self):
+ """
+ Test that custom validation rules are enforced during bulk editing.
+ """
+ data = {
+ 'pk': list(Provider.objects.values_list('pk', flat=True)),
+ '_apply': '',
+ 'description': 'New description',
+ }
+ self.add_permissions(
+ 'circuits.view_provider',
+ 'circuits.change_provider',
+ 'ipam.view_asn',
+ )
+
+ # Change the ASN assignments
+ asn = ASN.objects.first()
+ data['asns'] = [asn.pk]
+ request = {
+ 'path': self._get_url('bulk_edit'),
+ 'data': post_data(data),
+ }
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 302)
+ for provider in Provider.objects.all():
+ self.assertEqual(len(provider.asns.all()), 1)
+
+ # Attempt to remove the ASN assignments
+ data.pop('asns')
+ data['_nullify'] = 'asns'
+ request = {
+ 'path': self._get_url('bulk_edit'),
+ 'data': post_data(data),
+ }
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 200)
+ for provider in Provider.objects.all():
+ self.assertTrue(provider.asns.exists())
+
+
+class BulkImportCustomValidationTest(ModelViewTestCase):
+ model = Provider
+
+ @classmethod
+ def setUpTestData(cls):
+ create_tags('Tag1', 'Tag2', 'Tag3')
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'tags': {'required': True}}
+ ]
+ })
+ def test_bulk_import_invalid(self):
+ """
+ Test that custom validation rules are enforced during bulk import.
+ """
+ csv_data = (
+ "name,slug",
+ "Provider 1,provider-1",
+ "Provider 2,provider-2",
+ "Provider 3,provider-3",
+ )
+ data = {
+ 'data': '\n'.join(csv_data),
+ 'format': ImportFormatChoices.CSV,
+ 'csv_delimiter': CSVDelimiterChoices.COMMA,
+ }
+ self.add_permissions(
+ 'circuits.view_provider',
+ 'circuits.add_provider',
+ 'extras.view_tag',
+ )
+
+ # Attempt to import providers without tags
+ request = {
+ 'path': self._get_url('import'),
+ 'data': post_data(data),
+ }
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 200)
+ self.assertFalse(Provider.objects.exists())
+
+ # Import providers successfully with tag assignments
+ csv_data = (
+ "name,slug,tags",
+ "Provider 1,provider-1,tag1",
+ "Provider 2,provider-2,tag2",
+ "Provider 3,provider-3,tag3",
+ )
+ data['data'] = '\n'.join(csv_data)
+ request = {
+ 'path': self._get_url('import'),
+ 'data': post_data(data),
+ }
+ response = self.client.post(**request)
+ self.assertHttpStatus(response, 302)
+ self.assertTrue(Provider.objects.exists())
+
+
+class APISerializerCustomValidationTest(APITestCase):
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'tags': {'required': True}}
+ ]
+ })
+ def test_tags_validation(self):
+ """
+ Check that custom validation rules work for tag assignment.
+ """
+ data = {
+ 'name': 'Provider 1',
+ 'slug': 'provider-1',
+ }
+ serializer = ProviderSerializer(data=data)
+ self.assertFalse(serializer.is_valid())
+
+ tags = create_tags('Tag1', 'Tag2', 'Tag3')
+ data['tags'] = [tag.pk for tag in tags]
+ serializer = ProviderSerializer(data=data)
+ self.assertTrue(serializer.is_valid())
+
+ @override_settings(CUSTOM_VALIDATORS={
+ 'circuits.provider': [
+ {'asns': {'required': True}}
+ ]
+ })
+ def test_m2m_validation(self):
+ """
+ Check that custom validation rules work for many-to-many fields.
+ """
+ data = {
+ 'name': 'Provider 1',
+ 'slug': 'provider-1',
+ }
+ serializer = ProviderSerializer(data=data)
+ self.assertFalse(serializer.is_valid())
+
+ rir = RIR.objects.create(name='RIR 1', slug='rir-1')
+ asns = ASN.objects.bulk_create((
+ ASN(rir=rir, asn=65001),
+ ASN(rir=rir, asn=65002),
+ ASN(rir=rir, asn=65003),
+ ))
+ data['asns'] = [asn.pk for asn in asns]
+ serializer = ProviderSerializer(data=data)
+ self.assertTrue(serializer.is_valid())
diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py
index 019aef235..574452a81 100644
--- a/netbox/extras/tests/test_customfields.py
+++ b/netbox/extras/tests/test_customfields.py
@@ -12,6 +12,7 @@ from dcim.models import Manufacturer, Rack, Site
from extras.choices import *
from extras.models import CustomField, CustomFieldChoiceSet
from ipam.models import VLAN
+from utilities.choices import CSVDelimiterChoices, ImportFormatChoices
from utilities.testing import APITestCase, TestCase
from virtualization.models import VirtualMachine
@@ -427,6 +428,97 @@ class CustomFieldTest(TestCase):
self.assertNotIn('field1', site.custom_field_data)
self.assertEqual(site.custom_field_data['field2'], FIELD_DATA)
+ def test_default_value_validation(self):
+ choiceset = CustomFieldChoiceSet.objects.create(
+ name="Test Choice Set",
+ extra_choices=(
+ ('choice1', 'Choice 1'),
+ ('choice2', 'Choice 2'),
+ )
+ )
+ site = Site.objects.create(name='Site 1', slug='site-1')
+ object_type = ContentType.objects.get_for_model(Site)
+
+ # Text
+ CustomField(name='test', type='text', required=True, default="Default text").full_clean()
+
+ # Integer
+ CustomField(name='test', type='integer', required=True, default=1).full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='integer', required=True, default='xxx').full_clean()
+
+ # Boolean
+ CustomField(name='test', type='boolean', required=True, default=True).full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='boolean', required=True, default='xxx').full_clean()
+
+ # Date
+ CustomField(name='test', type='date', required=True, default="2023-02-25").full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='date', required=True, default='xxx').full_clean()
+
+ # Datetime
+ CustomField(name='test', type='datetime', required=True, default="2023-02-25 02:02:02").full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='datetime', required=True, default='xxx').full_clean()
+
+ # URL
+ CustomField(name='test', type='url', required=True, default="https://www.netbox.dev").full_clean()
+
+ # JSON
+ CustomField(name='test', type='json', required=True, default='{"test": "object"}').full_clean()
+
+ # Selection
+ CustomField(name='test', type='select', required=True, choice_set=choiceset, default='choice1').full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='select', required=True, choice_set=choiceset, default='xxx').full_clean()
+
+ # Multi-select
+ CustomField(
+ name='test',
+ type='multiselect',
+ required=True,
+ choice_set=choiceset,
+ default=['choice1'] # Single default choice
+ ).full_clean()
+ CustomField(
+ name='test',
+ type='multiselect',
+ required=True,
+ choice_set=choiceset,
+ default=['choice1', 'choice2'] # Multiple default choices
+ ).full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(
+ name='test',
+ type='multiselect',
+ required=True,
+ choice_set=choiceset,
+ default=['xxx']
+ ).full_clean()
+
+ # Object
+ CustomField(name='test', type='object', required=True, object_type=object_type, default=site.pk).full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(name='test', type='object', required=True, object_type=object_type, default="xxx").full_clean()
+
+ # Multi-object
+ CustomField(
+ name='test',
+ type='multiobject',
+ required=True,
+ object_type=object_type,
+ default=[site.pk]
+ ).full_clean()
+ with self.assertRaises(ValidationError):
+ CustomField(
+ name='test',
+ type='multiobject',
+ required=True,
+ object_type=object_type,
+ default=["xxx"]
+ ).full_clean()
+
class CustomFieldManagerTest(TestCase):
@@ -1085,7 +1177,11 @@ class CustomFieldImportTest(TestCase):
)
csv_data = '\n'.join(','.join(row) for row in data)
- response = self.client.post(reverse('dcim:site_import'), {'data': csv_data, 'format': 'csv'})
+ response = self.client.post(reverse('dcim:site_import'), {
+ 'data': csv_data,
+ 'format': ImportFormatChoices.CSV,
+ 'csv_delimiter': CSVDelimiterChoices.AUTO,
+ })
self.assertEqual(response.status_code, 302)
self.assertEqual(Site.objects.count(), 3)
@@ -1233,7 +1329,7 @@ class CustomFieldModelFilterTest(TestCase):
choice_set = CustomFieldChoiceSet.objects.create(
name='Custom Field Choice Set 1',
- extra_choices=(('a', 'A'), ('b', 'B'), ('c', 'C'), ('x', 'X'))
+ extra_choices=(('a', 'A'), ('b', 'B'), ('c', 'C'))
)
# Integer filtering
@@ -1339,7 +1435,7 @@ class CustomFieldModelFilterTest(TestCase):
'cf7': 'http://a.example.com',
'cf8': 'http://a.example.com',
'cf9': 'A',
- 'cf10': ['A', 'X'],
+ 'cf10': ['A', 'B'],
'cf11': manufacturers[0].pk,
'cf12': [manufacturers[0].pk, manufacturers[3].pk],
}),
@@ -1353,7 +1449,7 @@ class CustomFieldModelFilterTest(TestCase):
'cf7': 'http://b.example.com',
'cf8': 'http://b.example.com',
'cf9': 'B',
- 'cf10': ['B', 'X'],
+ 'cf10': ['B', 'C'],
'cf11': manufacturers[1].pk,
'cf12': [manufacturers[1].pk, manufacturers[3].pk],
}),
@@ -1367,7 +1463,7 @@ class CustomFieldModelFilterTest(TestCase):
'cf7': 'http://c.example.com',
'cf8': 'http://c.example.com',
'cf9': 'C',
- 'cf10': ['C', 'X'],
+ 'cf10': None,
'cf11': manufacturers[2].pk,
'cf12': [manufacturers[2].pk, manufacturers[3].pk],
}),
@@ -1435,8 +1531,9 @@ class CustomFieldModelFilterTest(TestCase):
self.assertEqual(self.filterset({'cf_cf9': ['A', 'B']}, self.queryset).qs.count(), 2)
def test_filter_multiselect(self):
- self.assertEqual(self.filterset({'cf_cf10': ['A', 'B']}, self.queryset).qs.count(), 2)
- self.assertEqual(self.filterset({'cf_cf10': ['X']}, self.queryset).qs.count(), 3)
+ self.assertEqual(self.filterset({'cf_cf10': ['A']}, self.queryset).qs.count(), 1)
+ self.assertEqual(self.filterset({'cf_cf10': ['A', 'C']}, self.queryset).qs.count(), 2)
+ self.assertEqual(self.filterset({'cf_cf10': ['null']}, self.queryset).qs.count(), 1)
def test_filter_object(self):
manufacturer_ids = Manufacturer.objects.values_list('id', flat=True)
diff --git a/netbox/extras/tests/test_customvalidator.py b/netbox/extras/tests/test_customvalidation.py
similarity index 64%
rename from netbox/extras/tests/test_customvalidator.py
rename to netbox/extras/tests/test_customvalidation.py
index 0fe507b67..d74ad599b 100644
--- a/netbox/extras/tests/test_customvalidator.py
+++ b/netbox/extras/tests/test_customvalidation.py
@@ -1,10 +1,13 @@
from django.conf import settings
from django.core.exceptions import ValidationError
+from django.db import transaction
from django.test import TestCase, override_settings
from ipam.models import ASN, RIR
+from dcim.choices import SiteStatusChoices
from dcim.models import Site
from extras.validators import CustomValidator
+from utilities.exceptions import AbortRequest
class MyValidator(CustomValidator):
@@ -14,6 +17,20 @@ class MyValidator(CustomValidator):
self.fail("Name must be foo!")
+eq_validator = CustomValidator({
+ 'asn': {
+ 'eq': 100
+ }
+})
+
+
+neq_validator = CustomValidator({
+ 'asn': {
+ 'neq': 100
+ }
+})
+
+
min_validator = CustomValidator({
'asn': {
'min': 65000
@@ -77,6 +94,18 @@ class CustomValidatorTest(TestCase):
validator = settings.CUSTOM_VALIDATORS['ipam.asn'][0]
self.assertIsInstance(validator, CustomValidator)
+ @override_settings(CUSTOM_VALIDATORS={'ipam.asn': [eq_validator]})
+ def test_eq(self):
+ ASN(asn=100, rir=RIR.objects.first()).clean()
+ with self.assertRaises(ValidationError):
+ ASN(asn=99, rir=RIR.objects.first()).clean()
+
+ @override_settings(CUSTOM_VALIDATORS={'ipam.asn': [neq_validator]})
+ def test_neq(self):
+ ASN(asn=99, rir=RIR.objects.first()).clean()
+ with self.assertRaises(ValidationError):
+ ASN(asn=100, rir=RIR.objects.first()).clean()
+
@override_settings(CUSTOM_VALIDATORS={'ipam.asn': [min_validator]})
def test_min(self):
with self.assertRaises(ValidationError):
@@ -147,7 +176,7 @@ class CustomValidatorConfigTest(TestCase):
@override_settings(
CUSTOM_VALIDATORS={
'dcim.site': (
- 'extras.tests.test_customvalidator.MyValidator',
+ 'extras.tests.test_customvalidation.MyValidator',
)
}
)
@@ -159,3 +188,62 @@ class CustomValidatorConfigTest(TestCase):
Site(name='foo', slug='foo').clean()
with self.assertRaises(ValidationError):
Site(name='bar', slug='bar').clean()
+
+
+class ProtectionRulesConfigTest(TestCase):
+
+ @override_settings(
+ PROTECTION_RULES={
+ 'dcim.site': [
+ {'status': {'eq': SiteStatusChoices.STATUS_DECOMMISSIONING}}
+ ]
+ }
+ )
+ def test_plain_data(self):
+ """
+ Test custom validator configuration using plain data (as opposed to a CustomValidator
+ class)
+ """
+ # Create a site with a protected status
+ site = Site(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_ACTIVE)
+ site.save()
+
+ # Try to delete it
+ with self.assertRaises(AbortRequest):
+ with transaction.atomic():
+ site.delete()
+
+ # Change its status to an allowed value
+ site.status = SiteStatusChoices.STATUS_DECOMMISSIONING
+ site.save()
+
+ # Deletion should now succeed
+ site.delete()
+
+ @override_settings(
+ PROTECTION_RULES={
+ 'dcim.site': (
+ 'extras.tests.test_customvalidation.MyValidator',
+ )
+ }
+ )
+ def test_dotted_path(self):
+ """
+ Test custom validator configuration using a dotted path (string) reference to a
+ CustomValidator class.
+ """
+ # Create a site with a protected name
+ site = Site(name='bar', slug='bar')
+ site.save()
+
+ # Try to delete it
+ with self.assertRaises(AbortRequest):
+ with transaction.atomic():
+ site.delete()
+
+ # Change the name to an allowed value
+ site.name = site.slug = 'foo'
+ site.save()
+
+ # Deletion should now succeed
+ site.delete()
diff --git a/netbox/extras/tests/test_webhooks.py b/netbox/extras/tests/test_event_rules.py
similarity index 72%
rename from netbox/extras/tests/test_webhooks.py
rename to netbox/extras/tests/test_event_rules.py
index ef7637765..549c33478 100644
--- a/netbox/extras/tests/test_webhooks.py
+++ b/netbox/extras/tests/test_event_rules.py
@@ -3,22 +3,21 @@ import uuid
from unittest.mock import patch
import django_rq
+from dcim.choices import SiteStatusChoices
+from dcim.models import Site
from django.contrib.contenttypes.models import ContentType
from django.http import HttpResponse
from django.urls import reverse
+from extras.choices import EventRuleActionChoices, ObjectChangeActionChoices
+from extras.events import enqueue_object, flush_events, serialize_for_event
+from extras.models import EventRule, Tag, Webhook
+from extras.webhooks import generate_signature, send_webhook
from requests import Session
from rest_framework import status
-
-from dcim.choices import SiteStatusChoices
-from dcim.models import Site
-from extras.choices import ObjectChangeActionChoices
-from extras.models import Tag, Webhook
-from extras.webhooks import enqueue_object, flush_webhooks, generate_signature, serialize_for_webhook
-from extras.webhooks_worker import eval_conditions, process_webhook
from utilities.testing import APITestCase
-class WebhookTest(APITestCase):
+class EventRuleTest(APITestCase):
def setUp(self):
super().setUp()
@@ -35,12 +34,37 @@ class WebhookTest(APITestCase):
DUMMY_SECRET = 'LOOKATMEIMASECRETSTRING'
webhooks = Webhook.objects.bulk_create((
- Webhook(name='Webhook 1', type_create=True, payload_url=DUMMY_URL, secret=DUMMY_SECRET, additional_headers='X-Foo: Bar'),
- Webhook(name='Webhook 2', type_update=True, payload_url=DUMMY_URL, secret=DUMMY_SECRET),
- Webhook(name='Webhook 3', type_delete=True, payload_url=DUMMY_URL, secret=DUMMY_SECRET),
+ Webhook(name='Webhook 1', payload_url=DUMMY_URL, secret=DUMMY_SECRET, additional_headers='X-Foo: Bar'),
+ Webhook(name='Webhook 2', payload_url=DUMMY_URL, secret=DUMMY_SECRET),
+ Webhook(name='Webhook 3', payload_url=DUMMY_URL, secret=DUMMY_SECRET),
))
- for webhook in webhooks:
- webhook.content_types.set([site_ct])
+
+ ct = ContentType.objects.get(app_label='extras', model='webhook')
+ event_rules = EventRule.objects.bulk_create((
+ EventRule(
+ name='Webhook Event 1',
+ type_create=True,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ action_object_type=ct,
+ action_object_id=webhooks[0].id
+ ),
+ EventRule(
+ name='Webhook Event 2',
+ type_update=True,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ action_object_type=ct,
+ action_object_id=webhooks[0].id
+ ),
+ EventRule(
+ name='Webhook Event 3',
+ type_delete=True,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ action_object_type=ct,
+ action_object_id=webhooks[0].id
+ ),
+ ))
+ for event_rule in event_rules:
+ event_rule.content_types.set([site_ct])
Tag.objects.bulk_create((
Tag(name='Foo', slug='foo'),
@@ -48,7 +72,42 @@ class WebhookTest(APITestCase):
Tag(name='Baz', slug='baz'),
))
- def test_enqueue_webhook_create(self):
+ def test_eventrule_conditions(self):
+ """
+ Test evaluation of EventRule conditions.
+ """
+ event_rule = EventRule(
+ name='Event Rule 1',
+ type_create=True,
+ type_update=True,
+ conditions={
+ 'and': [
+ {
+ 'attr': 'status.value',
+ 'value': 'active',
+ }
+ ]
+ }
+ )
+
+ # Create a Site to evaluate
+ site = Site.objects.create(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_STAGING)
+ data = serialize_for_event(site)
+
+ # Evaluate the conditions (status='staging')
+ self.assertFalse(event_rule.eval_conditions(data))
+
+ # Change the site's status
+ site.status = SiteStatusChoices.STATUS_ACTIVE
+ data = serialize_for_event(site)
+
+ # Evaluate the conditions (status='active')
+ self.assertTrue(event_rule.eval_conditions(data))
+
+ def test_single_create_process_eventrule(self):
+ """
+ Check that creating an object with an applicable EventRule queues a background task for the rule's action.
+ """
# Create an object via the REST API
data = {
'name': 'Site 1',
@@ -65,10 +124,10 @@ class WebhookTest(APITestCase):
self.assertEqual(Site.objects.count(), 1)
self.assertEqual(Site.objects.first().tags.count(), 2)
- # Verify that a job was queued for the object creation webhook
+ # Verify that a background task was queued for the new object
self.assertEqual(self.queue.count, 1)
job = self.queue.jobs[0]
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_create=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_create=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_CREATE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], response.data['id'])
@@ -76,7 +135,11 @@ class WebhookTest(APITestCase):
self.assertEqual(job.kwargs['snapshots']['postchange']['name'], 'Site 1')
self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Bar', 'Foo'])
- def test_enqueue_webhook_bulk_create(self):
+ def test_bulk_create_process_eventrule(self):
+ """
+ Check that bulk creating multiple objects with an applicable EventRule queues a background task for each
+ new object.
+ """
# Create multiple objects via the REST API
data = [
{
@@ -111,10 +174,10 @@ class WebhookTest(APITestCase):
self.assertEqual(Site.objects.count(), 3)
self.assertEqual(Site.objects.first().tags.count(), 2)
- # Verify that a webhook was queued for each object
+ # Verify that a background task was queued for each new object
self.assertEqual(self.queue.count, 3)
for i, job in enumerate(self.queue.jobs):
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_create=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_create=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_CREATE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], response.data[i]['id'])
@@ -122,7 +185,10 @@ class WebhookTest(APITestCase):
self.assertEqual(job.kwargs['snapshots']['postchange']['name'], response.data[i]['name'])
self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Bar', 'Foo'])
- def test_enqueue_webhook_update(self):
+ def test_single_update_process_eventrule(self):
+ """
+ Check that updating an object with an applicable EventRule queues a background task for the rule's action.
+ """
site = Site.objects.create(name='Site 1', slug='site-1')
site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
@@ -139,10 +205,10 @@ class WebhookTest(APITestCase):
response = self.client.patch(url, data, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
- # Verify that a job was queued for the object update webhook
+ # Verify that a background task was queued for the updated object
self.assertEqual(self.queue.count, 1)
job = self.queue.jobs[0]
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_update=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_update=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_UPDATE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], site.pk)
@@ -152,7 +218,11 @@ class WebhookTest(APITestCase):
self.assertEqual(job.kwargs['snapshots']['postchange']['name'], 'Site X')
self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Baz'])
- def test_enqueue_webhook_bulk_update(self):
+ def test_bulk_update_process_eventrule(self):
+ """
+ Check that bulk updating multiple objects with an applicable EventRule queues a background task for each
+ updated object.
+ """
sites = (
Site(name='Site 1', slug='site-1'),
Site(name='Site 2', slug='site-2'),
@@ -191,10 +261,10 @@ class WebhookTest(APITestCase):
response = self.client.patch(url, data, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
- # Verify that a job was queued for the object update webhook
+ # Verify that a background task was queued for each updated object
self.assertEqual(self.queue.count, 3)
for i, job in enumerate(self.queue.jobs):
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_update=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_update=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_UPDATE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], data[i]['id'])
@@ -204,7 +274,10 @@ class WebhookTest(APITestCase):
self.assertEqual(job.kwargs['snapshots']['postchange']['name'], response.data[i]['name'])
self.assertEqual(job.kwargs['snapshots']['postchange']['tags'], ['Baz'])
- def test_enqueue_webhook_delete(self):
+ def test_single_delete_process_eventrule(self):
+ """
+ Check that deleting an object with an applicable EventRule queues a background task for the rule's action.
+ """
site = Site.objects.create(name='Site 1', slug='site-1')
site.tags.set(Tag.objects.filter(name__in=['Foo', 'Bar']))
@@ -214,17 +287,21 @@ class WebhookTest(APITestCase):
response = self.client.delete(url, **self.header)
self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
- # Verify that a job was queued for the object update webhook
+ # Verify that a task was queued for the deleted object
self.assertEqual(self.queue.count, 1)
job = self.queue.jobs[0]
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_delete=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_delete=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_DELETE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], site.pk)
self.assertEqual(job.kwargs['snapshots']['prechange']['name'], 'Site 1')
self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
- def test_enqueue_webhook_bulk_delete(self):
+ def test_bulk_delete_process_eventrule(self):
+ """
+ Check that bulk deleting multiple objects with an applicable EventRule queues a background task for each
+ deleted object.
+ """
sites = (
Site(name='Site 1', slug='site-1'),
Site(name='Site 2', slug='site-2'),
@@ -243,49 +320,17 @@ class WebhookTest(APITestCase):
response = self.client.delete(url, data, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
- # Verify that a job was queued for the object update webhook
+ # Verify that a background task was queued for each deleted object
self.assertEqual(self.queue.count, 3)
for i, job in enumerate(self.queue.jobs):
- self.assertEqual(job.kwargs['webhook'], Webhook.objects.get(type_delete=True))
+ self.assertEqual(job.kwargs['event_rule'], EventRule.objects.get(type_delete=True))
self.assertEqual(job.kwargs['event'], ObjectChangeActionChoices.ACTION_DELETE)
self.assertEqual(job.kwargs['model_name'], 'site')
self.assertEqual(job.kwargs['data']['id'], sites[i].pk)
self.assertEqual(job.kwargs['snapshots']['prechange']['name'], sites[i].name)
self.assertEqual(job.kwargs['snapshots']['prechange']['tags'], ['Bar', 'Foo'])
- def test_webhook_conditions(self):
- # Create a conditional Webhook
- webhook = Webhook(
- name='Conditional Webhook',
- type_create=True,
- type_update=True,
- payload_url='http://localhost:9000/',
- conditions={
- 'and': [
- {
- 'attr': 'status.value',
- 'value': 'active',
- }
- ]
- }
- )
-
- # Create a Site to evaluate
- site = Site.objects.create(name='Site 1', slug='site-1', status=SiteStatusChoices.STATUS_STAGING)
- data = serialize_for_webhook(site)
-
- # Evaluate the conditions (status='staging')
- self.assertFalse(eval_conditions(webhook, data))
-
- # Change the site's status
- site.status = SiteStatusChoices.STATUS_ACTIVE
- data = serialize_for_webhook(site)
-
- # Evaluate the conditions (status='active')
- self.assertTrue(eval_conditions(webhook, data))
-
- def test_webhooks_worker(self):
-
+ def test_send_webhook(self):
request_id = uuid.uuid4()
def dummy_send(_, request, **kwargs):
@@ -293,7 +338,8 @@ class WebhookTest(APITestCase):
A dummy implementation of Session.send() to be used for testing.
Always returns a 200 HTTP response.
"""
- webhook = Webhook.objects.get(type_create=True)
+ event = EventRule.objects.get(type_create=True)
+ webhook = event.action_object
signature = generate_signature(request.body, webhook.secret)
# Validate the outgoing request headers
@@ -322,11 +368,11 @@ class WebhookTest(APITestCase):
request_id=request_id,
action=ObjectChangeActionChoices.ACTION_CREATE
)
- flush_webhooks(webhooks_queue)
+ flush_events(webhooks_queue)
# Retrieve the job from queue
job = self.queue.jobs[0]
# Patch the Session object with our dummy_send() method, then process the webhook for sending
with patch.object(Session, 'send', dummy_send) as mock_send:
- process_webhook(**job.kwargs)
+ send_webhook(**job.kwargs)
diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py
index c558a0467..ef8aedcbd 100644
--- a/netbox/extras/tests/test_filtersets.py
+++ b/netbox/extras/tests/test_filtersets.py
@@ -6,6 +6,7 @@ from django.contrib.contenttypes.models import ContentType
from django.test import TestCase
from circuits.models import Provider
+from core.choices import ManagedFileRootPathChoices
from dcim.filtersets import SiteFilterSet
from dcim.models import DeviceRole, DeviceType, Manufacturer, Platform, Rack, Region, Site, SiteGroup
from dcim.models import Location
@@ -40,7 +41,9 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
required=True,
weight=100,
filter_logic=CustomFieldFilterLogicChoices.FILTER_LOOSE,
- ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE
+ ui_visible=CustomFieldUIVisibleChoices.ALWAYS,
+ ui_editable=CustomFieldUIEditableChoices.YES,
+ description='foobar1'
),
CustomField(
name='Custom Field 2',
@@ -48,7 +51,9 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
required=False,
weight=200,
filter_logic=CustomFieldFilterLogicChoices.FILTER_EXACT,
- ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_READ_ONLY
+ ui_visible=CustomFieldUIVisibleChoices.IF_SET,
+ ui_editable=CustomFieldUIEditableChoices.NO,
+ description='foobar2'
),
CustomField(
name='Custom Field 3',
@@ -56,7 +61,9 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
required=False,
weight=300,
filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED,
- ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_HIDDEN
+ ui_visible=CustomFieldUIVisibleChoices.HIDDEN,
+ ui_editable=CustomFieldUIEditableChoices.HIDDEN,
+ description='foobar3'
),
CustomField(
name='Custom Field 4',
@@ -64,7 +71,8 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
required=False,
weight=400,
filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED,
- ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_HIDDEN,
+ ui_visible=CustomFieldUIVisibleChoices.HIDDEN,
+ ui_editable=CustomFieldUIEditableChoices.HIDDEN,
choice_set=choice_sets[0]
),
CustomField(
@@ -73,7 +81,8 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
required=False,
weight=500,
filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED,
- ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_HIDDEN,
+ ui_visible=CustomFieldUIVisibleChoices.HIDDEN,
+ ui_editable=CustomFieldUIEditableChoices.HIDDEN,
choice_set=choice_sets[1]
),
)
@@ -84,6 +93,10 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
custom_fields[3].content_types.add(ContentType.objects.get_by_natural_key('dcim', 'device'))
custom_fields[4].content_types.add(ContentType.objects.get_by_natural_key('dcim', 'device'))
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Custom Field 1', 'Custom Field 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -106,8 +119,12 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
params = {'filter_logic': CustomFieldFilterLogicChoices.FILTER_LOOSE}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
- def test_ui_visibility(self):
- params = {'ui_visibility': CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE}
+ def test_ui_visible(self):
+ params = {'ui_visible': CustomFieldUIVisibleChoices.ALWAYS}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
+ def test_ui_editable(self):
+ params = {'ui_editable': CustomFieldUIEditableChoices.YES}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
def test_choice_set(self):
@@ -116,6 +133,10 @@ class CustomFieldTestCase(TestCase, BaseFilterSetTests):
params = {'choice_set_id': CustomFieldChoiceSet.objects.values_list('pk', flat=True)}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
class CustomFieldChoiceSetTestCase(TestCase, BaseFilterSetTests):
queryset = CustomFieldChoiceSet.objects.all()
@@ -124,12 +145,16 @@ class CustomFieldChoiceSetTestCase(TestCase, BaseFilterSetTests):
@classmethod
def setUpTestData(cls):
choice_sets = (
- CustomFieldChoiceSet(name='Choice Set 1', extra_choices=['A', 'B', 'C']),
- CustomFieldChoiceSet(name='Choice Set 2', extra_choices=['D', 'E', 'F']),
- CustomFieldChoiceSet(name='Choice Set 3', extra_choices=['G', 'H', 'I']),
+ CustomFieldChoiceSet(name='Choice Set 1', extra_choices=['A', 'B', 'C'], description='foobar1'),
+ CustomFieldChoiceSet(name='Choice Set 2', extra_choices=['D', 'E', 'F'], description='foobar2'),
+ CustomFieldChoiceSet(name='Choice Set 3', extra_choices=['G', 'H', 'I'], description='foobar3'),
)
CustomFieldChoiceSet.objects.bulk_create(choice_sets)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Choice Set 1', 'Choice Set 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -138,6 +163,10 @@ class CustomFieldChoiceSetTestCase(TestCase, BaseFilterSetTests):
params = {'choice': ['A', 'D']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
class WebhookTestCase(TestCase, BaseFilterSetTests):
queryset = Webhook.objects.all()
@@ -150,82 +179,196 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
webhooks = (
Webhook(
name='Webhook 1',
- type_create=True,
- type_update=False,
- type_delete=False,
- type_job_start=False,
- type_job_end=False,
payload_url='http://example.com/?1',
- enabled=True,
http_method='GET',
ssl_verification=True,
+ description='foobar1'
),
Webhook(
name='Webhook 2',
- type_create=False,
- type_update=True,
- type_delete=False,
- type_job_start=False,
- type_job_end=False,
payload_url='http://example.com/?2',
- enabled=True,
http_method='POST',
ssl_verification=True,
+ description='foobar2'
),
Webhook(
name='Webhook 3',
- type_create=False,
- type_update=False,
- type_delete=True,
- type_job_start=False,
- type_job_end=False,
payload_url='http://example.com/?3',
- enabled=False,
http_method='PATCH',
ssl_verification=False,
+ description='foobar3'
),
Webhook(
name='Webhook 4',
- type_create=False,
- type_update=False,
- type_delete=False,
- type_job_start=True,
- type_job_end=False,
payload_url='http://example.com/?4',
- enabled=False,
http_method='PATCH',
ssl_verification=False,
),
Webhook(
name='Webhook 5',
- type_create=False,
- type_update=False,
- type_delete=False,
- type_job_start=False,
- type_job_end=True,
payload_url='http://example.com/?5',
- enabled=False,
http_method='PATCH',
ssl_verification=False,
),
)
Webhook.objects.bulk_create(webhooks)
- webhooks[0].content_types.add(content_types[0])
- webhooks[1].content_types.add(content_types[1])
- webhooks[2].content_types.add(content_types[2])
- webhooks[3].content_types.add(content_types[3])
- webhooks[4].content_types.add(content_types[4])
+
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
def test_name(self):
params = {'name': ['Webhook 1', 'Webhook 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_http_method(self):
+ params = {'http_method': ['GET', 'POST']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_ssl_verification(self):
+ params = {'ssl_verification': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+
+class EventRuleTestCase(TestCase, BaseFilterSetTests):
+ queryset = EventRule.objects.all()
+ filterset = EventRuleFilterSet
+
+ @classmethod
+ def setUpTestData(cls):
+ content_types = ContentType.objects.filter(
+ model__in=['region', 'site', 'rack', 'location', 'device']
+ )
+
+ webhooks = (
+ Webhook(
+ name='Webhook 1',
+ payload_url='http://example.com/?1',
+ ),
+ Webhook(
+ name='Webhook 2',
+ payload_url='http://example.com/?2',
+ ),
+ Webhook(
+ name='Webhook 3',
+ payload_url='http://example.com/?3',
+ ),
+ )
+ Webhook.objects.bulk_create(webhooks)
+
+ scripts = (
+ ScriptModule(
+ file_root=ManagedFileRootPathChoices.SCRIPTS,
+ file_path='/var/tmp/script1.py'
+ ),
+ ScriptModule(
+ file_root=ManagedFileRootPathChoices.SCRIPTS,
+ file_path='/var/tmp/script2.py'
+ ),
+ )
+ ScriptModule.objects.bulk_create(scripts)
+
+ event_rules = (
+ EventRule(
+ name='Event Rule 1',
+ action_object=webhooks[0],
+ enabled=True,
+ type_create=True,
+ type_update=False,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=False,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ description='foobar1'
+ ),
+ EventRule(
+ name='Event Rule 2',
+ action_object=webhooks[1],
+ enabled=True,
+ type_create=False,
+ type_update=True,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=False,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ description='foobar2'
+ ),
+ EventRule(
+ name='Event Rule 3',
+ action_object=webhooks[2],
+ enabled=False,
+ type_create=False,
+ type_update=False,
+ type_delete=True,
+ type_job_start=False,
+ type_job_end=False,
+ action_type=EventRuleActionChoices.WEBHOOK,
+ description='foobar3'
+ ),
+ EventRule(
+ name='Event Rule 4',
+ action_object=scripts[0],
+ enabled=False,
+ type_create=False,
+ type_update=False,
+ type_delete=False,
+ type_job_start=True,
+ type_job_end=False,
+ action_type=EventRuleActionChoices.SCRIPT,
+ ),
+ EventRule(
+ name='Event Rule 5',
+ action_object=scripts[1],
+ enabled=False,
+ type_create=False,
+ type_update=False,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=True,
+ action_type=EventRuleActionChoices.SCRIPT,
+ ),
+ )
+ EventRule.objects.bulk_create(event_rules)
+ event_rules[0].content_types.add(content_types[0])
+ event_rules[1].content_types.add(content_types[1])
+ event_rules[2].content_types.add(content_types[2])
+ event_rules[3].content_types.add(content_types[3])
+ event_rules[4].content_types.add(content_types[4])
+
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
+ def test_name(self):
+ params = {'name': ['Event Rule 1', 'Event Rule 2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
def test_content_types(self):
params = {'content_types': 'dcim.region'}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
params = {'content_type_id': [ContentType.objects.get_for_model(Region).pk]}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+ def test_action_type(self):
+ params = {'action_type': [EventRuleActionChoices.WEBHOOK]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+ params = {'action_type': [EventRuleActionChoices.SCRIPT]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_enabled(self):
+ params = {'enabled': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ params = {'enabled': False}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+
def test_type_create(self):
params = {'type_create': True}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
@@ -246,18 +389,6 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
params = {'type_job_end': True}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
- def test_enabled(self):
- params = {'enabled': True}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
- def test_http_method(self):
- params = {'http_method': ['GET', 'POST']}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
- def test_ssl_verification(self):
- params = {'ssl_verification': True}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
class CustomLinkTestCase(TestCase, BaseFilterSetTests):
queryset = CustomLink.objects.all()
@@ -297,6 +428,10 @@ class CustomLinkTestCase(TestCase, BaseFilterSetTests):
for i, custom_link in enumerate(custom_links):
custom_link.content_types.set([content_types[i]])
+ def test_q(self):
+ params = {'q': 'Custom Link 1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Custom Link 1', 'Custom Link 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -347,7 +482,8 @@ class SavedFilterTestCase(TestCase, BaseFilterSetTests):
weight=100,
enabled=True,
shared=True,
- parameters={'status': ['active']}
+ parameters={'status': ['active']},
+ description='foobar1'
),
SavedFilter(
name='Saved Filter 2',
@@ -356,7 +492,8 @@ class SavedFilterTestCase(TestCase, BaseFilterSetTests):
weight=200,
enabled=True,
shared=True,
- parameters={'status': ['planned']}
+ parameters={'status': ['planned']},
+ description='foobar2'
),
SavedFilter(
name='Saved Filter 3',
@@ -365,13 +502,18 @@ class SavedFilterTestCase(TestCase, BaseFilterSetTests):
weight=300,
enabled=False,
shared=False,
- parameters={'status': ['retired']}
+ parameters={'status': ['retired']},
+ description='foobar3'
),
)
SavedFilter.objects.bulk_create(saved_filters)
for i, savedfilter in enumerate(saved_filters):
savedfilter.content_types.set([content_types[i]])
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Saved Filter 1', 'Saved Filter 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -380,6 +522,10 @@ class SavedFilterTestCase(TestCase, BaseFilterSetTests):
params = {'slug': ['saved-filter-1', 'saved-filter-2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
def test_content_types(self):
params = {'content_types': 'dcim.site'}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
@@ -423,8 +569,6 @@ class BookmarkTestCase(TestCase, BaseFilterSetTests):
@classmethod
def setUpTestData(cls):
- content_types = ContentType.objects.filter(model__in=['site', 'rack', 'device'])
-
users = (
User(username='User 1'),
User(username='User 2'),
@@ -505,6 +649,10 @@ class ExportTemplateTestCase(TestCase, BaseFilterSetTests):
for i, et in enumerate(export_templates):
et.content_types.set([content_types[i]])
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Export Template 1', 'Export Template 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -578,6 +726,10 @@ class ImageAttachmentTestCase(TestCase, BaseFilterSetTests):
)
ImageAttachment.objects.bulk_create(image_attachments)
+ def test_q(self):
+ params = {'q': 'Attachment 1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Image Attachment 1', 'Image Attachment 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -630,41 +782,45 @@ class JournalEntryTestCase(TestCase, ChangeLoggedFilterSetTests):
assigned_object=sites[0],
created_by=users[0],
kind=JournalEntryKindChoices.KIND_INFO,
- comments='New journal entry'
+ comments='foobar1'
),
JournalEntry(
assigned_object=sites[0],
created_by=users[1],
kind=JournalEntryKindChoices.KIND_SUCCESS,
- comments='New journal entry'
+ comments='foobar2'
),
JournalEntry(
assigned_object=sites[1],
created_by=users[2],
kind=JournalEntryKindChoices.KIND_WARNING,
- comments='New journal entry'
+ comments='foobar3'
),
JournalEntry(
assigned_object=racks[0],
created_by=users[0],
kind=JournalEntryKindChoices.KIND_INFO,
- comments='New journal entry'
+ comments='foobar4'
),
JournalEntry(
assigned_object=racks[0],
created_by=users[1],
kind=JournalEntryKindChoices.KIND_SUCCESS,
- comments='New journal entry'
+ comments='foobar5'
),
JournalEntry(
assigned_object=racks[1],
created_by=users[2],
kind=JournalEntryKindChoices.KIND_WARNING,
- comments='New journal entry'
+ comments='foobar6'
),
)
JournalEntry.objects.bulk_create(journal_entries)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_created_by(self):
users = User.objects.filter(username__in=['Alice', 'Bob'])
params = {'created_by': [users[0].username, users[1].username]}
@@ -800,9 +956,10 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests):
for i in range(0, 3):
is_active = bool(i % 2)
c = ConfigContext.objects.create(
- name='Config Context {}'.format(i + 1),
+ name=f"Config Context {i + 1}",
is_active=is_active,
- data='{"foo": 123}'
+ data='{"foo": 123}',
+ description=f"foobar{i + 1}"
)
c.regions.set([regions[i]])
c.site_groups.set([site_groups[i]])
@@ -818,6 +975,10 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests):
c.tenants.set([tenants[i]])
c.tags.set([tags[i]])
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Config Context 1', 'Config Context 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -828,6 +989,10 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests):
params = {'is_active': False}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ def test_description(self):
+ params = {'description': ['foobar1', 'foobar2']}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
def test_region(self):
regions = Region.objects.all()[:2]
params = {'region_id': [regions[0].pk, regions[1].pk]}
@@ -929,6 +1094,10 @@ class ConfigTemplateTestCase(TestCase, BaseFilterSetTests):
)
ConfigTemplate.objects.bulk_create(config_templates)
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Config Template 1', 'Config Template 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -965,6 +1134,10 @@ class TagTestCase(TestCase, ChangeLoggedFilterSetTests):
site.tags.set([tags[0]])
provider.tags.set([tags[1]])
+ def test_q(self):
+ params = {'q': 'foobar1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_name(self):
params = {'name': ['Tag 1', 'Tag 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -1076,6 +1249,10 @@ class ObjectChangeTestCase(TestCase, BaseFilterSetTests):
)
ObjectChange.objects.bulk_create(object_changes)
+ def test_q(self):
+ params = {'q': 'Site 1'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+
def test_user(self):
params = {'user_id': User.objects.filter(username__in=['user1', 'user2']).values_list('pk', flat=True)}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4)
@@ -1109,11 +1286,13 @@ class ChangeLoggedFilterSetTestCase(TestCase):
Site(name='Site 1', slug='site-1'),
Site(name='Site 2', slug='site-2'),
Site(name='Site 3', slug='site-3'),
+ Site(name='Site 4', slug='site-4'),
)
Site.objects.bulk_create(sites)
# Simulate *creation* changelog records for two of the sites
request_id = uuid.uuid4()
+ cls.create_request_id = request_id
objectchanges = (
ObjectChange(
changed_object_type=content_type,
@@ -1132,6 +1311,7 @@ class ChangeLoggedFilterSetTestCase(TestCase):
# Simulate *update* changelog records for two of the sites
request_id = uuid.uuid4()
+ cls.update_request_id = request_id
objectchanges = (
ObjectChange(
changed_object_type=content_type,
@@ -1148,14 +1328,36 @@ class ChangeLoggedFilterSetTestCase(TestCase):
)
ObjectChange.objects.bulk_create(objectchanges)
+ # Simulate *create* and *update* changelog records for two of the sites
+ request_id = uuid.uuid4()
+ cls.create_update_request_id = request_id
+ objectchanges = (
+ ObjectChange(
+ changed_object_type=content_type,
+ changed_object_id=sites[2].pk,
+ action=ObjectChangeActionChoices.ACTION_CREATE,
+ request_id=request_id
+ ),
+ ObjectChange(
+ changed_object_type=content_type,
+ changed_object_id=sites[3].pk,
+ action=ObjectChangeActionChoices.ACTION_UPDATE,
+ request_id=request_id
+ ),
+ )
+ ObjectChange.objects.bulk_create(objectchanges)
+
def test_created_by_request(self):
- request_id = ObjectChange.objects.filter(action=ObjectChangeActionChoices.ACTION_CREATE).first().request_id
- params = {'created_by_request': request_id}
+ params = {'created_by_request': self.create_request_id}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
- self.assertEqual(self.queryset.count(), 3)
+ self.assertEqual(self.queryset.count(), 4)
def test_updated_by_request(self):
- request_id = ObjectChange.objects.filter(action=ObjectChangeActionChoices.ACTION_UPDATE).first().request_id
- params = {'updated_by_request': request_id}
+ params = {'updated_by_request': self.update_request_id}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
- self.assertEqual(self.queryset.count(), 3)
+ self.assertEqual(self.queryset.count(), 4)
+
+ def test_modified_by_request(self):
+ params = {'modified_by_request': self.create_update_request_id}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+ self.assertEqual(self.queryset.count(), 4)
diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py
index 01ef9a2a6..d720560e4 100644
--- a/netbox/extras/tests/test_views.py
+++ b/netbox/extras/tests/test_views.py
@@ -1,4 +1,3 @@
-import json
import urllib.parse
import uuid
@@ -6,12 +5,11 @@ from django.contrib.auth import get_user_model
from django.contrib.contenttypes.models import ContentType
from django.urls import reverse
-from dcim.models import Site
+from dcim.models import DeviceType, Manufacturer, Site
from extras.choices import *
from extras.models import *
from utilities.testing import ViewTestCases, TestCase
-
User = get_user_model()
@@ -50,15 +48,16 @@ class CustomFieldTestCase(ViewTestCases.PrimaryObjectViewTestCase):
'default': None,
'weight': 200,
'required': True,
- 'ui_visibility': CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE,
+ 'ui_visible': CustomFieldUIVisibleChoices.ALWAYS,
+ 'ui_editable': CustomFieldUIEditableChoices.YES,
}
cls.csv_data = (
- 'name,label,type,content_types,object_type,weight,search_weight,filter_logic,choice_set,validation_minimum,validation_maximum,validation_regex,ui_visibility',
- 'field4,Field 4,text,dcim.site,,100,1000,exact,,,,[a-z]{3},read-write',
- 'field5,Field 5,integer,dcim.site,,100,2000,exact,,1,100,,read-write',
- 'field6,Field 6,select,dcim.site,,100,3000,exact,Choice Set 1,,,,read-write',
- 'field7,Field 7,object,dcim.site,dcim.region,100,4000,exact,,,,,read-write',
+ 'name,label,type,content_types,object_type,weight,search_weight,filter_logic,choice_set,validation_minimum,validation_maximum,validation_regex,ui_visible,ui_editable',
+ 'field4,Field 4,text,dcim.site,,100,1000,exact,,,,[a-z]{3},always,yes',
+ 'field5,Field 5,integer,dcim.site,,100,2000,exact,,1,100,,always,yes',
+ 'field6,Field 6,select,dcim.site,,100,3000,exact,Choice Set 1,,,,always,yes',
+ 'field7,Field 7,object,dcim.site,dcim.region,100,4000,exact,,,,,always,yes',
)
cls.csv_update_data = (
@@ -93,19 +92,24 @@ class CustomFieldChoiceSetTestCase(ViewTestCases.PrimaryObjectViewTestCase):
name='Choice Set 3',
extra_choices=(('C1', 'Choice 1'), ('C2', 'Choice 2'), ('C3', 'Choice 3'))
),
+ CustomFieldChoiceSet(
+ name='Choice Set 4',
+ extra_choices=(('D1', 'Choice 1'), ('D2', 'Choice 2'), ('D3', 'Choice 3'))
+ ),
)
CustomFieldChoiceSet.objects.bulk_create(choice_sets)
cls.form_data = {
'name': 'Choice Set X',
- 'extra_choices': '\n'.join(['X1,Choice 1', 'X2,Choice 2', 'X3,Choice 3'])
+ 'extra_choices': '\n'.join(['X1:Choice 1', 'X2:Choice 2', 'X3:Choice 3'])
}
cls.csv_data = (
'name,extra_choices',
- 'Choice Set 4,"D1,D2,D3"',
- 'Choice Set 5,"E1,E2,E3"',
- 'Choice Set 6,"F1,F2,F3"',
+ 'Choice Set 5,"D1,D2,D3"',
+ 'Choice Set 6,"E1,E2,E3"',
+ 'Choice Set 7,"F1,F2,F3"',
+ 'Choice Set 8,"F1:L1,F2:L2,F3:L3"',
)
cls.csv_update_data = (
@@ -113,12 +117,20 @@ class CustomFieldChoiceSetTestCase(ViewTestCases.PrimaryObjectViewTestCase):
f'{choice_sets[0].pk},"A,B,C"',
f'{choice_sets[1].pk},"A,B,C"',
f'{choice_sets[2].pk},"A,B,C"',
+ f'{choice_sets[3].pk},"A:L1,B:L2,C:L3"',
)
cls.bulk_edit_data = {
'description': 'New description',
}
+ # This is here as extra_choices field splits on colon, but is returned
+ # from DB as comma separated.
+ def assertInstanceEqual(self, instance, data, exclude=None, api=False):
+ if 'extra_choices' in data:
+ data['extra_choices'] = data['extra_choices'].replace(':', ',')
+ return super().assertInstanceEqual(instance, data, exclude, api)
+
class CustomLinkTestCase(ViewTestCases.PrimaryObjectViewTestCase):
model = CustomLink
@@ -335,48 +347,94 @@ class WebhookTestCase(ViewTestCases.PrimaryObjectViewTestCase):
@classmethod
def setUpTestData(cls):
- site_ct = ContentType.objects.get_for_model(Site)
webhooks = (
- Webhook(name='Webhook 1', payload_url='http://example.com/?1', type_create=True, http_method='POST'),
- Webhook(name='Webhook 2', payload_url='http://example.com/?2', type_create=True, http_method='POST'),
- Webhook(name='Webhook 3', payload_url='http://example.com/?3', type_create=True, http_method='POST'),
+ Webhook(name='Webhook 1', payload_url='http://example.com/?1', http_method='POST'),
+ Webhook(name='Webhook 2', payload_url='http://example.com/?2', http_method='POST'),
+ Webhook(name='Webhook 3', payload_url='http://example.com/?3', http_method='POST'),
)
for webhook in webhooks:
webhook.save()
- webhook.content_types.add(site_ct)
cls.form_data = {
'name': 'Webhook X',
+ 'payload_url': 'http://example.com/?x',
+ 'http_method': 'GET',
+ 'http_content_type': 'application/foo',
+ 'description': 'My webhook',
+ }
+
+ cls.csv_data = (
+ "name,payload_url,http_method,http_content_type,description",
+ "Webhook 4,http://example.com/?4,GET,application/json,Foo",
+ "Webhook 5,http://example.com/?5,GET,application/json,Bar",
+ "Webhook 6,http://example.com/?6,GET,application/json,Baz",
+ )
+
+ cls.csv_update_data = (
+ "id,name,description",
+ f"{webhooks[0].pk},Webhook 7,Foo",
+ f"{webhooks[1].pk},Webhook 8,Bar",
+ f"{webhooks[2].pk},Webhook 9,Baz",
+ )
+
+ cls.bulk_edit_data = {
+ 'http_method': 'GET',
+ }
+
+
+class EventRulesTestCase(ViewTestCases.PrimaryObjectViewTestCase):
+ model = EventRule
+
+ @classmethod
+ def setUpTestData(cls):
+
+ webhooks = (
+ Webhook(name='Webhook 1', payload_url='http://example.com/?1', http_method='POST'),
+ Webhook(name='Webhook 2', payload_url='http://example.com/?2', http_method='POST'),
+ Webhook(name='Webhook 3', payload_url='http://example.com/?3', http_method='POST'),
+ )
+ for webhook in webhooks:
+ webhook.save()
+
+ site_ct = ContentType.objects.get_for_model(Site)
+ event_rules = (
+ EventRule(name='EventRule 1', type_create=True, action_object=webhooks[0]),
+ EventRule(name='EventRule 2', type_create=True, action_object=webhooks[1]),
+ EventRule(name='EventRule 3', type_create=True, action_object=webhooks[2]),
+ )
+ for event in event_rules:
+ event.save()
+ event.content_types.add(site_ct)
+
+ webhook_ct = ContentType.objects.get_for_model(Webhook)
+ cls.form_data = {
+ 'name': 'Event X',
'content_types': [site_ct.pk],
'type_create': False,
'type_update': True,
'type_delete': True,
- 'payload_url': 'http://example.com/?x',
- 'http_method': 'GET',
- 'http_content_type': 'application/foo',
'conditions': None,
+ 'action_type': 'webhook',
+ 'action_object_type': webhook_ct.pk,
+ 'action_object_id': webhooks[0].pk,
+ 'action_choice': webhooks[0],
+ 'description': 'New description',
}
cls.csv_data = (
- "name,content_types,type_create,payload_url,http_method,http_content_type",
- "Webhook 4,dcim.site,True,http://example.com/?4,GET,application/json",
- "Webhook 5,dcim.site,True,http://example.com/?5,GET,application/json",
- "Webhook 6,dcim.site,True,http://example.com/?6,GET,application/json",
+ "name,content_types,type_create,action_type,action_object",
+ "Webhook 4,dcim.site,True,webhook,Webhook 1",
)
cls.csv_update_data = (
"id,name",
- f"{webhooks[0].pk},Webhook 7",
- f"{webhooks[1].pk},Webhook 8",
- f"{webhooks[2].pk},Webhook 9",
+ f"{event_rules[0].pk},Event 7",
+ f"{event_rules[1].pk},Event 8",
+ f"{event_rules[2].pk},Event 9",
)
cls.bulk_edit_data = {
- 'enabled': False,
- 'type_create': False,
'type_update': True,
- 'type_delete': True,
- 'http_method': 'GET',
}
@@ -434,7 +492,8 @@ class ConfigContextTestCase(
@classmethod
def setUpTestData(cls):
- site = Site.objects.create(name='Site 1', slug='site-1')
+ manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1')
+ devicetype = DeviceType.objects.create(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1')
# Create three ConfigContexts
for i in range(1, 4):
@@ -443,7 +502,7 @@ class ConfigContextTestCase(
data={'foo': i}
)
configcontext.save()
- configcontext.sites.add(site)
+ configcontext.device_types.add(devicetype)
cls.form_data = {
'name': 'Config Context X',
@@ -451,11 +510,12 @@ class ConfigContextTestCase(
'description': 'A new config context',
'is_active': True,
'regions': [],
- 'sites': [site.pk],
+ 'sites': [],
'roles': [],
'platforms': [],
'tenant_groups': [],
'tenants': [],
+ 'device_types': [devicetype.id],
'tags': [],
'data': '{"foo": 123}',
}
diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py
index fd95186e4..0a1786f1f 100644
--- a/netbox/extras/urls.py
+++ b/netbox/extras/urls.py
@@ -61,6 +61,14 @@ urlpatterns = [
path('webhooks/delete/', views.WebhookBulkDeleteView.as_view(), name='webhook_bulk_delete'),
path('webhooks/"+bs(e[t].content)+`
-`};Ia.fence=function(e,t,r,n,a){var o=e[t],s=o.info?wY(o.info).trim():"",l="",d,h,v,b;return s&&(l=s.split(/\s+/g)[0]),r.highlight?d=r.highlight(o.content,l)||bs(o.content):d=bs(o.content),d.indexOf("