catalog-be/src/main/java/org/openecomp/sdc/be/components/impl/InterfaceDefinitionHandler.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19 package org.openecomp.sdc.be.components.impl;
  20
  21 import static org.openecomp.sdc.be.components.impl.ImportUtils.Constants.QUOTE;
  22 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.DEFAULT;
  23 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.DESCRIPTION;
  24 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.IMPLEMENTATION;
  25 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.INPUTS;
  26 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.NOTIFICATIONS;
  27 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.OPERATIONS;
  28 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.REQUIRED;
  29 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.STATUS;
  30 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.TYPE;
  31
  32 import com.google.gson.Gson;
  33 import fj.data.Either;
  34 import java.util.ArrayList;
  35 import java.util.Arrays;
  36 import java.util.Collections;
  37 import java.util.LinkedHashMap;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.Map.Entry;
  41 import java.util.Optional;
  42 import java.util.UUID;
  43 import java.util.stream.Collectors;
  44 import org.apache.commons.collections.MapUtils;
  45 import org.openecomp.sdc.be.components.impl.ImportUtils.ResultStatusEnum;
  46 import org.openecomp.sdc.be.components.impl.exceptions.ByActionStatusComponentException;
  47 import org.openecomp.sdc.be.dao.api.ActionStatus;
  48 import org.openecomp.sdc.be.datatypes.elements.ArtifactDataDefinition;
  49 import org.openecomp.sdc.be.datatypes.elements.InputDataDefinition;
  50 import org.openecomp.sdc.be.datatypes.elements.ListDataDefinition;
  51 import org.openecomp.sdc.be.datatypes.elements.OperationDataDefinition;
  52 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
  53 import org.openecomp.sdc.be.datatypes.elements.PropertyDataDefinition;
  54 import org.openecomp.sdc.be.model.InputDefinition;
  55 import org.openecomp.sdc.be.model.InterfaceDefinition;
  56 import org.openecomp.sdc.be.model.operations.impl.UniqueIdBuilder;
  57 import org.openecomp.sdc.be.model.tosca.ToscaPropertyType;
  58 import org.openecomp.sdc.be.tosca.utils.OperationArtifactUtil;
  59 import org.openecomp.sdc.exception.ResponseFormat;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62 import org.springframework.stereotype.Component;
  63
  64 /**
  65  * Handles interface definition TOSCA conversions
  66  */
  67 @Component("interfaceDefinitionHandler")
  68 public class InterfaceDefinitionHandler {
  69
  70     private static final Logger LOGGER = LoggerFactory.getLogger(InterfaceDefinitionHandler.class);
  71     private static final String WITH_ATTRIBUTE = "with attribute '{}': '{}'";
  72     private final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic;
  73
  74     public InterfaceDefinitionHandler(final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic) {
  75         this.interfaceOperationBusinessLogic = interfaceOperationBusinessLogic;
  76     }
  77
  78     /**
  79      * Creates an interface definition based on a TOSCA map representing an interface definition.
  80      *
  81      * @param interfaceDefinitionToscaMap the TOSCA interface definition structure
  82      * @return an interface definition representation
  83      */
  84     public InterfaceDefinition create(final Map<String, Object> interfaceDefinitionToscaMap, final String model) {
  85         final InterfaceDefinition interfaceDefinition = new InterfaceDefinition();
  86         interfaceDefinition.setModel(model);
  87         if (interfaceDefinitionToscaMap.containsKey(TYPE.getElementName())) {
  88             final Object typeObj = interfaceDefinitionToscaMap.get(TYPE.getElementName());
  89             if (!(typeObj instanceof String)) {
  90                 throw new ByActionStatusComponentException(ActionStatus.INVALID_YAML);
  91             }
  92             final String type = (String) typeObj;
  93             interfaceDefinition.setType(type);
  94             interfaceDefinition.setUniqueId(type);
  95         }
  96         final Map<String, InputDefinition> inputDefinitionMap = handleInputs(interfaceDefinitionToscaMap);
  97         if (!inputDefinitionMap.isEmpty()) {
  98             final Map<String, InputDataDefinition> collect = inputDefinitionMap.entrySet().stream()
  99                 .collect(Collectors.toMap(Entry::getKey, value -> new InputDataDefinition(value.getValue())));
 100             interfaceDefinition.setInputs(collect);
 101         }
 102         final Map<String, OperationDataDefinition> operationMap;
 103         if (interfaceDefinitionToscaMap.containsKey(OPERATIONS.getElementName()) || interfaceDefinitionToscaMap
 104             .containsKey(NOTIFICATIONS.getElementName())) {
 105             operationMap = handleOperations(interfaceDefinitionToscaMap);
 106             //TODO handle notifications
 107         } else {
 108             operationMap = handleLegacyOperations(interfaceDefinitionToscaMap);
 109         }
 110         if (!operationMap.isEmpty()) {
 111             validateOperations(interfaceDefinition.getType(), operationMap, model);
 112             interfaceDefinition.setOperations(operationMap);
 113         }
 114         return interfaceDefinition;
 115     }
 116
 117     private void validateOperations(final String interfaceType, final Map<String, OperationDataDefinition> operationMap, final String model) {
 118         if (MapUtils.isEmpty(operationMap)) {
 119             return;
 120         }
 121         Either<Map<String, InterfaceDefinition>, ResponseFormat> interfaceDefinitionMapEither = interfaceOperationBusinessLogic
 122             .getAllInterfaceLifecycleTypes(model);
 123         if (interfaceDefinitionMapEither.isRight() || MapUtils.isEmpty(interfaceDefinitionMapEither.left().value())) {
 124             throw new ByActionStatusComponentException(ActionStatus.INTERFACE_UNKNOWN, interfaceType);
 125         }
 126         final Map<String, InterfaceDefinition> interfaceDefinitionMap = interfaceDefinitionMapEither.left().value();
 127         final Optional<InterfaceDefinition> interfaceDefinitionOptional = interfaceDefinitionMap.entrySet().stream()
 128             .filter(interfaceDefinitionEntry -> interfaceDefinitionEntry.getKey().equalsIgnoreCase(UniqueIdBuilder.buildInterfaceTypeUid(model, interfaceType))).map(Entry::getValue).findFirst();
 129         if (interfaceDefinitionOptional.isEmpty()) {
 130             throw new ByActionStatusComponentException(ActionStatus.INTERFACE_UNKNOWN, interfaceType);
 131         }
 132         final InterfaceDefinition interfaceDefinition = interfaceDefinitionOptional.get();
 133         operationMap.keySet().forEach(operation1 -> {
 134             if (!interfaceDefinition.hasOperation(operation1)) {
 135                 throw new ByActionStatusComponentException(ActionStatus.INTERFACE_OPERATION_NOT_DEFINED, operation1, interfaceType);
 136             }
 137         });
 138     }
 139
 140     private Map<String, OperationDataDefinition> handleOperations(final Map<String, Object> interfaceDefinitionToscaMap) {
 141         if (!interfaceDefinitionToscaMap.containsKey(OPERATIONS.getElementName())) {
 142             return Collections.emptyMap();
 143         }
 144         final Map<String, Object> operationMap = (Map<String, Object>) interfaceDefinitionToscaMap.get(OPERATIONS.getElementName());
 145         return operationMap.entrySet().stream()
 146             .map(interfaceEntry -> createOperation(interfaceEntry.getKey(), (Map<String, Object>) interfaceEntry.getValue()))
 147             .collect(Collectors.toMap(OperationDataDefinition::getName, operationDataDefinition -> operationDataDefinition));
 148     }
 149
 150     private Map<String, OperationDataDefinition> handleLegacyOperations(final Map<String, Object> interfaceDefinitionToscaMap) {
 151         final List<String> notALegacyOperationEntry = Arrays
 152             .asList(OPERATIONS.getElementName(), TYPE.getElementName(), INPUTS.getElementName(), NOTIFICATIONS.getElementName());
 153         return interfaceDefinitionToscaMap.entrySet().stream().filter(interfaceEntry -> !notALegacyOperationEntry.contains(interfaceEntry.getKey()))
 154             .map(interfaceEntry -> createOperation(interfaceEntry.getKey(), (Map<String, Object>) interfaceEntry.getValue()))
 155             .collect(Collectors.toMap(OperationDataDefinition::getName, operationDataDefinition -> operationDataDefinition));
 156     }
 157
 158     private OperationDataDefinition createOperation(final String operationName, final Map<String, Object> operationDefinitionMap) {
 159         final OperationDataDefinition operation = new OperationDataDefinition();
 160         operation.setUniqueId(UUID.randomUUID().toString());
 161         operation.setName(operationName);
 162         Object operationDescription = operationDefinitionMap.get(
 163                 DESCRIPTION.getElementName()
 164         );
 165         if (null != operationDescription) {
 166             operation.setDescription(operationDescription.toString());
 167         }
 168         operation.setImplementation(handleOperationImplementation(operationDefinitionMap).orElse(new ArtifactDataDefinition()));
 169         if (operationDefinitionMap.containsKey(INPUTS.getElementName())) {
 170             final Map<String, Object> interfaceInputs = (Map<String, Object>) operationDefinitionMap.get(INPUTS.getElementName());
 171             operation.setInputs(handleInterfaceOperationInputs(interfaceInputs));
 172         }
 173         return operation;
 174     }
 175
 176     private ListDataDefinition<OperationInputDefinition> handleInterfaceOperationInputs(final Map<String, Object> interfaceInputs) {
 177         final ListDataDefinition<OperationInputDefinition> inputs = new ListDataDefinition<>();
 178         for (final Entry<String, Object> interfaceInput : interfaceInputs.entrySet()) {
 179             final OperationInputDefinition operationInput = new OperationInputDefinition();
 180             operationInput.setUniqueId(UUID.randomUUID().toString());
 181             operationInput.setInputId(operationInput.getUniqueId());
 182             operationInput.setName(interfaceInput.getKey());
 183             handleInputToscaDefinition(interfaceInput.getKey(), interfaceInput.getValue(), operationInput);
 184             inputs.add(operationInput);
 185         }
 186         return inputs;
 187     }
 188
 189     private void handleInputToscaDefinition(final String inputName, final Object value, final OperationInputDefinition operationInput) {
 190         if (value instanceof Map) {
 191             final LinkedHashMap<String, Object> inputPropertyValue = (LinkedHashMap<String, Object>) value;
 192             LOGGER.debug("Creating interface operation input '{}'", inputName);
 193             if (inputPropertyValue.get(TYPE.getElementName()) != null) {
 194                 final String type = inputPropertyValue.get(TYPE.getElementName()).toString();
 195                 LOGGER.debug(WITH_ATTRIBUTE, TYPE.getElementName(), type);
 196                 operationInput.setType(type);
 197             }
 198             if (inputPropertyValue.get(DESCRIPTION.getElementName()) != null) {
 199                 final String description = inputPropertyValue.get(DESCRIPTION.getElementName()).toString();
 200                 LOGGER.debug(WITH_ATTRIBUTE, DESCRIPTION.getElementName(), description);
 201                 operationInput.setDescription(description);
 202             }
 203             if (inputPropertyValue.get(REQUIRED.getElementName()) != null) {
 204                 final boolean required = Boolean.parseBoolean(inputPropertyValue.get(REQUIRED.getElementName()).toString());
 205                 LOGGER.debug(WITH_ATTRIBUTE, REQUIRED.getElementName(), required);
 206                 operationInput.setRequired(required);
 207             }
 208             if (inputPropertyValue.get(DEFAULT.getElementName()) != null) {
 209                 final Gson gson = new Gson();
 210                 final String json = gson.toJson(inputPropertyValue.get(DEFAULT.getElementName()));
 211                 LOGGER.debug(WITH_ATTRIBUTE, DEFAULT.getElementName(), json);
 212                 operationInput.setToscaDefaultValue(json);
 213             }
 214             if (inputPropertyValue.get(STATUS.getElementName()) != null) {
 215                 final String status = inputPropertyValue.get(STATUS.getElementName()).toString();
 216                 LOGGER.debug(WITH_ATTRIBUTE, STATUS.getElementName(), status);
 217                 operationInput.setStatus(status);
 218             }
 219             return;
 220         }
 221         if (value instanceof String) {
 222             final String stringValue = (String) value;
 223             operationInput.setDefaultValue(stringValue);
 224             operationInput.setToscaDefaultValue(stringValue);
 225             operationInput.setValue(stringValue);
 226         }
 227     }
 228
 229     @SuppressWarnings("unchecked")
 230     private Optional<ArtifactDataDefinition> handleOperationImplementation(final Map<String, Object> operationDefinitionMap) {
 231         if (!operationDefinitionMap.containsKey(IMPLEMENTATION.getElementName())) {
 232             return Optional.empty();
 233         }
 234         final ArtifactDataDefinition artifactDataDefinition = new ArtifactDataDefinition();
 235         if (operationDefinitionMap.get(IMPLEMENTATION.getElementName()) instanceof Map &&
 236                 ((Map)operationDefinitionMap.get(IMPLEMENTATION.getElementName())).containsKey("primary")) {
 237             Map<String, Object> implDetails = (Map) ((Map)operationDefinitionMap.get(IMPLEMENTATION.getElementName())).get("primary");
 238
 239             if (implDetails.get("file") != null) {
 240                 final String file = implDetails.get("file").toString();
 241                 artifactDataDefinition.setArtifactName(generateArtifactName(file));
 242             }
 243             if (implDetails.get("type") != null) {
 244                 artifactDataDefinition.setArtifactType(implDetails.get("type").toString());
 245             }
 246             if (implDetails.get("artifact_version") != null) {
 247                 artifactDataDefinition.setArtifactVersion(implDetails.get("artifact_version").toString());
 248             }
 249
 250             if(implDetails.get("properties") instanceof Map) {
 251                 List<PropertyDataDefinition> operationProperties = artifactDataDefinition.getProperties() == null ? new ArrayList<>() : artifactDataDefinition.getProperties();
 252                 Map<String, Object> properties = (Map<String, Object>) implDetails.get("properties");
 253                 properties.forEach((k,v) -> {
 254                     ToscaPropertyType type = getTypeFromObject(v);
 255                     if (type != null) {
 256                         PropertyDataDefinition propertyDef = new PropertyDataDefinition();
 257                         propertyDef.setName(k);
 258                         propertyDef.setType(type.getType());
 259                         propertyDef.setValue(v.toString());
 260                         artifactDataDefinition.addProperty(propertyDef);
 261                     }
 262                 });
 263             }
 264         }
 265         if (operationDefinitionMap.get(IMPLEMENTATION.getElementName()) instanceof String) {
 266             final String implementation = (String) operationDefinitionMap.get(IMPLEMENTATION.getElementName());
 267             artifactDataDefinition.setArtifactName(generateArtifactName(implementation));
 268         }
 269         return Optional.of(artifactDataDefinition);
 270     }
 271
 272     private String generateArtifactName(final String name) {
 273         if (OperationArtifactUtil.artifactNameIsALiteralValue(name)) {
 274            return name;
 275         } else {
 276             return QUOTE + name + QUOTE;
 277         }
 278     }
 279
 280     private ToscaPropertyType getTypeFromObject(final Object value) {
 281         if (value instanceof String) {
 282             return ToscaPropertyType.STRING;
 283         }
 284         if (value instanceof Integer) {
 285             return ToscaPropertyType.INTEGER;
 286         }
 287         if (value instanceof Boolean) {
 288             return ToscaPropertyType.BOOLEAN;
 289         }
 290         if (value instanceof Float || value instanceof Double) {
 291             return ToscaPropertyType.FLOAT;
 292         }
 293         return null;
 294     }
 295
 296
 297     private Map<String, InputDefinition> handleInputs(final Map<String, Object> interfaceDefinitionToscaMap) {
 298         if (!interfaceDefinitionToscaMap.containsKey(INPUTS.getElementName())) {
 299             return Collections.emptyMap();
 300         }
 301         final Either<Map<String, InputDefinition>, ResultStatusEnum> inputMapEither = ImportUtils.getInputs(interfaceDefinitionToscaMap);
 302         if (inputMapEither.isRight()) {
 303             return Collections.emptyMap();
 304         }
 305         return inputMapEither.left().value();
 306     }
 307 }