Re-implement model type value for Resource Mapping
[aai/babel.git] / src / main / java / org / onap / aai / babel / parser / ArtifactGeneratorToscaParser.java
index 3fb77be..6e37587 100644 (file)
@@ -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.
 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;
@@ -37,12 +37,14 @@ import java.util.Properties;
 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.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.types.ModelType;
 import org.onap.aai.cl.api.Logger;
 import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
 import org.onap.sdc.toscaparser.api.Group;
@@ -85,34 +87,17 @@ public class ArtifactGeneratorToscaParser {
      * Constructs using csarHelper
      *
      * @param csarHelper
-     *     The csar helper
+     *            The csar helper
      */
     public ArtifactGeneratorToscaParser(ISdcCsarHelper csarHelper) {
         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();
-        }
-    }
-
-    /**
-     * Initialises the widget configuration.
-     *
+     * Initializes the Widget to UUID mapping configuration.
+     * 
      * @throws IOException
+     *             if an error occurs reading the configuration properties
      */
     public static void initWidgetConfiguration() throws IOException {
         log.debug("Getting Widget Configuration");
@@ -133,26 +118,35 @@ public class ArtifactGeneratorToscaParser {
     }
 
     /**
-     * Initialises the group filtering and TOSCA mapping configuration.
+     * Initializes the group filtering and TOSCA to Widget mapping configuration.
      * 
      * @param configLocation
-     *     the pathname to the JSON config file
-     * @throws FileNotFoundException
-     *     if the file cannot be opened for reading
+     *            the pathname to the JSON mappings file
+     * @throws IOException
+     *             if the file content could not be read successfully
      */
-    public static void initToscaMappingsConfiguration(String configLocation) throws FileNotFoundException {
+    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));
         }
 
-        BufferedReader bufferedReader = new BufferedReader(new FileReader(configLocation));
-        GroupConfiguration config = new Gson().fromJson(bufferedReader, GroupConfiguration.class);
-        if (config != null) {
-            WidgetConfigurationUtil.setSupportedInstanceGroups(config.getInstanceGroupTypes());
-            WidgetConfigurationUtil.setWidgetMappings(config.getWidgetMappings());
+        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);
         }
+
+        if (config == null) {
+            throw new IOException("There is no content for the Mappings Configuration " + configLocation);
+        }
+
+        WidgetConfigurationUtil.setSupportedInstanceGroups(config.getInstanceGroupTypes());
+        WidgetConfigurationUtil.setWidgetTypes(config.getWidgetTypes());
+        WidgetConfigurationUtil.setWidgetMappings(config.getWidgetMappings());
     }
 
     /**
@@ -161,8 +155,11 @@ public class ArtifactGeneratorToscaParser {
      * @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);
@@ -181,9 +178,9 @@ public class ArtifactGeneratorToscaParser {
      * duplicate keys then the TOSCA Property value takes precedence.
      *
      * @param stringProps
-     *     initial Map of String property values (e.g. from the TOSCA YAML metadata section)
+     *            initial Map of String property values (e.g. from the TOSCA YAML metadata section)
      * @param toscaProps
-     *     Map of TOSCA Property Type Object values to merge in (or overwrite)
+     *            Map of TOSCA Property Type Object values to merge in (or overwrite)
      * @return a Map of the property values converted to String
      */
     public Map<String, String> mergeProperties(Map<String, String> stringProps, Map<String, Property> toscaProps) {
@@ -200,11 +197,16 @@ public class ArtifactGeneratorToscaParser {
     }
 
     /**
+     * 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) {
-        if (relation.isResource()) {
+    public void addRelatedModel(final Model model, final Resource relation) throws XmlArtifactGenerationException {
+        if (relation.getModelType() == ModelType.RESOURCE) {
             model.addResource(relation);
         } else {
             model.addWidget(Widget.getWidget(relation.getWidgetType()));
@@ -225,8 +227,10 @@ public class ArtifactGeneratorToscaParser {
      * @param resources
      * @param model
      * @param serviceNode
+     * @throws XmlArtifactGenerationException
      */
-    public void processVfModules(List<Resource> resources, Model resourceModel, NodeTemplate serviceNode) {
+    public void processVfModules(List<Resource> resources, Model resourceModel, NodeTemplate serviceNode)
+            throws XmlArtifactGenerationException {
         // 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);
@@ -275,17 +279,20 @@ public class ArtifactGeneratorToscaParser {
      * Create an Instance Group Model and populate it with the supplied data.
      *
      * @param resourceModel
-     *     the Resource node template Model
+     *            the Resource node template Model
      * @param memberNodes
-     *     the Resources and Widgets belonging to the Group
+     *            the Resources and Widgets belonging to the Group
      * @param metaProperties
-     *     the metadata of the Group
+     *            the metadata of the Group
      * @param properties
-     *     the properties of the Group
+     *            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());
@@ -300,10 +307,13 @@ 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<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()));
 
@@ -323,7 +333,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);
                 }
             }
