Package: pytest-grpc
pytest-grpcWrite test for gRPC with pytest.ExampleSee example dir and/or read 'usage'.UsageFor example you have some proto file with rpc declaration.syntax="proto3";packagetest.v1;serviceEchoService{rpchandler(EchoRequest)returns(EchoResponse){}}messageEchoRequest{stringname=1;}messageEchoResponse{stringname=1;}After compile it with grpcio-tools, you get *_pb2.py and *_pb2_grpc.py files, now you can write your service.fromstub.test_pb2importEchoRequest,EchoResponsefromstub.test_pb2_grpcimportEchoServiceServicerclassServicer(EchoServiceServicer):defhandler(self,request:EchoRequest,context)->EchoResponse:returnEchoResponse(name=f'test-{request.name}')deferror_handler(self,request:EchoRequest,context)->EchoResponse:raiseRuntimeError('Some error')Point pytest with your stubs and service:importpytestfromstub.test_pb2importEchoRequest@pytest.fixture(scope='module')defgrpc_add_to_server():fromstub.test_pb2_grpcimportadd_EchoServiceServicer_to_serverreturnadd_EchoServiceServicer_to_server@pytest.fixture(scope='module')defgrpc_servicer():fromservicerimportServicerreturnServicer()@pytest.fixture(scope='module')defgrpc_stub_cls(grpc_channel):fromstub.test_pb2_grpcimportEchoServiceStubreturnEchoServiceStubWrite little test:deftest_some(grpc_stub):request=EchoRequest()response=grpc_stub.handler(request)assertresponse.name==f'test-{request.name}'deftest_example(grpc_stub):request=EchoRequest()response=grpc_stub.error_handler(request)assertresponse.name==f'test-{request.name}'Testing secure serverfrompathlibimportPathimportpytestimportgrpc@pytest.fixture(scope='module')defgrpc_add_to_server():fromstub.test_pb2_grpcimportadd_EchoServiceServicer_to_serverreturnadd_EchoServiceServicer_to_server@pytest.fixture(scope='module')defgrpc_servicer():fromservicerimportServicerreturnServicer()@pytest.fixture(scope='module')defgrpc_stub_cls(grpc_channel):fromstub.test_pb2_grpcimportEchoServiceStubreturnEchoServiceStub@pytest.fixture(scope='session')defmy_ssl_key_path():returnPath('/path/to/key.pem')@pytest.fixture(scope='session')defmy_ssl_cert_path():returnPath('/path/to/cert.pem')@pytest.fixture(scope='module')defgrpc_server(_grpc_server,grpc_addr,my_ssl_key_path,my_ssl_cert_path):"""Overwrites default `grpc_server` fixture with ssl credentials"""credentials=grpc.ssl_server_credentials([(my_ssl_key_path.read_bytes(),my_ssl_cert_path.read_bytes())])_grpc_server.add_secure_port(grpc_addr,server_credentials=credentials)_grpc_server.start()yield_grpc_server_grpc_server.stop(grace=None)@pytest.fixture(scope='module')defmy_channel_ssl_credentials(my_ssl_cert_path):# If we're using self-signed certificate it's necessarily to pass root certificate to channelreturngrpc.ssl_channel_credentials(root_certificates=my_ssl_cert_path.read_bytes())@pytest.fixture(scope='module')defgrpc_channel(my_channel_ssl_credentials,create_channel):"""Overwrites default `grpc_channel` fixture with ssl credentials"""withcreate_channel(my_channel_ssl_credentials)aschannel:yieldchannel@pytest.fixture(scope='module')defgrpc_authorized_channel(my_channel_ssl_credentials,create_channel):"""Channel with authorization header passed"""grpc_channel_credentials=grpc.access_token_call_credentials("some_token")composite_credentials=grpc.composite_channel_credentials(my_channel_ssl_credentials,grpc_channel_credentials)withcreate_channel(composite_credentials)aschannel:yieldchannel@pytest.fixture(scope='module')defmy_authorized_stub(grpc_stub_cls,grpc_channel):"""Stub with authorized channel"""returngrpc_stub_cls(grpc_channel)Run tests against real gRPC serverRun tests against read grpc server worked in another thread:py.testcachedir: .pytest_cache
plugins: grpc-0.0.0
collected 2 items

example/test_example.py::test_some PASSED
example/test_example.py::test_example FAILED

=================================== FAILURES ====================================
_________________________________ test_example __________________________________

grpc_stub = <stub.test_pb2_grpc.EchoServiceStub object at 0x107a9b390>

    def test_example(grpc_stub):
        request = EchoRequest()
>       response = grpc_stub.error_handler(request)

example/test_example.py:35:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
.env/lib/python3.7/site-packages/grpc/_channel.py:547: in __call__
    return _end_unary_response_blocking(state, call, False, None)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

state = <grpc._channel._RPCState object at 0x107b263c8>
call = <grpc._cython.cygrpc.SegregatedCall object at 0x107b323c8>
with_call = False, deadline = None

    def _end_unary_response_blocking(state, call, with_call, deadline):
        if state.code is grpc.StatusCode.OK:
            if with_call:
                rendezvous = _Rendezvous(state, call, None, deadline)
                return state.response, rendezvous
            else:
                return state.response
        else:
>           raise _Rendezvous(state, None, None, deadline)
E           grpc._channel._Rendezvous: <_Rendezvous of RPC that terminated with:
E           	status = StatusCode.UNKNOWN
E           	details = "Exception calling application: Some error"
E           	debug_error_string = "{"created":"@1544451353.148337000","description":"Error received from peer","file":"src/core/lib/surface/call.cc","file_line":1036,"grpc_message":"Exception calling application: Some error","grpc_status":2}"
E           >

.env/lib/python3.7/site-packages/grpc/_channel.py:466: _Rendezvous
------------------------------- Captured log call -------------------------------
_server.py                 397 ERROR    Exception calling application: Some error
Traceback (most recent call last):
  File "pytest-grpc/.env/lib/python3.7/site-packages/grpc/_server.py", line 389, in _call_behavior
    return behavior(argument, context), True
  File "pytest-grpc/example/src/servicer.py", line 10, in error_handler
    raise RuntimeError('Some error')
RuntimeError: Some error
================ 1 failed, 1 passed, 1 warnings in 0.16 seconds =================Run tests directly to python codeCall handlers directly, with fake grpc internals:py.test--grpc-fake-serverIn this case your get nice direct exceptions:============================= test session starts =============================
cachedir: .pytest_cache
plugins: grpc-0.0.0
collected 2 items

example/test_example.py::test_some PASSED
example/test_example.py::test_example FAILED

================================== FAILURES ===================================
________________________________ test_example _________________________________

grpc_stub = <stub.test_pb2_grpc.EchoServiceStub object at 0x10e06f518>

    def test_example(grpc_stub):
        request = EchoRequest()
>       response = grpc_stub.error_handler(request)

example/test_example.py:35:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
pytest_grpc/plugin.py:42: in fake_handler
    return real_method(request, context)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <servicer.Servicer object at 0x10ce75278>, request =
context = <pytest_grpc.plugin.FakeContext object at 0x10e083e48>

    def error_handler(self, request: EchoRequest, context) -> EchoResponse:
>       raise RuntimeError('Some error')
E       RuntimeError: Some error

example/src/servicer.py:10: RuntimeError
=============== 1 failed, 1 passed, 1 warnings in 0.10 seconds ================Run the servicer on multiple threadsThe number of workers threads for gRPC can be specified in two ways:add--grpc-max-workers=<n>to the argumentstest modules can also use agrpc_max_workers=<n>variableSeetest_blockingin example.