aboutsummaryrefslogtreecommitdiffstats
path: root/models-interactions/model-actors/actor.test/src/main/java/org/onap/policy/controlloop/actor/test/BasicHttpOperation.java
blob: 4bb75dc7436814837b57235d2a0288b9b0679c53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2023 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.controlloop.actor.test;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.lenient;

import java.util.Map;
import java.util.concurrent.CompletableFuture;
import javax.ws.rs.client.AsyncInvoker;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation.Builder;
import javax.ws.rs.client.InvocationCallback;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.stubbing.Answer;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;

/**
 * Superclass for various HttpOperation tests.
 */
public class BasicHttpOperation extends BasicOperation {
    protected static final String MY_CLIENT = "my-client";
    protected static final String BASE_URI = "http://my-host:6969/base-uri/";
    protected static final String PATH = "my-path/";

    @Captor
    protected ArgumentCaptor<InvocationCallback<Response>> callbackCaptor;
    @Captor
    protected ArgumentCaptor<Entity<String>> requestCaptor;
    @Captor
    protected ArgumentCaptor<Map<String, Object>> headerCaptor;

    @Mock
    protected HttpConfig config;
    @Mock
    protected WebTarget webTarget;
    @Mock
    protected Builder webBuilder;
    @Mock
    protected AsyncInvoker webAsync;
    @Mock
    protected HttpClient client;
    @Mock
    protected HttpClientFactory factory;
    @Mock
    protected Response rawResponse;


    /**
     * Constructs the object using a default actor and operation name.
     */
    public BasicHttpOperation() {
        super();
    }

    /**
     * Constructs the object.
     *
     * @param actor actor name
     * @param operation operation name
     */
    public BasicHttpOperation(String actor, String operation) {
        super(actor, operation);
    }

    /**
     * Initializes mocks and sets up.
     */
    @Override
    public void setUpBasic() {
        super.setUpBasic();

        lenient().when(factory.get(MY_CLIENT)).thenReturn(client);

        lenient().when(rawResponse.getStatus()).thenReturn(200);

        lenient().when(webBuilder.async()).thenReturn(webAsync);
        lenient().when(webBuilder.accept(any(MediaType.class))).thenReturn(webBuilder);
        lenient().when(webBuilder.accept(any(String.class))).thenReturn(webBuilder);

        lenient().when(webTarget.request()).thenReturn(webBuilder);
        lenient().when(webTarget.path(any())).thenReturn(webTarget);
        lenient().when(webTarget.queryParam(any(), any())).thenReturn(webTarget);

        lenient().when(client.getWebTarget()).thenReturn(webTarget);

        lenient().when(client.getBaseUrl()).thenReturn(BASE_URI);

        initConfig();
    }

    /**
     * Initializes a configuration.
     */
    protected void initConfig() {
        lenient().when(config.getClient()).thenReturn(client);
        lenient().when(config.getPath()).thenReturn(PATH);
    }

    /**
     * Provides a response to an asynchronous HttpClient call.
     *
     * @param response response to be provided to the call
     * @return a function that provides the response to the call
     */
    protected Answer<CompletableFuture<Response>> provideResponse(Response response) {
        return provideResponse(response, 0);
    }

    /**
     * Provides a response to an asynchronous HttpClient call.
     *
     * @param response response to be provided to the call
     * @param index index of the callback within the arguments
     * @return a function that provides the response to the call
     */
    protected Answer<CompletableFuture<Response>> provideResponse(Response response, int index) {
        return args -> {
            InvocationCallback<Response> cb = args.getArgument(index);
            cb.completed(response);
            return CompletableFuture.completedFuture(response);
        };
    }
}