com.google.api.generator.gapic.composer.common

Class AbstractServiceClientTestClassComposer

java.lang.Object

com.google.api.generator.gapic.composer.common.AbstractServiceClientTestClassComposer

All Implemented Interfaces:

ClassComposer

Direct Known Subclasses:

ServiceClientTestClassComposer, ServiceClientTestClassComposer

public abstract class AbstractServiceClientTestClassComposer
extends Object
implements ClassComposer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLIENT_VAR_NAME
protected static Statement	EMPTY_LINE_STATEMENT
protected static TypeStore	FIXED_TYPESTORE
protected static AnnotationNode	TEST_ANNOTATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServiceClientTestClassComposer(TransportContext transportContext)

Method Summary

Modifier and Type	Method and Description
protected abstract List<Statement>	constructRpcTestCheckerLogic(Method method, List<MethodArgument> methodSignature, Service service, boolean isRequestArg, Map<String,VariableExpr> classMemberVarExprs, VariableExpr requestVarExpr, Message requestMessage)
protected List<Statement>	createClassMemberFieldDecls(Map<String,VariableExpr> classMemberVarExprs)
protected abstract Map<String,VariableExpr>	createClassMemberVarExprs(Service service, GapicContext context, TypeStore typeStore)
protected abstract MethodDefinition	createRpcExceptionTestMethod(Method method, Service service, List<MethodArgument> methodSignature, int variantIndex, Map<String,VariableExpr> classMemberVarExprs, Map<String,ResourceName> resourceNames, Map<String,Message> messageTypes) Creates a test method to exercise exceptions for a given RPC, e.g.
protected List<Statement>	createRpcExceptionTestStatements(Method method, List<MethodArgument> methodSignature, Map<String,VariableExpr> classMemberVarExprs, Map<String,ResourceName> resourceNames, Map<String,Message> messageTypes)
protected abstract List<Statement>	createRpcLroExceptionTestCatchBody(VariableExpr exceptionExpr, boolean isStreaming)
protected abstract MethodDefinition	createSetUpMethod(Service service, Map<String,VariableExpr> classMemberVarExprs, TypeStore typeStore)
protected abstract MethodDefinition	createStartStaticServerMethod(Service service, GapicContext context, Map<String,VariableExpr> classMemberVarExprs, TypeStore typeStore, String newBuilderMethod)
protected abstract MethodDefinition	createStopServerMethod(Service service, Map<String,VariableExpr> classMemberVarExprs)
protected abstract List<Statement>	createStreamingRpcExceptionTestStatements(Method method, Map<String,VariableExpr> classMemberVarExprs, Map<String,ResourceName> resourceNames, Map<String,Message> messageTypes)
protected abstract MethodDefinition	createStreamingRpcTestMethod(Service service, Method method, Map<String,VariableExpr> classMemberVarExprs, Map<String,ResourceName> resourceNames, Map<String,Message> messageTypes)
protected abstract MethodDefinition	createTearDownMethod(Service service, Map<String,VariableExpr> classMemberVarExprs)
protected MethodDefinition	createUnsupportedTestMethod(Method method)
GapicClass	generate(GapicContext context, Service service)
protected GapicClass	generate(String className, GapicContext context, Service service)
protected static String	getCallableMethodName(Method protoMethod)
protected static TypeNode	getCallableType(Method protoMethod)
protected String	getMockServiceVarName(Service service)
TransportContext	getTransportContext()
protected boolean	isSupportedMethod(Method method)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_LINE_STATEMENT

protected static final Statement EMPTY_LINE_STATEMENT

CLIENT_VAR_NAME

protected static final String CLIENT_VAR_NAME

See Also:

Constant Field Values

FIXED_TYPESTORE

protected static final TypeStore FIXED_TYPESTORE

TEST_ANNOTATION

protected static final AnnotationNode TEST_ANNOTATION

Constructor Detail

AbstractServiceClientTestClassComposer

protected AbstractServiceClientTestClassComposer(TransportContext transportContext)

Method Detail

getTransportContext

public TransportContext getTransportContext()

generate

