* ============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.
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.babel.parser;
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.FileNotFoundException;
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;
+import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
import org.onap.aai.babel.xml.generator.data.GroupConfiguration;
import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
-import org.onap.aai.babel.xml.generator.model.AllotedResource;
-import org.onap.aai.babel.xml.generator.model.InstanceGroup;
-import org.onap.aai.babel.xml.generator.model.L3NetworkWidget;
import org.onap.aai.babel.xml.generator.model.Model;
-import org.onap.aai.babel.xml.generator.model.ProvidingService;
import org.onap.aai.babel.xml.generator.model.Resource;
-import org.onap.aai.babel.xml.generator.model.VfModule;
import org.onap.aai.babel.xml.generator.model.Widget;
+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;
/**
- * Wrapper for the sdc-tosca parser
+ * Wrapper for the sdc-tosca parser.
*
*/
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_GROUP_FILTERS_CONFIG_FILE = "groupfilter.config";
+ public static final String PROPERTY_TOSCA_MAPPING_FILE = "tosca.mappings.config";
+
+ public static final String GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND =
+ "Cannot generate artifacts. System property %s not configured";
private static final String GENERATOR_AAI_CONFIGFILE_NOT_FOUND =
"Cannot generate artifacts. Artifact Generator Configuration file not found at %s";
- private static final String GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND =
- "Cannot generate artifacts. System property %s not configured";
private static final String GENERATOR_AAI_PROVIDING_SERVICE_METADATA_MISSING =
"Cannot generate artifacts. Providing Service Metadata is missing for allotted resource %s";
private static final String GENERATOR_AAI_PROVIDING_SERVICE_MISSING =
}
/**
- * 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();
- }
- }
-
- /**
- * Initialises the widget configuration.
+ * Initializes the group filtering and TOSCA to Widget mapping configuration.
*
+ * @param configLocation
+ * the pathname to the JSON mappings file
* @throws IOException
+ * if the file content could not be read successfully
*/
- 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));
+ public static void initToscaMappingsConfiguration(String configLocation) throws IOException {
+ log.debug("Getting TOSCA Mappings Configuration");
+ File file = new File(configLocation);
+ if (!file.exists()) {
+ throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGFILE_NOT_FOUND, configLocation));
}
- }
- /**
- * Initialises the group filtering and mapping configuration.
- *
- * @throws FileNotFoundException
- *
- */
- public static void initGroupFilterConfiguration() throws FileNotFoundException {
- log.debug("Getting Filter Types Configuration");
- String configLocation = System.getProperty(PROPERTY_GROUP_FILTERS_CONFIG_FILE);
- if (configLocation == null) {
- throw new IllegalArgumentException(
- String.format(GENERATOR_AAI_CONFIGLOCATION_NOT_FOUND, PROPERTY_GROUP_FILTERS_CONFIG_FILE));
+ GroupConfiguration config;
+
+ try (BufferedReader bufferedReader = new BufferedReader(new FileReader(configLocation))) {
+ config = new Gson().fromJson(bufferedReader, GroupConfiguration.class);
+ } catch (JsonSyntaxException e) {
+ throw new IOException("Invalid Mappings Configuration " + configLocation, e);
}
- File file = new File(configLocation);
- if (!file.exists()) {
- throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGFILE_NOT_FOUND, configLocation));
+ if (config == null) {
+ throw new IOException("There is no content for the Mappings Configuration " + configLocation);
}
-
- BufferedReader bufferedReader = new BufferedReader(new FileReader(configLocation));
- GroupConfiguration config = new Gson().fromJson(bufferedReader, GroupConfiguration.class);
+
WidgetConfigurationUtil.setSupportedInstanceGroups(config.getInstanceGroupTypes());
- WidgetConfigurationUtil.setTypeMappings(config.getToscaToWidgetMappings());
+ WidgetConfigurationUtil.setWidgetTypes(config.getWidgetTypes());
+ WidgetConfigurationUtil.setWidgetMappings(config.getWidgetMappings());
}
/**
* @param resourceModel
* @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<Resource> processInstanceGroups(Model resourceModel, NodeTemplate serviceNodeTemplate) {
+ public List<Resource> processInstanceGroups(Model resourceModel, NodeTemplate serviceNodeTemplate)
+ throws XmlArtifactGenerationException {
List<Resource> resources = new ArrayList<>();
if (serviceNodeTemplate.getSubMappingToscaTemplate() != null) {
- List<Group> serviceGroups = csarHelper.getGroupsOfOriginOfNodeTemplate(serviceNodeTemplate);
+ List<Group> serviceGroups = serviceNodeTemplate.getSubMappingToscaTemplate().getGroups();
for (Group group : serviceGroups) {
if (WidgetConfigurationUtil.isSupportedInstanceGroup(group.getType())) {
resources.addAll(processInstanceGroup(resourceModel, group.getMemberNodes(),
}
public Resource createInstanceGroupModel(Map<String, String> properties) {
- Resource groupModel = new InstanceGroup();
+ 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 Model relation) {
- if (relation instanceof Resource) {
- model.addResource((Resource) relation);
+ public void addRelatedModel(final Model model, final Resource relation) throws XmlArtifactGenerationException {
+ if (relation.getModelType() == ModelType.RESOURCE) {
+ model.addResource(relation);
} else {
- model.addWidget((Widget) relation);
- }
- }
-
- public String normaliseNodeTypeName(NodeTemplate nodeType) {
- String nodeTypeName = nodeType.getType();
- Metadata metadata = nodeType.getMetaData();
- if (metadata != null && hasAllottedResource(metadata.getAllProperties())) {
- if (nodeType.getType().contains("org.openecomp.resource.vf.")) {
- nodeTypeName = "org.openecomp.resource.vf.allottedResource";
- }
- if (nodeType.getType().contains("org.openecomp.resource.vfc.")) {
- nodeTypeName = "org.openecomp.resource.vfc.AllottedResource";
- }
+ model.addWidget(Widget.createWidget(relation.getWidgetType()));
}
- return nodeTypeName;
}
public boolean hasAllottedResource(Map<String, String> metadata) {
*
* @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<Resource> resources, Model resourceModel, NodeTemplate serviceNode) {
- // Get the customisation UUID for each VF node and use it to get its Groups
- String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNode);
- List<Group> serviceGroups = csarHelper.getVfModulesByVf(uuid);
-
+ public void processVfModules(List<Resource> resources, Model resourceModel, NodeTemplate serviceVfNode)
+ throws XmlArtifactGenerationException {
// Process each VF Group
- for (Group serviceGroup : serviceGroups) {
+ for (Group serviceGroup : getVfModuleGroups(serviceVfNode)) {
Model groupModel = Model.getModelFor(serviceGroup.getType());
- if (groupModel instanceof VfModule) {
- processVfModule(resources, resourceModel, serviceGroup, serviceNode, (VfModule) 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<Group> 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<NodeTemplate> resourceNodeTemplates) {
+ public void processResourceModels(Resource resourceModel, List<NodeTemplate> resourceNodeTemplates)
+ throws XmlArtifactGenerationException {
boolean foundProvidingService = false;
for (NodeTemplate resourceNodeTemplate : resourceNodeTemplates) {
- String nodeTypeName = normaliseNodeTypeName(resourceNodeTemplate);
- Metadata metaData = resourceNodeTemplate.getMetaData();
- String metaDataType = Optional.ofNullable(metaData).map(m -> m.getValue("type")).orElse(nodeTypeName);
- Model resourceNode = Model.getModelFor(nodeTypeName, metaDataType);
- foundProvidingService |=
- processModel(resourceModel, metaData, resourceNode, resourceNodeTemplate.getProperties());
+ String nodeTypeName = resourceNodeTemplate.getType();
+ Metadata metadata = resourceNodeTemplate.getMetaData();
+ String metaDataType = Optional.ofNullable(metadata).map(m -> m.getValue("type")).orElse(nodeTypeName);
+ Resource model = Model.getModelFor(nodeTypeName, metaDataType);
+
+ if (metadata != null && hasAllottedResource(metadata.getAllProperties())
+ && model.hasWidgetType("VSERVER")) {
+ model = new Resource(WidgetType.valueOf("ALLOTTED_RESOURCE"), false);
+ Map<String, Object> props = new HashMap<>();
+ props.put("providingService", true);
+ model.setProperties(props);
+ }
+
+ foundProvidingService |= processModel(resourceModel, metadata, model, resourceNodeTemplate.getProperties());
}
- if (resourceModel instanceof AllotedResource && !foundProvidingService) {
- final String modelInvariantId = resourceModel.getModelId();
- throw new IllegalArgumentException(String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING,
- modelInvariantId == null ? "<null ID>" : modelInvariantId));
+ if (resourceModel.hasWidgetType("ALLOTTED_RESOURCE") && !foundProvidingService) {
+ throw new XmlArtifactGenerationException(String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING,
+ Optional.ofNullable(resourceModel.getModelId()).orElse("<null ID>")));
}
}
* @param properties
* 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<Resource> processInstanceGroup(Model resourceModel, ArrayList<NodeTemplate> memberNodes,
- Map<String, String> metaProperties, Map<String, Property> properties) {
+ Map<String, String> metaProperties, Map<String, Property> properties)
+ throws XmlArtifactGenerationException {
Resource groupModel = createInstanceGroupModel(mergeProperties(metaProperties, properties));
resourceModel.addResource(groupModel);
List<Resource> resources = Stream.of(groupModel).collect(Collectors.toList());
/**
* @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<Resource> generateResourcesAndWidgets(final ArrayList<NodeTemplate> memberNodes,
- final Resource groupModel) {
+ final Resource groupModel) throws XmlArtifactGenerationException {
log.debug(String.format("Processing member nodes for Group %s (invariant UUID %s)", //
groupModel.getModelName(), groupModel.getModelId()));
List<Resource> resources = new ArrayList<>();
for (NodeTemplate nodeTemplate : memberNodes) {
- String nodeTypeName = normaliseNodeTypeName(nodeTemplate);
+ String nodeTypeName = nodeTemplate.getType();
final String metadataType = nodeTemplate.getMetaData().getValue("type");
log.debug(String.format("Get model for %s (metadata type %s)", nodeTypeName, metadataType));
- Model memberModel = Model.getModelFor(nodeTypeName, metadataType);
+ Resource memberModel = Model.getModelFor(nodeTypeName, metadataType);
if (memberModel != null) {
memberModel.populateModelIdentificationInformation(nodeTemplate.getMetaData().getAllProperties());
memberModel.getClass().getSuperclass().getSimpleName(), memberModel.getClass(), nodeTypeName));
addRelatedModel(groupModel, memberModel);
- if (memberModel instanceof Resource) {
- resources.add((Resource) memberModel);
+ if (memberModel.getModelType() == ModelType.RESOURCE) {
+ resources.add(memberModel);
}
}
}
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<Resource> resources, Model vfModel, Group groupDefinition,
- NodeTemplate serviceNode, VfModule groupModel) {
+ NodeTemplate serviceNode, Resource groupModel) throws XmlArtifactGenerationException {
groupModel.populateModelIdentificationInformation(
mergeProperties(groupDefinition.getMetadata().getAllProperties(), groupDefinition.getProperties()));
- processVfModuleGroup(groupModel, csarHelper.getMembersOfVfModule(serviceNode, groupDefinition));
+
+ 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
}
}
- private void processVfModuleGroup(VfModule groupModel, List<NodeTemplate> members) {
+ /**
+ * @param substitutionMappings
+ * @param vfModuleInvariantUuid
+ * @return all serviceNode child Node Templates which are members of the first VF Module Group
+ */
+ private List<NodeTemplate> 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<? super Group> 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<NodeTemplate> members)
+ throws XmlArtifactGenerationException {
if (members != null && !members.isEmpty()) {
// Get names of the members of the service group
List<String> memberNames = members.stream().map(NodeTemplate::getName).collect(Collectors.toList());
}
}
- private void processGroupMembers(Model group, NodeTemplate member) {
- Model resourceNode;
- // L3-network inside vf-module to be generated as Widget a special handling.
- if (member.getType().contains("org.openecomp.resource.vl")) {
- resourceNode = new L3NetworkWidget();
- } else {
- resourceNode = Model.getModelFor(member.getType());
+ /**
+ * 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.hasWidgetType("L3_NET")) {
+ // An l3-network inside a vf-module is treated as a Widget
+ resource.setModelType(ModelType.WIDGET);
}
- if (resourceNode != null && !(resourceNode instanceof Resource)) {
- Widget widget = (Widget) resourceNode;
+
+ 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);
/**
* If the specified resourceNode is a type of Resource, add it to the specified resourceModel. If the Resource type
- * is ProvidingService return true, otherwise return false.
+ * is ProvidingService then return true, otherwise return false.
*
* @param resourceModel
* parent Resource
* any Model (will be ignored if not a Resource)
* @param nodeProperties
* the node properties
- * @return whether or not a ProvidingService was prcoessed
+ * @return whether or not a ProvidingService was processed
*/
- private boolean processModel(Model resourceModel, Metadata metaData, Model resourceNode,
+ private boolean processModel(Model resourceModel, Metadata metaData, Resource resourceNode,
Map<String, Property> nodeProperties) {
- boolean foundProvidingService = false;
- if (resourceNode instanceof ProvidingService) {
- foundProvidingService = true;
+ boolean foundProvidingService = resourceNode != null
+ && (boolean) Optional.ofNullable(resourceNode.getProperties().get("providingService")).orElse(false);
+
+ if (foundProvidingService) {
processProvidingService(resourceModel, resourceNode, nodeProperties);
- } else if (resourceNode instanceof Resource && !(resourceNode.getWidgetType().equals(Widget.Type.L3_NET))) {
+ } else if (resourceNode != null && resourceNode.getModelType() == ModelType.RESOURCE
+ && !resourceNode.hasWidgetType("L3_NET")) {
if (metaData != null) {
resourceNode.populateModelIdentificationInformation(metaData.getAllProperties());
}
- resourceModel.addResource((Resource) resourceNode);
+ resourceModel.addResource(resourceNode);
}
return foundProvidingService;
}
- private void processProvidingService(Model resourceModel, Model resourceNode,
+ private void processProvidingService(Model resourceModel, Resource resourceNode,
Map<String, Property> nodeProperties) {
if (nodeProperties == null || nodeProperties.get("providing_service_uuid") == null
|| nodeProperties.get("providing_service_invariant_uuid") == null) {
Map<String, String> properties = populateStringProperties(nodeProperties);
properties.put(VERSION, "1.0");
resourceNode.populateModelIdentificationInformation(properties);
- resourceModel.addResource((Resource) resourceNode);
+ resourceModel.addResource(resourceNode);
}
}
Code Review / aai / babel.git / blobdiff