osdf/adapters/conductor/api_builder.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2015-2017 AT&T Intellectual Property
   3 #   Copyright (C) 2020 Wipro Limited.
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #
  17 # -------------------------------------------------------------------------
  18 #
  19
  20 from jinja2 import Template
  21 import json
  22
  23 import osdf.adapters.conductor.translation as tr
  24 from osdf.adapters.policy.utils import group_policies_gen
  25 from osdf.utils.programming_utils import list_flatten
  26
  27
  28 def _build_parameters(group_policies, service_info, request_parameters):
  29     """Function prepares parameters section for has request
  30
  31         :param group_policies: filtered policies
  32         :param service_info: service info
  33         :param request_parameters: request parameters
  34         :return:
  35         """
  36     initial_params = tr.get_opt_query_data(request_parameters,
  37                                            group_policies['onap.policies.optimization.service.QueryPolicy'])
  38     params = dict()
  39     params.update({"REQUIRED_MEM": initial_params.pop("requiredMemory", "")})
  40     params.update({"REQUIRED_DISK": initial_params.pop("requiredDisk", "")})
  41     params.update({"customer_lat": initial_params.pop("customerLatitude", 0.0)})
  42     params.update({"customer_long": initial_params.pop("customerLongitude", 0.0)})
  43     params.update({"service_name": service_info.get('serviceName', "")})
  44     params.update({"service_id": service_info.get('serviceInstanceId', "")})
  45
  46     for key, val in initial_params.items():
  47         if val and val != "":
  48             params.update({key: val})
  49     return params
  50
  51
  52 def conductor_api_builder(req_info, demands, request_parameters, service_info,
  53                           template_fields, flat_policies: list, local_config,
  54                           template="osdf/adapters/conductor/templates/conductor_interface.json"):
  55     """Build an OSDF southbound API call for HAS-Conductor/Placement optimization
  56
  57         :param req_info: parameter data received from a client
  58         :param demands: list of demands
  59         :param request_parameters: request parameters
  60         :param service_info: service info object
  61         :param template_fields: Fields that has to be passed to the template to render
  62         :param flat_policies: policy data received from the policy platform (flat policies)
  63         :param template: template to generate southbound API call to conductor
  64         :param local_config: local configuration file with pointers for
  65                the service specific information
  66         :return: json to be sent to Conductor/placement optimization
  67         """
  68
  69     templ = Template(open(template).read())
  70     gp = group_policies_gen(flat_policies, local_config)
  71     demand_name_list = []
  72     for demand in demands:
  73         demand_name_list.append(demand['resourceModuleName'].lower())
  74     demand_list = tr.gen_demands(demands, gp['onap.policies.optimization.resource.VnfPolicy'])
  75     attribute_policy_list = tr.gen_attribute_policy(
  76         demand_name_list, gp['onap.policies.optimization.resource.AttributePolicy'])
  77
  78     distance_to_location_policy_list = tr.gen_distance_to_location_policy(
  79         demand_name_list, gp['onap.policies.optimization.resource.DistancePolicy'])
  80     inventory_policy_list = tr.gen_inventory_group_policy(
  81         demand_name_list, gp['onap.policies.optimization.resource.InventoryGroupPolicy'])
  82     resource_instance_policy_list = tr.gen_resource_instance_policy(
  83         demand_name_list, gp['onap.policies.optimization.resource.ResourceInstancePolicy'])
  84     resource_region_policy_list = tr.gen_resource_region_policy(
  85         demand_name_list, gp['onap.policies.optimization.resource.ResourceRegionPolicy'])
  86     zone_policy_list = tr.gen_zone_policy(
  87         demand_name_list, gp['onap.policies.optimization.resource.AffinityPolicy'])
  88     optimization_policy_list = tr.gen_optimization_policy(
  89         demand_name_list, gp['onap.policies.optimization.resource.OptimizationPolicy'])
  90     reservation_policy_list = tr.gen_reservation_policy(
  91         demand_name_list, gp['onap.policies.optimization.resource.InstanceReservationPolicy'])
  92     capacity_policy_list = tr.gen_capacity_policy(
  93         demand_name_list, gp['onap.policies.optimization.resource.Vim_fit'])
  94     hpa_policy_list = tr.gen_hpa_policy(
  95         demand_name_list, gp['onap.policies.optimization.resource.HpaPolicy'])
  96     threshold_policy_list = tr.gen_threshold_policy(demand_name_list,
  97                                                     gp['onap.policies.optimization.resource.'
  98                                                        'ThresholdPolicy'])
  99     aggregation_policy_list = tr.gen_aggregation_policy(demand_name_list,
 100                                                         gp['onap.policies.optimization.resource.'
 101                                                            'AggregationPolicy'])
 102     req_params_dict = _build_parameters(gp, service_info, request_parameters)
 103     conductor_policies = [attribute_policy_list, distance_to_location_policy_list,
 104                           inventory_policy_list, resource_instance_policy_list,
 105                           resource_region_policy_list, zone_policy_list, reservation_policy_list,
 106                           capacity_policy_list, hpa_policy_list, threshold_policy_list, aggregation_policy_list]
 107     filtered_policies = [x for x in conductor_policies if len(x) > 0]
 108     policy_groups = list_flatten(filtered_policies)
 109     request_type = req_info.get('requestType', None)
 110     rendered_req = templ.render(
 111         requestType=request_type,
 112         demand_list=demand_list,
 113         policy_groups=policy_groups,
 114         optimization_policies=optimization_policy_list,
 115         name=req_info['requestId'],
 116         timeout=req_info['timeout'],
 117         limit=req_info['numSolutions'],
 118         request_params=req_params_dict,
 119         location_enabled=template_fields.get('location_enabled'),
 120         version=template_fields.get('version'),
 121         json=json)
 122     json_payload = json.dumps(json.loads(rendered_req))  # need this because template's JSON is ugly!
 123     return json_payload