Enforce black code format via pre-commit hook
[vvp/validation-scripts.git] / ice_validator / tests / utils / vm_types.py
1 # -*- coding: utf8 -*-
2 # ============LICENSE_START=======================================================
3 # org.onap.vvp/validation-scripts
4 # ===================================================================
5 # Copyright © 2019 AT&T Intellectual Property. All rights reserved.
6 # ===================================================================
7 #
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
12 #
13 #             http://www.apache.org/licenses/LICENSE-2.0
14 #
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.
20 #
21 #
22 #
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
27 #
28 #             https://creativecommons.org/licenses/by/4.0/
29 #
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.
35 #
36 # ============LICENSE_END============================================
37 #
38 #
39
40 import re
41 from tests import cached_yaml as yaml
42
43
44 def get_vm_types_for_resource(resource):
45     """
46     Get all unique vm_types for a resource
47     Notes:
48     - Returns set([]) if the resource is not formatted
49     properly, the passed resource is not a nova server
50     - If more than one vm_type is detected all vm_types will
51     be returned
52     """
53     if not isinstance(resource, dict):
54         return set()
55     if not is_nova_server(resource):
56         return set()
57
58     key_values = ["name", "flavor", "image"]
59     key_value_formats = [
60         ["name", "string", re.compile(r"(.+?)_name_\d+")],
61         ["name", "comma_delimited_list", re.compile(r"(.+?)_names")],
62         ["flavor", "string", re.compile(r"(.+?)_flavor_name")],
63         ["image", "string", re.compile(r"(.+?)_image_name")],
64     ]
65
66     vm_types = []
67     for k2, v2 in resource["properties"].items():
68         if k2 not in key_values:
69             continue
70         if "get_param" not in v2:
71             continue
72         formats = [v for v in key_value_formats if v[0] == k2]
73         for v3 in formats:
74             param = v2["get_param"]
75             if isinstance(param, list):
76                 param = param[0]
77             m = v3[2].match(param)
78             if m and m.group(1):
79                 vm_types.append(m.group(1))
80
81     return set(vm_types)
82
83
84 def is_nova_server(resource):
85
86     return (
87         "type" in resource
88         and "properties" in resource
89         and resource.get("type") == "OS::Nova::Server"
90     )
91
92
93 def get_vm_type_for_nova_server(resource):
94     """
95     Get the vm_type for a resource
96     Note: Returns None if not exactly one vm_type
97     is detected, if the resource is not formatted properly, or
98     the passed resource is not a nova server
99     """
100     vm_types = get_vm_types_for_resource(resource)
101
102     # if more than one vm_type was identified, return None
103     if len(vm_types) > 1:
104         return None
105
106     return vm_types.pop()
107
108
109 def get_vm_types(resources):
110     """
111     Get all vm_types for a list of heat resources, do note that
112     some of the values retrieved may be invalid
113     """
114     vm_types = []
115     for v in resources.values():
116         vm_types.extend(list(get_vm_types_for_resource(v)))
117
118     return set(vm_types)
119
120
121 def get_all_vm_types(yaml_files):
122     """
123     Get all vm_types for a list of yaml files
124     """
125     vm_types = []
126     for yaml_file in yaml_files:
127         with open(yaml_file, "r") as f:
128             yml = yaml.load(f)
129
130         if "resources" not in yml:
131             continue
132
133         vm_types.extend(get_vm_types(yml["resources"]))
134
135     return set(vm_types)