Partially implement gRPC Python server reflection

Some features relating to proto2 extension querying are missing due to
missing upstream features required to support them (see
https://github.com/google/protobuf/issues/2248).

3 files changed, 232 insertions, 18 deletions

diff --git a/src/python/grpcio_tests/tests/reflection/__init__.py b/src/python/grpcio_tests/tests/reflection/__init__.py
new file mode 100644
index 0000000000..100a624dc9
--- /dev/null
+++ b/src/python/grpcio_tests/tests/reflection/__init__.py
@@ -0,0 +1,28 @@
+# 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.
diff --git a/src/python/grpcio_tests/tests/reflection/_reflection_servicer_test.py b/src/python/grpcio_tests/tests/reflection/_reflection_servicer_test.py
new file mode 100644
index 0000000000..87264cf9ba
--- /dev/null
+++ b/src/python/grpcio_tests/tests/reflection/_reflection_servicer_test.py
@@ -0,0 +1,185 @@
+# 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 of grpc.reflection.v1alpha.reflection."""
+
+import unittest
+
+import grpc
+from grpc.framework.foundation import logging_pool
+from grpc.reflection.v1alpha import reflection
+from grpc.reflection.v1alpha import reflection_pb2
+
+from google.protobuf import descriptor_pool
+from google.protobuf import descriptor_pb2
+
+from src.proto.grpc.testing.proto2 import empty2_extensions_pb2
+from src.proto.grpc.testing import empty_pb2
+from tests.unit.framework.common import test_constants
+
+_EMPTY_PROTO_FILE_NAME = 'src/proto/grpc/testing/empty.proto'
+_EMPTY_PROTO_SYMBOL_NAME = 'grpc.testing.Empty'
+_SERVICE_NAMES = (
+    'Angstrom', 'Bohr', 'Curie', 'Dyson', 'Einstein', 'Feynman', 'Galilei')
+
+def _file_descriptor_to_proto(descriptor):
+  proto = descriptor_pb2.FileDescriptorProto()
+  descriptor.CopyToProto(proto)
+  return proto.SerializeToString()
+
+class ReflectionServicerTest(unittest.TestCase):
+
+  def setUp(self):
+    servicer = reflection.ReflectionServicer(service_names=_SERVICE_NAMES)
+    server_pool = logging_pool.pool(test_constants.THREAD_CONCURRENCY)
+    self._server = grpc.server(server_pool)
+    port = self._server.add_insecure_port('[::]:0')
+    reflection_pb2.add_ServerReflectionServicer_to_server(servicer, self._server)
+    self._server.start()
+
+    channel = grpc.insecure_channel('localhost:%d' % port)
+    self._stub = reflection_pb2.ServerReflectionStub(channel)
+
+  def testFileByName(self):
+    requests = (
+      reflection_pb2.ServerReflectionRequest(
+        file_by_filename=_EMPTY_PROTO_FILE_NAME
+      ),
+      reflection_pb2.ServerReflectionRequest(
+        file_by_filename='i-donut-exist'
+      ),
+    )
+    responses = tuple(self._stub.ServerReflectionInfo(requests))
+    expected_responses = (
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        file_descriptor_response=reflection_pb2.FileDescriptorResponse(
+          file_descriptor_proto=(
+            _file_descriptor_to_proto(empty_pb2.DESCRIPTOR),
+          )
+        )
+      ),
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        error_response=reflection_pb2.ErrorResponse(
+          error_code=grpc.StatusCode.NOT_FOUND.value[0],
+          error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(),
+        )
+      ),
+    )
+    self.assertEqual(expected_responses, responses)
+
+  def testFileBySymbol(self):
+    requests = (
+      reflection_pb2.ServerReflectionRequest(
+        file_containing_symbol=_EMPTY_PROTO_SYMBOL_NAME
+      ),
+      reflection_pb2.ServerReflectionRequest(
+        file_containing_symbol='i.donut.exist.co.uk.org.net.me.name.foo'
+      ),
+    )
+    responses = tuple(self._stub.ServerReflectionInfo(requests))
+    expected_responses = (
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        file_descriptor_response=reflection_pb2.FileDescriptorResponse(
+          file_descriptor_proto=(
+            _file_descriptor_to_proto(empty_pb2.DESCRIPTOR),
+          )
+        )
+      ),
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        error_response=reflection_pb2.ErrorResponse(
+          error_code=grpc.StatusCode.NOT_FOUND.value[0],
+          error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(),
+        )
+      ),
+    )
+    self.assertEqual(expected_responses, responses)
+
+  @unittest.skip('TODO(atash): implement file-containing-extension reflection '
+                 '(see https://github.com/google/protobuf/issues/2248)')
+  def testFileContainingExtension(self):
+    requests = (
+      reflection_pb2.ServerReflectionRequest(
+        file_containing_extension=reflection_pb2.ExtensionRequest(
+          containing_type='grpc.testing.proto2.Empty',
+          extension_number=125,
+        ),
+      ),
+      reflection_pb2.ServerReflectionRequest(
+        file_containing_extension=reflection_pb2.ExtensionRequest(
+          containing_type='i.donut.exist.co.uk.org.net.me.name.foo',
+          extension_number=55,
+        ),
+      ),
+    )
+    responses = tuple(self._stub.ServerReflectionInfo(requests))
+    expected_responses = (
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        file_descriptor_response=reflection_pb2.FileDescriptorResponse(
+          file_descriptor_proto=(
+            _file_descriptor_to_proto(empty_extensions_pb2.DESCRIPTOR),
+          )
+        )
+      ),
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        error_response=reflection_pb2.ErrorResponse(
+          error_code=grpc.StatusCode.NOT_FOUND.value[0],
+          error_message=grpc.StatusCode.NOT_FOUND.value[1].encode(),
+        )
+      ),
+    )
+    self.assertEqual(expected_responses, responses)
+
+  def testListServices(self):
+    requests = (
+      reflection_pb2.ServerReflectionRequest(
+        list_services='',
+      ),
+    )
+    responses = tuple(self._stub.ServerReflectionInfo(requests))
+    expected_responses = (
+      reflection_pb2.ServerReflectionResponse(
+        valid_host='',
+        list_services_response=reflection_pb2.ListServiceResponse(
+          service=tuple(
+            reflection_pb2.ServiceResponse(name=name)
+            for name in _SERVICE_NAMES
+          )
+        )
+      ),
+    )
+    self.assertEqual(expected_responses, responses)
+
+if __name__ == '__main__':
+  unittest.main(verbosity=2)
diff --git a/src/python/grpcio_tests/tests/tests.json b/src/python/grpcio_tests/tests/tests.json
index 2071a33e13..2e85f1f397 100644
--- a/src/python/grpcio_tests/tests/tests.json
+++ b/src/python/grpcio_tests/tests/tests.json
@@ -4,41 +4,42 @@
   "_api_test.ChannelTest",
   "_auth_test.AccessTokenCallCredentialsTest",
   "_auth_test.GoogleCallCredentialsTest",
