* ============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.
* 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;
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.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;
+import org.onap.aai.babel.util.ArtifactTestUtils;
+import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
/**
- * Direct tests of the Model class VfModule so as to improve code coverage
+ * Direct tests of the VFMODULE Resource and Widget functionality to improve code coverage.
*/
public class TestVfModule {
- static {
- if (System.getProperty("AJSC_HOME") == null) {
- System.setProperty("AJSC_HOME", ".");
- }
+ /**
+ * Load the Widget mappings configuration.
+ *
+ * @throws IOException
+ * if the mappings configuration cannot be loaded
+ */
+ @BeforeClass
+ public static void setup() throws IOException {
+ new ArtifactTestUtils().loadWidgetMappings();
}
- @Before
- public 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);
+ /**
+ * Call hashCode() method for code coverage.
+ */
+ @Test
+ public void testHashCode() {
+ Resource vfModule = createNewVfModule();
+ populateIdentInfo(vfModule);
+ assertThat(vfModule.hashCode(), is(notNullValue()));
}
+ /**
+ * Call equals() method for code coverage.
+ */
@Test
- public void testCreateVfModule() {
- VfModule vf = new VfModule();
- Map<String, String> modelIdentInfo = new HashMap<>();
- modelIdentInfo.put("UUID", "dummy_uuid");
- vf.populateModelIdentificationInformation(modelIdentInfo);
- assertThat(vf.hashCode(), is(notNullValue()));
- assertThat(vf.equals(vf), 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
+ 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 testNonMemberWidgetToVF() {
- VfModule vf = new VfModule();
- Widget widget = Widget.getWidget(Type.SERVICE);
- vf.setMembers(Collections.singletonList(widget.getId()));
- vf.addWidget(widget);
+ public void testAddVServerWidgetToVf() throws XmlArtifactGenerationException {
+ assertAddWidget(createNewVfModule(), WidgetType.valueOf("VSERVER"));
}
@Test
- public void testAddServiceWidgetToVF() {
- VfModule vf = new VfModule();
- addWidgetToModule(vf, Type.SERVICE);
+ public void testAddServiceWidgetToVf() throws XmlArtifactGenerationException {
+ assertAddWidget(createNewVfModule(), WidgetType.valueOf("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 testAddVServerWidgetToVF() {
- VfModule vf = new VfModule();
- addWidgetToModule(vf, Type.VSERVER);
+ public void testNonMemberWidgetToVf() throws XmlArtifactGenerationException {
+ Resource vfModule = createNewVfModule();
+ assertThat(vfModule.addWidget(Widget.createWidget("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 testAddLIntfWidgetToVF() {
- VfModule vf = new VfModule();
- addWidgetToModule(vf, Type.LINT);
- addWidgetToModule(vf, Type.VSERVER);
- addWidgetToModule(vf, Type.LINT);
+ public void testAddOamNetworkWidgetToVf() throws XmlArtifactGenerationException {
+ Resource vfModule = createNewVfModule();
+ assertThat(createNewWidgetForModule(vfModule, WidgetType.valueOf("OAM_NETWORK")), is(false));
+ assertNumberOfWidgets(vfModule, 0);
}
+ /**
+ * Add a Volume Widget to a VF Module via a vserver Widget.
+ *
+ * <li>Create a VF Module</li>
+ * <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 vf = new VfModule();
- addWidgetToModule(vf, Type.VOLUME);
- addWidgetToModule(vf, Type.VSERVER);
- addWidgetToModule(vf, Type.VOLUME);
+ public void testAddVolumeWidgetToVf() throws XmlArtifactGenerationException {
+ Resource vfModule = createNewVfModule();
+
+ // Adding a Volume widget has no effect until a vserver widget is added.
+ assertAddWidget(vfModule, WidgetType.valueOf("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, WidgetType.valueOf("VSERVER"));
+ assertNumberOfWidgets(vfModule, 1);
+
+ // Adding another Volume widget is always treated as successful.
+ assertAddWidget(vfModule, WidgetType.valueOf("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.
+ *
+ * <li>Create a VF Module</li>
+ * <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 testAddOAMNetworkWidgetToVF() {
- VfModule vf = new VfModule();
- addWidgetToModule(vf, Type.OAM_NETWORK);
+ public void testAddLinterfaceWidgetToVf() throws XmlArtifactGenerationException {
+ Resource vfModule = createNewVfModule();
+
+ // Adding an L-Interface widget has no effect until a vserver widget is added.
+ assertFailToAddWidget(vfModule, WidgetType.valueOf("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, WidgetType.valueOf("VSERVER"));
+ assertNumberOfWidgets(vfModule, 1);
+
+ // Adding an L-Interface widget is always treated as successful when a vserver exists.
+ assertAddWidget(vfModule, WidgetType.valueOf("LINT"));
+ // Assert that no additional Widgets are actually present.
+ assertNumberOfWidgets(vfModule, 1);
+ assertNumberOfWidgets(vfModule.vserver, vserverBaseWidgetCount + 1);
+ }
+
+ /**
+ * Add a Volume and an L-Interface Widget to a VF Module via a vserver Widget.
+ *
+ * <li>Create a VF Module</li>
+ * <li>Add a Volume Widget</li>
+ * <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() throws XmlArtifactGenerationException {
+ Resource vfModule = createNewVfModule();
+
+ // Adding a Volume widget has no effect until a vserver widget is added.
+ assertAddWidget(vfModule, WidgetType.valueOf("VOLUME"));
+ assertNumberOfWidgets(vfModule, 0);
+
+ // Adding an L-Interface widget has no effect until a vserver widget is added.
+ assertFailToAddWidget(vfModule, WidgetType.valueOf("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, WidgetType.valueOf("VSERVER"));
+ assertNumberOfWidgets(vfModule, 1);
+
+ // Add new instances (with no effect).
+ assertAddWidget(vfModule, WidgetType.valueOf("VOLUME"));
+ assertAddWidget(vfModule, WidgetType.valueOf("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));
+ }
+
+ /**
+ * Create a new VF Module that contains zero widgets and has no members.
+ *
+ * @return new VF Module resource
+ */
+ private Resource createNewVfModule() {
+ Resource vfModule = new Resource(WidgetType.valueOf("VFMODULE"), true);
+ assertNumberOfWidgets(vfModule, 0);
+ return vfModule;
+ }
+
+ /**
+ * Set up some dummy Model Identification properties.
+ *
+ * @param vfModule
+ * to be populated
+ */
+ private void populateIdentInfo(Resource vfModule) {
+ Map<String, String> modelIdentInfo = new HashMap<>();
+ modelIdentInfo.put("UUID", "dummy_uuid");
+ vfModule.populateModelIdentificationInformation(modelIdentInfo);
}
- private void addWidgetToModule(VfModule vfModule, Type widgeType) {
- Widget widget = Widget.getWidget(widgeType);
+ /**
+ * 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
+ * @throws XmlArtifactGenerationException
+ * if the Widget mapping configuration is missing
+ */
+ private void assertAddWidget(Resource vfModule, WidgetType 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
+ * @throws XmlArtifactGenerationException
+ * if the Widget mapping configuration is missing
+ */
+ private void assertFailToAddWidget(Resource vfModule, WidgetType 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
+ * @return whether or not the Widget was added to the module
+ * @throws XmlArtifactGenerationException
+ * if the Widget mapping configuration is missing
+ */
+ private boolean createNewWidgetForModule(Resource vfModule, WidgetType widgetType)
+ throws XmlArtifactGenerationException {
+ Widget widget = Widget.createWidget(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(Resource 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
+ * @throws XmlArtifactGenerationException
+ * if the Widget mapping configuration is missing
+ */
+ private int createVserverForVf(Resource vfModule) throws XmlArtifactGenerationException {
+ Widget vserverWidget = Widget.createWidget("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
+ * @throws XmlArtifactGenerationException
+ * if the Widget mapping configuration is missing
+ */
+ 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);
+
+ // Add the vserver to the VF Module.
+ setWidgetAsMember(vfModule, vserverWidget);
+ assertThat(vfModule.addWidget(vserverWidget), is(true));
+
+ return initialWidgetCount;
}
}
Code Review / aai / babel.git / blobdiff