mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/WorkflowSpecificationsHandler.java

   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     @Autowired
  67     private ResponseBuilder builder;
  68
  69     @Autowired
  70     private CatalogDbClient catalogDbClient;
  71
  72     private static Logger logger = LoggerFactory.getLogger(WorkflowSpecificationsHandler.class);
  73     private static final String ARTIFACT_TYPE_WORKFLOW = "workflow";
  74     private static final String NATIVE_WORKFLOW = "native";
  75     private static final String EMPTY_BODY = "";
  76
  77     @Path("/{version:[vV]1}/workflows")
  78     @GET
  79     @Operation(description = "Finds Workflow Specifications", responses = @ApiResponse(
  80             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
  81     @Transactional
  82
  83     public Response queryWorkflowSpecifications(@QueryParam("vnfModelVersionId") String vnfModelVersionId,
  84             @QueryParam("pnfModelVersionId") String pnfModelVersionId, @PathParam("version") String version)
  85             throws Exception {
  86         String apiVersion = version.substring(1);
  87
  88         List<Workflow> workflows = new ArrayList<>();
  89         if (vnfModelVersionId == null && pnfModelVersionId == null) {
  90             workflows.addAll(queryWorkflowSpecificationsForAll());
  91         } else {
  92             // 1. query workflow specifications for given vnfModelVersionId if need.
  93             if (vnfModelVersionId != null) {
  94                 List<Workflow> vnfWorkflows = queryWorkflowSpecificationsForVnf(vnfModelVersionId);
  95                 logger.debug("Retrieved " + vnfWorkflows.size() + " workflows for given vnfModelVersionId.");
  96                 if (vnfWorkflows.size() > 0) {
  97                     workflows.addAll(vnfWorkflows);
  98                 }
  99             }
 100
 101             // 2. query workflow specifications for given pnfModelVersionId if need.
 102             if (pnfModelVersionId != null) {
 103                 List<Workflow> pnfWorkflows = queryWorkflowSpecificationsForPnf(pnfModelVersionId);
 104                 logger.debug("Retrieved " + pnfWorkflows.size() + " workflows for given pnfModelVerionId.");
 105                 if (pnfWorkflows.size() > 0) {
 106                     workflows.addAll(pnfWorkflows);
 107                 }
 108             }
 109         }
 110
 111         // Deduplication
 112         List<Workflow> retWorkflows = workflows.stream()
 113                 .collect(Collectors.collectingAndThen(
 114                         Collectors.toCollection(() -> new TreeSet<>(Comparator.comparing(Workflow::getArtifactUUID))),
 115                         ArrayList::new));
 116
 117         Optional<String> optional = getResponseByWorkflowSpec(retWorkflows);
 118         return builder.buildResponse(HttpStatus.SC_OK, "", optional.isPresent() ? optional.get() : EMPTY_BODY,
 119                 apiVersion);
 120     }
 121
 122     @Path("/{version:[vV]1}/pnfWorkflows")
 123     @GET
 124     @Operation(description = "Finds pnf workflow specifications", responses = @ApiResponse(
 125             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
 126     @Transactional
 127     public Response getWorkflowsSpecForPnf(@PathParam("version") String version) throws Exception {
 128
 129         final String pnf_resource = "pnf";
 130         String apiVersion = version.substring(1);
 131
 132         ObjectMapper mapper = new ObjectMapper();
 133         mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
 134
 135         List<Workflow> workflows = catalogDbClient.findWorkflowByResourceTarget(pnf_resource);
 136
 137         Optional<String> optional = getResponseByWorkflowSpec(workflows);
 138         return builder.buildResponse(HttpStatus.SC_OK, "", optional.isPresent() ? optional.get() : EMPTY_BODY,
 139                 apiVersion);
 140     }
 141
 142     protected WorkflowSpecifications mapWorkflowsToWorkflowSpecifications(List<Workflow> workflows) {
 143         if (workflows == null || workflows.isEmpty()) {
 144             return null;
 145         }
 146         WorkflowSpecifications workflowSpecifications = new WorkflowSpecifications();
 147         List<WorkflowSpecificationList> workflowSpecificationList = new ArrayList<>();
 148
 149         for (Workflow workflow : workflows) {
 150             WorkflowSpecificationList workflowSpecificationListItem = new WorkflowSpecificationList();
 151             WorkflowSpecification workflowSpecification = new WorkflowSpecification();
 152             workflowSpecification.setArtifactInfo(buildArtifactInfo(workflow));
 153             workflowSpecification.setActivitySequence(buildActivitySequence(workflow));
 154             workflowSpecification.setWorkflowInputParameters(buildWorkflowInputParameters(workflow));
 155             workflowSpecificationListItem.setWorkflowSpecification(workflowSpecification);
 156             workflowSpecificationList.add(workflowSpecificationListItem);
 157         }
 158         workflowSpecifications.setWorkflowSpecificationList(workflowSpecificationList);
 159         return workflowSpecifications;
 160     }
 161
 162     private Optional<String> getResponseByWorkflowSpec(List<Workflow> workflows) throws ValidateException {
 163         WorkflowSpecifications workflowSpecifications = mapWorkflowsToWorkflowSpecifications(workflows);
 164
 165         try {
 166             ObjectMapper mapper = new ObjectMapper();
 167             return Optional.of(mapper.writeValueAsString(workflowSpecifications));
 168         } catch (JsonProcessingException e) {
 169             catchAndThrowValidationEx(e);
 170         }
 171         return Optional.empty();
 172     }
 173
 174     private Response catchAndThrowValidationEx(JsonProcessingException e) throws ValidateException {
 175         ErrorLoggerInfo errorLoggerInfo =
 176                 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError).build();
 177         ValidateException validateException =
 178                 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
 179                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo)
 180                                 .build();
 181         throw validateException;
 182     }
 183
 184     private ArtifactInfo buildArtifactInfo(Workflow workflow) {
 185         ArtifactInfo artifactInfo = new ArtifactInfo();
 186         artifactInfo.setArtifactType(ARTIFACT_TYPE_WORKFLOW);
 187         artifactInfo.setArtifactUuid(workflow.getArtifactUUID());
 188         artifactInfo.setArtifactName(workflow.getArtifactName());
 189         if (workflow.getVersion() != null) {
 190             artifactInfo.setArtifactVersion(workflow.getVersion().toString());
 191         }
 192         artifactInfo.setArtifactDescription(workflow.getDescription());
 193         artifactInfo.setWorkflowName(workflow.getName());
 194         artifactInfo.setOperationName(workflow.getOperationName());
 195         artifactInfo.setWorkflowSource(workflow.getSource());
 196         artifactInfo.setWorkflowResourceTarget(workflow.getResourceTarget());
 197         return artifactInfo;
 198     }
 199
 200     private List<ActivitySequence> buildActivitySequence(Workflow workflow) {
 201         List<WorkflowActivitySpecSequence> workflowActivitySpecSequences = workflow.getWorkflowActivitySpecSequence();
 202         if (workflowActivitySpecSequences == null || workflowActivitySpecSequences.isEmpty()) {
 203             return null;
 204         }
 205         List<ActivitySequence> activitySequences = new ArrayList<>();
 206         for (WorkflowActivitySpecSequence workflowActivitySpecSequence : workflowActivitySpecSequences) {
 207             if (workflowActivitySpecSequence != null) {
 208                 ActivitySpec activitySpec = workflowActivitySpecSequence.getActivitySpec();
 209                 if (activitySpec != null) {
 210                     ActivitySequence activitySequence = new ActivitySequence();
 211                     activitySequence.setName(activitySpec.getName());
 212                     logger.debug("Adding activity: " + activitySpec.getName());
 213                     activitySequence.setDescription(activitySpec.getDescription());
 214                     activitySequences.add(activitySequence);
 215                 }
 216             }
 217         }
 218         return activitySequences;
 219     }
 220
 221     private List<WorkflowInputParameter> buildWorkflowInputParameters(Workflow workflow) {
 222         List<WorkflowActivitySpecSequence> workflowActivitySpecSequences = workflow.getWorkflowActivitySpecSequence();
 223         if (workflowActivitySpecSequences == null || workflowActivitySpecSequences.isEmpty()) {
 224             return new ArrayList<>();
 225         }
 226         Map<String, WorkflowInputParameter> workflowInputParameterMap = new HashMap<>();
 227         for (WorkflowActivitySpecSequence workflowActivitySpecSequence : workflowActivitySpecSequences) {
 228             if (workflowActivitySpecSequence != null) {
 229                 ActivitySpec activitySpec = workflowActivitySpecSequence.getActivitySpec();
 230                 if (activitySpec != null) {
 231                     List<ActivitySpecUserParameters> activitySpecUserParameters =
 232                             activitySpec.getActivitySpecUserParameters();
 233                     if (activitySpecUserParameters != null && !activitySpecUserParameters.isEmpty()) {
 234                         for (ActivitySpecUserParameters activitySpecUserParameter : activitySpecUserParameters) {
 235                             UserParameters userParameter = activitySpecUserParameter.getUserParameters();
 236                             if (userParameter != null) {
 237                                 WorkflowInputParameter workflowInputParameter =
 238                                         buildWorkflowInputParameter(userParameter);
 239                                 workflowInputParameterMap.put(userParameter.getName(), workflowInputParameter);
 240                             }
 241                         }
 242                     }
 243                 }
 244             }
 245         }
 246
 247         if (workflowInputParameterMap.size() == 0) {
 248             return new ArrayList<>();
 249         }
 250         List<WorkflowInputParameter> workflowInputParameterList =
 251                 workflowInputParameterMap.values().stream().collect(Collectors.toList());
 252         return workflowInputParameterList;
 253     }
 254
 255     private WorkflowInputParameter buildWorkflowInputParameter(UserParameters userParameter) {
 256         WorkflowInputParameter workflowInputParameter = new WorkflowInputParameter();
 257         workflowInputParameter.setLabel(userParameter.getLabel());
 258         workflowInputParameter.setInputType(userParameter.getType());
 259         workflowInputParameter.setRequired(userParameter.getIsRequried());
 260         workflowInputParameter.setSoFieldName(userParameter.getName());
 261         workflowInputParameter.setSoPayloadLocation(userParameter.getPayloadLocation());
 262         workflowInputParameter.setValidation(buildValidationList(userParameter));
 263         return workflowInputParameter;
 264     }
 265
 266     private List<Validation> buildValidationList(UserParameters userParameter) {
 267         List<Validation> validationList = null;
 268         if (userParameter.getMaxLength() != null || userParameter.getAllowableChars() != null) {
 269             validationList = new ArrayList<>();
 270             Validation validation = new Validation();
 271             if (userParameter.getMaxLength() != null) {
 272                 validation.setMaxLength(userParameter.getMaxLength().toString());
 273             }
 274             validation.setAllowableChars(userParameter.getAllowableChars());
 275             validationList.add(validation);
 276         }
 277         return validationList;
 278     }
 279
 280     private List<Workflow> queryWorkflowSpecificationsForAll() {
 281         List<Workflow> workflows = catalogDbClient.findWorkflowBySource(NATIVE_WORKFLOW);
 282         return workflows;
 283     }
 284
 285     private List<Workflow> queryWorkflowSpecificationsForVnf(String vnfModelVersionId) {
 286         List<Workflow> workflows = catalogDbClient.findWorkflowByVnfModelUUID(vnfModelVersionId);
 287
 288         List<Workflow> nativeWorkflows = catalogDbClient.findWorkflowBySource(NATIVE_WORKFLOW);
 289         if (!nativeWorkflows.isEmpty()) {
 290             workflows.addAll(nativeWorkflows);
 291         }
 292         return workflows;
 293     }
 294
 295     private List<Workflow> queryWorkflowSpecificationsForPnf(String pnfModelVersionId) {
 296         List<Workflow> workflows = catalogDbClient.findWorkflowByPnfModelUUID(pnfModelVersionId);
 297         return workflows;
 298     }
 299 }