Add JUnit test for invalid TOSCA mappings JSON
[aai/babel.git] / src / test / java / org / onap / aai / babel / xml / generator / model / TestVfModule.java
index e9c8c1b..f712ba5 100644 (file)
@@ -2,8 +2,8 @@
  * ============LICENSE_START=======================================================
  * org.onap.aai
  * ================================================================================
- * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2017-2018 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.
@@ -26,83 +26,97 @@ import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.hamcrest.collection.IsCollectionWithSize.hasSize;
 import static org.junit.Assert.assertThat;
 
-import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.InputStream;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Properties;
 import org.junit.BeforeClass;
 import org.junit.Test;
-import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
+import org.onap.aai.babel.util.ArtifactTestUtils;
+import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
 import org.onap.aai.babel.xml.generator.model.Widget.Type;
 
 /**
- * Direct tests of the VfModule Model class to improve code coverage.
+ * Direct tests of the VFMODULE Resource and Widget functionality to improve code coverage.
  */
 public class TestVfModule {
 
-    static {
-        System.setProperty("APP_HOME", ".");
-    }
-
     /**
-     * Load the Widget to UUID mappings from the Artifact Generator properties.
-     * 
-     * @throws FileNotFoundException if the properties file is missing
-     * @throws IOException if the properties file is not loaded
+     * Load the Widget Configuration, including the type mappings and the UUID mappings.
+     *
+     * @throws IOException
+     *             if the mappings configuration cannot be loaded
      */
     @BeforeClass
-    public static void setup() throws FileNotFoundException, IOException {
-        InputStream in = TestVfModule.class.getClassLoader().getResourceAsStream("artifact-generator.properties");
-        Properties properties = new Properties();
-        properties.load(in);
-        in.close();
-        WidgetConfigurationUtil.setConfig(properties);
+    public static void setup() throws IOException {
+        ArtifactTestUtils util = new ArtifactTestUtils();
+        util.loadWidgetToUuidMappings();
+        util.loadWidgetMappings();
     }
 
     /**
-     * Call equals() and hashCode() methods for code coverage.
+     * Call hashCode() method for code coverage.
      */
     @Test
-    public void testEqualsHashCode() {
-        VfModule vfModule = createNewVfModule();
+    public void testHashCode() {
+        Resource vfModule = createNewVfModule();
         populateIdentInfo(vfModule);
         assertThat(vfModule.hashCode(), is(notNullValue()));
-        assertThat(vfModule.equals(vfModule), is(true));
-        // Tests that the overridden equals() method correctly returns false for a different type of Object
-        // This is necessary to achieve complete code coverage
-        assertThat(vfModule.equals("string"), is(false)); // NOSONAR
     }
 
+    /**
+     * Call equals() method for code coverage.
+     */
     @Test
-    public void testAddVServerWidgetToVf() {
+    public void testEquals() {
+        Resource vfModuleA = createNewVfModule();
+        populateIdentInfo(vfModuleA);
+
+        // equals() is reflexive
+        assertThat(vfModuleA.equals(vfModuleA), is(true));
+
+        // equals() is symmetric
+        Resource vfModuleB = createNewVfModule();
+        populateIdentInfo(vfModuleB);
+        assertThat(vfModuleA.equals(vfModuleB), is(true));
+        assertThat(vfModuleB.equals(vfModuleA), is(true));
+
+        assertThat(vfModuleA.equals(null), is(false));
+    }
+
+    @Test
+    public void testAddVServerWidgetToVf() throws XmlArtifactGenerationException {
         assertAddWidget(createNewVfModule(), Type.VSERVER);
     }
 
     @Test
-    public void testAddServiceWidgetToVf() {
+    public void testAddServiceWidgetToVf() throws XmlArtifactGenerationException {
         assertAddWidget(createNewVfModule(), Type.SERVICE);
     }
 
     /**
      * Add a new Widget to a VF Module, where the Widget is NOT set as a member. N.B. For the current VF Module
      * implementation the actual Widget type is not important.
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
-    public void testNonMemberWidgetToVf() {
-        VfModule vfModule = createNewVfModule();
+    public void testNonMemberWidgetToVf() throws XmlArtifactGenerationException {
+        Resource vfModule = createNewVfModule();
         assertThat(vfModule.addWidget(createNewWidget(Type.SERVICE)), is(false));
         assertNumberOfWidgets(vfModule, 0);
     }
 
     /**
      * OAM Network is specifically excluded from a VF Module.
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
-    public void testAddOamNetworkWidgetToVf() {
-        VfModule vfModule = createNewVfModule();
+    public void testAddOamNetworkWidgetToVf() throws XmlArtifactGenerationException {
+        Resource vfModule = createNewVfModule();
         assertThat(createNewWidgetForModule(vfModule, Type.OAM_NETWORK), is(false));
         assertNumberOfWidgets(vfModule, 0);
     }
@@ -114,10 +128,13 @@ public class TestVfModule {
      * <li>Add a Volume Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that the Volume Widget appears under the vserver</li>
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
-    public void testAddVolumeWidgetToVf() {
-        VfModule vfModule = createNewVfModule();
+    public void testAddVolumeWidgetToVf() throws XmlArtifactGenerationException {
+        Resource vfModule = createNewVfModule();
 
         // Adding a Volume widget has no effect until a vserver widget is added.
         assertAddWidget(vfModule, Type.VOLUME);
@@ -146,10 +163,13 @@ public class TestVfModule {
      * <li>Add an L-Interface Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that the L-Interface Widget appears under the vserver</li>
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
-    public void testAddLinterfaceWidgetToVf() {
-        VfModule vfModule = createNewVfModule();
+    public void testAddLinterfaceWidgetToVf() throws XmlArtifactGenerationException {
+        Resource vfModule = createNewVfModule();
 
         // Adding an L-Interface widget has no effect until a vserver widget is added.
         assertFailToAddWidget(vfModule, Type.LINT);
@@ -179,10 +199,13 @@ public class TestVfModule {
      * <li>Add an L-Interface Widget</li>
      * <li>Add a vserver Widget</li>
      * <li>Check that both Widgets appear under the vserver</li>
+     * 
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
     @Test
-    public void testAddVolumeAndLinterfaceWidgetToVf() {
-        VfModule vfModule = createNewVfModule();
+    public void testAddVolumeAndLinterfaceWidgetToVf() throws XmlArtifactGenerationException {
+        Resource vfModule = createNewVfModule();
 
         // Adding a Volume widget has no effect until a vserver widget is added.
         assertAddWidget(vfModule, Type.VOLUME);
@@ -216,10 +239,13 @@ public class TestVfModule {
     /**
      * Use the static Factory method to create a new Widget.
      *
-     * @param widgetType type of Widget to create
+     * @param widgetType
+     *            type of Widget to create
      * @return a new Widget
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private Widget createNewWidget(Type widgetType) {
+    private Widget createNewWidget(Type widgetType) throws XmlArtifactGenerationException {
         return Widget.getWidget(widgetType);
     }
 
@@ -228,8 +254,8 @@ public class TestVfModule {
      *
      * @return new VF Module resource
      */
-    private VfModule createNewVfModule() {
-        VfModule vfModule = new VfModule();
+    private Resource createNewVfModule() {
+        Resource vfModule = new Resource(Type.VFMODULE, true);
         assertNumberOfWidgets(vfModule, 0);
         return vfModule;
     }
@@ -237,9 +263,10 @@ public class TestVfModule {
     /**
      * Set up some dummy Model Identification properties.
      *
-     * @param vfModule to be populated
+     * @param vfModule
+     *            to be populated
      */
-    private void populateIdentInfo(VfModule vfModule) {
+    private void populateIdentInfo(Resource vfModule) {
         Map<String, String> modelIdentInfo = new HashMap<>();
         modelIdentInfo.put("UUID", "dummy_uuid");
         vfModule.populateModelIdentificationInformation(modelIdentInfo);
@@ -248,31 +275,43 @@ public class TestVfModule {
     /**
      * Create a new Widget and assert that it is successfully added to the VF Module.
      *
-     * @param vfModule the VF Module to update
-     * @param widgetType the type of Widget to create and add
+     * @param vfModule
+     *            the VF Module to update
+     * @param widgetType
+     *            the type of Widget to create and add
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private void assertAddWidget(VfModule vfModule, Type widgetType) {
+    private void assertAddWidget(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         assertThat(createNewWidgetForModule(vfModule, widgetType), is(true));
     }
 
     /**
      * Create a new Widget and assert that it cannot be added to the VF Module.
      *
-     * @param vfModule the VF Module
-     * @param widgetType the type of Widget to create and attempt to add
+     * @param vfModule
+     *            the VF Module
+     * @param widgetType
+     *            the type of Widget to create and attempt to add
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private void assertFailToAddWidget(VfModule vfModule, Type widgetType) {
+    private void assertFailToAddWidget(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         assertThat(createNewWidgetForModule(vfModule, widgetType), is(false));
     }
 
     /**
      * Create a new widget, make it a member of the VF Module, then try to add it.
      *
-     * @param vfModule the VF Module to update
-     * @param widgetType the type of Widget to create and attempt to add
+     * @param vfModule
+     *            the VF Module to update
+     * @param widgetType
+     *            the type of Widget to create and attempt to add
      * @return whether or not the Widget was added to the module
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private boolean createNewWidgetForModule(VfModule vfModule, Type widgetType) {
+    private boolean createNewWidgetForModule(Resource vfModule, Type widgetType) throws XmlArtifactGenerationException {
         Widget widget = createNewWidget(widgetType);
         setWidgetAsMember(vfModule, widget);
         return vfModule.addWidget(widget);
@@ -283,10 +322,12 @@ public class TestVfModule {
      * to its set of keys, and by then setting the VF Module's members to a Singleton List comprised of this ID. These
      * updates allow the Widget to be successfully added to the VF Module. (Non-member Widgets cannot be added.)
      *
-     * @param vfModule the module for which members are overwritten
-     * @param widget the widget to be set as the member
+     * @param vfModule
+     *            the module for which members are overwritten
+     * @param widget
+     *            the widget to be set as the member
      */
-    private void setWidgetAsMember(VfModule vfModule, Widget widget) {
+    private void setWidgetAsMember(Resource vfModule, Widget widget) {
         String id = widget.getId();
         widget.addKey(id);
         vfModule.setMembers(Collections.singletonList(id));
@@ -295,11 +336,14 @@ public class TestVfModule {
     /**
      * Create a vserver widget and add it to the specified VF Module.
      *
-     * @param vfModule the VF Module to update
+     * @param vfModule
+     *            the VF Module to update
      * @return the number of Widgets present in the vserver on creation
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private int createVserverForVf(VfModule vfModule) {
-        VServerWidget vserverWidget = (VServerWidget) createNewWidget(Type.VSERVER);
+    private int createVserverForVf(Resource vfModule) throws XmlArtifactGenerationException {
+        Widget vserverWidget = createNewWidget(Type.VSERVER);
         assertNumberOfWidgets(vfModule, 0);
         final int initialWidgetCount = addVserverToVf(vfModule, vserverWidget);
         assertNumberOfWidgets(vfModule, 1);
@@ -309,11 +353,15 @@ public class TestVfModule {
     /**
      * Add the specified vserver to the specified VF Module.
      * 
-     * @param vfModule the VF Module to update
-     * @param vserverWidget the Widget to add
+     * @param vfModule
+     *            the VF Module to update
+     * @param vserverWidget
+     *            the Widget to add
      * @return initial widget count for the vserver Widget
+     * @throws XmlArtifactGenerationException
+     *             if the Widget mapping configuration is missing
      */
-    private int addVserverToVf(VfModule vfModule, VServerWidget vserverWidget) {
+    private int addVserverToVf(Resource vfModule, Widget vserverWidget) throws XmlArtifactGenerationException {
         // A vserver (initially) has Flavor, Image, Tenant and Vfc.
         final int initialWidgetCount = 4;
         assertNumberOfWidgets(vserverWidget, initialWidgetCount);