2 * ============LICENSE_START=======================================================
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
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.controlloop.actorserviceprovider.impl;
23 import static org.assertj.core.api.Assertions.assertThatCode;
24 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
25 import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
26 import static org.junit.Assert.assertEquals;
27 import static org.junit.Assert.assertFalse;
28 import static org.junit.Assert.assertNotNull;
29 import static org.junit.Assert.assertSame;
30 import static org.junit.Assert.assertTrue;
31 import static org.mockito.ArgumentMatchers.any;
32 import static org.mockito.ArgumentMatchers.eq;
33 import static org.mockito.Mockito.never;
34 import static org.mockito.Mockito.verify;
35 import static org.mockito.Mockito.when;
37 import java.util.Arrays;
38 import java.util.List;
39 import java.util.concurrent.CompletableFuture;
40 import java.util.function.BiConsumer;
43 import org.apache.commons.lang3.tuple.Pair;
44 import org.junit.Before;
45 import org.junit.Test;
46 import org.mockito.ArgumentCaptor;
47 import org.mockito.Captor;
48 import org.mockito.Mock;
49 import org.mockito.MockitoAnnotations;
50 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
51 import org.onap.policy.common.utils.coder.Coder;
52 import org.onap.policy.common.utils.coder.CoderException;
53 import org.onap.policy.common.utils.coder.StandardCoder;
54 import org.onap.policy.common.utils.coder.StandardCoderObject;
55 import org.onap.policy.common.utils.time.PseudoExecutor;
56 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
57 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
58 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
59 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
60 import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
61 import org.onap.policy.controlloop.policy.PolicyResult;
63 public class BidirectionalTopicOperationTest {
64 private static final CommInfrastructure SINK_INFRA = CommInfrastructure.NOOP;
65 private static final IllegalStateException EXPECTED_EXCEPTION = new IllegalStateException("expected exception");
66 private static final String ACTOR = "my-actor";
67 private static final String OPERATION = "my-operation";
68 private static final String REQ_ID = "my-request-id";
69 private static final String TEXT = "some text";
70 private static final String SUB_REQID = "my-sub-request-id";
71 private static final int TIMEOUT_SEC = 10;
72 private static final long TIMEOUT_MS = 1000 * TIMEOUT_SEC;
73 private static final int MAX_REQUESTS = 100;
75 private static final StandardCoder coder = new StandardCoder();
78 private BidirectionalTopicConfig config;
80 private BidirectionalTopicHandler handler;
82 private Forwarder forwarder;
85 private ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
87 private ControlLoopOperationParams params;
88 private OperationOutcome outcome;
89 private StandardCoderObject stdResponse;
90 private String responseText;
91 private PseudoExecutor executor;
93 private BidirectionalTopicOperation<MyRequest, MyResponse> oper;
99 public void setUp() throws CoderException {
100 MockitoAnnotations.initMocks(this);
102 when(config.getTopicHandler()).thenReturn(handler);
103 when(config.getForwarder()).thenReturn(forwarder);
104 when(config.getTimeoutMs()).thenReturn(TIMEOUT_MS);
106 when(handler.send(any())).thenReturn(true);
107 when(handler.getSinkTopicCommInfrastructure()).thenReturn(SINK_INFRA);
109 executor = new PseudoExecutor();
111 params = ControlLoopOperationParams.builder().actor(ACTOR).operation(OPERATION).executor(executor).build();
112 outcome = params.makeOutcome();
114 responseText = coder.encode(new MyResponse());
115 stdResponse = coder.decode(responseText, StandardCoderObject.class);
119 oper = new MyOperation();
123 public void testConstructor_testGetTopicHandler_testGetForwarder_testGetTopicParams() {
124 assertEquals(ACTOR, oper.getActorName());
125 assertEquals(OPERATION, oper.getName());
126 assertSame(handler, oper.getTopicHandler());
127 assertSame(forwarder, oper.getForwarder());
128 assertEquals(TIMEOUT_MS, oper.getTimeoutMs());
129 assertSame(MyResponse.class, oper.getResponseClass());
133 public void testStartOperationAsync() throws Exception {
135 // tell it to expect three responses
138 CompletableFuture<OperationOutcome> future = oper.startOperationAsync(1, outcome);
139 assertFalse(future.isDone());
141 assertEquals(SUB_REQID, outcome.getSubRequestId());
143 verify(forwarder).register(eq(Arrays.asList(REQ_ID)), listenerCaptor.capture());
145 verify(forwarder, never()).unregister(any(), any());
147 verify(handler).send(any());
149 // provide first response
150 listenerCaptor.getValue().accept(responseText, stdResponse);
151 assertTrue(executor.runAll(MAX_REQUESTS));
152 assertFalse(future.isDone());
154 // provide second response
155 listenerCaptor.getValue().accept(responseText, stdResponse);
156 assertTrue(executor.runAll(MAX_REQUESTS));
157 assertFalse(future.isDone());
159 // provide final response
160 listenerCaptor.getValue().accept(responseText, stdResponse);
161 assertTrue(executor.runAll(MAX_REQUESTS));
162 assertTrue(future.isDone());
164 assertSame(outcome, future.get());
165 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
167 verify(forwarder).unregister(eq(Arrays.asList(REQ_ID)), eq(listenerCaptor.getValue()));
171 * Tests startOperationAsync() when the publisher throws an exception.
174 public void testStartOperationAsyncException() throws Exception {
175 // indicate that nothing was published
176 when(handler.send(any())).thenReturn(false);
178 assertThatIllegalStateException().isThrownBy(() -> oper.startOperationAsync(1, outcome));
180 verify(forwarder).register(eq(Arrays.asList(REQ_ID)), listenerCaptor.capture());
182 // must still unregister
183 verify(forwarder).unregister(eq(Arrays.asList(REQ_ID)), eq(listenerCaptor.getValue()));
187 public void testGetTimeoutMsInteger() {
189 assertEquals(TIMEOUT_MS, oper.getTimeoutMs(null));
190 assertEquals(TIMEOUT_MS, oper.getTimeoutMs(0));
192 // use provided value
193 assertEquals(5000, oper.getTimeoutMs(5));
197 public void testPublishRequest() {
198 assertThatCode(() -> oper.publishRequest(new MyRequest())).doesNotThrowAnyException();
202 * Tests publishRequest() when nothing is published.
205 public void testPublishRequestUnpublished() {
206 when(handler.send(any())).thenReturn(false);
207 assertThatIllegalStateException().isThrownBy(() -> oper.publishRequest(new MyRequest()));
211 * Tests publishRequest() when the request type is a String.
214 public void testPublishRequestString() {
215 MyStringOperation oper2 = new MyStringOperation();
216 assertThatCode(() -> oper2.publishRequest(TEXT)).doesNotThrowAnyException();
220 * Tests publishRequest() when the coder throws an exception.
223 public void testPublishRequestException() {
224 setOperCoderException();
225 assertThatIllegalArgumentException().isThrownBy(() -> oper.publishRequest(new MyRequest()));
229 * Tests processResponse() when it's a success and the response type is a String.
232 public void testProcessResponseSuccessString() {
233 MyStringOperation oper2 = new MyStringOperation();
235 assertSame(outcome, oper2.processResponse(outcome, TEXT, null));
236 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
240 * Tests processResponse() when it's a success and the response type is a
241 * StandardCoderObject.
244 public void testProcessResponseSuccessSco() {
245 MyScoOperation oper2 = new MyScoOperation();
247 assertSame(outcome, oper2.processResponse(outcome, responseText, stdResponse));
248 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
252 * Tests processResponse() when it's a failure.
255 public void testProcessResponseFailure() throws CoderException {
256 // indicate error in the response
257 MyResponse resp = new MyResponse();
258 resp.setOutput("error");
260 responseText = coder.encode(resp);
261 stdResponse = coder.decode(responseText, StandardCoderObject.class);
263 assertSame(outcome, oper.processResponse(outcome, responseText, stdResponse));
264 assertEquals(PolicyResult.FAILURE, outcome.getResult());
268 * Tests processResponse() when the decoder succeeds.
271 public void testProcessResponseDecodeOk() throws CoderException {
272 assertSame(outcome, oper.processResponse(outcome, responseText, stdResponse));
273 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
277 * Tests processResponse() when the decoder throws an exception.
280 public void testProcessResponseDecodeExcept() throws CoderException {
282 assertThatIllegalArgumentException().isThrownBy(
283 () -> oper.processResponse(outcome, "{invalid json", stdResponse));
288 public void testPostProcessResponse() {
289 assertThatCode(() -> oper.postProcessResponse(outcome, null, null)).doesNotThrowAnyException();
293 public void testMakeCoder() {
294 assertNotNull(oper.makeCoder());
298 * Creates a new {@link #oper} whose coder will throw an exception.
300 private void setOperCoderException() {
301 oper = new MyOperation() {
303 protected Coder makeCoder() {
304 return new StandardCoder() {
306 public String encode(Object object, boolean pretty) throws CoderException {
307 throw new CoderException(EXPECTED_EXCEPTION);
316 public static class MyRequest {
317 private String theRequestId = REQ_ID;
318 private String input;
323 public static class MyResponse {
324 private String requestId = REQ_ID;
325 private String output;
329 private class MyStringOperation extends BidirectionalTopicOperation<String, String> {
331 public MyStringOperation() {
332 super(BidirectionalTopicOperationTest.this.params, config, String.class);
336 protected Pair<String, String> makeRequest(int attempt) {
337 return Pair.of(SUB_REQID, TEXT);
341 protected List<String> getExpectedKeyValues(int attempt, String request) {
342 return Arrays.asList(REQ_ID);
346 protected Status detmStatus(String rawResponse, String response) {
347 return (response != null ? Status.SUCCESS : Status.FAILURE);
352 private class MyScoOperation extends BidirectionalTopicOperation<MyRequest, StandardCoderObject> {
353 public MyScoOperation() {
354 super(BidirectionalTopicOperationTest.this.params, config, StandardCoderObject.class);
358 protected Pair<String, MyRequest> makeRequest(int attempt) {
359 return Pair.of(SUB_REQID, new MyRequest());
363 protected List<String> getExpectedKeyValues(int attempt, MyRequest request) {
364 return Arrays.asList(REQ_ID);
368 protected Status detmStatus(String rawResponse, StandardCoderObject response) {
369 return (response.getString("output") == null ? Status.SUCCESS : Status.FAILURE);
374 private class MyOperation extends BidirectionalTopicOperation<MyRequest, MyResponse> {
375 public MyOperation() {
376 super(BidirectionalTopicOperationTest.this.params, config, MyResponse.class);
380 protected Pair<String, MyRequest> makeRequest(int attempt) {
381 return Pair.of(SUB_REQID, new MyRequest());
385 protected List<String> getExpectedKeyValues(int attempt, MyRequest request) {
386 return Arrays.asList(REQ_ID);
390 protected Status detmStatus(String rawResponse, MyResponse response) {
392 return (response.getOutput() == null ? Status.SUCCESS : Status.FAILURE);
395 return Status.STILL_WAITING;