2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018-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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.drools.pooling;
23 import static org.junit.Assert.assertEquals;
24 import static org.junit.Assert.assertTrue;
25 import static org.mockito.ArgumentMatchers.any;
26 import static org.mockito.Mockito.doAnswer;
27 import static org.mockito.Mockito.mock;
28 import static org.mockito.Mockito.when;
29 import static org.onap.policy.drools.pooling.PoolingProperties.PREFIX;
31 import com.google.gson.Gson;
32 import com.google.gson.JsonParseException;
33 import java.util.Arrays;
34 import java.util.Deque;
35 import java.util.IdentityHashMap;
36 import java.util.LinkedList;
37 import java.util.List;
38 import java.util.Properties;
39 import java.util.TreeMap;
40 import java.util.concurrent.CountDownLatch;
41 import java.util.concurrent.TimeUnit;
42 import java.util.concurrent.atomic.AtomicBoolean;
43 import java.util.concurrent.atomic.AtomicInteger;
44 import org.junit.After;
45 import org.junit.AfterClass;
46 import org.junit.Before;
47 import org.junit.BeforeClass;
48 import org.junit.Ignore;
49 import org.junit.Test;
50 import org.mockito.invocation.InvocationOnMock;
51 import org.mockito.stubbing.Answer;
52 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
53 import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
54 import org.onap.policy.common.endpoints.event.comm.TopicListener;
55 import org.onap.policy.common.endpoints.event.comm.TopicSink;
56 import org.onap.policy.common.endpoints.event.comm.TopicSource;
57 import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
58 import org.onap.policy.drools.controller.DroolsController;
59 import org.onap.policy.drools.system.PolicyController;
60 import org.onap.policy.drools.system.PolicyEngine;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
65 * End-to-end tests of the pooling feature. Launches one or more "hosts", each one having its own
66 * feature object. Uses real feature objects, as well as real DMaaP sources and sinks. However, the
67 * following are not: <dl> <dt>PolicyEngine, PolicyController, DroolsController</dt> <dd>mocked</dd>
70 * <p>The following fields must be set before executing this: <ul> <li>UEB_SERVERS</li>
71 * <li>INTERNAL_TOPIC</li> <li>EXTERNAL_TOPIC</li> </ul>
73 public class EndToEndFeatureTest {
75 private static final Logger logger = LoggerFactory.getLogger(EndToEndFeatureTest.class);
78 * UEB servers for both internal & external topics.
80 private static final String UEB_SERVERS = "";
83 * Name of the topic used for inter-host communication.
85 private static final String INTERNAL_TOPIC = "";
88 * Name of the topic from which "external" events "arrive".
90 private static final String EXTERNAL_TOPIC = "";
93 * Consumer group to use when polling the external topic.
95 private static final String EXTERNAL_GROUP = EndToEndFeatureTest.class.getName();
98 * Name of the controller.
100 private static final String CONTROLLER1 = "controller.one";
103 * Maximum number of items to fetch from DMaaP in a single poll.
105 private static final String FETCH_LIMIT = "5";
107 private static final long STD_REACTIVATE_WAIT_MS = 10000;
108 private static final long STD_IDENTIFICATION_MS = 10000;
109 private static final long STD_START_HEARTBEAT_MS = 15000;
110 private static final long STD_ACTIVE_HEARTBEAT_MS = 12000;
111 private static final long STD_INTER_HEARTBEAT_MS = 5000;
112 private static final long STD_OFFLINE_PUB_WAIT_MS = 2;
113 private static final long EVENT_WAIT_SEC = 15;
116 * Used to decode events from the external topic.
118 private static final Gson mapper = new Gson();
121 * Used to identify the current host.
123 private static final ThreadLocal<Host> currentHost = new ThreadLocal<Host>();
126 * Sink for external DMaaP topic.
128 private static TopicSink externalSink;
131 * Sink for internal DMaaP topic.
133 private static TopicSink internalSink;
136 * Context for the current test case.
141 * Setup before class.
145 public static void setUpBeforeClass() {
146 externalSink = TopicEndpoint.manager.addTopicSinks(makeSinkProperties(EXTERNAL_TOPIC)).get(0);
147 externalSink.start();
149 internalSink = TopicEndpoint.manager.addTopicSinks(makeSinkProperties(INTERNAL_TOPIC)).get(0);
150 internalSink.start();
154 * Tear down after class.
158 public static void tearDownAfterClass() {
167 public void setUp() {
175 public void tearDown() {
183 public void test_SingleHost() throws Exception {
189 public void test_TwoHosts() throws Exception {
195 public void test_ThreeHosts() throws Exception {
199 private void run(int nmessages, int nhosts) throws Exception {
200 ctx = new Context(nmessages);
202 for (int x = 0; x < nhosts; ++x) {
207 ctx.awaitAllActive(STD_IDENTIFICATION_MS * 2);
209 for (int x = 0; x < nmessages; ++x) {
210 ctx.offerExternal(makeMessage(x));
213 ctx.awaitEvents(EVENT_WAIT_SEC, TimeUnit.SECONDS);
215 assertEquals(0, ctx.getDecodeErrors());
216 assertEquals(0, ctx.getRemainingEvents());
217 ctx.checkAllSawAMsg();
220 private String makeMessage(int reqnum) {
221 return "{\"reqid\":\"req" + reqnum + "\", \"data\":\"hello " + reqnum + "\"}";
224 private static Properties makeSinkProperties(String topic) {
225 Properties props = new Properties();
227 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS, topic);
229 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
230 + PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX, UEB_SERVERS);
231 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
232 + PolicyEndPointProperties.PROPERTY_TOPIC_SINK_PARTITION_KEY_SUFFIX, "0");
233 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
234 + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "false");
239 private static Properties makeSourceProperties(String topic) {
240 Properties props = new Properties();
242 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS, topic);
244 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
245 + PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX, UEB_SERVERS);
246 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
247 + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_FETCH_LIMIT_SUFFIX, FETCH_LIMIT);
248 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
249 + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "false");
251 if (EXTERNAL_TOPIC.equals(topic)) {
252 // consumer group is a constant
253 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
254 + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX, EXTERNAL_GROUP);
256 // consumer instance is generated by the BusConsumer code
259 // else internal topic: feature populates info for internal topic
268 * @return the decoded event, or {@code null} if it cannot be decoded
270 private static Object decodeEvent(String event) {
272 return mapper.fromJson(event, TreeMap.class);
274 } catch (JsonParseException e) {
275 logger.warn("cannot decode external event", e);
281 * Context used for a single test case.
283 private static class Context {
286 * Hosts that have been added to this context.
288 private final Deque<Host> hosts = new LinkedList<>();
291 * Maps a drools controller to its policy controller.
293 private final IdentityHashMap<DroolsController, PolicyController> drools2policy = new IdentityHashMap<>();
296 * Counts the number of decode errors.
298 private final AtomicInteger decodeErrors = new AtomicInteger(0);
301 * Number of events we're still waiting to receive.
303 private final CountDownLatch eventCounter;
308 * @param nEvents number of events to be processed
310 public Context(int events) {
311 eventCounter = new CountDownLatch(events);
315 * Destroys the context, stopping any hosts that remain.
317 public void destroy() {
323 * Creates and adds a new host to the context.
325 * @return the new Host
327 public Host addHost() {
328 Host host = new Host(this);
337 public void startHosts() {
338 hosts.forEach(host -> host.start());
344 public void stopHosts() {
345 hosts.forEach(host -> host.stop());
349 * Verifies that all hosts processed at least one message.
351 public void checkAllSawAMsg() {
353 for (Host host : hosts) {
354 assertTrue("msgs=" + msgs, host.messageSeen());
360 * Offers an event to the external topic.
364 public void offerExternal(String event) {
365 externalSink.send(event);
369 * Associates a controller with its drools controller.
371 * @param controller controller
372 * @param droolsController drools controller
374 public void addController(PolicyController controller, DroolsController droolsController) {
375 drools2policy.put(droolsController, controller);
381 * @param droolsController drools controller
382 * @return the controller associated with a drools controller, or {@code null} if it has no
383 * associated controller
385 public PolicyController getController(DroolsController droolsController) {
386 return drools2policy.get(droolsController);
392 * @return the number of decode errors so far
394 public int getDecodeErrors() {
395 return decodeErrors.get();
399 * Increments the count of decode errors.
401 public void bumpDecodeErrors() {
402 decodeErrors.incrementAndGet();
406 * Get remaining events.
408 * @return the number of events that haven't been processed
410 public long getRemainingEvents() {
411 return eventCounter.getCount();
415 * Adds an event to the counter.
417 public void addEvent() {
418 eventCounter.countDown();
422 * Waits, for a period of time, for all events to be processed.
426 * @return {@code true} if all events have been processed, {@code false} otherwise
427 * @throws InterruptedException throws interrupted exception
429 public boolean awaitEvents(long time, TimeUnit units) throws InterruptedException {
430 return eventCounter.await(time, units);
434 * Waits, for a period of time, for all hosts to enter the Active state.
436 * @param timeMs maximum time to wait, in milliseconds
437 * @throws InterruptedException throws interrupted exception
439 public void awaitAllActive(long timeMs) throws InterruptedException {
440 long tend = timeMs + System.currentTimeMillis();
442 for (Host host : hosts) {
443 long tremain = Math.max(0, tend - System.currentTimeMillis());
444 assertTrue(host.awaitActive(tremain));
450 * Simulates a single "host".
452 private static class Host {
454 private final PoolingFeature feature;
457 * {@code True} if this host has processed a message, {@code false} otherwise.
459 private final AtomicBoolean sawMsg = new AtomicBoolean(false);
461 private final TopicSource externalSource;
462 private final TopicSource internalSource;
465 private final PolicyEngine engine = mock(PolicyEngine.class);
466 private final ListenerController controller = mock(ListenerController.class);
467 private final DroolsController drools = mock(DroolsController.class);
472 * @param context context
474 public Host(Context context) {
476 when(controller.getName()).thenReturn(CONTROLLER1);
477 when(controller.getDrools()).thenReturn(drools);
479 externalSource = TopicEndpoint.manager.addTopicSources(makeSourceProperties(EXTERNAL_TOPIC)).get(0);
480 internalSource = TopicEndpoint.manager.addTopicSources(makeSourceProperties(INTERNAL_TOPIC)).get(0);
482 // stop consuming events if the controller stops
483 when(controller.stop()).thenAnswer(args -> {
484 externalSource.unregister(controller);
488 doAnswer(new MyExternalTopicListener(context, this)).when(controller).onTopicEvent(any(), any(), any());
490 context.addController(controller, drools);
492 feature = new PoolingFeatureImpl(context, this);
496 * Waits, for a period of time, for the host to enter the Active state.
498 * @param timeMs time to wait, in milliseconds
499 * @return {@code true} if the host entered the Active state within the given amount of
500 * time, {@code false} otherwise
501 * @throws InterruptedException throws interrupted exception
503 public boolean awaitActive(long timeMs) throws InterruptedException {
504 return feature.getActiveLatch().await(timeMs, TimeUnit.MILLISECONDS);
508 * Starts threads for the host so that it begins consuming from both the external "DMaaP"
509 * topic and its own internal "DMaaP" topic.
511 public void start() {
512 feature.beforeStart(engine);
513 feature.afterCreate(controller);
515 feature.beforeStart(controller);
517 // start consuming events from the external topic
518 externalSource.register(controller);
520 feature.afterStart(controller);
524 * Stops the host's threads.
527 feature.beforeStop(controller);
528 externalSource.unregister(controller);
529 feature.afterStop(controller);
533 * Offers an event to the feature, before the policy controller handles it.
535 * @param protocol protocol
536 * @param topic2 topic
538 * @return {@code true} if the event was handled, {@code false} otherwise
540 public boolean beforeOffer(CommInfrastructure protocol, String topic2, String event) {
541 return feature.beforeOffer(controller, protocol, topic2, event);
545 * Offers an event to the feature, after the policy controller handles it.
547 * @param protocol protocol
550 * @param success success
551 * @return {@code true} if the event was handled, {@code false} otherwise
553 public boolean afterOffer(CommInfrastructure protocol, String topic, String event, boolean success) {
555 return feature.afterOffer(controller, protocol, topic, event, success);
559 * Offers an event to the feature, before the drools controller handles it.
562 * @return {@code true} if the event was handled, {@code false} otherwise
564 public boolean beforeInsert(Object fact) {
565 return feature.beforeInsert(drools, fact);
569 * Offers an event to the feature, after the drools controller handles it.
572 * @param successInsert {@code true} if it was successfully inserted by the drools
573 * controller, {@code false} otherwise
574 * @return {@code true} if the event was handled, {@code false} otherwise
576 public boolean afterInsert(Object fact, boolean successInsert) {
577 return feature.afterInsert(drools, fact, successInsert);
581 * Indicates that a message was seen for this host.
583 public void sawMessage() {
590 * @return {@code true} if a message was seen for this host, {@code false} otherwise
592 public boolean messageSeen() {
598 * Listener for the external topic. Simulates the actions taken by
599 * <i>AggregatedPolicyController.onTopicEvent</i>.
601 private static class MyExternalTopicListener implements Answer<Void> {
603 private final Context context;
604 private final Host host;
606 public MyExternalTopicListener(Context context, Host host) {
607 this.context = context;
612 public Void answer(InvocationOnMock args) throws Throwable {
614 CommInfrastructure commType = args.getArgument(index++);
615 String topic = args.getArgument(index++);
616 String event = args.getArgument(index++);
618 if (host.beforeOffer(commType, topic, event)) {
623 Object fact = decodeEvent(event);
627 context.bumpDecodeErrors();
632 if (!host.beforeInsert(fact)) {
633 // feature did not handle it so we handle it here
634 host.afterInsert(fact, result);
641 host.afterOffer(commType, topic, event, result);
647 * Feature with overrides.
649 private static class PoolingFeatureImpl extends PoolingFeature {
651 private final Context context;
652 private final Host host;
657 * @param context context
659 public PoolingFeatureImpl(Context context, Host host) {
660 this.context = context;
664 * Note: do NOT extract anything from "context" at this point, because it hasn't been
665 * fully initialized yet
670 public Properties getProperties(String featName) {
671 Properties props = new Properties();
673 props.setProperty(PoolingProperties.PROP_EXTRACTOR_PREFIX + ".java.util.Map", "${reqid}");
675 props.setProperty(specialize(PoolingProperties.FEATURE_ENABLED, CONTROLLER1), "true");
676 props.setProperty(specialize(PoolingProperties.POOLING_TOPIC, CONTROLLER1), INTERNAL_TOPIC);
677 props.setProperty(specialize(PoolingProperties.OFFLINE_LIMIT, CONTROLLER1), "10000");
678 props.setProperty(specialize(PoolingProperties.OFFLINE_AGE_MS, CONTROLLER1), "1000000");
679 props.setProperty(specialize(PoolingProperties.OFFLINE_PUB_WAIT_MS, CONTROLLER1),
680 "" + STD_OFFLINE_PUB_WAIT_MS);
681 props.setProperty(specialize(PoolingProperties.START_HEARTBEAT_MS, CONTROLLER1),
682 "" + STD_START_HEARTBEAT_MS);
683 props.setProperty(specialize(PoolingProperties.REACTIVATE_MS, CONTROLLER1), "" + STD_REACTIVATE_WAIT_MS);
684 props.setProperty(specialize(PoolingProperties.IDENTIFICATION_MS, CONTROLLER1), "" + STD_IDENTIFICATION_MS);
685 props.setProperty(specialize(PoolingProperties.ACTIVE_HEARTBEAT_MS, CONTROLLER1),
686 "" + STD_ACTIVE_HEARTBEAT_MS);
687 props.setProperty(specialize(PoolingProperties.INTER_HEARTBEAT_MS, CONTROLLER1),
688 "" + STD_INTER_HEARTBEAT_MS);
690 props.putAll(makeSinkProperties(INTERNAL_TOPIC));
691 props.putAll(makeSourceProperties(INTERNAL_TOPIC));
697 public PolicyController getController(DroolsController droolsController) {
698 return context.getController(droolsController);
702 * Embeds a specializer within a property name, after the prefix.
704 * @param propnm property name into which it should be embedded
705 * @param spec specializer to be embedded
706 * @return the property name, with the specializer embedded within it
708 private String specialize(String propnm, String spec) {
709 String suffix = propnm.substring(PREFIX.length());
710 return PREFIX + spec + "." + suffix;
714 protected PoolingManagerImpl makeManager(String hostName, PolicyController controller, PoolingProperties props,
715 CountDownLatch activeLatch) {
718 * Set this before creating the test, because the test's superclass
719 * constructor uses it before the test object has a chance to store it.
721 currentHost.set(host);
723 return new PoolingManagerTest(hostName, controller, props, activeLatch);
728 * Pooling Manager with overrides.
730 private static class PoolingManagerTest extends PoolingManagerImpl {
735 * @param hostName the host
736 * @param controller the controller
737 * @param props the properties
738 * @param activeLatch the latch
740 public PoolingManagerTest(String hostName, PolicyController controller,
741 PoolingProperties props, CountDownLatch activeLatch) {
743 super(hostName, controller, props, activeLatch);
747 protected DmaapManager makeDmaapManager(String topic) throws PoolingFeatureException {
748 return new DmaapManagerImpl(topic);
752 protected boolean canDecodeEvent(DroolsController drools, String topic) {
757 protected Object decodeEventWrapper(DroolsController drools, String topic, String event) {
758 return decodeEvent(event);
763 * DMaaP Manager with overrides.
765 private static class DmaapManagerImpl extends DmaapManager {
770 * @param topic the topic
771 * @throws PoolingFeatureException if an error occurs
773 public DmaapManagerImpl(String topic) throws PoolingFeatureException {
778 protected List<TopicSource> getTopicSources() {
779 Host host = currentHost.get();
780 return Arrays.asList(host.internalSource, host.externalSource);
784 protected List<TopicSink> getTopicSinks() {
785 return Arrays.asList(internalSink, externalSink);
790 * Controller that also implements the {@link TopicListener} interface.
792 private static interface ListenerController extends PolicyController, TopicListener {