From 5d7c9960d7fd51e79b19adafcc2b2625ea474ed6 Mon Sep 17 00:00:00 2001 From: "mark.j.leonard" Date: Fri, 6 Jul 2018 12:05:54 +0100 Subject: [PATCH] Create new tests for adding Widgets to VfModule Also correct formatting for Checkstyle and add Javadoc comments where missing. Issue-ID: AAI-1250 Change-Id: I614fd748fb288e6fc8f763f073e99a5067cbaac4 Signed-off-by: mark.j.leonard --- .../java/org/onap/aai/babel/logging/LogReader.java | 4 +- .../aai/babel/logging/TestApplicationLogger.java | 53 ++-- .../xml/generator/model/TestGeneratorUtil.java | 2 +- .../aai/babel/xml/generator/model/TestModel.java | 7 + .../babel/xml/generator/model/TestVfModule.java | 287 ++++++++++++++++++--- .../aai/babel/xml/generator/model/TestWidget.java | 73 +++++- 6 files changed, 345 insertions(+), 81 deletions(-) diff --git a/src/test/java/org/onap/aai/babel/logging/LogReader.java b/src/test/java/org/onap/aai/babel/logging/LogReader.java index 77b8d60..21a3d1d 100644 --- a/src/test/java/org/onap/aai/babel/logging/LogReader.java +++ b/src/test/java/org/onap/aai/babel/logging/LogReader.java @@ -79,8 +79,10 @@ public class LogReader { } /** + * Wait for and read new log entries. + * * @return new lines appended to the log file - * @throws IOException + * @throws IOException If an I/O error occurs */ public String getNewLines() throws IOException { StopWatch stopwatch = new StopWatch(); diff --git a/src/test/java/org/onap/aai/babel/logging/TestApplicationLogger.java b/src/test/java/org/onap/aai/babel/logging/TestApplicationLogger.java index 0c350c2..2719315 100644 --- a/src/test/java/org/onap/aai/babel/logging/TestApplicationLogger.java +++ b/src/test/java/org/onap/aai/babel/logging/TestApplicationLogger.java @@ -18,6 +18,7 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.logging; import static org.hamcrest.CoreMatchers.containsString; @@ -39,7 +40,7 @@ import org.onap.aai.cl.mdc.MdcOverride; /** * Simple test to log each of the validation messages in turn. - * + * * This version tests only the error logger at INFO level. * */ @@ -53,8 +54,8 @@ public class TestApplicationLogger { /** * Check that each message can be logged and that (by implication of successful logging) there is a corresponding * resource (message format). - * - * @throws IOException + * + * @throws IOException if the log files cannot be read */ @Test public void logAllMessages() throws IOException { @@ -88,21 +89,21 @@ public class TestApplicationLogger { /** * Check that each message can be logged and that (by implication of successful logging) there is a corresponding * resource (message format). - * - * @throws IOException + * + * @throws IOException if the log file cannot be read */ @Test public void logDebugMessages() throws IOException { LogReader reader = new LogReader(LogHelper.getLogDirectory(), "debug"); LogHelper.INSTANCE.debug("a message"); - String s = reader.getNewLines(); - assertThat(s, is(notNullValue())); + String str = reader.getNewLines(); + assertThat(str, is(notNullValue())); } /** - * Check logAudit with HTTP headers - * - * @throws IOException + * Check logAudit with HTTP headers. + * + * @throws IOException if the log file cannot be read */ @Test public void logAuditMessage() throws IOException { @@ -132,9 +133,9 @@ public class TestApplicationLogger { } /** - * Check logAudit with no HTTP headers - * - * @throws IOException + * Check logAudit with no HTTP headers. + * + * @throws IOException if the log file cannot be read */ @Test public void logAuditMessageWithoutHeaders() throws IOException { @@ -149,9 +150,9 @@ public class TestApplicationLogger { } /** - * Check logMetrics - * - * @throws IOException + * Check logMetrics. + * + * @throws IOException if the log file cannot be read */ @Test public void logMetricsMessage() throws IOException { @@ -204,10 +205,10 @@ public class TestApplicationLogger { } /** - * Call a logger method which is expected to throw an UnsupportedOperationException - * - * @param logMethod - * @param dummyMsg + * Call a logger method which is expected to throw an UnsupportedOperationException. + * + * @param logMethod the logger method to invoke + * @param dummyMsg any Application Message enumeration value */ private void callUnsupportedOperationMethod(TriConsumer, LogFields, String[]> logMethod, ApplicationMsgs dummyMsg) { @@ -220,12 +221,12 @@ public class TestApplicationLogger { } /** - * Assert that a log message was logged to the expected log file at the expected severity - * - * @param msg - * @param reader - * @param severity - * @throws IOException + * Assert that a log message was logged to the expected log file at the expected severity. + * + * @param msg the Application Message enumeration value + * @param reader the log reader for the message + * @param severity log level + * @throws IOException if the log file cannot be read */ private void validateLoggedMessage(ApplicationMsgs msg, LogReader reader, String severity) throws IOException { String str = reader.getNewLines(); diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestGeneratorUtil.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestGeneratorUtil.java index 151d7c9..60bcc7e 100644 --- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestGeneratorUtil.java +++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestGeneratorUtil.java @@ -17,6 +17,7 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.xml.generator.model; import static org.hamcrest.core.Is.is; @@ -35,7 +36,6 @@ public class TestGeneratorUtil { @Test public void shouldEncodeUsingBase64() { byte[] expected = Base64.getEncoder().encode(TEST_BYTES); - byte[] result = GeneratorUtil.encode(TEST_BYTES); assertThat(result, is(expected)); diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestModel.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestModel.java index fbac64c..8d6fe3e 100644 --- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestModel.java +++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestModel.java @@ -18,6 +18,7 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.xml.generator.model; import static org.hamcrest.CoreMatchers.instanceOf; @@ -50,6 +51,12 @@ public class TestModel { 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 + */ @Before public void setup() throws FileNotFoundException, IOException { InputStream in = TestModel.class.getClassLoader().getResourceAsStream("artifact-generator.properties"); diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java index 5572fe2..a07a68f 100644 --- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java +++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestVfModule.java @@ -18,10 +18,12 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.xml.generator.model; import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.CoreMatchers.notNullValue; +import static org.hamcrest.collection.IsCollectionWithSize.hasSize; import static org.junit.Assert.assertThat; import java.io.FileNotFoundException; @@ -31,24 +33,29 @@ import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.Properties; -import org.junit.Before; + +import org.junit.BeforeClass; import org.junit.Test; import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil; import org.onap.aai.babel.xml.generator.model.Widget.Type; /** - * Direct tests of the Model class VfModule so as to improve code coverage + * Direct tests of the VfModule Model class to improve code coverage. */ public class TestVfModule { static { - if (System.getProperty("APP_HOME") == null) { - System.setProperty("APP_HOME", "."); - } + System.setProperty("APP_HOME", "."); } - @Before - public void setup() throws FileNotFoundException, IOException { + /** + * 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 + */ + @BeforeClass + public static void setup() throws FileNotFoundException, IOException { InputStream in = TestVfModule.class.getClassLoader().getResourceAsStream("artifact-generator.properties"); Properties properties = new Properties(); properties.load(in); @@ -56,66 +63,266 @@ public class TestVfModule { WidgetConfigurationUtil.setConfig(properties); } + /** + * Call equals() and hashCode() methods for code coverage. + */ @Test - public void testCreateVfModule() { - VfModule vf = new VfModule(); - Map modelIdentInfo = new HashMap<>(); - modelIdentInfo.put("UUID", "dummy_uuid"); - vf.populateModelIdentificationInformation(modelIdentInfo); - assertThat(vf.hashCode(), is(notNullValue())); - assertThat(vf.equals(vf), is(true)); + public void testEqualsHashCode() { + VfModule 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(vf.equals("string"), is(false)); // NOSONAR + assertThat(vfModule.equals("string"), is(false)); // NOSONAR } @Test - public void testNonMemberWidgetToVf() { - VfModule vf = new VfModule(); - Widget widget = Widget.getWidget(Type.SERVICE); - vf.setMembers(Collections.singletonList(widget.getId())); - vf.addWidget(widget); + public void testAddVServerWidgetToVf() { + assertAddWidget(createNewVfModule(), Type.VSERVER); } @Test public void testAddServiceWidgetToVf() { - VfModule vf = new VfModule(); - addWidgetToModule(vf, Type.SERVICE); + 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. + */ @Test - public void testAddVServerWidgetToVf() { - VfModule vf = new VfModule(); - addWidgetToModule(vf, Type.VSERVER); + public void testNonMemberWidgetToVf() { + VfModule vfModule = createNewVfModule(); + assertThat(vfModule.addWidget(createNewWidget(Type.SERVICE)), is(false)); + assertNumberOfWidgets(vfModule, 0); } + /** + * OAM Network is specifically excluded from a VF Module. + */ @Test - public void testAddLIntfWidgetToVf() { - VfModule vf = new VfModule(); - addWidgetToModule(vf, Type.LINT); - addWidgetToModule(vf, Type.VSERVER); - addWidgetToModule(vf, Type.LINT); + public void testAddOamNetworkWidgetToVf() { + VfModule vfModule = createNewVfModule(); + assertThat(createNewWidgetForModule(vfModule, Type.OAM_NETWORK), is(false)); + assertNumberOfWidgets(vfModule, 0); } + /** + * Add a Volume Widget to a VF Module via a vserver Widget. + * + *
  • Create a VF Module
    • + *
  • Add a Volume Widget
    • + *
  • Add a vserver Widget
    • + *
  • Check that the Volume Widget appears under the vserver
    • + */ @Test public void testAddVolumeWidgetToVf() { - VfModule vf = new VfModule(); - addWidgetToModule(vf, Type.VOLUME); - addWidgetToModule(vf, Type.VSERVER); - addWidgetToModule(vf, Type.VOLUME); + VfModule vfModule = createNewVfModule(); + + // Adding a Volume widget has no effect until a vserver widget is added. + assertAddWidget(vfModule, Type.VOLUME); + assertNumberOfWidgets(vfModule, 0); + + final int vserverBaseWidgetCount = createVserverForVf(vfModule); + + // The vserver now has Volume as well. + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 1); + + // Adding another instance of a vserver widget fails. + assertFailToAddWidget(vfModule, Type.VSERVER); + assertNumberOfWidgets(vfModule, 1); + + // Adding another Volume widget is always treated as successful. + assertAddWidget(vfModule, Type.VOLUME); + // Assert that no additional Widgets are actually present. + assertNumberOfWidgets(vfModule, 1); + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 1); } + /** + * Add an L-Interface Widget to a VF Module via a vserver Widget. + * + *
  • Create a VF Module
    • + *
  • Add an L-Interface Widget
    • + *
  • Add a vserver Widget
    • + *
  • Check that the L-Interface Widget appears under the vserver
    • + */ @Test - public void testAddOamNetworkWidgetToVf() { - VfModule vf = new VfModule(); - addWidgetToModule(vf, Type.OAM_NETWORK); + public void testAddLinterfaceWidgetToVf() { + VfModule vfModule = createNewVfModule(); + + // Adding an L-Interface widget has no effect until a vserver widget is added. + assertFailToAddWidget(vfModule, Type.LINT); + assertNumberOfWidgets(vfModule, 0); + + final int vserverBaseWidgetCount = createVserverForVf(vfModule); + + // The vserver now has an L-Interface as well. + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 1); + + // Adding another instance of a vserver widget fails. + assertFailToAddWidget(vfModule, Type.VSERVER); + assertNumberOfWidgets(vfModule, 1); + + // Adding an L-Interface widget is always treated as successful when a vserver exists. + assertAddWidget(vfModule, Type.LINT); + // Assert that no additional Widgets are actually present. + assertNumberOfWidgets(vfModule, 1); + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 1); } - private void addWidgetToModule(VfModule vfModule, Type widgeType) { - Widget widget = Widget.getWidget(widgeType); + /** + * Add a Volume and an L-Interface Widget to a VF Module via a vserver Widget. + * + *
  • Create a VF Module
    • + *
  • Add a Volume Widget
    • + *
  • Add an L-Interface Widget
    • + *
  • Add a vserver Widget
    • + *
  • Check that both Widgets appear under the vserver
    • + */ + @Test + public void testAddVolumeAndLinterfaceWidgetToVf() { + VfModule vfModule = createNewVfModule(); + + // Adding a Volume widget has no effect until a vserver widget is added. + assertAddWidget(vfModule, Type.VOLUME); + assertNumberOfWidgets(vfModule, 0); + + // Adding an L-Interface widget has no effect until a vserver widget is added. + assertFailToAddWidget(vfModule, Type.LINT); + assertNumberOfWidgets(vfModule, 0); + + final int vserverBaseWidgetCount = createVserverForVf(vfModule); + + // The vserver now has both Volume and L-Interface. + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 2); + + // Adding another instance of a vserver widget fails. + assertFailToAddWidget(vfModule, Type.VSERVER); + assertNumberOfWidgets(vfModule, 1); + + // Add new instances (with no effect). + assertAddWidget(vfModule, Type.VOLUME); + assertAddWidget(vfModule, Type.LINT); + // Assert that no additional Widgets are in fact present. + assertNumberOfWidgets(vfModule, 1); + assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 2); + } + + private void assertNumberOfWidgets(Model model, int numberOfWidgets) { + assertThat(model.getWidgets(), hasSize(numberOfWidgets)); + } + + /** + * Use the static Factory method to create a new Widget. + * + * @param widgetType type of Widget to create + * @return a new Widget + */ + private Widget createNewWidget(Type widgetType) { + return Widget.getWidget(widgetType); + } + + /** + * Create a new VF Module that contains zero widgets and has no members. + * + * @return new VF Module resource + */ + private VfModule createNewVfModule() { + VfModule vfModule = new VfModule(); + assertNumberOfWidgets(vfModule, 0); + return vfModule; + } + + /** + * Set up some dummy Model Identification properties. + * + * @param vfModule to be populated + */ + private void populateIdentInfo(VfModule vfModule) { + Map modelIdentInfo = new HashMap<>(); + modelIdentInfo.put("UUID", "dummy_uuid"); + vfModule.populateModelIdentificationInformation(modelIdentInfo); + } + + /** + * 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 + */ + private void assertAddWidget(VfModule vfModule, Type widgetType) { + 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 + */ + private void assertFailToAddWidget(VfModule vfModule, Type widgetType) { + 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 + * @return whether or not the Widget was added to the module + */ + private boolean createNewWidgetForModule(VfModule vfModule, Type widgetType) { + Widget widget = createNewWidget(widgetType); + setWidgetAsMember(vfModule, widget); + return vfModule.addWidget(widget); + } + + /** + * Make the specified Widget the sole member of the VF Module. This is achieved by first adding the Widget's own ID + * 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 + */ + private void setWidgetAsMember(VfModule vfModule, Widget widget) { String id = widget.getId(); widget.addKey(id); vfModule.setMembers(Collections.singletonList(id)); - vfModule.addWidget(widget); + } + + /** + * Create a vserver widget and add it to the specified VF Module. + * + * @param vfModule the VF Module to update + * @return the number of Widgets present in the vserver on creation + */ + private int createVserverForVf(VfModule vfModule) { + VServerWidget vserverWidget = (VServerWidget) createNewWidget(Type.VSERVER); + assertNumberOfWidgets(vfModule, 0); + final int initialWidgetCount = addVserverToVf(vfModule, vserverWidget); + assertNumberOfWidgets(vfModule, 1); + return initialWidgetCount; + } + + /** + * Add the specified vserver to the specified VF Module. + * + * @param vfModule the VF Module to update + * @param vserverWidget the Widget to add + * @return initial widget count for the vserver Widget + */ + private int addVserverToVf(VfModule vfModule, VServerWidget vserverWidget) { + // A vserver (initially) has Flavor, Image, Tenant and Vfc. + final int initialWidgetCount = 4; + assertNumberOfWidgets(vserverWidget, initialWidgetCount); + + // Add the vserver to the VF Module. + setWidgetAsMember(vfModule, vserverWidget); + assertThat(vfModule.addWidget(vserverWidget), is(true)); + + return initialWidgetCount; } } diff --git a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java index 1865968..81db946 100644 --- a/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java +++ b/src/test/java/org/onap/aai/babel/xml/generator/model/TestWidget.java @@ -18,37 +18,84 @@ * limitations under the License. * ============LICENSE_END========================================================= */ + package org.onap.aai.babel.xml.generator.model; +import static org.hamcrest.CoreMatchers.instanceOf; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.nullValue; +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.Properties; +import org.junit.BeforeClass; import org.junit.Test; +import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil; import org.onap.aai.babel.xml.generator.model.Widget.Type; +import org.onap.aai.babel.xml.generator.types.ModelType; /** - * Direct tests of the Model so as to improve code coverage + * Direct tests of the Widget class for code coverage. */ public class TestWidget { static { - if (System.getProperty("APP_HOME") == null) { - System.setProperty("APP_HOME", "."); + 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 + */ + @BeforeClass + public static void setup() throws FileNotFoundException, IOException { + final Properties properties = new Properties(); + try (InputStream in = TestWidget.class.getClassLoader().getResourceAsStream("artifact-generator.properties")) { + properties.load(in); } + WidgetConfigurationUtil.setConfig(properties); } @Test public void testGetWidgets() { - Widget.getWidget(Type.VFC); - Widget.getWidget(Type.FLAVOR); - Widget.getWidget(Type.TENANT); - Widget.getWidget(Type.VOLUME_GROUP); - Widget.getWidget(Type.L3_NET); - Widget.getWidget(Type.IMAGE); - Widget.getWidget(Type.TUNNEL_XCONNECT); + assertThat(Widget.getWidget(Type.SERVICE), instanceOf(ServiceWidget.class)); + assertThat(Widget.getWidget(Type.VF), instanceOf(VfWidget.class)); + assertThat(Widget.getWidget(Type.VFC), instanceOf(VfcWidget.class)); + assertThat(Widget.getWidget(Type.VSERVER), instanceOf(VServerWidget.class)); + assertThat(Widget.getWidget(Type.VOLUME), instanceOf(VolumeWidget.class)); + assertThat(Widget.getWidget(Type.FLAVOR), instanceOf(FlavorWidget.class)); + assertThat(Widget.getWidget(Type.TENANT), instanceOf(TenantWidget.class)); + assertThat(Widget.getWidget(Type.VOLUME_GROUP), instanceOf(VolumeGroupWidget.class)); + assertThat(Widget.getWidget(Type.LINT), instanceOf(LIntfWidget.class)); + assertThat(Widget.getWidget(Type.L3_NET), instanceOf(L3NetworkWidget.class)); + assertThat(Widget.getWidget(Type.VFMODULE), instanceOf(VfModuleWidget.class)); + assertThat(Widget.getWidget(Type.IMAGE), instanceOf(ImageWidget.class)); + assertThat(Widget.getWidget(Type.OAM_NETWORK), instanceOf(OamNetwork.class)); + assertThat(Widget.getWidget(Type.ALLOTTED_RESOURCE), instanceOf(AllotedResourceWidget.class)); + assertThat(Widget.getWidget(Type.TUNNEL_XCONNECT), instanceOf(TunnelXconnectWidget.class)); + assertThat(Widget.getWidget(Type.CONFIGURATION), instanceOf(ConfigurationWidget.class)); } @Test - public void testMethods() { - new ServiceWidget().addWidget(new TenantWidget()); - new VolumeGroupWidget().getWidgetType(); + public void testWidgetMethods() { + Widget widget = new ServiceWidget(); + assertThat(widget.getType(), is(ModelType.WIDGET)); + assertThat(widget.getWidgetId(), is("82194af1-3c2c-485a-8f44-420e22a9eaa4")); + assertThat(widget.addWidget(new TenantWidget()), is(true)); + assertThat(widget.memberOf(null), is(false)); + assertThat(widget.memberOf(Collections.emptyList()), is(false)); + + widget = new VolumeGroupWidget(); // just for variety + assertThat(widget.getWidgetType(), is(nullValue())); } + @Test(expected = org.onap.aai.babel.xml.generator.error.IllegalAccessException.class) + public void testAddResourceIsUnsupported() { + new OamNetwork().addResource(null); + } } -- 2.16.6