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-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2023-2024 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actor.test;
  23
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.fail;
  26 import static org.mockito.Mockito.lenient;
  27
  28 import java.util.List;
  29 import java.util.function.BiConsumer;
  30 import lombok.AccessLevel;
  31 import lombok.NoArgsConstructor;
  32 import org.mockito.ArgumentCaptor;
  33 import org.mockito.Captor;
  34 import org.mockito.Mock;
  35 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
  36 import org.onap.policy.common.endpoints.event.comm.TopicSink;
  37 import org.onap.policy.common.endpoints.event.comm.TopicSource;
  38 import org.onap.policy.common.endpoints.event.comm.client.BidirectionalTopicClientException;
  39 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  40 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
  41 import org.onap.policy.common.endpoints.parameters.TopicParameters;
  42 import org.onap.policy.common.utils.coder.CoderException;
  43 import org.onap.policy.common.utils.coder.StandardCoderObject;
  44 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
  45 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
  46 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager;
  47 import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
  48 import org.onap.policy.simulators.TopicServer;
  49
  50 /**
  51  * Superclass for various BidirectionalTopicOperation tests.
  52  *
  53  * @param <Q> request type
  54  */
  55 @NoArgsConstructor(access = AccessLevel.PROTECTED)
  56 public abstract class BasicBidirectionalTopicOperation<Q> extends BasicOperation {
  57     protected static final String MY_SINK = "my-sink";
  58     protected static final String MY_SOURCE = "my-source";
  59     protected static final int TIMEOUT_SEC = 10;
  60     protected static final long TIMEOUT_MS = 1000L * TIMEOUT_SEC;
  61
  62     // sink and source used by the TopicServer
  63     private static TopicSink serverSink;
  64     private static TopicSource serverSource;
  65     private static BidirectionalTopicHandler realTopicHandler;
  66
  67     protected static BidirectionalTopicManager topicMgr = (sink, source) -> {
  68         // note: the sink and source names are swapped for the simulator
  69         assertEquals(serverSource.getTopic(), sink);
  70         assertEquals(serverSink.getTopic(), source);
  71         return realTopicHandler;
  72     };
  73
  74     @Captor
  75     protected ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
  76
  77     @Mock
  78     protected BidirectionalTopicHandler topicHandler;
  79     @Mock
  80     protected Forwarder forwarder;
  81     @Mock
  82     protected BidirectionalTopicConfig config;
  83
  84     private TopicServer<Q> topicServer;
  85
  86
  87     /**
  88      * Constructs the object.
  89      *
  90      * @param actor actor name
  91      * @param operation operation name
  92      */
  93     protected BasicBidirectionalTopicOperation(String actor, String operation) {
  94         super(actor, operation);
  95     }
  96
  97     /**
  98      * Starts the topic.
  99      *
 100      * @throws BidirectionalTopicClientException if the client cannot be built
 101      */
 102     protected static void initBeforeClass(String sinkTopic, String sourceTopic)
 103                     throws BidirectionalTopicClientException {
 104
 105         // note: the sink and source names are swapped for the simulator
 106         var ptopic = new TopicParameters();
 107         ptopic.setTopic(sourceTopic);
 108         ptopic.setManaged(true);
 109         ptopic.setServers(List.of("localhost"));
 110         ptopic.setTopicCommInfrastructure("NOOP");
 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     /**
 155      * Finish all topic servers and mocks.
 156      */
 157     public void tearDownBasic() {
 158         topicServer.shutdown();
 159         try {
 160             closeable.close();
 161         } catch (Exception e) {
 162             fail(e.getMessage());
 163         }
 164     }
 165
 166     /**
 167      * Makes a simulator for the given sink and source.
 168      *
 169      * @param sink topic to which the simulator should publish responses
 170      * @param source topic from which the simulator should receive messages
 171      * @return a new topic server/simulator
 172      */
 173     protected abstract TopicServer<Q> makeServer(TopicSink sink, TopicSource source);
 174
 175     /**
 176      * Initializes a configuration.
 177      */
 178     protected void initConfig() {
 179         lenient().when(config.getTopicHandler()).thenReturn(topicHandler);
 180         lenient().when(config.getForwarder()).thenReturn(forwarder);
 181         lenient().when(config.getTimeoutMs()).thenReturn(TIMEOUT_MS);
 182     }
 183
 184     /**
 185      * Provides a response to the topic {@link #listenerCaptor}.
 186      *
 187      * @param listener listener to which to provide the response
 188      * @param response response to be provided
 189      */
 190     protected void provideResponse(BiConsumer<String, StandardCoderObject> listener, String response) {
 191         try {
 192             StandardCoderObject sco = coder.decode(response, StandardCoderObject.class);
 193             listener.accept(response, sco);
 194
 195         } catch (CoderException e) {
 196             throw new IllegalArgumentException("response is not a Map", e);
 197         }
 198     }
 199 }