models-interactions/model-actors/actor.test/src/main/java/org/onap/policy/controlloop/actor/test/BasicHttpOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.test;
  22
  23 import static org.mockito.ArgumentMatchers.any;
  24 import static org.mockito.Mockito.when;
  25
  26 import java.util.Map;
  27 import java.util.concurrent.CompletableFuture;
  28 import javax.ws.rs.client.AsyncInvoker;
  29 import javax.ws.rs.client.Entity;
  30 import javax.ws.rs.client.Invocation.Builder;
  31 import javax.ws.rs.client.InvocationCallback;
  32 import javax.ws.rs.client.WebTarget;
  33 import javax.ws.rs.core.MediaType;
  34 import javax.ws.rs.core.Response;
  35 import org.mockito.ArgumentCaptor;
  36 import org.mockito.Captor;
  37 import org.mockito.Mock;
  38 import org.mockito.stubbing.Answer;
  39 import org.onap.policy.common.endpoints.http.client.HttpClient;
  40 import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
  41 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  42
  43 /**
  44  * Superclass for various HttpOperation tests.
  45  */
  46 public class BasicHttpOperation extends BasicOperation {
  47     protected static final String MY_CLIENT = "my-client";
  48     protected static final String BASE_URI = "http://my-host:6969/base-uri/";
  49     protected static final String PATH = "my-path/";
  50
  51     @Captor
  52     protected ArgumentCaptor<InvocationCallback<Response>> callbackCaptor;
  53     @Captor
  54     protected ArgumentCaptor<Entity<String>> requestCaptor;
  55     @Captor
  56     protected ArgumentCaptor<Map<String, Object>> headerCaptor;
  57
  58     @Mock
  59     protected HttpConfig config;
  60     @Mock
  61     protected WebTarget webTarget;
  62     @Mock
  63     protected Builder webBuilder;
  64     @Mock
  65     protected AsyncInvoker webAsync;
  66     @Mock
  67     protected HttpClient client;
  68     @Mock
  69     protected HttpClientFactory factory;
  70     @Mock
  71     protected Response rawResponse;
  72
  73
  74     /**
  75      * Constructs the object using a default actor and operation name.
  76      */
  77     public BasicHttpOperation() {
  78         super();
  79     }
  80
  81     /**
  82      * Constructs the object.
  83      *
  84      * @param actor actor name
  85      * @param operation operation name
  86      */
  87     public BasicHttpOperation(String actor, String operation) {
  88         super(actor, operation);
  89     }
  90
  91     /**
  92      * Initializes mocks and sets up.
  93      */
  94     @Override
  95     public void setUpBasic() {
  96         super.setUpBasic();
  97
  98         when(factory.get(MY_CLIENT)).thenReturn(client);
  99
 100         when(rawResponse.getStatus()).thenReturn(200);
 101
 102         when(webBuilder.async()).thenReturn(webAsync);
 103         when(webBuilder.accept(any(MediaType.class))).thenReturn(webBuilder);
 104         when(webBuilder.accept(any(String.class))).thenReturn(webBuilder);
 105
 106         when(webTarget.request()).thenReturn(webBuilder);
 107         when(webTarget.path(any())).thenReturn(webTarget);
 108         when(webTarget.queryParam(any(), any())).thenReturn(webTarget);
 109
 110         when(client.getWebTarget()).thenReturn(webTarget);
 111
 112         when(client.getBaseUrl()).thenReturn(BASE_URI);
 113
 114         initConfig();
 115     }
 116
 117     /**
 118      * Initializes a configuration.
 119      */
 120     protected void initConfig() {
 121         when(config.getClient()).thenReturn(client);
 122         when(config.getPath()).thenReturn(PATH);
 123     }
 124
 125     /**
 126      * Provides a response to an asynchronous HttpClient call.
 127      *
 128      * @param response response to be provided to the call
 129      * @return a function that provides the response to the call
 130      */
 131     protected Answer<CompletableFuture<Response>> provideResponse(Response response) {
 132         return provideResponse(response, 0);
 133     }
 134
 135     /**
 136      * Provides a response to an asynchronous HttpClient call.
 137      *
 138      * @param response response to be provided to the call
 139      * @param index index of the callback within the arguments
 140      * @return a function that provides the response to the call
 141      */
 142     protected Answer<CompletableFuture<Response>> provideResponse(Response response, int index) {
 143         return args -> {
 144             InvocationCallback<Response> cb = args.getArgument(index);
 145             cb.completed(response);
 146             return CompletableFuture.completedFuture(response);
 147         };
 148     }
 149 }