1 files changed, 245 insertions, 0 deletions
diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/event/comm/bus/TopicFactoryTestBase.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/event/comm/bus/TopicFactoryTestBase.java
new file mode 100644
index 00000000..29816c6e
--- /dev/null
+++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/event/comm/bus/TopicFactoryTestBase.java
@@ -0,0 +1,245 @@
+/*
+ * ============LICENSE_START=======================================================
+ * policy-endpoints
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.common.endpoints.event.comm.bus;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+import static org.onap.policy.common.endpoints.properties.PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX;
+
+import java.util.List;
+import java.util.Properties;
+import org.onap.policy.common.endpoints.event.comm.Topic;
+
+/**
+ * Base class for XxxTopicFactory tests.
+ *
+ * @param <T> type of topic managed by the factory
+ */
+public abstract class TopicFactoryTestBase<T extends Topic> extends TopicTestBase {
+
+    public static final String SERVER = "my-server";
+    public static final String TOPIC2 = "my-topic-2";
+
+    /**
+     * Initializes a new factory.
+     */
+    protected abstract void initFactory();
+
+    /**
+     * Makes a property builder.
+     *
+     * @return a new property builder
+     */
+    protected abstract TopicPropertyBuilder makePropBuilder();
+
+    /**
+     * Builds a set of topics.
+     *
+     * @param properties the properties used to configure the topics
+     * @return a list of new topics
+     */
+    protected abstract List<T> buildTopics(Properties properties);
+
+    /**
+     * Destroys the factory.
+     */
+    protected abstract void destroyFactory();
+
+    /**
+     * Destroys a topic within the factory.
+     *
+     * @param topic the topic to destroy
+     */
+    protected abstract void destroyTopic(String topic);
+
+    /**
+     * Gets the list of topics from the factory.
+     *
+     * @return the topic inventory
+     */
+    protected abstract List<T> getInventory();
+
+    /**
+     * Gets a topic from the factory.
+     *
+     * @param topic the topic name
+     * @return the topic
+     */
+    protected abstract T getTopic(String topic);
+
+
+    /**
+     * Tests building a topic using varied Properties.
+     */
+    public void testBuildProperties_Variations() {
+        initFactory();
+
+        // null topic list
+        assertTrue(buildTopics(makePropBuilder().build()).isEmpty());
+
+        // empty topic list
+        assertTrue(buildTopics(makePropBuilder().addTopic("").build()).isEmpty());
+
+        // null servers
+        assertTrue(buildTopics(makePropBuilder().makeTopic(MY_TOPIC).removeTopicProperty(PROPERTY_TOPIC_SERVERS_SUFFIX)
+                        .build()).isEmpty());
+
+        // empty servers
+        assertTrue(buildTopics(makePropBuilder().makeTopic(MY_TOPIC).setTopicProperty(PROPERTY_TOPIC_SERVERS_SUFFIX, "")
+                        .build()).isEmpty());
+    }
+
+    /**
+     * Tests building multiple topics using Properties.
+     */
+    public void testBuildProperties_Multiple() {
+        initFactory();
+
+        // make two fully-defined topics, and add two duplicate topic names to the list
+        TopicPropertyBuilder builder =
+                        makePropBuilder().makeTopic(MY_TOPIC).makeTopic(TOPIC2).addTopic(MY_TOPIC).addTopic(MY_TOPIC);
+
+        List<T> lst = buildTopics(builder.build());
+        assertEquals(4, lst.size());
+
+        int index = 0;
+        T item = lst.get(index++);
+        assertTrue(item != lst.get(index++));
+        assertTrue(item == lst.get(index++));
+        assertTrue(item == lst.get(index++));
+    }
+
+    /**
+     * Tests destroy(topic), get(topic), and inventory() methods.
+     */
+    public void testDestroyString_testGet_testInventory() {
+        initFactory();
+
+        List<T> lst = buildTopics(makePropBuilder().makeTopic(MY_TOPIC).makeTopic(TOPIC2).build());
+
+        int index = 0;
+        T item1 = lst.get(index++);
+        T item2 = lst.get(index++);
+
+        assertEquals(2, getInventory().size());
+        assertTrue(getInventory().contains(item1));
+        assertTrue(getInventory().contains(item2));
+
+        item1.start();
+        item2.start();
+
+        assertEquals(item1, getTopic(MY_TOPIC));
+        assertEquals(item2, getTopic(TOPIC2));
+
+        destroyTopic(MY_TOPIC);
+        assertFalse(item1.isAlive());
+        assertTrue(item2.isAlive());
+        assertEquals(item2, getTopic(TOPIC2));
+        assertEquals(1, getInventory().size());
+        assertTrue(getInventory().contains(item2));
+
+        // repeat
+        destroyTopic(MY_TOPIC);
+        assertFalse(item1.isAlive());
+        assertTrue(item2.isAlive());
+
+        // with other topic
+        destroyTopic(TOPIC2);
+        assertFalse(item1.isAlive());
+        assertFalse(item2.isAlive());
+        assertEquals(0, getInventory().size());
+    }
+
+    /**
+     * Tests exception cases with destroy(topic).
+     */
+    public void testDestroyString_Ex() {
+        // null topic
+        RuntimeException actual = expectException(() -> destroyTopic(null));
+        assertEquals(IllegalArgumentException.class, actual.getClass());
+
+        // empty topic
+        actual = expectException(() -> destroyTopic(""));
+        assertEquals(IllegalArgumentException.class, actual.getClass());
+    }
+
+    /**
+     * Tests the destroy() method.
+     */
+    public void testDestroy() {
+        initFactory();
+
+        List<T> lst = buildTopics(makePropBuilder().makeTopic(MY_TOPIC).makeTopic(TOPIC2).build());
+
+        int index = 0;
+        T item1 = lst.get(index++);
+        T item2 = lst.get(index++);
+
+        item1.start();
+        item2.start();
+
+        destroyFactory();
+
+        assertFalse(item1.isAlive());
+        assertFalse(item2.isAlive());
+        assertEquals(0, getInventory().size());
+    }
+
+    /**
+     * Tests exception cases with get(topic).
+     */
+    public void testGet_Ex() {
+        // null topic
+        RuntimeException actual = expectException(() -> getTopic(null));
+        assertEquals("null topic", IllegalArgumentException.class, actual.getClass());
+
+        // empty topic
+        actual = expectException(() -> getTopic(""));
+        assertEquals("empty topic", IllegalArgumentException.class, actual.getClass());
+
+        // unknown topic
+        initFactory();
+        buildTopics(makePropBuilder().makeTopic(MY_TOPIC).build());
+
+        actual = expectException(() -> getTopic(TOPIC2));
+        assertEquals("unknown topic", IllegalStateException.class, actual.getClass());
+    }
+
+    /**
+     * Runs a function that is expected to throw an exception. Invokes fail() if the
+     * function does not throw an exception.
+     *
+     * @param function the function to run
+     * @return the exception thrown by the function
+     */
+    public RuntimeException expectException(Runnable function) {
+        try {
+            function.run();
+            fail("missing exception");
+            return null;
+
+        } catch (RuntimeException e) {
+            return e;
+        }
+    }
+}