2 # ============LICENSE_START====================================================
3 # org.onap.vvp/validation-scripts
4 # ===================================================================
5 # Copyright © 2019 AT&T Intellectual Property. All rights reserved.
6 # ===================================================================
8 # Unless otherwise specified, all software contained herein is licensed
9 # under the Apache License, Version 2.0 (the "License");
10 # you may not use this software except in compliance with the License.
11 # You may obtain a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
23 # Unless otherwise specified, all documentation contained herein is licensed
24 # under the Creative Commons License, Attribution 4.0 Intl. (the "License");
25 # you may not use this documentation except in compliance with the License.
26 # You may obtain a copy of the License at
28 # https://creativecommons.org/licenses/by/4.0/
30 # Unless required by applicable law or agreed to in writing, documentation
31 # distributed under the License is distributed on an "AS IS" BASIS,
32 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33 # See the License for the specific language governing permissions and
34 # limitations under the License.
36 # ============LICENSE_END============================================
47 from tests import cached_yaml as yaml
48 from tests.helpers import load_yaml, get_param
49 from .utils import nested_dict
53 # key = pattern, value = regex compiled from pattern
57 def _get_regex(pattern):
58 """Return a compiled version of pattern.
59 Keep result in _REGEX_CACHE to avoid re-compiling.
61 regex = _REGEX_CACHE.get(pattern, None)
63 regex = re.compile(pattern)
64 _REGEX_CACHE[pattern] = regex
68 class Hashabledict(dict):
70 dicts with the same keys and whose keys have the same values
71 are assigned the same hash.
75 return hash((frozenset(self), frozenset(self.values())))
78 class HeatProcessor(object):
79 """base class for xxxx::xxxx::xxxx processors
82 resource_type = None # string 'xxxx::xxxx::xxxx'
83 re_rids = collections.OrderedDict() # OrderedDict of name: regex
84 # name is a string to name the regex.
85 # regex parses the proper resource id format.
88 def get_param_value(value, withIndex=False):
89 """Return get_param value of `value`
91 if isinstance(value, dict) and len(value) == 1:
92 v = value.get("get_param")
93 if isinstance(v, list) and v:
94 if withIndex and len(v) > 1:
96 if isinstance(idx, dict):
97 idx = idx.get("get_param", idx)
98 v = "{}{}".format(v[0], idx)
106 def get_resource_or_param_value(cls, value):
107 """Return the get_resource or get_param value of `value`
109 if isinstance(value, dict) and len(value) == 1:
110 v = value.get("get_resource") or cls.get_param_value(value)
116 def get_rid_match_tuple(cls, rid):
117 """find the first regex matching `rid` and return the tuple
118 (name, match object) or ('', None) if no match.
120 rid = "" if rid is None else rid
121 for name, regex in cls.re_rids.items():
122 match = regex.match(rid)
128 def get_rid_patterns(cls):
129 """Return OrderedDict of name: friendly regex.pattern
130 "friendly" means the group notation is replaced with
131 braces, and the trailing "$" is removed.
134 nested parentheses in any rid_pattern will break this parser.
135 The final character is ASSUMED to be a dollar sign.
137 friendly_pattern = _get_regex(r"\(\?P<(.*?)>.*?\)")
138 rid_patterns = collections.OrderedDict()
139 for name, regex in cls.re_rids.items():
140 rid_patterns[name] = friendly_pattern.sub(
141 r"{\1}", regex.pattern # replace groups with braces
144 ] # remove trailing $
148 def get_str_replace_name(cls, resource_dict):
149 """Return the name modified by str_replace of `resource_dict`,
150 a resource (i.e. a value in some template's resources).
151 Return None, if there is no name, str_replace, its template,
152 or any missing parameters.
154 str_replace = Heat.nested_get(
155 resource_dict, "properties", "name", "str_replace"
159 template = Heat.nested_get(str_replace, "template")
160 if not isinstance(template, str):
162 params = Heat.nested_get(str_replace, "params", default={})
163 if not isinstance(params, dict):
166 # The user must choose non-overlapping keys for params since they
167 # are replaced in the template in arbitrary order.
169 for key, value in params.items():
170 param = cls.get_param_value(value, withIndex=True)
173 name = name.replace(key, str(param))
177 class CinderVolumeAttachmentProcessor(HeatProcessor):
178 """ Cinder VolumeAttachment
181 resource_type = "OS::Cinder::VolumeAttachment"
184 def get_config(cls, resources):
185 """Return a tuple (va_config, va_count)
186 va_config - Hashabledict of Cinder Volume Attachment config
188 va_count - dict of attachment counts indexed by rid.
190 va_count = collections.defaultdict(int)
191 va_config = Hashabledict()
192 for resource in resources.values():
193 resource_type = nested_dict.get(resource, "type")
194 if resource_type == cls.resource_type:
195 config, rids = cls.get_volume_attachment_config(resource)
197 va_config[rid] = config
199 return va_config, va_count
202 def get_volume_attachment_config(cls, resource):
203 """Returns the cinder volume attachment configuration
204 of `resource` as a tuple (config, rids)
206 - config is a Hashabledict whose keys are the keys of the
207 properties of resource, and whose values are the
208 corresponding property values (nova server resource ids)
209 replaced with the vm-type they reference.
210 - rids is the set of nova server resource ids referenced by
213 config = Hashabledict()
215 for key, value in (resource.get("properties") or {}).items():
216 rid = cls.get_resource_or_param_value(value)
218 name, match = NovaServerProcessor.get_rid_match_tuple(rid)
220 vm_type = match.groupdict()["vm_type"]
221 config[key] = vm_type
226 class ContrailV2NetworkFlavorBaseProcessor(HeatProcessor):
227 """ContrailV2 objects which have network_flavor
230 network_flavor_external = "external"
231 network_flavor_internal = "internal"
232 network_flavor_subint = "subinterface"
235 def get_network_flavor(cls, resource):
236 """Return the network flavor of resource, one of
237 "internal" - get_resource, or get_param contains _int_
238 "subint" - get_param contains _subint_
239 "external" - otherwise
240 None - no parameters found to decide the flavor.
242 resource.properties.virtual_network_refs should be a list.
243 All the parameters in the list should have the same "flavor"
244 so the flavor is determined from the first item.
246 network_flavor = None
247 network_refs = nested_dict.get(resource, "properties", "virtual_network_refs")
248 if network_refs and isinstance(network_refs, list):
249 param = network_refs[0]
250 if isinstance(param, dict):
251 if "get_resource" in param:
252 network_flavor = cls.network_flavor_internal
254 p = param.get("get_param")
255 network_flavor = cls.get_network_format(p)
256 return network_flavor
259 def get_network_format(cls, param):
260 if isinstance(param, str):
261 if "_int_" in param or param.startswith("int_"):
262 return cls.network_flavor_internal
263 elif "_subint_" in param:
264 return cls.network_flavor_subint
266 return cls.network_flavor_external
269 class ContrailV2InstanceIpProcessor(ContrailV2NetworkFlavorBaseProcessor):
270 """ ContrailV2 InstanceIp
273 resource_type = "OS::ContrailV2::InstanceIp"
274 re_rids = collections.OrderedDict(
280 r"_(?P<vm_type_index>\d+)"
282 r"_(?P<network_role>.+)"
284 r"_(?P<vmi_index>\d+)"
295 r"_(?P<vm_type_index>\d+)"
297 r"_(?P<network_role>.+)"
299 r"_(?P<vmi_index>\d+)"
310 r"_(?P<vm_type_index>\d+)"
311 r"_(?P<network_role>.+)"
313 r"_(?P<vmi_index>\d+)"
324 class ContrailV2InterfaceRouteTableProcessor(HeatProcessor):
325 """ ContrailV2 InterfaceRouteTable
328 resource_type = "OS::ContrailV2::InterfaceRouteTable"
331 class ContrailV2NetworkIpamProcessor(HeatProcessor):
332 """ ContrailV2 NetworkIpam
335 resource_type = "OS::ContrailV2::NetworkIpam"
338 class ContrailV2PortTupleProcessor(HeatProcessor):
339 """ ContrailV2 PortTuple
342 resource_type = "OS::ContrailV2::PortTuple"
345 class ContrailV2ServiceHealthCheckProcessor(HeatProcessor):
346 """ ContrailV2 ServiceHealthCheck
349 resource_type = "OS::ContrailV2::ServiceHealthCheck"
352 class ContrailV2ServiceInstanceProcessor(HeatProcessor):
353 """ ContrailV2 ServiceInstance
356 resource_type = "OS::ContrailV2::ServiceInstance"
359 class ContrailV2ServiceInstanceIpProcessor(HeatProcessor):
360 """ ContrailV2 ServiceInstanceIp
363 resource_type = "OS::ContrailV2::ServiceInstanceIp"
366 class ContrailV2ServiceTemplateProcessor(HeatProcessor):
367 """ ContrailV2 ServiceTemplate
370 resource_type = "OS::ContrailV2::ServiceTemplate"
373 class ContrailV2VirtualMachineInterfaceProcessor(ContrailV2NetworkFlavorBaseProcessor):
374 """ ContrailV2 Virtual Machine Interface resource
377 resource_type = "OS::ContrailV2::VirtualMachineInterface"
378 re_rids = collections.OrderedDict(
384 r"_(?P<vm_type_index>\d+)"
386 r"_(?P<network_role>.+)"
388 r"_(?P<vmi_index>\d+)"
396 r"_(?P<vm_type_index>\d+)"
398 r"_(?P<network_role>.+)"
400 r"_(?P<vmi_index>\d+)"
408 r"_(?P<vm_type_index>\d+)"
409 r"_(?P<network_role>.+)"
411 r"_(?P<vmi_index>\d+)"
419 class ContrailV2VirtualNetworkProcessor(HeatProcessor):
420 """ ContrailV2 VirtualNetwork
423 resource_type = "OS::ContrailV2::VirtualNetwork"
424 re_rids = collections.OrderedDict(
426 ("network", _get_regex(r"int" r"_(?P<network_role>.+)" r"_network" r"$")),
427 # ("rvn", _get_regex(r"int" r"_(?P<network_role>.+)" r"_RVN" r"$")),
432 class HeatResourceGroupProcessor(HeatProcessor):
433 """ Heat ResourceGroup
436 resource_type = "OS::Heat::ResourceGroup"
437 re_rids = collections.OrderedDict(
443 r"_(?P<vm_type_index>\d+)"
445 r"_(?P<network_role>.+)"
446 r"_port_(?P<port_index>\d+)"
455 class NeutronNetProcessor(HeatProcessor):
456 """ Neutron Net resource
459 resource_type = "OS::Neutron::Net"
460 re_rids = collections.OrderedDict(
461 [("network", _get_regex(r"int" r"_(?P<network_role>.+)" r"_network" r"$"))]
465 class NeutronPortProcessor(HeatProcessor):
466 """ Neutron Port resource
469 resource_type = "OS::Neutron::Port"
470 re_rids = collections.OrderedDict(
476 r"_(?P<vm_type_index>\d+)"
478 r"_(?P<network_role>.+)"
479 r"_port_(?P<port_index>\d+)"
487 r"_(?P<vm_type_index>\d+)"
488 r"_(?P<network_role>.+)"
489 r"_port_(?P<port_index>\d+)"
497 def uses_sr_iov(cls, resource):
498 """Returns True/False as `resource` is/not
499 An OS::Nova:Port with the property binding:vnic_type
501 resource_properties = nested_dict.get(resource, "properties", default={})
503 nested_dict.get(resource, "type") == cls.resource_type
504 and resource_properties.get("binding:vnic_type", "") == "direct"
511 class NovaServerProcessor(HeatProcessor):
512 """ Nova Server resource
515 resource_type = "OS::Nova::Server"
516 re_rids = collections.OrderedDict(
520 _get_regex(r"(?P<vm_type>.+)" r"_server_(?P<vm_type_index>\d+)" r"$"),
526 def get_flavor(cls, resource):
527 """Return the flavor property of `resource`
529 return cls.get_param_value(nested_dict.get(resource, "properties", "flavor"))
532 def get_image(cls, resource):
533 """Return the image property of `resource`
535 return cls.get_param_value(nested_dict.get(resource, "properties", "image"))
538 def get_network(cls, resource):
539 """Return the network configuration of `resource` as a
540 frozenset of network-roles.
543 networks = nested_dict.get(resource, "properties", "networks")
544 if isinstance(networks, list):
545 for port in networks:
546 value = cls.get_resource_or_param_value(nested_dict.get(port, "port"))
547 name, match = NeutronPortProcessor.get_rid_match_tuple(value)
549 network_role = match.groupdict().get("network_role")
551 network.add(network_role)
552 return frozenset(network)
555 def get_vm_class(cls, resource):
556 """Return the vm_class of `resource`, a Hashabledict (of
557 hashable values) whose keys are only the required keys.
558 Return empty Hashabledict if `resource` is not a NovaServer.
560 vm_class = Hashabledict()
561 resource_type = nested_dict.get(resource, "type")
562 if resource_type == cls.resource_type:
564 flavor=cls.get_flavor(resource),
565 image=cls.get_image(resource),
566 networks=cls.get_network(resource),
575 filepath - absolute path to template file.
576 envpath - absolute path to environmnt file.
579 type_bool = "boolean"
580 type_boolean = "boolean"
581 type_cdl = "comma_delimited_list"
582 type_comma_delimited_list = "comma_delimited_list"
585 type_number = "number"
587 type_string = "string"
589 def __init__(self, filepath=None, envpath=None):
594 self.heat_template_version = None
595 self.description = None
596 self.parameter_groups = None
597 self.parameters = None
598 self.resources = None
600 self.conditions = None
605 self.load_env(envpath)
606 self.heat_processors = self.get_heat_processors()
609 def contrail_resources(self):
610 """This attribute is a dict of Contrail resources.
612 return self.get_resource_by_type(
613 resource_type=ContrailV2VirtualMachineInterfaceProcessor.resource_type
616 def get_all_resources(self, base_dir=None, count=1):
618 Like ``resources``, but this returns all the resources definitions
619 defined in the template, resource groups, and nested YAML files.
621 A special variable will be added to all resource properties (__count__).
622 This will normally be 1, but if the resource is generated by a
623 ResourceGroup **and** an env file is present, then the count will be
624 the value from the env file (assuming this follows standard VNF Heat
627 base_dir = base_dir or self.dirname
629 for r_id, r_data in self.resources.items():
630 r_data["__count__"] = count
631 resources[r_id] = r_data
632 resource = Resource(r_id, r_data)
633 if resource.is_nested():
634 nested_count = resource.get_count(self.env)
635 nested = Heat(os.path.join(base_dir, resource.get_nested_filename()))
636 nested_resources = nested.get_all_resources(count=nested_count)
637 resources.update(nested_resources)
641 def get_heat_processors():
642 """Return a dict, key is resource_type, value is the
643 HeatProcessor subclass whose resource_type is the key.
645 return _HEAT_PROCESSORS
647 def get_resource_by_type(self, resource_type, all_resources=False):
648 """Return dict of resources whose type is `resource_type`.
649 key is resource_id, value is resource.
651 resources = self.get_all_resources() if all_resources else self.resources
654 for rid, resource in resources.items()
655 if self.nested_get(resource, "type") == resource_type
658 def get_rid_match_tuple(self, rid, resource_type):
659 """return get_rid_match_tuple(rid) called on the class
660 corresponding to the given resource_type.
662 processor = self.heat_processors.get(resource_type, HeatProcessor)
663 return processor.get_rid_match_tuple(rid)
665 def get_vm_type(self, rid, resource=None):
666 """return the vm_type
670 resource_type = self.nested_get(resource, "type")
671 match = self.get_rid_match_tuple(rid, resource_type)[1]
672 vm_type = match.groupdict().get("vm_type") if match else None
675 def load(self, filepath):
676 """Load the Heat template given a filepath.
678 self.filepath = filepath
679 self.basename = os.path.basename(self.filepath)
680 self.dirname = os.path.dirname(self.filepath)
681 with open(self.filepath) as fi:
682 self.yml = yaml.load(fi)
683 self.heat_template_version = self.yml.get("heat_template_version", None)
684 self.description = self.yml.get("description", "")
685 self.parameter_groups = self.yml.get("parameter_groups") or {}
686 self.parameters = self.yml.get("parameters") or {}
687 self.resources = self.yml.get("resources") or {}
688 self.outputs = self.yml.get("outputs") or {}
689 self.conditions = self.yml.get("conditions") or {}
691 def load_env(self, envpath):
692 """Load the Environment template given a envpath.
694 self.env = Env(filepath=envpath)
697 def nested_get(dic, *keys, **kwargs):
698 """make utils.nested_dict.get available as a class method.
700 return nested_dict.get(dic, *keys, **kwargs)
703 def neutron_port_resources(self):
704 """This attribute is a dict of Neutron Ports
706 return self.get_resource_by_type(
707 resource_type=NeutronPortProcessor.resource_type
711 def nova_server_resources(self):
712 """This attribute is a dict of Nova Servers
714 return self.get_resource_by_type(
715 resource_type=NovaServerProcessor.resource_type
719 def part_is_in_name(part, name):
721 Return True if any of
722 - name starts with part + '_'
723 - name contains '_' + part + '_'
724 - name ends with '_' + part
728 re.search("(^(%(x)s)_)|(_(%(x)s)_)|(_(%(x)s)$)" % dict(x=part), name)
733 """An Environment file
739 class Resource(object):
743 def __init__(self, resource_id=None, resource=None):
744 self.resource_id = resource_id or ""
745 self.resource = resource or {}
746 self.properties = self.resource.get("properties", {})
747 self.resource_type = self.resource.get("type", "")
750 def get_index_var(resource):
751 """Return the index_var for this resource.
753 index_var = nested_dict.get(resource, "properties", "index_var") or "index"
756 def get_nested_filename(self):
757 """Returns the filename of the nested YAML file if the
758 resource is a nested YAML or ResourceDef, returns '' otherwise."""
759 typ = self.resource.get("type", "")
760 if typ == "OS::Heat::ResourceGroup":
761 rd = nested_dict.get(self.resource, "properties", "resource_def")
762 typ = rd.get("type", "") if rd else ""
763 ext = os.path.splitext(typ)[1]
765 if ext == ".yml" or ext == ".yaml":
770 def get_nested_properties(self):
772 Returns {} if not nested
773 Returns resource: properties if nested
774 Returns resource: properties: resource_def: properties if RG
776 if not bool(self.get_nested_filename()):
778 elif self.resource_type == "OS::Heat::ResourceGroup":
779 return nested_dict.get(
780 self.properties, "resource_def", "properties", default={}
783 return self.properties
785 def get_count(self, env):
786 if self.resource_type == "OS::Heat::ResourceGroup":
789 env_params = env.parameters
790 count_param = get_param(self.properties["count"])
791 count_value = env_params.get(count_param) if count_param else 1
793 return int(count_value)
794 except (ValueError, TypeError):
797 "WARNING: Invalid value for count parameter {}. Expected "
798 "an integer, but got {}. Defaulting to 1"
799 ).format(count_param, count_value)
804 def depends_on(self):
806 Returns the list of resources this resource depends on. Always
809 :return: list of all resource IDs this resource depends on. If none,
810 then returns an empty list
812 parents = self.resource.get("depends_on", [])
813 return parents if isinstance(parents, list) else [parents]
816 """Returns True if the resource represents a Nested YAML resource
817 using either type: {filename} or ResourceGroup -> resource_def"""
818 return bool(self.get_nested_filename())
820 def get_nested_yaml(self, base_dir):
821 """If the resource represents a Nested YAML resource, then it
822 returns the loaded YAML. If the resource is not nested or the
823 file cannot be found, then an empty dict is returned"""
824 filename = self.get_nested_filename()
826 file_path = os.path.join(base_dir, filename)
827 return load_yaml(file_path) if os.path.exists(file_path) else {}
832 def get_all_resources(yaml_files):
833 """Return a dict, resource id: resource
834 of the union of resources across all files.
837 for heat_template in yaml_files:
838 heat = Heat(filepath=heat_template)
839 dirname = os.path.dirname(heat_template)
840 resources.update(heat.get_all_resources(dirname))
844 def _get_heat_processors():
845 """Introspect this module and return a
846 dict of all HeatProcessor sub-classes with a (True) resource_type.
847 Key is the resource_type, value is the corrresponding class.
849 mod_classes = inspect.getmembers(sys.modules[__name__], inspect.isclass)
852 for _, c in mod_classes
853 if issubclass(c, HeatProcessor) and c.resource_type
855 return heat_processors
858 _HEAT_PROCESSORS = _get_heat_processors()