2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018-2021 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.TopicEndpointManager;
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 = TopicEndpointManager.getManager().addTopicSinks(makeSinkProperties(EXTERNAL_TOPIC)).get(0);
147 externalSink.start();
149 internalSink = TopicEndpointManager.getManager().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() {
182 * This test should only be run manually, after configuring all of the fields,
183 * thus it is ignored.
187 public void test_SingleHost() throws Exception { // NOSONAR
192 * This test should only be run manually, after configuring all of the fields,
193 * thus it is ignored.
197 public void test_TwoHosts() throws Exception { // NOSONAR
202 * This test should only be run manually, after configuring all of the fields,
203 * thus it is ignored.
207 public void test_ThreeHosts() throws Exception { // NOSONAR
211 private void run(int nmessages, int nhosts) throws Exception {
212 ctx = new Context(nmessages);
214 for (int x = 0; x < nhosts; ++x) {
219 ctx.awaitAllActive(STD_IDENTIFICATION_MS * 2);
221 for (int x = 0; x < nmessages; ++x) {
222 ctx.offerExternal(makeMessage(x));
225 ctx.awaitEvents(EVENT_WAIT_SEC, TimeUnit.SECONDS);
227 assertEquals(0, ctx.getDecodeErrors());
228 assertEquals(0, ctx.getRemainingEvents());
229 ctx.checkAllSawAMsg();
232 private String makeMessage(int reqnum) {
233 return "{\"reqid\":\"req" + reqnum + "\", \"data\":\"hello " + reqnum + "\"}";
236 private static Properties makeSinkProperties(String topic) {
237 Properties props = new Properties();
239 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS, topic);
241 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
242 + PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX, UEB_SERVERS);
243 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
244 + PolicyEndPointProperties.PROPERTY_TOPIC_SINK_PARTITION_KEY_SUFFIX, "0");
245 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SINK_TOPICS + "." + topic
246 + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "false");
251 private static Properties makeSourceProperties(String topic) {
252 Properties props = new Properties();
254 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS, topic);
256 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
257 + PolicyEndPointProperties.PROPERTY_TOPIC_SERVERS_SUFFIX, UEB_SERVERS);
258 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
259 + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_FETCH_LIMIT_SUFFIX, FETCH_LIMIT);
260 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
261 + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "false");
263 if (EXTERNAL_TOPIC.equals(topic)) {
264 // consumer group is a constant
265 props.setProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic
266 + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX, EXTERNAL_GROUP);
268 // consumer instance is generated by the BusConsumer code
271 // else internal topic: feature populates info for internal topic
280 * @return the decoded event, or {@code null} if it cannot be decoded
282 private static Object decodeEvent(String event) {
284 return mapper.fromJson(event, TreeMap.class);
286 } catch (JsonParseException e) {
287 logger.warn("cannot decode external event", e);
293 * Context used for a single test case.
295 private static class Context {
298 * Hosts that have been added to this context.
300 private final Deque<Host> hosts = new LinkedList<>();
303 * Maps a drools controller to its policy controller.
305 private final IdentityHashMap<DroolsController, PolicyController> drools2policy = new IdentityHashMap<>();
308 * Counts the number of decode errors.
310 private final AtomicInteger decodeErrors = new AtomicInteger(0);
313 * Number of events we're still waiting to receive.
315 private final CountDownLatch eventCounter;
320 * @param events number of events to be processed
322 public Context(int events) {
323 eventCounter = new CountDownLatch(events);
327 * Destroys the context, stopping any hosts that remain.
329 public void destroy() {
335 * Creates and adds a new host to the context.
337 * @return the new Host
339 public Host addHost() {
340 Host host = new Host(this);
349 public void startHosts() {
350 hosts.forEach(host -> host.start());
356 public void stopHosts() {
357 hosts.forEach(host -> host.stop());
361 * Verifies that all hosts processed at least one message.
363 public void checkAllSawAMsg() {
365 for (Host host : hosts) {
366 assertTrue("msgs=" + msgs, host.messageSeen());
372 * Offers an event to the external topic.
376 public void offerExternal(String event) {
377 externalSink.send(event);
381 * Associates a controller with its drools controller.
383 * @param controller controller
384 * @param droolsController drools controller
386 public void addController(PolicyController controller, DroolsController droolsController) {
387 drools2policy.put(droolsController, controller);
393 * @param droolsController drools controller
394 * @return the controller associated with a drools controller, or {@code null} if it has no
395 * associated controller
397 public PolicyController getController(DroolsController droolsController) {
398 return drools2policy.get(droolsController);
404 * @return the number of decode errors so far
406 public int getDecodeErrors() {
407 return decodeErrors.get();
411 * Increments the count of decode errors.
413 public void bumpDecodeErrors() {
414 decodeErrors.incrementAndGet();
418 * Get remaining events.
420 * @return the number of events that haven't been processed
422 public long getRemainingEvents() {
423 return eventCounter.getCount();
427 * Adds an event to the counter.
429 public void addEvent() {
430 eventCounter.countDown();
434 * Waits, for a period of time, for all events to be processed.
438 * @return {@code true} if all events have been processed, {@code false} otherwise
439 * @throws InterruptedException throws interrupted exception
441 public boolean awaitEvents(long time, TimeUnit units) throws InterruptedException {
442 return eventCounter.await(time, units);
446 * Waits, for a period of time, for all hosts to enter the Active state.
448 * @param timeMs maximum time to wait, in milliseconds
449 * @throws InterruptedException throws interrupted exception
451 public void awaitAllActive(long timeMs) throws InterruptedException {
452 long tend = timeMs + System.currentTimeMillis();
454 for (Host host : hosts) {
455 long tremain = Math.max(0, tend - System.currentTimeMillis());
456 assertTrue(host.awaitActive(tremain));
462 * Simulates a single "host".
464 private static class Host {
466 private final PoolingFeature feature;
469 * {@code True} if this host has processed a message, {@code false} otherwise.
471 private final AtomicBoolean sawMsg = new AtomicBoolean(false);
473 private final TopicSource externalSource;
474 private final TopicSource internalSource;
477 private final PolicyEngine engine = mock(PolicyEngine.class);
478 private final ListenerController controller = mock(ListenerController.class);
479 private final DroolsController drools = mock(DroolsController.class);
484 * @param context context
486 public Host(Context context) {
488 when(controller.getName()).thenReturn(CONTROLLER1);
489 when(controller.getDrools()).thenReturn(drools);
491 externalSource = TopicEndpointManager.getManager().addTopicSources(makeSourceProperties(EXTERNAL_TOPIC))
493 internalSource = TopicEndpointManager.getManager().addTopicSources(makeSourceProperties(INTERNAL_TOPIC))
496 // stop consuming events if the controller stops
497 when(controller.stop()).thenAnswer(args -> {
498 externalSource.unregister(controller);
502 doAnswer(new MyExternalTopicListener(context, this)).when(controller).onTopicEvent(any(), any(), any());
504 context.addController(controller, drools);
506 feature = new PoolingFeatureImpl(context, this);
510 * Waits, for a period of time, for the host to enter the Active state.
512 * @param timeMs time to wait, in milliseconds
513 * @return {@code true} if the host entered the Active state within the given amount of
514 * time, {@code false} otherwise
515 * @throws InterruptedException throws interrupted exception
517 public boolean awaitActive(long timeMs) throws InterruptedException {
518 return feature.getActiveLatch().await(timeMs, TimeUnit.MILLISECONDS);
522 * Starts threads for the host so that it begins consuming from both the external "DMaaP"
523 * topic and its own internal "DMaaP" topic.
525 public void start() {
526 feature.beforeStart(engine);
527 feature.afterCreate(controller);
529 feature.beforeStart(controller);
531 // start consuming events from the external topic
532 externalSource.register(controller);
534 feature.afterStart(controller);
538 * Stops the host's threads.
541 feature.beforeStop(controller);
542 externalSource.unregister(controller);
543 feature.afterStop(controller);
547 * Offers an event to the feature, before the policy controller handles it.
549 * @param protocol protocol
550 * @param topic2 topic
552 * @return {@code true} if the event was handled, {@code false} otherwise
554 public boolean beforeOffer(CommInfrastructure protocol, String topic2, String event) {
555 return feature.beforeOffer(controller, protocol, topic2, event);
559 * Offers an event to the feature, after the policy controller handles it.
561 * @param protocol protocol
564 * @param success success
565 * @return {@code true} if the event was handled, {@code false} otherwise
567 public boolean afterOffer(CommInfrastructure protocol, String topic, String event, boolean success) {
569 return feature.afterOffer(controller, protocol, topic, event, success);
573 * Offers an event to the feature, before the drools controller handles it.
576 * @return {@code true} if the event was handled, {@code false} otherwise
578 public boolean beforeInsert(Object fact) {
579 return feature.beforeInsert(drools, fact);
583 * Offers an event to the feature, after the drools controller handles it.
586 * @param successInsert {@code true} if it was successfully inserted by the drools
587 * controller, {@code false} otherwise
588 * @return {@code true} if the event was handled, {@code false} otherwise
590 public boolean afterInsert(Object fact, boolean successInsert) {
591 return feature.afterInsert(drools, fact, successInsert);
595 * Indicates that a message was seen for this host.
597 public void sawMessage() {
604 * @return {@code true} if a message was seen for this host, {@code false} otherwise
606 public boolean messageSeen() {
612 * Listener for the external topic. Simulates the actions taken by
613 * <i>AggregatedPolicyController.onTopicEvent</i>.
615 private static class MyExternalTopicListener implements Answer<Void> {
617 private final Context context;
618 private final Host host;
620 public MyExternalTopicListener(Context context, Host host) {
621 this.context = context;
626 public Void answer(InvocationOnMock args) throws Throwable {
628 CommInfrastructure commType = args.getArgument(index++);
629 String topic = args.getArgument(index++);
630 String event = args.getArgument(index++);
632 if (host.beforeOffer(commType, topic, event)) {
637 Object fact = decodeEvent(event);
641 context.bumpDecodeErrors();
646 if (!host.beforeInsert(fact)) {
647 // feature did not handle it so we handle it here
648 host.afterInsert(fact, result);
655 host.afterOffer(commType, topic, event, result);
661 * Feature with overrides.
663 private static class PoolingFeatureImpl extends PoolingFeature {
665 private final Context context;
666 private final Host host;
671 * @param context context
673 public PoolingFeatureImpl(Context context, Host host) {
674 this.context = context;
678 * Note: do NOT extract anything from "context" at this point, because it hasn't been
679 * fully initialized yet
684 public Properties getProperties(String featName) {
685 Properties props = new Properties();
687 props.setProperty(PoolingProperties.PROP_EXTRACTOR_PREFIX + ".java.util.Map", "${reqid}");
689 props.setProperty(specialize(PoolingProperties.FEATURE_ENABLED, CONTROLLER1), "true");
690 props.setProperty(specialize(PoolingProperties.POOLING_TOPIC, CONTROLLER1), INTERNAL_TOPIC);
691 props.setProperty(specialize(PoolingProperties.OFFLINE_LIMIT, CONTROLLER1), "10000");
692 props.setProperty(specialize(PoolingProperties.OFFLINE_AGE_MS, CONTROLLER1), "1000000");
693 props.setProperty(specialize(PoolingProperties.OFFLINE_PUB_WAIT_MS, CONTROLLER1),
694 "" + STD_OFFLINE_PUB_WAIT_MS);
695 props.setProperty(specialize(PoolingProperties.START_HEARTBEAT_MS, CONTROLLER1),
696 "" + STD_START_HEARTBEAT_MS);
697 props.setProperty(specialize(PoolingProperties.REACTIVATE_MS, CONTROLLER1), "" + STD_REACTIVATE_WAIT_MS);
698 props.setProperty(specialize(PoolingProperties.IDENTIFICATION_MS, CONTROLLER1), "" + STD_IDENTIFICATION_MS);
699 props.setProperty(specialize(PoolingProperties.ACTIVE_HEARTBEAT_MS, CONTROLLER1),
700 "" + STD_ACTIVE_HEARTBEAT_MS);
701 props.setProperty(specialize(PoolingProperties.INTER_HEARTBEAT_MS, CONTROLLER1),
702 "" + STD_INTER_HEARTBEAT_MS);
704 props.putAll(makeSinkProperties(INTERNAL_TOPIC));
705 props.putAll(makeSourceProperties(INTERNAL_TOPIC));
711 public PolicyController getController(DroolsController droolsController) {
712 return context.getController(droolsController);
716 * Embeds a specializer within a property name, after the prefix.
718 * @param propnm property name into which it should be embedded
719 * @param spec specializer to be embedded
720 * @return the property name, with the specializer embedded within it
722 private String specialize(String propnm, String spec) {
723 String suffix = propnm.substring(PREFIX.length());
724 return PREFIX + spec + "." + suffix;
728 protected PoolingManagerImpl makeManager(String hostName, PolicyController controller, PoolingProperties props,
729 CountDownLatch activeLatch) {
732 * Set this before creating the test, because the test's superclass
733 * constructor uses it before the test object has a chance to store it.
735 currentHost.set(host);
737 return new PoolingManagerTest(hostName, controller, props, activeLatch);
742 * Pooling Manager with overrides.
744 private static class PoolingManagerTest extends PoolingManagerImpl {
749 * @param hostName the host
750 * @param controller the controller
751 * @param props the properties
752 * @param activeLatch the latch
754 public PoolingManagerTest(String hostName, PolicyController controller,
755 PoolingProperties props, CountDownLatch activeLatch) {
757 super(hostName, controller, props, activeLatch);
761 protected DmaapManager makeDmaapManager(String topic) throws PoolingFeatureException {
762 return new DmaapManagerImpl(topic);
766 protected boolean canDecodeEvent(DroolsController drools, String topic) {
771 protected Object decodeEventWrapper(DroolsController drools, String topic, String event) {
772 return decodeEvent(event);
777 * DMaaP Manager with overrides.
779 private static class DmaapManagerImpl extends DmaapManager {
784 * @param topic the topic
785 * @throws PoolingFeatureException if an error occurs
787 public DmaapManagerImpl(String topic) throws PoolingFeatureException {
792 protected List<TopicSource> getTopicSources() {
793 Host host = currentHost.get();
794 return Arrays.asList(host.internalSource, host.externalSource);
798 protected List<TopicSink> getTopicSinks() {
799 return Arrays.asList(internalSink, externalSink);
804 * Controller that also implements the {@link TopicListener} interface.
806 private static interface ListenerController extends PolicyController, TopicListener {