adapters/etsi-sol003-adapter/etsi-sol003-lcm/etsi-sol003-lcm-adapter/src/main/java/org/onap/so/adapters/etsisol003adapter/lcm/lifecycle/LifecycleManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   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  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.adapters.etsisol003adapter.lcm.lifecycle;
  22
  23 import java.util.Map;
  24 import org.onap.aai.domain.yang.EsrVnfm;
  25 import org.onap.aai.domain.yang.GenericVnf;
  26 import org.onap.aai.domain.yang.Relationship;
  27 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.EtsiPackageProvider;
  28 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.aai.AaiHelper;
  29 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.aai.AaiServiceProvider;
  30 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.aai.OamIpAddressSource;
  31 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.aai.OamIpAddressSource.OamIpAddressType;
  32 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.VnfmHelper;
  33 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.VnfmServiceProvider;
  34 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InlineResponse201;
  35 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.InstantiateVnfRequest;
  36 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.LccnSubscriptionRequest;
  37 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.TerminateVnfRequest;
  38 import org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.TerminateVnfRequest.TerminationTypeEnum;
  39 import org.onap.so.adapters.etsisol003adapter.lcm.jobmanagement.JobManager;
  40 import org.onap.so.adapters.etsisol003adapter.lcm.rest.exceptions.VnfNotFoundException;
  41 import org.onap.so.adapters.etsisol003adapter.lcm.rest.exceptions.VnfmNotFoundException;
  42 import org.onap.so.adapters.etsisol003adapter.lcm.rest.exceptions.VnfmRequestFailureException;
  43 import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfRequest;
  44 import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.CreateVnfResponse;
  45 import org.onap.so.adapters.etsisol003adapter.lcm.v1.model.DeleteVnfResponse;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48 import org.springframework.beans.factory.annotation.Autowired;
  49 import org.springframework.stereotype.Component;
  50 import com.google.common.base.Optional;
  51 import static org.apache.commons.lang3.StringUtils.isNotBlank;
  52
  53 /**
  54  * Manages lifecycle operations towards the VNFMs.
  55  */
  56 @Component
  57 public class LifecycleManager {
  58     private static final Logger logger = LoggerFactory.getLogger(LifecycleManager.class);
  59     private final AaiServiceProvider aaiServiceProvider;
  60     private final VnfmServiceProvider vnfmServiceProvider;
  61     private final AaiHelper aaiHelper;
  62     private final VnfmHelper vnfmHelper;
  63     private final JobManager jobManager;
  64     private final EtsiPackageProvider packageProvider;
  65
  66     @Autowired
  67     LifecycleManager(final AaiServiceProvider aaiServiceProvider, final AaiHelper aaiHelper,
  68             final VnfmHelper vnfmHelper, final VnfmServiceProvider vnfmServiceProvider, final JobManager jobManager,
  69             final EtsiPackageProvider packageProvider) {
  70         this.aaiServiceProvider = aaiServiceProvider;
  71         this.vnfmServiceProvider = vnfmServiceProvider;
  72         this.aaiHelper = aaiHelper;
  73         this.vnfmHelper = vnfmHelper;
  74         this.jobManager = jobManager;
  75         this.packageProvider = packageProvider;
  76     }
  77
  78     /**
  79      * Create a VNF on a VNFM.
  80      *
  81      * @param vnfIdInAai the ID of the VNF in AAI
  82      * @param request the create request
  83      * @return the response to the request
  84      */
  85     public CreateVnfResponse createVnf(final String vnfIdInAai, final CreateVnfRequest request) {
  86         final GenericVnf genericVnf = getGenericVnfFromAai(vnfIdInAai);
  87         EsrVnfm vnfm = aaiHelper.getAssignedVnfm(genericVnf);
  88         checkIfVnfAlreadyExistsInVnfm(vnfm, genericVnf);
  89
  90         if (vnfm == null) {
  91             vnfm = aaiHelper.selectVnfm(genericVnf);
  92             aaiServiceProvider.invokePutGenericVnfToVnfmRelationship(genericVnf, vnfm.getVnfmId());
  93         }
  94         final InlineResponse201 vnfmResponse = sendCreateRequestToVnfm(request, genericVnf, vnfIdInAai, vnfm);
  95
  96         logger.info("Create response: {}", vnfmResponse);
  97
  98         genericVnf.setSelflink(getSelfLink(vnfmResponse, vnfm));
  99
 100         final GenericVnf genericVnfPatch = new GenericVnf();
 101         genericVnfPatch.setVnfId(genericVnf.getVnfId());
 102         genericVnfPatch.setSelflink(genericVnf.getSelflink());
 103         aaiServiceProvider.invokePatchGenericVnf(genericVnfPatch);
 104
 105         final String vnfIdInVnfm = vnfmResponse.getId();
 106
 107         final OamIpAddressSource oamIpAddressSource = extractOamIpAddressSource(request);
 108         aaiHelper.setOamIpAddressSource(vnfIdInVnfm, oamIpAddressSource);
 109
 110         createNotificationSubscription(vnfm, vnfIdInVnfm);
 111         final String operationId = sendInstantiateRequestToVnfm(vnfm, genericVnf, request);
 112
 113         final String jobId = jobManager.createJob(vnfm.getVnfmId(), operationId, false);
 114         final CreateVnfResponse response = new CreateVnfResponse();
 115         response.setJobId(jobId);
 116         return response;
 117     }
 118
 119     private String getSelfLink(final InlineResponse201 vnfmResponse, final EsrVnfm vnfm) {
 120         if (vnfmResponse.getLinks() != null && vnfmResponse.getLinks().getSelf() != null
 121                 && vnfmResponse.getLinks().getSelf().getHref() != null) {
 122             return vnfmResponse.getLinks().getSelf().getHref();
 123         }
 124         return vnfm.getEsrSystemInfoList().getEsrSystemInfo().iterator().next().getServiceUrl() + "/vnf_instances/"
 125                 + vnfmResponse.getId();
 126     }
 127
 128     private OamIpAddressSource extractOamIpAddressSource(final CreateVnfRequest request) {
 129         final Map<String, String> additionalParams = request.getAdditionalParams();
 130         try {
 131             final String sourceType = additionalParams.remove("oamIpAddressSourceType");
 132             final String sourceValue = additionalParams.remove("oamIpAddressSourceValue");
 133             final OamIpAddressType oamIpAddressType = OamIpAddressType.valueOf(sourceType.toUpperCase());
 134             return new OamIpAddressSource(oamIpAddressType, sourceValue);
 135         } catch (final NullPointerException | IllegalArgumentException exception) {
 136             logger.debug("Additional Params not set for OAM IP address source", exception);
 137             return null;
 138         }
 139     }
 140
 141     private void checkIfVnfAlreadyExistsInVnfm(final EsrVnfm vnfm, final GenericVnf genericVnf) {
 142         if (genericVnf.getSelflink() != null && !genericVnf.getSelflink().isEmpty() && vnfm != null) {
 143             Optional<InlineResponse201> response = Optional.absent();
 144             try {
 145                 response = vnfmServiceProvider.getVnf(vnfm, genericVnf.getSelflink());
 146             } catch (final Exception exception) {
 147                 logger.debug("Ignoring invalid self link in generic vnf", exception);
 148             }
 149             if (response.isPresent()) {
 150                 throw new IllegalArgumentException("VNF " + genericVnf.getVnfId()
 151                         + " is already defined on the VNFM, self link: " + genericVnf.getSelflink());
 152             }
 153         }
 154     }
 155
 156     private InlineResponse201 sendCreateRequestToVnfm(final CreateVnfRequest createVnfRequest,
 157             final GenericVnf genericVnf, final String vnfIdInAai, final EsrVnfm vnfm) {
 158         logger.debug("Sending a create request to SVNFM {}", createVnfRequest);
 159         final org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.CreateVnfRequest vnfmRequest =
 160                 new org.onap.so.adapters.etsisol003adapter.lcm.extclients.vnfm.model.CreateVnfRequest();
 161
 162         final String pkgId = getPackageId(createVnfRequest, genericVnf);
 163         final String vnfdId = packageProvider.getVnfdId(pkgId);
 164         vnfmRequest.setVnfdId(vnfdId);
 165         vnfmRequest.setVnfInstanceName(createVnfRequest.getName().replaceAll(" ", "_"));
 166         vnfmRequest.setVnfInstanceDescription(vnfIdInAai);
 167
 168         final Optional<InlineResponse201> optionalResponse = vnfmServiceProvider.createVnf(vnfm, vnfmRequest);
 169
 170         try {
 171             return optionalResponse.get();
 172         } catch (final Exception exception) {
 173             final String errorMessage = "Unable to return response from VNFM";
 174             logger.error(errorMessage, exception);
 175             throw new VnfmRequestFailureException(errorMessage, exception);
 176         }
 177     }
 178
 179     private String getPackageId(final CreateVnfRequest createVnfRequest, final GenericVnf genericVnf) {
 180         if (isNotBlank(createVnfRequest.getPkgId())) {
 181             logger.info("Found createVnfRequest pkgId: {}", createVnfRequest.getPkgId());
 182             return createVnfRequest.getPkgId();
 183         }
 184         logger.info("Found genericVnf modelVersionId: {}", genericVnf.getModelVersionId());
 185         return genericVnf.getModelVersionId();
 186     }
 187
 188     private void createNotificationSubscription(final EsrVnfm vnfm, final String vnfId) {
 189         try {
 190             final LccnSubscriptionRequest subscriptionRequest = vnfmHelper.createNotificationSubscriptionRequest(vnfId);
 191             vnfmServiceProvider.subscribeForNotifications(vnfm, subscriptionRequest);
 192         } catch (final Exception exception) {
 193             logger.warn("Subscription for notifications to VNFM: " + vnfm.getVnfmId() + " for VNF " + vnfId
 194                     + " failed. AAI will not be updated unless the VNFM is configured by other means to send notifications relating to this VNF",
 195                     exception);
 196         }
 197     }
 198
 199     private String sendInstantiateRequestToVnfm(final EsrVnfm vnfm, final GenericVnf genericVnf,
 200             final CreateVnfRequest createVnfRequest) {
 201
 202         final String pkgId = getPackageId(createVnfRequest, genericVnf);
 203         final InstantiateVnfRequest instantiateVnfRequest = vnfmHelper.createInstantiateRequest(
 204                 createVnfRequest.getTenant(), createVnfRequest, packageProvider.getFlavourId(pkgId));
 205         final String jobId = vnfmServiceProvider.instantiateVnf(vnfm, genericVnf.getSelflink(), instantiateVnfRequest);
 206
 207         logger.info("Instantiate VNF request successfully sent to " + genericVnf.getSelflink());
 208         return jobId;
 209     }
 210
 211     /**
 212      * Delete a VNF on a VNFM.
 213      *
 214      * @param vnfIdInAai the ID of the VNF in AAI
 215      * @return the response to the request
 216      */
 217     public DeleteVnfResponse deleteVnf(final String vnfIdInAai) {
 218         final GenericVnf genericVnf = getGenericVnfFromAai(vnfIdInAai);
 219         final EsrVnfm vnfm = getAssignedVnfm(genericVnf);
 220
 221         final String operationId = sendTerminateRequestToVnfm(vnfm, genericVnf);
 222
 223         if (operationId.equals(JobManager.ALREADY_COMPLETED_OPERATION_ID)) {
 224             sendDeleteRequestToVnfm(genericVnf);
 225         }
 226         final String jobId = jobManager.createJob(vnfm.getVnfmId(), operationId, true);
 227
 228         return new DeleteVnfResponse().jobId(jobId);
 229     }
 230
 231     private String sendTerminateRequestToVnfm(final EsrVnfm vnfm, final GenericVnf genericVnf) {
 232         final TerminateVnfRequest terminateVnfRequest = new TerminateVnfRequest();
 233         terminateVnfRequest.setTerminationType(TerminationTypeEnum.FORCEFUL);
 234         return vnfmServiceProvider.terminateVnf(vnfm, genericVnf.getSelflink(), terminateVnfRequest);
 235     }
 236
 237     private GenericVnf getGenericVnfFromAai(final String vnfIdInAai) {
 238         final GenericVnf genericVnf = aaiServiceProvider.invokeGetGenericVnf(vnfIdInAai);
 239         if (genericVnf == null) {
 240             throw new VnfNotFoundException("VNF not found in AAI: " + vnfIdInAai);
 241         }
 242         logger.debug("Retrieved generic VNF from AAI: " + genericVnf);
 243         return genericVnf;
 244     }
 245
 246     private EsrVnfm getAssignedVnfm(final GenericVnf genericVnf) {
 247         final EsrVnfm vnfm = aaiHelper.getAssignedVnfm(genericVnf);
 248         if (vnfm == null) {
 249             throw new VnfmNotFoundException("No VNFM found in AAI for VNF " + genericVnf.getVnfId());
 250         }
 251         return vnfm;
 252     }
 253
 254     private void sendDeleteRequestToVnfm(final GenericVnf genericVnf) {
 255
 256         vnfmServiceProvider.deleteVnf(aaiHelper.getAssignedVnfm(genericVnf), genericVnf.getSelflink());
 257
 258         final GenericVnf genericVnfPatch = new GenericVnf();
 259         genericVnfPatch.setVnfId(genericVnf.getVnfId());
 260         genericVnfPatch.setOrchestrationStatus("Assigned");
 261         genericVnfPatch.setSelflink("");
 262         aaiServiceProvider.invokePatchGenericVnf(genericVnfPatch);
 263
 264         for (final Relationship relationship : genericVnf.getRelationshipList().getRelationship()) {
 265             if (relationship.getRelatedTo().equals("vserver")) {
 266                 aaiServiceProvider.invokeDeleteVserver(
 267                         aaiHelper.getRelationshipData(relationship, "cloud-region.cloud-owner"),
 268                         aaiHelper.getRelationshipData(relationship, "cloud-region.cloud-region-id"),
 269                         aaiHelper.getRelationshipData(relationship, "tenant.tenant-id"),
 270                         aaiHelper.getRelationshipData(relationship, "vserver.vserver-id"));
 271             }
 272         }
 273
 274
 275     }
 276 }