models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020 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.policy.controlloop.actor.so;
  22
  23 import java.util.concurrent.CompletableFuture;
  24 import javax.ws.rs.client.Entity;
  25 import javax.ws.rs.core.MediaType;
  26 import org.apache.commons.lang3.tuple.Pair;
  27 import org.onap.aai.domain.yang.CloudRegion;
  28 import org.onap.aai.domain.yang.GenericVnf;
  29 import org.onap.aai.domain.yang.ServiceInstance;
  30 import org.onap.aai.domain.yang.Tenant;
  31 import org.onap.policy.aai.AaiConstants;
  32 import org.onap.policy.aai.AaiCqResponse;
  33 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  34 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  35 import org.onap.policy.controlloop.actor.aai.AaiCustomQueryOperation;
  36 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  37 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  38 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  39 import org.onap.policy.so.SoCloudConfiguration;
  40 import org.onap.policy.so.SoModelInfo;
  41 import org.onap.policy.so.SoOperationType;
  42 import org.onap.policy.so.SoRelatedInstance;
  43 import org.onap.policy.so.SoRelatedInstanceListElement;
  44 import org.onap.policy.so.SoRequest;
  45 import org.onap.policy.so.SoRequestDetails;
  46 import org.onap.policy.so.SoRequestParameters;
  47
  48 public class VfModuleCreate extends SoOperation {
  49     public static final String NAME = "VF Module Create";
  50
  51     public VfModuleCreate(ControlLoopOperationParams params, HttpConfig config) {
  52         super(params, config);
  53     }
  54
  55     /**
  56      * Ensures that A&AI customer query has been performed, and then runs the guard query.
  57      */
  58     @Override
  59     @SuppressWarnings("unchecked")
  60     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  61         ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
  62                         .operation(AaiCustomQueryOperation.NAME).payload(null).retry(null).timeoutSec(null).build();
  63
  64         // run Custom Query and Guard, in parallel
  65         return allOf(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams), this::startGuardAsync);
  66     }
  67
  68     @Override
  69     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
  70
  71         // starting a whole new attempt - reset the count
  72         resetGetCount();
  73
  74         Pair<String, SoRequest> pair = makeRequest();
  75         String path = pair.getLeft();
  76         SoRequest request = pair.getRight();
  77
  78         Entity<SoRequest> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
  79         String url = getClient().getBaseUrl() + path;
  80
  81         logMessage(EventType.OUT, CommInfrastructure.REST, url, request);
  82
  83         // TODO should this use "path" or the full "url"?
  84
  85         return handleResponse(outcome, url, callback -> getClient().post(callback, path, entity, null));
  86     }
  87
  88     /**
  89      * Makes a request.
  90      *
  91      * @return a pair containing the request URL and the new request
  92      */
  93     protected Pair<String, SoRequest> makeRequest() {
  94         final AaiCqResponse aaiCqResponse = params.getContext().getProperty(AaiCqResponse.CONTEXT_KEY);
  95         final SoModelInfo soModelInfo = prepareSoModelInfo();
  96         final GenericVnf vnfItem = getVnfItem(aaiCqResponse, soModelInfo);
  97         final ServiceInstance vnfServiceItem = getServiceInstance(aaiCqResponse);
  98         final Tenant tenantItem = getDefaultTenant(aaiCqResponse);
  99         final CloudRegion cloudRegionItem = getDefaultCloudRegion(aaiCqResponse);
 100
 101         SoRequest request = new SoRequest();
 102         request.setOperationType(SoOperationType.SCALE_OUT);
 103
 104         //
 105         //
 106         // Do NOT send SO the requestId, they do not support this field
 107         //
 108         request.setRequestDetails(new SoRequestDetails());
 109         request.getRequestDetails().setRequestParameters(new SoRequestParameters());
 110         request.getRequestDetails().getRequestParameters().setUserParams(null);
 111
 112         // cloudConfiguration
 113         request.getRequestDetails().setCloudConfiguration(constructCloudConfigurationCq(tenantItem, cloudRegionItem));
 114
 115         // modelInfo
 116         request.getRequestDetails().setModelInfo(soModelInfo);
 117
 118         // requestInfo
 119         request.getRequestDetails().setRequestInfo(constructRequestInfo());
 120         request.getRequestDetails().getRequestInfo().setInstanceName("vfModuleName");
 121
 122         // relatedInstanceList
 123         SoRelatedInstanceListElement relatedInstanceListElement1 = new SoRelatedInstanceListElement();
 124         SoRelatedInstanceListElement relatedInstanceListElement2 = new SoRelatedInstanceListElement();
 125         relatedInstanceListElement1.setRelatedInstance(new SoRelatedInstance());
 126         relatedInstanceListElement2.setRelatedInstance(new SoRelatedInstance());
 127
 128         // Service Item
 129         relatedInstanceListElement1.getRelatedInstance().setInstanceId(vnfServiceItem.getServiceInstanceId());
 130         relatedInstanceListElement1.getRelatedInstance().setModelInfo(new SoModelInfo());
 131         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelType("service");
 132         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 133                         .setModelInvariantId(vnfServiceItem.getModelInvariantId());
 134         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 135                         .setModelVersionId(vnfServiceItem.getModelVersionId());
 136         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelName(
 137                         aaiCqResponse.getModelVerByVersionId(vnfServiceItem.getModelVersionId()).getModelName());
 138         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelVersion(
 139                         aaiCqResponse.getModelVerByVersionId(vnfServiceItem.getModelVersionId()).getModelVersion());
 140
 141         // VNF Item
 142         relatedInstanceListElement2.getRelatedInstance().setInstanceId(vnfItem.getVnfId());
 143         relatedInstanceListElement2.getRelatedInstance().setModelInfo(new SoModelInfo());
 144         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelType("vnf");
 145         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 146                         .setModelInvariantId(vnfItem.getModelInvariantId());
 147         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelVersionId(vnfItem.getModelVersionId());
 148
 149         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 150                         .setModelName(aaiCqResponse.getModelVerByVersionId(vnfItem.getModelVersionId()).getModelName());
 151         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelVersion(
 152                         aaiCqResponse.getModelVerByVersionId(vnfItem.getModelVersionId()).getModelVersion());
 153
 154         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 155                         .setModelCustomizationId(vnfItem.getModelCustomizationId());
 156
 157         // Insert the Service Item and VNF Item
 158         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement1);
 159         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement2);
 160
 161         // Request Parameters
 162         request.getRequestDetails().setRequestParameters(buildRequestParameters());
 163
 164         // Configuration Parameters
 165         request.getRequestDetails().setConfigurationParameters(buildConfigurationParameters());
 166
 167         // compute the path
 168         String path = "/serviceInstantiation/v7/serviceInstances/" + vnfServiceItem.getServiceInstanceId() + "/vnfs/"
 169                         + vnfItem.getVnfId() + "/vfModules/scaleOut";
 170
 171         return Pair.of(path, request);
 172     }
 173
 174     /**
 175      * Construct cloudConfiguration for the SO requestDetails. Overridden for custom
 176      * query.
 177      *
 178      * @param tenantItem tenant item from A&AI named-query response
 179      * @return SO cloud configuration
 180      */
 181     private SoCloudConfiguration constructCloudConfigurationCq(Tenant tenantItem, CloudRegion cloudRegionItem) {
 182         SoCloudConfiguration cloudConfiguration = new SoCloudConfiguration();
 183         cloudConfiguration.setTenantId(tenantItem.getTenantId());
 184         cloudConfiguration.setLcpCloudRegionId(cloudRegionItem.getCloudRegionId());
 185         return cloudConfiguration;
 186     }
 187 }