io.grpc.testing.integration

Class AbstractInteropTest

java.lang.Object

io.grpc.testing.integration.AbstractInteropTest

public abstract class AbstractInteropTest
extends Object

Abstract base class for all GRPC transport tests.

New tests should avoid using Mockito to support running on AppEngine.

Field Summary

Fields

Modifier and Type	Field and Description
protected TestServiceGrpc.TestServiceStub	asyncStub
protected TestServiceGrpc.TestServiceBlockingStub	blockingStub
protected io.grpc.ManagedChannel	channel
protected static EmptyProtos.Empty	EMPTY
org.junit.rules.TestRule	globalTimeout
static int	MAX_MESSAGE_SIZE Must be at least unaryPayloadLength(), plus some to account for encoding overhead.
static int	TEST_FLOW_CONTROL_WINDOW Use a small flow control to help detect flow control bugs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInteropTest() Constructor for tests.

Method Summary

Modifier and Type	Method and Description
protected static void	assertSuccess(io.grpc.internal.testing.StreamRecorder<?> recorder)
protected void	assertX500SubjectDn(String tlsInfo) Helper for asserting TLS info in SSLSession ServerCall.getAttributes().
protected static void	assumeEnoughMemory() Some tests run on memory constrained environments.
void	cacheableUnary() Sends a cacheable unary rpc using GET.
void	cancelAfterBegin()
void	cancelAfterFirstResponse()
void	censusContextsPropagated()
void	clientCompressedStreaming(boolean probe) Tests client per-message compression for streaming calls.
void	clientCompressedUnary(boolean probe) Tests client per-message compression for unary calls.
void	clientStreaming()
void	computeEngineChannelCredentials(String defaultServiceAccount, TestServiceGrpc.TestServiceBlockingStub computeEngineStub) Sends an unary rpc with ComputeEngineChannelBuilder.
void	computeEngineCreds(String serviceAccount, String oauthScope) Sends a large unary rpc with compute engine credentials.
protected io.grpc.ClientInterceptor	createCensusStatsClientInterceptor()
protected io.grpc.ManagedChannel	createChannel()
protected abstract io.grpc.ManagedChannelBuilder<?>	createChannelBuilder()
protected io.grpc.ServerStreamTracer.Factory	createCustomCensusTracerFactory()
protected boolean	customCensusModulePresent() Override this when custom census module presence is different from metricsExpected().
void	customMetadata()
void	deadlineExceeded()
void	deadlineExceededServerStreaming()
void	deadlineInPast()
void	deadlineNotExceeded()
void	emptyStream()
void	emptyUnary()
void	emptyUnaryWithRetriableStream()
void	exchangeMetadataStreamingCall()
void	exchangeMetadataUnaryCall()
void	fullDuplexCallShouldSucceed()
protected io.grpc.ClientInterceptor[]	getAdditionalInterceptors()
protected io.grpc.ServerBuilder<?>	getHandshakerServerBuilder()
void	getServerAddressAndLocalAddressFromClient() Verifies remote server address and local client address are available from ClientCall Attributes via ClientInterceptor.
protected io.grpc.ServerBuilder<?>	getServerBuilder() Returns the server builder used to create server for each test run.
void	googleDefaultCredentials(String defaultServiceAccount, TestServiceGrpc.TestServiceBlockingStub googleDefaultStub) Sends an unary rpc with "google default credentials".
void	gracefulShutdown()
void	halfDuplexCallShouldSucceed()
void	jwtTokenCreds(InputStream serviceAccountJson) Test JWT-based auth.
void	largeUnary()
void	maxInboundSize_exact()
void	maxInboundSize_tooBig()
void	maxOutboundSize_exact()
void	maxOutboundSize_tooBig()
protected boolean	metricsExpected() Return true if exact metric values should be checked.
void	oauth2AuthToken(String jsonKey, InputStream credentialsStream, String authScope) Sends a unary rpc with raw oauth2 access token credentials.
protected SocketAddress	obtainLocalClientAddr() Helper for getting local address from ClientCall.getAttributes().
protected SocketAddress	obtainLocalServerAddr() Helper for getting local address from ServerCall.getAttributes().
protected SocketAddress	obtainRemoteClientAddr() Helper for getting remote address from ServerCall.getAttributes().
protected SocketAddress	obtainRemoteServerAddr() Helper for getting remote address from ClientCall.getAttributes().
protected int	operationTimeoutMillis()
void	performSoakTest(String serverUri, boolean resetChannelPerIteration, int soakIterations, int maxFailures, int maxAcceptablePerIterationLatencyMs, int minTimeMsBetweenRpcs, int overallTimeoutSeconds) Runs large unary RPCs in a loop with configurable failure thresholds and channel creation behavior.
void	perRpcCreds(String jsonKey, InputStream credentialsStream, String oauthScope) Sends a unary rpc with "per rpc" raw oauth2 access token credentials.
void	pickFirstUnary() Assuming "pick_first" policy is used, tests that all requests are sent to the same server.
void	pingPong()
void	sendsTimeoutHeader()
void	serverCompressedStreaming() Tests server per-message compression in a streaming response.
void	serverCompressedUnary() Tests if the server can send a compressed unary response.
void	serverStreaming()
void	serverStreamingShouldBeFlowControlled()
void	serviceAccountCreds(String jsonKey, InputStream credentialsStream, String authScope) Sends a large unary rpc with service account credentials.
void	setUp() Must be called by the subclass setup method if overridden.
void	specialStatusMessage()
protected void	startServer(io.grpc.ServerBuilder<?> builder)
void	statusCodeAndMessage()
void	tearDown() Clean up.
void	testOrcaOob() Test backend metrics OOB reporting: expect the test client LB policy to receive load reports.
void	testOrcaPerRpc() Test backend metrics per query reporting: expect the test client LB policy to receive load reports.
void	timeoutOnSleepingServer() Start a fullDuplexCall which the server will not respond, and verify the deadline expires.
protected int	unaryPayloadLength()
void	unimplementedMethod() Sends an rpc to an unimplemented method within TestService.
void	unimplementedService() Sends an rpc to an unimplemented service on the server.
void	veryLargeRequest()
void	veryLargeResponse()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

