/usr/lib/python2.7/dist-packages/maasserver/node_constraint_filter_forms.py is in python-django-maas 1.5+bzr2252-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 | # Copyright 2013-2014 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
from __future__ import (
absolute_import,
print_function,
unicode_literals,
)
str = None
__metaclass__ = type
__all__ = [
'AcquireNodeForm',
]
import itertools
from itertools import chain
import re
from django import forms
from django.core.exceptions import ValidationError
from django.db.models import Q
from maasserver.fields import mac_validator
from maasserver.forms import (
UnconstrainedMultipleChoiceField,
ValidatorMultipleChoiceField,
)
import maasserver.forms as maasserver_forms
from maasserver.models import (
Network,
Tag,
Zone,
)
from maasserver.models.network import parse_network_spec
from maasserver.models.zone import ZONE_NAME_VALIDATOR
from maasserver.utils.orm import (
macs_contain,
macs_do_not_contain,
)
def generate_architecture_wildcards(arches):
"""Map 'primary' architecture names to a list of full expansions.
Return a dictionary keyed by the primary architecture name (the part before
the '/'). The value of an entry is a frozenset of full architecture names
('primary_arch/subarch') under the keyed primary architecture.
"""
sorted_arch_list = sorted(arches)
def extract_primary_arch(arch):
return arch.split('/')[0]
return {
primary_arch: frozenset(subarch_generator)
for primary_arch, subarch_generator in itertools.groupby(
sorted_arch_list, key=extract_primary_arch
)
}
def get_architecture_wildcards(arches):
wildcards = generate_architecture_wildcards(arches)
# juju uses a general "arm" architecture constraint across all of its
# providers. Since armhf is the cross-distro agreed Linux userspace
# architecture and ABI and ARM servers are expected to only use armhf,
# interpret "arm" to mean "armhf" in MAAS.
if 'armhf' in wildcards and 'arm' not in wildcards:
wildcards['arm'] = wildcards['armhf']
return wildcards
def parse_legacy_tags(values):
# Support old-method to pass a list of strings using a
# comma-separated or space-separated list.
# 'values' is assumed to be a list of strings.
result = chain.from_iterable(
re.findall(r'[^\s,]+', value) for value in values)
return list(result)
# Mapping used to rename the fields from the AcquireNodeForm form.
# The new names correspond to the names used by Juju. This is used so
# that the search form present on the node listing page can be used to
# filter nodes using Juju's semantics.
JUJU_ACQUIRE_FORM_FIELDS_MAPPING = {
'name': 'maas-name',
'tags': 'maas-tags',
'arch': 'architecture',
'cpu_count': 'cpu',
}
# XXX JeroenVermeulen 2014-02-06: Can we document this please?
class RenamableFieldsForm(forms.Form):
def __init__(self, *args, **kwargs):
super(RenamableFieldsForm, self).__init__(*args, **kwargs)
self.field_mapping = {name: name for name in self.fields}
def get_field_name(self, name):
"""Get the new name of the field named 'name'."""
return self.field_mapping[name]
def rename_fields(self, mapping):
"""Rename all the field as described in the given mapping."""
for old_name, new_name in mapping.items():
self.rename_field(old_name, new_name)
def rename_field(self, old_name, new_name):
"""Rename a field."""
if old_name in self.fields:
# Rename field mapping.
self.field_mapping[old_name] = new_name
# Rename field.
self.fields[new_name] = self.fields.pop(old_name)
# Rename clean_field() method if it exists.
clean_name = "clean_%s" % old_name
method = getattr(self, clean_name, None)
if method is not None:
setattr(self, "clean_%s" % new_name, method)
def detect_nonexistent_zone_names(names):
"""Check for, and return, names of nonexistent physical zones.
Used for checking zone names as passed to the `AcquireNodeForm`.
:param names: List, tuple, or set of purpoprted zone names.
:return: A sorted list of those names that did not name existing zones.
"""
assert isinstance(names, (list, tuple, set))
if len(names) == 0:
return []
existing_names = set(Zone.objects.all().values_list('name', flat=True))
return sorted(set(names) - existing_names)
class AcquireNodeForm(RenamableFieldsForm):
"""A form handling the constraints used to acquire a node."""
name = forms.CharField(label="Host name", required=False)
arch = forms.CharField(label="Architecture", required=False)
cpu_count = forms.FloatField(
label="CPU count", required=False,
error_messages={'invalid': "Invalid CPU count: number required."})
mem = forms.FloatField(
label="Memory", required=False,
error_messages={'invalid': "Invalid memory: number of MB required."})
tags = UnconstrainedMultipleChoiceField(label="Tags", required=False)
networks = ValidatorMultipleChoiceField(
validator=parse_network_spec, label="Attached to networks",
required=False, error_messages={
'invalid_list': "Invalid parameter: list of networks required.",
})
not_networks = ValidatorMultipleChoiceField(
validator=parse_network_spec, label="Not attached to networks",
required=False, error_messages={
'invalid_list': "Invalid parameter: list of networks required.",
})
connected_to = ValidatorMultipleChoiceField(
validator=mac_validator, label="Connected to", required=False,
error_messages={
'invalid_list':
"Invalid parameter: list of MAC addresses required."})
not_connected_to = ValidatorMultipleChoiceField(
validator=mac_validator, label="Not connected to", required=False,
error_messages={
'invalid_list':
"Invalid parameter: list of MAC addresses required."})
zone = forms.CharField(label="Physical zone", required=False)
not_in_zone = ValidatorMultipleChoiceField(
validator=ZONE_NAME_VALIDATOR, label="Not in zone", required=False,
error_messages={
'invalid_list': "Invalid parameter: must list physical zones.",
})
ignore_unknown_constraints = True
@classmethod
def Strict(cls, *args, **kwargs):
"""A stricter version of the form which rejects unknown parameters."""
form = cls(*args, **kwargs)
form.ignore_unknown_constraints = False
return form
def clean_arch(self):
# Import list_all_usable_architectures as part of its module, not
# directly, so that patch_usable_architectures can easily patch it
# for testing purposes.
usable_architectures = maasserver_forms.list_all_usable_architectures()
architecture_wildcards = get_architecture_wildcards(
usable_architectures)
value = self.cleaned_data[self.get_field_name('arch')]
if value:
if value in usable_architectures:
# Full 'arch/subarch' specified directly.
return [value]
elif value in architecture_wildcards:
# Try to expand 'arch' to all available 'arch/subarch'
# matches.
return architecture_wildcards[value]
raise ValidationError(
{self.get_field_name('arch'):
['Architecture not recognised.']})
return None
def clean_tags(self):
value = self.cleaned_data[self.get_field_name('tags')]
if value:
tag_names = parse_legacy_tags(value)
# Validate tags.
tag_names = set(tag_names)
db_tag_names = set(Tag.objects.filter(
name__in=tag_names).values_list('name', flat=True))
if len(tag_names) != len(db_tag_names):
unknown_tags = tag_names.difference(db_tag_names)
error_msg = 'No such tag(s): %s.' % ', '.join(
"'%s'" % tag for tag in unknown_tags)
raise ValidationError(
{self.get_field_name('arch'): [error_msg]})
return tag_names
return None
def clean_zone(self):
value = self.cleaned_data[self.get_field_name('zone')]
if value:
nonexistent_names = detect_nonexistent_zone_names([value])
if len(nonexistent_names) > 0:
error_msg = "No such zone: '%s'." % value
raise ValidationError(
{self.get_field_name('zone'): [error_msg]})
return value
return None
def clean_not_in_zone(self):
value = self.cleaned_data[self.get_field_name('not_in_zone')]
if value is None or len(value) == 0:
return None
nonexistent_names = detect_nonexistent_zone_names(value)
if len(nonexistent_names) > 0:
error_msg = "No such zone(s): %s." % ', '.join(nonexistent_names)
raise ValidationError(
{self.get_field_name('not_in_zone'): [error_msg]})
return value
def clean_networks(self):
value = self.cleaned_data[self.get_field_name('networks')]
if value is None:
return None
try:
return [Network.objects.get_from_spec(spec) for spec in value]
except Network.DoesNotExist as e:
raise ValidationError(e.message)
def clean_not_networks(self):
value = self.cleaned_data[self.get_field_name('not_networks')]
if value is None:
return None
try:
return [Network.objects.get_from_spec(spec) for spec in value]
except Network.DoesNotExist as e:
raise ValidationError(e.message)
def clean(self):
if not self.ignore_unknown_constraints:
unknown_constraints = set(
self.data).difference(set(self.field_mapping.values()))
for constraint in unknown_constraints:
msg = "No such constraint."
self._errors[constraint] = self.error_class([msg])
return super(AcquireNodeForm, self).clean()
def filter_nodes(self, nodes):
"""Return the subset of nodes that match the form's constraints.
:param nodes: The set of nodes on which the form should apply
constraints.
:type nodes: `django.db.models.query.QuerySet`
:return: A QuerySet of the nodes that match the form's constraints.
:rtype: `django.db.models.query.QuerySet`
"""
filtered_nodes = nodes
# Filter by hostname.
hostname = self.cleaned_data.get(self.get_field_name('name'))
if hostname:
clause = Q(hostname=hostname)
# If the given hostname has a domain part, try matching
# against the nodes' FQDNs as well (the FQDN is built using
# the nodegroup's name as the domain name).
if "." in hostname:
host, domain = hostname.split('.', 1)
hostname_clause = (
Q(hostname__startswith="%s." % host) |
Q(hostname=host)
)
domain_clause = Q(nodegroup__name=domain)
clause = clause | (hostname_clause & domain_clause)
filtered_nodes = filtered_nodes.filter(clause)
# Filter by architecture.
arch = self.cleaned_data.get(self.get_field_name('arch'))
if arch:
filtered_nodes = filtered_nodes.filter(architecture__in=arch)
# Filter by cpu_count.
cpu_count = self.cleaned_data.get(self.get_field_name('cpu_count'))
if cpu_count:
filtered_nodes = filtered_nodes.filter(cpu_count__gte=cpu_count)
# Filter by memory.
mem = self.cleaned_data.get(self.get_field_name('mem'))
if mem:
filtered_nodes = filtered_nodes.filter(memory__gte=mem)
# Filter by tags.
tags = self.cleaned_data.get(self.get_field_name('tags'))
if tags:
for tag in tags:
filtered_nodes = filtered_nodes.filter(tags__name=tag)
# Filter by zone.
zone = self.cleaned_data.get(self.get_field_name('zone'))
if zone:
zone_obj = Zone.objects.get(name=zone)
filtered_nodes = filtered_nodes.filter(zone=zone_obj)
# Filter by not_in_zone.
not_in_zone = self.cleaned_data.get(self.get_field_name('not_in_zone'))
if not_in_zone is not None and len(not_in_zone) > 0:
not_in_zones = Zone.objects.filter(name__in=not_in_zone)
filtered_nodes = filtered_nodes.exclude(zone__in=not_in_zones)
# Filter by networks.
networks = self.cleaned_data.get(self.get_field_name('networks'))
if networks is not None:
for network in set(networks):
filtered_nodes = filtered_nodes.filter(
macaddress__networks=network)
# Filter by not_networks.
not_networks = self.cleaned_data.get(
self.get_field_name('not_networks'))
if not_networks is not None:
for not_network in set(not_networks):
filtered_nodes = filtered_nodes.exclude(
macaddress__networks=not_network)
# Filter by connected_to.
connected_to = self.cleaned_data.get(
self.get_field_name('connected_to'))
if connected_to:
where, params = macs_contain(
"routers", connected_to)
filtered_nodes = filtered_nodes.extra(
where=[where], params=params)
# Filter by not_connected_to.
not_connected_to = self.cleaned_data.get(
self.get_field_name('not_connected_to'))
if not_connected_to:
where, params = macs_do_not_contain(
"routers", not_connected_to)
filtered_nodes = filtered_nodes.extra(
where=[where], params=params)
return filtered_nodes.distinct()
|