Remove all references to artifactgenerator config
[aai/babel.git] / src / main / java / org / onap / aai / babel / parser / ArtifactGeneratorToscaParser.java
index 50c6edf..c2d34c9 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;
@@ -33,16 +32,17 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-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.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.toscaparser.api.Group;
@@ -58,7 +58,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,67 +91,35 @@ public class ArtifactGeneratorToscaParser {
     }
 
     /**
-     * Get or create the artifact description.
+     * Initializes the group filtering and TOSCA to Widget mapping configuration.
      *
-     * @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.
-     *
-     * @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));
-        }
-    }
-
-    /**
-     * Initialises the group filtering and TOSCA 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 +128,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);
@@ -194,20 +164,25 @@ public class ArtifactGeneratorToscaParser {
     }
 
     public Resource createInstanceGroupModel(Map<String, String> 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) {
-        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()));
+            model.addWidget(Widget.createWidget(relation.getWidgetType()));
         }
     }
 
@@ -225,16 +200,19 @@ public class ArtifactGeneratorToscaParser {
      * @param resources
      * @param model
      * @param serviceNode
+     * @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
+    public void processVfModules(List<Resource> resources, Model resourceModel, NodeTemplate serviceNode)
+            throws XmlArtifactGenerationException {
+        // Get the customization UUID for each VF node and use it to get its Groups
         String uuid = csarHelper.getNodeTemplateCustomizationUuid(serviceNode);
         List<Group> serviceGroups = csarHelper.getVfModulesByVf(uuid);
 
         // Process each VF Group
         for (Group serviceGroup : serviceGroups) {
             Model groupModel = Model.getModelFor(serviceGroup.getType());
-            if (groupModel.getWidgetType() == Type.VFMODULE) {
+            if (groupModel.hasWidgetType("VFMODULE")) {
                 processVfModule(resources, resourceModel, serviceGroup, serviceNode, (Resource) groupModel);
             }
         }
@@ -253,19 +231,18 @@ public class ArtifactGeneratorToscaParser {
             String metaDataType = Optional.ofNullable(metadata).map(m -> m.getValue("type")).orElse(nodeTypeName);
             Resource model = Model.getModelFor(nodeTypeName, metaDataType);
 
-            if (metadata != null && hasAllottedResource(metadata.getAllProperties())) {
-                if (model.getWidgetType() == Type.VSERVER) {
-                    model = new Resource(Type.ALLOTTED_RESOURCE, false);
-                    Map<String, Object> props = new HashMap<>();
-                    props.put("providingService", true);
-                    model.setProperties(props);
-                }
+            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.getWidgetType() == Type.ALLOTTED_RESOURCE && !foundProvidingService) {
+        if (resourceModel.hasWidgetType("ALLOTTED_RESOURCE") && !foundProvidingService) {
             final String modelInvariantId = resourceModel.getModelId();
             throw new IllegalArgumentException(String.format(GENERATOR_AAI_PROVIDING_SERVICE_MISSING,
                     modelInvariantId == null ? "<null ID>" : modelInvariantId));
@@ -284,9 +261,12 @@ public class ArtifactGeneratorToscaParser {
      * @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());
@@ -301,10 +281,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()));
 
@@ -324,7 +307,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,8 +315,17 @@ 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<Resource> resources, Model vfModel, Group groupDefinition,
-            NodeTemplate serviceNode, Resource groupModel) {
+            NodeTemplate serviceNode, Resource groupModel) throws XmlArtifactGenerationException {
         groupModel.populateModelIdentificationInformation(
                 mergeProperties(groupDefinition.getMetadata().getAllProperties(), groupDefinition.getProperties()));
 
@@ -346,7 +338,14 @@ public class ArtifactGeneratorToscaParser {
         }
     }
 
-    private void processVfModuleGroup(Resource groupModel, List<NodeTemplate> members) {
+    /**
+     * @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());
@@ -359,22 +358,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) {
+    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);
@@ -414,12 +417,12 @@ public class ArtifactGeneratorToscaParser {
 
         if (foundProvidingService) {
             processProvidingService(resourceModel, resourceNode, nodeProperties);
-        } else if (resourceNode != null && resourceNode.isResource()
-                && resourceNode.getWidgetType() != 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;
     }