models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleDelete.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.net.URI;
  24 import java.net.http.HttpRequest;
  25 import java.net.http.HttpRequest.BodyPublishers;
  26 import java.net.http.HttpRequest.Builder;
  27 import java.net.http.HttpResponse;
  28 import java.net.http.HttpResponse.BodyHandlers;
  29 import java.nio.charset.StandardCharsets;
  30 import java.util.Base64;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import java.util.concurrent.CompletableFuture;
  35 import javax.ws.rs.client.InvocationCallback;
  36 import javax.ws.rs.core.MediaType;
  37 import javax.ws.rs.core.Response;
  38 import org.apache.commons.lang3.StringUtils;
  39 import org.apache.commons.lang3.tuple.Pair;
  40 import org.onap.aai.domain.yang.CloudRegion;
  41 import org.onap.aai.domain.yang.GenericVnf;
  42 import org.onap.aai.domain.yang.ServiceInstance;
  43 import org.onap.aai.domain.yang.Tenant;
  44 import org.onap.policy.aai.AaiConstants;
  45 import org.onap.policy.aai.AaiCqResponse;
  46 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  47 import org.onap.policy.common.endpoints.http.client.HttpClient;
  48 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  49 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  50 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  51 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  52 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
  53 import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
  54 import org.onap.policy.so.SoModelInfo;
  55 import org.onap.policy.so.SoOperationType;
  56 import org.onap.policy.so.SoRequest;
  57 import org.onap.policy.so.SoRequestDetails;
  58 import org.onap.policy.so.SoResponse;
  59
  60 /**
  61  * Operation to delete a VF Module. This gets the VF count from the A&AI Custom Query
  62  * response and stores it in the context. It also passes the count-1 to the guard. Once
  63  * the "delete" completes successfully, it decrements the VF count that's stored in the
  64  * context.
  65  */
  66 public class VfModuleDelete extends SoOperation {
  67     public static final String NAME = "VF Module Delete";
  68
  69     private static final String PATH_PREFIX = "/";
  70
  71     // @formatter:off
  72     private static final List<String> PROPERTY_NAMES = List.of(
  73                             OperationProperties.AAI_SERVICE,
  74                             OperationProperties.AAI_VNF,
  75                             OperationProperties.AAI_DEFAULT_CLOUD_REGION,
  76                             OperationProperties.AAI_DEFAULT_TENANT,
  77                             OperationProperties.DATA_VF_COUNT);
  78     // @formatter:on
  79
  80     /**
  81      * Constructs the object.
  82      *
  83      * @param params operation parameters
  84      * @param config configuration for this operation
  85      */
  86     public VfModuleDelete(ControlLoopOperationParams params, HttpPollingConfig config) {
  87         super(params, config, PROPERTY_NAMES);
  88
  89         // ensure we have the necessary parameters
  90         validateTarget();
  91     }
  92
  93     /**
  94      * Ensures that A&AI custom query has been performed, and then runs the guard.
  95      */
  96     @Override
  97     @SuppressWarnings("unchecked")
  98     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  99         if (params.isPreprocessed()) {
 100             return null;
 101         }
 102
 103         // need the VF count
 104         ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
 105                         .operation(AaiCqResponse.OPERATION).payload(null).retry(null).timeoutSec(null).build();
 106
 107         // run Custom Query, extract the VF count, and then run the Guard
 108
 109         // @formatter:off
 110         return sequence(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams),
 111                         this::obtainVfCount, this::startGuardAsync);
 112         // @formatter:on
 113     }
 114
 115     @Override
 116     protected Map<String, Object> makeGuardPayload() {
 117         Map<String, Object> payload = super.makeGuardPayload();
 118
 119         // run guard with the proposed vf count
 120         payload.put(PAYLOAD_KEY_VF_COUNT, getVfCount() - 1);
 121
 122         return payload;
 123     }
 124
 125     @Override
 126     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
 127
 128         // starting a whole new attempt - reset the count
 129         resetPollCount();
 130
 131         Pair<String, SoRequest> pair = makeRequest();
 132         SoRequest request = pair.getRight();
 133         String url = getPath() + pair.getLeft();
 134
 135         String strRequest = prettyPrint(request);
 136         logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
 137
 138         Map<String, Object> headers = createSimpleHeaders();
 139
 140         // @formatter:off
 141         return handleResponse(outcome, url,
 142             callback -> delete(url, headers, MediaType.APPLICATION_JSON, strRequest, callback));
 143         // @formatter:on
 144     }
 145
 146     /**
 147      * Issues an HTTP "DELETE" request, containing a request body, using the java built-in
 148      * HttpClient, as the JerseyClient does not support it. This will add the content-type
 149      * and authorization headers, so they should not be included within "headers".
 150      *
 151      * @param uri URI suffix, to be appended to the URI prefix
 152      * @param headers headers to be included
 153      * @param contentType content type of the request
 154      * @param request request to be posted
 155      * @param callback response callbacks
 156      * @return a future to await the response. Note: it's untested whether canceling this
 157      *         future will actually cancel the underlying HTTP request
 158      */
 159     protected CompletableFuture<Response> delete(String uri, Map<String, Object> headers, String contentType,
 160                     String request, InvocationCallback<Response> callback) {
 161         // TODO move to HttpOperation
 162
 163         final String url = getClient().getBaseUrl() + uri;
 164
 165         Builder builder = HttpRequest.newBuilder(URI.create(url));
 166         builder = builder.header("Content-type", contentType);
 167         builder = addAuthHeader(builder);
 168
 169         for (Entry<String, Object> header : headers.entrySet()) {
 170             builder = builder.header(header.getKey(), header.getValue().toString());
 171         }
 172
 173         PipelineControllerFuture<Response> controller = new PipelineControllerFuture<>();
 174
 175         HttpRequest req = builder.method("DELETE", BodyPublishers.ofString(request)).build();
 176
 177         CompletableFuture<HttpResponse<String>> future = makeHttpClient().sendAsync(req, BodyHandlers.ofString());
 178
 179         // propagate "cancel" to the future
 180         controller.add(future);
 181
 182         future.thenApply(response -> new RestManagerResponse(response.statusCode(), response.body(), getCoder()))
 183                         .whenComplete((resp, thrown) -> {
 184                             if (thrown != null) {
 185                                 callback.failed(thrown);
 186                                 controller.completeExceptionally(thrown);
 187                             } else {
 188                                 callback.completed(resp);
 189                                 controller.complete(resp);
 190                             }
 191                         });
 192
 193         return controller;
 194     }
 195
 196     /**
 197      * Adds the authorization header to the HTTP request, if configured.
 198      *
 199      * @param builder request builder to which the header should be added
 200      * @return the builder
 201      */
 202     protected Builder addAuthHeader(Builder builder) {
 203         // TODO move to HttpOperation
 204         final HttpClient client = getClient();
 205         String username = client.getUserName();
 206         if (StringUtils.isBlank(username)) {
 207             return builder;
 208         }
 209
 210         String password = client.getPassword();
 211         if (password == null) {
 212             password = "";
 213         }
 214
 215         String encoded = username + ":" + password;
 216         encoded = Base64.getEncoder().encodeToString(encoded.getBytes(StandardCharsets.UTF_8));
 217         return builder.header("Authorization", "Basic " + encoded);
 218     }
 219
 220
 221     /**
 222      * Decrements the VF count that's stored in the context, if the request was
 223      * successful.
 224      */
 225     @Override
 226     protected Status detmStatus(Response rawResponse, SoResponse response) {
 227         Status status = super.detmStatus(rawResponse, response);
 228
 229         if (status == Status.SUCCESS) {
 230             setVfCount(getVfCount() - 1);
 231         }
 232
 233         return status;
 234     }
 235
 236     /**
 237      * Makes a request.
 238      *
 239      * @return a pair containing the request URL and the new request
 240      */
 241     protected Pair<String, SoRequest> makeRequest() {
 242         final SoModelInfo soModelInfo = prepareSoModelInfo();
 243         final GenericVnf vnfItem = getVnfItem(soModelInfo);
 244         final ServiceInstance vnfServiceItem = getServiceInstance();
 245         final Tenant tenantItem = getDefaultTenant();
 246         final CloudRegion cloudRegionItem = getDefaultCloudRegion();
 247
 248         SoRequest request = new SoRequest();
 249         request.setOperationType(SoOperationType.DELETE_VF_MODULE);
 250
 251         //
 252         //
 253         // Do NOT send SO the requestId, they do not support this field
 254         //
 255         SoRequestDetails details = new SoRequestDetails();
 256         request.setRequestDetails(details);
 257         details.setRelatedInstanceList(null);
 258         details.setConfigurationParameters(null);
 259
 260         // cloudConfiguration
 261         details.setCloudConfiguration(constructCloudConfigurationCq(tenantItem, cloudRegionItem));
 262
 263         // modelInfo
 264         details.setModelInfo(soModelInfo);
 265
 266         // requestInfo
 267         details.setRequestInfo(constructRequestInfo());
 268
 269         /*
 270          * TODO the legacy SO code always passes null for the last argument, though it
 271          * should be passing the vfModuleInstanceId
 272          */
 273
 274         // compute the path
 275         String path = PATH_PREFIX + vnfServiceItem.getServiceInstanceId() + "/vnfs/" + vnfItem.getVnfId()
 276                         + "/vfModules/null";
 277
 278         return Pair.of(path, request);
 279     }
 280
 281     // these may be overridden by junit tests
 282
 283     protected java.net.http.HttpClient makeHttpClient() {
 284         return java.net.http.HttpClient.newHttpClient();
 285     }
 286 }