5cb9bcbd848e2038910903779cb4d3a2225af2ed
[policy/common.git] /
1 /*
2  * ============LICENSE_START=======================================================
3  * ONAP
4  * ================================================================================
5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.policy.common.endpoints.event.comm.bus;
22
23 import static org.assertj.core.api.Assertions.assertThatThrownBy;
24 import static org.junit.Assert.assertEquals;
25 import static org.junit.Assert.assertNotNull;
26 import static org.junit.Assert.assertNotSame;
27 import static org.junit.Assert.assertSame;
28 import static org.junit.Assert.assertTrue;
29 import static org.onap.policy.common.endpoints.properties.PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX;
30 import static org.onap.policy.common.endpoints.properties.PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX;
31
32 import java.util.ArrayList;
33 import java.util.Arrays;
34 import java.util.Collections;
35 import java.util.List;
36 import java.util.Properties;
37 import org.apache.commons.lang3.RandomStringUtils;
38 import org.junit.After;
39 import org.junit.Before;
40 import org.junit.Test;
41 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
42 import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
43
44 public abstract class NoopTopicFactoryTest<F extends NoopTopicFactory<T>, T extends NoopTopicEndpoint>
45     extends TopicFactoryTestBase<T> {
46
47     private static final List<String> NOOP_SERVERS = Arrays.asList(CommInfrastructure.NOOP.toString());
48     private F factory = null;
49
50     protected abstract F buildFactory();
51
52     /**
53      * Creates the object to be tested.
54      */
55     @Before
56     @Override
57     public void setUp() {
58         super.setUp();
59         initFactory();
60     }
61
62     @After
63     public void tearDown() {
64         factory.destroy();
65     }
66
67     @Test
68     public void testBuildBusTopicParams() {
69         initFactory();
70
71         T item1 = buildTopic(makeParams(servers, MY_TOPIC, true));
72         assertNotNull(item1);
73
74         assertEquals(servers, item1.getServers());
75         assertEquals(MY_TOPIC, item1.getTopic());
76     }
77
78     @Test
79     public void testBuildListOfStringStringBoolean() {
80         initFactory();
81
82         T item1 = buildTopic(servers, MY_TOPIC, true);
83         assertNotNull(item1);
84
85         assertEquals(servers, item1.getServers());
86         assertEquals(MY_TOPIC, item1.getTopic());
87
88         // managed topic - should not build a new one
89         assertEquals(item1, buildTopic(servers, MY_TOPIC, true));
90
91         T item2 = buildTopic(servers, TOPIC2, true);
92         assertNotNull(item2);
93         assertNotSame(item1, item2);
94
95         // duplicate - should be the same, as these topics are managed
96         List<String> randomServers = new ArrayList<>();
97         randomServers.add(RandomStringUtils.randomAlphanumeric(8));
98         T item3 = buildTopic(randomServers, TOPIC2, true);
99         assertSame(item2, item3);
100
101         T item4 = buildTopic(Collections.emptyList(), TOPIC2, true);
102         assertSame(item3, item4);
103
104         // null server list
105         initFactory();
106         assertEquals(NOOP_SERVERS, buildTopic(null, MY_TOPIC, true).getServers());
107
108         // empty server list
109         initFactory();
110         assertEquals(NOOP_SERVERS, buildTopic(Collections.emptyList(), MY_TOPIC, true).getServers());
111
112         // unmanaged topic
113         initFactory();
114         item1 = buildTopic(servers, MY_TOPIC, false);
115         assertNotSame(item1, buildTopic(servers, MY_TOPIC, false));
116     }
117
118     @Test(expected = IllegalArgumentException.class)
119     public void testBuildListOfStringStringBoolean_NullTopic() {
120         buildTopic(servers, null, true);
121     }
122
123     @Test(expected = IllegalArgumentException.class)
124     public void testBuildListOfStringStringBoolean_EmptyTopic() {
125         buildTopic(servers, "", true);
126     }
127
128     @Test
129     public void testBuildProperties() {
130         // managed topic
131         initFactory();
132         assertEquals(1, buildTopics(makePropBuilder().makeTopic(MY_TOPIC).build()).size());
133         assertNotNull(factory.get(MY_TOPIC));
134
135         // unmanaged topic - get() will throw an exception
136         initFactory();
137         assertEquals(1, buildTopics(makePropBuilder().makeTopic(MY_TOPIC)
138                         .setTopicProperty(PROPERTY_MANAGED_SUFFIX, "false").build()).size());
139         assertThatThrownBy(() -> factory.get(MY_TOPIC));
140
141         // managed undefined - default to true
142         initFactory();
143         assertEquals(1, buildTopics(
144                         makePropBuilder().makeTopic(MY_TOPIC).removeTopicProperty(PROPERTY_MANAGED_SUFFIX).build())
145                                         .size());
146         assertNotNull(factory.get(MY_TOPIC));
147
148         // managed empty - default to true
149         initFactory();
150         assertEquals(1, buildTopics(
151                         makePropBuilder().makeTopic(MY_TOPIC).setTopicProperty(PROPERTY_MANAGED_SUFFIX, "").build())
152                                         .size());
153         assertNotNull(factory.get(MY_TOPIC));
154
155         initFactory();
156
157         // null topic list
158         assertTrue(buildTopics(makePropBuilder().build()).isEmpty());
159
160         // empty topic list
161         assertTrue(buildTopics(makePropBuilder().addTopic("").build()).isEmpty());
162
163         // null server list
164         initFactory();
165         T endpoint = buildTopics(makePropBuilder().makeTopic(MY_TOPIC)
166                         .removeTopicProperty(PROPERTY_TOPIC_SERVERS_SUFFIX).build()).get(0);
167         assertEquals(NOOP_SERVERS, endpoint.getServers());
168
169         // empty server list
170         initFactory();
171         endpoint = buildTopics(makePropBuilder().makeTopic(MY_TOPIC).setTopicProperty(PROPERTY_TOPIC_SERVERS_SUFFIX, "")
172                         .build()).get(0);
173         assertEquals(NOOP_SERVERS, endpoint.getServers());
174
175         // test other options
176         super.testBuildProperties_Multiple();
177     }
178
179     @Test
180     @Override
181     public void testDestroyString_testGet_testInventory() {
182         super.testDestroyString_testGet_testInventory();
183         super.testDestroyString_Ex();
184     }
185
186     @Test
187     @Override
188     public void testDestroy() {
189         super.testDestroy();
190     }
191
192     @Test
193     public void testGet() {
194         super.testGet_Ex();
195     }
196
197     @Override
198     protected void initFactory() {
199         if (factory != null) {
200             factory.destroy();
201         }
202
203         factory = buildFactory();
204     }
205
206     @Override
207     protected List<T> buildTopics(Properties properties) {
208         return factory.build(properties);
209     }
210
211     protected T buildTopic(BusTopicParams param) {
212         return factory.build(param);
213     }
214
215     protected T buildTopic(List<String> servers, String topic, boolean managed) {
216         return factory.build(servers, topic, managed);
217     }
218
219     @Override
220     protected void destroyFactory() {
221         factory.destroy();
222     }
223
224     @Override
225     protected void destroyTopic(String topic) {
226         factory.destroy(topic);
227     }
228
229     @Override
230     protected List<T> getInventory() {
231         return factory.inventory();
232     }
233
234     @Override
235     protected T getTopic(String topic) {
236         return factory.get(topic);
237     }
238
239     @Override
240     protected TopicPropertyBuilder makePropBuilder() {
241         return new NoopTopicPropertyBuilder(factory.getTopicsPropertyName());
242     }
243
244     private BusTopicParams makeParams(List<String> servers, String topic, boolean managed) {
245         BusTopicParams params = new BusTopicParams();
246
247         params.setServers(servers);
248         params.setTopic(topic);
249         params.setManaged(managed);
250
251         return params;
252     }
253 }