| # Copyright 2016, Google Inc. |
| # All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are |
| # met: |
| # |
| # * Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # * Redistributions in binary form must reproduce the above |
| # copyright notice, this list of conditions and the following disclaimer |
| # in the documentation and/or other materials provided with the |
| # distribution. |
| # * Neither the name of Google Inc. nor the names of its |
| # contributors may be used to endorse or promote products derived from |
| # this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| """Tests server and client side metadata API.""" |
| |
| import unittest |
| import weakref |
| |
| import grpc |
| from grpc import _grpcio_metadata |
| from grpc.framework.foundation import logging_pool |
| |
| from tests.unit import test_common |
| from tests.unit.framework.common import test_constants |
| |
| _CHANNEL_ARGS = (('grpc.primary_user_agent', 'primary-agent'), |
| ('grpc.secondary_user_agent', 'secondary-agent')) |
| |
| _REQUEST = b'\x00\x00\x00' |
| _RESPONSE = b'\x00\x00\x00' |
| |
| _UNARY_UNARY = b'/test/UnaryUnary' |
| _UNARY_STREAM = b'/test/UnaryStream' |
| _STREAM_UNARY = b'/test/StreamUnary' |
| _STREAM_STREAM = b'/test/StreamStream' |
| |
| _USER_AGENT = 'Python-gRPC-{}'.format(_grpcio_metadata.__version__) |
| |
| _CLIENT_METADATA = ( |
| (b'client-md-key', b'client-md-key'), |
| (b'client-md-key-bin', b'\x00\x01') |
| ) |
| |
| _SERVER_INITIAL_METADATA = ( |
| (b'server-initial-md-key', b'server-initial-md-value'), |
| (b'server-initial-md-key-bin', b'\x00\x02') |
| ) |
| |
| _SERVER_TRAILING_METADATA = ( |
| (b'server-trailing-md-key', b'server-trailing-md-value'), |
| (b'server-trailing-md-key-bin', b'\x00\x03') |
| ) |
| |
| |
| def user_agent(metadata): |
| for key, val in metadata: |
| if key == b'user-agent': |
| return val.decode('ascii') |
| raise KeyError('No user agent!') |
| |
| |
| def validate_client_metadata(test, servicer_context): |
| test.assertTrue(test_common.metadata_transmitted( |
| _CLIENT_METADATA, servicer_context.invocation_metadata())) |
| test.assertTrue(user_agent(servicer_context.invocation_metadata()) |
| .startswith('primary-agent ' + _USER_AGENT)) |
| test.assertTrue(user_agent(servicer_context.invocation_metadata()) |
| .endswith('secondary-agent')) |
| |
| |
| def handle_unary_unary(test, request, servicer_context): |
| validate_client_metadata(test, servicer_context) |
| servicer_context.send_initial_metadata(_SERVER_INITIAL_METADATA) |
| servicer_context.set_trailing_metadata(_SERVER_TRAILING_METADATA) |
| return _RESPONSE |
| |
| |
| def handle_unary_stream(test, request, servicer_context): |
| validate_client_metadata(test, servicer_context) |
| servicer_context.send_initial_metadata(_SERVER_INITIAL_METADATA) |
| servicer_context.set_trailing_metadata(_SERVER_TRAILING_METADATA) |
| for _ in range(test_constants.STREAM_LENGTH): |
| yield _RESPONSE |
| |
| |
| def handle_stream_unary(test, request_iterator, servicer_context): |
| validate_client_metadata(test, servicer_context) |
| servicer_context.send_initial_metadata(_SERVER_INITIAL_METADATA) |
| servicer_context.set_trailing_metadata(_SERVER_TRAILING_METADATA) |
| # TODO(issue:#6891) We should be able to remove this loop |
| for request in request_iterator: |
| pass |
| return _RESPONSE |
| |
| |
| def handle_stream_stream(test, request_iterator, servicer_context): |
| validate_client_metadata(test, servicer_context) |
| servicer_context.send_initial_metadata(_SERVER_INITIAL_METADATA) |
| servicer_context.set_trailing_metadata(_SERVER_TRAILING_METADATA) |
| # TODO(issue:#6891) We should be able to remove this loop, |
| # and replace with return; yield |
| for request in request_iterator: |
| yield _RESPONSE |
| |
| |
| class _MethodHandler(grpc.RpcMethodHandler): |
| |
| def __init__(self, test, request_streaming, response_streaming): |
| self.request_streaming = request_streaming |
| self.response_streaming = response_streaming |
| self.request_deserializer = None |
| self.response_serializer = None |
| self.unary_unary = None |
| self.unary_stream = None |
| self.stream_unary = None |
| self.stream_stream = None |
| if self.request_streaming and self.response_streaming: |
| self.stream_stream = lambda x, y: handle_stream_stream(test, x, y) |
| elif self.request_streaming: |
| self.stream_unary = lambda x, y: handle_stream_unary(test, x, y) |
| elif self.response_streaming: |
| self.unary_stream = lambda x, y: handle_unary_stream(test, x, y) |
| else: |
| self.unary_unary = lambda x, y: handle_unary_unary(test, x, y) |
| |
| |
| class _GenericHandler(grpc.GenericRpcHandler): |
| |
| def __init__(self, test): |
| self._test = test |
| |
| def service(self, handler_call_details): |
| if handler_call_details.method == _UNARY_UNARY: |
| return _MethodHandler(self._test, False, False) |
| elif handler_call_details.method == _UNARY_STREAM: |
| return _MethodHandler(self._test, False, True) |
| elif handler_call_details.method == _STREAM_UNARY: |
| return _MethodHandler(self._test, True, False) |
| elif handler_call_details.method == _STREAM_STREAM: |
| return _MethodHandler(self._test, True, True) |
| else: |
| return None |
| |
| |
| class MetadataTest(unittest.TestCase): |
| |
| def setUp(self): |
| self._server_pool = logging_pool.pool(test_constants.THREAD_CONCURRENCY) |
| self._server = grpc.server((_GenericHandler(weakref.proxy(self)),), |
| self._server_pool) |
| port = self._server.add_insecure_port('[::]:0') |
| self._server.start() |
| self._channel = grpc.insecure_channel('localhost:%d' % port, |
| options=_CHANNEL_ARGS) |
| |
| def tearDown(self): |
| self._server.stop(0) |
| |
| def testUnaryUnary(self): |
| multi_callable = self._channel.unary_unary(_UNARY_UNARY) |
| unused_response, call = multi_callable.with_call( |
| _REQUEST, metadata=_CLIENT_METADATA) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_INITIAL_METADATA, call.initial_metadata())) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_TRAILING_METADATA, call.trailing_metadata())) |
| |
| def testUnaryStream(self): |
| multi_callable = self._channel.unary_stream(_UNARY_STREAM) |
| call = multi_callable(_REQUEST, metadata=_CLIENT_METADATA) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_INITIAL_METADATA, call.initial_metadata())) |
| for _ in call: |
| pass |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_TRAILING_METADATA, call.trailing_metadata())) |
| |
| def testStreamUnary(self): |
| multi_callable = self._channel.stream_unary(_STREAM_UNARY) |
| unused_response, call = multi_callable.with_call( |
| [_REQUEST] * test_constants.STREAM_LENGTH, |
| metadata=_CLIENT_METADATA) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_INITIAL_METADATA, call.initial_metadata())) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_TRAILING_METADATA, call.trailing_metadata())) |
| |
| def testStreamStream(self): |
| multi_callable = self._channel.stream_stream(_STREAM_STREAM) |
| call = multi_callable([_REQUEST] * test_constants.STREAM_LENGTH, |
| metadata=_CLIENT_METADATA) |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_INITIAL_METADATA, call.initial_metadata())) |
| for _ in call: |
| pass |
| self.assertTrue(test_common.metadata_transmitted( |
| _SERVER_TRAILING_METADATA, call.trailing_metadata())) |
| |
| |
| if __name__ == '__main__': |
| unittest.main(verbosity=2) |