-
Notifications
You must be signed in to change notification settings - Fork 3
/
EdgeVerticleHttpTest.java
281 lines (230 loc) · 8.69 KB
/
EdgeVerticleHttpTest.java
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
package org.folio.edge.core;
import static org.folio.edge.core.Constants.SYS_LOG_LEVEL;
import static org.folio.edge.core.Constants.SYS_OKAPI_URL;
import static org.folio.edge.core.Constants.SYS_PORT;
import static org.folio.edge.core.Constants.SYS_REQUEST_TIMEOUT_MS;
import static org.folio.edge.core.Constants.SYS_SECURE_STORE_PROP_FILE;
import static org.folio.edge.core.Constants.TEXT_PLAIN;
import static org.folio.edge.core.utils.test.MockOkapi.X_ECHO_STATUS;
import static org.hamcrest.Matchers.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import java.util.ArrayList;
import java.util.List;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.folio.edge.core.security.SecureStore;
import org.folio.edge.core.utils.ApiKeyUtils;
import org.folio.edge.core.utils.OkapiClientFactory;
import org.folio.edge.core.utils.test.MockOkapi;
import org.folio.edge.core.utils.test.TestUtils;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import io.restassured.RestAssured;
import io.vertx.core.DeploymentOptions;
import io.vertx.core.Vertx;
import io.vertx.core.http.HttpMethod;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.unit.TestContext;
import io.vertx.ext.unit.junit.VertxUnitRunner;
import io.vertx.ext.web.Router;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.handler.BodyHandler;
@RunWith(VertxUnitRunner.class)
public class EdgeVerticleHttpTest {
private static final Logger logger = LogManager.getLogger(EdgeVerticleHttpTest.class);
private static final String apiKey = ApiKeyUtils.generateApiKey("gYn0uFv3Lf", "diku", "diku");
private static final String badApiKey = apiKey + "0000";
private static final String unknownTenantApiKey = ApiKeyUtils.generateApiKey("gYn0uFv3Lf", "foobarbaz", "userA");
private static final int requestTimeoutMs = 5000;
private static Vertx vertx;
private static MockOkapi mockOkapi;
@BeforeClass
public static void setUpOnce(TestContext context) throws Exception {
int okapiPort = TestUtils.getPort();
int serverPort = TestUtils.getPort();
List<String> knownTenants = new ArrayList<>();
knownTenants.add(ApiKeyUtils.parseApiKey(apiKey).tenantId);
mockOkapi = spy(new MockOkapi(okapiPort, knownTenants));
mockOkapi.start()
.onComplete(context.asyncAssertSuccess());
vertx = Vertx.vertx();
JsonObject jo = new JsonObject()
.put(SYS_PORT, serverPort)
.put(SYS_OKAPI_URL, "http://localhost:" + okapiPort)
.put(SYS_SECURE_STORE_PROP_FILE, "src/main/resources/ephemeral.properties")
.put(SYS_LOG_LEVEL, "TRACE")
.put(SYS_REQUEST_TIMEOUT_MS, requestTimeoutMs);
final DeploymentOptions opt = new DeploymentOptions().setConfig(jo);
vertx.deployVerticle(TestVerticleHttp.class.getName(), opt, context.asyncAssertSuccess());
RestAssured.baseURI = "http://localhost:" + serverPort;
RestAssured.port = serverPort;
RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();
}
@AfterClass
public static void tearDownOnce(TestContext context) {
logger.info("Shutting down server");
vertx.close()
.onSuccess(x -> logger.info("Successfully shut down edge-common server"))
.compose(x -> mockOkapi.close())
.onSuccess(x -> logger.info("Successfully shut down mock Okapi"))
.onComplete(context.asyncAssertSuccess());
}
@Before
public void before() {
mockOkapi.setDelay(0);
}
@Test
public void testAdminHealth() {
logger.info("=== Test the health check endpoint ===");
RestAssured
.get("/admin/health")
.then()
.contentType(TEXT_PLAIN)
.statusCode(200)
.body(is("\"OK\""));
}
@Test
public void testLoginUnknownApiKey() {
logger.info("=== Test request with unknown apiKey (tenant) ===");
RestAssured
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", unknownTenantApiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(403);
}
@Test
public void testLoginMissingApiKey() {
logger.info("=== Test request without specifying an apiKey ===");
RestAssured
.get("/login/and/do/something?apikey=&foo=bar")
.then()
.contentType(TEXT_PLAIN)
.statusCode(401);
}
@Test
public void testLoginBadApiKey() {
logger.info("=== Test request with malformed apiKey ===");
RestAssured
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", badApiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(401);
}
@Test
public void testExceptionHandler() {
logger.info("=== Test the exception handler ===");
RestAssured
.get("/internal/server/error")
.then()
.contentType(TEXT_PLAIN)
.statusCode(500);
}
@Test
public void testMissingRequired() {
logger.info("=== Test request w/ missing required parameter ===");
RestAssured
.with()
.contentType(TEXT_PLAIN)
.body("success")
.get(String.format("/login/and/do/something?apikey=%s", apiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(400)
.body(is("Missing required parameter: foo"));
}
@Test
public void test404() {
logger.info("=== Test 404 response ===");
RestAssured
.with()
.contentType(TEXT_PLAIN)
.header(X_ECHO_STATUS, "404")
.body("Not Found")
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", apiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(404)
.body(is("Not Found"));
}
@Test
public void testCachedToken() {
logger.info("=== Test the tokens are cached and reused ===");
int iters = 5;
for (int i = 0; i < iters; i++) {
RestAssured
.with()
.contentType(TEXT_PLAIN)
.body("success")
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", apiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(200)
.body(is("success"));
}
verify(mockOkapi).loginHandler(any());
}
@Test
public void testRequestTimeout() {
logger.info("=== Test request timeout ===");
RestAssured
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", apiKey))
.then()
.statusCode(200);
mockOkapi.setDelay(requestTimeoutMs * 2);
RestAssured
.get(String.format("/login/and/do/something?apikey=%s&foo=bar", apiKey))
.then()
.contentType(TEXT_PLAIN)
.statusCode(408)
.body(containsString("The timeout period of 5000ms has been exceeded while executing POST"));
}
public static class TestVerticleHttp extends EdgeVerticleHttp {
@Override
public Router defineRoutes() {
OkapiClientFactory ocf = new OkapiClientFactory(vertx, config().getString(SYS_OKAPI_URL), config().getInteger(SYS_REQUEST_TIMEOUT_MS));
ApiKeyHelper apiKeyHelper = new ApiKeyHelper("HEADER,PARAM,PATH");
Router router = Router.router(vertx);
router.route().handler(BodyHandler.create());
router.route(HttpMethod.GET, "/admin/health").handler(this::handleHealthCheck);
router.route(HttpMethod.GET, "/login/and/do/something")
.handler(new GetTokenHandler(ocf, secureStore, apiKeyHelper)::handle);
router.route(HttpMethod.GET, "/internal/server/error")
.handler(new handle500(secureStore, ocf)::handle);
return router;
}
}
private static class GetTokenHandler extends Handler {
public GetTokenHandler(OkapiClientFactory ocf, SecureStore secureStore, ApiKeyHelper keyHelper) {
super(secureStore, ocf, keyHelper);
}
public void handle(RoutingContext ctx) {
super.handleCommon(ctx,
new String[] { "foo" },
new String[] {},
(client, params) -> {
logger.info("Token: " + client.getToken());
client.post(String.format("%s/echo", client.okapiURL),
client.tenant,
ctx.getBodyAsString(),
ctx.request().headers(),
resp -> handleProxyResponse(ctx, resp),
t -> handleProxyException(ctx, t));
});
}
}
private static class handle500 extends Handler {
public handle500(SecureStore secureStore, OkapiClientFactory ocf) {
super(secureStore, ocf);
}
public void handle(RoutingContext ctx) {
ocf.getOkapiClient("").get("http://url.invalid.", "",
resp -> handleProxyResponse(ctx, resp),
t -> handleProxyException(ctx, t));
}
}
}