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.
17 package org.openecomp.sdc.be.tosca;
19 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.DEFAULT;
20 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.INPUTS;
21 import static org.openecomp.sdc.be.utils.TypeUtils.ToscaTagNamesEnum.OPERATIONS;
23 import com.fasterxml.jackson.annotation.JsonInclude;
24 import com.fasterxml.jackson.databind.DeserializationFeature;
25 import com.fasterxml.jackson.databind.ObjectMapper;
26 import com.fasterxml.jackson.databind.module.SimpleModule;
27 import com.google.gson.Gson;
28 import java.util.Collections;
29 import java.util.HashMap;
30 import java.util.List;
32 import java.util.Map.Entry;
33 import java.util.Objects;
35 import java.util.stream.Collectors;
36 import org.apache.commons.collections.MapUtils;
37 import org.apache.commons.collections4.CollectionUtils;
38 import org.apache.commons.lang3.StringUtils;
39 import org.apache.commons.lang3.math.NumberUtils;
40 import org.openecomp.sdc.be.datatypes.elements.ArtifactDataDefinition;
41 import org.openecomp.sdc.be.datatypes.elements.InputDataDefinition;
42 import org.openecomp.sdc.be.datatypes.elements.OperationDataDefinition;
43 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
44 import org.openecomp.sdc.be.datatypes.elements.PropertyDataDefinition;
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;
69 public class InterfacesOperationsConverter {
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;
81 public InterfacesOperationsConverter(final PropertyConvertor propertyConvertor) {
82 this.propertyConvertor = propertyConvertor;
85 private static Object getDefaultValue(Map<String, Object> inputValueMap) {
86 Object defaultValue = null;
87 for (Map.Entry<String, Object> operationEntry : inputValueMap.entrySet()) {
88 final Object value = operationEntry.getValue();
89 if (value instanceof Map) {
90 getDefaultValue((Map<String, Object>) value);
92 final String key = operationEntry.getKey();
93 if (key.equals(DEFAULTP)) {
94 defaultValue = inputValueMap.remove(key);
100 //Remove input type and copy default value directly into the proxy node template from the node type
101 private static void handleOperationInputValue(Map<String, Object> operationsMap, String parentKey) {
102 for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
103 final Object value = operationEntry.getValue();
104 final String key = operationEntry.getKey();
105 if (value instanceof Map) {
106 if (INPUTS.getElementName().equals(parentKey)) {
107 Object defaultValue = getDefaultValue((Map<String, Object>) value);
108 operationsMap.put(key, defaultValue);
110 handleOperationInputValue((Map<String, Object>) value, key);
116 private static String getLastPartOfName(String toscaResourceName) {
117 return toscaResourceName.substring(toscaResourceName.lastIndexOf(DOT) + 1);
120 private static String getInputValue(final OperationInputDefinition input) {
121 if (null != input.getToscaFunction()) {
122 return input.getToscaFunction().getJsonObjectValue().toString();
124 String inputValue = input.getValue() == null ? input.getToscaDefaultValue() : input.getValue();
125 if (inputValue != null && inputValue.contains(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName())) {
126 Gson gson = new Gson();
127 Map<String, List<String>> consumptionValue = gson.fromJson(inputValue, Map.class);
128 List<String> mappedOutputValue = consumptionValue.get(ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName());
129 //Extract the interface name from the interface type
130 String interfaceType = mappedOutputValue.get(1);
131 String interfaceName = interfaceType.substring(interfaceType.lastIndexOf('.') + 1);
132 mappedOutputValue.remove(1);
133 mappedOutputValue.add(1, interfaceName);
134 inputValue = gson.toJson(consumptionValue);
139 private static String getInterfaceType(Component component, String interfaceType) {
140 if (LOCAL_INTERFACE_TYPE.equals(interfaceType)) {
141 return DERIVED_FROM_BASE_DEFAULT + component.getComponentMetadataDefinition().getMetadataDataDefinition().getSystemName();
143 return interfaceType;
146 private static Map<String, Object> getObjectAsMap(final Object obj) {
147 final Map<String, Object> objectAsMap;
148 if (obj instanceof Map) {
149 objectAsMap = (Map<String, Object>) obj;
151 final ObjectMapper objectMapper = new ObjectMapper();
152 final SimpleModule module = new SimpleModule("ToscaPropertyAssignmentSerializer");
153 module.addSerializer(ToscaPropertyAssignment.class, new ToscaPropertyAssignmentJsonSerializer());
154 objectMapper.registerModule(module);
155 if (obj instanceof ToscaInterfaceDefinition) {
156 //Prevent empty field serialization in interface definition
157 objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
159 objectAsMap = objectMapper.convertValue(obj, Map.class);
162 final String defaultEntry = DEFAULT.getElementName();
163 if (objectAsMap.containsKey(defaultEntry)) {
164 objectAsMap.put(DEFAULT_HAS_UNDERSCORE, objectAsMap.remove(defaultEntry));
170 * Creates the interface_types element.
172 * @param component to work on
173 * @return the added element
175 public Map<String, Object> addInterfaceTypeElement(Component component, List<String> allInterfaceTypes) {
176 if (component instanceof Product) {
179 final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
180 if (MapUtils.isEmpty(interfaces)) {
183 Map<String, Object> toscaInterfaceTypes = new HashMap<>();
184 for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
185 boolean isInterfaceTypeExistInGlobalType = allInterfaceTypes.stream()
186 .anyMatch(type -> type.equalsIgnoreCase(interfaceDefinition.getType()));
187 if (!isInterfaceTypeExistInGlobalType) {
188 ToscaInterfaceNodeType toscaInterfaceType = new ToscaInterfaceNodeType();
189 toscaInterfaceType.setDerived_from(DERIVED_FROM_STANDARD_INTERFACE);
190 final Map<String, OperationDataDefinition> operations = interfaceDefinition.getOperations();
191 Map<String, Object> toscaOperations = new HashMap<>();
192 for (Map.Entry<String, OperationDataDefinition> operationEntry : operations.entrySet()) {
193 toscaOperations.put(operationEntry.getValue().getName(), null);
195 toscaInterfaceType.setOperations(toscaOperations);
196 Map<String, Object> interfacesAsMap = getObjectAsMap(toscaInterfaceType);
197 Map<String, Object> operationsMap = (Map<String, Object>) interfacesAsMap.remove(OPERATIONS.getElementName());
198 interfacesAsMap.putAll(operationsMap);
199 toscaInterfaceTypes.put(getInterfaceType(component, LOCAL_INTERFACE_TYPE), interfacesAsMap);
202 return MapUtils.isNotEmpty(toscaInterfaceTypes) ? toscaInterfaceTypes : null;
205 private boolean isArtifactPresent(final OperationDataDefinition operationDataDefinition) {
206 return operationDataDefinition.getImplementation() != null
207 && StringUtils.isNotEmpty(operationDataDefinition.getImplementation().getArtifactName());
211 * Adds the 'interfaces' element to the node type provided.
213 * @param component to work on
214 * @param nodeType to which the interfaces element will be added
216 public void addInterfaceDefinitionElement(Component component, ToscaNodeType nodeType, Map<String, DataTypeDefinition> dataTypes,
217 boolean isAssociatedComponent) {
218 if (component instanceof Product) {
221 final Map<String, InterfaceDefinition> interfaces = component.getInterfaces();
222 if (MapUtils.isEmpty(interfaces)) {
225 Map<String, Object> toscaInterfaceDefinitions = getInterfacesMap(component, dataTypes, isAssociatedComponent);
226 if (MapUtils.isNotEmpty(toscaInterfaceDefinitions)) {
227 nodeType.setInterfaces(toscaInterfaceDefinitions);
231 private Map<String, Object> getInterfacesMap(Component component, Map<String, DataTypeDefinition> dataTypes, boolean isAssociatedComponent) {
232 return getInterfacesMap(component, null, component.getInterfaces(), dataTypes, isAssociatedComponent);
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)) {
241 final Map<String, Object> toscaInterfaceDefinitions = new HashMap<>();
242 for (InterfaceDefinition interfaceDefinition : interfaces.values()) {
243 handleInterfaceOperations(component, componentInstance, dataTypes, isAssociatedComponent,
244 toscaInterfaceDefinitions, interfaceDefinition);
246 return toscaInterfaceDefinitions;
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);
260 return toscaInterfaceDefinitions;
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();
271 interfaceType = getInterfaceType(component, interfaceDefinition.getType());
273 final ToscaInterfaceDefinition toscaInterfaceDefinition = new ToscaInterfaceDefinition();
274 if (componentInstance == null) {
275 toscaInterfaceDefinition.setType(interfaceType);
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());
287 fillToscaOperationInputs(operationEntry.getValue(), dataTypes, toscaLifecycleOperationDefinition);
288 toscaOperationMap.put(operationEntry.getValue().getName(), toscaLifecycleOperationDefinition);
291 toscaInterfaceDefinition.setOperations(toscaOperationMap);
292 final Map<String, Object> interfaceInputMap = createInterfaceInputMap(interfaceDefinition, dataTypes);
293 if (MapUtils.isNotEmpty(interfaceInputMap)) {
294 toscaInterfaceDefinition.setInputs(interfaceInputMap);
296 final Map<String, Object> interfaceDefinitionAsMap = getObjectAsMap(toscaInterfaceDefinition);
297 if (interfaceDefinitionAsMap.containsKey(INPUTS.getElementName())) {
298 handleDefaults((Map<String, Object>) interfaceDefinitionAsMap.get(INPUTS.getElementName()));
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);
306 private boolean operationHasAnImplementation(OperationDataDefinition operation) {
307 return operation.getImplementation() != null && StringUtils.isNotEmpty(operation.getImplementation().getArtifactName()) &&
308 !operation.getImplementation().getArtifactName().equals("''");
311 private void handleInterfaceOperationImplementation(final Component component, final ComponentInstance componentInstance,
312 final boolean isAssociatedComponent,
313 final OperationDataDefinition operationDataDefinition,
314 final ToscaLifecycleOperationDefinition toscaOperation,
315 final Map<String, DataTypeDefinition> dataTypes) {
316 final ArtifactDataDefinition implementation = operationDataDefinition.getImplementation();
317 if (implementation == null) {
321 if (isArtifactPresent(operationDataDefinition)) {
322 final String operationArtifactPath =
323 OperationArtifactUtil.createOperationArtifactPath(component, componentInstance, operationDataDefinition, isAssociatedComponent);
324 if (implementation.getArtifactType() != null) {
325 final ToscaArtifactDefinition toscaArtifactDefinition = new ToscaArtifactDefinition();
326 toscaArtifactDefinition.setFile(operationArtifactPath);
327 final String artifactVersion = implementation.getArtifactVersion();
328 toscaArtifactDefinition.setArtifact_version(!artifactVersion.equals(NumberUtils.INTEGER_ZERO.toString()) ? artifactVersion : null);
329 toscaArtifactDefinition.setType(implementation.getArtifactType());
330 final Map<String, ToscaPropertyAssignment> propertiesMap = handleImplementationProperties(operationDataDefinition, dataTypes);
331 if (MapUtils.isNotEmpty(propertiesMap)) {
332 toscaArtifactDefinition.setProperties(propertiesMap);
334 final ToscaInterfaceOperationImplementation toscaInterfaceOperationImplementation = new ToscaInterfaceOperationImplementation();
335 toscaInterfaceOperationImplementation.setPrimary(toscaArtifactDefinition);
336 toscaOperation.setImplementation(toscaInterfaceOperationImplementation);
338 toscaOperation.setImplementation(
339 StringUtils.isBlank(operationArtifactPath) || "null".equals(operationArtifactPath) ? null : operationArtifactPath);
344 private Map<String, ToscaPropertyAssignment> handleImplementationProperties(final OperationDataDefinition operationDataDefinition,
345 final Map<String, DataTypeDefinition> dataTypes) {
346 if (operationDataDefinition.getImplementation() == null) {
347 return new HashMap<>();
350 final List<PropertyDataDefinition> properties = operationDataDefinition.getImplementation().getProperties();
351 if (CollectionUtils.isEmpty(properties)) {
352 return new HashMap<>();
355 final Map<String, ToscaPropertyAssignment> propertiesMap = new HashMap<>();
357 .filter(propertyDataDefinition -> StringUtils.isNotEmpty(propertyDataDefinition.getValue()))
358 .forEach(propertyDataDefinition -> {
359 final String propertyValue =
360 propertyDataDefinition.getValue() != null ? propertyDataDefinition.getValue() : propertyDataDefinition.getDefaultValue();
361 final ToscaPropertyAssignment toscaPropertyAssignment = new ToscaPropertyAssignment();
362 toscaPropertyAssignment.setValue(propertyConvertor.convertToToscaObject(propertyDataDefinition, propertyValue, dataTypes, false));
363 propertiesMap.put(propertyDataDefinition.getName(), toscaPropertyAssignment);
367 return propertiesMap;
370 public void removeInterfacesWithoutOperations(final Map<String, Object> interfaceMap) {
371 if (MapUtils.isEmpty(interfaceMap)) {
374 final Set<String> emptyInterfaces = interfaceMap.entrySet().stream().filter(entry -> {
375 final Object value = entry.getValue();
376 if (value instanceof ToscaInterfaceDefinition) {
377 final ToscaInterfaceDefinition interfaceDefinition = (ToscaInterfaceDefinition) value;
378 return MapUtils.isEmpty(interfaceDefinition.getOperations());
379 } else if (value instanceof Map) {
380 final Map<String, Object> interfaceDefMap = (Map<String, Object>) value;
381 return MapUtils.isEmpty(interfaceDefMap);
384 }).map(Entry::getKey).collect(Collectors.toSet());
385 emptyInterfaces.forEach(interfaceMap::remove);
388 private Map<String, Object> createInterfaceInputMap(final InterfaceDefinition interfaceDefinition,
389 final Map<String, DataTypeDefinition> allDataTypeMap) {
390 final Map<String, InputDataDefinition> inputMap = interfaceDefinition.getInputs();
391 if (MapUtils.isEmpty(inputMap)) {
392 return Collections.emptyMap();
394 final Map<String, Object> toscaInterfaceInputMap = new HashMap<>();
395 for (final Entry<String, InputDataDefinition> inputEntry : inputMap.entrySet()) {
396 final InputDataDefinition inputDataDefinition = inputEntry.getValue();
397 final ToscaProperty toscaProperty = propertyConvertor
398 .convertProperty(allDataTypeMap, new PropertyDefinition(inputDataDefinition), PropertyType.INPUT);
399 toscaInterfaceInputMap.put(inputEntry.getKey(), new ToscaInput(toscaProperty));
401 return toscaInterfaceInputMap;
405 * workaround for : currently "defaultp" is not being converted to "default" by the relevant code in
406 * ToscaExportHandler so, any string Map key named "defaultp" will have its named changed to "default"
407 * @param operationsMap the map to update
409 private void handleDefaults(Map<String, Object> operationsMap) {
410 for (Map.Entry<String, Object> operationEntry : operationsMap.entrySet()) {
411 final Object value = operationEntry.getValue();
412 if (value instanceof Map) {
413 handleDefaults((Map<String, Object>) value);
415 final String key = operationEntry.getKey();
416 if (key.equals(DEFAULTP)) {
417 Object removed = operationsMap.remove(key);
418 operationsMap.put(ToscaTagNamesEnum.DEFAULT.getElementName(), removed);
423 private void fillToscaOperationInputs(OperationDataDefinition operation, Map<String, DataTypeDefinition> dataTypes,
424 ToscaLifecycleOperationDefinition toscaOperation) {
425 if (Objects.isNull(operation.getInputs()) || operation.getInputs().isEmpty()) {
426 toscaOperation.setInputs(null);
429 Map<String, ToscaProperty> toscaInputs = new HashMap<>();
430 for (OperationInputDefinition input : operation.getInputs().getListToscaDataDefinition()) {
431 ToscaProperty toscaInput = new ToscaProperty();
432 toscaInput.setDescription(input.getDescription());
433 toscaInput.setType(input.getType());
434 toscaInput.setRequired(input.isRequired());
435 toscaInput.setDefaultp(propertyConvertor.convertToToscaObject(input, getInputValue(input), dataTypes, false));
436 toscaInputs.put(input.getName(), toscaInput);
438 toscaOperation.setInputs(toscaInputs);