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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
* Modifications 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.pdp.xacml.application.common;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.IOException;
import java.util.Properties;
import java.util.UUID;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
import org.onap.policy.common.endpoints.http.server.HttpServletServer;
import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
import org.onap.policy.common.endpoints.parameters.RestClientParameters;
import org.onap.policy.common.endpoints.properties.PolicyEndPointProperties;
import org.onap.policy.common.gson.GsonMessageBodyHandler;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class PolicyApiCallerTest {
private static final String MY_TYPE = "my-type";
private static final String MY_VERSION = "1.0.0";
private static final Logger logger = LoggerFactory.getLogger(PolicyApiCallerTest.class);
private static final String CLIENT_NAME = "policy-api";
private static final String NOT_A_TYPE = "other-type";
private static final String INVALID_TYPE = "invalid";
private static final String UNKNOWN_TYPE = "unknown";
private static int port;
private static RestClientParameters clientParams;
private static HttpClient apiClient;
private PolicyApiCaller api;
/**
* Initializes {@link #clientParams} and starts a simple REST server to handle the
* test requests.
*
* @throws IOException if an error occurs
*/
@BeforeClass
public static void setUpBeforeClass() throws Exception {
port = NetworkUtil.allocPort();
clientParams = mock(RestClientParameters.class);
when(clientParams.getClientName()).thenReturn("apiClient");
when(clientParams.getHostname()).thenReturn("localhost");
when(clientParams.getPort()).thenReturn(port);
Properties props = new Properties();
props.setProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES, CLIENT_NAME);
final String svcpfx =
PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + CLIENT_NAME;
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_HOST_SUFFIX, clientParams.getHostname());
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_PORT_SUFFIX,
Integer.toString(clientParams.getPort()));
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_REST_CLASSES_SUFFIX,
ApiRestController.class.getName());
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX, "true");
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_HTTPS_SUFFIX, "false");
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_AAF_SUFFIX, "false");
props.setProperty(svcpfx + PolicyEndPointProperties.PROPERTY_HTTP_SERIALIZATION_PROVIDER,
GsonMessageBodyHandler.class.getName());
HttpServletServerFactoryInstance.getServerFactory().build(props).forEach(HttpServletServer::start);
apiClient = HttpClientFactoryInstance.getClientFactory().build(clientParams);
assertTrue(NetworkUtil.isTcpPortOpen(clientParams.getHostname(), clientParams.getPort(), 100, 100));
}
@AfterClass
public static void tearDownAfterClass() {
HttpServletServerFactoryInstance.getServerFactory().destroy();
}
/**
* Resets {@link #clientParams} and populates {@link #api}.
*
* @throws PolicyApiException if an error occurs
*/
@Before
public void setUp() throws PolicyApiException {
when(clientParams.getPort()).thenReturn(port);
api = new PolicyApiCaller(apiClient);
}
@Test
public void testGetPolicyType() throws Exception {
assertNotNull(api.getPolicyType(new ToscaConceptIdentifier(MY_TYPE, MY_VERSION)));
assertThatThrownBy(() -> api.getPolicyType(new ToscaConceptIdentifier(INVALID_TYPE, MY_VERSION)))
.isInstanceOf(PolicyApiException.class);
assertThatThrownBy(() -> api.getPolicyType(new ToscaConceptIdentifier(UNKNOWN_TYPE, MY_VERSION)))
.isInstanceOf(NotFoundException.class);
assertThatThrownBy(() -> api.getPolicyType(new ToscaConceptIdentifier(NOT_A_TYPE, MY_VERSION)))
.isInstanceOf(PolicyApiException.class);
// connect to a port that has no server
RestClientParameters params2 = mock(RestClientParameters.class);
when(params2.getClientName()).thenReturn("apiClient");
when(params2.getHostname()).thenReturn("localhost");
when(params2.getPort()).thenReturn(NetworkUtil.allocPort());
HttpClient apiClient2 = HttpClientFactoryInstance.getClientFactory().build(params2);
api = new PolicyApiCaller(apiClient2);
assertThatThrownBy(() -> api.getPolicyType(new ToscaConceptIdentifier(MY_TYPE, MY_VERSION)))
.isInstanceOf(PolicyApiException.class);
}
/**
* Simple REST server to handle test requests.
*/
@Path("/policy/api/v1")
@Produces({"application/json", "application/yaml"})
@Consumes({"application/json", "application/yaml"})
public static class ApiRestController {
/**
* Retrieves the specified version of a particular policy type.
*
* @param policyTypeId ID of desired policy type
* @param versionId version of desired policy type
* @param requestId optional request ID
*
* @return the Response object containing the results of the API operation
*/
@GET
@Path("/policytypes/{policyTypeId}/versions/{versionId}")
public Response getSpecificVersionOfPolicyType(@PathParam("policyTypeId") String policyTypeId,
@PathParam("versionId") String versionId, @HeaderParam("X-ONAP-RequestID") UUID requestId) {
assertEquals(MY_VERSION, versionId);
switch (policyTypeId) {
case UNKNOWN_TYPE:
logger.info("request for unknown policy type");
return Response.status(Response.Status.NOT_FOUND).build();
case INVALID_TYPE:
logger.info("invalid request for policy type");
return Response.status(Response.Status.BAD_REQUEST).build();
case NOT_A_TYPE:
logger.info("invalid request for policy type");
return Response.status(Response.Status.OK).entity("string-type").build();
default:
logger.info("request for policy type={} version={}", policyTypeId, versionId);
return Response.status(Response.Status.OK).entity(new ToscaPolicyType()).build();
}
}
}
}
|
