-
Notifications
You must be signed in to change notification settings - Fork 48
/
ITDynamicRoutingHeaders.java
311 lines (282 loc) · 12.9 KB
/
ITDynamicRoutingHeaders.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/*
* Copyright 2023 Google LLC
*
* 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
*
* https://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.
*/
package com.google.showcase.v1beta1.it;
import static com.google.api.gax.rpc.internal.Headers.DYNAMIC_ROUTING_HEADER_KEY;
import static com.google.common.truth.Truth.assertThat;
import com.google.api.gax.httpjson.ApiMethodDescriptor;
import com.google.api.gax.httpjson.ForwardingHttpJsonClientCall;
import com.google.api.gax.httpjson.ForwardingHttpJsonClientCallListener;
import com.google.api.gax.httpjson.HttpJsonCallOptions;
import com.google.api.gax.httpjson.HttpJsonChannel;
import com.google.api.gax.httpjson.HttpJsonClientCall;
import com.google.api.gax.httpjson.HttpJsonClientInterceptor;
import com.google.api.gax.httpjson.HttpJsonMetadata;
import com.google.common.collect.ImmutableList;
import com.google.showcase.v1beta1.EchoClient;
import com.google.showcase.v1beta1.EchoRequest;
import com.google.showcase.v1beta1.it.util.TestClientInitializer;
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.ForwardingClientCall;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
public class ITDynamicRoutingHeaders {
private static final String SPLIT_TOKEN = "&";
private static final Metadata.Key<String> REQUEST_PARAMS_HEADER_KEY =
Metadata.Key.of(DYNAMIC_ROUTING_HEADER_KEY, Metadata.ASCII_STRING_MARSHALLER);
// Implement a request interceptor to retrieve the headers being sent on the request.
// The headers being set are part of the Metadata
private static class GrpcCapturingClientInterceptor implements ClientInterceptor {
private Metadata metadata;
@Override
public <RequestT, ResponseT> ClientCall<RequestT, ResponseT> interceptCall(
MethodDescriptor<RequestT, ResponseT> method, final CallOptions callOptions, Channel next) {
ClientCall<RequestT, ResponseT> call = next.newCall(method, callOptions);
return new ForwardingClientCall.SimpleForwardingClientCall<RequestT, ResponseT>(call) {
@Override
public void start(ClientCall.Listener<ResponseT> responseListener, Metadata headers) {
metadata = headers;
super.start(responseListener, headers);
}
};
}
}
// Implement a request interceptor to retrieve the headers being sent on the request
// The headers being set are part of the CallOptions
private static class HttpJsonCapturingClientInterceptor implements HttpJsonClientInterceptor {
private String requestParam;
@Override
public <RequestT, ResponseT> HttpJsonClientCall<RequestT, ResponseT> interceptCall(
ApiMethodDescriptor<RequestT, ResponseT> method,
HttpJsonCallOptions callOptions,
HttpJsonChannel next) {
HttpJsonClientCall<RequestT, ResponseT> call = next.newCall(method, callOptions);
return new ForwardingHttpJsonClientCall.SimpleForwardingHttpJsonClientCall<
RequestT, ResponseT>(call) {
@Override
public void start(Listener<ResponseT> responseListener, HttpJsonMetadata requestHeaders) {
Listener<ResponseT> forwardingResponseListener =
new ForwardingHttpJsonClientCallListener.SimpleForwardingHttpJsonClientCallListener<
ResponseT>(responseListener) {
@Override
public void onHeaders(HttpJsonMetadata responseHeaders) {
super.onHeaders(responseHeaders);
}
@Override
public void onMessage(ResponseT message) {
super.onMessage(message);
}
@Override
public void onClose(int statusCode, HttpJsonMetadata trailers) {
super.onClose(statusCode, trailers);
}
};
super.start(forwardingResponseListener, requestHeaders);
if (requestHeaders.getHeaders().containsKey(DYNAMIC_ROUTING_HEADER_KEY)) {
requestParam =
String.valueOf(requestHeaders.getHeaders().get(DYNAMIC_ROUTING_HEADER_KEY));
}
}
};
}
}
private HttpJsonCapturingClientInterceptor httpJsonInterceptor;
private GrpcCapturingClientInterceptor grpcInterceptor;
private EchoClient grpcClient;
private EchoClient httpJsonClient;
@Before
public void createClients() throws Exception {
// Create gRPC Interceptor and Client
grpcInterceptor = new GrpcCapturingClientInterceptor();
grpcClient = TestClientInitializer.createGrpcEchoClient(ImmutableList.of(grpcInterceptor));
// Create HttpJson Interceptor and Client
httpJsonInterceptor = new HttpJsonCapturingClientInterceptor();
httpJsonClient =
TestClientInitializer.createHttpJsonEchoClient(ImmutableList.of(httpJsonInterceptor));
}
@After
public void destroyClient() {
grpcClient.close();
httpJsonClient.close();
}
@Test
public void testGrpc_noRoutingHeaderUsed() {
grpcClient.echo(EchoRequest.newBuilder().build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNull();
}
@Test
public void testHttpJson_noRoutingHeaderUsed() {
httpJsonClient.echo(EchoRequest.newBuilder().build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNull();
}
@Test
public void testGrpc_emptyHeader() {
grpcClient.echo(EchoRequest.newBuilder().setHeader("").build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNull();
}
@Test
public void testHttpJson_emptyHeader() {
httpJsonClient.echo(EchoRequest.newBuilder().setHeader("").build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNull();
}
@Test
public void testGrpc_matchesHeaderName() {
grpcClient.echo(EchoRequest.newBuilder().setHeader("potato").build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders = ImmutableList.of("header=potato", "routing_id=potato");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testHttpJson_matchesHeaderName() {
httpJsonClient.echo(EchoRequest.newBuilder().setHeader("potato").build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders = ImmutableList.of("header=potato", "routing_id=potato");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testGrpc_matchesOtherHeaderName() {
grpcClient.echo(EchoRequest.newBuilder().setOtherHeader("instances/456").build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders = ImmutableList.of("baz=instances%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testHttpJson_matchesOtherHeaderName() {
httpJsonClient.echo(EchoRequest.newBuilder().setOtherHeader("instances/456").build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders = ImmutableList.of("baz=instances%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testGrpc_matchesMultipleOfSameRoutingHeader_usesHeader() {
grpcClient.echo(EchoRequest.newBuilder().setHeader("projects/123/instances/456").build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of(
"header=projects%2F123%2Finstances%2F456",
"routing_id=projects%2F123%2Finstances%2F456",
"super_id=projects%2F123",
"table_name=projects%2F123%2Finstances%2F456",
"instance_id=instances%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testHttpJson_matchesMultipleOfSameRoutingHeader_usesHeader() {
httpJsonClient.echo(EchoRequest.newBuilder().setHeader("projects/123/instances/456").build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of(
"header=projects%2F123%2Finstances%2F456",
"routing_id=projects%2F123%2Finstances%2F456",
"super_id=projects%2F123",
"table_name=projects%2F123%2Finstances%2F456",
"instance_id=instances%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders).inOrder();
}
@Test
public void testGrpc_matchesMultipleOfSameRoutingHeader_usesOtherHeader() {
grpcClient.echo(EchoRequest.newBuilder().setOtherHeader("projects/123/instances/456").build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of("baz=projects%2F123%2Finstances%2F456", "qux=projects%2F123");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testHttpJson_matchesMultipleOfSameRoutingHeader_usesOtherHeader() {
httpJsonClient.echo(
EchoRequest.newBuilder().setOtherHeader("projects/123/instances/456").build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of("baz=projects%2F123%2Finstances%2F456", "qux=projects%2F123");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testGrpc_matchesMultipleRoutingHeaders() {
grpcClient.echo(
EchoRequest.newBuilder()
.setHeader("regions/123/zones/456")
.setOtherHeader("projects/123/instances/456")
.build());
String headerValue = grpcInterceptor.metadata.get(REQUEST_PARAMS_HEADER_KEY);
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of(
"baz=projects%2F123%2Finstances%2F456",
"qux=projects%2F123",
"table_name=regions%2F123%2Fzones%2F456",
"header=regions%2F123%2Fzones%2F456",
"routing_id=regions%2F123%2Fzones%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
@Test
public void testHttpJson_matchesMultipleRoutingHeaders() {
httpJsonClient.echo(
EchoRequest.newBuilder()
.setHeader("regions/123/zones/456")
.setOtherHeader("projects/123/instances/456")
.build());
String headerValue = httpJsonInterceptor.requestParam;
assertThat(headerValue).isNotNull();
List<String> requestHeaders =
Arrays.stream(headerValue.split(SPLIT_TOKEN)).collect(Collectors.toList());
List<String> expectedHeaders =
ImmutableList.of(
"baz=projects%2F123%2Finstances%2F456",
"qux=projects%2F123",
"table_name=regions%2F123%2Fzones%2F456",
"header=regions%2F123%2Fzones%2F456",
"routing_id=regions%2F123%2Fzones%2F456");
assertThat(requestHeaders).containsExactlyElementsIn(expectedHeaders);
}
}