2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017-2018 European Software Marketing Ltd.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.onap.aai.babel.parser;
25 import java.io.FileInputStream;
26 import java.io.IOException;
27 import java.util.ArrayList;
28 import java.util.HashMap;
29 import java.util.LinkedList;
30 import java.util.List;
32 import java.util.Optional;
33 import java.util.Properties;
34 import java.util.stream.Collectors;
35 import java.util.stream.Stream;
36 import org.onap.aai.babel.logging.ApplicationMsgs;
37 import org.onap.aai.babel.logging.LogHelper;
38 import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
39 import org.onap.aai.babel.xml.generator.model.AllotedResource;
40 import org.onap.aai.babel.xml.generator.model.InstanceGroup;
41 import org.onap.aai.babel.xml.generator.model.L3NetworkWidget;
42 import org.onap.aai.babel.xml.generator.model.Model;
43 import org.onap.aai.babel.xml.generator.model.ProvidingService;
44 import org.onap.aai.babel.xml.generator.model.Resource;
45 import org.onap.aai.babel.xml.generator.model.Service;
46 import org.onap.aai.babel.xml.generator.model.TunnelXconnectWidget;
47 import org.onap.aai.babel.xml.generator.model.VfModule;
48 import org.onap.aai.babel.xml.generator.model.Widget;
49 import org.onap.aai.babel.xml.generator.types.ModelType;
50 import org.onap.aai.cl.api.Logger;
51 import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
52 import org.onap.sdc.toscaparser.api.Group;
53 import org.onap.sdc.toscaparser.api.NodeTemplate;
54 import org.onap.sdc.toscaparser.api.Property;
55 import org.onap.sdc.toscaparser.api.elements.Metadata;
57 public class ArtifactGeneratorToscaParser {
59 private static Logger log = LogHelper.INSTANCE;
61 public static final String PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE = "artifactgenerator.config";
62 public static final String PROPERTY_GROUP_FILTERS_CONFIG_FILE = "groupfilter.config";
64 private static final String GENERATOR_AAI_CONFIGFILE_NOT_FOUND = "Cannot generate artifacts. Artifact Generator Configuration file not found at %s";
65 private static final String GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND = "Cannot generate artifacts. System property %s not configured";
66 private static final String GENERATOR_AAI_PROVIDING_SERVICE_METADATA_MISSING = "Cannot generate artifacts. Providing Service Metadata is missing for allotted resource %s";
67 private static final String GENERATOR_AAI_PROVIDING_SERVICE_MISSING = "Cannot generate artifacts. Providing Service is missing for allotted resource %s";
69 // Metadata properties
70 private static final String CATEGORY = "category";
71 private static final String ALLOTTED_RESOURCE = "Allotted Resource";
72 private static final String SUBCATEGORY = "subcategory";
73 private static final String TUNNEL_XCONNECT = "Tunnel XConnect";
75 private static final String VERSION = "version";
77 private ISdcCsarHelper csarHelper;
80 * Constructs using csarHelper
85 public ArtifactGeneratorToscaParser(ISdcCsarHelper csarHelper) {
86 this.csarHelper = csarHelper;
90 * Returns the artifact description
94 * @return the artifact model's description
96 public static String getArtifactDescription(Model model) {
97 String artifactDesc = model.getModelDescription();
98 if (model.getModelType().equals(ModelType.SERVICE)) {
99 artifactDesc = "AAI Service Model";
100 } else if (model.getModelType().equals(ModelType.RESOURCE)) {
101 artifactDesc = "AAI Resource Model";
107 * Initialises the widget configuration.
109 * @throws IOException
111 public static void initWidgetConfiguration() throws IOException {
112 log.debug("Getting Widget Configuration");
113 String configLocation = System.getProperty(PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE);
114 if (configLocation != null) {
115 File file = new File(configLocation);
117 Properties properties = new Properties();
118 properties.load(new FileInputStream(file));
119 WidgetConfigurationUtil.setConfig(properties);
121 throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGFILE_NOT_FOUND, configLocation));
124 throw new IllegalArgumentException(
125 String.format(GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND, PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE));
130 * Initialises the group filter configuration.
132 * @throws IOException
134 public static void initGroupFilterConfiguration() throws IOException {
135 log.debug("Getting Filter Tyoes Configuration");
136 String configLocation = System.getProperty(PROPERTY_GROUP_FILTERS_CONFIG_FILE);
137 if (configLocation != null) {
138 File file = new File(configLocation);
140 Properties properties = new Properties();
141 properties.load(new FileInputStream(file));
142 WidgetConfigurationUtil.setFilterConfig(properties);
144 throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGFILE_NOT_FOUND, configLocation));
147 throw new IllegalArgumentException(
148 String.format(GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND, PROPERTY_GROUP_FILTERS_CONFIG_FILE));
153 * Process the service TOSCA.
156 * model of the service artifact
159 * @param nodeTemplates
160 * a list of service nodes
162 public void processServiceTosca(Service service, Map<String, String> idTypeStore,
163 List<NodeTemplate> nodeTemplates) {
164 log.debug("Processing (TOSCA) Service object");
166 for (NodeTemplate nodeTemplate : nodeTemplates) {
167 if (nodeTemplate.getMetaData() != null) {
168 addNodeToService(idTypeStore, service, nodeTemplate);
170 log.warn(ApplicationMsgs.MISSING_SERVICE_METADATA, nodeTemplate.getName());
176 * Generates a Resource List using input Service Node Templates.
178 * @param serviceNodeTemplates
179 * input Service Node Templates
183 * @return the processed resource models
185 public List<Resource> processResourceToscas(List<NodeTemplate> serviceNodeTemplates,
186 Map<String, String> idTypeStore) {
187 List<Resource> resources = new LinkedList<>();
188 for (NodeTemplate serviceNodeTemplate : serviceNodeTemplates) {
189 if (serviceNodeTemplate.getMetaData() != null) {
190 resources.addAll(processResourceTosca(idTypeStore, serviceNodeTemplate,
191 csarHelper.getNodeTemplateChildren(serviceNodeTemplate)));
193 log.warn(ApplicationMsgs.MISSING_SERVICE_METADATA, serviceNodeTemplate.getName());
202 * @param serviceNodeTemplate
203 * @param resourceNodeTemplates
204 * the (non-VNF) substituted node templates
205 * @return the processed resource models
207 private List<Resource> processResourceTosca(Map<String, String> idTypeStore, NodeTemplate serviceNodeTemplate,
208 List<NodeTemplate> resourceNodeTemplates) {
209 List<Resource> resources = new LinkedList<>();
210 String resourceUuId = serviceNodeTemplate.getMetaData().getValue("UUID");
211 String nodeTypeName = idTypeStore.get(resourceUuId);
212 if (nodeTypeName != null) {
213 Model resourceModel = Model.getModelFor(nodeTypeName, serviceNodeTemplate.getMetaData().getValue("type"));
215 log.debug("Processing resource " + nodeTypeName + ": " + resourceUuId);
216 Map<String, String> serviceMetadata = serviceNodeTemplate.getMetaData().getAllProperties();
217 resourceModel.populateModelIdentificationInformation(serviceMetadata);
219 idTypeStore.remove(resourceModel.getModelNameVersionId());
220 processResourceModels(idTypeStore, resourceModel, resourceNodeTemplates);
222 if (csarHelper.getServiceVfList() != null) {
223 processVfModules(resources, resourceModel, serviceNodeTemplate);
226 if (hasSubCategoryTunnelXConnect(serviceMetadata) && hasAllottedResource(serviceMetadata)) {
227 resourceModel.addWidget(new TunnelXconnectWidget());
230 resources.addAll(processInstanceGroups(resourceModel, serviceNodeTemplate));
231 resources.add((Resource) resourceModel);
238 * Process groups for this service node, according to the defined filter.
240 * @param resourceModel
242 * @return resources for which XML Models should be generated
244 List<Resource> processInstanceGroups(Model resourceModel, NodeTemplate serviceNode) {
245 List<Resource> resources = new ArrayList<>();
246 if (serviceNode.getSubMappingToscaTemplate() != null) {
247 List<Group> serviceGroups = csarHelper.getGroupsOfOriginOfNodeTemplate(serviceNode);
248 for (Group group : serviceGroups) {
249 if (WidgetConfigurationUtil.isSupportedInstanceGroup(group.getType())) {
250 resources.addAll(processInstanceGroup(resourceModel, group.getMemberNodes(),
251 group.getMetadata().getAllProperties(), group.getProperties()));
259 * Merge a Map of String values with a Map of TOSCA Property Objects to create a combined Map. If there are
260 * duplicate keys then the TOSCA Property value takes precedence.
263 * initial Map of String property values (e.g. from the TOSCA YAML metadata section)
265 * Map of TOSCA Property Type Object values to merge in (or overwrite)
266 * @return a Map of the property values converted to String
268 private Map<String, String> mergeProperties(Map<String, String> stringProps, Map<String, Property> toscaProps) {
269 Map<String, String> props = new HashMap<>(stringProps);
270 toscaProps.forEach((key, toscaProp) -> props.put(key,
271 toscaProp.getValue() == null ? "" : toscaProp.getValue().toString()));
276 * Create an Instance Group Model and populate it with the supplied data.
278 * @param resourceModel
279 * the Resource node template Model
281 * the Resources and Widgets belonging to the Group
282 * @param metaProperties
283 * the metadata of the Group
285 * the properties of the Group
286 * @return the Instance Group and Member resource models
288 private List<Resource> processInstanceGroup(Model resourceModel, ArrayList<NodeTemplate> memberNodes,
289 Map<String, String> metaProperties, Map<String, Property> properties) {
290 Resource groupModel = createInstanceGroupModel(mergeProperties(metaProperties, properties));
291 resourceModel.addResource(groupModel);
292 List<Resource> resources = Stream.of(groupModel).collect(Collectors.toList());
294 if (memberNodes != null && !memberNodes.isEmpty()) {
295 resources.addAll(generateResourcesAndWidgets(memberNodes, groupModel));
301 private Resource createInstanceGroupModel(Map<String, String> properties) {
302 Resource groupModel = new InstanceGroup();
303 groupModel.populateModelIdentificationInformation(properties);
312 private List<Resource> generateResourcesAndWidgets(final ArrayList<NodeTemplate> memberNodes,
313 final Resource groupModel) {
314 List<Resource> resources = new ArrayList<>();
315 for (NodeTemplate nodeTemplate : memberNodes) {
316 String nodeTypeName = normaliseNodeTypeName(nodeTemplate);
317 Model memberModel = Model.getModelFor(nodeTypeName, nodeTemplate.getMetaData().getValue("type"));
318 memberModel.populateModelIdentificationInformation(nodeTemplate.getMetaData().getAllProperties());
320 log.debug(String.format("Generating grouped %s (%s) from TOSCA type %s",
321 memberModel.getClass().getSuperclass().getSimpleName(), memberModel.getClass(), nodeTypeName));
323 addRelatedModel(groupModel, memberModel);
324 if (memberModel instanceof Resource) {
325 resources.add((Resource) memberModel);
332 * Add the supplied Node Template to the Service, provided that it is a valid Resource or Widget. If the Node
333 * Template is a Resource type, this is also recorded in the supplied nodesById Map.
336 * a map of Resource node type names, keyed by UUID
338 * the Service to which the Node Template should be added
339 * @param nodeTemplate
340 * the Node Template to add (only if this is a Resource or Widget type)
342 private void addNodeToService(Map<String, String> nodesById, Service service, NodeTemplate nodeTemplate) {
343 String nodeTypeName = normaliseNodeTypeName(nodeTemplate);
344 Model model = Model.getModelFor(nodeTypeName, nodeTemplate.getMetaData().getValue("type"));
346 if (nodeTemplate.getMetaData() != null) {
347 model.populateModelIdentificationInformation(nodeTemplate.getMetaData().getAllProperties());
350 addRelatedModel(service, model);
351 if (model instanceof Resource) {
352 nodesById.put(model.getModelNameVersionId(), nodeTypeName);
361 private void addRelatedModel(final Model model, final Model relation) {
362 if (relation instanceof Resource) {
363 model.addResource((Resource) relation);
365 model.addWidget((Widget) relation);
370 * Process TOSCA Group information for VF Modules.
376 private void processVfModules(List<Resource> resources, Model resourceModel, NodeTemplate serviceNode) {
377 // Get the customisation UUID for each VF node and use it to get its Groups
378 String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNode);
379 List<Group> serviceGroups = csarHelper.getVfModulesByVf(uuid);
381 // Process each VF Group
382 for (Group serviceGroup : serviceGroups) {
383 Model groupModel = Model.getModelFor(serviceGroup.getType());
384 if (groupModel instanceof VfModule) {
385 processVfModule(resources, resourceModel, serviceGroup, serviceNode, (VfModule) groupModel);
390 private void processVfModule(List<Resource> resources, Model model, Group groupDefinition, NodeTemplate serviceNode,
391 VfModule groupModel) {
392 groupModel.populateModelIdentificationInformation(
393 mergeProperties(groupDefinition.getMetadata().getAllProperties(), groupDefinition.getProperties()));
394 processVfModuleGroup(resources, model, groupDefinition, serviceNode, groupModel);
397 private void processVfModuleGroup(List<Resource> resources, Model model, Group groupDefinition,
398 NodeTemplate serviceNode, VfModule groupModel) {
399 // Get names of the members of the service group
400 List<NodeTemplate> members = csarHelper.getMembersOfVfModule(serviceNode, groupDefinition);
401 if (members != null && !members.isEmpty()) {
402 List<String> memberNames = members.stream().map(NodeTemplate::getName).collect(Collectors.toList());
403 groupModel.setMembers(memberNames);
404 for (NodeTemplate member : members) {
405 processGroupMembers(groupModel, member);
409 model.addResource(groupModel); // Added group (VfModule) to the (VF) model
410 // Check if we have already encountered the same VfModule across all the artifacts
411 if (!resources.contains(groupModel)) {
412 resources.add(groupModel);
416 private void processGroupMembers(Model group, NodeTemplate member) {
418 // L3-network inside vf-module to be generated as Widget a special handling.
419 if (member.getType().contains("org.openecomp.resource.vl")) {
420 resourceNode = new L3NetworkWidget();
422 resourceNode = Model.getModelFor(member.getType());
424 if (resourceNode != null && !(resourceNode instanceof Resource)) {
425 Widget widget = (Widget) resourceNode;
426 widget.addKey(member.getName());
427 // Add the widget element encountered to the Group model
428 group.addWidget(widget);
432 private String normaliseNodeTypeName(NodeTemplate nodeType) {
433 String nodeTypeName = nodeType.getType();
434 Metadata metadata = nodeType.getMetaData();
435 if (metadata != null && hasAllottedResource(metadata.getAllProperties())) {
436 if (nodeType.getType().contains("org.openecomp.resource.vf.")) {
437 nodeTypeName = "org.openecomp.resource.vf.allottedResource";
439 if (nodeType.getType().contains("org.openecomp.resource.vfc.")) {
440 nodeTypeName = "org.openecomp.resource.vfc.AllottedResource";
446 private boolean hasAllottedResource(Map<String, String> metadata) {
447 return ALLOTTED_RESOURCE.equals(metadata.get(CATEGORY));
450 private boolean hasSubCategoryTunnelXConnect(Map<String, String> metadata) {
451 return TUNNEL_XCONNECT.equals(metadata.get(SUBCATEGORY));
455 * Create a Map of property name against String property value from the input Map
459 * @return Map of property name against String property value
461 private Map<String, String> populateStringProperties(Map<String, Property> inputMap) {
462 return inputMap.entrySet().stream().collect(Collectors.toMap(Map.Entry::getKey,
463 e -> e.getValue().getValue() == null ? "" : e.getValue().getValue().toString()));
468 * @param resourceModel
469 * @param resourceNodeTemplates
471 private void processResourceModels(Map<String, String> idTypeStore, Model resourceModel,
472 List<NodeTemplate> resourceNodeTemplates) {
473 boolean foundProvidingService = false;
475 for (NodeTemplate resourceNodeTemplate : resourceNodeTemplates) {
476 String nodeTypeName = normaliseNodeTypeName(resourceNodeTemplate);
477 Metadata metaData = resourceNodeTemplate.getMetaData();
478 String metaDataType = Optional.ofNullable(metaData).map(m -> m.getValue("type")).orElse(nodeTypeName);
479 Model resourceNode = Model.getModelFor(nodeTypeName, metaDataType);
480 foundProvidingService |= processModel(idTypeStore, resourceModel, resourceNodeTemplate, nodeTypeName,
481 metaData, resourceNode);
484 if (resourceModel instanceof AllotedResource && !foundProvidingService) {
485 throw new IllegalArgumentException(
486 String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING, resourceModel.getModelId()));
490 private boolean processModel(Map<String, String> idTypeStore, Model resourceModel,
491 NodeTemplate resourceNodeTemplate, String nodeTypeName, Metadata metaData, Model resourceNode) {
492 boolean foundProvidingService = false;
493 if (resourceNode instanceof ProvidingService) {
494 foundProvidingService = true;
495 processProvidingService(resourceModel, resourceNodeTemplate, resourceNode);
496 } else if (resourceNode instanceof Resource && !(resourceNode.getWidgetType().equals(Widget.Type.L3_NET))) {
497 if (metaData != null) {
498 resourceNode.populateModelIdentificationInformation(metaData.getAllProperties());
500 idTypeStore.put(resourceNode.getModelNameVersionId(), nodeTypeName);
501 resourceModel.addResource((Resource) resourceNode);
503 return foundProvidingService;
506 private void processProvidingService(Model resourceModel, NodeTemplate resourceNodeTemplate, Model resourceNode) {
507 Map<String, Property> nodeProperties = resourceNodeTemplate.getProperties();
508 if (nodeProperties.get("providing_service_uuid") == null
509 || nodeProperties.get("providing_service_invariant_uuid") == null) {
510 throw new IllegalArgumentException(
511 String.format(GENERATOR_AAI_PROVIDING_SERVICE_METADATA_MISSING, resourceModel.getModelId()));
513 Map<String, String> properties = populateStringProperties(nodeProperties);
514 properties.put(VERSION, "1.0");
515 resourceNode.populateModelIdentificationInformation(properties);
516 resourceModel.addResource((Resource) resourceNode);