2 * Copyright © 2016-2020 European Support Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * 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.
16 package org.openecomp.sdc.be.tosca;
18 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.DEFAULT;
19 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.INPUTS;
20 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.OPERATIONS;
22 import com.fasterxml.jackson.annotation.JsonInclude;
23 import com.fasterxml.jackson.databind.DeserializationFeature;
24 import com.fasterxml.jackson.databind.ObjectMapper;
25 import com.fasterxml.jackson.databind.module.SimpleModule;
26 import com.google.gson.Gson;
27 import java.util.Collections;
28 import java.util.HashMap;
29 import java.util.List;
31 import java.util.Map.Entry;
32 import java.util.Objects;
34 import java.util.stream.Collectors;
35 import org.apache.commons.collections.MapUtils;
36 import org.apache.commons.collections4.CollectionUtils;
37 import org.apache.commons.lang3.StringUtils;
38 import org.apache.commons.lang3.math.NumberUtils;
39 import org.openecomp.sdc.be.datatypes.elements.ArtifactDataDefinition;
40 import org.openecomp.sdc.be.datatypes.elements.InputDataDefinition;
41 import org.openecomp.sdc.be.datatypes.elements.OperationDataDefinition;
42 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
43 import org.openecomp.sdc.be.datatypes.elements.PropertyDataDefinition;
44 import org.openecomp.sdc.be.model.Component;
45 import org.openecomp.sdc.be.model.ComponentInstance;
46 import org.openecomp.sdc.be.model.DataTypeDefinition;
47 import org.openecomp.sdc.be.model.InterfaceDefinition;
48 import org.openecomp.sdc.be.model.Product;
49 import org.openecomp.sdc.be.model.PropertyDefinition;
50 import org.openecomp.sdc.be.tosca.PropertyConvertor.PropertyType;
51 import org.openecomp.sdc.be.tosca.model.ToscaArtifactDefinition;
52 import org.openecomp.sdc.be.tosca.model.ToscaInput;
53 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceDefinition;
54 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceNodeType;
55 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceOperationImplementation;
56 import org.openecomp.sdc.be.tosca.model.ToscaLifecycleOperationDefinition;
57 import org.openecomp.sdc.be.tosca.model.ToscaNodeType;
58 import org.openecomp.sdc.be.tosca.model.ToscaProperty;
59 import org.openecomp.sdc.be.tosca.model.ToscaPropertyAssignment;
60 import org.openecomp.sdc.be.tosca.model.ToscaPropertyAssignmentJsonSerializer;
61 import org.openecomp.sdc.be.tosca.utils.OperationArtifactUtil;
62 import org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum;
63 import org.openecomp.sdc.tosca.datatypes.ToscaFunctions;
64 import org.springframework.beans.factory.annotation.Autowired;
65 import org.springframework.stereotype.Service;
68 public class InterfacesOperationsConverter {
70 public static final String SELF = "SELF";
71 private static final String DERIVED_FROM_STANDARD_INTERFACE = "tosca.interfaces.node.lifecycle.Standard";
72 private static final String DERIVED_FROM_BASE_DEFAULT = "org.openecomp.interfaces.node.lifecycle.";
73 private static final String DEFAULT_HAS_UNDERSCORE = "_default";
74 private static final String DOT = ".";
75 private static final String DEFAULTP = "defaultp";
76 private static final String LOCAL_INTERFACE_TYPE = "Local";
77 private final PropertyConvertor propertyConvertor;
80 public InterfacesOperationsConverter(final PropertyConvertor propertyConvertor) {
81 this.propertyConvertor = propertyConvertor;
85 * Creates the interface_types element.
87 * @param component to work on
88 * @return the added element
90 public Map<String, Object> addInterfaceTypeElement(Component component, List<String> allInterfaceTypes) {
91 if (component instanceof Product) {
94 final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
95 if (MapUtils.isEmpty(interfaces)) {
98 Map<String, Object> toscaInterfaceTypes = new HashMap<>();
99 for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
100 boolean isInterfaceTypeExistInGlobalType = allInterfaceTypes.stream()
101 .anyMatch(type -> type.equalsIgnoreCase(interfaceDefinition.getType()));
102 if (!isInterfaceTypeExistInGlobalType) {
103 ToscaInterfaceNodeType toscaInterfaceType = new ToscaInterfaceNodeType();
104 toscaInterfaceType.setDerived_from(DERIVED_FROM_STANDARD_INTERFACE);
105 final Map<String, OperationDataDefinition> operations = interfaceDefinition.getOperations();
106 Map<String, Object> toscaOperations = new HashMap<>();
107 for (Map.Entry<String, OperationDataDefinition> operationEntry : operations.entrySet()) {
108 toscaOperations.put(operationEntry.getValue().getName(), null);
110 toscaInterfaceType.setOperations(toscaOperations);
111 Map<String, Object> interfacesAsMap = getObjectAsMap(toscaInterfaceType);
112 Map<String, Object> operationsMap = (Map<String, Object>) interfacesAsMap.remove(OPERATIONS.getElementName());
113 interfacesAsMap.putAll(operationsMap);
114 toscaInterfaceTypes.put(getInterfaceType(component, LOCAL_INTERFACE_TYPE), interfacesAsMap);
117 return MapUtils.isNotEmpty(toscaInterfaceTypes) ? toscaInterfaceTypes : null;
120 private static Object getDefaultValue(Map<String, Object> inputValueMap) {
121 Object defaultValue = null;
122 for (Map.Entry<String, Object> operationEntry : inputValueMap.entrySet()) {
123 final Object value = operationEntry.getValue();
124 if (value instanceof Map) {
125 getDefaultValue((Map<String, Object>) value);
127 final String key = operationEntry.getKey();
128 if (key.equals(DEFAULTP)) {
129 defaultValue = inputValueMap.remove(key);
135 //Remove input type and copy default value directly into the proxy node template from the node type
136 private static void handleOperationInputValue(Map<String, Object> operationsMap, String parentKey) {
137 for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
138 final Object value = operationEntry.getValue();
139 final String key = operationEntry.getKey();
140 if (value instanceof Map) {
141 if (INPUTS.getElementName().equals(parentKey)) {
142 Object defaultValue = getDefaultValue((Map<String, Object>) value);
143 operationsMap.put(key, defaultValue);
145 handleOperationInputValue((Map<String, Object>) value, key);
151 private static String getLastPartOfName(String toscaResourceName) {
152 return toscaResourceName.substring(toscaResourceName.lastIndexOf(DOT) + 1);
155 private boolean isArtifactPresent(final OperationDataDefinition operationDataDefinition) {
156 return operationDataDefinition.getImplementation() != null
157 && StringUtils.isNotEmpty(operationDataDefinition.getImplementation().getArtifactName());
160 private static String getInputValue(final OperationInputDefinition input) {
161 String inputValue = input.getValue() == null ? input.getToscaDefaultValue() : input.getValue();
162 if (inputValue != null && inputValue.contains(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName())) {
163 Gson gson = new Gson();
164 Map<String, List<String>> consumptionValue = gson.fromJson(inputValue, Map.class);
165 List<String> mappedOutputValue = consumptionValue.get(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName());
166 //Extract the interface name from the interface type
167 String interfaceType = mappedOutputValue.get(1);
168 String interfaceName = interfaceType.substring(interfaceType.lastIndexOf('.') + 1);
169 mappedOutputValue.remove(1);
170 mappedOutputValue.add(1, interfaceName);
171 inputValue = gson.toJson(consumptionValue);
176 private static String getInterfaceType(Component component, String interfaceType) {
177 if (LOCAL_INTERFACE_TYPE.equals(interfaceType)) {
178 return DERIVED_FROM_BASE_DEFAULT + component.getComponentMetadataDefinition().getMetadataDataDefinition().getSystemName();
180 return interfaceType;
183 private static Map<String, Object> getObjectAsMap(final Object obj) {
184 final Map<String, Object> objectAsMap;
185 if (obj instanceof Map) {
186 objectAsMap = (Map<String, Object>) obj;
188 final ObjectMapper objectMapper = new ObjectMapper();
189 final SimpleModule module = new SimpleModule("ToscaPropertyAssignmentSerializer");
190 module.addSerializer(ToscaPropertyAssignment.class, new ToscaPropertyAssignmentJsonSerializer());
191 objectMapper.registerModule(module);
192 if (obj instanceof ToscaInterfaceDefinition) {
193 //Prevent empty field serialization in interface definition
194 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
196 objectAsMap = objectMapper.convertValue(obj, Map.class);
199 final String defaultEntry = DEFAULT.getElementName();
200 if (objectAsMap.containsKey(defaultEntry)) {
201 objectAsMap.put(DEFAULT_HAS_UNDERSCORE, objectAsMap.remove(defaultEntry));
207 * Adds the 'interfaces' element to the node type provided.
209 * @param component to work on
210 * @param nodeType to which the interfaces element will be added
212 public void addInterfaceDefinitionElement(Component component, ToscaNodeType nodeType, Map<String, DataTypeDefinition> dataTypes,
213 boolean isAssociatedComponent) {
214 if (component instanceof Product) {
217 final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
218 if (MapUtils.isEmpty(interfaces)) {
221 Map<String, Object> toscaInterfaceDefinitions = getInterfacesMap(component, dataTypes, isAssociatedComponent);
222 if (MapUtils.isNotEmpty(toscaInterfaceDefinitions)) {
223 nodeType.setInterfaces(toscaInterfaceDefinitions);
227 private Map<String, Object> getInterfacesMap(Component component, Map<String, DataTypeDefinition> dataTypes, boolean isAssociatedComponent) {
228 return getInterfacesMap(component, null, component.getInterfaces(), dataTypes, isAssociatedComponent);
231 public Map<String, Object> getInterfacesMap(final Component component, final ComponentInstance componentInstance,
232 final Map<String, InterfaceDefinition> interfaces, final Map<String, DataTypeDefinition> dataTypes,
233 final boolean isAssociatedComponent) {
234 if (MapUtils.isEmpty(interfaces)) {
237 final Map<String, Object> toscaInterfaceDefinitions = new HashMap<>();
238 for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
239 handleInterfaceOperations(component, componentInstance, dataTypes, isAssociatedComponent,
240 toscaInterfaceDefinitions, interfaceDefinition);
242 return toscaInterfaceDefinitions;
245 public Map<String, Object> getInterfacesMapFromComponentInstance(final Component component, final ComponentInstance componentInstance,
246 final Map<String, DataTypeDefinition> dataTypes,
247 final boolean isAssociatedComponent) {
248 final Map<String, Object> toscaInterfaceDefinitions = new HashMap<>();
249 final ObjectMapper objectMapper = new ObjectMapper();
250 objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
251 for (final Map.Entry<String, Object> interfaceEntry : componentInstance.getInterfaces().entrySet()) {
252 final InterfaceDefinition interfaceDefinition = objectMapper.convertValue(interfaceEntry.getValue(), InterfaceDefinition.class);
253 handleInterfaceOperations(component, componentInstance, dataTypes, isAssociatedComponent,
254 toscaInterfaceDefinitions, interfaceDefinition);
256 return toscaInterfaceDefinitions;
259 private void handleInterfaceOperations(final Component component, final ComponentInstance componentInstance,
260 final Map<String, DataTypeDefinition> dataTypes, final boolean isAssociatedComponent,
261 final Map<String, Object> toscaInterfaceDefinitions,
262 final InterfaceDefinition interfaceDefinition) {
263 final String interfaceType;
264 if (componentInstance != null && LOCAL_INTERFACE_TYPE.equals(interfaceDefinition.getType())) {
265 interfaceType = DERIVED_FROM_BASE_DEFAULT + componentInstance.getSourceModelName();
267 interfaceType = getInterfaceType(component, interfaceDefinition.getType());
269 final ToscaInterfaceDefinition toscaInterfaceDefinition = new ToscaInterfaceDefinition();
270 if (componentInstance == null) {
271 toscaInterfaceDefinition.setType(interfaceType);
273 final Map<String, OperationDataDefinition> operations = interfaceDefinition.getOperations();
274 final Map<String, Object> toscaOperationMap = new HashMap<>();
275 for (final Entry<String, OperationDataDefinition> operationEntry : operations.entrySet()) {
276 if (operationHasAnImplementation(operationEntry.getValue())) {
277 final ToscaLifecycleOperationDefinition toscaLifecycleOperationDefinition = new ToscaLifecycleOperationDefinition();
278 handleInterfaceOperationImplementation(component, componentInstance, isAssociatedComponent, operationEntry.getValue(),
279 toscaLifecycleOperationDefinition, dataTypes);
280 if (StringUtils.isNotEmpty(operationEntry.getValue().getDescription())) {
281 toscaLifecycleOperationDefinition.setDescription(operationEntry.getValue().getDescription());
283 fillToscaOperationInputs(operationEntry.getValue(), dataTypes, toscaLifecycleOperationDefinition);
284 toscaOperationMap.put(operationEntry.getValue().getName(), toscaLifecycleOperationDefinition);
287 toscaInterfaceDefinition.setOperations(toscaOperationMap);
288 final Map<String, Object> interfaceInputMap = createInterfaceInputMap(interfaceDefinition, dataTypes);
289 if (MapUtils.isNotEmpty(interfaceInputMap)) {
290 toscaInterfaceDefinition.setInputs(interfaceInputMap);
292 final Map<String, Object> interfaceDefinitionAsMap = getObjectAsMap(toscaInterfaceDefinition);
293 if (interfaceDefinitionAsMap.containsKey(INPUTS.getElementName())) {
294 handleDefaults((Map<String, Object>) interfaceDefinitionAsMap.get(INPUTS.getElementName()));
296 final Map<String, Object> operationsMap = (Map<String, Object>) interfaceDefinitionAsMap.remove(OPERATIONS.getElementName());
297 handleOperationInputValue(operationsMap, interfaceType);
298 interfaceDefinitionAsMap.putAll(operationsMap);
299 toscaInterfaceDefinitions.put(getLastPartOfName(interfaceType), interfaceDefinitionAsMap);
302 private boolean operationHasAnImplementation(OperationDataDefinition operation) {
303 return operation.getImplementation() != null && StringUtils.isNotEmpty(operation.getImplementation().getArtifactName()) && !operation.getImplementation().getArtifactName().equals("''");
306 private void handleInterfaceOperationImplementation(final Component component, final ComponentInstance componentInstance,
307 final boolean isAssociatedComponent,
308 final OperationDataDefinition operationDataDefinition,
309 final ToscaLifecycleOperationDefinition toscaOperation,
310 final Map<String, DataTypeDefinition> dataTypes) {
311 final ArtifactDataDefinition implementation = operationDataDefinition.getImplementation();
312 if (implementation == null) {
316 if (isArtifactPresent(operationDataDefinition)) {
317 final String operationArtifactPath =
318 OperationArtifactUtil.createOperationArtifactPath(component, componentInstance, operationDataDefinition, isAssociatedComponent);
319 if (implementation.getArtifactType() != null) {
320 final ToscaArtifactDefinition toscaArtifactDefinition = new ToscaArtifactDefinition();
321 toscaArtifactDefinition.setFile(operationArtifactPath);
322 final String artifactVersion = implementation.getArtifactVersion();
323 toscaArtifactDefinition.setArtifact_version(!artifactVersion.equals(NumberUtils.INTEGER_ZERO.toString()) ? artifactVersion : null);
324 toscaArtifactDefinition.setType(implementation.getArtifactType());
325 final Map<String, ToscaPropertyAssignment> propertiesMap = handleImplementationProperties(operationDataDefinition, dataTypes);
326 if (MapUtils.isNotEmpty(propertiesMap)) {
327 toscaArtifactDefinition.setProperties(propertiesMap);
329 final ToscaInterfaceOperationImplementation toscaInterfaceOperationImplementation = new ToscaInterfaceOperationImplementation();
330 toscaInterfaceOperationImplementation.setPrimary(toscaArtifactDefinition);
331 toscaOperation.setImplementation(toscaInterfaceOperationImplementation);
333 toscaOperation.setImplementation(
334 StringUtils.isBlank(operationArtifactPath) || "null".equals(operationArtifactPath) ? null : operationArtifactPath);
339 private Map<String, ToscaPropertyAssignment> handleImplementationProperties(final OperationDataDefinition operationDataDefinition,
340 final Map<String, DataTypeDefinition> dataTypes) {
341 if (operationDataDefinition.getImplementation() == null) {
342 return new HashMap<>();
345 final List<PropertyDataDefinition> properties = operationDataDefinition.getImplementation().getProperties();
346 if (CollectionUtils.isEmpty(properties)) {
347 return new HashMap<>();
350 final Map<String, ToscaPropertyAssignment> propertiesMap = new HashMap<>();
352 .filter(propertyDataDefinition -> StringUtils.isNotEmpty(propertyDataDefinition.getValue()))
353 .forEach(propertyDataDefinition -> {
354 final String propertyValue =
355 propertyDataDefinition.getValue() != null ? propertyDataDefinition.getValue() : propertyDataDefinition.getDefaultValue();
356 final ToscaPropertyAssignment toscaPropertyAssignment = new ToscaPropertyAssignment();
357 toscaPropertyAssignment.setValue(propertyConvertor.convertToToscaObject(propertyDataDefinition, propertyValue, dataTypes, false));
358 propertiesMap.put(propertyDataDefinition.getName(), toscaPropertyAssignment);
362 return propertiesMap;
365 public void removeInterfacesWithoutOperations(final Map<String, Object> interfaceMap) {
366 if (MapUtils.isEmpty(interfaceMap)) {
369 final Set<String> emptyInterfaces = interfaceMap.entrySet().stream().filter(entry -> {
370 final Object value = entry.getValue();
371 if (value instanceof ToscaInterfaceDefinition) {
372 final ToscaInterfaceDefinition interfaceDefinition = (ToscaInterfaceDefinition) value;
373 return MapUtils.isEmpty(interfaceDefinition.getOperations());
374 } else if (value instanceof Map) {
375 final Map<String, Object> interfaceDefMap = (Map<String, Object>) value;
376 return MapUtils.isEmpty(interfaceDefMap);
379 }).map(Entry::getKey).collect(Collectors.toSet());
380 emptyInterfaces.forEach(interfaceMap::remove);
383 private Map<String, Object> createInterfaceInputMap(final InterfaceDefinition interfaceDefinition,
384 final Map<String, DataTypeDefinition> allDataTypeMap) {
385 final Map<String, InputDataDefinition> inputMap = interfaceDefinition.getInputs();
386 if (MapUtils.isEmpty(inputMap)) {
387 return Collections.emptyMap();
389 final Map<String, Object> toscaInterfaceInputMap = new HashMap<>();
390 for (final Entry<String, InputDataDefinition> inputEntry : inputMap.entrySet()) {
391 final InputDataDefinition inputDataDefinition = inputEntry.getValue();
392 final ToscaProperty toscaProperty = propertyConvertor
393 .convertProperty(allDataTypeMap, new PropertyDefinition(inputDataDefinition), PropertyType.INPUT);
394 toscaInterfaceInputMap.put(inputEntry.getKey(), new ToscaInput(toscaProperty));
396 return toscaInterfaceInputMap;
400 * workaround for : currently "defaultp" is not being converted to "default" by the relevant code in
401 * ToscaExportHandler so, any string Map key named "defaultp" will have its named changed to "default"
402 * @param operationsMap the map to update
404 private void handleDefaults(Map<String, Object> operationsMap) {
405 for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
406 final Object value = operationEntry.getValue();
407 if (value instanceof Map) {
408 handleDefaults((Map<String, Object>) value);
410 final String key = operationEntry.getKey();
411 if (key.equals(DEFAULTP)) {
412 Object removed = operationsMap.remove(key);
413 operationsMap.put(ToscaTagNamesEnum.DEFAULT.getElementName(), removed);
418 private void fillToscaOperationInputs(OperationDataDefinition operation, Map<String, DataTypeDefinition> dataTypes,
419 ToscaLifecycleOperationDefinition toscaOperation) {
420 if (Objects.isNull(operation.getInputs()) || operation.getInputs().isEmpty()) {
421 toscaOperation.setInputs(null);
424 Map<String, ToscaProperty> toscaInputs = new HashMap<>();
425 for (OperationInputDefinition input : operation.getInputs().getListToscaDataDefinition()) {
426 ToscaProperty toscaInput = new ToscaProperty();
427 toscaInput.setDescription(input.getDescription());
428 toscaInput.setType(input.getType());
429 toscaInput.setRequired(input.isRequired());
430 toscaInput.setDefaultp(propertyConvertor.convertToToscaObject(input, getInputValue(input), dataTypes, false));
431 toscaInputs.put(input.getName(), toscaInput);
433 toscaOperation.setInputs(toscaInputs);