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;
30 import java.io.ByteArrayOutputStream;
31 import java.io.PrintStream;
32 import java.util.concurrent.TimeUnit;
33 import javax.ws.rs.client.Client;
34 import javax.ws.rs.client.Invocation.Builder;
35 import javax.ws.rs.client.WebTarget;
36 import javax.ws.rs.core.Response;
37 import org.junit.After;
38 import org.junit.Test;
39 import org.mockito.Mock;
40 import org.mockito.Mockito;
41 import org.mockito.MockitoAnnotations;
42 import org.onap.policy.apex.service.engine.event.ApexEventException;
43 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
44 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
47 * This class tests the ApexRestClientConusmer class.
50 public class ApexRestClientConusmerTest {
51 private final PrintStream stdout = System.out;
54 private Client httpClientMock;
57 private WebTarget targetMock;
60 private Builder builderMock;
63 private Response responseMock;
67 System.setOut(stdout);
71 public void testApexRestClientConsumerErrors() throws ApexEventException {
72 MockitoAnnotations.initMocks(this);
74 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
77 EventHandlerParameters consumerParameters = new EventHandlerParameters();
78 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
79 assertThatThrownBy(() -> arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver))
80 .hasMessageContaining(
81 "specified consumer properties are not applicable to REST client" + " consumer (RestClientConsumer)");
83 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
84 consumerParameters.setCarrierTechnologyParameters(rcctp);
85 rcctp.setHttpMethod(RestClientCarrierTechnologyParameters.HttpMethod.DELETE);
86 assertThatThrownBy(() -> {
87 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
88 }).hasMessageContaining("specified HTTP method of \"DELETE\" is invalid, only HTTP method \"GET\" is "
89 + "supported for event reception on REST client consumer (RestClientConsumer)");
91 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.DELETE, rcctp.getHttpMethod());
92 rcctp.setHttpMethod(null);
93 rcctp.setHttpCodeFilter("zzz");
95 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
96 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
98 assertEquals("RestClientConsumer", arcc.getName());
100 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
101 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
103 rcctp.setUrl("http://some.place.that.does.not/exist");
104 Mockito.doReturn(Response.Status.BAD_REQUEST.getStatusCode()).when(responseMock).getStatus();
105 Mockito.doReturn(responseMock).when(builderMock).get();
106 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
107 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
108 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
109 arcc.setClient(httpClientMock);
111 // We have not set the URL, this test should not receive any events
113 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
115 assertEquals(0, incomingEventReceiver.getEventCount());
117 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
119 // We have not set the URL, this test should not receive any events
121 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
123 assertEquals(0, incomingEventReceiver.getEventCount());
127 public void testApexRestClientConsumerHttpError() throws ApexEventException {
128 MockitoAnnotations.initMocks(this);
130 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
133 EventHandlerParameters consumerParameters = new EventHandlerParameters();
134 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
135 consumerParameters.setCarrierTechnologyParameters(rcctp);
136 rcctp.setUrl("http://some.place.that.does.not/exist");
137 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
138 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
140 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
141 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
143 assertEquals("[1-5][0][0-5]", rcctp.getHttpCodeFilter());
145 assertEquals("RestClientConsumer", arcc.getName());
147 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
148 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
150 Mockito.doReturn(Response.Status.BAD_REQUEST.getStatusCode()).when(responseMock).getStatus();
151 Mockito.doReturn(responseMock).when(builderMock).get();
152 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
153 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
154 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
155 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
156 arcc.setClient(httpClientMock);
158 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
159 System.setOut(new PrintStream(outContent));
161 // We have not set the URL, this test should not receive any events
163 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);
165 assertEquals(0, incomingEventReceiver.getEventCount());
169 public void testApexRestClientConsumerJsonError() throws ApexEventException {
170 MockitoAnnotations.initMocks(this);
172 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
175 EventHandlerParameters consumerParameters = new EventHandlerParameters();
176 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
177 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
178 consumerParameters.setCarrierTechnologyParameters(rcctp);
179 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
181 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
182 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
183 assertEquals("RestClientConsumer", arcc.getName());
185 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
187 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
189 rcctp.setUrl("http://some.place.that.does.not/exist");
190 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
191 Mockito.doReturn(responseMock).when(builderMock).get();
192 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
193 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
194 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
195 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
196 arcc.setClient(httpClientMock);
198 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
199 System.setOut(new PrintStream(outContent));
201 // We have not set the URL, this test should not receive any events
203 await().atMost(400, TimeUnit.MILLISECONDS).until(() -> outContent.toString()
204 .contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
206 assertEquals(0, incomingEventReceiver.getEventCount());
210 public void testApexRestClientConsumerJsonEmpty() throws ApexEventException {
211 MockitoAnnotations.initMocks(this);
213 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
216 EventHandlerParameters consumerParameters = new EventHandlerParameters();
217 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
218 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
219 consumerParameters.setCarrierTechnologyParameters(rcctp);
220 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
222 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
223 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
225 assertEquals("RestClientConsumer", arcc.getName());
227 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
229 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
231 rcctp.setUrl("http://some.place.that.does.not/exist");
232 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
233 Mockito.doReturn("").when(responseMock).readEntity(String.class);
234 Mockito.doReturn(responseMock).when(builderMock).get();
235 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
236 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
237 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
238 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
239 arcc.setClient(httpClientMock);
241 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
242 System.setOut(new PrintStream(outContent));
244 // We have not set the URL, this test should not receive any events
246 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> outContent.toString()
247 .contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
250 assertEquals(0, incomingEventReceiver.getEventCount());
252 final String outString = outContent.toString();
254 assertTrue(outString.contains("received an empty event from URL \"http://some.place.that.does.not/exist\""));
258 public void testApexRestClientConsumerJsonOk() throws ApexEventException {
259 MockitoAnnotations.initMocks(this);
261 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
264 EventHandlerParameters consumerParameters = new EventHandlerParameters();
265 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
266 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
267 consumerParameters.setCarrierTechnologyParameters(rcctp);
268 rcctp.setHttpCodeFilter("[1-5][0][0-5]");
270 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
271 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
273 assertEquals("RestClientConsumer", arcc.getName());
275 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
277 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
279 rcctp.setUrl("http://some.place.that.does.not/exist");
280 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
281 Mockito.doReturn("This is an event").when(responseMock).readEntity(String.class);
282 Mockito.doReturn(responseMock).when(builderMock).get();
283 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
284 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
285 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
286 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
287 arcc.setClient(httpClientMock);
289 // We have not set the URL, this test should not receive any events
291 await().atMost(400, TimeUnit.MILLISECONDS)
292 .until(() -> incomingEventReceiver.getLastEvent().equals("This is an event"));
297 public void testApexRestClientConsumerInvalidStatusCode() throws ApexEventException {
298 MockitoAnnotations.initMocks(this);
300 ApexRestClientConsumer arcc = new ApexRestClientConsumer();
303 EventHandlerParameters consumerParameters = new EventHandlerParameters();
304 SupportApexEventReceiver incomingEventReceiver = new SupportApexEventReceiver();
305 RestClientCarrierTechnologyParameters rcctp = new RestClientCarrierTechnologyParameters();
306 consumerParameters.setCarrierTechnologyParameters(rcctp);
307 rcctp.setHttpCodeFilter("zzz");
309 arcc.init("RestClientConsumer", consumerParameters, incomingEventReceiver);
310 assertEquals(RestClientCarrierTechnologyParameters.HttpMethod.GET, rcctp.getHttpMethod());
312 assertEquals("RestClientConsumer", arcc.getName());
314 arcc.setPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS, null);
316 assertEquals(null, arcc.getPeeredReference(EventHandlerPeeredMode.SYNCHRONOUS));
318 rcctp.setUrl("http://some.place.that.does.not/exist");
319 Mockito.doReturn(Response.Status.OK.getStatusCode()).when(responseMock).getStatus();
320 Mockito.doReturn("This is an event").when(responseMock).readEntity(String.class);
321 Mockito.doReturn(responseMock).when(builderMock).get();
322 Mockito.doReturn(builderMock).when(targetMock).request("application/json");
323 Mockito.doReturn(builderMock).when(builderMock).headers(Mockito.any());
324 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getUrl());
325 Mockito.doReturn(targetMock).when(httpClientMock).target(rcctp.getHttpCodeFilter());
326 arcc.setClient(httpClientMock);
328 ByteArrayOutputStream outContent = new ByteArrayOutputStream();
329 System.setOut(new PrintStream(outContent));
332 await().atMost(200, TimeUnit.MILLISECONDS).until(() -> incomingEventReceiver.getEventCount() == 0);