@@ -332,7 +342,7 @@ public class ArtifactGeneratorToscaParser {
     }
 
     private void processVfModule(List<Resource> resources, Model vfModel, Group groupDefinition,
-            NodeTemplate serviceNode, Resource groupModel) {
+            NodeTemplate serviceNode, Resource groupModel) throws XmlArtifactGenerationException {
         groupModel.populateModelIdentificationInformation(
                 mergeProperties(groupDefinition.getMetadata().getAllProperties(), groupDefinition.getProperties()));
 
@@ -345,7 +355,8 @@ public class ArtifactGeneratorToscaParser {
         }
     }
 
-    private void processVfModuleGroup(Resource groupModel, List<NodeTemplate> members) {
+    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());
@@ -361,18 +372,19 @@ public class ArtifactGeneratorToscaParser {
      * 
      * @param group
      * @param member
+     * @throws XmlArtifactGenerationException
      */
-    private void processGroupMembers(Resource group, NodeTemplate 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) {
             // An l3-network inside a vf-module is treated as a Widget
-            resource.setIsResource(false);
+            resource.setModelType(ModelType.WIDGET);
         }
 
-        if (!resource.isResource()) {
+        if (resource.getModelType() == ModelType.WIDGET) {
             Widget widget = Widget.getWidget(resource.getWidgetType());
             widget.addKey(member.getName());
             // Add the widget element encountered to the Group model
@@ -384,7 +396,7 @@ public class ArtifactGeneratorToscaParser {
      * Create a Map of property name against String property value from the input Map
      *
      * @param inputMap
-     *     The input Map
+     *            The input Map
      * @return Map of property name against String property value
      */
     private Map<String, String> populateStringProperties(Map<String, Property> inputMap) {
@@ -397,13 +409,13 @@ public class ArtifactGeneratorToscaParser {
      * is ProvidingService then return true, otherwise return false.
      *
      * @param resourceModel
-     *     parent Resource
+     *            parent Resource
      * @param metaData
-     *     for populating the Resource IDs
+     *            for populating the Resource IDs
      * @param resourceNode
-     *     any Model (will be ignored if not a Resource)
+     *            any Model (will be ignored if not a Resource)
      * @param nodeProperties
-     *     the node properties
+     *            the node properties
      * @return whether or not a ProvidingService was processed
      */
     private boolean processModel(Model resourceModel, Metadata metaData, Resource resourceNode,
@@ -413,7 +425,7 @@ public class ArtifactGeneratorToscaParser {
 
         if (foundProvidingService) {
             processProvidingService(resourceModel, resourceNode, nodeProperties);
-        } else if (resourceNode != null && resourceNode.isResource()
+        } else if (resourceNode != null && resourceNode.getModelType() == ModelType.RESOURCE
                 && resourceNode.getWidgetType() != Widget.Type.L3_NET) {
             if (metaData != null) {
                 resourceNode.populateModelIdentificationInformation(metaData.getAllProperties());