1 # -------------------------------------------------------------------------
2 # Copyright (c) 2015-2017 AT&T Intellectual Property
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # -------------------------------------------------------------------------
21 # from osdf.utils import data_mapping
22 from jinja2 import Template
23 from osdf.utils.programming_utils import list_flatten, dot_notation
24 import osdf.optimizers.placementopt.conductor.translation as tr
25 from osdf.adapters.policy.utils import group_policies
28 def conductor_api_builder(request_json, flat_policies: list, local_config, prov_status,
29 template="templates/conductor_interface.json"):
30 """Build a SNIRO southbound API call for Conductor/Placement optimization
31 :param request_json: parameter data received from a client
32 :param flat_policies: policy data received from the policy platform (flat policies)
33 :param template: template to generate southbound API call to conductor
34 :param local_config: local configuration file with pointers for the service specific information
35 :param prov_status: provStatus retrieved from Subscriber policy
36 :return: json to be sent to Conductor/placement optimization
38 templ = Template(open(template).read())
39 gp = group_policies(flat_policies)
40 demand_vnf_name_list = []
42 for placementDemand in request_json['placementInfo']['demandInfo']['placementDemand']:
43 demand_vnf_name_list.append(placementDemand['resourceModuleName'])
45 demand_list = tr.gen_demands(request_json['placementInfo']['demandInfo'], gp['vnfPolicy'])
46 attribute_policy_list = tr.gen_attribute_policy(demand_vnf_name_list, gp['attribute'])
47 distance_to_location_policy_list = tr.gen_distance_to_location_policy(
48 demand_vnf_name_list, gp['distance_to_location'])
49 inventory_policy_list = tr.gen_inventory_group_policy(demand_vnf_name_list, gp['inventory_group'])
50 resource_instance_policy_list = tr.gen_resource_instance_policy(
51 demand_vnf_name_list, gp['instance_fit'])
52 resource_region_policy_list = tr.gen_resource_region_policy(demand_vnf_name_list, gp['region_fit'])
53 zone_policy_list = tr.gen_zone_policy(demand_vnf_name_list, gp['zone'])
54 optimization_policy_list = tr.gen_optimization_policy(demand_vnf_name_list, gp['placementOptimization'])
55 reservation_policy_list = tr.gen_reservation_policy(demand_vnf_name_list, gp['instance_reservation'])
56 conductor_policies = [attribute_policy_list, distance_to_location_policy_list, inventory_policy_list,
57 resource_instance_policy_list, resource_region_policy_list, zone_policy_list]
58 filtered_policies = [x for x in conductor_policies if len(x) > 0]
59 policy_groups = list_flatten(filtered_policies)
60 reservation_policies = [x for x in reservation_policy_list if len(x) > 0]
61 reservation_groups = list_flatten(reservation_policies)
62 req_info = request_json['requestInfo']
63 model_name = request_json['placementInfo']['serviceModelInfo']['modelName']
64 service_type = model_name
65 # service_type = data_mapping.get_service_type(model_name)
66 service_info = local_config.get('service_info', {}).get(service_type, {})
68 if 'orderInfo' in request_json["placementInfo"]:
69 order_info = json.loads(request_json["placementInfo"]["orderInfo"])
70 request_type = req_info.get('requestType', None)
72 if 'subscriberInfo' in request_json['placementInfo']:
73 subs_com_site_id = request_json['placementInfo']['subscriberInfo'].get('subscriberCommonSiteId', "")
74 if service_type == 'vCPE':
75 # data_mapping.normalize_user_params(order_info)
76 rendered_req = templ.render(
77 requestType=request_type,
78 chosenComplex=subs_com_site_id,
79 demand_list=demand_list,
80 policy_groups=policy_groups,
81 optimization_policies=optimization_policy_list,
82 name=req_info['requestId'],
83 timeout=req_info['timeout'],
84 limit=req_info['numSolutions'],
85 serviceType=service_type,
86 serviceInstance=request_json['placementInfo']['serviceInstanceId'],
87 provStatus = prov_status,
88 chosenRegion=order_info.get('requestParameters',{}).get('lcpCloudRegionId'),
90 elif service_type == 'UNKNOWN':
91 rendered_req = templ.render(
92 requestType=request_type,
93 chosenComplex=subs_com_site_id,
94 demand_list=demand_list,
95 policy_groups=policy_groups,
96 reservation_groups=reservation_groups,
97 optimization_policies=optimization_policy_list,
98 name=req_info['requestId'],
99 timeout=req_info['timeout'],
100 limit=req_info['numSolutions'],
101 serviceType=service_type,
102 serviceInstance=request_json['placementInfo']['serviceInstanceId'],
103 provStatus = prov_status,
105 bandwidth=dot_notation(order_info, service_info['bandwidth']),
106 bandwidth_unit=dot_notation(order_info, service_info['bandwidth_units']),
108 json_payload = json.dumps(json.loads(rendered_req)) # need this because template's JSON is ugly!
112 def retrieve_node(req_json, reference):
114 Get the child node(s) from the dot-notation [reference] and parent [req_json].
115 For placement and other requests, there are encoded JSONs inside the request or policy,
116 so we need to expand it and then do a search over the parent plus expanded JSON.
118 req_json_copy = copy.deepcopy(req_json) # since we expand the JSON in place, we work on a copy
119 if 'orderInfo' in req_json_copy['placementInfo']:
120 req_json_copy['placementInfo']['orderInfo'] = json.loads(req_json_copy['placementInfo']['orderInfo'])
121 info = dot_notation(req_json_copy, reference)
122 return list_flatten(info) if isinstance(info, list) else info