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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.restapi;
import com.yahoo.application.container.JDisc;
import com.yahoo.application.container.handler.Request;
import com.yahoo.application.container.handler.Response;
import com.yahoo.component.ComponentSpecification;
import com.yahoo.config.provision.ApplicationName;
import com.yahoo.container.http.filter.FilterChainRepository;
import com.yahoo.jdisc.http.filter.SecurityRequestFilter;
import com.yahoo.jdisc.http.filter.SecurityRequestFilterChain;
import com.yahoo.slime.SlimeUtils;
import com.yahoo.vespa.athenz.api.AthenzDomain;
import com.yahoo.vespa.athenz.api.AthenzIdentity;
import com.yahoo.vespa.flags.InMemoryFlagSource;
import com.yahoo.vespa.hosted.controller.Controller;
import com.yahoo.vespa.hosted.controller.api.integration.athenz.ApplicationAction;
import com.yahoo.vespa.hosted.controller.api.integration.athenz.AthenzClientFactoryMock;
import com.yahoo.vespa.hosted.controller.api.integration.stubs.MockUserManagement;
import com.yahoo.vespa.hosted.controller.integration.ServiceRegistryMock;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.charset.CharacterCodingException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Optional;
import java.util.function.Supplier;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Provides testing of JSON container responses
*
* @author bratseth
*/
public class ContainerTester {
private static final boolean writeResponses = false;
private final JDisc container;
private final String responseFilePath;
public ContainerTester(JDisc container, String responseFilePath) {
this.container = container;
this.responseFilePath = responseFilePath;
}
public Controller controller() {
return (Controller) container.components().getComponent(Controller.class.getName());
}
public AthenzClientFactoryMock athenzClientFactory() {
return (AthenzClientFactoryMock) container.components().getComponent(AthenzClientFactoryMock.class.getName());
}
public InMemoryFlagSource flagSource() {
return (InMemoryFlagSource) container.components().getComponent(InMemoryFlagSource.class.getName());
}
public ServiceRegistryMock serviceRegistry() {
return (ServiceRegistryMock) container.components().getComponent(ServiceRegistryMock.class.getName());
}
public MockUserManagement userManagement() {
return (MockUserManagement) container.components().getComponent(MockUserManagement.class.getName());
}
public void authorize(AthenzDomain tenantDomain, AthenzIdentity identity, ApplicationAction action, ApplicationName application) {
athenzClientFactory().getSetup()
.domains.get(tenantDomain)
.applications.get(new com.yahoo.vespa.hosted.controller.api.identifiers.ApplicationId(application.value()))
.addRoleMember(action, identity);
}
public void assertJsonResponse(Supplier<Request> request, File responseFile) {
assertResponse(request.get(), responseFile, 200, false, true);
}
public void assertResponse(Supplier<Request> request, File responseFile) {
assertResponse(request.get(), responseFile);
}
public void assertResponse(Request request, File responseFile) {
assertResponse(request, responseFile, 200);
}
public void assertResponse(Supplier<Request> request, File responseFile, int expectedStatusCode) {
assertResponse(request.get(), responseFile, expectedStatusCode);
}
public void assertResponse(Request request, File responseFile, int expectedStatusCode) {
assertResponse(request, responseFile, expectedStatusCode, true);
}
public void assertResponse(Request request, File responseFile, int expectedStatusCode, boolean removeWhitespace) {
assertResponse(request, responseFile, expectedStatusCode, removeWhitespace, false);
}
private void assertResponse(Request request, File responseFile, int expectedStatusCode, boolean removeWhitespace, boolean compareJson) {
String expectedResponse = readTestFile(responseFile.toString());
expectedResponse = include(expectedResponse);
FilterResult filterResult = invokeSecurityFilters(request);
request = filterResult.request;
Response response = filterResult.response != null ? filterResult.response : container.handleRequest(request);
String responseString;
try {
responseString = response.getBodyAsString();
}
catch (CharacterCodingException e) {
throw new UncheckedIOException(e);
}
try {
if (responseFile.toString().endsWith(".json")) {
byte[] expected = SlimeUtils.toJsonBytes(SlimeUtils.jsonToSlimeOrThrow(expectedResponse).get(), false);
byte[] actual = SlimeUtils.toJsonBytes(SlimeUtils.jsonToSlimeOrThrow(responseString).get(), false);
if (writeResponses) writeTestFile(responseFile.toString(), actual);
else assertEquals(new String(expected, UTF_8), new String(actual, UTF_8));
}
else { // Not JSON? Let's do a verbatim comparison, then ...
if (writeResponses) writeTestFile(responseFile.toString(), responseString.getBytes(UTF_8));
else assertEquals(expectedResponse, responseString);
}
}
catch (IOException e) {
fail("failed writing JSON: " + e);
}
assertEquals(expectedStatusCode, response.getStatus(), "Status code");
}
public void assertResponse(Supplier<Request> request, String expectedResponse) {
assertResponse(request, expectedResponse, 200);
}
public void assertResponse(Request request, String expectedResponse) {
assertResponse(() -> request, expectedResponse, 200);
}
public void assertResponse(Request request, String expectedResponse, int expectedStatusCode) {
assertResponse(() -> request, expectedResponse, expectedStatusCode);
}
public void assertResponse(Supplier<Request> request, String expectedResponse, int expectedStatusCode) {
assertResponse(request,
(response) -> assertEquals(expectedResponse, new String(response.getBody(), UTF_8)),
expectedStatusCode);
}
public void assertResponse(Supplier<Request> requestSupplier, ConsumerThrowingException<Response> responseAssertion, int expectedStatusCode) {
var request = requestSupplier.get();
FilterResult filterResult = invokeSecurityFilters(request);
request = filterResult.request;
Response response = filterResult.response != null ? filterResult.response : container.handleRequest(request);
try {
responseAssertion.accept(response);
} catch (Exception e) {
throw new RuntimeException(e);
}
assertEquals(expectedStatusCode, response.getStatus(), "Status code");
}
// Hack to run request filters as part of the request processing chain.
// Limitation: Bindings ignored, disc filter request wrapper only support limited set of methods.
private FilterResult invokeSecurityFilters(Request request) {
FilterChainRepository filterChainRepository = (FilterChainRepository) container.components().getComponent(FilterChainRepository.class.getName());
SecurityRequestFilterChain chain = (SecurityRequestFilterChain) filterChainRepository.getFilter(ComponentSpecification.fromString("default"));
for (SecurityRequestFilter securityRequestFilter : chain.getFilters()) {
ApplicationRequestToDiscFilterRequestWrapper discFilterRequest = new ApplicationRequestToDiscFilterRequestWrapper(request);
ResponseHandlerToApplicationResponseWrapper responseHandlerWrapper = new ResponseHandlerToApplicationResponseWrapper();
securityRequestFilter.filter(discFilterRequest, responseHandlerWrapper);
request = discFilterRequest.getUpdatedRequest();
Optional<Response> filterResponse = responseHandlerWrapper.toResponse();
if (filterResponse.isPresent()) {
return new FilterResult(request, filterResponse.get());
}
}
return new FilterResult(request, null);
}
/** Replaces @include(localFile) with the content of the file */
private String include(String response) {
// Please don't look at this code
int includeIndex = response.indexOf("@include(");
if (includeIndex < 0) return response;
String prefix = response.substring(0, includeIndex);
String rest = response.substring(includeIndex + "@include(".length());
int filenameEnd = rest.indexOf(")");
String includeFileName = rest.substring(0, filenameEnd);
String includedContent = readTestFile(includeFileName);
includedContent = include(includedContent);
String postFix = rest.substring(filenameEnd + 1);
postFix = include(postFix);
return prefix + includedContent + postFix;
}
private void writeTestFile(String name, byte[] content) {
try {
Files.write(Paths.get(responseFilePath, name), content);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private String readTestFile(String name) {
try {
return new String(Files.readAllBytes(Paths.get(responseFilePath, name)));
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private static class FilterResult {
final Request request;
final Response response;
FilterResult(Request request, Response response) {
this.request = request;
this.response = response;
}
}
@FunctionalInterface
public interface ConsumerThrowingException<T> {
void accept(T t) throws Exception;
}
}
|