globalTimeout

public final org.junit.rules.TestRule globalTimeout

MAX_MESSAGE_SIZE

public static final int MAX_MESSAGE_SIZE

Must be at least unaryPayloadLength(), plus some to account for encoding overhead.

See Also:

Constant Field Values

TEST_FLOW_CONTROL_WINDOW

public static final int TEST_FLOW_CONTROL_WINDOW

Use a small flow control to help detect flow control bugs. Don't use 64KiB to test SETTINGS/WINDOW_UPDATE exchange.

See Also:

Constant Field Values

EMPTY

protected static final EmptyProtos.Empty EMPTY

channel

protected io.grpc.ManagedChannel channel

blockingStub

protected TestServiceGrpc.TestServiceBlockingStub blockingStub

asyncStub

protected TestServiceGrpc.TestServiceStub asyncStub

Constructor Detail

AbstractInteropTest

protected AbstractInteropTest()

Constructor for tests.

Method Detail

startServer

protected void startServer(@Nullable
                           io.grpc.ServerBuilder<?> builder)

setUp

public void setUp()

Must be called by the subclass setup method if overridden.

tearDown

public void tearDown()

Clean up.

createChannel

protected io.grpc.ManagedChannel createChannel()

createChannelBuilder

protected abstract io.grpc.ManagedChannelBuilder<?> createChannelBuilder()

getAdditionalInterceptors

@Nullable
protected io.grpc.ClientInterceptor[] getAdditionalInterceptors()

getServerBuilder

@Nullable
protected io.grpc.ServerBuilder<?> getServerBuilder()

Returns the server builder used to create server for each test run. Return null if it shouldn't start a server in the same process.

getHandshakerServerBuilder

@Nullable
protected io.grpc.ServerBuilder<?> getHandshakerServerBuilder()

createCensusStatsClientInterceptor

protected final io.grpc.ClientInterceptor createCensusStatsClientInterceptor()

createCustomCensusTracerFactory

protected final io.grpc.ServerStreamTracer.Factory createCustomCensusTracerFactory()

customCensusModulePresent

protected boolean customCensusModulePresent()

Override this when custom census module presence is different from metricsExpected().

metricsExpected

protected boolean metricsExpected()

Return true if exact metric values should be checked.

