| // Copyright 2015 The gRPC Authors |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| // Message definitions to be used by integration test service definitions. |
| |
| syntax = "proto3"; |
| |
| package grpc.testing; |
| |
| option java_package = "io.grpc.testing.integration"; |
| |
| // TODO(jihuncho): Use well-known types once all languages are synced. |
| message BoolValue { |
| // The bool value. |
| bool value = 1; |
| } |
| |
| // A block of data, to simply increase gRPC message size. |
| message Payload { |
| reserved 1; |
| |
| // Primary contents of payload. |
| bytes body = 2; |
| } |
| |
| // A protobuf representation for grpc status. This is used by test |
| // clients to specify a status that the server should attempt to return. |
| message EchoStatus { |
| int32 code = 1; |
| string message = 2; |
| } |
| |
| // The type of route that a client took to reach a server w.r.t. gRPCLB. |
| // The server must fill in "fallback" if it detects that the RPC reached |
| // the server via the "gRPCLB fallback" path, and "backend" if it detects |
| // that the RPC reached the server via "gRPCLB backend" path (i.e. if it got |
| // the address of this server from the gRPCLB server BalanceLoad RPC). Exactly |
| // how this detection is done is context and server dependent. |
| enum GrpclbRouteType { |
| // Server didn't detect the route that a client took to reach it. |
| GRPCLB_ROUTE_TYPE_UNKNOWN = 0; |
| // Indicates that a client reached a server via gRPCLB fallback. |
| GRPCLB_ROUTE_TYPE_FALLBACK = 1; |
| // Indicates that a client reached a server as a gRPCLB-given backend. |
| GRPCLB_ROUTE_TYPE_BACKEND = 2; |
| } |
| |
| // Unary request. |
| message SimpleRequest { |
| reserved 1; |
| |
| // Desired payload size in the response from the server. |
| int32 response_size = 2; |
| |
| // Optional input payload sent along with the request. |
| Payload payload = 3; |
| |
| // Whether SimpleResponse should include username. |
| bool fill_username = 4; |
| |
| // Whether SimpleResponse should include OAuth scope. |
| bool fill_oauth_scope = 5; |
| |
| // Whether to request the server to compress the response. This field is |
| // "nullable" in order to interoperate seamlessly with clients not able to |
| // implement the full compression tests by introspecting the call to verify |
| // the response's compression status. |
| BoolValue response_compressed = 6; |
| |
| // Whether server should return a given status |
| EchoStatus response_status = 7; |
| |
| // Whether the server should expect this request to be compressed. |
| BoolValue expect_compressed = 8; |
| |
| // Whether SimpleResponse should include server_id. |
| bool fill_server_id = 9; |
| |
| // Whether SimpleResponse should include grpclb_route_type. |
| bool fill_grpclb_route_type = 10; |
| } |
| |
| // Unary response, as configured by the request. |
| message SimpleResponse { |
| // Payload to increase message size. |
| Payload payload = 1; |
| // The user the request came from, for verifying authentication was |
| // successful when the client expected it. |
| string username = 2; |
| // OAuth scope. |
| string oauth_scope = 3; |
| // Server ID. This must be unique among different server instances, |
| // but the same across all RPC's made to a particular server instance. |
| string server_id = 4; |
| // gRPCLB Path. |
| GrpclbRouteType grpclb_route_type = 5; |
| // Server hostname. |
| string hostname = 6; |
| } |
| |
| message SimpleContext { |
| string value = 1; |
| } |
| |
| // Client-streaming request. |
| message StreamingInputCallRequest { |
| // Optional input payload sent along with the request. |
| Payload payload = 1; |
| |
| // Whether the server should expect this request to be compressed. This field |
| // is "nullable" in order to interoperate seamlessly with servers not able to |
| // implement the full compression tests by introspecting the call to verify |
| // the request's compression status. |
| BoolValue expect_compressed = 2; |
| |
| // Not expecting any payload from the response. |
| } |
| |
| // Client-streaming response. |
| message StreamingInputCallResponse { |
| // Aggregated size of payloads received from the client. |
| int32 aggregated_payload_size = 1; |
| } |
| |
| // Configuration for a particular response. |
| message ResponseParameters { |
| // Desired payload sizes in responses from the server. |
| int32 size = 1; |
| |
| // Desired interval between consecutive responses in the response stream in |
| // microseconds. |
| int32 interval_us = 2; |
| |
| // Whether to request the server to compress the response. This field is |
| // "nullable" in order to interoperate seamlessly with clients not able to |
| // implement the full compression tests by introspecting the call to verify |
| // the response's compression status. |
| BoolValue compressed = 3; |
| } |
| |
| // Server-streaming request. |
| message StreamingOutputCallRequest { |
| reserved 1; |
| |
| // Configuration for each expected response message. |
| repeated ResponseParameters response_parameters = 2; |
| |
| // Optional input payload sent along with the request. |
| Payload payload = 3; |
| |
| // Whether server should return a given status |
| EchoStatus response_status = 7; |
| } |
| |
| // Server-streaming response, as configured by the request and parameters. |
| message StreamingOutputCallResponse { |
| // Payload to increase response size. |
| Payload payload = 1; |
| } |
| |
| // For reconnect interop test only. |
| // Client tells server what reconnection parameters it used. |
| message ReconnectParams { |
| int32 max_reconnect_backoff_ms = 1; |
| } |
| |
| // For reconnect interop test only. |
| // Server tells client whether its reconnects are following the spec and the |
| // reconnect backoffs it saw. |
| message ReconnectInfo { |
| bool passed = 1; |
| repeated int32 backoff_ms = 2; |
| } |
| |
| message LoadBalancerStatsRequest { |
| // Request stats for the next num_rpcs sent by client. |
| int32 num_rpcs = 1; |
| // If num_rpcs have not completed within timeout_sec, return partial results. |
| int32 timeout_sec = 2; |
| } |
| |
| message LoadBalancerStatsResponse { |
| // The number of completed RPCs for each peer. |
| map<string, int32> rpcs_by_peer = 1; |
| // The number of RPCs that failed to record a remote peer. |
| int32 num_failures = 2; |
| message RpcsByPeer { |
| // The number of completed RPCs for each peer. |
| map<string, int32> rpcs_by_peer = 1; |
| } |
| // The number of completed RPCs for each type (UnaryCall or EmptyCall). |
| map<string, RpcsByPeer> rpcs_by_method = 3; |
| } |