4 Client and server use
6 and the [gRPC over HTTP/2 v2 protocol](./PROTOCOL-HTTP2.md).
9 ------
12 provided the test case it is expected to run as a command-line parameter. Names
16 * --server_host=HOSTNAME
17     * The server host to connect to. For example, "localhost" or "127.0.0.1"
18 * --server_host_override=HOSTNAME
19     * The server host to claim to be connecting to, for use in TLS and HTTP/2
20       :authority header. If unspecified, the value of --server_host will be
22 * --server_port=PORT
23     * The server port to connect to. For example, "8080"
24 * --test_case=TESTCASE
26 * --use_tls=BOOLEAN
28 * --use_test_ca=BOOLEAN
32 * --default_service_account=ACCOUNT_EMAIL
34 * --oauth_scope=SCOPE
36 * --service_account_key_file=PATH
45 This test verifies that implementations support zero-size messages. Ideally,
50 Server features:
58 * response is non-null
66 of POST, and that server sets appropriate cache control headers for the response
67 to be cached by a proxy. This test requires that the server is behind
71 Server features:
78     Client adds a `x-user-ip` header with value `1.2.3.4` to the request.
96 Server features:
121 probing request to verify whether the server supports the [CompressedRequest][]
124 Server features:
180 This test verifies the server can compress unary messages. It sends two unary
181 requests, expecting the server's response to be compressed or not according to
187 the `response_compressed` boolean is obeyed by the server*.
190 Server features:
233 This test verifies that client-only streaming succeeds.
235 Server features:
280  6. Client half-closes
289 This test verifies the client can compress requests on per-message basis by
290 performing a two-request streaming call. It also sends an initial probing
291 request to verify whether the server supports the [CompressedRequest][] feature
295  1. Client calls `StreamingInputCall` and sends the following feature-probing
336  1. Client half-closes
346 This test verifies that server-only streaming succeeds.
348 Server features:
380 This test verifies that the server can compress streaming messages and disable
381 compression on individual messages, expecting the server's response to be
387 `response_compressed` boolean is obeyed by the server*.
389 Server features:
429 Server features:
485  5. After getting a reply, client half-closes
496 This test verifies that streams support having zero-messages in both
499 Server features:
503  1. Client calls FullDuplexCall and then half-closes
511 This test is only for cloud-to-prod path.
514 Credentials from GCE metadata server. The client instance needs to be created
517 The test uses `--default_service_account` with GCE service account email and
518 `--oauth_scope` with the OAuth scope to use. For testing against
519 grpc-test.sandbox.googleapis.com, "https://www.googleapis.com/auth/xapi.zoo"
521 be passed in as `--oauth_scope`.
523 Server features:
525 * [Echo Authenticated Username][]
545 * received SimpleResponse.username equals the value of
546   `--default_service_account` flag
547 * received SimpleResponse.oauth_scope is in `--oauth_scope`
554 This test is only for cloud-to-prod path.
559 Test caller should set flag `--service_account_key_file` with the
565 Server features:
567 * [Echo Authenticated Username][]
586 * received SimpleResponse.username is not empty and is in the json key file used
587 by the auth library. The client can optionally check the username matches the
588 email address in the key file or equals the value of `--default_service_account`
596 This test is only for cloud-to-prod path and some implementations may run
602 language-specific authorization library.
608 - uses the flag `--service_account_key_file` with the path to a json key file
612 fetch the token, `--default_service_account` can be used to pass in GCE service
614 - uses the flag `--oauth_scope` for the oauth scope.  For testing against
615 grpc-test.sandbox.googleapis.com, "https://www.googleapis.com/auth/xapi.zoo"
616 should be passed as the `--oauth_scope`.
618 Server features:
620 * [Echo Authenticated Username][]
638 * received SimpleResponse.username is valid. Depending on whether a service
641 * received SimpleResponse.oauth_scope is in `--oauth_scope`
645 Similar to the other auth tests, this test is only for cloud-to-prod path.
651 - uses the flag `--service_account_key_file` with the path to a json key file
655 - optionally uses the flag `--oauth_scope` for the oauth scope if implementator
657 against grpc-test.sandbox.googleapis.com, oauth scope
660 Server features:
662 * [Echo Authenticated Username][]
667  2. Client calls UnaryCall, setting per-call credentials to
678 * received SimpleResponse.username is not empty and is in the json key file used
679 by the auth library. The client can optionally check the username matches the
686 sent as initial-metadata by the client and as both initial- and trailing-metadata
687 by the server.
689 Server features:
698     key: "x-grpc-test-echo-initial", value: "test_initial_metadata_value"
699     key: "x-grpc-test-echo-trailing-bin", value: 0xababab
716     key: "x-grpc-test-echo-initial", value: "test_initial_metadata_value"
717     key: "x-grpc-test-echo-trailing-bin", value: 0xababab
733     and then half-closes
737 * metadata with key `"x-grpc-test-echo-initial"` and value
740 * metadata with key `"x-grpc-test-echo-trailing-bin"` and value `0xababab` is
750 Server features:
778     and then half-closes
792 Server features:
803         message: "\t\ntest with whitespace\r\nand Unicode BMP ☺ and non-BMP ��\t\n"
818 Server features:
835 This test verifies calling an unimplemented server returns the UNIMPLEMENTED
838 Server features:
853 Server features:
866 from the server.
868 Server features:
895 Server features:
925 This test verifies that a client sending faster than a server can drain sees
949 The client performs a number of large_unary RPCs over a single long-lived 
960 Metadata: client headers, server headers + trailers, binary+ascii
978 Flow control. Pushback at server for large messages (abhishek)
993 Start streaming RPC but don't send any requests, server responds
998 isn't affected negatively by the responses put on the wire by a buggy server
1008 Server  section in Interoperability Test Case Descriptions
1009 ------
1011 Servers implement various named features for clients to test with. Server
1012 features are orthogonal. If a server implements a feature, it is always
1018 * --port=PORT
1022 * --use_tls=BOOLEAN
1033 Server implements EmptyCall which immediately returns the empty message.
1038 Server implements UnaryCall which immediately returns a SimpleResponse with a
1040 for the `SimpleRequest.response_type`. If the server does not support the
1046 Server gets the default SimpleRequest proto as the request. The content of the
1053      the response path. Server should be behind a caching proxy for this test
1054      to pass. Currently we set the max-age to 60 seconds.
1059 When the client sets `response_compressed` to true, the server's response is
1066 When the client sets `expect_compressed` to true, the server expects the client
1074 Server implements StreamingInputCall which upon half close immediately returns
1081 Server implements StreamingOutputCall by replying, in order, with one
1090 Server implements FullDuplexCall by replying, in order, with one
1098 [Echo Status]: #echo-status
1099 When the client sends a response_status in the request payload, the server closes
1101 The server will not process any further messages on the stream sent by the client.
1103 associated status messages end-to-end.
1106 [Echo Metadata]: #echo-metadata
1107 When the client sends metadata with the key `"x-grpc-test-echo-initial"` with its
1108 request, the server sends back exactly this key and the corresponding value back to
1110 `"x-grpc-test-echo-trailing-bin"` with its request, the server sends back exactly this
1114 [Observe ResponseParameters.interval_us]: #observe-responseparametersinterval_us
1116 In StreamingOutputCall and FullDuplexCall, server delays sending a
1128 #### Echo Authenticated Username
1129 [Echo Authenticated Username]: #echo-authenticated-username  argument
1132 authenticated, then the SimpleResponse should have username filled with the
1138 [Echo OAuth Scope]: #echo-oauth-scope
1144 Although a general server-side feature, most test servers won't implement this
1145 feature. The TLS server `grpc-test.sandbox.googleapis.com:443` supports this