8f5f2714071ffe51e2b3691fa3dc4cd0f27fbdbf
[sdc.git] / catalog-be / src / main / java / org / openecomp / sdc / be / tosca / InterfacesOperationsConverter.java
1 /*
2  * Copyright © 2016-2020 European Support Limited
3  *
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
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
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 package org.openecomp.sdc.be.tosca;
17
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;
21
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;
30 import java.util.Map;
31 import java.util.Map.Entry;
32 import java.util.Objects;
33 import java.util.Set;
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.datatypes.elements.ToscaGetFunctionDataDefinition;
45 import org.openecomp.sdc.be.model.Component;
46 import org.openecomp.sdc.be.model.ComponentInstance;
47 import org.openecomp.sdc.be.model.DataTypeDefinition;
48 import org.openecomp.sdc.be.model.InterfaceDefinition;
49 import org.openecomp.sdc.be.model.Product;
50 import org.openecomp.sdc.be.model.PropertyDefinition;
51 import org.openecomp.sdc.be.tosca.PropertyConvertor.PropertyType;
52 import org.openecomp.sdc.be.tosca.model.ToscaArtifactDefinition;
53 import org.openecomp.sdc.be.tosca.model.ToscaInput;
54 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceDefinition;
55 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceNodeType;
56 import org.openecomp.sdc.be.tosca.model.ToscaInterfaceOperationImplementation;
57 import org.openecomp.sdc.be.tosca.model.ToscaLifecycleOperationDefinition;
58 import org.openecomp.sdc.be.tosca.model.ToscaNodeType;
59 import org.openecomp.sdc.be.tosca.model.ToscaProperty;
60 import org.openecomp.sdc.be.tosca.model.ToscaPropertyAssignment;
61 import org.openecomp.sdc.be.tosca.model.ToscaPropertyAssignmentJsonSerializer;
62 import org.openecomp.sdc.be.tosca.utils.OperationArtifactUtil;
63 import org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum;
64 import org.openecomp.sdc.tosca.datatypes.ToscaFunctions;
65 import org.springframework.beans.factory.annotation.Autowired;
66 import org.springframework.stereotype.Service;
67
68 @Service
69 public class InterfacesOperationsConverter {
70
71     public static final String SELF = "SELF";
72     private static final String DERIVED_FROM_STANDARD_INTERFACE = "tosca.interfaces.node.lifecycle.Standard";
73     private static final String DERIVED_FROM_BASE_DEFAULT = "org.openecomp.interfaces.node.lifecycle.";
74     private static final String DEFAULT_HAS_UNDERSCORE = "_default";
75     private static final String DOT = ".";
76     private static final String DEFAULTP = "defaultp";
77     private static final String LOCAL_INTERFACE_TYPE = "Local";
78     private final PropertyConvertor propertyConvertor;
79
80     @Autowired
81     public InterfacesOperationsConverter(final PropertyConvertor propertyConvertor) {
82         this.propertyConvertor = propertyConvertor;
83     }
84
85     /**
86      * Creates the interface_types element.
87      *
88      * @param component to work on
89      * @return the added element
90      */
91     public Map<String, Object> addInterfaceTypeElement(Component component, List<String> allInterfaceTypes) {
92         if (component instanceof Product) {
93             return null;
94         }
95         final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
96         if (MapUtils.isEmpty(interfaces)) {
97             return null;
98         }
99         Map<String, Object> toscaInterfaceTypes = new HashMap<>();
100         for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
101             boolean isInterfaceTypeExistInGlobalType = allInterfaceTypes.stream()
102                 .anyMatch(type -> type.equalsIgnoreCase(interfaceDefinition.getType()));
103             if (!isInterfaceTypeExistInGlobalType) {
104                 ToscaInterfaceNodeType toscaInterfaceType = new ToscaInterfaceNodeType();
105                 toscaInterfaceType.setDerived_from(DERIVED_FROM_STANDARD_INTERFACE);
106                 final Map<String, OperationDataDefinition> operations = interfaceDefinition.getOperations();
107                 Map<String, Object> toscaOperations = new HashMap<>();
108                 for (Map.Entry<String, OperationDataDefinition> operationEntry : operations.entrySet()) {
109                     toscaOperations.put(operationEntry.getValue().getName(), null);
110                 }
111                 toscaInterfaceType.setOperations(toscaOperations);
112                 Map<String, Object> interfacesAsMap = getObjectAsMap(toscaInterfaceType);
113                 Map<String, Object> operationsMap = (Map<String, Object>) interfacesAsMap.remove(OPERATIONS.getElementName());
114                 interfacesAsMap.putAll(operationsMap);
115                 toscaInterfaceTypes.put(getInterfaceType(component, LOCAL_INTERFACE_TYPE), interfacesAsMap);
116             }
117         }
118         return MapUtils.isNotEmpty(toscaInterfaceTypes) ? toscaInterfaceTypes : null;
119     }
120
121     private static Object getDefaultValue(Map<String, Object> inputValueMap) {
122         Object defaultValue = null;
123         for (Map.Entry<String, Object> operationEntry : inputValueMap.entrySet()) {
124             final Object value = operationEntry.getValue();
125             if (value instanceof Map) {
126                 getDefaultValue((Map<String, Object>) value);
127             }
128             final String key = operationEntry.getKey();
129             if (key.equals(DEFAULTP)) {
130                 defaultValue = inputValueMap.remove(key);
131             }
132         }
133         return defaultValue;
134     }
135
136     //Remove input type and copy default value directly into the proxy node template from the node type
137     private static void handleOperationInputValue(Map<String, Object> operationsMap, String parentKey) {
138         for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
139             final Object value = operationEntry.getValue();
140             final String key = operationEntry.getKey();
141             if (value instanceof Map) {
142                 if (INPUTS.getElementName().equals(parentKey)) {
143                     Object defaultValue = getDefaultValue((Map<String, Object>) value);
144                     operationsMap.put(key, defaultValue);
145                 } else {
146                     handleOperationInputValue((Map<String, Object>) value, key);
147                 }
148             }
149         }
150     }
151
152     private static String getLastPartOfName(String toscaResourceName) {
153         return toscaResourceName.substring(toscaResourceName.lastIndexOf(DOT) + 1);
154     }
155
156     private boolean isArtifactPresent(final OperationDataDefinition operationDataDefinition) {
157         return operationDataDefinition.getImplementation() != null
158             && StringUtils.isNotEmpty(operationDataDefinition.getImplementation().getArtifactName());
159     }
160
161     private static String getInputValue(final OperationInputDefinition input) {
162         if (null != input.getToscaFunction()) {
163             return input.getToscaFunction().getJsonObjectValue().toString();
164         }
165         String inputValue = input.getValue() == null ? input.getToscaDefaultValue() : input.getValue();
166         if (inputValue != null && inputValue.contains(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName())) {
167             Gson gson = new Gson();
168             Map<String, List<String>> consumptionValue = gson.fromJson(inputValue, Map.class);
169             List<String> mappedOutputValue = consumptionValue.get(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName());
170             //Extract the interface name from the interface type
171             String interfaceType = mappedOutputValue.get(1);
172             String interfaceName = interfaceType.substring(interfaceType.lastIndexOf('.') + 1);
173             mappedOutputValue.remove(1);
174             mappedOutputValue.add(1, interfaceName);
175             inputValue = gson.toJson(consumptionValue);
176         }
177         return inputValue;
178     }
179
180     private static String getInterfaceType(Component component, String interfaceType) {
181         if (LOCAL_INTERFACE_TYPE.equals(interfaceType)) {
182             return DERIVED_FROM_BASE_DEFAULT + component.getComponentMetadataDefinition().getMetadataDataDefinition().getSystemName();
183         }
184         return interfaceType;
185     }
186
187     private static Map<String, Object> getObjectAsMap(final Object obj) {
188         final Map<String, Object> objectAsMap;
189         if (obj instanceof Map) {
190             objectAsMap = (Map<String, Object>) obj;
191         } else {
192             final ObjectMapper objectMapper = new ObjectMapper();
193             final SimpleModule module = new SimpleModule("ToscaPropertyAssignmentSerializer");
194             module.addSerializer(ToscaPropertyAssignment.class, new ToscaPropertyAssignmentJsonSerializer());
195             objectMapper.registerModule(module);
196             if (obj instanceof ToscaInterfaceDefinition) {
197                 //Prevent empty field serialization in interface definition
198                 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
199             }
200             objectAsMap = objectMapper.convertValue(obj, Map.class);
201         }
202
203         final String defaultEntry = DEFAULT.getElementName();
204         if (objectAsMap.containsKey(defaultEntry)) {
205             objectAsMap.put(DEFAULT_HAS_UNDERSCORE, objectAsMap.remove(defaultEntry));
206         }
207         return objectAsMap;
208     }
209
210     /**
211      * Adds the 'interfaces' element to the node type provided.
212      *
213      * @param component to work on
214      * @param nodeType  to which the interfaces element will be added
215      */
216     public void addInterfaceDefinitionElement(Component component, ToscaNodeType nodeType, Map<String, DataTypeDefinition> dataTypes,
217                                               boolean isAssociatedComponent) {
218         if (component instanceof Product) {
219             return;
220         }
221         final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
222         if (MapUtils.isEmpty(interfaces)) {
223             return;
224         }
225         Map<String, Object> toscaInterfaceDefinitions = getInterfacesMap(component, dataTypes, isAssociatedComponent);
226         if (MapUtils.isNotEmpty(toscaInterfaceDefinitions)) {
227             nodeType.setInterfaces(toscaInterfaceDefinitions);
228         }
229     }
230
231     private Map<String, Object> getInterfacesMap(Component component, Map<String, DataTypeDefinition> dataTypes, boolean isAssociatedComponent) {
232         return getInterfacesMap(component, null, component.getInterfaces(), dataTypes, isAssociatedComponent);
233     }
234
235     public Map<String, Object> getInterfacesMap(final Component component, final ComponentInstance componentInstance,
236                                                 final Map<String, InterfaceDefinition> interfaces, final Map<String, DataTypeDefinition> dataTypes,
237                                                 final boolean isAssociatedComponent) {
238         if (MapUtils.isEmpty(interfaces)) {
239             return null;
240         }
241         final Map<String, Object> toscaInterfaceDefinitions = new HashMap<>();
242         for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
243             handleInterfaceOperations(component, componentInstance, dataTypes, isAssociatedComponent,
244                 toscaInterfaceDefinitions, interfaceDefinition);
245         }
246         return toscaInterfaceDefinitions;
247     }
248
249     public Map<String, Object> getInterfacesMapFromComponentInstance(final Component component, final ComponentInstance componentInstance,
250                                                                      final Map<String, DataTypeDefinition> dataTypes,
251                                                                      final boolean isAssociatedComponent) {
252         final Map<String, Object> toscaInterfaceDefinitions = new HashMap<>();
253         final ObjectMapper objectMapper = new ObjectMapper();
254         objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
255         for (final Map.Entry<String, Object> interfaceEntry : componentInstance.getInterfaces().entrySet()) {
256             final InterfaceDefinition interfaceDefinition = objectMapper.convertValue(interfaceEntry.getValue(), InterfaceDefinition.class);
257             handleInterfaceOperations(component, componentInstance, dataTypes, isAssociatedComponent,
258                 toscaInterfaceDefinitions, interfaceDefinition);
259         }
260         return toscaInterfaceDefinitions;
261     }
262
263     private void handleInterfaceOperations(final Component component, final ComponentInstance componentInstance,
264                                            final Map<String, DataTypeDefinition> dataTypes, final boolean isAssociatedComponent,
265                                            final Map<String, Object> toscaInterfaceDefinitions,
266                                            final InterfaceDefinition interfaceDefinition) {
267         final String interfaceType;
268         if (componentInstance != null && LOCAL_INTERFACE_TYPE.equals(interfaceDefinition.getType())) {
269             interfaceType = DERIVED_FROM_BASE_DEFAULT + componentInstance.getSourceModelName();
270         } else {
271             interfaceType = getInterfaceType(component, interfaceDefinition.getType());
272         }
273         final ToscaInterfaceDefinition toscaInterfaceDefinition = new ToscaInterfaceDefinition();
274         if (componentInstance == null) {
275             toscaInterfaceDefinition.setType(interfaceType);
276         }
277         final Map<String, OperationDataDefinition> operations = interfaceDefinition.getOperations();
278         final Map<String, Object> toscaOperationMap = new HashMap<>();
279         for (final Entry<String, OperationDataDefinition> operationEntry : operations.entrySet()) {
280             if (operationHasAnImplementation(operationEntry.getValue())) {
281                 final ToscaLifecycleOperationDefinition toscaLifecycleOperationDefinition = new ToscaLifecycleOperationDefinition();
282                 handleInterfaceOperationImplementation(component, componentInstance, isAssociatedComponent, operationEntry.getValue(),
283                     toscaLifecycleOperationDefinition, dataTypes);
284                 if (StringUtils.isNotEmpty(operationEntry.getValue().getDescription())) {
285                     toscaLifecycleOperationDefinition.setDescription(operationEntry.getValue().getDescription());
286                 }
287                 fillToscaOperationInputs(operationEntry.getValue(), dataTypes, toscaLifecycleOperationDefinition);
288                 toscaOperationMap.put(operationEntry.getValue().getName(), toscaLifecycleOperationDefinition);
289             }
290         }
291         toscaInterfaceDefinition.setOperations(toscaOperationMap);
292         final Map<String, Object> interfaceInputMap = createInterfaceInputMap(interfaceDefinition, dataTypes);
293         if (MapUtils.isNotEmpty(interfaceInputMap)) {
294             toscaInterfaceDefinition.setInputs(interfaceInputMap);
295         }
296         final Map<String, Object> interfaceDefinitionAsMap = getObjectAsMap(toscaInterfaceDefinition);
297         if (interfaceDefinitionAsMap.containsKey(INPUTS.getElementName())) {
298             handleDefaults((Map<String, Object>) interfaceDefinitionAsMap.get(INPUTS.getElementName()));
299         }
300         final Map<String, Object> operationsMap = (Map<String, Object>) interfaceDefinitionAsMap.remove(OPERATIONS.getElementName());
301         handleOperationInputValue(operationsMap, interfaceType);
302         interfaceDefinitionAsMap.putAll(operationsMap);
303         toscaInterfaceDefinitions.put(getLastPartOfName(interfaceType), interfaceDefinitionAsMap);
304     }
305     
306     private boolean operationHasAnImplementation(OperationDataDefinition operation) {
307         return operation.getImplementation() != null && StringUtils.isNotEmpty(operation.getImplementation().getArtifactName()) && !operation.getImplementation().getArtifactName().equals("''");
308     }
309
310     private void handleInterfaceOperationImplementation(final Component component, final ComponentInstance componentInstance,
311                                                         final boolean isAssociatedComponent,
312                                                         final OperationDataDefinition operationDataDefinition,
313                                                         final ToscaLifecycleOperationDefinition toscaOperation,
314                                                         final Map<String, DataTypeDefinition> dataTypes) {
315         final ArtifactDataDefinition implementation = operationDataDefinition.getImplementation();
316         if (implementation == null) {
317             return;
318         }
319
320         if (isArtifactPresent(operationDataDefinition)) {
321             final String operationArtifactPath =
322                 OperationArtifactUtil.createOperationArtifactPath(component, componentInstance, operationDataDefinition, isAssociatedComponent);
323             if (implementation.getArtifactType() != null) {
324                 final ToscaArtifactDefinition toscaArtifactDefinition = new ToscaArtifactDefinition();
325                 toscaArtifactDefinition.setFile(operationArtifactPath);
326                 final String artifactVersion = implementation.getArtifactVersion();
327                 toscaArtifactDefinition.setArtifact_version(!artifactVersion.equals(NumberUtils.INTEGER_ZERO.toString()) ? artifactVersion : null);
328                 toscaArtifactDefinition.setType(implementation.getArtifactType());
329                 final Map<String, ToscaPropertyAssignment> propertiesMap = handleImplementationProperties(operationDataDefinition, dataTypes);
330                 if (MapUtils.isNotEmpty(propertiesMap)) {
331                     toscaArtifactDefinition.setProperties(propertiesMap);
332                 }
333                 final ToscaInterfaceOperationImplementation toscaInterfaceOperationImplementation = new ToscaInterfaceOperationImplementation();
334                 toscaInterfaceOperationImplementation.setPrimary(toscaArtifactDefinition);
335                 toscaOperation.setImplementation(toscaInterfaceOperationImplementation);
336             } else {
337                 toscaOperation.setImplementation(
338                     StringUtils.isBlank(operationArtifactPath) || "null".equals(operationArtifactPath) ? null : operationArtifactPath);
339             }
340         }
341     }
342
343     private Map<String, ToscaPropertyAssignment> handleImplementationProperties(final OperationDataDefinition operationDataDefinition,
344                                                                                 final Map<String, DataTypeDefinition> dataTypes) {
345         if (operationDataDefinition.getImplementation() == null) {
346             return new HashMap<>();
347         }
348
349         final List<PropertyDataDefinition> properties = operationDataDefinition.getImplementation().getProperties();
350         if (CollectionUtils.isEmpty(properties)) {
351             return new HashMap<>();
352         }
353
354         final Map<String, ToscaPropertyAssignment> propertiesMap = new HashMap<>();
355         properties.stream()
356             .filter(propertyDataDefinition -> StringUtils.isNotEmpty(propertyDataDefinition.getValue()))
357             .forEach(propertyDataDefinition -> {
358                     final String propertyValue =
359                         propertyDataDefinition.getValue() != null ? propertyDataDefinition.getValue() : propertyDataDefinition.getDefaultValue();
360                     final ToscaPropertyAssignment toscaPropertyAssignment = new ToscaPropertyAssignment();
361                     toscaPropertyAssignment.setValue(propertyConvertor.convertToToscaObject(propertyDataDefinition, propertyValue, dataTypes, false));
362                     propertiesMap.put(propertyDataDefinition.getName(), toscaPropertyAssignment);
363                 }
364             );
365
366         return propertiesMap;
367     }
368
369     public void removeInterfacesWithoutOperations(final Map<String, Object> interfaceMap) {
370         if (MapUtils.isEmpty(interfaceMap)) {
371             return;
372         }
373         final Set<String> emptyInterfaces = interfaceMap.entrySet().stream().filter(entry -> {
374             final Object value = entry.getValue();
375             if (value instanceof ToscaInterfaceDefinition) {
376                 final ToscaInterfaceDefinition interfaceDefinition = (ToscaInterfaceDefinition) value;
377                 return MapUtils.isEmpty(interfaceDefinition.getOperations());
378             } else if (value instanceof Map) {
379                 final Map<String, Object> interfaceDefMap = (Map<String, Object>) value;
380                 return MapUtils.isEmpty(interfaceDefMap);
381             }
382             return false;
383         }).map(Entry::getKey).collect(Collectors.toSet());
384         emptyInterfaces.forEach(interfaceMap::remove);
385     }
386
387     private Map<String, Object> createInterfaceInputMap(final InterfaceDefinition interfaceDefinition,
388                                                         final Map<String, DataTypeDefinition> allDataTypeMap) {
389         final Map<String, InputDataDefinition> inputMap = interfaceDefinition.getInputs();
390         if (MapUtils.isEmpty(inputMap)) {
391             return Collections.emptyMap();
392         }
393         final Map<String, Object> toscaInterfaceInputMap = new HashMap<>();
394         for (final Entry<String, InputDataDefinition> inputEntry : inputMap.entrySet()) {
395             final InputDataDefinition inputDataDefinition = inputEntry.getValue();
396             final ToscaProperty toscaProperty = propertyConvertor
397                 .convertProperty(allDataTypeMap, new PropertyDefinition(inputDataDefinition), PropertyType.INPUT);
398             toscaInterfaceInputMap.put(inputEntry.getKey(), new ToscaInput(toscaProperty));
399         }
400         return toscaInterfaceInputMap;
401     }
402
403     /*
404      * workaround for : currently "defaultp" is not being converted to "default" by the relevant code in
405      * ToscaExportHandler so, any string Map key named "defaultp" will have its named changed to "default"
406      * @param operationsMap the map to update
407      */
408     private void handleDefaults(Map<String, Object> operationsMap) {
409         for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
410             final Object value = operationEntry.getValue();
411             if (value instanceof Map) {
412                 handleDefaults((Map<String, Object>) value);
413             }
414             final String key = operationEntry.getKey();
415             if (key.equals(DEFAULTP)) {
416                 Object removed = operationsMap.remove(key);
417                 operationsMap.put(ToscaTagNamesEnum.DEFAULT.getElementName(), removed);
418             }
419         }
420     }
421
422     private void fillToscaOperationInputs(OperationDataDefinition operation, Map<String, DataTypeDefinition> dataTypes,
423                                           ToscaLifecycleOperationDefinition toscaOperation) {
424         if (Objects.isNull(operation.getInputs()) || operation.getInputs().isEmpty()) {
425             toscaOperation.setInputs(null);
426             return;
427         }
428         Map<String, ToscaProperty> toscaInputs = new HashMap<>();
429         for (OperationInputDefinition input : operation.getInputs().getListToscaDataDefinition()) {
430             ToscaProperty toscaInput = new ToscaProperty();
431             toscaInput.setDescription(input.getDescription());
432             toscaInput.setType(input.getType());
433             toscaInput.setRequired(input.isRequired());
434             toscaInput.setDefaultp(propertyConvertor.convertToToscaObject(input, getInputValue(input), dataTypes, false));
435             toscaInputs.put(input.getName(), toscaInput);
436         }
437         toscaOperation.setInputs(toscaInputs);
438     }
439
440 }