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