Skip to content

Commit 893ef44

Browse files
carl-mastrangelocarl-mastrangelo
committed
all/tests: add a ClientCall and ServerCall suitable for use in tests
1 parent ea3f506 commit 893ef44

File tree

7 files changed

+168
-103
lines changed

7 files changed

+168
-103
lines changed

‎core/src/test/java/io/grpc/ContextsTest.java‎

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
import static org.mockito.Mockito.mock;
4646

4747
import io.grpc.internal.FakeClock;
48+
import io.grpc.testing.NoopServerCall;
4849

4950
import org.junit.Test;
5051
import org.junit.runner.RunWith;
@@ -67,30 +68,7 @@ public class ContextsTest {
6768
@SuppressWarnings("unchecked")
6869
private MethodDescriptor<Object, Object> method = mock(MethodDescriptor.class);
6970
@SuppressWarnings("unchecked")
70-
private ServerCall<Object, Object> call = new ServerCall<Object, Object>() {
71-
72-
@Override
73-
public void request(int numMessages) {}
74-
75-
@Override
76-
public void sendHeaders(Metadata headers) {}
77-
78-
@Override
79-
public void sendMessage(Object message) {}
80-
81-
@Override
82-
public void close(Status status, Metadata trailers) {}
83-
84-
@Override
85-
public boolean isCancelled() {
86-
return false;
87-
}
88-
89-
@Override
90-
public MethodDescriptor<Object, Object> getMethodDescriptor() {
91-
return null;
92-
}
93-
};
71+
private ServerCall<Object, Object> call = new NoopServerCall<Object, Object>();
9472
private Metadata headers = new Metadata();
9573

9674
@Test

‎core/src/test/java/io/grpc/ServerInterceptorsTest.java‎

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
import io.grpc.MethodDescriptor.Marshaller;
4646
import io.grpc.MethodDescriptor.MethodType;
4747
import io.grpc.ServerCall.Listener;
48+
import io.grpc.testing.NoopServerCall;
4849

4950
import org.junit.After;
5051
import org.junit.Before;
@@ -78,7 +79,7 @@ public class ServerInterceptorsTest {
7879

7980
private MethodDescriptor<String, Integer> flowMethod;
8081

81-
private ServerCall<String, Integer> call = new BaseServerCall<String, Integer>();
82+
private ServerCall<String, Integer> call = new NoopServerCall<String, Integer>();
8283

8384
private ServerServiceDefinition serviceDefinition;
8485

@@ -280,7 +281,7 @@ public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
280281
@Test
281282
public void argumentsPassed() {
282283
@SuppressWarnings("unchecked")
283-
final ServerCall<String, Integer> call2 = new BaseServerCall<String, Integer>();
284+
final ServerCall<String, Integer> call2 = new NoopServerCall<String, Integer>();
284285
@SuppressWarnings("unchecked")
285286
final ServerCall.Listener<String> listener2 = mock(ServerCall.Listener.class);
286287

@@ -406,7 +407,7 @@ public void onMessage(ReqT message) {
406407
.intercept(inputStreamMessageService, interceptor2);
407408
ServerMethodDefinition<InputStream, InputStream> serverMethod =
408409
(ServerMethodDefinition<InputStream, InputStream>) intercepted2.getMethod("basic/wrapped");
409-
ServerCall<InputStream, InputStream> call2 = new BaseServerCall<InputStream, InputStream>();
410+
ServerCall<InputStream, InputStream> call2 = new NoopServerCall<InputStream, InputStream>();
410411
byte[] bytes = {};
411412
serverMethod
412413
.getServerCallHandler()
@@ -457,29 +458,4 @@ public InputStream get() {
457458
return inputStream;
458459
}
459460
}
460-
461-
private static class BaseServerCall<ReqT, RespT> extends ServerCall<ReqT, RespT> {
462-
463-
@Override
464-
public void request(int numMessages) {}
465-
466-
@Override
467-
public void sendHeaders(Metadata headers) {}
468-
469-
@Override
470-
public void sendMessage(RespT message) {}
471-
472-
@Override
473-
public void close(Status status, Metadata trailers) {}
474-
475-
@Override
476-
public boolean isCancelled() {
477-
return false;
478-
}
479-
480-
@Override
481-
public MethodDescriptor<ReqT, RespT> getMethodDescriptor() {
482-
return null;
483-
}
484-
}
485461
}

‎interop-testing/src/test/java/io/grpc/stub/StubConfigTest.java‎

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
import io.grpc.Channel;
4949
import io.grpc.ClientCall;
5050
import io.grpc.Deadline;
51-
import io.grpc.Metadata;
5251
import io.grpc.MethodDescriptor;
52+
import io.grpc.testing.NoopClientCall;
5353
import io.grpc.testing.integration.Messages.SimpleRequest;
5454
import io.grpc.testing.integration.Messages.SimpleResponse;
5555
import io.grpc.testing.integration.TestServiceGrpc;
@@ -80,28 +80,7 @@ public class StubConfigTest {
8080
@Before public void setUp() {
8181
MockitoAnnotations.initMocks(this);
8282
ClientCall<SimpleRequest, SimpleResponse> call =
83-
new ClientCall<SimpleRequest, SimpleResponse>() {
84-
@Override
85-
public void start(
86-
ClientCall.Listener<SimpleResponse> responseListener, Metadata headers) {
87-
}
88-
89-
@Override
90-
public void request(int numMessages) {
91-
}
92-
93-
@Override
94-
public void cancel(String message, Throwable cause) {
95-
}
96-
97-
@Override
98-
public void halfClose() {
99-
}
100-
101-
@Override
102-
public void sendMessage(SimpleRequest message) {
103-
}
104-
};
83+
new NoopClientCall<SimpleRequest, SimpleResponse>();
10584
when(channel.newCall(
10685
Mockito.<MethodDescriptor<SimpleRequest, SimpleResponse>>any(), any(CallOptions.class)))
10786
.thenReturn(call);

‎stub/build.gradle‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ plugins {
55
description = "gRPC: Stub"
66
dependencies {
77
compile project(':grpc-core')
8-
testCompile libraries.truth
8+
testCompile libraries.truth,
9+
project(':grpc-testing')
910
}
1011

1112
// Configure the animal sniffer plugin

‎stub/src/test/java/io/grpc/stub/ClientCallsTest.java‎

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
import io.grpc.inprocess.InProcessServerBuilder;
5656
import io.grpc.stub.ServerCalls.NoopStreamObserver;
5757
import io.grpc.stub.ServerCallsTest.IntegerMarshaller;
58+
import io.grpc.testing.NoopClientCall;
5859

5960
import org.junit.After;
6061
import org.junit.Before;
@@ -111,7 +112,7 @@ public void unaryBlockingCallSuccess() throws Exception {
111112
final Status status = Status.OK;
112113
final Metadata trailers = new Metadata();
113114

114-
BaseClientCall call = new BaseClientCall() {
115+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
115116
@Override
116117
public void start(ClientCall.Listener<String> listener, Metadata headers) {
117118
listener.onMessage(resp);
@@ -129,7 +130,7 @@ public void unaryBlockingCallFailed() throws Exception {
129130
final Status status = Status.INTERNAL.withDescription("Unique status");
130131
final Metadata trailers = new Metadata();
131132

132-
BaseClientCall call = new BaseClientCall() {
133+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
133134
@Override
134135
public void start(io.grpc.ClientCall.Listener<String> listener, Metadata headers) {
135136
listener.onClose(status, trailers);
@@ -151,7 +152,7 @@ public void unaryFutureCallSuccess() throws Exception {
151152
new AtomicReference<ClientCall.Listener<String>>();
152153
final AtomicReference<Integer> message = new AtomicReference<Integer>();
153154
final AtomicReference<Boolean> halfClosed = new AtomicReference<Boolean>();
154-
BaseClientCall call = new BaseClientCall() {
155+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
155156
@Override
156157
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
157158
listener.set(responseListener);
@@ -181,7 +182,7 @@ public void halfClose() {
181182
public void unaryFutureCallFailed() throws Exception {
182183
final AtomicReference<ClientCall.Listener<String>> listener =
183184
new AtomicReference<ClientCall.Listener<String>>();
184-
BaseClientCall call = new BaseClientCall() {
185+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
185186
@Override
186187
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
187188
listener.set(responseListener);
@@ -208,7 +209,7 @@ public void unaryFutureCallCancelled() throws Exception {
208209
new AtomicReference<ClientCall.Listener<String>>();
209210
final AtomicReference<String> cancelMessage = new AtomicReference<String>();
210211
final AtomicReference<Throwable> cancelCause = new AtomicReference<Throwable>();
211-
BaseClientCall call = new BaseClientCall() {
212+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
212213
@Override
213214
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
214215
listener.set(responseListener);
@@ -237,7 +238,7 @@ public void cancel(String message, Throwable cause) {
237238

238239
@Test
239240
public void cannotSetOnReadyAfterCallStarted() throws Exception {
240-
BaseClientCall call = new BaseClientCall();
241+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>();
241242
CallStreamObserver<Integer> callStreamObserver =
242243
(CallStreamObserver<Integer>) ClientCalls.asyncClientStreamingCall(call,
243244
new NoopStreamObserver<String>());
@@ -260,7 +261,7 @@ public void disablingInboundAutoFlowControlSuppressesRequestsForMoreMessages()
260261
final AtomicReference<ClientCall.Listener<String>> listener =
261262
new AtomicReference<ClientCall.Listener<String>>();
262263
final List<Integer> requests = new ArrayList<Integer>();
263-
BaseClientCall call = new BaseClientCall() {
264+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
264265
@Override
265266
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
266267
listener.set(responseListener);
@@ -321,7 +322,7 @@ public void onCompleted() {
321322
final AtomicReference<ClientCall.Listener<String>> listener =
322323
new AtomicReference<ClientCall.Listener<String>>();
323324
final List<Integer> requests = new ArrayList<Integer>();
324-
BaseClientCall call = new BaseClientCall() {
325+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
325326
@Override
326327
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
327328
listener.set(responseListener);
@@ -367,7 +368,7 @@ public void onCompleted() {
367368
final AtomicReference<ClientCall.Listener<String>> listener =
368369
new AtomicReference<ClientCall.Listener<String>>();
369370
final List<Integer> requests = new ArrayList<Integer>();
370-
BaseClientCall call = new BaseClientCall() {
371+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
371372
@Override
372373
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
373374
listener.set(responseListener);
@@ -557,7 +558,7 @@ public void onCompleted() {
557558
public void blockingResponseStreamFailed() throws Exception {
558559
final AtomicReference<ClientCall.Listener<String>> listener =
559560
new AtomicReference<ClientCall.Listener<String>>();
560-
BaseClientCall call = new BaseClientCall() {
561+
NoopClientCall<Integer, String> call = new NoopClientCall<Integer, String>() {
561562
@Override
562563
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {
563564
listener.set(responseListener);
@@ -579,21 +580,4 @@ public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata
579580
assertSame(trailers, metadata);
580581
}
581582
}
582-
583-
private static class BaseClientCall extends ClientCall<Integer, String> {
584-
@Override
585-
public void start(io.grpc.ClientCall.Listener<String> responseListener, Metadata headers) {}
586-
587-
@Override
588-
public void request(int numMessages) {}
589-
590-
@Override
591-
public void cancel(String message, Throwable cause) {}
592-
593-
@Override
594-
public void halfClose() {}
595-
596-
@Override
597-
public void sendMessage(Integer message) {}
598-
}
599583
}

‎testing/src/main/java/io/grpc/testing/NoopClientCall.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2016, Google Inc. All rights reserved.
3+
*
4+
* Redistribution and use in source and binary forms, with or without
5+
* modification, are permitted provided that the following conditions are
6+
* met:
7+
*
8+
* * Redistributions of source code must retain the above copyright
9+
* notice, this list of conditions and the following disclaimer.
10+
* * Redistributions in binary form must reproduce the above
11+
* copyright notice, this list of conditions and the following disclaimer
12+
* in the documentation and/or other materials provided with the
13+
* distribution.
14+
*
15+
* * Neither the name of Google Inc. nor the names of its
16+
* contributors may be used to endorse or promote products derived from
17+
* this software without specific prior written permission.
18+
*
19+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30+
*/
31+
32+
package io.grpc.testing;
33+
34+
import io.grpc.ClientCall;
35+
import io.grpc.ExperimentalApi;
36+
import io.grpc.Metadata;
37+
38+
/**
39+
* {@link NoopClientCall} is a class that is designed for use in tests. It is designed to be used
40+
* in places where a scriptable call is necessary. By default, all methods are noops, and designed
41+
* to be overriden.
42+
*/
43+
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2234")
44+
public class NoopClientCall<ReqT, RespT> extends ClientCall<ReqT, RespT> {
45+
46+
/**
47+
* {@link NoopClientCall.NoopClientCallListener} is a class that is designed for use in tests.
48+
* It is designed to be used in places where a scriptable call listener is necessary. By
49+
* default, all methods are noops, and designed to be overriden.
50+
*/
51+
public static class NoopClientCallListener<T> extends ClientCall.Listener<T> {
52+
}
53+
54+
@Override
55+
public void start(ClientCall.Listener<RespT> listener, Metadata headers) {}
56+
57+
@Override
58+
public void request(int numMessages) {}
59+
60+
@Override
61+
public void cancel(String message, Throwable cause) {}
62+
63+
@Override
64+
public void halfClose() {}
65+
66+
@Override
67+
public void sendMessage(ReqT message) {}
68+
}
69+

0 commit comments

Comments
 (0)