2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2018 Ericsson. All rights reserved.
4 * Modifications Copyright (C) 2019-2020 Nordix Foundation.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.apex.plugins.event.carrier.restclient;
24 import static org.assertj.core.api.Assertions.assertThatThrownBy;
25 import static org.awaitility.Awaitility.await;
26 import static org.junit.Assert.assertEquals;
27 import static org.junit.Assert.assertNotNull;
28 import static org.junit.Assert.assertTrue;
29 import static org.junit.Assert.fail;
31 import java.io.ByteArrayOutputStream;
32 import java.io.PrintStream;
33 import java.util.concurrent.TimeUnit;
34 import javax.ws.rs.client.Client;
35 import javax.ws.rs.client.Invocation.Builder;
36 import javax.ws.rs.client.WebTarget;
37 import javax.ws.rs.core.Response;
38 import org.junit.After;
39 import org.junit.Test;
40 import org.mockito.Mock;
41 import org.mockito.Mockito;
42 import org.mockito.MockitoAnnotations;
43 import org.onap.policy.apex.service.engine.event.ApexEventException;
44 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
45 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
48 * This class tests the ApexRestClientConusmer class.
51 public class ApexRestClientConusmerTest {
52 private final PrintStream stdout = System.out;
55 private Client httpClientMock;
58 private WebTarget targetMock;
61 private Builder builderMock;
64 private Response responseMock;
68 System.setOut(stdout);
72 public void testApexRestClientConsumerErrors() throws ApexEventException {
73 MockitoAnnotations.initMocks(this);
75 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
78 EventHandlerParameters consumerParameters = new EventHandlerParameters();
79 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
80 assertThatThrownBy(() -> arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver))
81 .hasMessageContaining("specified consumer properties are not applicable to REST client"
82 + " consumer (RestClientConsumer)");
84 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
85 consumerParameters.setCarrierTechnologyParameters(rcctp);
86 rcctp.setHttpMethod(RestClientCarrierTechnologyParameters.HttpMethod.DELETE);
87 assertThatThrownBy(() -> {
88 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
89 }).hasMessageContaining("specified HTTP method of \"DELETE\" is invalid, only HTTP method \"GET\" is "
90 + "supported for event reception on REST client consumer (RestClientConsumer)");
92 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.DELETE, rcctp.getHttpMethod());
93 rcctp.setHttpMethod(null);
94 rcctp.setHttpCodeFilter("zzz");
96 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
97 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
99 assertEquals("RestClientConsumer", arcc.getName());
101 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
102 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
104 rcctp.setUrl("http://some.place.that.does.not/exist");
105 Mockito.doReturn(Response.Status.BAD_REQUEST.getStatusCode()).when(responseMock).getStatus();
106 Mockito.doReturn(responseMock).when(builderMock).get();
107 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
108 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
109 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
110 arcc.setClient(httpClientMock);
112 // We have not set the URL, this test should not receive any events
114 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
116 assertEquals(0, incomingEventReceiver.getEventCount());
118 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
120 // We have not set the URL, this test should not receive any events
122 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
124 assertEquals(0, incomingEventReceiver.getEventCount());
128 public void testApexRestClientConsumerHttpError() throws ApexEventException {
129 MockitoAnnotations.initMocks(this);
131 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
134 EventHandlerParameters consumerParameters = new EventHandlerParameters();
135 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
136 consumerParameters.setCarrierTechnologyParameters(rcctp);
137 rcctp.setUrl("http://some.place.that.does.not/exist");
138 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
139 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
141 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
142 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
144 assertEquals("[1-5][0][0-5]", rcctp.getHttpCodeFilter());
146 assertEquals("RestClientConsumer", arcc.getName());
148 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
149 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
151 Mockito.doReturn(Response.Status.BAD_REQUEST.getStatusCode()).when(responseMock).getStatus();
152 Mockito.doReturn(responseMock).when(builderMock).get();
153 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
154 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
155 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
156 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
157 arcc.setClient(httpClientMock);
159 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
160 System.setOut(new PrintStream(outContent));
162 // We have not set the URL, this test should not receive any events
164 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
166 assertEquals(0, incomingEventReceiver.getEventCount());
170 public void testApexRestClientConsumerJsonError() throws ApexEventException {
171 MockitoAnnotations.initMocks(this);
173 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
176 EventHandlerParameters consumerParameters = new EventHandlerParameters();
177 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
178 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
179 consumerParameters.setCarrierTechnologyParameters(rcctp);
180 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
182 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
183 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
184 assertEquals("RestClientConsumer", arcc.getName());
186 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
188 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
190 rcctp.setUrl("http://some.place.that.does.not/exist");
191 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
192 Mockito.doReturn(responseMock).when(builderMock).get();
193 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
194 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
195 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
196 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
197 arcc.setClient(httpClientMock);
199 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
200 System.setOut(new PrintStream(outContent));
202 // We have not set the URL, this test should not receive any events
204 await().atMost(400, TimeUnit.MILLISECONDS).until(() -> outContent.toString()
205 .contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
207 assertEquals(0, incomingEventReceiver.getEventCount());
211 public void testApexRestClientConsumerJsonEmpty() throws ApexEventException {
212 MockitoAnnotations.initMocks(this);
214 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
217 EventHandlerParameters consumerParameters = new EventHandlerParameters();
218 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
219 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
220 consumerParameters.setCarrierTechnologyParameters(rcctp);
221 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
223 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
224 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
226 assertEquals("RestClientConsumer", arcc.getName());
228 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
230 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
232 rcctp.setUrl("http://some.place.that.does.not/exist");
233 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
234 Mockito.doReturn("").when(responseMock).readEntity(String.class);
235 Mockito.doReturn(responseMock).when(builderMock).get();
236 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
237 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
238 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
239 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
240 arcc.setClient(httpClientMock);
242 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
243 System.setOut(new PrintStream(outContent));
245 // We have not set the URL, this test should not receive any events
247 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> outContent.toString()
248 .contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
251 assertEquals(0, incomingEventReceiver.getEventCount());
253 final String outString = outContent.toString();
255 assertTrue(outString.contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
259 public void testApexRestClientConsumerJsonOk() throws ApexEventException {
260 MockitoAnnotations.initMocks(this);
262 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
265 EventHandlerParameters consumerParameters = new EventHandlerParameters();
266 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
267 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
268 consumerParameters.setCarrierTechnologyParameters(rcctp);
269 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
271 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
272 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
274 assertEquals("RestClientConsumer", arcc.getName());
276 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
278 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
280 rcctp.setUrl("http://some.place.that.does.not/exist");
281 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
282 Mockito.doReturn("This is an event").when(responseMock).readEntity(String.class);
283 Mockito.doReturn(responseMock).when(builderMock).get();
284 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
285 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
286 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
287 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
288 arcc.setClient(httpClientMock);
290 // We have not set the URL, this test should not receive any events
292 await().atMost(400, TimeUnit.MILLISECONDS)
293 .until(() -> incomingEventReceiver.getLastEvent().equals("This is an event"));
298 public void testApexRestClientConsumerInvalidStatusCode() throws ApexEventException {
299 MockitoAnnotations.initMocks(this);
301 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
304 EventHandlerParameters consumerParameters = new EventHandlerParameters();
305 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
306 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
307 consumerParameters.setCarrierTechnologyParameters(rcctp);
308 rcctp.setHttpCodeFilter("zzz");
310 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
311 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
313 assertEquals("RestClientConsumer", arcc.getName());
315 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
317 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
319 rcctp.setUrl("http://some.place.that.does.not/exist");
320 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
321 Mockito.doReturn("This is an event").when(responseMock).readEntity(String.class);
322 Mockito.doReturn(responseMock).when(builderMock).get();
323 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
324 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
325 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
326 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
327 arcc.setClient(httpClientMock);
329 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
330 System.setOut(new PrintStream(outContent));
333 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);