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;
41 import lombok.EqualsAndHashCode;
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 int TIMEOUT_SEC = 10;
71 private static final long TIMEOUT_MS = 1000 * TIMEOUT_SEC;
72 private static final int MAX_REQUESTS = 100;
74 private static final StandardCoder coder = new StandardCoder();
77 private BidirectionalTopicConfig config;
79 private BidirectionalTopicHandler handler;
81 private Forwarder forwarder;
84 private ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
86 private ControlLoopOperationParams params;
87 private OperationOutcome outcome;
88 private StandardCoderObject stdResponse;
89 private MyResponse response;
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 response = new MyResponse();
115 response.setRequestId(REQ_ID);
116 responseText = coder.encode(response);
117 stdResponse = coder.decode(responseText, StandardCoderObject.class);
121 oper = new MyOperation();
125 public void testConstructor_testGetTopicHandler_testGetForwarder_testGetTopicParams() {
126 assertEquals(ACTOR, oper.getActorName());
127 assertEquals(OPERATION, oper.getName());
128 assertSame(handler, oper.getTopicHandler());
129 assertSame(forwarder, oper.getForwarder());
130 assertEquals(TIMEOUT_MS, oper.getTimeoutMs());
131 assertSame(MyResponse.class, oper.getResponseClass());
135 public void testStartOperationAsync() throws Exception {
137 // tell it to expect three responses
140 CompletableFuture<OperationOutcome> future = oper.startOperationAsync(1, outcome);
141 assertFalse(future.isDone());
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());
166 assertEquals(response, outcome.getResponse());
168 verify(forwarder).unregister(eq(Arrays.asList(REQ_ID)), eq(listenerCaptor.getValue()));
172 * Tests startOperationAsync() when processResponse() throws an exception.
175 public void testStartOperationAsyncProcException() throws Exception {
176 oper = new MyOperation() {
178 protected OperationOutcome processResponse(OperationOutcome outcome, String rawResponse,
179 StandardCoderObject scoResponse) {
180 throw EXPECTED_EXCEPTION;
184 CompletableFuture<OperationOutcome> future = oper.startOperationAsync(1, outcome);
185 assertFalse(future.isDone());
187 verify(forwarder).register(eq(Arrays.asList(REQ_ID)), listenerCaptor.capture());
189 verify(forwarder, never()).unregister(any(), any());
191 // provide a response
192 listenerCaptor.getValue().accept(responseText, stdResponse);
193 assertTrue(executor.runAll(MAX_REQUESTS));
194 assertTrue(future.isCompletedExceptionally());
196 verify(forwarder).unregister(eq(Arrays.asList(REQ_ID)), eq(listenerCaptor.getValue()));
200 * Tests startOperationAsync() when the publisher throws an exception.
203 public void testStartOperationAsyncPubException() throws Exception {
204 // indicate that nothing was published
205 when(handler.send(any())).thenReturn(false);
207 assertThatIllegalStateException().isThrownBy(() -> oper.startOperationAsync(1, outcome));
209 verify(forwarder).register(eq(Arrays.asList(REQ_ID)), listenerCaptor.capture());
211 // must still unregister
212 verify(forwarder).unregister(eq(Arrays.asList(REQ_ID)), eq(listenerCaptor.getValue()));
216 public void testGetTimeoutMsInteger() {
218 assertEquals(TIMEOUT_MS, oper.getTimeoutMs(null));
219 assertEquals(TIMEOUT_MS, oper.getTimeoutMs(0));
221 // use provided value
222 assertEquals(5000, oper.getTimeoutMs(5));
226 public void testPublishRequest() {
227 assertThatCode(() -> oper.publishRequest(new MyRequest())).doesNotThrowAnyException();
231 * Tests publishRequest() when nothing is published.
234 public void testPublishRequestUnpublished() {
235 when(handler.send(any())).thenReturn(false);
236 assertThatIllegalStateException().isThrownBy(() -> oper.publishRequest(new MyRequest()));
240 * Tests publishRequest() when the request type is a String.
243 public void testPublishRequestString() {
244 MyStringOperation oper2 = new MyStringOperation();
245 assertThatCode(() -> oper2.publishRequest(TEXT)).doesNotThrowAnyException();
249 * Tests publishRequest() when the coder throws an exception.
252 public void testPublishRequestException() {
253 setOperCoderException();
254 assertThatIllegalArgumentException().isThrownBy(() -> oper.publishRequest(new MyRequest()));
258 * Tests processResponse() when it's a success and the response type is a String.
261 public void testProcessResponseSuccessString() {
262 MyStringOperation oper2 = new MyStringOperation();
264 assertSame(outcome, oper2.processResponse(outcome, TEXT, null));
265 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
266 assertEquals(TEXT, outcome.getResponse());
270 * Tests processResponse() when it's a success and the response type is a
271 * StandardCoderObject.
274 public void testProcessResponseSuccessSco() {
275 MyScoOperation oper2 = new MyScoOperation();
277 assertSame(outcome, oper2.processResponse(outcome, responseText, stdResponse));
278 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
279 assertEquals(stdResponse, outcome.getResponse());
283 * Tests processResponse() when it's a failure.
286 public void testProcessResponseFailure() throws CoderException {
287 // indicate error in the response
288 MyResponse resp = new MyResponse();
289 resp.setOutput("error");
291 responseText = coder.encode(resp);
292 stdResponse = coder.decode(responseText, StandardCoderObject.class);
294 assertSame(outcome, oper.processResponse(outcome, responseText, stdResponse));
295 assertEquals(PolicyResult.FAILURE, outcome.getResult());
296 assertEquals(resp, outcome.getResponse());
300 * Tests processResponse() when the decoder succeeds.
303 public void testProcessResponseDecodeOk() throws CoderException {
304 assertSame(outcome, oper.processResponse(outcome, responseText, stdResponse));
305 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
306 assertEquals(response, outcome.getResponse());
310 * Tests processResponse() when the decoder throws an exception.
313 public void testProcessResponseDecodeExcept() throws CoderException {
315 assertThatIllegalArgumentException().isThrownBy(
316 () -> oper.processResponse(outcome, "{invalid json", stdResponse));
321 public void testPostProcessResponse() {
322 assertThatCode(() -> oper.postProcessResponse(outcome, null, null)).doesNotThrowAnyException();
326 public void testGetCoder() {
327 assertNotNull(oper.getCoder());
331 * Creates a new {@link #oper} whose coder will throw an exception.
333 private void setOperCoderException() {
334 oper = new MyOperation() {
336 protected Coder getCoder() {
337 return new StandardCoder() {
339 public String encode(Object object, boolean pretty) throws CoderException {
340 throw new CoderException(EXPECTED_EXCEPTION);
349 public static class MyRequest {
350 private String theRequestId = REQ_ID;
351 private String input;
357 public static class MyResponse {
358 private String requestId;
359 private String output;
363 private class MyStringOperation extends BidirectionalTopicOperation<String, String> {
365 public MyStringOperation() {
366 super(BidirectionalTopicOperationTest.this.params, config, String.class);
370 protected String makeRequest(int attempt) {
375 protected List<String> getExpectedKeyValues(int attempt, String request) {
376 return Arrays.asList(REQ_ID);
380 protected Status detmStatus(String rawResponse, String response) {
381 return (response != null ? Status.SUCCESS : Status.FAILURE);
386 private class MyScoOperation extends BidirectionalTopicOperation<MyRequest, StandardCoderObject> {
387 public MyScoOperation() {
388 super(BidirectionalTopicOperationTest.this.params, config, StandardCoderObject.class);
392 protected MyRequest makeRequest(int attempt) {
393 return new MyRequest();
397 protected List<String> getExpectedKeyValues(int attempt, MyRequest request) {
398 return Arrays.asList(REQ_ID);
402 protected Status detmStatus(String rawResponse, StandardCoderObject response) {
403 return (response.getString("output") == null ? Status.SUCCESS : Status.FAILURE);
408 private class MyOperation extends BidirectionalTopicOperation<MyRequest, MyResponse> {
409 public MyOperation() {
410 super(BidirectionalTopicOperationTest.this.params, config, MyResponse.class);
414 protected MyRequest makeRequest(int attempt) {
415 return new MyRequest();
419 protected List<String> getExpectedKeyValues(int attempt, MyRequest request) {
420 return Arrays.asList(REQ_ID);
424 protected Status detmStatus(String rawResponse, MyResponse response) {
426 return (response.getOutput() == null ? Status.SUCCESS : Status.FAILURE);
429 return Status.STILL_WAITING;