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 fj.data.Either;
  33 import java.util.Arrays;
  34 import java.util.Collections;
  35 import java.util.LinkedHashMap;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Map.Entry;
  39 import java.util.Optional;
  40 import java.util.UUID;
  41 import java.util.stream.Collectors;
  42 import org.apache.commons.collections.MapUtils;
  43 import org.openecomp.sdc.be.components.impl.ImportUtils.ResultStatusEnum;
  44 import org.openecomp.sdc.be.components.impl.exceptions.ByActionStatusComponentException;
  45 import org.openecomp.sdc.be.dao.api.ActionStatus;
  46 import org.openecomp.sdc.be.datatypes.elements.ArtifactDataDefinition;
  47 import org.openecomp.sdc.be.datatypes.elements.InputDataDefinition;
  48 import org.openecomp.sdc.be.datatypes.elements.ListDataDefinition;
  49 import org.openecomp.sdc.be.datatypes.elements.OperationDataDefinition;
  50 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
  51 import org.openecomp.sdc.be.model.InputDefinition;
  52 import org.openecomp.sdc.be.model.InterfaceDefinition;
  53 import org.openecomp.sdc.be.model.operations.impl.UniqueIdBuilder;
  54 import org.openecomp.sdc.be.tosca.utils.OperationArtifactUtil;
  55 import org.openecomp.sdc.exception.ResponseFormat;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58 import org.springframework.stereotype.Component;
  59
  60 /**
  61  * Handles interface definition TOSCA conversions
  62  */
  63 @Component("interfaceDefinitionHandler")
  64 public class InterfaceDefinitionHandler {
  65
  66     private static final Logger LOGGER = LoggerFactory.getLogger(InterfaceDefinitionHandler.class);
  67     private final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic;
  68
  69     public InterfaceDefinitionHandler(final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic) {
  70         this.interfaceOperationBusinessLogic = interfaceOperationBusinessLogic;
  71     }
  72
  73     /**
  74      * Creates an interface definition based on a TOSCA map representing an interface definition.
  75      *
  76      * @param interfaceDefinitionToscaMap the TOSCA interface definition structure
  77      * @return an interface definition representation
  78      */
  79     public InterfaceDefinition create(final Map<String, Object> interfaceDefinitionToscaMap, final String model) {
  80         final InterfaceDefinition interfaceDefinition = new InterfaceDefinition();
  81         interfaceDefinition.setModel(model);
  82         if (interfaceDefinitionToscaMap.containsKey(TYPE.getElementName())) {
  83             final Object typeObj = interfaceDefinitionToscaMap.get(TYPE.getElementName());
  84             if (!(typeObj instanceof String)) {
  85                 throw new ByActionStatusComponentException(ActionStatus.INVALID_YAML);
  86             }
  87             final String type = (String) typeObj;
  88             interfaceDefinition.setType(type);
  89             interfaceDefinition.setUniqueId(type.toLowerCase());
  90         }
  91         final Map<String, InputDefinition> inputDefinitionMap = handleInputs(interfaceDefinitionToscaMap);
  92         if (!inputDefinitionMap.isEmpty()) {
  93             final Map<String, InputDataDefinition> collect = inputDefinitionMap.entrySet().stream()
  94                 .collect(Collectors.toMap(Entry::getKey, value -> new InputDataDefinition(value.getValue())));
  95             interfaceDefinition.setInputs(collect);
  96         }
  97         final Map<String, OperationDataDefinition> operationMap;
  98         if (interfaceDefinitionToscaMap.containsKey(OPERATIONS.getElementName()) || interfaceDefinitionToscaMap
  99             .containsKey(NOTIFICATIONS.getElementName())) {
 100             operationMap = handleOperations(interfaceDefinitionToscaMap);
 101             //TODO handle notifications
 102         } else {
 103             operationMap = handleLegacyOperations(interfaceDefinitionToscaMap);
 104         }
 105         if (!operationMap.isEmpty()) {
 106             validateOperations(interfaceDefinition.getType(), operationMap, model);
 107             interfaceDefinition.setOperations(operationMap);
 108         }
 109         return interfaceDefinition;
 110     }
 111
 112     private void validateOperations(final String interfaceType, final Map<String, OperationDataDefinition> operationMap, final String model) {
 113         if (MapUtils.isEmpty(operationMap)) {
 114             return;
 115         }
 116         Either<Map<String, InterfaceDefinition>, ResponseFormat> interfaceDefinitionMapEither = interfaceOperationBusinessLogic
 117             .getAllInterfaceLifecycleTypes(model);
 118         if (interfaceDefinitionMapEither.isRight() || MapUtils.isEmpty(interfaceDefinitionMapEither.left().value())) {
 119             throw new ByActionStatusComponentException(ActionStatus.INTERFACE_UNKNOWN, interfaceType);
 120         }
 121         final Map<String, InterfaceDefinition> interfaceDefinitionMap = interfaceDefinitionMapEither.left().value();
 122         final Optional<InterfaceDefinition> interfaceDefinitionOptional = interfaceDefinitionMap.entrySet().stream()
 123             .filter(interfaceDefinitionEntry -> interfaceDefinitionEntry.getKey().equalsIgnoreCase(UniqueIdBuilder.buildInterfaceTypeUid(model, interfaceType))).map(Entry::getValue).findFirst();
 124         if (interfaceDefinitionOptional.isEmpty()) {
 125             throw new ByActionStatusComponentException(ActionStatus.INTERFACE_UNKNOWN, interfaceType);
 126         }
 127         final InterfaceDefinition interfaceDefinition = interfaceDefinitionOptional.get();
 128         operationMap.keySet().forEach(operation1 -> {
 129             if (!interfaceDefinition.hasOperation(operation1)) {
 130                 throw new ByActionStatusComponentException(ActionStatus.INTERFACE_OPERATION_NOT_DEFINED, operation1, interfaceType);
 131             }
 132         });
 133     }
 134
 135     private Map<String, OperationDataDefinition> handleOperations(final Map<String, Object> interfaceDefinitionToscaMap) {
 136         if (!interfaceDefinitionToscaMap.containsKey(OPERATIONS.getElementName())) {
 137             return Collections.emptyMap();
 138         }
 139         final Map<String, Object> operationMap = (Map<String, Object>) interfaceDefinitionToscaMap.get(OPERATIONS.getElementName());
 140         return operationMap.entrySet().stream()
 141             .map(interfaceEntry -> createOperation(interfaceEntry.getKey(), (Map<String, Object>) interfaceEntry.getValue()))
 142             .collect(Collectors.toMap(OperationDataDefinition::getName, operationDataDefinition -> operationDataDefinition));
 143     }
 144
 145     private Map<String, OperationDataDefinition> handleLegacyOperations(final Map<String, Object> interfaceDefinitionToscaMap) {
 146         final List<String> notALegacyOperationEntry = Arrays
 147             .asList(OPERATIONS.getElementName(), TYPE.getElementName(), INPUTS.getElementName(), NOTIFICATIONS.getElementName());
 148         return interfaceDefinitionToscaMap.entrySet().stream().filter(interfaceEntry -> !notALegacyOperationEntry.contains(interfaceEntry.getKey()))
 149             .map(interfaceEntry -> createOperation(interfaceEntry.getKey(), (Map<String, Object>) interfaceEntry.getValue()))
 150             .collect(Collectors.toMap(OperationDataDefinition::getName, operationDataDefinition -> operationDataDefinition));
 151     }
 152
 153     private OperationDataDefinition createOperation(final String operationName, final Map<String, Object> operationDefinitionMap) {
 154         final OperationDataDefinition operation = new OperationDataDefinition();
 155         operation.setUniqueId(UUID.randomUUID().toString());
 156         operation.setName(operationName);
 157         operation.setImplementation(handleOperationImplementation(operationDefinitionMap).orElse(new ArtifactDataDefinition()));
 158         if (operationDefinitionMap.containsKey(INPUTS.getElementName())) {
 159             final Map<String, Object> interfaceInputs = (Map<String, Object>) operationDefinitionMap.get(INPUTS.getElementName());
 160             operation.setInputs(handleInterfaceOperationInputs(interfaceInputs));
 161         }
 162         return operation;
 163     }
 164
 165     private ListDataDefinition<OperationInputDefinition> handleInterfaceOperationInputs(final Map<String, Object> interfaceInputs) {
 166         final ListDataDefinition<OperationInputDefinition> inputs = new ListDataDefinition<>();
 167         for (final Entry<String, Object> interfaceInput : interfaceInputs.entrySet()) {
 168             final OperationInputDefinition operationInput = new OperationInputDefinition();
 169             operationInput.setUniqueId(UUID.randomUUID().toString());
 170             operationInput.setInputId(operationInput.getUniqueId());
 171             operationInput.setName(interfaceInput.getKey());
 172             if (interfaceInput.getValue() instanceof Map) {
 173                 final LinkedHashMap<String, Object> inputPropertyValue = (LinkedHashMap<String, Object>) interfaceInput.getValue();
 174                 LOGGER.info("createModuleInterface: i interfaceInput.getKey() {}, {} , {}  ", interfaceInput.getKey(), inputPropertyValue.keySet(),
 175                     inputPropertyValue.values());
 176                 if (inputPropertyValue.get(TYPE.getElementName()) != null) {
 177                     operationInput.setType(inputPropertyValue.get(TYPE.getElementName()).toString());
 178                 }
 179                 if (inputPropertyValue.get(DESCRIPTION.getElementName()) != null) {
 180                     operationInput.setDescription(inputPropertyValue.get(DESCRIPTION.getElementName()).toString());
 181                 }
 182                 if (inputPropertyValue.get(REQUIRED.getElementName()) != null) {
 183                     operationInput.setRequired(Boolean.getBoolean(inputPropertyValue.get(REQUIRED.getElementName()).toString()));
 184                 }
 185                 if (inputPropertyValue.get(DEFAULT.getElementName()) != null) {
 186                     operationInput.setToscaDefaultValue(inputPropertyValue.get(DEFAULT.getElementName()).toString());
 187                 }
 188                 if (inputPropertyValue.get(STATUS.getElementName()) != null) {
 189                     operationInput.setStatus(inputPropertyValue.get(STATUS.getElementName()).toString());
 190                 }
 191             } else if (interfaceInput.getValue() instanceof String) {
 192                 final String value = (String) interfaceInput.getValue();
 193                 operationInput.setDefaultValue(value);
 194                 operationInput.setToscaDefaultValue(value);
 195                 operationInput.setValue(value);
 196             }
 197             inputs.add(operationInput);
 198         }
 199         return inputs;
 200     }
 201
 202     private Optional<ArtifactDataDefinition> handleOperationImplementation(final Map<String, Object> operationDefinitionMap) {
 203         if (!operationDefinitionMap.containsKey(IMPLEMENTATION.getElementName())) {
 204             return Optional.empty();
 205         }
 206         final ArtifactDataDefinition artifactDataDefinition = new ArtifactDataDefinition();
 207         final String artifactName = (String) operationDefinitionMap.get(IMPLEMENTATION.getElementName());
 208         if (OperationArtifactUtil.artifactNameIsALiteralValue(artifactName)) {
 209             artifactDataDefinition.setArtifactName(artifactName);
 210         } else {
 211             artifactDataDefinition.setArtifactName(QUOTE + artifactName + QUOTE);
 212         }
 213         return Optional.of(artifactDataDefinition);
 214     }
 215
 216     private Map<String, InputDefinition> handleInputs(final Map<String, Object> interfaceDefinitionToscaMap) {
 217         if (!interfaceDefinitionToscaMap.containsKey(INPUTS.getElementName())) {
 218             return Collections.emptyMap();
 219         }
 220         final Either<Map<String, InputDefinition>, ResultStatusEnum> inputMapEither = ImportUtils.getInputs(interfaceDefinitionToscaMap);
 221         if (inputMapEither.isRight()) {
 222             return Collections.emptyMap();
 223         }
 224         return inputMapEither.left().value();
 225     }
 226 }