emptyUnary

public void emptyUnary()
                throws Exception

Throws:

Exception

emptyUnaryWithRetriableStream

public void emptyUnaryWithRetriableStream()
                                   throws Exception

Throws:

Exception

cacheableUnary

public void cacheableUnary()

Sends a cacheable unary rpc using GET. Requires that the server is behind a caching proxy.

largeUnary

public void largeUnary()
                throws Exception

Throws:

Exception

clientCompressedUnary

public void clientCompressedUnary(boolean probe)
                           throws Exception

Tests client per-message compression for unary calls. The Java API does not support inspecting a message's compression level, so this is primarily intended to run against a gRPC C++ server.

Throws:

Exception

serverCompressedUnary

public void serverCompressedUnary()
                           throws Exception

Tests if the server can send a compressed unary response. Ideally we would assert that the responses have the requested compression, but this is not supported by the API. Given a compliant server, this test will exercise the code path for receiving a compressed response but cannot itself verify that the response was compressed.

Throws:

Exception

pickFirstUnary

public void pickFirstUnary()
                    throws Exception

Assuming "pick_first" policy is used, tests that all requests are sent to the same server.

Throws:

Exception

serverStreaming

public void serverStreaming()
                     throws Exception

Throws:

Exception

clientStreaming

public void clientStreaming()
                     throws Exception

Throws:

Exception

clientCompressedStreaming

public void clientCompressedStreaming(boolean probe)
                               throws Exception

Tests client per-message compression for streaming calls. The Java API does not support inspecting a message's compression level, so this is primarily intended to run against a gRPC C++ server.

Throws:

Exception

serverCompressedStreaming

public void serverCompressedStreaming()
                               throws Exception

Tests server per-message compression in a streaming response. Ideally we would assert that the responses have the requested compression, but this is not supported by the API. Given a compliant server, this test will exercise the code path for receiving a compressed response but cannot itself verify that the response was compressed.

Throws:

Exception

pingPong

public void pingPong()
              throws Exception

Throws:

Exception

emptyStream

public void emptyStream()
                 throws Exception

Throws:

Exception

cancelAfterBegin

public void cancelAfterBegin()
                      throws Exception

Throws:

Exception

cancelAfterFirstResponse

public void cancelAfterFirstResponse()
                              throws Exception

Throws:

Exception

fullDuplexCallShouldSucceed

public void fullDuplexCallShouldSucceed()
                                 throws Exception

Throws:

Exception

halfDuplexCallShouldSucceed

public void halfDuplexCallShouldSucceed()
                                 throws Exception

Throws:

Exception

serverStreamingShouldBeFlowControlled

public void serverStreamingShouldBeFlowControlled()
                                           throws Exception

Throws:

Exception

veryLargeRequest

public void veryLargeRequest()
                      throws Exception

Throws:

Exception

veryLargeResponse

public void veryLargeResponse()
                       throws Exception

Throws:

Exception

exchangeMetadataUnaryCall

public void exchangeMetadataUnaryCall()
                               throws Exception

Throws:

Exception

exchangeMetadataStreamingCall

public void exchangeMetadataStreamingCall()
                                   throws Exception

Throws:

Exception

sendsTimeoutHeader

public void sendsTimeoutHeader()

deadlineNotExceeded

public void deadlineNotExceeded()

deadlineExceeded

public void deadlineExceeded()
                      throws Exception

Throws:

Exception

deadlineExceededServerStreaming

public void deadlineExceededServerStreaming()
                                     throws Exception

Throws:

Exception

deadlineInPast

public void deadlineInPast()
                    throws Exception

Throws:

Exception

maxInboundSize_exact

public void maxInboundSize_exact()

maxInboundSize_tooBig

public void maxInboundSize_tooBig()

maxOutboundSize_exact

public void maxOutboundSize_exact()

maxOutboundSize_tooBig

public void maxOutboundSize_tooBig()

unaryPayloadLength

protected int unaryPayloadLength()

gracefulShutdown

public void gracefulShutdown()
                      throws Exception

Throws:

Exception

customMetadata

public void customMetadata()
                    throws Exception

Throws:

Exception

censusContextsPropagated

public void censusContextsPropagated()

statusCodeAndMessage

