models-interactions/model-actors/actor.test/src/main/java/org/onap/policy/controlloop/actor/test/BasicBidirectionalTopicOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020 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.controlloop.actor.test;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.mockito.Mockito.when;
  25
  26 import java.util.List;
  27 import java.util.function.BiConsumer;
  28 import org.mockito.ArgumentCaptor;
  29 import org.mockito.Captor;
  30 import org.mockito.Mock;
  31 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
  32 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  33 import org.onap.policy.common.endpoints.event.comm.TopicSource;
  34 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  35 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
  36 import org.onap.policy.common.endpoints.parameters.TopicParameters;
  37 import org.onap.policy.common.utils.coder.CoderException;
  38 import org.onap.policy.common.utils.coder.StandardCoderObject;
  39 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
  40 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
  41 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager;
  42 import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
  43 import org.onap.policy.simulators.TopicServer;
  44 import org.onap.policy.simulators.Util;
  45
  46 /**
  47  * Superclass for various BidirectionalTopicOperation tests.
  48  *
  49  * @param <Q> request type
  50  */
  51 public abstract class BasicBidirectionalTopicOperation<Q> extends BasicOperation {
  52     protected static final String MY_SINK = "my-sink";
  53     protected static final String MY_SOURCE = "my-source";
  54     protected static final int TIMEOUT_SEC = 10;
  55     protected static final long TIMEOUT_MS = 1000L * TIMEOUT_SEC;
  56
  57     // sink and source used by the TopicServer
  58     private static TopicSink serverSink;
  59     private static TopicSource serverSource;
  60     private static BidirectionalTopicHandler realTopicHandler;
  61
  62     protected static BidirectionalTopicManager topicMgr = (sink, source) -> {
  63         // note: the sink and source names are swapped for the simulator
  64         assertEquals(serverSource.getTopic(), sink);
  65         assertEquals(serverSink.getTopic(), source);
  66         return realTopicHandler;
  67     };
  68
  69     @Captor
  70     protected ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
  71
  72     @Mock
  73     protected BidirectionalTopicHandler topicHandler;
  74     @Mock
  75     protected Forwarder forwarder;
  76     @Mock
  77     protected BidirectionalTopicConfig config;
  78
  79     private TopicServer<Q> topicServer;
  80
  81     /**
  82      * Constructs the object using a default actor and operation name.
  83      */
  84     public BasicBidirectionalTopicOperation() {
  85         super();
  86     }
  87
  88     /**
  89      * Constructs the object.
  90      *
  91      * @param actor actor name
  92      * @param operation operation name
  93      */
  94     public BasicBidirectionalTopicOperation(String actor, String operation) {
  95         super(actor, operation);
  96     }
  97
  98     /**
  99      * Starts the topic.
 100      */
 101     protected static void initBeforeClass(String sinkTopic, String sourceTopic) throws Exception {
 102
 103         Util.buildDmaapSim();
 104
 105         // note: the sink and source names are swapped for the simulator
 106         TopicParameters ptopic = new TopicParameters();
 107         ptopic.setTopic(sourceTopic);
 108         ptopic.setManaged(true);
 109         ptopic.setServers(List.of("localhost"));
 110         ptopic.setTopicCommInfrastructure("dmaap");
 111         ptopic.setFetchTimeout(500);
 112         serverSink = TopicEndpointManager.getManager().addTopicSinks(List.of(ptopic)).get(0);
 113
 114         ptopic.setTopic(sinkTopic);
 115         serverSource = TopicEndpointManager.getManager().addTopicSources(List.of(ptopic)).get(0);
 116
 117         serverSink.start();
 118         serverSource.start();
 119
 120         if (!sinkTopic.equals(sourceTopic)) {
 121             // sink and source are different - create other ends for the actor
 122             initActorTopics(sinkTopic, sourceTopic, ptopic);
 123         }
 124
 125         realTopicHandler = new BidirectionalTopicHandler(sinkTopic, sourceTopic);
 126         realTopicHandler.start();
 127     }
 128
 129     private static void initActorTopics(String sinkTopic, String sourceTopic, TopicParameters ptopic) {
 130         // create sink and source for the actor, too
 131         ptopic.setTopic(sinkTopic);
 132         TopicEndpointManager.getManager().addTopicSinks(List.of(ptopic)).get(0).start();
 133
 134         ptopic.setTopic(sourceTopic);
 135         TopicEndpointManager.getManager().addTopicSources(List.of(ptopic)).get(0).start();
 136     }
 137
 138     protected static void destroyAfterClass() {
 139         TopicEndpointManager.getManager().shutdown();
 140         HttpServletServerFactoryInstance.getServerFactory().destroy();
 141         HttpClientFactoryInstance.getClientFactory().destroy();
 142     }
 143
 144     /**
 145      * Initializes mocks and sets up.
 146      */
 147     @Override
 148     public void setUpBasic() {
 149         super.setUpBasic();
 150         topicServer = makeServer(serverSink, serverSource);
 151         initConfig();
 152     }
 153
 154     public void tearDownBasic() {
 155         topicServer.shutdown();
 156     }
 157
 158     /**
 159      * Makes a simulator for the given sink and source.
 160      *
 161      * @param sink topic to which the simulator should publish responses
 162      * @param source topic from which the simulator should receive messages
 163      * @return a new topic server/simulator
 164      */
 165     protected abstract TopicServer<Q> makeServer(TopicSink sink, TopicSource source);
 166
 167     /**
 168      * Initializes a configuration.
 169      */
 170     protected void initConfig() {
 171         when(config.getTopicHandler()).thenReturn(topicHandler);
 172         when(config.getForwarder()).thenReturn(forwarder);
 173         when(config.getTimeoutMs()).thenReturn(TIMEOUT_MS);
 174     }
 175
 176     /**
 177      * Provides a response to the topic {@link #listenerCaptor}.
 178      *
 179      * @param listener listener to which to provide the response
 180      * @param response response to be provided
 181      */
 182     protected void provideResponse(BiConsumer<String, StandardCoderObject> listener, String response) {
 183         try {
 184             StandardCoderObject sco = coder.decode(response, StandardCoderObject.class);
 185             listener.accept(response, sco);
 186
 187         } catch (CoderException e) {
 188             throw new IllegalArgumentException("response is not a Map", e);
 189         }
 190     }
 191 }