/
filters.py
286 lines (244 loc) · 9.19 KB
/
filters.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
"""Filters for UI and API Views."""
import django_filters
from django.db.models import Q
from nautobot.dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Platform, Rack, RackGroup, Region, Site
from nautobot.extras.filters import CustomFieldModelFilterSetMixin, StatusFilter
from nautobot.extras.models import Status
from nautobot.tenancy.models import Tenant, TenantGroup
from nautobot.utilities.filters import BaseFilterSet, NameSlugSearchFilterSet, TreeNodeMultipleChoiceFilter
from nautobot_golden_config import models
class GenericPlatformFilterSet(CustomFieldModelFilterSetMixin):
"""Generic method to reuse common FilterSet."""
platform_id = django_filters.ModelMultipleChoiceFilter(
queryset=Platform.objects.all(),
label="Platform (ID)",
)
platform = django_filters.ModelMultipleChoiceFilter(
field_name="platform__slug",
queryset=Platform.objects.all(),
to_field_name="slug",
label="Platform (slug)",
)
class GoldenConfigFilterSet(CustomFieldModelFilterSetMixin):
"""Filter capabilities for GoldenConfig instances."""
q = django_filters.CharFilter(
method="search",
label="Search",
)
tenant_group_id = TreeNodeMultipleChoiceFilter(
queryset=TenantGroup.objects.all(),
field_name="device__tenant__group",
label="Tenant Group (ID)",
)
tenant_group = TreeNodeMultipleChoiceFilter(
queryset=TenantGroup.objects.all(),
field_name="device__tenant__group",
to_field_name="slug",
label="Tenant Group (slug)",
)
tenant_id = django_filters.ModelMultipleChoiceFilter(
queryset=Tenant.objects.all(),
field_name="device__tenant_id",
label="Tenant (ID)",
)
tenant = django_filters.ModelMultipleChoiceFilter(
queryset=Tenant.objects.all(),
field_name="device__tenant__slug",
to_field_name="slug",
label="Tenant (slug)",
)
region_id = TreeNodeMultipleChoiceFilter(
queryset=Region.objects.all(),
field_name="device__site__region",
label="Region (ID)",
)
region = TreeNodeMultipleChoiceFilter(
queryset=Region.objects.all(),
field_name="device__site__region",
to_field_name="slug",
label="Region (slug)",
)
site_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__site",
queryset=Site.objects.all(),
label="Site (ID)",
)
site = django_filters.ModelMultipleChoiceFilter(
field_name="device__site__slug",
queryset=Site.objects.all(),
to_field_name="slug",
label="Site name (slug)",
)
rack_group_id = TreeNodeMultipleChoiceFilter(
queryset=RackGroup.objects.all(),
field_name="device__rack__group",
label="Rack group (ID)",
)
rack_group = TreeNodeMultipleChoiceFilter(
field_name="device__rack__group",
queryset=RackGroup.objects.all(),
label="Rack group (slug)",
)
rack_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__rack",
queryset=Rack.objects.all(),
label="Rack (ID)",
)
rack = django_filters.ModelMultipleChoiceFilter(
field_name="device__rack__name",
queryset=Rack.objects.all(),
to_field_name="name",
label="Rack (name)",
)
role_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_role_id",
queryset=DeviceRole.objects.all(),
label="Role (ID)",
)
role = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_role__slug",
queryset=DeviceRole.objects.all(),
to_field_name="slug",
label="Role (slug)",
)
manufacturer_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_type__manufacturer",
queryset=Manufacturer.objects.all(),
label="Manufacturer (ID)",
)
manufacturer = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_type__manufacturer__slug",
queryset=Manufacturer.objects.all(),
to_field_name="slug",
label="Manufacturer (slug)",
)
platform_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__platform",
queryset=Platform.objects.all(),
label="Platform (ID)",
)
platform = django_filters.ModelMultipleChoiceFilter(
field_name="device__platform__slug",
queryset=Platform.objects.all(),
to_field_name="slug",
label="Platform (slug)",
)
device_status_id = StatusFilter(
field_name="device__status_id",
queryset=Status.objects.all(),
label="Device Status",
)
device_status = StatusFilter(
field_name="device__status",
queryset=Status.objects.all(),
label="Device Status",
)
device_type_id = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_type_id",
queryset=DeviceType.objects.all(),
label="Device type (ID)",
)
device_type = django_filters.ModelMultipleChoiceFilter(
field_name="device__device_type__slug",
queryset=DeviceType.objects.all(),
to_field_name="slug",
label="DeviceType (slug)",
)
device_id = django_filters.ModelMultipleChoiceFilter(
queryset=Device.objects.all(),
label="Device ID",
)
device = django_filters.ModelMultipleChoiceFilter(
field_name="device__name",
queryset=Device.objects.all(),
to_field_name="name",
label="Device Name",
)
def search(self, queryset, name, value): # pylint: disable=unused-argument,no-self-use
"""Perform the filtered search."""
if not value.strip():
return queryset
# Chose only device, can be convinced more should be included
qs_filter = Q(device__name__icontains=value)
return queryset.filter(qs_filter)
class Meta:
"""Meta class attributes for GoldenConfigFilter."""
model = models.GoldenConfig
distinct = True
fields = ["id"]
class ConfigComplianceFilterSet(GoldenConfigFilterSet):
"""Filter capabilities for ConfigCompliance instances."""
class Meta:
"""Meta class attributes for ConfigComplianceFilter."""
model = models.ConfigCompliance
fields = ["id"]
class ComplianceFeatureFilterSet(CustomFieldModelFilterSetMixin):
"""Inherits Base Class CustomFieldModelFilterSetMixin."""
q = django_filters.CharFilter(
method="search",
label="Search",
)
def search(self, queryset, name, value): # pylint: disable=unused-argument,no-self-use
"""Perform the filtered search."""
if not value.strip():
return queryset
qs_filter = Q(name__icontains=value)
return queryset.filter(qs_filter)
class Meta:
"""Boilerplate filter Meta data for compliance feature."""
model = models.ComplianceFeature
fields = ["id", "name", "slug"]
class ComplianceRuleFilterSet(GenericPlatformFilterSet):
"""Inherits Base Class CustomFieldModelFilterSetMixin."""
q = django_filters.CharFilter(
method="search",
label="Search",
)
def search(self, queryset, name, value): # pylint: disable=unused-argument,no-self-use
"""Perform the filtered search."""
if not value.strip():
return queryset
qs_filter = Q(feature__name__icontains=value)
return queryset.filter(qs_filter)
class Meta:
"""Boilerplate filter Meta data for compliance rule."""
model = models.ComplianceRule
fields = ["feature", "id"]
class ConfigRemoveFilterSet(GenericPlatformFilterSet):
"""Inherits Base Class CustomFieldModelFilterSetMixin."""
q = django_filters.CharFilter(
method="search",
label="Search",
)
def search(self, queryset, name, value): # pylint: disable=unused-argument,no-self-use
"""Perform the filtered search."""
if not value.strip():
return queryset
qs_filter = Q(name__icontains=value)
return queryset.filter(qs_filter)
class Meta:
"""Boilerplate filter Meta data for Config Remove."""
model = models.ConfigRemove
fields = ["id", "name"]
class ConfigReplaceFilterSet(GenericPlatformFilterSet):
"""Inherits Base Class CustomFieldModelFilterSetMixin."""
q = django_filters.CharFilter(
method="search",
label="Search",
)
def search(self, queryset, name, value): # pylint: disable=unused-argument,no-self-use
"""Perform the filtered search."""
if not value.strip():
return queryset
qs_filter = Q(name__icontains=value)
return queryset.filter(qs_filter)
class Meta:
"""Boilerplate filter Meta data for Config Replace."""
model = models.ConfigReplace
fields = ["id", "name"]
class GoldenConfigSettingFilterSet(BaseFilterSet, NameSlugSearchFilterSet):
"""Inherits Base Class BaseFilterSet."""
class Meta:
"""Boilerplate filter Meta data for Config Remove."""
model = models.GoldenConfigSetting
fields = ["id", "name", "slug", "weight", "backup_repository", "intended_repository", "jinja_repository"]