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