gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Modifications Copyright (c) 2020 Nordix
  10  * ================================================================================
  11  * Licensed under the Apache License, Version 2.0 (the "License");
  12  * you may not use this file except in compliance with the License.
  13  * You may obtain a copy of the License at
  14  *
  15  *      http://www.apache.org/licenses/LICENSE-2.0
  16  *
  17  * Unless required by applicable law or agreed to in writing, software
  18  * distributed under the License is distributed on an "AS IS" BASIS,
  19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20  * See the License for the specific language governing permissions and
  21  * limitations under the License.
  22  * ============LICENSE_END=========================================================
  23  */
  24 package org.onap.so.apihandlerinfra;
  25
  26 import com.fasterxml.jackson.core.JsonProcessingException;
  27 import com.fasterxml.jackson.databind.DeserializationFeature;
  28 import com.fasterxml.jackson.databind.ObjectMapper;
  29 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
  30 import io.swagger.v3.oas.annotations.Operation;
  31 import io.swagger.v3.oas.annotations.info.Info;
  32 import io.swagger.v3.oas.annotations.media.ArraySchema;
  33 import io.swagger.v3.oas.annotations.media.Content;
  34 import io.swagger.v3.oas.annotations.media.Schema;
  35 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  36 import org.apache.http.HttpStatus;
  37 import org.onap.so.apihandler.common.ErrorNumbers;
  38 import org.onap.so.apihandler.common.ResponseBuilder;
  39 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  40 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  41 import org.onap.so.apihandlerinfra.workflowspecificationbeans.*;
  42 import org.onap.so.db.catalog.beans.*;
  43 import org.onap.so.db.catalog.client.CatalogDbClient;
  44 import org.onap.logging.filter.base.ErrorCode;
  45 import org.onap.so.logger.MessageEnum;
  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 javax.transaction.Transactional;
  51 import javax.ws.rs.GET;
  52 import javax.ws.rs.Path;
  53 import javax.ws.rs.PathParam;
  54 import javax.ws.rs.QueryParam;
  55 import javax.ws.rs.core.Response;
  56 import java.util.*;
  57 import java.util.stream.Collectors;
  58
  59
  60 @Path("onap/so/infra/workflowSpecifications")
  61 @OpenAPIDefinition(info = @Info(title = "onap/so/infra/workflowSpecifications",
  62         description = "Queries of Workflow Specifications"))
  63 @Component
  64 public class WorkflowSpecificationsHandler {
  65
  66     private static final ObjectMapper mapper = new ObjectMapper();
  67
  68     @Autowired
  69     private ResponseBuilder builder;
  70
  71     @Autowired
  72     private CatalogDbClient catalogDbClient;
  73
  74     private static Logger logger = LoggerFactory.getLogger(WorkflowSpecificationsHandler.class);
  75     private static final String ARTIFACT_TYPE_WORKFLOW = "workflow";
  76     private static final String NATIVE_WORKFLOW = "native";
  77     private static final String EMPTY_BODY = "";
  78
  79     @Path("/{version:[vV]1}/workflows")
  80     @GET
  81     @Operation(description = "Finds Workflow Specifications", responses = @ApiResponse(
  82             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
  83     @Transactional
  84
  85     public Response queryWorkflowSpecifications(@QueryParam("vnfModelVersionId") String vnfModelVersionId,
  86             @QueryParam("pnfModelVersionId") String pnfModelVersionId,
  87             @QueryParam("resourceTarget") String resourceTarget, @PathParam("version") String version)
  88             throws Exception {
  89         String apiVersion = version.substring(1);
  90
  91         List<Workflow> workflows = new ArrayList<>();
  92         if (vnfModelVersionId == null && pnfModelVersionId == null && resourceTarget == null) {
  93             workflows.addAll(queryWorkflowSpecificationsForAll());
  94         } else {
  95             // 1. query workflow specifications for given vnfModelVersionId if need.
  96             if (vnfModelVersionId != null) {
  97                 List<Workflow> vnfWorkflows = queryWorkflowSpecificationsForVnf(vnfModelVersionId);
  98                 logger.debug("Retrieved " + vnfWorkflows.size() + " workflows for given vnfModelVersionId.");
  99                 if (vnfWorkflows.size() > 0) {
 100                     workflows.addAll(vnfWorkflows);
 101                 }
 102             }
 103
 104             // 2. query workflow specifications for given pnfModelVersionId if need.
 105             if (pnfModelVersionId != null) {
 106                 List<Workflow> pnfWorkflows = queryWorkflowSpecificationsForPnf(pnfModelVersionId);
 107                 logger.debug("Retrieved " + pnfWorkflows.size() + " workflows for given pnfModelVerionId.");
 108                 if (pnfWorkflows.size() > 0) {
 109                     workflows.addAll(pnfWorkflows);
 110                 }
 111             }
 112
 113             // 3. query workflow specifications for given resourceTarget
 114             if (resourceTarget != null) {
 115                 List<Workflow> workflowsForResourceTarget = queryWorkflowsForResourceTarget(resourceTarget);
 116                 logger.debug(
 117                         "Retrieved " + workflowsForResourceTarget.size() + " workflows for given resource target.");
 118                 if (workflowsForResourceTarget.size() > 0) {
 119                     workflows.addAll(workflowsForResourceTarget);
 120                 }
 121             }
 122         }
 123
 124         // Deduplication
 125         List<Workflow> retWorkflows = workflows.stream()
 126                 .collect(Collectors.collectingAndThen(
 127                         Collectors.toCollection(() -> new TreeSet<>(Comparator.comparing(Workflow::getArtifactUUID))),
 128                         ArrayList::new));
 129
 130         Optional<String> optional = getResponseByWorkflowSpec(retWorkflows);
 131         return builder.buildResponse(HttpStatus.SC_OK, "", optional.isPresent() ? optional.get() : EMPTY_BODY,
 132                 apiVersion);
 133     }
 134
 135     /**
 136      * @deprecated As of G release, workflows for all resource types (pnf,vnf,service) can be fetched using
 137      *             /workflowSpecifications/{version:[vV]1}/workflows?resourceTarget={resourceType} API
 138      */
 139     @Path("/{version:[vV]1}/pnfWorkflows")
 140     @GET
 141     @Operation(description = "Finds pnf workflow specifications", responses = @ApiResponse(
 142             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
 143     @Transactional
 144     @Deprecated
 145     public Response getWorkflowsSpecForPnf(@PathParam("version") String version) throws Exception {
 146
 147         final String pnf_resource = "pnf";
 148         String apiVersion = version.substring(1);
 149
 150         List<Workflow> workflows = queryWorkflowsForResourceTarget(pnf_resource);
 151
 152         Optional<String> optional = getResponseByWorkflowSpec(workflows);
 153         return builder.buildResponse(HttpStatus.SC_OK, "", optional.isPresent() ? optional.get() : EMPTY_BODY,
 154                 apiVersion);
 155     }
 156
 157     protected WorkflowSpecifications mapWorkflowsToWorkflowSpecifications(List<Workflow> workflows) {
 158         if (workflows == null || workflows.isEmpty()) {
 159             return null;
 160         }
 161         WorkflowSpecifications workflowSpecifications = new WorkflowSpecifications();
 162         List<WorkflowSpecificationList> workflowSpecificationList = new ArrayList<>();
 163
 164         for (Workflow workflow : workflows) {
 165             WorkflowSpecificationList workflowSpecificationListItem = new WorkflowSpecificationList();
 166             WorkflowSpecification workflowSpecification = new WorkflowSpecification();
 167             workflowSpecification.setArtifactInfo(buildArtifactInfo(workflow));
 168             workflowSpecification.setActivitySequence(buildActivitySequence(workflow));
 169             workflowSpecification.setWorkflowInputParameters(buildWorkflowInputParameters(workflow));
 170             workflowSpecificationListItem.setWorkflowSpecification(workflowSpecification);
 171             workflowSpecificationList.add(workflowSpecificationListItem);
 172         }
 173         workflowSpecifications.setWorkflowSpecificationList(workflowSpecificationList);
 174         return workflowSpecifications;
 175     }
 176
 177     private Optional<String> getResponseByWorkflowSpec(List<Workflow> workflows) throws ValidateException {
 178         WorkflowSpecifications workflowSpecifications = mapWorkflowsToWorkflowSpecifications(workflows);
 179
 180         try {
 181             return Optional.of(mapper.writeValueAsString(workflowSpecifications));
 182         } catch (JsonProcessingException e) {
 183             catchAndThrowValidationEx(e);
 184         }
 185         return Optional.empty();
 186     }
 187
 188     private Response catchAndThrowValidationEx(JsonProcessingException e) throws ValidateException {
 189         ErrorLoggerInfo errorLoggerInfo =
 190                 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError).build();
 191         ValidateException validateException =
 192                 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
 193                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo)
 194                                 .build();
 195         throw validateException;
 196     }
 197
 198     private ArtifactInfo buildArtifactInfo(Workflow workflow) {
 199         ArtifactInfo artifactInfo = new ArtifactInfo();
 200         artifactInfo.setArtifactType(ARTIFACT_TYPE_WORKFLOW);
 201         artifactInfo.setArtifactUuid(workflow.getArtifactUUID());
 202         artifactInfo.setArtifactName(workflow.getArtifactName());
 203         if (workflow.getVersion() != null) {
 204             artifactInfo.setArtifactVersion(workflow.getVersion().toString());
 205         }
 206         artifactInfo.setArtifactDescription(workflow.getDescription());
 207         artifactInfo.setWorkflowName(workflow.getName());
 208         artifactInfo.setOperationName(workflow.getOperationName());
 209         artifactInfo.setWorkflowSource(workflow.getSource());
 210         artifactInfo.setWorkflowResourceTarget(workflow.getResourceTarget());
 211         return artifactInfo;
 212     }
 213
 214     private List<ActivitySequence> buildActivitySequence(Workflow workflow) {
 215         List<WorkflowActivitySpecSequence> workflowActivitySpecSequences = workflow.getWorkflowActivitySpecSequence();
 216         if (workflowActivitySpecSequences == null || workflowActivitySpecSequences.isEmpty()) {
 217             return null;
 218         }
 219         List<ActivitySequence> activitySequences = new ArrayList<>();
 220         for (WorkflowActivitySpecSequence workflowActivitySpecSequence : workflowActivitySpecSequences) {
 221             if (workflowActivitySpecSequence != null) {
 222                 ActivitySpec activitySpec = workflowActivitySpecSequence.getActivitySpec();
 223                 if (activitySpec != null) {
 224                     ActivitySequence activitySequence = new ActivitySequence();
 225                     activitySequence.setName(activitySpec.getName());
 226                     logger.debug("Adding activity: " + activitySpec.getName());
 227                     activitySequence.setDescription(activitySpec.getDescription());
 228                     activitySequences.add(activitySequence);
 229                 }
 230             }
 231         }
 232         return activitySequences;
 233     }
 234
 235     private List<WorkflowInputParameter> buildWorkflowInputParameters(Workflow workflow) {
 236         List<WorkflowActivitySpecSequence> workflowActivitySpecSequences = workflow.getWorkflowActivitySpecSequence();
 237         if (workflowActivitySpecSequences == null || workflowActivitySpecSequences.isEmpty()) {
 238             return new ArrayList<>();
 239         }
 240         Map<String, WorkflowInputParameter> workflowInputParameterMap = new HashMap<>();
 241         for (WorkflowActivitySpecSequence workflowActivitySpecSequence : workflowActivitySpecSequences) {
 242             if (workflowActivitySpecSequence != null) {
 243                 ActivitySpec activitySpec = workflowActivitySpecSequence.getActivitySpec();
 244                 if (activitySpec != null) {
 245                     List<ActivitySpecUserParameters> activitySpecUserParameters =
 246                             activitySpec.getActivitySpecUserParameters();
 247                     if (activitySpecUserParameters != null && !activitySpecUserParameters.isEmpty()) {
 248                         for (ActivitySpecUserParameters activitySpecUserParameter : activitySpecUserParameters) {
 249                             UserParameters userParameter = activitySpecUserParameter.getUserParameters();
 250                             if (userParameter != null) {
 251                                 WorkflowInputParameter workflowInputParameter =
 252                                         buildWorkflowInputParameter(userParameter);
 253                                 workflowInputParameterMap.put(userParameter.getName(), workflowInputParameter);
 254                             }
 255                         }
 256                     }
 257                 }
 258             }
 259         }
 260
 261         if (workflowInputParameterMap.size() == 0) {
 262             return new ArrayList<>();
 263         }
 264         List<WorkflowInputParameter> workflowInputParameterList =
 265                 workflowInputParameterMap.values().stream().collect(Collectors.toList());
 266         return workflowInputParameterList;
 267     }
 268
 269     private WorkflowInputParameter buildWorkflowInputParameter(UserParameters userParameter) {
 270         WorkflowInputParameter workflowInputParameter = new WorkflowInputParameter();
 271         workflowInputParameter.setLabel(userParameter.getLabel());
 272         workflowInputParameter.setInputType(userParameter.getType());
 273         workflowInputParameter.setRequired(userParameter.getIsRequried());
 274         workflowInputParameter.setSoFieldName(userParameter.getName());
 275         workflowInputParameter.setSoPayloadLocation(userParameter.getPayloadLocation());
 276         workflowInputParameter.setValidation(buildValidationList(userParameter));
 277         return workflowInputParameter;
 278     }
 279
 280     private List<Validation> buildValidationList(UserParameters userParameter) {
 281         List<Validation> validationList = null;
 282         if (userParameter.getMaxLength() != null || userParameter.getAllowableChars() != null) {
 283             validationList = new ArrayList<>();
 284             Validation validation = new Validation();
 285             if (userParameter.getMaxLength() != null) {
 286                 validation.setMaxLength(userParameter.getMaxLength().toString());
 287             }
 288             validation.setAllowableChars(userParameter.getAllowableChars());
 289             validationList.add(validation);
 290         }
 291         return validationList;
 292     }
 293
 294     private List<Workflow> queryWorkflowSpecificationsForAll() {
 295         List<Workflow> workflows = catalogDbClient.findWorkflowBySource(NATIVE_WORKFLOW);
 296         return workflows;
 297     }
 298
 299     private List<Workflow> queryWorkflowSpecificationsForVnf(String vnfModelVersionId) {
 300         List<Workflow> workflows = catalogDbClient.findWorkflowByVnfModelUUID(vnfModelVersionId);
 301
 302         List<Workflow> nativeWorkflows = catalogDbClient.findWorkflowBySource(NATIVE_WORKFLOW);
 303         if (!nativeWorkflows.isEmpty()) {
 304             workflows.addAll(nativeWorkflows);
 305         }
 306         return workflows;
 307     }
 308
 309     private List<Workflow> queryWorkflowSpecificationsForPnf(String pnfModelVersionId) {
 310         List<Workflow> workflows = catalogDbClient.findWorkflowByPnfModelUUID(pnfModelVersionId);
 311         return workflows;
 312     }
 313
 314     private List<Workflow> queryWorkflowsForResourceTarget(String resourceTarget) {
 315         List<Workflow> workflows = catalogDbClient.findWorkflowByResourceTarget(resourceTarget);
 316         return workflows;
 317     }
 318
 319
 320 }