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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// 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.
package com.google.devtools.build.lib.server;
import static com.google.common.truth.Truth.assertThat;
import static junit.framework.TestCase.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import com.google.common.util.concurrent.Uninterruptibles;
import com.google.devtools.build.lib.server.CommandProtos.RunResponse;
import com.google.devtools.build.lib.server.GrpcServerImpl.StreamType;
import com.google.devtools.build.lib.testutil.Suite;
import com.google.devtools.build.lib.testutil.TestSpec;
import com.google.devtools.build.lib.testutil.TestThread;
import com.google.devtools.build.lib.testutil.TestUtils;
import com.google.protobuf.ByteString;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.stub.ServerCallStreamObserver;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.InOrder;
/**
* Unit tests for the gRPC server.
*/
@TestSpec(size = Suite.SMALL_TESTS)
@RunWith(JUnit4.class)
public class GrpcServerTest {
/**
* A little mock observer so that we can pretend we are talking to gRPC.
*/
private static class MockObserver extends ServerCallStreamObserver<RunResponse> {
private final AtomicBoolean cancelled = new AtomicBoolean();
private final AtomicBoolean ready = new AtomicBoolean(true);
private Runnable onCancelHandler;
private Runnable onReadyHandler;
private int sentMessages = 0;
private int targetMessageCount = -1;
private CountDownLatch targetMessageLatch = null;
private void waitForMessages(int count, long l, TimeUnit unit) {
synchronized (this) {
Preconditions.checkState(targetMessageCount == -1);
if (sentMessages >= count) {
return;
}
targetMessageLatch = new CountDownLatch(1);
this.targetMessageCount = count;
}
assertThat(Uninterruptibles.awaitUninterruptibly(targetMessageLatch, l, unit)).isTrue();
}
private synchronized int getMessageCount() {
return sentMessages;
}
@Override
public boolean isCancelled() {
return true;
}
@Override
public void setOnCancelHandler(Runnable onCancelHandler) {
this.onCancelHandler = onCancelHandler;
}
@Override
public void setCompression(String compression) {
}
@Override
public boolean isReady() {
return ready.get();
}
@Override
public void setOnReadyHandler(Runnable onReadyHandler) {
this.onReadyHandler = onReadyHandler;
}
@Override
public void disableAutoInboundFlowControl() {
}
@Override
public void request(int count) {
}
@Override
public void setMessageCompression(boolean enable) {
}
@Override
public void onNext(RunResponse value) {
synchronized (this) {
sentMessages += 1;
if (sentMessages == targetMessageCount) {
targetMessageLatch.countDown();
targetMessageLatch = null;
targetMessageCount = -1;
}
}
if (cancelled.get()) {
throw new StatusRuntimeException(Status.CANCELLED);
}
}
@Override
public void onError(Throwable t) {
}
@Override
public void onCompleted() {
if (cancelled.get()) {
throw new StatusRuntimeException(Status.CANCELLED);
}
}
}
private ExecutorService executor;
@Before
public void setUp() {
executor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder()
.setNameFormat("grpc-server-test-%d")
.setDaemon(true)
.build());
}
@After
public void tearDown() {
executor.shutdownNow();
}
private RunResponse runResponse() {
return RunResponse.newBuilder().setStandardError(ByteString.copyFromUtf8("hello")).build();
}
@Test
public void testSendingSimpleMessage() {
MockObserver observer = new MockObserver();
GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
assertThat(sink.offer(runResponse())).isTrue();
assertThat(sink.finish()).isFalse();
observer.waitForMessages(1, 100, TimeUnit.MILLISECONDS);
}
@Test
public void testSurvivesLateOnCancelHandler() {
MockObserver observer = new MockObserver();
GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
// First make the observer cancelled...
observer.cancelled.set(true);
// send a message...
sink.offer(runResponse());
// Then call the oncancel handler.
observer.onCancelHandler.run();
// Now the sink should still be responsive to finish events.
assertThat(sink.finish()).isTrue();
observer.waitForMessages(1, 100, TimeUnit.MILLISECONDS);
}
@Test
public void testCancellationTurnsSinkIntoBlackHole() {
MockObserver observer = new MockObserver();
GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
observer.cancelled.set(true);
observer.onCancelHandler.run();
assertThat(sink.offer(runResponse())).isFalse();
assertThat(sink.finish()).isTrue();
assertThat(observer.getMessageCount()).isEqualTo(0); // The message shouldn't have been sent.
}
@Test
public void testInterruptsCommandThreadOnCancellation() throws Exception {
final CountDownLatch safety = new CountDownLatch(1);
final AtomicBoolean interrupted = new AtomicBoolean(false);
TestThread victim = new TestThread() {
@Override
public void runTest() throws Exception {
try {
safety.await();
fail("Test thread finished unexpectedly");
} catch (InterruptedException e) {
interrupted.set(true);
}
}
};
victim.setDaemon(true);
victim.start();
MockObserver observer = new MockObserver();
GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
sink.setCommandThread(victim);
observer.cancelled.set(true);
observer.onCancelHandler.run();
assertThat(sink.offer(runResponse())).isFalse();
assertThat(sink.finish()).isTrue();
safety.countDown();
victim.joinAndAssertState(1000);
assertThat(interrupted.get()).isTrue();
}
@Test
public void testObeysReadySignal() throws Exception {
MockObserver observer = new MockObserver();
final GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
// First check if we can send a simple message
assertThat(sink.offer(runResponse())).isTrue();
observer.waitForMessages(1, 100, TimeUnit.MILLISECONDS);
observer.ready.set(false);
TestThread sender = new TestThread() {
@Override
public void runTest() {
assertThat(sink.offer(runResponse())).isTrue();
}
};
sender.setDaemon(true);
sender.start();
// Give the sender a little time to actually send the message
Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
assertThat(observer.getMessageCount()).isEqualTo(1);
// Let the sink loose again
observer.ready.set(true);
observer.onReadyHandler.run();
// Wait until the sender thread finishes and verify that the message was sent.
assertThat(sink.finish()).isFalse();
sender.joinAndAssertState(1000);
observer.waitForMessages(2, 100, TimeUnit.MILLISECONDS);
}
@Test
public void testDeadlockWhenDisconnectedWithQueueFull() throws Exception {
MockObserver observer = new MockObserver();
final GrpcServerImpl.GrpcSink sink = new GrpcServerImpl.GrpcSink("Dummy", observer, executor);
observer.ready.set(false);
TestThread sender = new TestThread() {
@Override
public void runTest() {
// Should return false due to the disconnect
assertThat(sink.offer(runResponse())).isFalse();
}
};
sender.setDaemon(true);
sender.start();
// Wait until the sink thread has processed the SEND message from #offer()
while (sink.getReceivedEventCount() < 1) {
Thread.sleep(200);
}
// Disconnect while there is an item pending
observer.onCancelHandler.run();
// Make sure that both the sink and the sender thread finish
assertThat(sink.finish()).isTrue();
sender.joinAndAssertState(TestUtils.WAIT_TIMEOUT_MILLISECONDS);
}
@Test
public void testRpcOutputStreamChunksLargeResponses() throws Exception {
GrpcServerImpl.GrpcSink mockSink = mock(GrpcServerImpl.GrpcSink.class);
@SuppressWarnings("resource")
GrpcServerImpl.RpcOutputStream underTest = new GrpcServerImpl.RpcOutputStream(
"command_id", "cookie", StreamType.STDOUT, mockSink);
when(mockSink.offer(any(RunResponse.class))).thenReturn(true);
String chunk1 = Strings.repeat("a", 8192);
String chunk2 = Strings.repeat("b", 8192);
String chunk3 = Strings.repeat("c", 1024);
underTest.write((chunk1 + chunk2 + chunk3).getBytes(StandardCharsets.ISO_8859_1));
InOrder inOrder = inOrder(mockSink);
inOrder.verify(mockSink).offer(
RunResponse.newBuilder()
.setCommandId("command_id")
.setCookie("cookie")
.setStandardOutput(ByteString.copyFrom(chunk1.getBytes(StandardCharsets.ISO_8859_1)))
.build());
inOrder.verify(mockSink).offer(
RunResponse.newBuilder()
.setCommandId("command_id")
.setCookie("cookie")
.setStandardOutput(ByteString.copyFrom(chunk2.getBytes(StandardCharsets.ISO_8859_1)))
.build());
inOrder.verify(mockSink).offer(
RunResponse.newBuilder()
.setCommandId("command_id")
.setCookie("cookie")
.setStandardOutput(ByteString.copyFrom(chunk3.getBytes(StandardCharsets.ISO_8859_1)))
.build());
}
}
|