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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.clamp.controlloop.runtime.util.rest;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertEquals;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.client.ClientProperties;
import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
import org.onap.policy.common.gson.GsonMessageBodyHandler;
import org.onap.policy.common.utils.network.NetworkUtil;
/**
* Class to perform Rest unit tests.
*
*/
public class CommonRestController {
public static final String SELF = NetworkUtil.getHostname();
public static final String CONTEXT_PATH = "onap/controlloop";
public static final String ENDPOINT_PREFIX = CONTEXT_PATH + "/v2/";
public static final String ACTUATOR_ENDPOINT = CONTEXT_PATH + "/actuator/";
private static String httpPrefix;
/**
* Verifies that an endpoint appears within the swagger response.
*
* @param endpoint the endpoint of interest
* @throws Exception if an error occurs
*/
protected void testSwagger(final String endpoint) throws Exception {
final Invocation.Builder invocationBuilder = sendRequest("api-docs");
final String resp = invocationBuilder.get(String.class);
assertThat(resp).contains(endpoint);
}
/**
* Sends a request to an endpoint.
*
* @param endpoint the target endpoint
* @return a request builder
* @throws Exception if an error occurs
*/
protected Invocation.Builder sendRequest(final String endpoint) throws Exception {
return sendFqeRequest(httpPrefix + ENDPOINT_PREFIX + endpoint, true);
}
/**
* Sends a request to an actuator endpoint.
*
* @param endpoint the target endpoint
* @return a request builder
* @throws Exception if an error occurs
*/
protected Invocation.Builder sendActRequest(final String endpoint) throws Exception {
return sendFqeRequest(httpPrefix + ACTUATOR_ENDPOINT + endpoint, true);
}
/**
* Sends a request to an Rest Api endpoint, without any authorization header.
*
* @param endpoint the target endpoint
* @return a request builder
* @throws Exception if an error occurs
*/
protected Invocation.Builder sendNoAuthRequest(final String endpoint) throws Exception {
return sendFqeRequest(httpPrefix + ENDPOINT_PREFIX + endpoint, false);
}
/**
* Sends a request to an actuator endpoint, without any authorization header.
*
* @param endpoint the target endpoint
* @return a request builder
* @throws Exception if an error occurs
*/
protected Invocation.Builder sendNoAuthActRequest(final String endpoint) throws Exception {
return sendFqeRequest(httpPrefix + ACTUATOR_ENDPOINT + endpoint, false);
}
/**
* Sends a request to a fully qualified endpoint.
*
* @param fullyQualifiedEndpoint the fully qualified target endpoint
* @param includeAuth if authorization header should be included
* @return a request builder
* @throws Exception if an error occurs
*/
protected Invocation.Builder sendFqeRequest(final String fullyQualifiedEndpoint, boolean includeAuth)
throws Exception {
final Client client = ClientBuilder.newBuilder().build();
client.property(ClientProperties.METAINF_SERVICES_LOOKUP_DISABLE, "true");
client.register(GsonMessageBodyHandler.class);
if (includeAuth) {
client.register(HttpAuthenticationFeature.basic("runtimeUser", "zb!XztG34"));
}
final WebTarget webTarget = client.target(fullyQualifiedEndpoint);
return webTarget.request(MediaType.APPLICATION_JSON, MediaType.TEXT_PLAIN);
}
/**
* Assert that POST call is Unauthorized.
*
* @param endPoint the endpoint
* @param entity the entity ofthe body
* @throws Exception if an error occurs
*/
protected void assertUnauthorizedPost(final String endPoint, final Entity<?> entity) throws Exception {
Response rawresp = sendNoAuthRequest(endPoint).post(entity);
assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
}
/**
* Assert that PUT call is Unauthorized.
*
* @param endPoint the endpoint
* @param entity the entity ofthe body
* @throws Exception if an error occurs
*/
protected void assertUnauthorizedPut(final String endPoint, final Entity<?> entity) throws Exception {
Response rawresp = sendNoAuthRequest(endPoint).put(entity);
assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
}
/**
* Assert that GET call is Unauthorized.
*
* @param endPoint the endpoint
* @throws Exception if an error occurs
*/
protected void assertUnauthorizedGet(final String endPoint) throws Exception {
Response rawresp = sendNoAuthRequest(endPoint).buildGet().invoke();
assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
}
/**
* Assert that GET call to actuator endpoint is Unauthorized.
*
* @param endPoint the endpoint
* @throws Exception if an error occurs
*/
protected void assertUnauthorizedActGet(final String endPoint) throws Exception {
Response rawresp = sendNoAuthActRequest(endPoint).buildGet().invoke();
assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
}
/**
* Assert that DELETE call is Unauthorized.
*
* @param endPoint the endpoint
* @throws Exception if an error occurs
*/
protected void assertUnauthorizedDelete(final String endPoint) throws Exception {
Response rawresp = sendNoAuthRequest(endPoint).delete();
assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(), rawresp.getStatus());
}
/**
* Set Up httpPrefix.
*
* @param port the port
*/
protected void setHttpPrefix(int port) {
httpPrefix = "http://" + SELF + ":" + port + "/";
}
protected String getHttpPrefix() {
return httpPrefix;
}
}
|
