X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fonap%2Faai%2Fbabel%2Fparser%2FArtifactGeneratorToscaParser.java;h=2816cb570da1539948981c4af7d102b8b1b8fab2;hb=60457e41054465e9fa10c8e6bfdbfa62a45d1f0a;hp=c79c2ef9dbb1b19a91a2ca404abab637484b3323;hpb=f5dae47e293ae63a7a2f18230b772a699a52566f;p=aai%2Fbabel.git diff --git a/src/main/java/org/onap/aai/babel/parser/ArtifactGeneratorToscaParser.java b/src/main/java/org/onap/aai/babel/parser/ArtifactGeneratorToscaParser.java index c79c2ef..2816cb5 100644 --- a/src/main/java/org/onap/aai/babel/parser/ArtifactGeneratorToscaParser.java +++ b/src/main/java/org/onap/aai/babel/parser/ArtifactGeneratorToscaParser.java @@ -2,8 +2,8 @@ * ============LICENSE_START======================================================= * org.onap.aai * ================================================================================ - * Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved. - * Copyright © 2017-2019 European Software Marketing Ltd. + * Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved. + * Copyright (c) 2017-2019 European Software Marketing Ltd. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,15 +25,15 @@ import com.google.gson.Gson; import com.google.gson.JsonSyntaxException; import java.io.BufferedReader; import java.io.File; -import java.io.FileInputStream; import java.io.FileReader; import java.io.IOException; import java.util.ArrayList; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Optional; -import java.util.Properties; +import java.util.function.Predicate; import java.util.stream.Collectors; import java.util.stream.Stream; import org.onap.aai.babel.logging.LogHelper; @@ -43,12 +43,16 @@ import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil; import org.onap.aai.babel.xml.generator.model.Model; import org.onap.aai.babel.xml.generator.model.Resource; import org.onap.aai.babel.xml.generator.model.Widget; -import org.onap.aai.babel.xml.generator.model.Widget.Type; +import org.onap.aai.babel.xml.generator.model.WidgetType; +import org.onap.aai.babel.xml.generator.types.ModelType; import org.onap.aai.cl.api.Logger; import org.onap.sdc.tosca.parser.api.ISdcCsarHelper; +import org.onap.sdc.tosca.parser.impl.SdcPropertyNames; +import org.onap.sdc.tosca.parser.utils.SdcToscaUtility; import org.onap.sdc.toscaparser.api.Group; import org.onap.sdc.toscaparser.api.NodeTemplate; import org.onap.sdc.toscaparser.api.Property; +import org.onap.sdc.toscaparser.api.SubstitutionMappings; import org.onap.sdc.toscaparser.api.elements.Metadata; /** @@ -59,7 +63,6 @@ public class ArtifactGeneratorToscaParser { private static Logger log = LogHelper.INSTANCE; - public static final String PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE = "artifactgenerator.config"; public static final String PROPERTY_TOSCA_MAPPING_FILE = "tosca.mappings.config"; public static final String GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND = @@ -92,50 +95,9 @@ public class ArtifactGeneratorToscaParser { this.csarHelper = csarHelper; } - /** - * Get or create the artifact description. - * - * @param model - * the artifact model - * @return the artifact model's description - */ - public static String getArtifactDescription(Model model) { - switch (model.getModelType()) { - case SERVICE: - return "AAI Service Model"; - case RESOURCE: - return "AAI Resource Model"; - default: - return model.getModelDescription(); - } - } - - /** - * Initializes the Widget to UUID mapping configuration. - * - * @throws IOException - */ - public static void initWidgetConfiguration() throws IOException { - log.debug("Getting Widget Configuration"); - String configLocation = System.getProperty(PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE); - if (configLocation != null) { - File file = new File(configLocation); - if (file.exists()) { - Properties properties = new Properties(); - properties.load(new FileInputStream(file)); - WidgetConfigurationUtil.setConfig(properties); - } else { - throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGFILE_NOT_FOUND, configLocation)); - } - } else { - throw new IllegalArgumentException( - String.format(GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND, PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE)); - } - } - /** * Initializes the group filtering and TOSCA to Widget mapping configuration. - * + * * @param configLocation * the pathname to the JSON mappings file * @throws IOException @@ -172,12 +134,13 @@ public class ArtifactGeneratorToscaParser { * @param serviceNodeTemplate * @return resources for which XML Models should be generated * @throws XmlArtifactGenerationException + * if there is no configuration defined for a member Widget of an instance group */ public List processInstanceGroups(Model resourceModel, NodeTemplate serviceNodeTemplate) throws XmlArtifactGenerationException { List resources = new ArrayList<>(); if (serviceNodeTemplate.getSubMappingToscaTemplate() != null) { - List serviceGroups = csarHelper.getGroupsOfOriginOfNodeTemplate(serviceNodeTemplate); + List serviceGroups = serviceNodeTemplate.getSubMappingToscaTemplate().getGroups(); for (Group group : serviceGroups) { if (WidgetConfigurationUtil.isSupportedInstanceGroup(group.getType())) { resources.addAll(processInstanceGroup(resourceModel, group.getMemberNodes(), @@ -206,21 +169,25 @@ public class ArtifactGeneratorToscaParser { } public Resource createInstanceGroupModel(Map properties) { - Resource groupModel = new Resource(Type.INSTANCE_GROUP, true); + Resource groupModel = new Resource(WidgetType.valueOf("INSTANCE_GROUP"), true); groupModel.populateModelIdentificationInformation(properties); return groupModel; } /** + * Add the resource/widget to the specified model. + * * @param model * @param relation + * resource or widget model to add * @throws XmlArtifactGenerationException + * if the relation is a widget and there is no configuration defined for the relation's widget type */ public void addRelatedModel(final Model model, final Resource relation) throws XmlArtifactGenerationException { - if (relation.isResource()) { + if (relation.getModelType() == ModelType.RESOURCE) { model.addResource(relation); } else { - model.addWidget(Widget.getWidget(relation.getWidgetType())); + model.addWidget(Widget.createWidget(relation.getWidgetType())); } } @@ -237,29 +204,51 @@ public class ArtifactGeneratorToscaParser { * * @param resources * @param model - * @param serviceNode + * @param serviceVfNode + * a VF resource Node Template * @throws XmlArtifactGenerationException + * if the configured widget mappings do not support the widget type of a VF Module */ - public void processVfModules(List resources, Model resourceModel, NodeTemplate serviceNode) + public void processVfModules(List resources, Model resourceModel, NodeTemplate serviceVfNode) throws XmlArtifactGenerationException { - // Get the customisation UUID for each VF node and use it to get its Groups - String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNode); - List serviceGroups = csarHelper.getVfModulesByVf(uuid); - // Process each VF Group - for (Group serviceGroup : serviceGroups) { + for (Group serviceGroup : getVfModuleGroups(serviceVfNode)) { Model groupModel = Model.getModelFor(serviceGroup.getType()); - if (groupModel.getWidgetType() == Type.VFMODULE) { - processVfModule(resources, resourceModel, serviceGroup, serviceNode, (Resource) groupModel); + if (groupModel.hasWidgetType("VFMODULE")) { + processVfModule(resources, resourceModel, serviceGroup, serviceVfNode, (Resource) groupModel); } } } /** + * Implementation taken from the sdc-tosca parser (deprecated method). + * + * @param serviceVfNode + * a VF resource Node Template + * @return all service level VfModule groups with a name matching that of the supplied VF node template + */ + private List getVfModuleGroups(NodeTemplate serviceVfNode) { + String instanceName = SdcToscaUtility.normaliseComponentInstanceName(serviceVfNode.getName()); + + return ToscaParser.getServiceLevelGroups(csarHelper).stream() + .filter(group -> "org.openecomp.groups.VfModule".equals(group.getTypeDefinition().getType()) + && group.getName().startsWith(instanceName)) + .collect(Collectors.toList()); + } + + /** + * Add each of the resources to the specified resourceModel. If the resourceModel type is Allotted Resource then + * validate that one of the resources is a Providing Service. + * * @param resourceModel + * parent Resource model * @param resourceNodeTemplates + * the child node templates of the resourceModel + * @throws XmlArtifactGenerationException + * if the resourceModel is an ALLOTTED_RESOURCE with no Providing Service */ - public void processResourceModels(Model resourceModel, List resourceNodeTemplates) { + public void processResourceModels(Resource resourceModel, List resourceNodeTemplates) + throws XmlArtifactGenerationException { boolean foundProvidingService = false; for (NodeTemplate resourceNodeTemplate : resourceNodeTemplates) { @@ -269,8 +258,8 @@ public class ArtifactGeneratorToscaParser { Resource model = Model.getModelFor(nodeTypeName, metaDataType); if (metadata != null && hasAllottedResource(metadata.getAllProperties()) - && model.getWidgetType() == Type.VSERVER) { - model = new Resource(Type.ALLOTTED_RESOURCE, false); + && model.hasWidgetType("VSERVER")) { + model = new Resource(WidgetType.valueOf("ALLOTTED_RESOURCE"), false); Map props = new HashMap<>(); props.put("providingService", true); model.setProperties(props); @@ -279,10 +268,9 @@ public class ArtifactGeneratorToscaParser { foundProvidingService |= processModel(resourceModel, metadata, model, resourceNodeTemplate.getProperties()); } - if (resourceModel.getWidgetType() == Type.ALLOTTED_RESOURCE && !foundProvidingService) { - final String modelInvariantId = resourceModel.getModelId(); - throw new IllegalArgumentException(String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING, - modelInvariantId == null ? "" : modelInvariantId)); + if (resourceModel.hasWidgetType("ALLOTTED_RESOURCE") && !foundProvidingService) { + throw new XmlArtifactGenerationException(String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING, + Optional.ofNullable(resourceModel.getModelId()).orElse(""))); } } @@ -299,6 +287,7 @@ public class ArtifactGeneratorToscaParser { * the properties of the Group * @return the Instance Group and Member resource models * @throws XmlArtifactGenerationException + * if there is no configuration defined for one of the member Widgets */ private List processInstanceGroup(Model resourceModel, ArrayList memberNodes, Map metaProperties, Map properties) @@ -317,8 +306,10 @@ public class ArtifactGeneratorToscaParser { /** * @param memberNodes * @param groupModel - * @return + * @return a list of Resources * @throws XmlArtifactGenerationException + * if a member node template is a widget and there is no configuration defined for that relation's + * widget type */ private List generateResourcesAndWidgets(final ArrayList memberNodes, final Resource groupModel) throws XmlArtifactGenerationException { @@ -341,7 +332,7 @@ public class ArtifactGeneratorToscaParser { memberModel.getClass().getSuperclass().getSimpleName(), memberModel.getClass(), nodeTypeName)); addRelatedModel(groupModel, memberModel); - if (memberModel.isResource()) { + if (memberModel.getModelType() == ModelType.RESOURCE) { resources.add(memberModel); } } @@ -349,12 +340,29 @@ public class ArtifactGeneratorToscaParser { return resources; } + /** + * @param resources + * @param vfModel + * @param groupDefinition + * @param serviceNode + * @param groupModel + * @throws XmlArtifactGenerationException + * if the configured widget mappings do not support the widget type of a VF Module + */ private void processVfModule(List resources, Model vfModel, Group groupDefinition, NodeTemplate serviceNode, Resource groupModel) throws XmlArtifactGenerationException { - groupModel.populateModelIdentificationInformation( - mergeProperties(groupDefinition.getMetadata().getAllProperties(), groupDefinition.getProperties())); + Metadata metadata = groupDefinition.getMetadata(); + + Map mergedProperties = + mergeProperties(metadata == null ? Collections.emptyMap() : metadata.getAllProperties(), + groupDefinition.getProperties()); - processVfModuleGroup(groupModel, csarHelper.getMembersOfVfModule(serviceNode, groupDefinition)); + groupModel.populateModelIdentificationInformation(mergedProperties); + SubstitutionMappings substitutionMappings = serviceNode.getSubMappingToscaTemplate(); + if (substitutionMappings != null) { + processVfModuleGroup(groupModel, getVfModuleMembers(substitutionMappings, + groupDefinition.getMetadata().getValue(SdcPropertyNames.PROPERTY_NAME_VFMODULEMODELINVARIANTUUID))); + } vfModel.addResource(groupModel); // Add group (VfModule) to the (VF) model // Check if we have already encountered the same VfModule across all the artifacts @@ -363,6 +371,35 @@ public class ArtifactGeneratorToscaParser { } } + /** + * @param substitutionMappings + * @param vfModuleInvariantUuid + * @return all serviceNode child Node Templates which are members of the first VF Module Group + */ + private List getVfModuleMembers(SubstitutionMappings substitutionMappings, + String vfModuleInvariantUuid) { + return Optional.ofNullable(substitutionMappings.getGroups()) // + .map(groups -> groups.stream() // + .filter(filterByVfModuleInvariantUuid(vfModuleInvariantUuid)) // + .findFirst().map(module -> Optional.ofNullable(module.getMembers()).orElse(new ArrayList<>())) + .orElse(new ArrayList<>())) + .map(members -> substitutionMappings.getNodeTemplates().stream() + .filter(nt -> members.contains(nt.getName())) // + .collect(Collectors.toList())) + .orElse(Collections.emptyList()); + } + + private Predicate filterByVfModuleInvariantUuid(String vfModuleInvariantUuid) { + return nt -> (nt.getMetadata() != null && vfModuleInvariantUuid + .equals(nt.getMetadata().getValue(SdcPropertyNames.PROPERTY_NAME_VFMODULEMODELINVARIANTUUID))); + } + + /** + * @param groupModel + * @param members + * @throws XmlArtifactGenerationException + * if the configured widget mappings do not support the widget type of a member + */ private void processVfModuleGroup(Resource groupModel, List members) throws XmlArtifactGenerationException { if (members != null && !members.isEmpty()) { @@ -377,23 +414,26 @@ public class ArtifactGeneratorToscaParser { /** * Process the Widget members of a VF Module Group - * + * * @param group + * the group resource model * @param member + * the group member to process * @throws XmlArtifactGenerationException + * if the configured widget mappings do not support the widget type of the member */ private void processGroupMembers(Resource group, NodeTemplate member) throws XmlArtifactGenerationException { Resource resource = Model.getModelFor(member.getType()); log.debug(member.getType() + " mapped to " + resource); - if (resource.getWidgetType() == Type.L3_NET) { + if (resource.hasWidgetType("L3_NET")) { // An l3-network inside a vf-module is treated as a Widget - resource.setIsResource(false); + resource.setModelType(ModelType.WIDGET); } - if (!resource.isResource()) { - Widget widget = Widget.getWidget(resource.getWidgetType()); + if (resource.getModelType() == ModelType.WIDGET) { + Widget widget = Widget.createWidget(resource.getWidgetType()); widget.addKey(member.getName()); // Add the widget element encountered to the Group model group.addWidget(widget); @@ -420,29 +460,34 @@ public class ArtifactGeneratorToscaParser { * parent Resource * @param metaData * for populating the Resource IDs - * @param resourceNode - * any Model (will be ignored if not a Resource) + * @param childResource + * a child Resource (will be ignored if this is a Widget type) * @param nodeProperties * the node properties * @return whether or not a ProvidingService was processed */ - private boolean processModel(Model resourceModel, Metadata metaData, Resource resourceNode, + private boolean processModel(Model resourceModel, Metadata metaData, Resource childResource, Map nodeProperties) { - boolean foundProvidingService = resourceNode != null - && (boolean) Optional.ofNullable(resourceNode.getProperties().get("providingService")).orElse(false); + boolean isProvidingService = childResource != null + && (boolean) Optional.ofNullable(childResource.getProperties().get("providingService")).orElse(false); - if (foundProvidingService) { - processProvidingService(resourceModel, resourceNode, nodeProperties); - } else if (resourceNode != null && resourceNode.isResource() - && resourceNode.getWidgetType() != Widget.Type.L3_NET) { + if (isProvidingService) { + processProvidingService(resourceModel, childResource, nodeProperties); + } else if (childResource != null && childResource.getModelType() == ModelType.RESOURCE + && !childResource.hasWidgetType("L3_NET")) { if (metaData != null) { - resourceNode.populateModelIdentificationInformation(metaData.getAllProperties()); + childResource.populateModelIdentificationInformation(metaData.getAllProperties()); } - resourceModel.addResource((Resource) resourceNode); + resourceModel.addResource(childResource); } - return foundProvidingService; + return isProvidingService; } + /** + * @param resourceModel + * @param resourceNode + * @param nodeProperties + */ private void processProvidingService(Model resourceModel, Resource resourceNode, Map nodeProperties) { if (nodeProperties == null || nodeProperties.get("providing_service_uuid") == null