public GapicClass generate(GapicContext context,
                           Service service)

Specified by:

generate in interface ClassComposer

generate

protected GapicClass generate(String className,
                              GapicContext context,
                              Service service)

isSupportedMethod

protected boolean isSupportedMethod(Method method)

createClassMemberVarExprs

protected abstract Map<String,VariableExpr> createClassMemberVarExprs(Service service,
                                                                      GapicContext context,
                                                                      TypeStore typeStore)

createClassMemberFieldDecls

protected List<Statement> createClassMemberFieldDecls(Map<String,VariableExpr> classMemberVarExprs)

createStartStaticServerMethod

protected abstract MethodDefinition createStartStaticServerMethod(Service service,
                                                                  GapicContext context,
                                                                  Map<String,VariableExpr> classMemberVarExprs,
                                                                  TypeStore typeStore,
                                                                  String newBuilderMethod)

createStopServerMethod

protected abstract MethodDefinition createStopServerMethod(Service service,
                                                           Map<String,VariableExpr> classMemberVarExprs)

createSetUpMethod

protected abstract MethodDefinition createSetUpMethod(Service service,
                                                      Map<String,VariableExpr> classMemberVarExprs,
                                                      TypeStore typeStore)

createTearDownMethod

protected abstract MethodDefinition createTearDownMethod(Service service,
                                                         Map<String,VariableExpr> classMemberVarExprs)

constructRpcTestCheckerLogic

protected abstract List<Statement> constructRpcTestCheckerLogic(Method method,
                                                                List<MethodArgument> methodSignature,
                                                                Service service,
                                                                boolean isRequestArg,
                                                                Map<String,VariableExpr> classMemberVarExprs,
                                                                VariableExpr requestVarExpr,
                                                                Message requestMessage)

createStreamingRpcTestMethod

protected abstract MethodDefinition createStreamingRpcTestMethod(Service service,
                                                                 Method method,
                                                                 Map<String,VariableExpr> classMemberVarExprs,
                                                                 Map<String,ResourceName> resourceNames,
                                                                 Map<String,Message> messageTypes)

createRpcExceptionTestMethod

protected abstract MethodDefinition createRpcExceptionTestMethod(Method method,
                                                                 Service service,
                                                                 List<MethodArgument> methodSignature,
                                                                 int variantIndex,
                                                                 Map<String,VariableExpr> classMemberVarExprs,
                                                                 Map<String,ResourceName> resourceNames,
                                                                 Map<String,Message> messageTypes)

Creates a test method to exercise exceptions for a given RPC, e.g. createAssetTest.

Parameters:

method - the RPC for which this test method is created.

service - the service that method belongs to.

methodSignature - the method signature of the RPC under test.

variantIndex - the nth variant of the RPC under test. This applies when we have polymorphism due to the presence of several method signature annotations in the proto.

classMemberVarExprs - the class members in the generated test class.

resourceNames - the resource names available for use.

messageTypes - the proto message types available for use.

createStreamingRpcExceptionTestStatements

protected abstract List<Statement> createStreamingRpcExceptionTestStatements(Method method,
                                                                             Map<String,VariableExpr> classMemberVarExprs,
                                                                             Map<String,ResourceName> resourceNames,
                                                                             Map<String,Message> messageTypes)

createUnsupportedTestMethod

protected MethodDefinition createUnsupportedTestMethod(Method method)

createRpcExceptionTestStatements

protected List<Statement> createRpcExceptionTestStatements(Method method,
                                                           List<MethodArgument> methodSignature,
                                                           Map<String,VariableExpr> classMemberVarExprs,
                                                           Map<String,ResourceName> resourceNames,
                                                           Map<String,Message> messageTypes)

createRpcLroExceptionTestCatchBody

protected abstract List<Statement> createRpcLroExceptionTestCatchBody(VariableExpr exceptionExpr,
                                                                      boolean isStreaming)

getCallableType

protected static TypeNode getCallableType(Method protoMethod)

getCallableMethodName

protected static String getCallableMethodName(Method protoMethod)

getMockServiceVarName

protected String getMockServiceVarName(Service service)