io.grpc.testing

Class TestUtils

java.lang.Object

io.grpc.testing.TestUtils

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1791")
public class TestUtils
extends Object

Common utility functions useful for writing tests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST_SERVER_HOST

Method Summary

Modifier and Type	Method and Description
static io.grpc.ServerInterceptor	echoRequestHeadersInterceptor(io.grpc.Metadata.Key<?>... keys) Echo the request headers from a client into response headers and trailers.
static File	loadCert(String name) Saves a file from the classpath resources in src/main/resources/certs as a file on the filesystem.
static X509Certificate	loadX509Cert(String fileName) Loads an X.509 certificate from the classpath resources in src/main/resources/certs.
static SSLSocketFactory	newSslSocketFactoryForCa(File certChainFile) Creates an SSLSocketFactory which contains certChainFile as its only root certificate.
static SSLSocketFactory	newSslSocketFactoryForCa(InputStream certChain) Creates an SSLSocketFactory which contains certChainFile as its only root certificate.
static List<String>	preferredTestCiphers() Returns the ciphers preferred to use during tests.
static io.grpc.ServerInterceptor	recordRequestHeadersInterceptor(AtomicReference<io.grpc.Metadata> headersCapture) Capture the request headers from a client.
static io.grpc.ServerInterceptor	recordServerCallInterceptor(AtomicReference<io.grpc.ServerCall<?,?>> serverCallCapture) Capture the request attributes.
static InetSocketAddress	testServerAddress(int port) Creates a new InetSocketAddress on localhost that overrides the host with TEST_SERVER_HOST.
static InetSocketAddress	testServerAddress(String host, int port) Creates a new InetSocketAddress that overrides the host with TEST_SERVER_HOST.

Methods inherited from class java.lang.Object

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

Field Detail

TEST_SERVER_HOST

public static final String TEST_SERVER_HOST

See Also:

Constant Field Values

Method Detail

echoRequestHeadersInterceptor

public static io.grpc.ServerInterceptor echoRequestHeadersInterceptor(io.grpc.Metadata.Key<?>... keys)

Echo the request headers from a client into response headers and trailers. Useful for testing end-to-end metadata propagation.

recordRequestHeadersInterceptor

public static io.grpc.ServerInterceptor recordRequestHeadersInterceptor(AtomicReference<io.grpc.Metadata> headersCapture)

Capture the request headers from a client. Useful for testing metadata propagation without requiring that it be symmetric on client and server, as with echoRequestHeadersInterceptor(io.grpc.Metadata.Key<?>...).

recordServerCallInterceptor

public static io.grpc.ServerInterceptor recordServerCallInterceptor(AtomicReference<io.grpc.ServerCall<?,?>> serverCallCapture)

Capture the request attributes. Useful for testing ServerCalls. ServerCall.attributes()

testServerAddress

public static InetSocketAddress testServerAddress(String host,
                                                  int port)

Creates a new InetSocketAddress that overrides the host with TEST_SERVER_HOST.

testServerAddress

public static InetSocketAddress testServerAddress(int port)

Creates a new InetSocketAddress on localhost that overrides the host with TEST_SERVER_HOST.

preferredTestCiphers

public static List<String> preferredTestCiphers()

Returns the ciphers preferred to use during tests. They may be chosen because they are widely available or because they are fast. There is no requirement that they provide confidentiality or integrity.

loadCert

public static File loadCert(String name)
                     throws IOException

Saves a file from the classpath resources in src/main/resources/certs as a file on the filesystem.

Parameters:

name - name of a file in src/main/resources/certs.

Throws:

IOException

loadX509Cert

public static X509Certificate loadX509Cert(String fileName)
                                    throws CertificateException,
                                           IOException

Loads an X.509 certificate from the classpath resources in src/main/resources/certs.

Parameters:

fileName - name of a file in src/main/resources/certs.

Throws:

CertificateException

IOException

newSslSocketFactoryForCa

public static SSLSocketFactory newSslSocketFactoryForCa(File certChainFile)
                                                 throws Exception

Creates an SSLSocketFactory which contains certChainFile as its only root certificate.

Throws:

Exception

newSslSocketFactoryForCa

public static SSLSocketFactory newSslSocketFactoryForCa(InputStream certChain)
                                                 throws Exception

Creates an SSLSocketFactory which contains certChainFile as its only root certificate.

Throws:

Exception