JarCastinggrpc-mock-server
Features
- Generate mock services for given proto API and run grpc service with these services.
- Provide API to mock
request/responsefor grpc service. - Can be started in the separate container in the kubernetes for
devenviroment. - Provide API for
spyfunctional (can check if method was called with certain response). - Provide API for reset mock data.
Before running
Classes for grpc api should be generated in the project. Example for configuration com.google.protobuf gradle plugin.
sourceSets {
main {
java {
srcDirs(
"${protobuf.protobuf.generatedFilesBaseDir}/main/java/io/github/udarya/mockserver",
"${protobuf.protobuf.generatedFilesBaseDir}/main/grpckt/io/github/udarya/mockserver",
"${protobuf.protobuf.generatedFilesBaseDir}/main/grpc/io/github/udarya/mockserver"
)
}
proto {
dependencies {
protobuf("io.github.udarya:mock-server:${mock-server-version}")
}
srcDir("grpc_mock_api.proto")
}
}
}
protobuf {
protoc {
artifact = "com.google.protobuf:protoc:${protoc-version}"
}
plugins {
id("grpc") {
artifact = "io.grpc:protoc-gen-grpc-java:${grpc-version}"
}
id("grpckt") {
artifact = "io.grpc:protoc-gen-grpc-kotlin:${grpc-version}"
}
}
generateProtoTasks {
ofSourceSet("main").forEach {
it.plugins {
id("grpc")
id("grpckt")
}
}
}
}
grpc-mock-server should be added to the project as gradle dependency:
implementation("io.github.udarya:mock-server:${mock-server-version}")
Running mocks
Generate and run mock for defined proto API.
Example of using mock generator:
@ExperimentalStdlibApi
fun main() {
val service = generateAndRunGrpcMock(
port,
MockStructure("io.github.udarya.mockserver.TestFXAPIGrpcKt", "TestFXAPI")
)
service.awaitTermination()
}
io.github.udarya.mockserver.TestFXAPIGrpcKt - kotlin class generated by io.grpc:protoc-gen-grpc-kotlin plugin TestFXAPI - name of service from .proto file
Mock data API
Mock request/response for grpc service.
rpc AddMockData(AddMockDataRequest) returns (AddMockDataResponse);
Request:
message AddMockDataRequest {
string serviceName = 1; // service name from .proto file
string methodName = 2;
string requestJSON = 3; // use `protobuf-java-util` to avoid additional proto fields
string responseJSON = 4; // use `protobuf-java-util` to avoid additional proto fields
}
Response:
message AddMockDataResponse {
}
Example of use:
mockServerAPIGrpc.addMockData(
MockServerApiProto.AddMockDataRequest.newBuilder()
.setServiceName("TestFXAPI") // service name from .proto file
.setMethodName("getRates")
.setRequestJson(jsonPrinter.print(getRatesRq))
.setResponseJson(jsonPrinter.print(getRatesRs))
.build()
)
Important: use protobuf-java-util to convert request to JSON and avoid additional proto fields (JsonFormat.printer().includingDefaultValueFields()) More examples can be founded in GrpcMockServiceTest.
Verify method call API
rpc VerifyMethodCall(VerifyMethodCallRequest) returns (VerifyMethodCallResponse);
Request:
message VerifyMethodCallRequest {
string method_name = 1;
string request_json = 2; // Request with default fields. Use JsonFormat from protobuf-java-util library
repeated string exclude_fields = 3; // Exclude these fields for comparing
}
Response:
message VerifyMethodCallResponse {
bool is_success = 1;
string error_message = 2;
}
Example of use:
mockServerAPIGrpc.verifyMethodCall(
MockServerApiProto.VerifyMethodCallRequest.newBuilder()
.setMethodName(testFXAPIGrpc::getRates.name)
.setRequestJson(jsonPrinter.print(fxRequestWithDifferentCurrencyTo))
.addAllExcludeFields(listOf("currencyFrom"))
.build()
)
More examples can be founded in SpyTest.
Reset mock data API
Delete mock data for method.
rpc ResetMethodCalls(ResetMethodCallsRequest) returns (ResetMethodCallsResponse);
Request:
message ResetMethodCallsRequest {
string method_name = 1;
}
Response:
message ResetMethodCallsResponse {
}
Example of use:
mockServerAPIGrpc.resetMethodCalls(
MockServerApiProto.ResetMethodCallsRequest.newBuilder()
.setMethodName("getRates")
.build()
)
More examples can be founded in SpyTest.