gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.client.adapter.network.mapper;
  22
  23 import java.io.UnsupportedEncodingException;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Optional;
  28 import java.util.UUID;
  29
  30 import org.modelmapper.ModelMapper;
  31 import org.modelmapper.PropertyMap;
  32 import org.onap.so.adapters.nwrest.ContrailNetwork;
  33 import org.onap.so.adapters.nwrest.CreateNetworkRequest;
  34 import org.onap.so.adapters.nwrest.CreateNetworkResponse;
  35 import org.onap.so.adapters.nwrest.DeleteNetworkRequest;
  36 import org.onap.so.adapters.nwrest.NetworkTechnology;
  37 import org.onap.so.adapters.nwrest.ProviderVlanNetwork;
  38 import org.onap.so.adapters.nwrest.RollbackNetworkRequest;
  39 import org.onap.so.adapters.nwrest.UpdateNetworkRequest;
  40 import org.onap.so.bpmn.core.UrnPropertiesReader;
  41 import org.onap.so.bpmn.servicedecomposition.bbobjects.CloudRegion;
  42 import org.onap.so.bpmn.servicedecomposition.bbobjects.Customer;
  43 import org.onap.so.bpmn.servicedecomposition.bbobjects.L3Network;
  44 import org.onap.so.bpmn.servicedecomposition.bbobjects.NetworkPolicy;
  45 import org.onap.so.bpmn.servicedecomposition.bbobjects.RouteTableReference;
  46 import org.onap.so.bpmn.servicedecomposition.bbobjects.ServiceInstance;
  47 import org.onap.so.bpmn.servicedecomposition.bbobjects.VpnBinding;
  48 import org.onap.so.bpmn.servicedecomposition.generalobjects.OrchestrationContext;
  49 import org.onap.so.bpmn.servicedecomposition.generalobjects.RequestContext;
  50 import org.onap.so.bpmn.servicedecomposition.modelinfo.ModelInfoNetwork;
  51 import org.onap.so.entity.MsoRequest;
  52 import org.onap.so.logger.MsoLogger;
  53 import org.onap.so.openstack.beans.NetworkRollback;
  54 import org.onap.so.openstack.beans.RouteTarget;
  55 import org.onap.so.openstack.beans.Subnet;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58 import org.springframework.stereotype.Component;
  59 import org.springframework.web.util.UriUtils;
  60
  61 @Component
  62 public class NetworkAdapterObjectMapper {
  63         private static final ModelMapper modelMapper = new ModelMapper();
  64         private static String FORWARD_SLASH = "/";
  65         private static final Logger logger = LoggerFactory.getLogger(NetworkAdapterObjectMapper.class);
  66
  67         public CreateNetworkRequest createNetworkRequestMapper(RequestContext requestContext, CloudRegion cloudRegion, OrchestrationContext orchestrationContext, ServiceInstance serviceInstance, L3Network l3Network, Map<String, String> userInput, String cloudRegionPo, Customer customer) throws UnsupportedEncodingException {
  68                 CreateNetworkRequest createNetworkRequest = new CreateNetworkRequest();
  69
  70                 //set cloudSiteId as determined for cloud region PO instead of cloudRegion.getLcpCloudRegionId()
  71                 createNetworkRequest.setCloudSiteId(cloudRegionPo);
  72                 createNetworkRequest.setTenantId(cloudRegion.getTenantId());
  73                 createNetworkRequest.setNetworkId(l3Network.getNetworkId());
  74                 createNetworkRequest.setNetworkName(l3Network.getNetworkName());
  75                 //TODO fields not available
  76                 createNetworkRequest.setNetworkType(l3Network.getNetworkType());
  77                 //createNetworkRequest.setNetworkTypeVersion(serviceInstance.getModelInfoServiceInstance().getModelVersion());
  78                 ModelInfoNetwork modelInfoNetwork  = l3Network.getModelInfoNetwork();
  79                 if (modelInfoNetwork != null){
  80                         createNetworkRequest.setModelCustomizationUuid(modelInfoNetwork.getModelCustomizationUUID());
  81                 }
  82
  83                 //build and set Subnet list
  84                 createNetworkRequest.setSubnets(buildOpenstackSubnetList(l3Network));
  85
  86                 //build and set provider Vlan Network
  87                 ProviderVlanNetwork providerVlanNetwork = buildProviderVlanNetwork(l3Network);
  88                 createNetworkRequest.setProviderVlanNetwork(providerVlanNetwork);
  89                 String networkTechnology = l3Network.getModelInfoNetwork().getNetworkTechnology();
  90                 if(networkTechnology == null) {
  91                         networkTechnology = l3Network.getNetworkTechnology();
  92                         logger.warn("NetworkTechnology was null in CatalogDB. Using field from AAI: " + networkTechnology);
  93                 }
  94                 createNetworkRequest.setNetworkTechnology(setNetworkTechnology(networkTechnology));
  95
  96                 //build and set Contrail Network
  97                 ContrailNetwork contrailNetwork = buildContrailNetwork(l3Network, customer);
  98                 createNetworkRequest.setContrailNetwork(contrailNetwork);
  99
 100                 //set Network Parameters from VID request
 101                 createNetworkRequest.setNetworkParams(userInput);
 102
 103                 createNetworkRequest = setFlowFlags(createNetworkRequest, orchestrationContext);
 104
 105                 createNetworkRequest.setMsoRequest(createMsoRequest(requestContext, serviceInstance));
 106
 107                 String messageId = getRandomUuid();
 108                 createNetworkRequest.setMessageId(messageId);
 109                 //TODO clarify callback URL build process
 110                 //createNetworkRequest.setNotificationUrl(createCallbackUrl("NetworkAResponse", messageId));
 111
 112                 return createNetworkRequest;
 113         }
 114
 115         protected NetworkTechnology setNetworkTechnology(String networkTechnology) {
 116                 if(networkTechnology.equalsIgnoreCase("Contrail")) {
 117                         return NetworkTechnology.CONTRAIL;
 118                 } else if(networkTechnology.equalsIgnoreCase("Neutron")){
 119                         return NetworkTechnology.NEUTRON;
 120                 } else {
 121                         return NetworkTechnology.VMWARE;
 122                 }
 123         }
 124
 125         public DeleteNetworkRequest deleteNetworkRequestMapper(RequestContext requestContext, CloudRegion cloudRegion, ServiceInstance serviceInstance, L3Network l3Network) throws UnsupportedEncodingException {
 126                 DeleteNetworkRequest deleteNetworkRequest = new DeleteNetworkRequest();
 127
 128                 deleteNetworkRequest.setCloudSiteId(cloudRegion.getLcpCloudRegionId());
 129
 130                 String messageId = getRandomUuid();
 131                 deleteNetworkRequest.setMessageId(messageId);
 132
 133                 ModelInfoNetwork modelInfoNetwork  = l3Network.getModelInfoNetwork();
 134                 if (modelInfoNetwork != null){
 135                         deleteNetworkRequest.setModelCustomizationUuid(modelInfoNetwork.getModelCustomizationUUID());
 136                 }
 137
 138                 deleteNetworkRequest.setMsoRequest(createMsoRequest(requestContext, serviceInstance));
 139                 deleteNetworkRequest.setNetworkId(l3Network.getNetworkId());
 140                 deleteNetworkRequest.setNetworkStackId(l3Network.getHeatStackId());
 141                 deleteNetworkRequest.setNetworkType(l3Network.getNetworkType());
 142                 deleteNetworkRequest.setSkipAAI(true);
 143                 deleteNetworkRequest.setTenantId(cloudRegion.getTenantId());
 144
 145                 return deleteNetworkRequest;
 146         }
 147
 148         /**
 149          * Access method to build Rollback Network Request
 150          * @return
 151          * @throws UnsupportedEncodingException
 152          */
 153         public RollbackNetworkRequest createNetworkRollbackRequestMapper(RequestContext requestContext, CloudRegion cloudRegion, OrchestrationContext orchestrationContext, ServiceInstance serviceInstance, L3Network l3Network, Map<String, String> userInput, String cloudRegionPo, CreateNetworkResponse createNetworkResponse) throws UnsupportedEncodingException {
 154                 RollbackNetworkRequest rollbackNetworkRequest = new RollbackNetworkRequest();
 155
 156                 rollbackNetworkRequest = setCommonRollbackRequestFields(rollbackNetworkRequest, requestContext);
 157
 158                 NetworkRollback networkRollback = buildNetworkRollback(l3Network, cloudRegion, cloudRegionPo, createNetworkResponse);
 159                 rollbackNetworkRequest.setNetworkRollback(networkRollback);
 160
 161                 return rollbackNetworkRequest;
 162         }
 163
 164         public UpdateNetworkRequest createNetworkUpdateRequestMapper(RequestContext requestContext, CloudRegion cloudRegion, OrchestrationContext orchestrationContext, ServiceInstance serviceInstance, L3Network l3Network, Map<String, String> userInput, Customer customer) throws UnsupportedEncodingException {
 165                 UpdateNetworkRequest updateNetworkRequest = new UpdateNetworkRequest();
 166
 167                 updateNetworkRequest.setCloudSiteId(cloudRegion.getLcpCloudRegionId());
 168                 updateNetworkRequest.setTenantId(cloudRegion.getTenantId());
 169                 updateNetworkRequest.setNetworkId(l3Network.getNetworkId());
 170                 updateNetworkRequest.setNetworkStackId(l3Network.getHeatStackId());
 171                 updateNetworkRequest.setNetworkName(l3Network.getNetworkName());
 172                 updateNetworkRequest.setNetworkType(l3Network.getModelInfoNetwork().getNetworkType());
 173                 updateNetworkRequest.setNetworkTypeVersion(l3Network.getModelInfoNetwork().getModelVersion());
 174                 updateNetworkRequest.setModelCustomizationUuid(l3Network.getModelInfoNetwork().getModelCustomizationUUID());
 175                 updateNetworkRequest.setSubnets(buildOpenstackSubnetList(l3Network));
 176                 updateNetworkRequest.setProviderVlanNetwork(buildProviderVlanNetwork(l3Network));
 177                 updateNetworkRequest.setContrailNetwork(buildContrailNetwork(l3Network, customer));
 178                 updateNetworkRequest.setNetworkParams(userInput);
 179                 updateNetworkRequest.setMsoRequest(createMsoRequest(requestContext, serviceInstance));
 180
 181                 setFlowFlags(updateNetworkRequest, orchestrationContext);
 182
 183                 String messageId = getRandomUuid();
 184                 updateNetworkRequest.setMessageId(messageId);
 185                 updateNetworkRequest.setNotificationUrl(createCallbackUrl("NetworkAResponse", messageId));
 186
 187                 return updateNetworkRequest;
 188         }
 189
 190         private RollbackNetworkRequest setCommonRollbackRequestFields(RollbackNetworkRequest request,RequestContext requestContext){
 191                 //TODO confirm flag value
 192                 request.setSkipAAI(true);
 193                 request.setMessageId(requestContext.getMsoRequestId());
 194                 //TODO clarify callback URL build process. This will also set SYNC flag
 195                 //request.setNotificationUrl(createCallbackUrl("NetworkAResponse", messageId));
 196                 return request;
 197         }
 198
 199         private NetworkRollback buildNetworkRollback(L3Network l3Network, CloudRegion cloudRegion, String cloudRegionPo, CreateNetworkResponse createNetworkResponse){
 200                 NetworkRollback networkRollback = new NetworkRollback();
 201                 networkRollback.setNetworkId(l3Network.getNetworkId());
 202                 networkRollback.setNeutronNetworkId(createNetworkResponse.getMessageId());
 203                 networkRollback.setNetworkStackId(createNetworkResponse.getNetworkStackId());
 204                 networkRollback.setTenantId(cloudRegion.getTenantId());
 205                 networkRollback.setCloudId(cloudRegionPo);
 206                 networkRollback.setNetworkType(l3Network.getNetworkType());
 207                 ModelInfoNetwork modelInfoNetwork  = l3Network.getModelInfoNetwork();
 208                 if (modelInfoNetwork != null){
 209                         networkRollback.setModelCustomizationUuid(modelInfoNetwork.getModelCustomizationUUID());
 210                 }
 211                 //rollback will only be called when network was actually created
 212                 networkRollback.setNetworkCreated(createNetworkResponse.getNetworkCreated());
 213                 //TODO confirm below not required for create rollback
 214                 //NetworkName
 215                 //PhysicalNetwork
 216                 //Vlans
 217                 //msoRequest
 218                 return networkRollback;
 219         }
 220
 221         public MsoRequest createMsoRequest(RequestContext requestContext, ServiceInstance serviceInstance) {
 222                 MsoRequest msoRequest = new MsoRequest();
 223                 msoRequest.setRequestId(requestContext.getMsoRequestId());
 224                 msoRequest.setServiceInstanceId(serviceInstance.getServiceInstanceId());
 225                 return msoRequest;
 226         }
 227
 228         protected String getRandomUuid() {
 229                 return UUID.randomUUID().toString();
 230         }
 231
 232         protected String createCallbackUrl(String messageType, String correlator) throws UnsupportedEncodingException {
 233                 String endpoint = this.getEndpoint();
 234
 235                 while (endpoint.endsWith("/")) {
 236                         endpoint = endpoint.substring(0, endpoint.length()-1);
 237                 }
 238                 return endpoint + "/" + UriUtils.encodePathSegment(messageType, "UTF-8") + "/" + UriUtils.encodePathSegment(correlator, "UTF-8");
 239         }
 240
 241         protected String getEndpoint() {
 242                 return UrnPropertiesReader.getVariable("mso.workflow.message.endpoint");
 243         }
 244         /**
 245          * Use BB L3Network object to build subnets list of type org.onap.so.openstack.beans.Subnet
 246          * @param L3Network
 247          * @return List<org.onap.so.openstack.beans.Subnet>
 248          */
 249         private List<Subnet> buildOpenstackSubnetList(L3Network l3Network){
 250
 251                 List<org.onap.so.bpmn.servicedecomposition.bbobjects.Subnet> subnets = l3Network.getSubnets();
 252                 List<org.onap.so.openstack.beans.Subnet> subnetList = new ArrayList<org.onap.so.openstack.beans.Subnet>();
 253                 //create mapper from onap Subnet to openstack bean Subnet
 254                 if(modelMapper.getTypeMap(org.onap.so.bpmn.servicedecomposition.bbobjects.Subnet.class, org.onap.so.openstack.beans.Subnet.class) == null) {
 255                         PropertyMap<org.onap.so.bpmn.servicedecomposition.bbobjects.Subnet, org.onap.so.openstack.beans.Subnet> personMap = new PropertyMap<org.onap.so.bpmn.servicedecomposition.bbobjects.Subnet, org.onap.so.openstack.beans.Subnet>() {
 256                                   protected void configure() {
 257                                     map().setSubnetName(source.getSubnetName());
 258                                     map(source.getSubnetId(), destination.getSubnetId());
 259                                     map(source.getNeutronSubnetId(), destination.getNeutronId());
 260                                     map(source.getGatewayAddress(), destination.getGatewayIp());
 261                                     map(source.getIpVersion(), destination.getIpVersion());
 262                                     map(source.isDhcpEnabled(), destination.getEnableDHCP());
 263                                   }
 264                                 };
 265                         modelMapper.addMappings(personMap);
 266                 }
 267
 268                 for (org.onap.so.bpmn.servicedecomposition.bbobjects.Subnet subnet : subnets) {
 269                         org.onap.so.openstack.beans.Subnet openstackSubnet = modelMapper.map(subnet, org.onap.so.openstack.beans.Subnet.class);
 270                         //update cidr value
 271                         if (subnet.getNetworkStartAddress() != null && subnet.getCidrMask() != null)
 272                                 openstackSubnet.setCidr(subnet.getNetworkStartAddress().concat(FORWARD_SLASH).concat(subnet.getCidrMask()));
 273                         List<org.onap.so.bpmn.servicedecomposition.bbobjects.HostRoute> hostRouteList = subnet.getHostRoutes();
 274                         List<org.onap.so.openstack.beans.HostRoute> openstackHostRouteList = new ArrayList<>();
 275                         org.onap.so.openstack.beans.HostRoute openstackHostRoute = new org.onap.so.openstack.beans.HostRoute();
 276                         //TODO only 2 fields available on openstack object. Confirm it is sufficient or add as needed
 277                         for (org.onap.so.bpmn.servicedecomposition.bbobjects.HostRoute hostRoute : hostRouteList) {
 278                                 openstackHostRoute.setNextHop(hostRoute.getNextHop());
 279                                 openstackHostRoute.setPrefix(hostRoute.getRoutePrefix());
 280                                 //add host route to the list
 281                                 openstackHostRouteList.add(openstackHostRoute);
 282                         }
 283                         openstackSubnet.setHostRoutes(openstackHostRouteList);
 284                         //add subnet to the list
 285                         subnetList.add(openstackSubnet);
 286                 }
 287                 return subnetList;
 288         }
 289
 290         private ProviderVlanNetwork buildProviderVlanNetwork(L3Network l3Network){
 291                 ProviderVlanNetwork providerVlanNetwork = new ProviderVlanNetwork();
 292                 providerVlanNetwork.setPhysicalNetworkName(l3Network.getPhysicalNetworkName());
 293                 List<Integer> vlans = new ArrayList<Integer>();
 294                 List<org.onap.so.bpmn.servicedecomposition.bbobjects.SegmentationAssignment> segmentationAssignments = l3Network.getSegmentationAssignments();
 295                 for (org.onap.so.bpmn.servicedecomposition.bbobjects.SegmentationAssignment assignment : segmentationAssignments) {
 296                         vlans.add(Integer.valueOf(assignment.getSegmentationId()));
 297                 }
 298                 providerVlanNetwork.setVlans(vlans);
 299                 return providerVlanNetwork;
 300         }
 301
 302         private ContrailNetwork buildContrailNetwork(L3Network l3Network, Customer customer){
 303                 ContrailNetwork contrailNetwork = new ContrailNetwork();
 304                 contrailNetwork.setExternal(Optional.ofNullable(l3Network.isIsExternalNetwork()).orElse(false).toString());
 305                 contrailNetwork.setShared(Optional.ofNullable(l3Network.isIsSharedNetwork()).orElse(false).toString());
 306                 contrailNetwork.setPolicyFqdns(buildPolicyFqdns(l3Network.getNetworkPolicies()));
 307                 contrailNetwork.setRouteTableFqdns(buildRouteTableFqdns(l3Network.getContrailNetworkRouteTableReferences()));
 308                 if(customer!= null)
 309                         contrailNetwork.setRouteTargets(buildRouteTargets(customer.getVpnBindings()));
 310                 //PolicyFqdns(policyFqdns); --- is set in getAAINetworkPolicy
 311                 //RouteTableFqdns(routeTableFqdns); --- is set in getAAINetworkTableRef
 312                 //RouteTargets(routeTargets); --- is set in getAAINetworkVpnBinding
 313                 return contrailNetwork;
 314         }
 315
 316         private List<String> buildPolicyFqdns(List<NetworkPolicy> networkPolicies) {
 317                 List<String> policyFqdns = new ArrayList<>();
 318                 for(NetworkPolicy networkPolicy : networkPolicies) {
 319                         policyFqdns.add(networkPolicy.getNetworkPolicyFqdn());
 320                 }
 321                 return policyFqdns;
 322         }
 323
 324         private List<String> buildRouteTableFqdns(List<RouteTableReference> contrailNetworkRouteTableReferences) {
 325                 List<String> routeTableFqdns = new ArrayList<>();
 326                 for(RouteTableReference routeTableReference : contrailNetworkRouteTableReferences) {
 327                         routeTableFqdns.add(routeTableReference.getRouteTableReferenceFqdn());
 328                 }
 329                 return routeTableFqdns;
 330         }
 331
 332         private List<RouteTarget> buildRouteTargets(List<VpnBinding> vpnBindings) {
 333                 if(modelMapper.getTypeMap(org.onap.so.bpmn.servicedecomposition.bbobjects.RouteTarget.class, RouteTarget.class) == null) {
 334                         modelMapper.addMappings(new PropertyMap<org.onap.so.bpmn.servicedecomposition.bbobjects.RouteTarget, RouteTarget>() {
 335                                 @Override
 336                                 protected void configure() {
 337                                         map().setRouteTarget(source.getGlobalRouteTarget());
 338                                         map().setRouteTargetRole(source.getRouteTargetRole());
 339                                 }
 340                         });
 341                 }
 342
 343                 List<RouteTarget> routeTargets = new ArrayList<>();
 344                 for(VpnBinding vpnBinding : vpnBindings) {
 345                         for(org.onap.so.bpmn.servicedecomposition.bbobjects.RouteTarget routeTarget : vpnBinding.getRouteTargets()) {
 346                                 routeTargets.add(modelMapper.map(routeTarget, RouteTarget.class));
 347                         }
 348                 }
 349                 return routeTargets;
 350         }
 351
 352         private CreateNetworkRequest setFlowFlags(CreateNetworkRequest createNetworkRequest, OrchestrationContext orchestrationContext){
 353                 //TODO confirm flag value
 354                 createNetworkRequest.setSkipAAI(true);
 355                 createNetworkRequest.setBackout(Boolean.TRUE.equals(orchestrationContext.getIsRollbackEnabled()));
 356                 //TODO confirm value - false by default
 357                 createNetworkRequest.setFailIfExists(true);
 358                 //NetworkTechnology(NetworkTechnology.NEUTRON); NOOP - default
 359                 return createNetworkRequest;
 360         }
 361
 362         private void setFlowFlags(UpdateNetworkRequest updateNetworkRequest, OrchestrationContext orchestrationContext){
 363                 updateNetworkRequest.setSkipAAI(true);
 364                 updateNetworkRequest.setBackout(Boolean.TRUE.equals(orchestrationContext.getIsRollbackEnabled()));
 365                 //NetworkTechnology(NetworkTechnology.NEUTRON); NOOP - default
 366         }
 367 }