-  "_beta_features_test.BetaFeaturesTest", 
-  "_beta_features_test.ContextManagementAndLifecycleTest", 
+  "_beta_features_test.BetaFeaturesTest",
+  "_beta_features_test.ContextManagementAndLifecycleTest",
   "_cancel_many_calls_test.CancelManyCallsTest",
   "_channel_args_test.ChannelArgsTest",
   "_channel_connectivity_test.ChannelConnectivityTest",
   "_channel_ready_future_test.ChannelReadyFutureTest",
-  "_channel_test.ChannelTest", 
+  "_channel_test.ChannelTest",
   "_compression_test.CompressionTest",
   "_connectivity_channel_test.ConnectivityStatesTest",
   "_credentials_test.CredentialsTest",
   "_empty_message_test.EmptyMessageTest",
   "_exit_test.ExitTest",
-  "_face_interface_test.DynamicInvokerBlockingInvocationInlineServiceTest", 
-  "_face_interface_test.DynamicInvokerFutureInvocationAsynchronousEventServiceTest", 
-  "_face_interface_test.GenericInvokerBlockingInvocationInlineServiceTest", 
-  "_face_interface_test.GenericInvokerFutureInvocationAsynchronousEventServiceTest", 
-  "_face_interface_test.MultiCallableInvokerBlockingInvocationInlineServiceTest", 
+  "_face_interface_test.DynamicInvokerBlockingInvocationInlineServiceTest",
+  "_face_interface_test.DynamicInvokerFutureInvocationAsynchronousEventServiceTest",
+  "_face_interface_test.GenericInvokerBlockingInvocationInlineServiceTest",
+  "_face_interface_test.GenericInvokerFutureInvocationAsynchronousEventServiceTest",
+  "_face_interface_test.MultiCallableInvokerBlockingInvocationInlineServiceTest",
   "_face_interface_test.MultiCallableInvokerFutureInvocationAsynchronousEventServiceTest",
   "_health_servicer_test.HealthServicerTest",
   "_implementations_test.CallCredentialsTest",
-  "_implementations_test.ChannelCredentialsTest", 
-  "_insecure_interop_test.InsecureInteropTest", 
-  "_logging_pool_test.LoggingPoolTest", 
+  "_implementations_test.ChannelCredentialsTest",
+  "_insecure_interop_test.InsecureInteropTest",
+  "_logging_pool_test.LoggingPoolTest",
   "_metadata_code_details_test.MetadataCodeDetailsTest",
   "_metadata_test.MetadataTest",
-  "_not_found_test.NotFoundTest", 
+  "_not_found_test.NotFoundTest",
   "_python_plugin_test.PythonPluginTest",
   "_read_some_but_not_all_responses_test.ReadSomeButNotAllResponsesTest",
+  "_reflection_servicer_test.ReflectionServicerTest",
   "_rpc_test.RPCTest",
-  "_sanity_test.Sanity", 
-  "_secure_interop_test.SecureInteropTest", 
+  "_sanity_test.Sanity",
+  "_secure_interop_test.SecureInteropTest",
   "_thread_cleanup_test.CleanupThreadTest",
-  "_utilities_test.ChannelConnectivityTest", 
-  "beta_python_plugin_test.PythonPluginTest", 
-  "cygrpc_test.InsecureServerInsecureClient", 
-  "cygrpc_test.SecureServerSecureClient", 
+  "_utilities_test.ChannelConnectivityTest",
+  "beta_python_plugin_test.PythonPluginTest",
+  "cygrpc_test.InsecureServerInsecureClient",
+  "cygrpc_test.SecureServerSecureClient",
   "cygrpc_test.TypeSmokeTest"
 ]