Skip to content

[ggj][codegen][test] feat: add streaming variants to ServiceClientTest #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miraleung merged 4 commits into from
Oct 1, 2020
Merged

[ggj][codegen][test] feat: add streaming variants to ServiceClientTest #353

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
539b5e6
feat: add streaming test variants to ServiceClientTest
miraleung Sep 28, 2020
e980f79
Merge branch 'master' into gp/g0
miraleung Oct 1, 2020
b4b89ec
Merge branch 'master' into gp/g0
miraleung Oct 1, 2020
b9c504b
Merge branch 'master' into gp/g0
miraleung Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
251 changes: 246 additions & 5 deletions src/main/java/com/google/api/generator/gapic/composer/ServiceClientTestClassComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,8 @@ private static List<MethodDefinition> createTestMethods(
Map<String, Message> messageTypes) {
List<MethodDefinition> javaMethods = new ArrayList<>();
for (Method method : service.methods()) {
if (method.methodSignatures().isEmpty()) {
// Ignore variants for streaming methods as well.
if (method.methodSignatures().isEmpty() || !method.stream().equals(Method.Stream.NONE)) {
javaMethods.add(
createRpcTestMethod(
method,
Expand Down Expand Up @@ -489,6 +490,10 @@ private static MethodDefinition createRpcTestMethod(
Map<String, VariableExpr> classMemberVarExprs,
Map<String, ResourceName> resourceNames,
Map<String, Message> messageTypes) {
if (!method.stream().equals(Method.Stream.NONE)) {
return createStreamingRpcTestMethod(
method, serviceName, classMemberVarExprs, resourceNames, messageTypes);
}
// Construct the expected response.
// TODO(miraleung): Paging here.
TypeNode methodOutputType = method.hasLro() ? method.lro().responseType() : method.outputType();
Expand Down Expand Up @@ -890,6 +895,242 @@ private static MethodDefinition createRpcTestMethod(
.build();
}

private static MethodDefinition createStreamingRpcTestMethod(
Method method,
String serviceName,
Map<String, VariableExpr> classMemberVarExprs,
Map<String, ResourceName> resourceNames,
Map<String, Message> messageTypes) {
TypeNode methodOutputType = method.hasLro() ? method.lro().responseType() : method.outputType();
List<Expr> methodExprs = new ArrayList<>();
VariableExpr expectedResponseVarExpr =
VariableExpr.withVariable(
Variable.builder().setType(methodOutputType).setName("expectedResponse").build());
Expr expectedResponseValExpr = null;
if (messageTypes.containsKey(methodOutputType.reference().name())) {
expectedResponseValExpr =
DefaultValueComposer.createSimpleMessageBuilderExpr(
messageTypes.get(methodOutputType.reference().name()), resourceNames, messageTypes);
} else {
// Wrap this in a field so we don't have to split the helper into lots of different methods,
// or duplicate it for VariableExpr.
expectedResponseValExpr =
DefaultValueComposer.createDefaultValue(
Field.builder()
.setType(methodOutputType)
.setIsMessage(true)
.setName("expectedResponse")
.build());
}
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(expectedResponseVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(expectedResponseValExpr)
.build());
if (method.hasLro()) {
VariableExpr resultOperationVarExpr =
VariableExpr.withVariable(
Variable.builder()
.setType(STATIC_TYPES.get("Operation"))
.setName("resultOperation")
.build());
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(resultOperationVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(
DefaultValueComposer.createSimpleOperationBuilderExpr(
String.format("%sTest", JavaStyle.toLowerCamelCase(method.name())),
expectedResponseVarExpr))
.build());
methodExprs.add(
MethodInvocationExpr.builder()
.setExprReferenceExpr(classMemberVarExprs.get(getMockServiceVarName(serviceName)))
.setMethodName("addResponse")
.setArguments(resultOperationVarExpr)
.build());
} else {
methodExprs.add(
MethodInvocationExpr.builder()
.setExprReferenceExpr(classMemberVarExprs.get(getMockServiceVarName(serviceName)))
.setMethodName("addResponse")
.setArguments(expectedResponseVarExpr)
.build());
}
// TODO(miraleung): Empty line here.

// Construct the request or method arguments.
VariableExpr requestVarExpr =
VariableExpr.withVariable(
Variable.builder().setType(method.inputType()).setName("request").build());
Message requestMessage = messageTypes.get(method.inputType().reference().name());
Preconditions.checkNotNull(requestMessage);
Expr valExpr =
DefaultValueComposer.createSimpleMessageBuilderExpr(
requestMessage, resourceNames, messageTypes);
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(requestVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(valExpr)
.build());

// Construct the mock stream observer.
VariableExpr responseObserverVarExpr =
VariableExpr.withVariable(
Variable.builder()
.setType(
TypeNode.withReference(
STATIC_TYPES
.get("MockStreamObserver")
.reference()
.copyAndSetGenerics(Arrays.asList(method.outputType().reference()))))
.setName("responseObserver")
.build());

methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(responseObserverVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(
NewObjectExpr.builder()
.setType(STATIC_TYPES.get("MockStreamObserver"))
.setIsGeneric(true)
.build())
.build());

// Build the callable variable and assign it.
VariableExpr callableVarExpr =
VariableExpr.withVariable(
Variable.builder().setType(getCallableType(method)).setName("callable").build());
Expr streamingCallExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(classMemberVarExprs.get("client"))
.setMethodName(String.format("%sCallable", JavaStyle.toLowerCamelCase(method.name())))
.setReturnType(callableVarExpr.type())
.build();
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(callableVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(streamingCallExpr)
.build());

// Call the streaming-variant callable method.
if (method.stream().equals(Method.Stream.SERVER)) {
methodExprs.add(
MethodInvocationExpr.builder()
.setExprReferenceExpr(callableVarExpr)
.setMethodName("serverStreamingCall")
.setArguments(requestVarExpr, responseObserverVarExpr)
.build());
} else {
VariableExpr requestObserverVarExpr =
VariableExpr.withVariable(
Variable.builder()
.setType(
TypeNode.withReference(
STATIC_TYPES
.get("ApiStreamObserver")
.reference()
.copyAndSetGenerics(Arrays.asList(method.inputType().reference()))))
.setName("requestObserver")
.build());
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(requestObserverVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(
MethodInvocationExpr.builder()
.setExprReferenceExpr(callableVarExpr)
.setMethodName(getCallableMethodName(method))
.setArguments(requestVarExpr, responseObserverVarExpr)
.setReturnType(requestObserverVarExpr.type())
.build())
.build());

// TODO(miraleung): Empty line here.
methodExprs.add(
MethodInvocationExpr.builder()
.setExprReferenceExpr(requestObserverVarExpr)
.setMethodName("onNext")
.setArguments(requestVarExpr)
.build());
methodExprs.add(
MethodInvocationExpr.builder()
.setExprReferenceExpr(requestObserverVarExpr)
.setMethodName("onCompleted")
.build());
}

// Check the actual responses.
VariableExpr actualResponsesVarExpr =
VariableExpr.withVariable(
Variable.builder()
.setType(
TypeNode.withReference(
ConcreteReference.builder()
.setClazz(List.class)
.setGenerics(Arrays.asList(method.outputType().reference()))
.build()))
.setName("actualResponses")
.build());

Expr getFutureResponseExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(responseObserverVarExpr)
.setMethodName("future")
.build();
getFutureResponseExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(getFutureResponseExpr)
.setMethodName("get")
.setReturnType(actualResponsesVarExpr.type())
.build();
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(actualResponsesVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(getFutureResponseExpr)
.build());

// Assert the size is equivalent.
methodExprs.add(
MethodInvocationExpr.builder()
.setStaticReferenceType(STATIC_TYPES.get("Assert"))
.setMethodName("assertEquals")
.setArguments(
ValueExpr.withValue(
PrimitiveValue.builder().setType(TypeNode.INT).setValue("1").build()),
MethodInvocationExpr.builder()
.setExprReferenceExpr(actualResponsesVarExpr)
.setMethodName("size")
.setReturnType(TypeNode.INT)
.build())
.build());

// Assert the responses are equivalent.
Expr zeroExpr =
ValueExpr.withValue(PrimitiveValue.builder().setType(TypeNode.INT).setValue("0").build());
Expr actualResponseExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(actualResponsesVarExpr)
.setMethodName("get")
.setArguments(zeroExpr)
.build();

methodExprs.add(
MethodInvocationExpr.builder()
.setStaticReferenceType(STATIC_TYPES.get("Assert"))
.setMethodName("assertEquals")
.setArguments(expectedResponseVarExpr, actualResponseExpr)
.build());

String testMethodName = String.format("%sTest", JavaStyle.toLowerCamelCase(method.name()));
return MethodDefinition.builder()
.setAnnotations(Arrays.asList(TEST_ANNOTATION))
.setScope(ScopeNode.PUBLIC)
.setReturnType(TypeNode.VOID)
.setName(testMethodName)
.setBody(
methodExprs.stream().map(e -> ExprStatement.withExpr(e)).collect(Collectors.toList()))
.build();
}

private static MethodDefinition createRpcExceptionTestMethod(
Method method,
List<MethodArgument> methodSignature,
Expand Down Expand Up @@ -938,11 +1179,11 @@ private static MethodDefinition createRpcExceptionTestMethod(
methodBody.add(ExprStatement.withExpr(addExceptionExpr));
if (isStreaming) {
methodBody.addAll(
createRpcExceptionTestStreamingStatements(
createStreamingRpcExceptionTestStatements(
method, classMemberVarExprs, resourceNames, messageTypes));
} else {
methodBody.addAll(
createRpcExceptionTestNonStreamingStatements(
createRpcExceptionTestStatements(
method, methodSignature, classMemberVarExprs, resourceNames, messageTypes));
}

Expand All @@ -956,7 +1197,7 @@ private static MethodDefinition createRpcExceptionTestMethod(
.build();
}

private static List<Statement> createRpcExceptionTestStreamingStatements(
private static List<Statement> createStreamingRpcExceptionTestStatements(
Method method,
Map<String, VariableExpr> classMemberVarExprs,
Map<String, ResourceName> resourceNames,
Expand Down Expand Up @@ -1118,7 +1359,7 @@ private static List<Statement> createRpcExceptionTestStreamingStatements(
return statements;
}

private static List<Statement> createRpcExceptionTestNonStreamingStatements(
private static List<Statement> createRpcExceptionTestStatements(
Method method,
List<MethodArgument> methodSignature,
Map<String, VariableExpr> classMemberVarExprs,
Expand Down
Loading