public void statusCodeAndMessage()
                          throws Exception

Throws:

Exception

specialStatusMessage

public void specialStatusMessage()
                          throws Exception

Throws:

Exception

unimplementedMethod

public void unimplementedMethod()

Sends an rpc to an unimplemented method within TestService.

unimplementedService

public void unimplementedService()

Sends an rpc to an unimplemented service on the server.

timeoutOnSleepingServer

public void timeoutOnSleepingServer()
                             throws Exception

Start a fullDuplexCall which the server will not respond, and verify the deadline expires.

Throws:

Exception

getServerAddressAndLocalAddressFromClient

public void getServerAddressAndLocalAddressFromClient()

Verifies remote server address and local client address are available from ClientCall Attributes via ClientInterceptor.

testOrcaPerRpc

public void testOrcaPerRpc()
                    throws Exception

Test backend metrics per query reporting: expect the test client LB policy to receive load reports.

Throws:

Exception

testOrcaOob

public void testOrcaOob()
                 throws Exception

Test backend metrics OOB reporting: expect the test client LB policy to receive load reports.

Throws:

Exception

serviceAccountCreds

public void serviceAccountCreds(String jsonKey,
                                InputStream credentialsStream,
                                String authScope)
                         throws Exception

Sends a large unary rpc with service account credentials.

Throws:

Exception

computeEngineCreds

public void computeEngineCreds(String serviceAccount,
                               String oauthScope)
                        throws Exception

Sends a large unary rpc with compute engine credentials.

Throws:

Exception

computeEngineChannelCredentials

public void computeEngineChannelCredentials(String defaultServiceAccount,
                                            TestServiceGrpc.TestServiceBlockingStub computeEngineStub)
                                     throws Exception

Sends an unary rpc with ComputeEngineChannelBuilder.

Throws:

Exception

jwtTokenCreds

public void jwtTokenCreds(InputStream serviceAccountJson)
                   throws Exception

Test JWT-based auth.

Throws:

Exception

oauth2AuthToken

public void oauth2AuthToken(String jsonKey,
                            InputStream credentialsStream,
                            String authScope)
                     throws Exception

Sends a unary rpc with raw oauth2 access token credentials.

Throws:

Exception

perRpcCreds

public void perRpcCreds(String jsonKey,
                        InputStream credentialsStream,
                        String oauthScope)
                 throws Exception

Sends a unary rpc with "per rpc" raw oauth2 access token credentials.

Throws:

Exception

googleDefaultCredentials

public void googleDefaultCredentials(String defaultServiceAccount,
                                     TestServiceGrpc.TestServiceBlockingStub googleDefaultStub)
                              throws Exception

Sends an unary rpc with "google default credentials".

Throws:

Exception

performSoakTest

public void performSoakTest(String serverUri,
                            boolean resetChannelPerIteration,
                            int soakIterations,
                            int maxFailures,
                            int maxAcceptablePerIterationLatencyMs,
                            int minTimeMsBetweenRpcs,
                            int overallTimeoutSeconds)
                     throws Exception

Runs large unary RPCs in a loop with configurable failure thresholds and channel creation behavior.

Throws:

Exception

assertSuccess

protected static void assertSuccess(io.grpc.internal.testing.StreamRecorder<?> recorder)

obtainRemoteClientAddr

protected SocketAddress obtainRemoteClientAddr()

Helper for getting remote address from ServerCall.getAttributes().

obtainRemoteServerAddr

protected SocketAddress obtainRemoteServerAddr()

Helper for getting remote address from ClientCall.getAttributes().

obtainLocalServerAddr

protected SocketAddress obtainLocalServerAddr()

Helper for getting local address from ServerCall.getAttributes().

obtainLocalClientAddr

protected SocketAddress obtainLocalClientAddr()

Helper for getting local address from ClientCall.getAttributes().

assertX500SubjectDn

protected void assertX500SubjectDn(String tlsInfo)

Helper for asserting TLS info in SSLSession ServerCall.getAttributes().

operationTimeoutMillis

protected int operationTimeoutMillis()

assumeEnoughMemory

protected static void assumeEnoughMemory()

Some tests run on memory constrained environments. Rather than OOM, just give up. 64 is chosen as a maximum amount of memory a large test would need.