Merge "vnf_generic: convert sshmanager to class"
[yardstick.git] / yardstick / network_services / vnf_generic / vnfdgen.py
1 # Copyright (c) 2016-2017 Intel Corporation
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #      http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """ Generic file to map and build vnf discriptor """
15
16 from __future__ import absolute_import
17 import collections
18 import yaml
19
20 from yardstick.common.task_template import TaskTemplate
21
22
23 def generate_vnfd(vnf_model, node):
24     """
25
26     :param vnf_model: VNF definition template, e.g. tg_ping_tpl.yaml
27     :param node: node configuration taken from pod.yaml
28     :return: Complete VNF Descriptor that will be taken
29              as input for GenericVNF.__init__
30     """
31     node["get"] = get
32     rendered_vnfd = TaskTemplate.render(vnf_model, **node)
33     # This is done to get rid of issues with serializing node
34     del node["get"]
35     filled_vnfd = yaml.load(rendered_vnfd)
36     return filled_vnfd
37
38
39 def dict_key_flatten(data):
40     """ Convert nested dict structure to dotted key
41         (e.g. {"a":{"b":1}} -> {"a.b":1}
42
43     :param data: nested dictionary
44     :return: flat dicrionary
45     """
46     next_data = {}
47
48     # check for non-string iterables
49     if not any((isinstance(v, collections.Iterable) and not isinstance(v, str))
50                for v in data.values()):
51         return data
52
53     for key, val in data.items():
54         if isinstance(val, collections.Mapping):
55             for n_k, n_v in val.items():
56                 next_data["%s.%s" % (key, n_k)] = n_v
57         elif isinstance(val, collections.Iterable) and not isinstance(val,
58                                                                       str):
59             for index, item in enumerate(val):
60                 next_data["%s%d" % (key, index)] = item
61         else:
62             next_data[key] = val
63
64     return dict_key_flatten(next_data)
65
66
67 def get(obj, key, *args):
68     """ Get template key from dictionary, get default value or raise an exception
69     """
70     data = dict_key_flatten(obj)
71     return data.get(key, *args)