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.Map;
  24 import java.util.concurrent.CompletableFuture;
  25 import javax.ws.rs.client.Entity;
  26 import javax.ws.rs.core.MediaType;
  27 import org.apache.commons.lang3.tuple.Pair;
  28 import org.onap.aai.domain.yang.CloudRegion;
  29 import org.onap.aai.domain.yang.GenericVnf;
  30 import org.onap.aai.domain.yang.ServiceInstance;
  31 import org.onap.aai.domain.yang.Tenant;
  32 import org.onap.policy.aai.AaiConstants;
  33 import org.onap.policy.aai.AaiCqResponse;
  34 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  35 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  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 /**
  49  * Operation to create a VF Module. This gets the VF count from the A&AI Custom Query
  50  * response and stores it in the context. It also passes the count+1 to the guard. Once
  51  * the "create" completes successfully, it bumps the VF count that's stored in the
  52  * context.
  53  * <p/>
  54  * Note: currently, this only supports storing the count for a single target VF.
  55  */
  56 public class VfModuleCreate extends SoOperation {
  57     public static final String NAME = "VF Module Create";
  58
  59     public static final String PAYLOAD_KEY_VF_COUNT = "vfCount";
  60
  61     /**
  62      * Constructs the object.
  63      *
  64      * @param params operation parameters
  65      * @param config configuration for this operation
  66      */
  67     public VfModuleCreate(ControlLoopOperationParams params, HttpConfig config) {
  68         super(params, config);
  69
  70         // ensure we have the necessary parameters
  71         validateTarget();
  72     }
  73
  74     /**
  75      * Ensures that A&AI customer query has been performed, and then runs the guard.
  76      */
  77     @Override
  78     @SuppressWarnings("unchecked")
  79     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  80
  81         // need the VF count
  82         ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
  83                         .operation(AaiCqResponse.OPERATION).payload(null).retry(null).timeoutSec(null).build();
  84
  85         // run Custom Query, extract the VF count, and then run the Guard
  86
  87         // @formatter:off
  88         return sequence(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams),
  89                         this::obtainVfCount, this::startGuardAsync);
  90         // @formatter:on
  91     }
  92
  93     @Override
  94     protected Map<String, Object> makeGuardPayload() {
  95         Map<String, Object> payload = super.makeGuardPayload();
  96
  97         // run guard with the proposed vf count
  98         payload.put(PAYLOAD_KEY_VF_COUNT, getVfCount() + 1);
  99
 100         return payload;
 101     }
 102
 103     @Override
 104     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
 105
 106         // starting a whole new attempt - reset the count
 107         resetGetCount();
 108
 109         Pair<String, SoRequest> pair = makeRequest();
 110         String path = pair.getLeft();
 111         SoRequest request = pair.getRight();
 112
 113         Entity<SoRequest> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
 114         String url = getClient().getBaseUrl() + path;
 115
 116         logMessage(EventType.OUT, CommInfrastructure.REST, url, request);
 117
 118         // TODO should this use "path" or the full "url"?
 119
 120         return handleResponse(outcome, url, callback -> getClient().post(callback, path, entity, null));
 121     }
 122
 123     /**
 124      * Increments the VF count that's stored in the context.
 125      */
 126     @Override
 127     protected void successfulCompletion() {
 128         setVfCount(getVfCount() + 1);
 129     }
 130
 131     /**
 132      * Makes a request.
 133      *
 134      * @return a pair containing the request URL and the new request
 135      */
 136     protected Pair<String, SoRequest> makeRequest() {
 137         final AaiCqResponse aaiCqResponse = params.getContext().getProperty(AaiCqResponse.CONTEXT_KEY);
 138         final SoModelInfo soModelInfo = prepareSoModelInfo();
 139         final GenericVnf vnfItem = getVnfItem(aaiCqResponse, soModelInfo);
 140         final ServiceInstance vnfServiceItem = getServiceInstance(aaiCqResponse);
 141         final Tenant tenantItem = getDefaultTenant(aaiCqResponse);
 142         final CloudRegion cloudRegionItem = getDefaultCloudRegion(aaiCqResponse);
 143
 144         SoRequest request = new SoRequest();
 145         request.setOperationType(SoOperationType.SCALE_OUT);
 146
 147         //
 148         //
 149         // Do NOT send SO the requestId, they do not support this field
 150         //
 151         request.setRequestDetails(new SoRequestDetails());
 152         request.getRequestDetails().setRequestParameters(new SoRequestParameters());
 153         request.getRequestDetails().getRequestParameters().setUserParams(null);
 154
 155         // cloudConfiguration
 156         request.getRequestDetails().setCloudConfiguration(constructCloudConfigurationCq(tenantItem, cloudRegionItem));
 157
 158         // modelInfo
 159         request.getRequestDetails().setModelInfo(soModelInfo);
 160
 161         // requestInfo
 162         request.getRequestDetails().setRequestInfo(constructRequestInfo());
 163         request.getRequestDetails().getRequestInfo().setInstanceName("vfModuleName");
 164
 165         // relatedInstanceList
 166         SoRelatedInstanceListElement relatedInstanceListElement1 = new SoRelatedInstanceListElement();
 167         SoRelatedInstanceListElement relatedInstanceListElement2 = new SoRelatedInstanceListElement();
 168         relatedInstanceListElement1.setRelatedInstance(new SoRelatedInstance());
 169         relatedInstanceListElement2.setRelatedInstance(new SoRelatedInstance());
 170
 171         // Service Item
 172         relatedInstanceListElement1.getRelatedInstance().setInstanceId(vnfServiceItem.getServiceInstanceId());
 173         relatedInstanceListElement1.getRelatedInstance().setModelInfo(new SoModelInfo());
 174         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelType("service");
 175         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 176                         .setModelInvariantId(vnfServiceItem.getModelInvariantId());
 177         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 178                         .setModelVersionId(vnfServiceItem.getModelVersionId());
 179         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelName(
 180                         aaiCqResponse.getModelVerByVersionId(vnfServiceItem.getModelVersionId()).getModelName());
 181         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelVersion(
 182                         aaiCqResponse.getModelVerByVersionId(vnfServiceItem.getModelVersionId()).getModelVersion());
 183
 184         // VNF Item
 185         relatedInstanceListElement2.getRelatedInstance().setInstanceId(vnfItem.getVnfId());
 186         relatedInstanceListElement2.getRelatedInstance().setModelInfo(new SoModelInfo());
 187         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelType("vnf");
 188         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 189                         .setModelInvariantId(vnfItem.getModelInvariantId());
 190         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelVersionId(vnfItem.getModelVersionId());
 191
 192         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 193                         .setModelName(aaiCqResponse.getModelVerByVersionId(vnfItem.getModelVersionId()).getModelName());
 194         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelVersion(
 195                         aaiCqResponse.getModelVerByVersionId(vnfItem.getModelVersionId()).getModelVersion());
 196
 197         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 198                         .setModelCustomizationId(vnfItem.getModelCustomizationId());
 199
 200         // Insert the Service Item and VNF Item
 201         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement1);
 202         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement2);
 203
 204         // Request Parameters
 205         buildRequestParameters().ifPresent(request.getRequestDetails()::setRequestParameters);
 206
 207         // Configuration Parameters
 208         buildConfigurationParameters().ifPresent(request.getRequestDetails()::setConfigurationParameters);
 209
 210         // compute the path
 211         String path = "/serviceInstantiation/v7/serviceInstances/" + vnfServiceItem.getServiceInstanceId() + "/vnfs/"
 212                         + vnfItem.getVnfId() + "/vfModules/scaleOut";
 213
 214         return Pair.of(path, request);
 215     }
 216
 217     /**
 218      * Construct cloudConfiguration for the SO requestDetails. Overridden for custom
 219      * query.
 220      *
 221      * @param tenantItem tenant item from A&AI named-query response
 222      * @return SO cloud configuration
 223      */
 224     private SoCloudConfiguration constructCloudConfigurationCq(Tenant tenantItem, CloudRegion cloudRegionItem) {
 225         SoCloudConfiguration cloudConfiguration = new SoCloudConfiguration();
 226         cloudConfiguration.setTenantId(tenantItem.getTenantId());
 227         cloudConfiguration.setLcpCloudRegionId(cloudRegionItem.getCloudRegionId());
 228         return cloudConfiguration;
 229     }
 230 }